Menu

Caution

Grafana Alloy is the new name for our distribution of the OTel collector. Grafana Agent has been deprecated and is in Long-Term Support (LTS) through October 31, 2025. Grafana Agent will reach an End-of-Life (EOL) on November 1, 2025. Read more about why we recommend migrating to Grafana Alloy.

Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Open source

remote.kubernetes.secret

remote.kubernetes.secret reads a Secret from the Kubernetes API server and exposes its data for other components to consume.

A common use case for this is loading credentials or other information from secrets that are not already mounted into the Grafana Agent pod at deployment time.

Usage

river
remote.kubernetes.secret "LABEL" {
  namespace = "NAMESPACE_OF_SECRET"
  name = "NAME_OF_SECRET"
}

Arguments

The following arguments are supported:

NameTypeDescriptionDefaultRequired
namespacestringKubernetes namespace containing the desired Secret.yes
namestringName of the Kubernetes Secretyes
poll_frequencydurationFrequency to poll the Kubernetes API."1m"no
poll_timeoutdurationTimeout when polling the Kubernetes API."15s"no

When this component performs a poll operation, it requests the Secret data from the Kubernetes API. A poll is triggered by the following:

  • When the component first loads.
  • Every time the component’s arguments get re-evaluated.
  • At the frequency specified by the poll_frequency argument.

Any error while polling will mark the component as unhealthy. After a successful poll, all data is exported with the same field names as the source Secret.

Blocks

The following blocks are supported inside the definition of remote.kubernetes.secret:

HierarchyBlockDescriptionRequired
clientclientConfigures Kubernetes client used to find Probes.no
client > basic_authbasic_authConfigure basic authentication to the Kubernetes API.no
client > authorizationauthorizationConfigure generic authorization to the Kubernetes API.no
client > oauth2oauth2Configure OAuth2 for authenticating to the Kubernetes API.no
client > oauth2 > tls_configtls_configConfigure TLS settings for connecting to the Kubernetes API.no
client > tls_configtls_configConfigure TLS settings for connecting to the Kubernetes API.no

The > symbol indicates deeper levels of nesting. For example, client > basic_auth refers to a basic_auth block defined inside a client block.

client block

The client block configures the Kubernetes client used to discover Probes. If the client block isn’t provided, the default in-cluster configuration with the service account of the running Grafana Agent pod is used.

The following arguments are supported:

NameTypeDescriptionDefaultRequired
api_serverstringURL of the Kubernetes API server.no
kubeconfig_filestringPath of the kubeconfig file to use for connecting to Kubernetes.no
bearer_token_filestringFile containing a bearer token to authenticate with.no
bearer_tokensecretBearer token to authenticate with.no
enable_http2boolWhether HTTP2 is supported for requests.trueno
follow_redirectsboolWhether redirects returned by the server should be followed.trueno
proxy_urlstringHTTP proxy to send requests through.no
no_proxystringComma-separated list of IP addresses, CIDR notations, and domain names to exclude from proxying.no
proxy_from_environmentboolUse the proxy URL indicated by environment variables.falseno
proxy_connect_headermap(list(secret))Specifies headers to send to proxies during CONNECT requests.no

At most, one of the following can be provided:

no_proxy can contain IPs, CIDR notations, and domain names. IP and domain names can contain port numbers. proxy_url must be configured if no_proxy is configured.

proxy_from_environment uses the environment variables HTTP_PROXY, HTTPS_PROXY and NO_PROXY (or the lowercase versions thereof). Requests use the proxy from the environment variable matching their scheme, unless excluded by NO_PROXY. proxy_url and no_proxy must not be configured if proxy_from_environment is configured.

proxy_connect_header should only be configured if proxy_url or proxy_from_environment are configured.

basic_auth block

NameTypeDescriptionDefaultRequired
password_filestringFile containing the basic auth password.no
passwordsecretBasic auth password.no
usernamestringBasic auth username.no

password and password_file are mutually exclusive, and only one can be provided inside a basic_auth block.

authorization block

NameTypeDescriptionDefaultRequired
credentials_filestringFile containing the secret value.no
credentialssecretSecret value.no
typestringAuthorization type, for example, “Bearer”.no

