This repository has been archived by the owner on Jan 19, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* New releases Signed-off-by: GitHub <[email protected]> * Fix links and Keptn version Signed-off-by: Arthur Pitman <[email protected]> Co-authored-by: TannerGilbert <[email protected]> Co-authored-by: Arthur Pitman <[email protected]>
- Loading branch information
3 people
authored
Jul 20, 2022
1 parent
2219c9c
commit 4c42d0a
Showing
2 changed files
with
110 additions
and
0 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| # Dynatrace-service | ||
|
|
||
|  | ||
|  | ||
| [](https://goreportcard.com/report/github.com/keptn-contrib/dynatrace-service) | ||
|
|
||
| ## Release validated with | ||
|
|
||
| |||| | ||
| |---|---|---| | ||
| | Dynatrace-service: `0.23.0` | Keptn: `0.16.1` | Dynatrace: `1.245` | | ||
|
|
||
|
|
||
| ## Overview | ||
|
|
||
| The dynatrace-service allows you to integrate Dynatrace monitoring in your Keptn sequences. It provides the following capabilities: | ||
|
|
||
| - [**SLI-provider**](https://raw.githubusercontent.com/keptn-contrib/dynatrace-service/master/documentation/sli-provider.md): To support the evaluation of the quality gates, the dynatrace-service can be configured to retrieve SLIs for a Keptn project, stage or service. | ||
|
|
||
| - [**Forwarding events from Keptn to Dynatrace**](https://raw.githubusercontent.com/keptn-contrib/dynatrace-service/master/documentation/event-forwarding-to-dynatrace.md): The dynatrace-service can forward events such as remediation, deployment, test start/stop, evaluation or release events to Dynatrace using attach rules to ensure that the correct monitored entities are associated with the event. | ||
|
|
||
| - [**Forwarding problem notifications from Dynatrace to Keptn**](https://raw.githubusercontent.com/keptn-contrib/dynatrace-service/master/documentation/problem-forwarding-to-keptn.md): The dynatrace-service can support triggering remediation sequences by forwarding problem notifications from Dynatrace to a Keptn environment and ensuring that the `sh.keptn.events.problem` event is mapped to the correct project, service and stage. | ||
|
|
||
| - [**Automatic onboarding of monitored service entities**](https://raw.githubusercontent.com/keptn-contrib/dynatrace-service/master/documentation/auto-service-onboarding.md): The dynatrace-service can be configured to periodically check for new service entities detected by Dynatrace and automatically import these into Keptn. | ||
|
|
||
| ### Upgrading to 0.18.0 or newer | ||
|
|
||
| If you are planning to upgrade to dynatrace-service version `0.18.0` or newer from version `0.17.1` or older, then please make sure to read and follow [these instructions on patching your secrets](https://raw.githubusercontent.com/keptn-contrib/dynatrace-service/master/documentation/patching-dynatrace-secrets.md) before doing the upgrade. | ||
|
|
||
| ## Table of contents | ||
|
|
||
| - [Installation](https://raw.githubusercontent.com/keptn-contrib/dynatrace-service/master/documentation/installation.md) | ||
| - [Downloading the latest Helm chart](https://raw.githubusercontent.com/keptn-contrib/dynatrace-service/master/documentation/installation.md#1-download-the-latest-dynatrace-service-helm-chart) | ||
| - [Gathering Keptn credentials](https://raw.githubusercontent.com/keptn-contrib/dynatrace-service/master/documentation/installation.md#2-gather-keptn-credentials) | ||
| - [Installing the dynatrace-service](https://raw.githubusercontent.com/keptn-contrib/dynatrace-service/master/documentation/installation.md#3-install-the-dynatrace-service ) | ||
| - [Project setup](https://raw.githubusercontent.com/keptn-contrib/dynatrace-service/master/documentation/project-setup.md) | ||
| - [Creating a Dynatrace API credentials secret](https://raw.githubusercontent.com/keptn-contrib/dynatrace-service/master/documentation/project-setup.md#1-create-a-dynatrace-api-credentials-secret) | ||
| - [Creating a dynatrace-service configuration file](https://raw.githubusercontent.com/keptn-contrib/dynatrace-service/master/documentation/project-setup.md#2-create-a-dynatrace-service-configuration-file-dynatracedynatraceconfyaml) | ||
| - [Configuring Dynatrace as the monitoring provider](https://raw.githubusercontent.com/keptn-contrib/dynatrace-service/master/documentation/project-setup.md#3-configure-dynatrace-as-the-monitoring-provider) | ||
| - [Feature overview](https://raw.githubusercontent.com/keptn-contrib/dynatrace-service/master/documentation/feature-overview.md) | ||
| - [SLI provider](https://raw.githubusercontent.com/keptn-contrib/dynatrace-service/master/documentation/sli-provider.md) | ||
| - [SLIs via `dynatrace/sli.yaml` files](https://raw.githubusercontent.com/keptn-contrib/dynatrace-service/master/documentation/slis-via-files.md) | ||
| - [SLIs via a Dynatrace dashboard](https://raw.githubusercontent.com/keptn-contrib/dynatrace-service/master/documentation/slis-via-dashboard.md) | ||
| - [Forwarding events from Keptn to Dynatrace](https://raw.githubusercontent.com/keptn-contrib/dynatrace-service/master/documentation/event-forwarding-to-dynatrace.md) | ||
| - [Targeting specific entities for deployment, test, evaluation and release information](https://raw.githubusercontent.com/keptn-contrib/dynatrace-service/master/documentation/event-forwarding-to-dynatrace-to-specific-entities) | ||
| - [Forwarding problem notifications from Dynatrace to Keptn](https://raw.githubusercontent.com/keptn-contrib/dynatrace-service/master/documentation/problem-forwarding-to-keptn.md) | ||
| - [Automatic onboarding of monitored service entities](https://raw.githubusercontent.com/keptn-contrib/dynatrace-service/master/documentation/auto-service-onboarding.md) | ||
| - [Troubleshooting common problems](https://raw.githubusercontent.com/keptn-contrib/dynatrace-service/master/documentation/troubleshooting.md) | ||
| - [No SLI provider configured](https://raw.githubusercontent.com/keptn-contrib/dynatrace-service/master/documentation/troubleshooting_no-sli-provider.md) | ||
| - [Configure monitoring fails](https://raw.githubusercontent.com/keptn-contrib/dynatrace-service/master/documentation/troubleshooting_configure-monitoring-fails.md) | ||
| - [Evaluation fails](https://raw.githubusercontent.com/keptn-contrib/dynatrace-service/master/documentation/troubleshooting_evaluation-fails.md) | ||
| - [Restore Keptn wildcard subscriptions `sh.keptn.*`](https://raw.githubusercontent.com/keptn-contrib/dynatrace-service/master/documentation/troubleshooting_restore-keptn-wildcard-subscriptions.md) | ||
| - Other topics | ||
| - [Additional installation options](https://raw.githubusercontent.com/keptn-contrib/dynatrace-service/master/documentation/additional-installation-options.md) | ||
| - [Dynatrace API token scopes](https://raw.githubusercontent.com/keptn-contrib/dynatrace-service/master/documentation/dynatrace-api-token-scopes.md) | ||
| - [Keptn placeholders](https://raw.githubusercontent.com/keptn-contrib/dynatrace-service/master/documentation/keptn-placeholders.md) | ||
| - [Automatic configuration of a Dynatrace tenant](https://raw.githubusercontent.com/keptn-contrib/dynatrace-service/master/documentation/auto-tenant-configuration.md) | ||
| - [Upgrading the dynatrace-service](https://raw.githubusercontent.com/keptn-contrib/dynatrace-service/master/documentation/other-topics.md#upgrading-the-dynatrace-service) | ||
| - [Uninstalling the dynatrace-service](https://raw.githubusercontent.com/keptn-contrib/dynatrace-service/master/documentation/other-topics.md#uninstalling-the-dynatrace-service) | ||
| - [Developing the dynatrace-service](https://raw.githubusercontent.com/keptn-contrib/dynatrace-service/master/documentation/other-topics.md#developing-the-dynatrace-service) |
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,50 @@ | ||
| version: 0.23.0 | ||
| name: dynatrace-service | ||
| displayName: Dynatrace Service | ||
| createdAt: '2022-07-14T12:23:10Z' | ||
| description: Keptn service that forwards Keptn events - occurring during a delivery | ||
| workflow - to Dynatrace. | ||
| logoURL: https://avatars.githubusercontent.com/u/6412311 | ||
| digest: '2022-07-14T12:23:10Z' | ||
| license: Apache-2.0 | ||
| homeURL: https://keptn.sh/docs/integrations/ | ||
| keywords: | ||
| - keptn | ||
| - dynatrace | ||
| - contrib | ||
| - observability | ||
| links: | ||
| - name: Source | ||
| url: https://github.com/keptn-contrib/dynatrace-service | ||
| install: "# Installation\n\nThe dynatrace-service can be installed in three steps:\n\ | ||
| \n## 1. Download the latest dynatrace-service Helm chart\n\nDownload [the latest\ | ||
| \ dynatrace-service Helm chart](https://github.com/keptn-contrib/dynatrace-service/releases/latest/)\ | ||
| \ from GitHub. Please ensure that the version of the dynatrace-service is compatible\ | ||
| \ with the version of Keptn you have installed by consulting the [Compatibility\ | ||
| \ Matrix](compatibility.md). Details on installing or upgrading Keptn can be found\ | ||
| \ on the [Keptn website](https://keptn.sh/docs/quickstart/).\n\n## 2. Gather Keptn\ | ||
| \ credentials\n\nThe dynatrace-service requires access to the Keptn API consisting\ | ||
| \ of `KEPTN_API_URL`, `KEPTN_API_TOKEN` and optionally `KEPTN_BRIDGE_URL`.\n\n*\ | ||
| \ To get the values for `KEPTN_API_URL` (also known as `KEPTN_ENDPOINT`), please\ | ||
| \ see [Authenticate Keptn CLI](https://keptn.sh/docs/0.16.x/operate/install/#authenticate-keptn-cli).\n\ | ||
| \n* By default, the `KEPTN_API_TOKEN` is read from the `keptn-api-token` secret\ | ||
| \ (i.e., the secret from the control-plane) and does not need to be set during installation.\n\ | ||
| \n* If you would like to use backlinks from your Dynatrace tenant to the Keptn Bridge,\ | ||
| \ provide the service with `KEPTN_BRIDGE_URL`. For further details about this value,\ | ||
| \ please see [Authenticate Keptn Bridge](https://keptn.sh/docs/0.16.x/operate/install/#authenticate-keptn-bridge).\n\ | ||
| \nIf running on a Linux or Unix based system, you can assign these to environment\ | ||
| \ variables to simplify the installation process: \n\n```console\nKEPTN_API_URL=<KEPTN_API_URL>\n\ | ||
| KEPTN_BRIDGE_URL=<KEPTN_BRIDGE_URL> # optional\n```\n\nAlternatively, replace the\ | ||
| \ variables with the actual values in the `helm upgrade` command in the following\ | ||
| \ section.\n\n\n## 3. Install the dynatrace-service\n\nTo install the dynatrace-service\ | ||
| \ in the standard `keptn` namespace, execute:\n\n```console\nhelm upgrade --install\ | ||
| \ dynatrace-service -n keptn \\\n <HELM_CHART_FILENAME> \\\n --set dynatraceService.config.keptnApiUrl=$KEPTN_API_URL\ | ||
| \ \\\n --set dynatraceService.config.keptnBridgeUrl=$KEPTN_BRIDGE_URL\n```\n\n\ | ||
| **Note:** \n- You can select additional installation options by appending key-value\ | ||
| \ pairs with the syntax `--set key=value`.\n" | ||
| recommendations: | ||
| - url: https://artifacthub.io/packages/helm/keptn/keptn | ||
| annotations: | ||
| keptn/kind: observability | ||
| keptn/org: contrib | ||
| keptn/version: 0.16.x |