Skip to content

Commit

Permalink
docs(chart): fix installation commands
Browse files Browse the repository at this point in the history
Also: remove the sections "Upgrading" and "Configuration" for now.

[skip ci]
  • Loading branch information
basti1302 committed Jun 27, 2024
1 parent acf8f8f commit 673edf0
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 11 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,5 @@ go.work
*.swp
*.swo
*~

dash0-operator-values.yaml
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ infrastructure to Dash0.
The Dash0 Kubernetes operator enables gathering OpenTelemetry data from your workloads for a selection of supported
runtimes.

The Dash0 Kubernetes operator is currently in beta.
The Dash0 Kubernetes operator is currently available as a technical preview.

Supported runtimes:

Expand All @@ -20,4 +20,4 @@ Supported runtimes:
## Getting Started

The preferred method of installation is via the operator's
[Helm chart](https://github.com/dash0hq/dash0-operator/helm-chart/dash0-operator/README.md).
[Helm chart](https://github.com/dash0hq/dash0-operator/blob/main/helm-chart/dash0-operator/README.md).
59 changes: 50 additions & 9 deletions helm-chart/dash0-operator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,23 +28,64 @@ https://github.com/dash0hq/dash0-operator/blob/main/README.md.
Before installing the operator, add the Helm repository as follows:

```console
$ helm repo add dash0-operator {TODO: add repository URL}
helm repo add dash0-operator https://dash0hq.github.io/dash0-operator
helm repo update
```

Then install the operator to your cluster like this:
Create a file named `dash0-operator-values.yaml` with the following content:

```yaml
#
# Note: The required values for the authorization token and OTLP/gRPC endpoint
# can be copied from https://app.dash0.com/settings (you need to be logged in).
#

opentelemetry-collector:
config:
extensions:
bearertokenauth/dash0:
token: "auth_..." # <- put your actual Dash0 Authorization Token here

exporters:
otlp:
auth:
authenticator: bearertokenauth/dash0
endpoint: "ingress.XX-XXXX-X.aws.dash0.com:4317" # <- pur your actual OTLP/gRPC endpoint here

service:
extensions:
- health_check
- memory_ballast
- bearertokenauth/dash0
```
Edit the file to replace the placeholders for the token and the endpoint.
The required values can be found in the Dash0 web application at https://app.dash0.com/settings.
Then install the operator to your cluster via Helm with the following command:
```console
helm install dash0-operator dash0-operator ... TODO ...
helm install \
--namespace dash0-operator-system \
--create-namespace \
--values dash0-operator-values.yaml \
dash0-operator \
dash0-operator/dash0-operator
```

## Upgrading
## Uninstallation

TODO
To remove the Dash0 Kubernetes Operator from your cluster, run the following command:

## Configuration
```
helm uninstall dash0-operator --namespace dash0-operator-system
```

TODO
Depending on the command you used to install the operator, you may need to use a different Helm release name or
namespace.

```yaml
...
Optionally, remove the namespace that has been created for the operator:

```
kubectl delete namespace dash0-operator-system
```

0 comments on commit 673edf0

Please sign in to comment.