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.

DocumentationGrafana AgentFlow modeReferenceComponents referenceremote.kubernetes.secret

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 agent pod at deployment time.

Usage

river Copy

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

Arguments

The following arguments are supported:

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:

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:

At most, one of the following can be provided:

• bearer_token argument.
• bearer_token_file argument.
• basic_auth block.
• authorization block.
• oauth2 block.

basic_auth block

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

authorization block

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

oauth2 block

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.

tls_config block

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:

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 Copy

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 Copy

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.