keptn-sail-down

README

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:

1. In case you want to contribute your service to keptn-sandbox or keptn-contrib, make sure you have read and understood the Contributing Guidelines.
2. 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)
3. Run GitHub workflow One-time repository initialization to 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.
4. 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.
5. Last but not least: Remove this intro within the README file and make sure the README file properly states what this repository is about

keptn-sail-down

This implements a keptn-sail-down for Keptn. If you want to learn more about Keptn visit us on keptn.sh

Compatibility Matrix

Please fill in your versions accordingly

Installation

The keptn-sail-down can be installed as a part of Keptn's uniform.

Deploy in your Kubernetes cluster

To deploy the current version of the keptn-sail-down in your Keptn Kubernetes cluster use the helm chart file, for example:

helm install -n keptn keptn-sail-down chart/

This should install the keptn-sail-down together with a Keptn distributor into the keptn namespace, which you can verify using

kubectl -n keptn get deployment keptn-sail-down -o wide
kubectl -n keptn get pods -l run=keptn-sail-down

Up- or Downgrading

Adapt 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 keptn-sail-down chart/

Uninstall

To delete a deployed keptn-sail-down, use the file deploy/*.yaml files from this repository and delete the Kubernetes resources:

helm uninstall -n keptn keptn-sail-down

Development

Development 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:

• main/master contains the latest potentially unstable version
• release-* contains a stable version of the service (e.g., release-0.1.0 contains version 0.1.0)
• create a new branch for any changes that you are working on, e.g., feature/my-cool-stuff or bug/overflow
• once ready, create a pull request from that branch back to the main/master branch

When writing code, it is recommended to follow the coding style suggested by the Golang community.

Where to start

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.

Common tasks

• Build the binary: go build -ldflags '-linkmode=external' -v -o keptn-sail-down
• Run tests: go test -race -v ./...
• Build the docker image: docker build . -t christian-kreuzberger-dtx/keptn-sail-down:dev (Note: Ensure that you use the correct DockerHub account/organization)
• Run the docker image locally: docker run --rm -it -p 8080:8080 christian-kreuzberger-dtx/keptn-sail-down:dev
• Push the docker image to DockerHub: docker push christian-kreuzberger-dtx/keptn-sail-down: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 keptn-sail-down -o wide
• Get logs using kubectl: kubectl -n keptn logs deployment/keptn-sail-down -f
• Watch the deployed pods using kubectl: kubectl -n keptn get pods -l run=keptn-sail-down
• Deploy the service using Skaffold: skaffold run --default-repo=your-docker-registry --tail (Note: Replace your-docker-registry with your container image registry (defaults to ghcr.io/christian-kreuzberger-dtx/keptn-sail-down); also make sure to adapt the image name in skaffold.yaml)

Testing Cloud Events

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.

Automation

GitHub Actions: Automated Pull Request Review

This repo uses reviewdog for automated reviews of Pull Requests.

You can find the details in .github/workflows/reviewdog.yml.

GitHub Actions: Unit Tests

This repo has automated unit tests for pull requests.

You can find the details in .github/workflows/CI.yml.

GH Actions/Workflow: Build Docker Images

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 username
• REGISTRY_PASSWORD - a DockerHub access token (alternatively, your DockerHub password)

How to release a new version of this service

It is assumed that the current development takes place in the main/master branch (either via Pull Requests or directly).

Once you're ready, go to the Actions tab on GitHub, select Pre-Release or Release, and run the action.

License

Please find more information in the LICENSE file.