Skip to content

Commit

Permalink
Updating docs
Browse files Browse the repository at this point in the history
  • Loading branch information
apontejaj committed Jan 16, 2025
1 parent 0848477 commit 45f2aa3
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 5 deletions.
1 change: 0 additions & 1 deletion docs/02-Installation/01-Setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ Note: you can also run captures with just the [CLI](./02-CLI.md).
### Requirements

- Helm version >= v3.8.0.
- Docker and Helm login to GitHub Container Registry. [Authenticating to GHCR](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry#authenticating-to-the-container-registry)

### Basic Mode

Expand Down
19 changes: 15 additions & 4 deletions docs/02-Installation/03-Config.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,22 @@

## Overview

To customize metrics and other options, upgrade Retina defining the specific parameter and attribute as part of the `helm upgrade` command.
### Default Configuration

### Example
Default settings for each component are specified in [Values file](../../deploy/legacy/manifests/controller/helm/retina/values.yaml).

### Deployed Configuration

Configuration of an active Retina deployment can be seen in `retina-config` and `retina-operator-config` configmaps.

```shell
kubectl get configmap retina-config -n kube-system -o yaml
kubectl get configmap retina-operator-config -n kube-system -o yaml
```

### Updating Configuration

If the Retina installation was done via Helm, configuration updates should be done via `helm upgrade` defining the specific attribute name and value as part of the command.

The example below enables gathering of advance pod-level metrics.

Expand All @@ -20,8 +33,6 @@ helm upgrade --install retina oci://ghcr.io/microsoft/retina/charts/retina \
--set enablePodLevel=true
```

Default settings for each component are specified in [Values file](../../deploy/legacy/manifests/controller/helm/retina/values.yaml).

## General Configuration

Apply to both Agent and Operator.
Expand Down

0 comments on commit 45f2aa3

Please sign in to comment.