Skip to content

Commit ea76f35

Browse files
Add multi-tenant GitHub source installation doc (#2650)
* add mt github installation instructions * apply fixes from review * fix typo
1 parent 4d2c894 commit ea76f35

File tree

2 files changed

+19
-25
lines changed

2 files changed

+19
-25
lines changed

docs/eventing/samples/github-source/README.md

+6-24
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,20 @@
11
GitHub Source example shows how to wire GitHub events for consumption
22
by a Knative Service.
33

4-
## Deployment Steps
4+
## Before you begin
55

6-
### Prerequisites
7-
8-
You will need:
9-
10-
1. An internet-accessible Kubernetes cluster with Knative Serving
11-
installed. Follow the [installation instructions](../../../install/README.md)
12-
if you need to create one.
6+
1. Set up [Knative Serving](../../../serving).
137
1. Ensure Knative Serving is [configured with a domain
148
name](../../../serving/using-a-custom-domain.md)
159
that allows GitHub to call into the cluster.
1610
1. If you're using GKE, you'll also want to [assign a static IP address](../../../serving/gke-assigning-static-ip-address.md).
17-
1. Install [Knative
18-
Eventing](../../../eventing). Those
19-
instructions also install the default eventing sources, including
20-
the `GitHubSource` we'll use.
21-
22-
### Install Github Event Source
23-
24-
Github Event source lives in the [knative/eventing-contrib](https://github.com/knative/eventing-contrib).
25-
You can install it by running the following (this is currently the latest released version (0.11.2))
26-
27-
```shell
28-
kubectl apply -f https://github.com/knative/eventing-contrib/releases/download/v0.15.0/github.yaml
29-
```
11+
1. Set up [Knative Eventing](../../../eventing) with the GitHub source.
3012

3113
### Create a Knative Service
3214

33-
To verify the `GitHubSource` is working, we will create a simple Knative
34-
`Service` that dumps incoming messages to its log. The `service.yaml` file
35-
defines this basic service.
15+
To verify the GitHub source is working, create a simple Knative
16+
Service that dumps incoming messages to its log. The `service.yaml` file
17+
defines this basic Service.
3618

3719
```yaml
3820
apiVersion: serving.knative.dev/v1

docs/install/any-kubernetes-cluster.md

+13-1
Original file line numberDiff line numberDiff line change
@@ -742,12 +742,24 @@ kubectl label namespace default eventing.knative.dev/injection=enabled
742742

743743
{{< feature-state version="v0.2" state="alpha" >}}
744744

745-
The following command installs the Github Source:
745+
The following command installs the single-tenant Github source:
746746

747747
```bash
748748
kubectl apply --filename {{< artifact repo="eventing-contrib" file="github.yaml" >}}
749749
```
750750

751+
The single-tenant GitHub source creates one Knative service per GitHub source.
752+
753+
The following command installs the multi-tenant GitHub source:
754+
755+
```bash
756+
kubectl apply --filename {{< artifact repo="eventing-contrib" file="mt-github.yaml" >}}
757+
```
758+
759+
The multi-tenant GitHub source creates only one Knative service handling all
760+
GitHub sources in the cluster. This source does not support logging or tracing
761+
configuration yet.
762+
751763
To learn more about the Github source, try
752764
[our sample](../eventing/samples/github-source/README.md)
753765

0 commit comments

Comments
 (0)