--- title: "remote.kubernetes.configmap | Grafana Agent documentation" description: "Learn about remote.kubernetes.configmap" --- # remote.kubernetes.configmap `remote.kubernetes.configmap` reads a ConfigMap from the Kubernetes API server and exposes its data for other components to consume. This can be useful anytime Grafana Agent Flow needs data from a ConfigMap that is not directly mounted to the Grafana Agent pod. ## Usage Alloy ![Copy code to clipboard](/media/images/icons/icon-copy-small-2.svg) Copy ```alloy remote.kubernetes.configmap "LABEL" { namespace = "NAMESPACE_OF_CONFIGMAP" name = "NAME_OF_CONFIGMAP" } ``` ## Arguments The following arguments are supported: Expand table | Name | Type | Description | Default | Required | |------------------|------------|--------------------------------------------------------|---------|----------| | `namespace` | `string` | Kubernetes namespace containing the desired ConfigMap. | | yes | | `name` | `string` | Name of the Kubernetes ConfigMap | | yes | | `poll_frequency` | `duration` | Frequency to poll the Kubernetes API. | `"1m"` | no | | `poll_timeout` | `duration` | Timeout when polling the Kubernetes API. | `"15s"` | no | When this component performs a poll operation, it requests the ConfigMap 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 ConfigMap. ## Blocks The following blocks are supported inside the definition of `remote.kubernetes.configmap`: Expand table | Hierarchy | Block | Description | Required | |-------------------------------------|---------------------------------------|--------------------------------------------------------------|----------| | client | [client](#client-block) | Configures Kubernetes client used to find Probes. | no | | client > basic\_auth | [basic\_auth](#basic_auth-block) | Configure basic authentication to the Kubernetes API. | no | | client > authorization | [authorization](#authorization-block) | Configure generic authorization to the Kubernetes API. | no | | client > oauth2 | [oauth2](#oauth2-block) | Configure OAuth2 for authenticating to the Kubernetes API. | no | | client > oauth2 > tls\_config | [tls\_config](#tls_config-block) | Configure TLS settings for connecting to the Kubernetes API. | no | | client > tls\_config | [tls\_config](#tls_config-block) | Configure 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: Expand table | Name | Type | Description | Default | Required | |--------------------------|---------------------|--------------------------------------------------------------------------------------------------|---------|----------| | `api_server` | `string` | URL of the Kubernetes API server. | | no | | `kubeconfig_file` | `string` | Path of the `kubeconfig` file to use for connecting to Kubernetes. | | no | | `bearer_token_file` | `string` | File containing a bearer token to authenticate with. | | no | | `bearer_token` | `secret` | Bearer token to authenticate with. | | no | | `enable_http2` | `bool` | Whether HTTP2 is supported for requests. | `true` | no | | `follow_redirects` | `bool` | Whether redirects returned by the server should be followed. | `true` | no | | `proxy_url` | `string` | HTTP proxy to send requests through. | | no | | `no_proxy` | `string` | Comma-separated list of IP addresses, CIDR notations, and domain names to exclude from proxying. | | no | | `proxy_from_environment` | `bool` | Use the proxy URL indicated by environment variables. | `false` | no | | `proxy_connect_header` | `map(list(secret))` | Specifies headers to send to proxies during CONNECT requests. | | no | At most, one of the following can be provided: - [`bearer_token` argument](#client-block). - [`bearer_token_file` argument](#client-block). - [`basic_auth` block](#basic_auth-block). - [`authorization` block](#authorization-block). - [`oauth2` block](#oauth2-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. ### basic\_auth block Expand table | Name | Type | Description | Default | Required | |-----------------|----------|------------------------------------------|---------|----------| | `password_file` | `string` | File containing the basic auth password. | | no | | `password` | `secret` | Basic auth password. | | no | | `username` | `string` | Basic auth username. | | no | `password` and `password_file` are mutually exclusive, and only one can be provided inside a `basic_auth` block. ### authorization block Expand table | Name | Type | Description | Default | Required | |--------------------|----------|--------------------------------------------|---------|----------| | `credentials_file` | `string` | File containing the secret value. | | no | | `credentials` | `secret` | Secret value. | | no | | `type` | `string` | Authorization type, for example, “Bearer”. | | no | `credential` and `credentials_file` are mutually exclusive, and only one can be provided inside an `authorization` block. ### oauth2 block Expand table | Name | Type | Description | Default | Required | |--------------------------|---------------------|--------------------------------------------------------------------------------------------------|---------|----------| | `client_id` | `string` | OAuth2 client ID. | | no | | `client_secret_file` | `string` | File containing the OAuth2 client secret. | | no | | `client_secret` | `secret` | OAuth2 client secret. | | no | | `endpoint_params` | `map(string)` | Optional parameters to append to the token URL. | | no | | `proxy_url` | `string` | HTTP proxy to send requests through. | | no | | `no_proxy` | `string` | Comma-separated list of IP addresses, CIDR notations, and domain names to exclude from proxying. | | no | | `proxy_from_environment` | `bool` | Use the proxy URL indicated by environment variables. | `false` | no | | `proxy_connect_header` | `map(list(secret))` | Specifies headers to send to proxies during CONNECT requests. | | no | | `scopes` | `list(string)` | List of scopes to authenticate with. | | no | | `token_url` | `string` | URL 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 Expand table | Name | Type | Description | Default | Required | |------------------------|----------|----------------------------------------------------------|---------|----------| | `ca_pem` | `string` | CA PEM-encoded text to validate the server with. | | no | | `ca_file` | `string` | CA certificate to validate the server with. | | no | | `cert_pem` | `string` | Certificate PEM-encoded text for client authentication. | | no | | `cert_file` | `string` | Certificate file for client authentication. | | no | | `insecure_skip_verify` | `bool` | Disables validation of the server certificate. | | no | | `key_file` | `string` | Key file for client authentication. | | no | | `key_pem` | `secret` | Key PEM-encoded text for client authentication. | | no | | `min_version` | `string` | Minimum acceptable TLS version. | | no | | `server_name` | `string` | ServerName 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: Expand table | Name | Type | Description | |--------|---------------|---------------------------------------------------| | `data` | `map(string)` | Data from the ConfigMap obtained from Kubernetes. | The `data` field contains a mapping from field names to values. ## Component health Instances of `remote.kubernetes.configmap` report as healthy if the most recent attempt to poll the kubernetes API succeeds. ## Debug information `remote.kubernetes.configmap` does not expose any component-specific debug information. ## Debug metrics `remote.kubernetes.configmap` 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. Alloy ![Copy code to clipboard](/media/images/icons/icon-copy-small-2.svg) Copy ```alloy 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 = 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.