Skip to content

Commit

Permalink
Add helm install method (#29)
Browse files Browse the repository at this point in the history
* add install instruction with helm

* re-order kubectl gs arguments

* rework install section
  • Loading branch information
TheoBrigitte authored Aug 10, 2024
1 parent 4949fad commit 6817301
Showing 1 changed file with 19 additions and 5 deletions.
24 changes: 19 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,16 +30,30 @@ Anyone with a need to collect observability data and who need an [OpenTelemetry]

There are several ways to install this app onto a workload cluster.

- [Using GitOps](https://docs.giantswarm.io/vintage/advanced/gitops/apps/add_appcr/)
- [Using our web interface](https://docs.giantswarm.io/vintage/platform-overview/web-interface/app-platform/#installing-an-app)
- [Using the App platform](https://docs.giantswarm.io/vintage/getting-started/app-platform/deploy-app/) ([kubectl gs template app](https://docs.giantswarm.io/vintage/use-the-api/kubectl-gs/template-app/) reference)
### Using `helm`

Example with `kubectl gs`:
```
helm repo add giantswarm https://giantswarm.github.io/giantswarm-catalog/
helm repo update
helm install alloy giantswarm/alloy --values helm/alloy/examples/mimir-rules/values.yaml
```

### Using `kubectl` GiantSwarm plugin

```
kubectl gs template app --name alloy --catalog giantswarm-playground --target-namespace alloy --cluster-name myCluster --version 0.1.0 --user-configmap helm/alloy/examples/mimir-rules/values.yaml | kubectl apply -f -
kubectl gs template app --cluster-name myCluster --name alloy --catalog giantswarm --target-namespace alloy --version 1.0.0 --user-configmap helm/alloy/examples/mimir-rules/values.yaml | kubectl apply -f -
```

See [App platform documentation](https://docs.giantswarm.io/vintage/getting-started/app-platform/deploy-app/) and [kubectl gs template app](https://docs.giantswarm.io/vintage/use-the-api/kubectl-gs/template-app/) reference.

### Using GiantsSwarm web interface

See [Web interface documentation](https://docs.giantswarm.io/vintage/platform-overview/web-interface/app-platform/#installing-an-app)

### Using GitOps

See [GitOps documentation](https://docs.giantswarm.io/vintage/advanced/gitops/apps/add_appcr/)

## Configuring

See examples in [helm/alloy/examples](helm/alloy/examples) for how to configure the app.
Expand Down

0 comments on commit 6817301

Please sign in to comment.