devopstoday11/knative-gcp

GCP event implementations to use with Knative Eventing.

Knative + Google Cloud Platform = 🚀

Knative-GCP builds on Kubernetes to enable easy configuration and consumption of Google Cloud Platform events and services. It can be useful independently, but is best mixed with Knative.

If you are interested in contributing, see DEVELOPMENT.md.

Installing Knative-GCP

Follow this guide to install Knative-GCP components on a platform of your choice.

1. Installing Knative-GCP
2. Installing a Service Account for the Data Plane
3. Installing GCP Broker
4. Installing Broker with PubSub Channel
5. Managing Multiple Projects

Operating Knative-GCP

The following guides pertain to operating an existing Knative-GCP installation.

1. Accessing Event Traces in Cloud Trace

Knative-GCP Sources

In order to consume events from different GCP services, Knative-GCP provides different Sources. A Source is a Kubernetes object that generate or import events into the cluster and sends them downstream in CloudEvents format. Use the examples below to learn how to configure and consume events from different GCP services.

1. CloudPubSubSource
2. CloudStorageSource
3. CloudSchedulerSource
4. CloudAuditLogsSource
5. CloudBuildSource

All of the above Sources are Pull-based, i.e., they poll messages from Pub/Sub subscriptions. Different mechanisms can be used to scale them out. Roughly speaking, all such mechanisms need metrics to understand how "congested" the Pub/Sub subscription is and inform their scaling decision subsystem. We currently support the following scaling mechanisms:

1. Keda-based Scaling

Pub/Sub Channel

A Channel is a Knative Eventing logical construct that provides an event delivery mechanism which can fan-out received events to multiple destinations via Subscriptions. A Channel has a single inbound HTTP-addressable interface, which may accept events delivered directly or forwarded from multiple Subscriptions. Use the example below if you want to use our Channel backed by Cloud Pub/Sub, which offers at-least-once message delivery and best-effort ordering to existing subscribers.

1. Channel

Pub/Sub Core Resources

In Cloud Pub/Sub, a publisher application creates and sends messages to a topic, while subscriber applications create a subscription to a topic in order to receive messages from it. If you want to interact directly with Cloud Pub/Sub topics and subscriptions within your Kubernetes cluster, use our custom Kubernetes resources below.

1. Topic
2. PullSubscription

Note: This repo is still in development, APIs and resource names are subject to change in the future.