knative
/
docs
mirror of https://github.com/knative/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add multi-tenant GitHub source installation doc (#2650) 

* add mt github installation instructions

* apply fixes from review

* fix typo
This commit is contained in:
Lionel Villard 2020-08-20 13:46:14 -04:00 committed by GitHub
parent 4d2c89421b
commit ea76f35f66
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 19 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
docs/eventing/samples/github-source/README.md
View File

@ -1,38 +1,20 @@
GitHub Source example shows how to wire GitHub events for consumption GitHub Source example shows how to wire GitHub events for consumption
by a Knative Service. by a Knative Service.
## Deployment Steps ## Before you begin
### Prerequisites 1. Set up [Knative Serving](../../../serving).
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. Ensure Knative Serving is [configured with a domain 1. Ensure Knative Serving is [configured with a domain
name](../../../serving/using-a-custom-domain.md) name](../../../serving/using-a-custom-domain.md)
that allows GitHub to call into the cluster. 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. 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 1. Set up [Knative Eventing](../../../eventing) with the GitHub source.
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
```
### Create a Knative Service ### Create a Knative Service
To verify the `GitHubSource` is working, we will create a simple Knative To verify the GitHub source is working, create a simple Knative
`Service` that dumps incoming messages to its log. The `service.yaml` file Service that dumps incoming messages to its log. The `service.yaml` file
defines this basic service. defines this basic Service.
```yaml ```yaml
apiVersion: serving.knative.dev/v1 apiVersion: serving.knative.dev/v1

14
docs/install/any-kubernetes-cluster.md
View File

@ -742,12 +742,24 @@ kubectl label namespace default eventing.knative.dev/injection=enabled
{{< feature-state version="v0.2" state="alpha" >}} {{< feature-state version="v0.2" state="alpha" >}}
The following command installs the Github Source: The following command installs the single-tenant Github source:
```bash ```bash
kubectl apply --filename {{< artifact repo="eventing-contrib" file="github.yaml" >}} 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 To learn more about the Github source, try
[our sample](../eventing/samples/github-source/README.md) [our sample](../eventing/samples/github-source/README.md)