Skip to content

Commit

Permalink
Add documentation regarding the fleet management preset
Browse files Browse the repository at this point in the history
  • Loading branch information
douglascamata committed Dec 19, 2024
1 parent 4d34383 commit 95af63e
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions otel-integration/k8s-helm/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -719,6 +719,25 @@ helm upgrade --install otel-coralogix-integration coralogix-charts-virtual/otel-

Once the installation is complete, verify that the Kube State Metrics metrics are being scraped and ingested inside Coralogix.

### Connecting to Coralogix fleet management

The integration can be configured to connect to the Coralogix fleet management server through setting the `presets.fleetManagement.enabled` property to `true`. This connection happens through the OpAMP extension of the Collector and the endpoint used is: `https://ingress.<CORALOGIX_DOMAIN>/opamp/v1`. This feature is disabled by default.

> [!CAUTION]
> Important security consideration when enabling this feature:
>
> - Because this extension shares your Collector's configuration with the fleet management server, it's important to ensure that any secret contained in it is using the environment variable expansion syntax.
> - The default capabilities of the OpAMP extension **do not** include remote configuration or packages.
> - By default, the extension will pool the server every 2 minutes. Additional network requests might be made between the server and the Collector, depending on the configuration on both sides.

To enable this feature, set the `presets.fleetManagement.enabled` property to `true`. Here is an example `values.yaml`:

```yaml
presets:
fleetManagement:
enabled: true
```

# Troubleshooting

## Metrics
Expand Down

0 comments on commit 95af63e

Please sign in to comment.