-
Notifications
You must be signed in to change notification settings - Fork 743
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* feat: custom trigger * chore: added debug log stmts. * docs: custom trigger walkthrough * docs: custom trigger walkthrough * docs: custom trigger walkthrough * docs: custom trigger walkthrough * docs: custom trigger walkthrough
- Loading branch information
1 parent
6295610
commit cb1358d
Showing
12 changed files
with
252 additions
and
40 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
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
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,112 @@ | ||
| # Build Your Own Trigger | ||
|
|
||
| Argo Events supports a variety of triggers out of box like Argo Workflow, K8s Objects, AWS Lambda, HTTP Requests etc., but you may want to write your own logic to trigger a pipeline or create an object in K8s cluster. An example would be to trigger | ||
| TektonCD or AirFlow pipelines on GitHub events. | ||
|
|
||
| ## Custom Trigger | ||
|
|
||
| In order to plug your own implementation for a trigger with Argo Events Sensor, you need to | ||
| run a gRPC server that implements the interface that the sensor expects. | ||
|
|
||
| ### Interface | ||
|
|
||
| The interface exposed via proto file, | ||
|
|
||
| // Trigger offers services to build a custom trigger | ||
| service Trigger { | ||
| // FetchResource fetches the resource to be triggered. | ||
| rpc FetchResource(FetchResourceRequest) returns (FetchResourceResponse); | ||
| // Execute executes the requested trigger resource. | ||
| rpc Execute(ExecuteRequest) returns (ExecuteResponse); | ||
| // ApplyPolicy applies policies on the trigger execution result. | ||
| rpc ApplyPolicy(ApplyPolicyRequest) returns (ApplyPolicyResponse); | ||
| } | ||
|
|
||
| The complete proto file is available [here](https://github.com/argoproj/argo-events/blob/master/sensors/triggers/trigger.proto). | ||
|
|
||
| Let's walk through the contract, | ||
|
|
||
| 1. `FetchResource`: If the trigger server needs to fetch a resource from external sources like S3, Git or a URL, this is the | ||
| place to do so. e.g. if the trigger server aims to invoke a TektonCD pipeline and the `PipelineRun` resource lives on Git, then | ||
| trigger server can first fetch it from Git and return it back to sensor. | ||
|
|
||
| 2. `Execute`: In this method, the trigger server executes/invokes the trigger. e.g. TektonCD pipeline resource being | ||
| created in K8s cluster. | ||
|
|
||
| 3. `ApplyPolicy`: This is where your trigger implementation can check whether the triggered resource transitioned into the success state. | ||
| Depending upon the response from the trigger server, the sensor will either stop processing subsequent triggers, or it will continue to | ||
| process them. | ||
|
|
||
|
|
||
| ### How to define the Custom Trigger in a sensor? | ||
|
|
||
| Let's look at the following sensor, | ||
|
|
||
| apiVersion: argoproj.io/v1alpha1 | ||
| kind: Sensor | ||
| metadata: | ||
| name: webhook-sensor | ||
| labels: | ||
| sensors.argoproj.io/sensor-controller-instanceid: argo-events | ||
| spec: | ||
| template: | ||
| spec: | ||
| containers: | ||
| - name: sensor | ||
| image: metalgearsolid/sensor:v0.15.0 | ||
| imagePullPolicy: Always | ||
| serviceAccountName: argo-events-sa | ||
| dependencies: | ||
| - name: test-dep | ||
| gatewayName: webhook-gateway | ||
| eventName: example | ||
| subscription: | ||
| http: | ||
| port: 9300 | ||
| triggers: | ||
| - template: | ||
| name: webhook-workflow-trigger | ||
| custom: | ||
| # the url of the trigger server. | ||
| serverURL: tekton-trigger.argo-events.svc:9000 | ||
| # spec is map of string->string and it is sent over to trigger server. | ||
| # the spec can be anything you want as per your use-case, just make sure the trigger server understands the spec map. | ||
| spec: | ||
| url: "https://raw.githubusercontent.com/VaibhavPage/tekton-cd-trigger/master/example.yaml" | ||
| # These parameters are applied on resource fetched and returned by the trigger server. | ||
| # e.g. consider a trigger server which invokes TektonCD pipeline runs, then | ||
| # the trigger server can return a TektonCD PipelineRun resource. | ||
| # The parameters are then applied on that PipelineRun resource. | ||
| parameters: | ||
| - src: | ||
| dependencyName: test-dep | ||
| dataKey: body.namespace | ||
| dest: metadata.namespace | ||
| # These parameters are applied on entire template body. | ||
| # So that you can parameterize anything under `custom` key such as `serverURL`, `spec` etc. | ||
| parameters: | ||
| - src: | ||
| dependencyName: test-dep | ||
| dataKey: body.url | ||
| dest: custom.spec.url | ||
|
|
||
| The sensor definition should look familiar to you. The only difference is the `custom` key under `triggers -> template`. | ||
| The specification under `custom` key defines the custom trigger. | ||
|
|
||
| The most important fields are, | ||
|
|
||
| 1. `serverURL`: This is the URL of the trigger gRPC server. | ||
|
|
||
| 1. `spec`: It is a map of string -> string. The spec can be anything you want as per your use-case. The sensor sends | ||
| the spec to trigger server, and it is upto the trigger gRPC server to interpret the spec. | ||
|
|
||
| 1. `parameters`: The parameters override the resource that is fetched by the trigger server. | ||
| Read more info on parameters [here](https://argoproj.github.io/argo-events/tutorials/02-parameterization/). | ||
|
|
||
| 1. `payload`: Payload to send to the trigger server. Read more on payload [here](https://argoproj.github.io/argo-events/triggers/http-trigger/#request-payload). | ||
|
|
||
| The complete spec for the custom trigger is available [here](https://github.com/argoproj/argo-events/blob/master/api/sensor.md#customtrigger). | ||
|
|
||
| ## Custom Trigger in Action | ||
|
|
||
| Refer to a sample [trigger server](https://github.com/VaibhavPage/tekton-cd-trigger) that invokes TektonCD pipeline on events. |
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 @@ | ||
| apiVersion: argoproj.io/v1alpha1 | ||
| kind: Sensor | ||
| metadata: | ||
| name: webhook-sensor | ||
| labels: | ||
| sensors.argoproj.io/sensor-controller-instanceid: argo-events | ||
| spec: | ||
| template: | ||
| spec: | ||
| containers: | ||
| - name: sensor | ||
| image: metalgearsolid/sensor:v0.15.0 | ||
| imagePullPolicy: Always | ||
| serviceAccountName: argo-events-sa | ||
| dependencies: | ||
| - name: test-dep | ||
| gatewayName: webhook-gateway | ||
| eventName: example | ||
| subscription: | ||
| http: | ||
| port: 9300 | ||
| triggers: | ||
| - template: | ||
| name: webhook-workflow-trigger | ||
| custom: | ||
| # the url of the trigger server. | ||
| serverURL: tekton-trigger.argo-events.svc:9000 | ||
| # spec is map of string->string and it is sent over to trigger server. | ||
| # the spec can be anything you want as per your use-case, just make sure the trigger server understands the spec map. | ||
| spec: | ||
| url: "https://raw.githubusercontent.com/VaibhavPage/tekton-cd-trigger/master/example.yaml" | ||
| # These parameters are applied on resource fetched and returned by the trigger server. | ||
| # e.g. consider a trigger server which invokes TektonCD pipeline runs, then | ||
| # the trigger server can return a TektonCD PipelineRun resource. | ||
| # The parameters are then applied on that PipelineRun resource. | ||
| parameters: | ||
| - src: | ||
| dependencyName: test-dep | ||
| dataKey: body.namespace | ||
| dest: metadata.namespace | ||
| # These parameters are applied on entire template body. | ||
| # So that you can parameterize anything under `custom` key such as `serverURL`, `spec` etc. | ||
| parameters: | ||
| - src: | ||
| dependencyName: test-dep | ||
| dataKey: body.url | ||
| dest: custom.spec.url |
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
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Oops, something went wrong.