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 4dbc3d9 commit 96d7612
Showing 1 changed file with 36 additions and 13 deletions.
49 changes: 36 additions & 13 deletions README.SCAFFOLD.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,19 +16,32 @@ The extension supports all environment variables provided by [steadybit/extensio

## Installation

### Using Docker

```sh
docker run \
--rm \
-p 8080 \
--name steadybit-extension-scaffold \
ghcr.io/steadybit/extension-scaffold:latest
### 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.

```
--set extension-scaffold.enabled=true \
```

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

```sh
#### 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-scaffold/blob/main/charts/steadybit-extension-scaffold).

```bash
helm repo add steadybit-extension-scaffold https://steadybit.github.io/extension-scaffold
helm repo update
helm upgrade steadybit-extension-scaffold \
Expand All @@ -40,7 +53,17 @@ helm upgrade steadybit-extension-scaffold \
steadybit-extension-scaffold/steadybit-extension-scaffold
```

## 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-scaffold` and then restart the service.

## Extension registration

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.
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 96d7612

Please sign in to comment.