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 d8a2339 commit e4be0ed
Showing 1 changed file with 36 additions and 14 deletions.
50 changes: 36 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,20 +28,33 @@ https://learn.microsoft.com/en-us/azure/active-directory/develop/howto-create-se

## Installation

### Using Docker
### Kubernetes

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).

#### 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.

```sh
docker run \
--rm \
-p 8092 \
--name steadybit-extension-azure \
-e AZURE_CLIENT_ID='YOUR_CLIENT_ID' \
-e AZURE_CLIENT_SECRET='YOUR_CLIENT_SECRET' \
-e AZURE_TENANT_ID='YOUR_TENANT_ID' \
ghcr.io/steadybit/extension-azure:latest
```
--set extension-azure.enabled=true \
--set extension-azure.azure.clientID=YOUR_CLIENT_ID \
--set extension-azure.azure.clientSecret=YOUR_CLIENT_SECRET \
--set extension-azure.azure.tenantID=YOUR_TENANT_ID \
```

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

#### Alternative (via own helm chart)

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

```sh
helm repo add steadybit-extension-azure https://steadybit.github.io/extension-azure
Expand All @@ -58,8 +71,17 @@ helm upgrade steadybit-extension-azure \
steadybit-extension-azure/steadybit-extension-azure
```

## Register the extension
### Linux Package

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.

After installing, configure the extension by editing `/etc/steadybit/extension-azure` and then restart the service.

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.
## Extension registration

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.

0 comments on commit e4be0ed

Please sign in to comment.