Skip to content

Commit

Permalink
docs: update installation guide
Browse files Browse the repository at this point in the history
  • Loading branch information
ReuDa committed Sep 16, 2024
1 parent bd3a438 commit 13cb062
Showing 1 changed file with 37 additions and 28 deletions.
65 changes: 37 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,17 +29,38 @@ The extension requires the following application key scopes:

## Installation

We recommend that you install the extension with
our [official Helm chart](https://github.com/steadybit/extension-datadog/tree/main/charts/steadybit-extension-datadog).
### Kubernetes

### Helm
Detailed information about agent and extension installation in kubernetes can also be found in
our [documentation](https://docs.steadybit.com/install-and-configure/install-agent/install-on-kubernetes).

```bash
helm repo add steadybit-extension-datadog https://steadybit.github.io/extension-datadog
helm repo update
#### Recommended (via agent helm chart)

All extensions provide a helm chart that is also integrated in the
[helm-chart](https://github.com/steadybit/helm-charts/tree/main/charts/steadybit-agent) of the agent.

You must provide additional values to activate this extension.

```
--set extension-datadog.enabled=true \
--set extension-datadog.datadog.apiKey="{{API_KEY}}" \
--set extension-datadog.datadog.applicationKey="{{APPLICATION_KEY}}" \
--set extension-datadog.datadog.siteParameter="{{SITE_PARAMETER}}" \
--set extension-datadog.datadog.siteUrl="{{SITE_URL}}" \
```

Additional configuration options can be found in
the [helm-chart](https://github.com/steadybit/extension-datadog/blob/main/charts/steadybit-extension-datadog/values.yaml) of the
extension.

#### Alternative (via own helm chart)

If you need more control, you can install the extension via its
dedicated [helm-chart](https://github.com/steadybit/extension-datadog/blob/main/charts/steadybit-extension-datadog).

```bash
helm repo add steadybit-extension-datadog https://steadybit.github.io/extension-datadog
helm repo update
helm upgrade steadybit-extension-datadog \
--install \
--wait \
Expand All @@ -53,32 +74,20 @@ helm upgrade steadybit-extension-datadog \
steadybit-extension-datadog/steadybit-extension-datadog
```

### Docker

You may alternatively start the Docker container manually.

```bash
docker run \
--env STEADYBIT_LOG_LEVEL=info \
--env STEADYBIT_EXTENSION_API_KEY="{{API_KEY}}" \
--env STEADYBIT_EXTENSION_APPLICATION_KEY="{{APPLICATION_KEY}}" \
--env STEADYBIT_EXTENSION_SITE_PARAMETER="{{SITE_PARAMETER}}" \
--env STEADYBIT_EXTENSION_SITE_URL="{{SITE_URL}}" \
--expose 8090 \
ghcr.io/steadybit/extension-datadog:latest
```

## Register the extension
### Linux Package

Make sure to register the extension at the steadybit platform. Please refer to
the [documentation](https://docs.steadybit.com/integrate-with-steadybit/extensions/extension-installation) for more information.
Please use
our [agent-linux.sh script](https://docs.steadybit.com/install-and-configure/install-agent/install-on-linux-hosts)
to install the extension on your Linux machine. The script will download the latest version of the extension and install
it using the package manager.

### Linux Package
After installing, configure the extension by editing `/etc/steadybit/extension-datadog` and then restart the service.

Please use our [agent-linux.sh script](https://docs.steadybit.com/install-and-configure/install-agent/install-on-linux-hosts) to install the extension on your Linux machine.
The script will download the latest version of the extension and install it using the package manager.
## Extension registration

After installing configure the extension by editing `/etc/steadybit/extension-datadog` and then restart the service.
Make sure that the extension is registered with the agent. In most cases this is done automatically. Please refer to
the [documentation](https://docs.steadybit.com/install-and-configure/install-agent/extension-discovery) for more
information about extension registration and how to verify.


## Proxy
Expand Down

0 comments on commit 13cb062

Please sign in to comment.