Skip to content

Commit

Permalink
add simple command deploy section and cleanup section to observabilit…
Browse files Browse the repository at this point in the history
…y document

Signed-off-by: hlts2 <hiroto.funakoshi.hiroto@gmail.com>
  • Loading branch information
hlts2 committed Jun 22, 2023
1 parent db06e2f commit 6c3675e
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions docs/user-guides/observability-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,14 @@ Before executing the following command, please ensure the Prometheus operator ru
make k8s/otel/operator/deploy k8s/otel/collector/deploy
```

### Deploy Observability components with a simple command

If you would like to deploy observability components with a simple command, please use the following command.

```bash
make k8s/external/cert-manager/deploy k8s/monitoring/deploy
```

## Configure Helm chart

This section shows how to set `values.yaml` to enable each Vald component to send its own telemetry data.
Expand Down Expand Up @@ -244,3 +252,28 @@ You can apply it after creating an observability environment.
The default manifests don't set ingress host.<BR>
You can monitor the browser by port forwarding or define the ingress host by yourself.
</div>

## Cleanup

Last, the Vald cluster will be removed by executing the following command.

```bash
helm uninstall vald
```

Also, the observability components will be removed by executing the following command.

```bash
make k8s/monitoring/delete k8s/external/cert-manager/delete
```

And you can also remove Observability components by executing the following command.

```bash
make k8s/otel/collector/delete \
k8s/otel/operator/delete \
k8s/metrics/grafana/delete \
k8s/metrics/jaeger/delete \
k8s/metrics/prometheus/operator/delete \
k8s/external/cert-manager/delete
```

0 comments on commit 6c3675e

Please sign in to comment.