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.

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

docs: fix dataplane observability configuration remote write url description #1714

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
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
11 changes: 6 additions & 5 deletions secrets/dataplane-observability-config.yaml.sample
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,12 @@
remote_write_configuration:
# [required] URL endpoint of the Prometheus instance to be used by the data planes
# to send metrics. The Prometheus instance has to offer a Remote Write endpoint.
# If oidc_configuration is set that endpoint has to be offered under the
# /api/v1/metrics/<tenant>/api/v1/receive" URL path, where <tenant> is defined by the
# --observability-red-hat-sso-tenant Fleet Manager flag.
# If oidc_coniguration is not set that endpoint has to be offered under the
# "/" URL path.
# If `.remote_write_configuration.authentication.oidc.static_configuration`
# is set that endpoint has to be offered under
# the /api/v1/metrics/<tenant>/api/v1/receive" URL path, where <tenant> is
# defined by the --observability-red-hat-sso-tenant Fleet Manager flag.
# If `.remote_write_configuration.authentication.oidc.autogenerated` is set
# that endpoint has to be offered under the "/" URL path.
# The format of remote_write_url is `<url-scheme>:<hostname>:<port>` where
# <port> is optional.
remote_write_url: # fill here
Expand Down