-
Notifications
You must be signed in to change notification settings - Fork 420
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add support for custom object to triggers eventlistener
- Loading branch information
1 parent
9371a71
commit 12241f6
Showing
25 changed files
with
1,173 additions
and
24 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| ## GitHub EventListener | ||
|
|
||
| Creates an EventListener that listens for GitHub webhook events. | ||
|
|
||
| ### Try it out locally: | ||
|
|
||
| 1. To create the GitHub trigger and all related resources, run: | ||
|
|
||
| ```bash | ||
| kubectl apply -f examples/custom-resource/ | ||
| ``` | ||
|
|
||
| 1. Port forward: | ||
|
|
||
| ```bash | ||
| kubectl port-forward \ | ||
| "$(kubectl get pod --selector=eventlistener=github-listener-interceptor-customresource -oname)" \ | ||
| 8080 | ||
| ``` | ||
|
|
||
| **Note**: Instead of port forwarding, you can set the | ||
| [`serviceType`](https://github.com/tektoncd/triggers/blob/master/docs/eventlisteners.md#serviceType) | ||
| to `LoadBalancer` to expose the EventListener with a public IP. | ||
|
|
||
| 1. Test by sending the sample payload. | ||
|
|
||
| ```bash | ||
| curl -v \ | ||
| -H 'X-GitHub-Event: pull_request' \ | ||
| -H 'X-Hub-Signature: sha1=ba0cdc263b3492a74b601d240c27efe81c4720cb' \ | ||
| -H 'Content-Type: application/json' \ | ||
| -d '{"action": "opened", "pull_request":{"head":{"sha": "28911bbb5a3e2ea034daf1f6be0a822d50e31e73"}},"repository":{"clone_url": "https://github.com/tektoncd/triggers.git"}}' \ | ||
| http://localhost:8080 | ||
| ``` | ||
|
|
||
| The response status code should be `201 Created` | ||
|
|
||
| [`HMAC`](https://www.freeformatter.com/hmac-generator.html) tool used to create X-Hub-Signature. | ||
|
|
||
| In [`HMAC`](https://www.freeformatter.com/hmac-generator.html) `string` is the *body payload ex:* `{"action": "opened", "pull_request":{"head":{"sha": "28911bbb5a3e2ea034daf1f6be0a822d50e31e73"}},"repository":{"clone_url": "https://github.com/tektoncd/triggers.git"}}` | ||
| and `secretKey` is the *given secretToken ex:* `1234567`. | ||
|
|
||
| 1. You should see a new TaskRun that got created: | ||
|
|
||
| ```bash | ||
| kubectl get taskruns | grep github-run- | ||
| ``` |
88 changes: 88 additions & 0 deletions
88
examples/custom-resource/github-eventlistener-interceptor-customresource.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| --- | ||
| apiVersion: triggers.tekton.dev/v1alpha1 | ||
| kind: EventListener | ||
| metadata: | ||
| name: github-listener-interceptor-customresource | ||
| spec: | ||
| triggers: | ||
| - name: github-listener | ||
| interceptors: | ||
| - github: | ||
| secretRef: | ||
| secretName: github-secret | ||
| secretKey: secretToken | ||
| eventTypes: | ||
| - pull_request | ||
| - cel: | ||
| filter: "body.action in ['opened', 'synchronize', 'reopened']" | ||
| bindings: | ||
| - ref: github-pr-binding | ||
| template: | ||
| ref: github-template | ||
| resources: | ||
| customResource: | ||
| apiVersion: serving.knative.dev/v1 | ||
| kind: Service | ||
| metadata: | ||
| name: knativeservice | ||
| spec: | ||
| template: | ||
| metadata: | ||
| name: knativeservice-rev | ||
| spec: | ||
| serviceAccountName: tekton-triggers-example-sa | ||
| containers: | ||
| - resources: | ||
| requests: | ||
| memory: "64Mi" | ||
| cpu: "250m" | ||
| limits: | ||
| memory: "128Mi" | ||
| cpu: "500m" | ||
| --- | ||
| apiVersion: triggers.tekton.dev/v1alpha1 | ||
| kind: TriggerBinding | ||
| metadata: | ||
| name: github-pr-binding | ||
| spec: | ||
| params: | ||
| - name: gitrevision | ||
| value: $(body.pull_request.head.sha) | ||
| - name: gitrepositoryurl | ||
| value: $(body.repository.clone_url) | ||
|
|
||
| --- | ||
| apiVersion: triggers.tekton.dev/v1alpha1 | ||
| kind: TriggerTemplate | ||
| metadata: | ||
| name: github-template | ||
| spec: | ||
| params: | ||
| - name: gitrevision | ||
| - name: gitrepositoryurl | ||
| resourcetemplates: | ||
| - apiVersion: tekton.dev/v1alpha1 | ||
| kind: TaskRun | ||
| metadata: | ||
| generateName: github-run- | ||
| spec: | ||
| taskSpec: | ||
| inputs: | ||
| resources: | ||
| - name: source | ||
| type: git | ||
| steps: | ||
| - image: ubuntu | ||
| script: | | ||
| #! /bin/bash | ||
| ls -al $(inputs.resources.source.path) | ||
| inputs: | ||
| resources: | ||
| - name: source | ||
| resourceSpec: | ||
| type: git | ||
| params: | ||
| - name: revision | ||
| value: $(tt.params.gitrevision) | ||
| - name: url | ||
| value: $(tt.params.gitrepositoryurl) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| apiVersion: v1 | ||
| kind: ServiceAccount | ||
| metadata: | ||
| name: tekton-triggers-example-sa | ||
| --- | ||
| apiVersion: rbac.authorization.k8s.io/v1 | ||
| kind: Role | ||
| metadata: | ||
| name: tekton-triggers-example-minimal | ||
| rules: | ||
| # EventListeners need to be able to fetch all namespaced resources | ||
| - apiGroups: ["triggers.tekton.dev"] | ||
| resources: ["eventlisteners", "triggerbindings", "triggertemplates", "triggers"] | ||
| verbs: ["get", "list", "watch"] | ||
| - apiGroups: [""] | ||
| # secrets are only needed for GitHub/GitLab interceptors | ||
| # configmaps is needed for updating logging config | ||
| resources: ["configmaps", "secrets"] | ||
| verbs: ["get", "list", "watch"] | ||
| # Permissions to create resources in associated TriggerTemplates | ||
| - apiGroups: ["tekton.dev"] | ||
| resources: ["pipelineruns", "pipelineresources", "taskruns"] | ||
| verbs: ["create"] | ||
| - apiGroups: [""] | ||
| resources: ["serviceaccounts"] | ||
| verbs: ["impersonate"] | ||
| - apiGroups: ["policy"] | ||
| resources: ["podsecuritypolicies"] | ||
| resourceNames: ["tekton-triggers"] | ||
| verbs: ["use"] | ||
| --- | ||
| apiVersion: rbac.authorization.k8s.io/v1 | ||
| kind: RoleBinding | ||
| metadata: | ||
| name: tekton-triggers-example-binding | ||
| subjects: | ||
| - kind: ServiceAccount | ||
| name: tekton-triggers-example-sa | ||
| roleRef: | ||
| apiGroup: rbac.authorization.k8s.io | ||
| kind: Role | ||
| name: tekton-triggers-example-minimal | ||
| --- | ||
| kind: ClusterRole | ||
| apiVersion: rbac.authorization.k8s.io/v1 | ||
| metadata: | ||
| name: tekton-triggers-example-clusterrole | ||
| rules: | ||
| # EventListeners need to be able to fetch any clustertriggerbindings | ||
| - apiGroups: ["triggers.tekton.dev"] | ||
| resources: ["clustertriggerbindings"] | ||
| verbs: ["get", "list", "watch"] | ||
| --- | ||
| apiVersion: rbac.authorization.k8s.io/v1 | ||
| kind: ClusterRoleBinding | ||
| metadata: | ||
| name: tekton-triggers-example-clusterbinding | ||
| subjects: | ||
| - kind: ServiceAccount | ||
| name: tekton-triggers-example-sa | ||
| namespace: default | ||
| roleRef: | ||
| apiGroup: rbac.authorization.k8s.io | ||
| kind: ClusterRole | ||
| name: tekton-triggers-example-clusterrole |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| apiVersion: v1 | ||
| kind: Secret | ||
| metadata: | ||
| name: github-secret | ||
| type: Opaque | ||
| stringData: | ||
| secretToken: "1234567" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.