Skip to content

Commit 63fc16f

Browse files
committed
docs fmt
1 parent 5d885c6 commit 63fc16f

File tree

1 file changed

+22
-5
lines changed

1 file changed

+22
-5
lines changed

otel-integration/k8s-helm/README.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -439,16 +439,15 @@ helm upgrade --install otel-coralogix-integration coralogix-charts-virtual/otel-
439439
### Deploying Coralogix EBPF Agent
440440

441441
```bash
442-
helm upgrade --install otel-coralogix-central-collector coralogix-charts-virtual/otel-integration \
442+
helm upgrade --install otel-coralogix coralogix-charts-virtual/otel-integration \
443443
--render-subchart-notes -f values-ebpf-agent.yaml
444444
```
445445

446-
By default, coralogix ebpf agent will be deployed with the [span metrics preset](#About-span-metrics) enabled.
447-
since due to the usual high volume of spans collected by the ebpf agent, it is recommended to use
446+
By default, coralogix ebpf agent will be deployed with the [span metrics preset](#about-span-metrics) enabled.
447+
since due to the usual high volume of spans collected by the ebpf agent, it is recommended to use
448448
[Coralogix APM with span metrics](https://coralogix.com/docs/user-guides/apm/getting-started/span-metrics/)
449449
to disable this, you can edit to the `values-ebpf-agent.yaml` file and set `presets.spanMetrics.enabled` to `false`.
450450

451-
452451
#### Filtering Specific Services For Coralogix EBPF Agent
453452

454453
By default, the coralogix-ebpf-agent will collect traffic from all services in the cluster.
@@ -488,7 +487,7 @@ If you already have an existing OpenTelemetry Collector deployment and you want
488487
you can only deploy the ebpf agent and supply your existing OpenTelemetry Collector endpoint with this command:
489488

490489
```bash
491-
helm upgrade --install otel-coralogix-central-collector coralogix-charts-virtual/otel-integration \
490+
helm upgrade --install otel-coralogix coralogix-charts-virtual/otel-integration \
492491
--render-subchart-notes -f values-ebpf-agent-existing-collector.yaml --set coralogix-ebpf-agent.ebpf_agent.otel.exporter.endpoint=<your-existing-collector-endpoint>
493492
```
494493

@@ -747,6 +746,24 @@ helm upgrade --install otel-coralogix-integration coralogix-charts-virtual/otel-
747746

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

749+
### Connecting to Coralogix fleet management
750+
751+
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.
752+
753+
> [!CAUTION]
754+
> Important security consideration when enabling this feature:
755+
> - 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.
756+
> - The default capabilities of the OpAMP extension **do not** include remote configuration or packages.
757+
> - 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.
758+
759+
To enable this feature, set the `presets.fleetManagement.enabled` property to `true`. Here is an example `values.yaml`:
760+
761+
```yaml
762+
presets:
763+
fleetManagement:
764+
enabled: true
765+
```
766+
750767
# Troubleshooting
751768

752769
## Metrics

0 commit comments

Comments
 (0)