Add documentation for deploying Telemetry services on Kubernetes #51
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
DataBoyTX
reviewed
Dec 17, 2024
docs/tools/telemetry.md
Outdated
| - **`telemetryEnv.grafana.GF_SERVER_ROOT_URL`** defines the root URL for accessing Grafana (e.g., `/grafana`). | ||
| - **`telemetryEnv.grafana.GF_SERVER_SERVE_FROM_SUB_PATH`** should be set to `true` if Grafana is accessed from a sub-path (e.g., `/grafana`) behind a reverse proxy or ingress. | ||
| 7. **`telemetryEnv.dcgmExporter.DCGM_EXPORTER_CLOCK_EVENTS_COUNT_WINDOW_SIZE`**: This environment variable is used when `OTEL_CLOUD_MODE` is set to `true`, and the `dcgm-exporter` is deployed to export GPU metrics to Prometheus. It controls the frequency of GPU sampling to gather metrics. The value `1000` represents the window size for counting clock events on the GPU. | ||
| 8. **`telemetryEnv.*.image`**: These values allow to change the image versions of the observability tools. |
There was a problem hiding this comment.
-
I think we should add section on how to re-configure caddy once the cluster is already up as discussed in the slack thread.
-
I think the doc could organize the doc better, or break it multiple md files, as it's getting pretty long. If we keep it in one file, maybe add a TOC with links at the top to the different sections.
Besides that, LGTM, but I was only able to get grafana working out of the box, until we know how to configure a new Caddyfile. I will review again once that's figured out, but overall docs look fine to me.
I have some feedback on gke instructions that I will send in Slack,
There was a problem hiding this comment.
Thanks @DataBoyTX ! Done!
DataBoyTX
approved these changes
Dec 18, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR enhances the documentation for deploying OpenTelemetry services for Graphistry in a Kubernetes environment. It includes detailed instructions for configuring Helm values, explains key environment variables, and provides an overview of the observability stack setup, making it easier to understand and implement the deployment process.