Merge pull request #66 from kubescape/fix-telemetry-docs

update docs - Telemetry
kubescape · Jul 22, 2024 · e54b197 · e54b197
2 parents 63780b7 + c3c7c59
commit e54b197
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 14 deletions.
diff --git a/docs/docs/install-operator.md b/docs/docs/install-operator.md
@@ -129,16 +129,25 @@ capabilities:
 
   # ====== Runtime related capabilities ======
   #
-  runtimeObservability: disable
+  runtimeObservability: enable
   networkPolicyService: enable
-
-  # ====== Integrations ======
-  #
-  prometheusExporter: disable
+  runtimeDetection: disable
+  malwareDetection: disable
+  nodeProfileService: disable
+  seccompProfileService: enable
 
   # ====== Other capabilities ======
   #
+  # This is an experimental capability with an elevated security risk. Read the
+  # matching docs before enabling.
   autoUpgrading: disable
+  prometheusExporter: disable
+  # seccompGenerator: disable
+
+#extra capability - service discovery option
+serviceScanConfig:
+  enabled : false
+  interval: 1h
 ```
 
 You can configure these by using `--set` when installing the chart, or by specifying your own values file with the `-f` flag. [Read the Helm documentation to learn more](https://helm.sh/docs/chart_template_guide/values_files/).

diff --git a/docs/docs/operator/telemetry.md b/docs/docs/operator/telemetry.md
@@ -1,18 +1,25 @@
 # Setting up Telemetry
 
-Several of Kubescape's in-cluster components implement telemetry data using [OpenTelemetry](https://opentelemetry.io/) (otel).
-You can optionally install an otel [collector](https://opentelemetry.io/docs/collector/) to your cluster to aggregate all metrics and send them to your own tracing tool.
+Several of Kubescape's in-cluster components implement telemetry data using [OpenTelemetry](https://opentelemetry.io/) (otel).\
+You can optionally install an Otel [collector](https://opentelemetry.io/docs/collector/) to your cluster to aggregate all metrics and send them to your own tracing tool.
 
-You simply have to fill in this information before [installing kubescape operator](#installing-kubescape-operator-in-a-kubernetes-cluster-using-helm):
+You simply have to fill in this information before [installing kubescape operator](/../install-operator.md):\
+you need to edit the property below at [values.yaml](https://github.com/kubescape/helm-charts/blob/main/charts/kubescape-operator/values.yaml) OR using --set while installing the helm chart\
 
 ```
+configurations:
+  otelUrl: # Default is empty. Add your Open Telemetry URL here.
+
+..
+..
+..
+
 otelCollector:
-  enabled: true
-  endpoint:
-    host: <ip or dns for your gRPC otel endpoint>
-    port: 4317
-    insecure: <whether your otel endpoint requires ssl>
-    headers: <optional - map of headers required by tracing tool>
+  name: otel-collector
+  endpoint: 
+    insecure: true # configurable
+    headers:
+      uptrace-dsn: "" # configurable
 ```
 
 If you don't have an otel distribution, we suggest you try either [Uptrace](https://github.com/uptrace/uptrace/tree/master/example/docker) or [SigNoz](https://signoz.io/docs/install/docker/)