diff --git a/docs/eventing/samples/github-source/README.md b/docs/eventing/samples/github-source/README.md index eca1fce90..f1e56276e 100644 --- a/docs/eventing/samples/github-source/README.md +++ b/docs/eventing/samples/github-source/README.md @@ -1,38 +1,20 @@ GitHub Source example shows how to wire GitHub events for consumption by a Knative Service. -## Deployment Steps +## Before you begin -### Prerequisites - -You will need: - -1. An internet-accessible Kubernetes cluster with Knative Serving - installed. Follow the [installation instructions](../../../install/README.md) - if you need to create one. +1. Set up [Knative Serving](../../../serving). 1. Ensure Knative Serving is [configured with a domain name](../../../serving/using-a-custom-domain.md) that allows GitHub to call into the cluster. 1. If you're using GKE, you'll also want to [assign a static IP address](../../../serving/gke-assigning-static-ip-address.md). -1. Install [Knative - Eventing](../../../eventing). Those - instructions also install the default eventing sources, including - the `GitHubSource` we'll use. - -### Install Github Event Source - -Github Event source lives in the [knative/eventing-contrib](https://github.com/knative/eventing-contrib). -You can install it by running the following (this is currently the latest released version (0.11.2)) - -```shell -kubectl apply -f https://github.com/knative/eventing-contrib/releases/download/v0.15.0/github.yaml -``` +1. Set up [Knative Eventing](../../../eventing) with the GitHub source. ### Create a Knative Service -To verify the `GitHubSource` is working, we will create a simple Knative -`Service` that dumps incoming messages to its log. The `service.yaml` file -defines this basic service. +To verify the GitHub source is working, create a simple Knative +Service that dumps incoming messages to its log. The `service.yaml` file +defines this basic Service. ```yaml apiVersion: serving.knative.dev/v1 diff --git a/docs/install/any-kubernetes-cluster.md b/docs/install/any-kubernetes-cluster.md index 375fdf52a..43a1ff5a1 100644 --- a/docs/install/any-kubernetes-cluster.md +++ b/docs/install/any-kubernetes-cluster.md @@ -742,12 +742,24 @@ kubectl label namespace default eventing.knative.dev/injection=enabled {{< feature-state version="v0.2" state="alpha" >}} -The following command installs the Github Source: +The following command installs the single-tenant Github source: ```bash kubectl apply --filename {{< artifact repo="eventing-contrib" file="github.yaml" >}} ``` +The single-tenant GitHub source creates one Knative service per GitHub source. + +The following command installs the multi-tenant GitHub source: + +```bash +kubectl apply --filename {{< artifact repo="eventing-contrib" file="mt-github.yaml" >}} +``` + +The multi-tenant GitHub source creates only one Knative service handling all +GitHub sources in the cluster. This source does not support logging or tracing +configuration yet. + To learn more about the Github source, try [our sample](../eventing/samples/github-source/README.md)