Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update docs - Telemetry #66

Merged
merged 3 commits into from
Jul 22, 2024
Merged

update docs - Telemetry #66

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d318e1e
updated operator capabilities + fix telemetry page (updated config+br…
idohuber Jul 15, 2024
8a7581f
fix english
idohuber Jul 21, 2024
c3c7c59
add more configuration
idohuber Jul 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 14 additions & 5 deletions docs/docs/install-operator.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/).
Expand Down
25 changes: 16 additions & 9 deletions docs/docs/operator/telemetry.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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/)
Expand Down