|
1 | 1 | # README |
2 | 2 |
|
3 | | -**BEFORE YOU START**, please be aware that there are more ways to integrate with your service that don't require creating a service from this template, see https://keptn.sh/docs/0.14.x/integrations/how_integrate/ for more details. |
| 3 | +**PLEASE CONSIDER USING ALTERNATIVE WAYS OF CREATING YOUR KEPTN INTEGRATION**. |
| 4 | + |
| 5 | +There are more ways to integrate with your service that don't require creating a service from this template, see https://keptn.sh/docs/0.17.x/integrations/how_integrate/ for more details. |
4 | 6 |
|
5 | 7 | Examples: |
6 | 8 |
|
7 | 9 | * Webhooks: https://keptn.sh/docs/0.17.x/integrations/webhooks/ |
8 | 10 | * Job-Executor-Service: https://github.com/keptn-sandbox/job-executor-service |
9 | 11 |
|
| 12 | +In addition, creating your own integration based on the service-template has been reduced to just using [Keptn's go-utils]( https://github.com/keptn/go-utils/) |
| 13 | +and is based on [**the example provided in go-utils**](https://github.com/keptn/go-utils/tree/master/examples/go-sdk). |
| 14 | + |
10 | 15 | --- |
11 | 16 |
|
12 | 17 | This is a Keptn Service Template written in GoLang. Follow the instructions below for writing your own Keptn integration. |
@@ -94,15 +99,14 @@ When writing code, it is recommended to follow the coding style suggested by the |
94 | 99 |
|
95 | 100 | ### Where to start |
96 | 101 |
|
97 | | -If you don't care about the details, your first entrypoint is [eventhandlers.go](eventhandlers.go). Within this file |
98 | | - you can add implementation for pre-defined Keptn Cloud events. |
99 | | - |
| 102 | +Please read the documentation provided by [Keptn/go-utils](https://github.com/keptn/go-utils/tree/master/examples/go-sdk), as it explains how to integrate with Keptn. |
| 103 | + |
100 | 104 | To better understand all variants of Keptn CloudEvents, please look at the [Keptn Spec](https://github.com/keptn/spec). |
101 | 105 |
|
102 | | -If you want to get more insights into processing those CloudEvents or even defining your own CloudEvents in code, please |
103 | | - look into [main.go](main.go) (specifically `processKeptnCloudEvent`), [chart/values.yaml](chart/values.yaml), |
104 | | - consult the [Keptn docs](https://keptn.sh/docs/) as well as existing [Keptn Core](https://github.com/keptn/keptn) and |
105 | | - [Keptn Contrib](https://github.com/keptn-contrib/) services. |
| 106 | +If you want to look at handler implementations, you can take a look at the [go-utils based example](https://github.com/keptn/go-utils/blob/master/examples/go-sdk/handler.go), |
| 107 | +as well as the concrete implementations within the [handler/](handler/) folder, e.g.: |
| 108 | +* [action-triggered](handler/action_triggered_event_handler.go) |
| 109 | +* [get-sli-triggered](handler/get_sli_triggered_event_handler.go) |
106 | 110 |
|
107 | 111 | ### Common tasks |
108 | 112 |
|
@@ -136,11 +140,7 @@ You can find the details in [.github/workflows/CI.yml](.github/workflows/CI.yml) |
136 | 140 |
|
137 | 141 | ### GH Actions/Workflow: Build Docker Images |
138 | 142 |
|
139 | | -This repo uses GH Actions and Workflows to test the code and automatically build docker images. |
140 | | - |
141 | | -Docker Images are automatically pushed based on the configuration done in [.ci_env](.ci_env) and the two [GitHub Secrets](https://github.com/keptn-sandbox/keptn-service-template-go/settings/secrets/actions) |
142 | | -* `REGISTRY_USER` - your DockerHub username |
143 | | -* `REGISTRY_PASSWORD` - a DockerHub [access token](https://hub.docker.com/settings/security) (alternatively, your DockerHub password) |
| 143 | +This repo uses GH Actions and Workflows to test the code and automatically build containers and upload it to `ghcr.io`. |
144 | 144 |
|
145 | 145 | ## How to release a new version of this service |
146 | 146 |
|
|
0 commit comments