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.10.x/integrations/how_integrate/ for more details.
Examples:
- Webhooks: https://keptn.sh/docs/0.10.x/integrations/webhooks/
- Job-Executor-Service: https://github.com/keptn-sandbox/job-executor-service
This is a Keptn Service Template written in GoLang. Follow the instructions below for writing your own Keptn integration.
Quick start:
- In case you want to contribute your service to keptn-sandbox or keptn-contrib, make sure you have read and understood the Contributing Guidelines.
- Click Use this template on top of the repository, or download the repo as a zip-file, extract it into a new folder named after the service you want to create (e.g., simple-service)
- Run GitHub workflow
One-time repository initializationto tailor deployment files and go modules to the new instance of the keptn service template. This will create a Pull Request containing the necessary changes, review it, adjust if necessary and merge it. - Figure out whether your Kubernetes Deployment requires any RBAC rules or a different service-account, and adapt chart/templates/serviceaccount.yaml accordingly for the roles.
- Last but not least: Remove this intro within the README file and make sure the README file properly states what this repository is about
This implements a automatic-octo-telegram for Keptn. If you want to learn more about Keptn visit us on keptn.sh
Please fill in your versions accordingly
| Keptn Version | Keptn-Service-Template-Go Docker Image |
|---|---|
| 0.6.1 | raffy23/automatic-octo-telegram:0.1.0 |
| 0.7.1 | raffy23/automatic-octo-telegram:0.1.1 |
| 0.7.2 | raffy23/automatic-octo-telegram:0.1.2 |
The automatic-octo-telegram can be installed as a part of Keptn's uniform.
To deploy the current version of the automatic-octo-telegram in your Keptn Kubernetes cluster use the helm chart file,
for example:
helm install -n keptn automatic-octo-telegram chart/This should install the automatic-octo-telegram together with a Keptn distributor into the keptn namespace, which you can verify using
kubectl -n keptn get deployment automatic-octo-telegram -o wide
kubectl -n keptn get pods -l run=automatic-octo-telegramAdapt and use the following command in case you want to up- or downgrade your installed version (specified by the $VERSION placeholder):
helm upgrade -n keptn --set image.tag=$VERSION automatic-octo-telegram chart/To delete a deployed automatic-octo-telegram, use the file deploy/*.yaml files from this repository and delete the Kubernetes resources:
helm uninstall -n keptn automatic-octo-telegramDevelopment can be conducted using any GoLang compatible IDE/editor (e.g., Jetbrains GoLand, VSCode with Go plugins).
It is recommended to make use of branches as follows:
mastercontains the latest potentially unstable versionrelease-*contains a stable version of the service (e.g.,release-0.1.0contains version 0.1.0)- create a new branch for any changes that you are working on, e.g.,
feature/my-cool-stufforbug/overflow - once ready, create a pull request from that branch back to the
masterbranch
When writing code, it is recommended to follow the coding style suggested by the Golang community.
If you don't care about the details, your first entrypoint is eventhandlers.go. Within this file you can add implementation for pre-defined Keptn Cloud events.
To better understand all variants of Keptn CloudEvents, please look at the Keptn Spec.
If you want to get more insights into processing those CloudEvents or even defining your own CloudEvents in code, please
look into main.go (specifically processKeptnCloudEvent), chart/values.yaml,
consult the Keptn docs as well as existing Keptn Core and
Keptn Contrib services.
- Build the binary:
go build -ldflags '-linkmode=external' -v -o automatic-octo-telegram - Run tests:
go test -race -v ./... - Build the docker image:
docker build . -t raffy23/automatic-octo-telegram:dev(Note: Ensure that you use the correct DockerHub account/organization) - Run the docker image locally:
docker run --rm -it -p 8080:8080 raffy23/automatic-octo-telegram:dev - Push the docker image to DockerHub:
docker push raffy23/automatic-octo-telegram:dev(Note: Ensure that you use the correct DockerHub account/organization) - Deploy the service using
kubectl:kubectl apply -f deploy/ - Delete/undeploy the service using
kubectl:kubectl delete -f deploy/ - Watch the deployment using
kubectl:kubectl -n keptn get deployment automatic-octo-telegram -o wide - Get logs using
kubectl:kubectl -n keptn logs deployment/automatic-octo-telegram -f - Watch the deployed pods using
kubectl:kubectl -n keptn get pods -l run=automatic-octo-telegram - Deploy the service using Skaffold:
skaffold run --default-repo=your-docker-registry --tail(Note: Replaceyour-docker-registrywith your container image registry (defaults to ghcr.io/raffy23/automatic-octo-telegram); also make sure to adapt the image name in skaffold.yaml)
We have dummy cloud-events in the form of RFC 2616 requests in the test-events/ directory. These can be easily executed using third party plugins such as the Huachao Mao REST Client in VS Code.
This repo uses reviewdog for automated reviews of Pull Requests.
You can find the details in .github/workflows/reviewdog.yml.
This repo has automated unit tests for pull requests.
You can find the details in .github/workflows/CI.yml.
This repo uses GH Actions and Workflows to test the code and automatically build docker images.
Docker Images are automatically pushed based on the configuration done in .ci_env and the two GitHub Secrets
REGISTRY_USER- your DockerHub usernameREGISTRY_PASSWORD- a DockerHub access token (alternatively, your DockerHub password)
It is assumed that the current development takes place in the master branch (either via Pull Requests or directly).
To make use of the built-in automation using GH Actions for releasing a new version of this service, you should
- branch away from master to a branch called
release-x.y.z(wherex.y.zis your version), - write release notes in the releasenotes/ folder,
- check the output of GH Actions builds for the release branch,
- verify that your image was built and pushed to DockerHub with the right tags,
- update the image tags in [deploy/service.yaml], and
- test your service against a working Keptn installation.
If any problems occur, fix them in the release branch and test them again.
Once you have confirmed that everything works and your version is ready to go, you should
- create a new release on the release branch using the GitHub releases page, and
- merge any changes from the release branch back to the master branch.
Please find more information in the LICENSE file.