credential and credentials_file are mutually exclusive, and only one can be provided inside an authorization block.

oauth2 block

NameTypeDescriptionDefaultRequired
client_idstringOAuth2 client ID.no
client_secret_filestringFile containing the OAuth2 client secret.no
client_secretsecretOAuth2 client secret.no
endpoint_paramsmap(string)Optional parameters to append to the token URL.no
proxy_urlstringHTTP proxy to send requests through.no
no_proxystringComma-separated list of IP addresses, CIDR notations, and domain names to exclude from proxying.no
proxy_from_environmentboolUse the proxy URL indicated by environment variables.falseno
proxy_connect_headermap(list(secret))Specifies headers to send to proxies during CONNECT requests.no
scopeslist(string)List of scopes to authenticate with.no
token_urlstringURL to fetch the token from.no

client_secret and client_secret_file are mutually exclusive, and only one can be provided inside an oauth2 block.

The oauth2 block may also contain a separate tls_config sub-block.

no_proxy can contain IPs, CIDR notations, and domain names. IP and domain names can contain port numbers. proxy_url must be configured if no_proxy is configured.

proxy_from_environment uses the environment variables HTTP_PROXY, HTTPS_PROXY and NO_PROXY (or the lowercase versions thereof). Requests use the proxy from the environment variable matching their scheme, unless excluded by NO_PROXY. proxy_url and no_proxy must not be configured if proxy_from_environment is configured.

proxy_connect_header should only be configured if proxy_url or proxy_from_environment are configured.

tls_config block

NameTypeDescriptionDefaultRequired
ca_pemstringCA PEM-encoded text to validate the server with.no
ca_filestringCA certificate to validate the server with.no
cert_pemstringCertificate PEM-encoded text for client authentication.no
cert_filestringCertificate file for client authentication.no
insecure_skip_verifyboolDisables validation of the server certificate.no
key_filestringKey file for client authentication.no
key_pemsecretKey PEM-encoded text for client authentication.no
min_versionstringMinimum acceptable TLS version.no
server_namestringServerName extension to indicate the name of the server.no

The following pairs of arguments are mutually exclusive and can’t both be set simultaneously:

  • ca_pem and ca_file
  • cert_pem and cert_file
  • key_pem and key_file

When configuring client authentication, both the client certificate (using cert_pem or cert_file) and the client key (using key_pem or key_file) must be provided.

When min_version is not provided, the minimum acceptable TLS version is inherited from Go’s default minimum version, TLS 1.2. If min_version is provided, it must be set to one of the following strings:

  • "TLS10" (TLS 1.0)
  • "TLS11" (TLS 1.1)
  • "TLS12" (TLS 1.2)
  • "TLS13" (TLS 1.3)

Exported fields

The following fields are exported and can be referenced by other components:

NameTypeDescription
datamap(secret)Data from the secret obtained from Kubernetes.

The data field contains a mapping from field names to values.

If an individual key stored in data does not hold sensitive data, it can be converted into a string using the nonsensitive function:

river
nonsensitive(remote.kubernetes.secret.LABEL.data.KEY_NAME)

Using nonsensitive allows for using the exports of remote.kubernetes.secret for attributes in components that do not support secrets.

Component health

Instances of remote.kubernetes.secret report as healthy if the most recent attempt to poll the kubernetes API succeeds.

Debug information

remote.kubernetes.secret does not expose any component-specific debug information.

Debug metrics

remote.kubernetes.secret does not expose any component-specific debug metrics.

Example

This example reads a Secret and a ConfigMap from Kubernetes and uses them to supply remote-write credentials.

river
remote.kubernetes.secret "credentials" {
  namespace = "monitoring"
  name = "metrics-secret"
}

remote.kubernetes.configmap "endpoint" {
  namespace = "monitoring"
  name = "metrics-endpoint"
}

prometheus.remote_write "default" {
  endpoint {
    url = remote.kubernetes.configmap.endpoint.data["url"]
    basic_auth {
      username = nonsensitive(remote.kubernetes.configmap.endpoint.data["username"])
      password = remote.kubernetes.secret.credentials.data["password"]
    }
  }
}

This example assumes that the Secret and ConfigMap have already been created, and that the appropriate field names exist in their data.