New releases

Signed-off-by: GitHub <[email protected]>

datadog-service/0.19.0/README.md

@@ -0,0 +1,193 @@
+# datadog-service
+![GitHub release (latest by date)](https://img.shields.io/github/v/release/keptn-sandbox/datadog-service)
+[![Go Report Card](https://goreportcard.com/badge/github.com/keptn-sandbox/datadog-service)](https://goreportcard.com/report/github.com/keptn-sandbox/datadog-service)
+
+This implements the `datadog-service` that integrates the [Datadog](https://en.wikipedia.org/wiki/Datadog) observability platform with Keptn. This enables you to use Datadog as the source for the Service Level Indicators ([SLIs](https://keptn.sh/docs/0.19.x/reference/files/sli/)) that are used for Keptn [Quality Gates](https://keptn.sh/docs/concepts/quality_gates/).
+If you want to learn more about Keptn visit us on [keptn.sh](https://keptn.sh)
+
+Check the issue on the main repo for more info: https://github.com/keptn/keptn/issues/2652
+
+
+## Quickstart
+If you are on Mac or Linux, you can use [examples/kup.sh](https://raw.githubusercontent.com/keptn-sandbox/datadog-service/release-0.19.0/examples/kup.sh) to set up a local Keptn installation that uses Datadog. This script creates a local minikube cluster, installs Keptn, Istio, Datadog and the Datadog integration for Keptn (check the script for pre-requisites). 
+
+To use the script,
+```bash
+export DD_API_KEY="<your-datadog-api-key>" DD_APP_KEY="<your-datadog-app-key>" DD_SITE="datadoghq.com" 
+examples/kup.sh
+```
+Check [the official docs](https://docs.datadoghq.com/account_management/api-app-keys/) for how to create the Datadog API key and Application key
+
+Note: Application keys get the same permissions as you. You might want to narrow down the permissions (datadog-service only reads metrics from the API. Check the official docs linked above for more information).
+
+## If you already have a Keptn cluster running
+1. Install datadog
+```bash
+export DD_API_KEY="<your-datadog-api-key>" DD_APP_KEY="<your-datadog-app-key>" DD_SITE="datadoghq.com" 
+helm install datadog --set datadog.apiKey=${DD_API_KEY} datadog/datadog --set datadog.appKey=${DD_APP_KEY} --set datadog.site=${DD_SITE} --set clusterAgent.enabled=true --set clusterAgent.metricsProvider.enabled=true --set clusterAgent.createPodDisruptionBudget=true --set clusterAgent.replicas=2
+
+```
+2. Install Keptn datadog-service to integrate Datadog with Keptn
+```bash
+export DD_API_KEY="<your-datadog-api-key>" DD_APP_KEY="<your-datadog-app-key>" DD_SITE="datadoghq.com" 
+# cd datadog-service
+helm install datadog-service ./helm --set datadogservice.ddApikey=${DD_API_KEY} --set datadogservice.ddAppKey=${DD_APP_KEY} --set datadogservice.ddSite=${DD_SITE}
+```
+
+3. Add SLI and SLO
+```bash
+keptn add-resource --project="<your-project>" --stage="<stage-name>" --service="<service-name>" --resource=/path-to/your/sli-file.yaml --resourceUri=datadog/sli.yaml
+keptn add-resource --project="<your-project>" --stage="<stage-name>" --service="<service-name>" --resource=/path-to/your/slo-file.yaml --resourceUri=slo.yaml
+```
+Example:
+```bash
+keptn add-resource --project="podtatohead" --stage="hardening" --service="helloservice" --resource=./quickstart/sli.yaml --resourceUri=datadog/sli.yaml
+keptn add-resource --project="podtatohead" --stage="hardening" --service="helloservice" --resource=./quickstart/slo.yaml --resourceUri=slo.yaml
+```
+Check [./quickstart/sli.yaml](https://raw.githubusercontent.com/keptn-sandbox/datadog-service/release-0.19.0/examples/quickstart/sli.yaml) and [./quickstart/slo.yaml](https://raw.githubusercontent.com/keptn-sandbox/datadog-service/release-0.19.0/examples/quickstart/slo.yaml) for example SLI and SLO. 
+
+4. Configure Keptn to use datadog SLI provider
+Use keptn CLI version [0.15.0](https://github.com/keptn/keptn/releases/tag/0.15.0) or later.
+```bash
+keptn configure monitoring datadog --project <project-name> --service <service-name>
+```
+
+5. Trigger delivery
+```bash
+keptn trigger delivery --project=<project-name> --service=<service-name> --image=<image> --tag=<tag>
+```
+Example:
+```bash
+keptn trigger delivery --project=podtatohead --service=helloservice --image=docker.io/jetzlstorfer/helloserver --tag=0.1.1
+```
+Observe the results in the [Keptn Bridge](https://keptn.sh/docs/0.19.x/bridge/)
+## Compatibility Matrix
+
+*Please fill in your versions accordingly*
+
+| Keptn Version | [datadog-service Docker Image](https://github.com/keptn-sandbox/datadog-service/pkgs/container/datadog-service) |
+|:----------------:|:----------------------------------------:|
+| 0.11.4 | ghcr.io/keptn-sandbox/datadog-service:0.1.0 |
+| 0.11.4 | ghcr.io/keptn-sandbox/datadog-service:0.2.0 |
+| 0.15.0 | ghcr.io/keptn-sandbox/datadog-service:0.15.0 | 
+| 0.19.0 | ghcr.io/keptn-sandbox/datadog-service:0.19.0 | 
+
+datadog-service version will match Keptn version starting from 0.15.0 version of Keptn e.g., datadog-service 0.15.x is compatible with Keptn 0.15.x 
+
+## Installation
+
+```bash
+export DD_API_KEY="<your-datadog-api-key>" DD_APP_KEY="<your-datadog-app-key>" DD_SITE="datadoghq.com" 
+# cd datadog-service
+helm install datadog-service ./helm --set datadogservice.ddApikey=${DD_API_KEY} --set datadogservice.ddAppKey=${DD_APP_KEY} --set datadogservice.ddSite=${DD_SITE}
+```
+Tell Keptn to use datadog as SLI provider for your project/service
+```bash
+keptn configure monitoring datadog --project <project-name> --service <service-name>
+```
+
+This should install the `datadog-service` together with a Keptn `distributor` into the `keptn` namespace, which you can verify using
+
+```console
+kubectl -n keptn get deployment datadog-service -o wide
+kubectl -n keptn get pods -l run=datadog-service
+```
+### 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):
+
+```bash
+helm upgrade datadog-service ./helm --set datadogservice.ddApikey=${DD_API_KEY} --set datadogservice.ddAppKey=${DD_APP_KEY} --set datadogservice.ddSite=${DD_SITE}
+```
+
+### Uninstall
+
+To delete a deployed *datadog-service* helm chart:
+
+```bash
+helm uninstall datadog-service
+```
+
+## 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:
+
+* `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 `master` branch
+
+When writing code, it is recommended to follow the coding style suggested by the [Golang community](https://github.com/golang/go/wiki/CodeReviewComments).
+
+### Where to start
+
+If you don't care about the details, your first entrypoint is [https://raw.githubusercontent.com/keptn-sandbox/datadog-service/release-0.19.0/eventhandlers.go](https://raw.githubusercontent.com/keptn-sandbox/datadog-service/release-0.19.0/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](https://github.com/keptn/spec).
+
+If you want to get more insights into processing those CloudEvents or even defining your own CloudEvents in code, please 
+ look into [https://raw.githubusercontent.com/keptn-sandbox/datadog-service/release-0.19.0/main.go](https://raw.githubusercontent.com/keptn-sandbox/datadog-service/release-0.19.0/main.go) (specifically `processKeptnCloudEvent`), [https://raw.githubusercontent.com/keptn-sandbox/datadog-service/release-0.19.0/helm/templates](https://raw.githubusercontent.com/keptn-sandbox/datadog-service/release-0.19.0/helm/templates),
+ consult the [Keptn docs](https://keptn.sh/docs/) as well as existing [Keptn Core](https://github.com/keptn/keptn) and
+ [Keptn Contrib](https://github.com/keptn-contrib/) services.
+
+### Common tasks
+
+* Build the binary: `go build -ldflags '-linkmode=external' -v -o datadog-service`
+* Run tests: `go test -race -v ./...`
+* Build the docker image: `docker build . -t ghcr.io/keptn-sandbox/datadog-service:latest`
+* Run the docker image locally: `docker run --rm -it -p 8080:8080 ghcr.io/keptn-sandbox/datadog-service:latest`
+* Push the docker image to DockerHub: `docker push ghcr.io/keptn-sandbox/datadog-service:latest`
+* Watch the deployment using `kubectl`: `kubectl -n keptn get deployment datadog-service -o wide`
+* Get logs using `kubectl`: `kubectl -n keptn logs deployment/datadog-service -f`
+* Watch the deployed pods using `kubectl`: `kubectl -n keptn get pods -l run=datadog-service`
+
+
+### Testing Cloud Events
+
+We have dummy cloud-events in the form of [RFC 2616](https://ietf.org/rfc/rfc2616.txt) requests in the [https://raw.githubusercontent.com/keptn-sandbox/datadog-service/release-0.19.0/test-events/](https://raw.githubusercontent.com/keptn-sandbox/datadog-service/release-0.19.0/test-events/) directory. These can be easily executed using third party plugins such as the [Huachao Mao REST Client in VS Code](https://marketplace.visualstudio.com/items?itemName=humao.rest-client).
+
+## Automation
+
+### GitHub Actions: Automated Pull Request Review
+
+This repo uses [reviewdog](https://github.com/reviewdog/reviewdog) for automated reviews of Pull Requests. 
+
+You can find the details in [https://raw.githubusercontent.com/keptn-sandbox/datadog-service/release-0.19.0/.github/workflows/reviewdog.yml](https://raw.githubusercontent.com/keptn-sandbox/datadog-service/release-0.19.0/.github/workflows/reviewdog.yml).
+
+### GitHub Actions: Unit Tests
+
+This repo has automated unit tests for pull requests. 
+
+You can find the details in [https://raw.githubusercontent.com/keptn-sandbox/datadog-service/release-0.19.0/.github/workflows/tests.yml](https://raw.githubusercontent.com/keptn-sandbox/datadog-service/release-0.19.0/.github/workflows/tests.yml).
+
+## How to release a new version of this service
+
+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` (where `x.y.z` is your version),
+* write release notes in the [https://raw.githubusercontent.com/keptn-sandbox/datadog-service/release-0.19.0/releasenotes/](https://raw.githubusercontent.com/keptn-sandbox/datadog-service/release-0.19.0/releasenotes/) folder,
+* check the output of GH Actions builds for the release branch, 
+* verify that your image was built and pushed to GHCR 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](https://github.com/keptn-sandbox/datadog-service/releases), and
+* merge any changes from the release branch back to the master branch.
+
+## Known problems
+1. If the evaluation window of the query is too short, the api might return an empty result which datadog-service treats as 0 and fails the evaluation. [Issue](https://github.com/keptn-sandbox/datadog-service/issues/10)
+2. There is an on-purpose 60s delay before the datadog metrics API is called. This is because, calling the metrics API earlier leads to incorrect data. [Issue](https://github.com/keptn-sandbox/datadog-service/issues/8)
+3. Does not support default queries for throughput, error rate, request latency etc., i.e., you have to enter the entire query. [Issue](https://github.com/keptn-sandbox/datadog-service/issues/9)
+
+## License
+
+Please find more information in the [https://raw.githubusercontent.com/keptn-sandbox/datadog-service/release-0.19.0/LICENSE](https://raw.githubusercontent.com/keptn-sandbox/datadog-service/release-0.19.0/LICENSE) file.

datadog-service/0.19.0/artifacthub-pkg.yml

@@ -0,0 +1,29 @@
+version: 0.19.0
+name: datadog-service
+displayName: datadog-service
+createdAt: '2022-09-21T06:40:05Z'
+description: Keptn SLI provider for datadog
+digest: '2022-09-21T06:40:05Z'
+license: Apache-2.0
+homeURL: https://keptn.sh/docs/integrations/
+keywords:
+- keptn
+- sandbox
+- observability
+- monitoring
+- sli-provider
+links:
+- name: Source
+ url: https://github.com/keptn-sandbox/datadog-service/tree/release-0.15.0
+annotations:
+ keptn/org: sandbox
+ keptn/kind: observability
+ keptn/version: 0.15.x
+install: "## Execute the following steps to install datadog-service:\n\n ```\n export\
+ \ DD_API_KEY='<your-datadog-api-key>' DD_APP_KEY='<your-datadog-app-key>' DD_SITE='datadoghq.com'\
+ \ \n\n helm install -n keptn datadog-service https://github.com/keptn-sandbox/datadog-service/releases/download/0.15.0/\
+ \  datadog-service-0.15.0.tar.gz --set datadogservice.ddApikey=${DD_API_KEY} --set\
+ \ datadogservice.ddAppKey=${DD_APP_KEY} --set datadogservice.ddSite=${DD_SITE}\
+ \ \n ``` \n\n Check [the official docs](https://docs.datadoghq.com/account_management/api-app-keys/)\
+ \ for \n how to create Datadog API key and Application key \n\n\n ### More Information\
+ \ \n\n More information can be found in our [GitHub repository](https://github.com/keptn-sandbox/datadog-service)."