[DOC] Add username_file in basic auth http client config (#12749)
Some checks are pending
buf.build / lint and publish (push) Waiting to run
CI / Go tests (push) Waiting to run
CI / More Go tests (push) Waiting to run
CI / Go tests with previous Go version (push) Waiting to run
CI / UI tests (push) Waiting to run
CI / Go tests on Windows (push) Waiting to run
CI / Mixins tests (push) Waiting to run
CI / Build Prometheus for common architectures (0) (push) Waiting to run
CI / Build Prometheus for common architectures (1) (push) Waiting to run
CI / Build Prometheus for common architectures (2) (push) Waiting to run
CI / Build Prometheus for all architectures (0) (push) Waiting to run
CI / Build Prometheus for all architectures (1) (push) Waiting to run
CI / Build Prometheus for all architectures (10) (push) Waiting to run
CI / Build Prometheus for all architectures (11) (push) Waiting to run
CI / Build Prometheus for all architectures (2) (push) Waiting to run
CI / Build Prometheus for all architectures (3) (push) Waiting to run
CI / Build Prometheus for all architectures (4) (push) Waiting to run
CI / Build Prometheus for all architectures (5) (push) Waiting to run
CI / Build Prometheus for all architectures (6) (push) Waiting to run
CI / Build Prometheus for all architectures (7) (push) Waiting to run
CI / Build Prometheus for all architectures (8) (push) Waiting to run
CI / Build Prometheus for all architectures (9) (push) Waiting to run
CI / Report status of build Prometheus for all architectures (push) Blocked by required conditions
CI / Check generated parser (push) Waiting to run
CI / golangci-lint (push) Waiting to run
CI / fuzzing (push) Waiting to run
CI / codeql (push) Waiting to run
CI / Publish main branch artifacts (push) Blocked by required conditions
CI / Publish release artefacts (push) Blocked by required conditions
CI / Publish UI on npm Registry (push) Blocked by required conditions
Scorecards supply-chain security / Scorecards analysis (push) Waiting to run

Signed-off-by: Wasim Nihal <sswasim64@gmail.com>
This commit is contained in:
Nihal 2024-09-17 16:50:31 +05:30 committed by GitHub
parent d1b4312f0a
commit d0d57ff642
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -266,9 +266,11 @@ params:
# Sets the `Authorization` header on every scrape request with the # Sets the `Authorization` header on every scrape request with the
# configured username and password. # configured username and password.
# username and username_file are mutually exclusive.
# password and password_file are mutually exclusive. # password and password_file are mutually exclusive.
basic_auth: basic_auth:
[ username: <string> ] [ username: <string> ]
[ username_file: <string> ]
[ password: <secret> ] [ password: <secret> ]
[ password_file: <string> ] [ password_file: <string> ]
@ -684,11 +686,13 @@ subscription_id: <string>
# Authentication information used to authenticate to the Azure API. # Authentication information used to authenticate to the Azure API.
# Note that `basic_auth`, `authorization` and `oauth2` options are # Note that `basic_auth`, `authorization` and `oauth2` options are
# mutually exclusive. # mutually exclusive.
# `username` and `username_file` are mutually exclusive.
# `password` and `password_file` are mutually exclusive. # `password` and `password_file` are mutually exclusive.
# Optional HTTP basic authentication information, currently not support by Azure. # Optional HTTP basic authentication information, currently not support by Azure.
basic_auth: basic_auth:
[ username: <string> ] [ username: <string> ]
[ username_file: <string> ]
[ password: <secret> ] [ password: <secret> ]
[ password_file: <string> ] [ password_file: <string> ]
@ -809,11 +813,13 @@ tags:
# Authentication information used to authenticate to the consul server. # Authentication information used to authenticate to the consul server.
# Note that `basic_auth`, `authorization` and `oauth2` options are # Note that `basic_auth`, `authorization` and `oauth2` options are
# mutually exclusive. # mutually exclusive.
# `username` and `username_file` are mutually exclusive.
# `password` and `password_file` are mutually exclusive. # `password` and `password_file` are mutually exclusive.
# Optional HTTP basic authentication information. # Optional HTTP basic authentication information.
basic_auth: basic_auth:
[ username: <string> ] [ username: <string> ]
[ username_file: <string> ]
[ password: <secret> ] [ password: <secret> ]
[ password_file: <string> ] [ password_file: <string> ]
@ -907,11 +913,13 @@ The following meta labels are available on targets during [relabeling](#relabel_
# Authentication information used to authenticate to the API server. # Authentication information used to authenticate to the API server.
# Note that `basic_auth` and `authorization` options are # Note that `basic_auth` and `authorization` options are
# mutually exclusive. # mutually exclusive.
# username and username_file are mutually exclusive.
# password and password_file are mutually exclusive. # password and password_file are mutually exclusive.
# Optional HTTP basic authentication information, not currently supported by DigitalOcean. # Optional HTTP basic authentication information, not currently supported by DigitalOcean.
basic_auth: basic_auth:
[ username: <string> ] [ username: <string> ]
[ username_file: <string> ]
[ password: <secret> ] [ password: <secret> ]
[ password_file: <string> ] [ password_file: <string> ]
@ -1055,11 +1063,13 @@ tls_config:
# Authentication information used to authenticate to the Docker daemon. # Authentication information used to authenticate to the Docker daemon.
# Note that `basic_auth` and `authorization` options are # Note that `basic_auth` and `authorization` options are
# mutually exclusive. # mutually exclusive.
# username and username_file are mutually exclusive.
# password and password_file are mutually exclusive. # password and password_file are mutually exclusive.
# Optional HTTP basic authentication information. # Optional HTTP basic authentication information.
basic_auth: basic_auth:
[ username: <string> ] [ username: <string> ]
[ username_file: <string> ]
[ password: <secret> ] [ password: <secret> ]
[ password_file: <string> ] [ password_file: <string> ]
@ -1244,11 +1254,13 @@ role: <string>
# Authentication information used to authenticate to the Docker daemon. # Authentication information used to authenticate to the Docker daemon.
# Note that `basic_auth` and `authorization` options are # Note that `basic_auth` and `authorization` options are
# mutually exclusive. # mutually exclusive.
# username and username_file are mutually exclusive.
# password and password_file are mutually exclusive. # password and password_file are mutually exclusive.
# Optional HTTP basic authentication information. # Optional HTTP basic authentication information.
basic_auth: basic_auth:
[ username: <string> ] [ username: <string> ]
[ username_file: <string> ]
[ password: <secret> ] [ password: <secret> ]
[ password_file: <string> ] [ password_file: <string> ]
@ -1391,11 +1403,13 @@ filters:
# Authentication information used to authenticate to the EC2 API. # Authentication information used to authenticate to the EC2 API.
# Note that `basic_auth`, `authorization` and `oauth2` options are # Note that `basic_auth`, `authorization` and `oauth2` options are
# mutually exclusive. # mutually exclusive.
# `username` and `username_file` are mutually exclusive.
# `password` and `password_file` are mutually exclusive. # `password` and `password_file` are mutually exclusive.
# Optional HTTP basic authentication information, currently not supported by AWS. # Optional HTTP basic authentication information, currently not supported by AWS.
basic_auth: basic_auth:
[ username: <string> ] [ username: <string> ]
[ username_file: <string> ]
[ password: <secret> ] [ password: <secret> ]
[ password_file: <string> ] [ password_file: <string> ]
@ -1684,6 +1698,7 @@ tls_config:
# Optional HTTP basic authentication information. # Optional HTTP basic authentication information.
basic_auth: basic_auth:
[ username: <string> ] [ username: <string> ]
[ username_file: <string> ]
[ password: <secret> ] [ password: <secret> ]
[ password_file: <string> ] [ password_file: <string> ]
@ -1915,12 +1930,14 @@ role: <string>
# Authentication information used to authenticate to the API server. # Authentication information used to authenticate to the API server.
# Note that `basic_auth` and `authorization` options are # Note that `basic_auth` and `authorization` options are
# mutually exclusive. # mutually exclusive.
# username and username_file are mutually exclusive.
# password and password_file are mutually exclusive. # password and password_file are mutually exclusive.
# Optional HTTP basic authentication information, required when role is robot # Optional HTTP basic authentication information, required when role is robot
# Role hcloud does not support basic auth. # Role hcloud does not support basic auth.
basic_auth: basic_auth:
[ username: <string> ] [ username: <string> ]
[ username_file: <string> ]
[ password: <secret> ] [ password: <secret> ]
[ password_file: <string> ] [ password_file: <string> ]
@ -2024,11 +2041,13 @@ url: <string>
# Authentication information used to authenticate to the API server. # Authentication information used to authenticate to the API server.
# Note that `basic_auth`, `authorization` and `oauth2` options are # Note that `basic_auth`, `authorization` and `oauth2` options are
# mutually exclusive. # mutually exclusive.
# `username` and `username_file` are mutually exclusive.
# `password` and `password_file` are mutually exclusive. # `password` and `password_file` are mutually exclusive.
# Optional HTTP basic authentication information. # Optional HTTP basic authentication information.
basic_auth: basic_auth:
[ username: <string> ] [ username: <string> ]
[ username_file: <string> ]
[ password: <secret> ] [ password: <secret> ]
[ password_file: <string> ] [ password_file: <string> ]
@ -2116,12 +2135,14 @@ datacenter_id: <string>
# Authentication information used to authenticate to the API server. # Authentication information used to authenticate to the API server.
# Note that `basic_auth` and `authorization` options are # Note that `basic_auth` and `authorization` options are
# mutually exclusive. # mutually exclusive.
# username and username_file are mutually exclusive.
# password and password_file are mutually exclusive. # password and password_file are mutually exclusive.
# Optional HTTP basic authentication information, required when using IONOS # Optional HTTP basic authentication information, required when using IONOS
# Cloud username and password as authentication method. # Cloud username and password as authentication method.
basic_auth: basic_auth:
[ username: <string> ] [ username: <string> ]
[ username_file: <string> ]
[ password: <secret> ] [ password: <secret> ]
[ password_file: <string> ] [ password_file: <string> ]
@ -2368,11 +2389,13 @@ role: <string>
# Optional authentication information used to authenticate to the API server. # Optional authentication information used to authenticate to the API server.
# Note that `basic_auth` and `authorization` options are mutually exclusive. # Note that `basic_auth` and `authorization` options are mutually exclusive.
# username and username_file are mutually exclusive.
# password and password_file are mutually exclusive. # password and password_file are mutually exclusive.
# Optional HTTP basic authentication information. # Optional HTTP basic authentication information.
basic_auth: basic_auth:
[ username: <string> ] [ username: <string> ]
[ username_file: <string> ]
[ password: <secret> ] [ password: <secret> ]
[ password_file: <string> ] [ password_file: <string> ]
@ -2526,11 +2549,13 @@ tls_config:
# Authentication information used to authenticate to the Docker daemon. # Authentication information used to authenticate to the Docker daemon.
# Note that `basic_auth` and `authorization` options are # Note that `basic_auth` and `authorization` options are
# mutually exclusive. # mutually exclusive.
# username and username_file are mutually exclusive.
# password and password_file are mutually exclusive. # password and password_file are mutually exclusive.
# Optional HTTP basic authentication information. # Optional HTTP basic authentication information.
basic_auth: basic_auth:
[ username: <string> ] [ username: <string> ]
[ username_file: <string> ]
[ password: <secret> ] [ password: <secret> ]
[ password_file: <string> ] [ password_file: <string> ]
@ -2611,11 +2636,13 @@ See below for the configuration options for Lightsail discovery:
# Authentication information used to authenticate to the Lightsail API. # Authentication information used to authenticate to the Lightsail API.
# Note that `basic_auth`, `authorization` and `oauth2` options are # Note that `basic_auth`, `authorization` and `oauth2` options are
# mutually exclusive. # mutually exclusive.
# `username` and `username_file` are mutually exclusive.
# `password` and `password_file` are mutually exclusive. # `password` and `password_file` are mutually exclusive.
# Optional HTTP basic authentication information, currently not supported by AWS. # Optional HTTP basic authentication information, currently not supported by AWS.
basic_auth: basic_auth:
[ username: <string> ] [ username: <string> ]
[ username_file: <string> ]
[ password: <secret> ] [ password: <secret> ]
[ password_file: <string> ] [ password_file: <string> ]
@ -2707,12 +2734,14 @@ The following meta labels are available on targets during [relabeling](#relabel_
# Authentication information used to authenticate to the API server. # Authentication information used to authenticate to the API server.
# Note that `basic_auth` and `authorization` options are # Note that `basic_auth` and `authorization` options are
# mutually exclusive. # mutually exclusive.
# username and username_file are mutually exclusive.
# password and password_file are mutually exclusive. # password and password_file are mutually exclusive.
# Note: Linode APIv4 Token must be created with scopes: 'linodes:read_only', 'ips:read_only', and 'events:read_only' # Note: Linode APIv4 Token must be created with scopes: 'linodes:read_only', 'ips:read_only', and 'events:read_only'
# Optional HTTP basic authentication information, not currently supported by Linode APIv4. # Optional HTTP basic authentication information, not currently supported by Linode APIv4.
basic_auth: basic_auth:
[ username: <string> ] [ username: <string> ]
[ username_file: <string> ]
[ password: <secret> ] [ password: <secret> ]
[ password_file: <string> ] [ password_file: <string> ]
@ -2820,9 +2849,11 @@ servers:
# Sets the `Authorization` header on every request with the # Sets the `Authorization` header on every request with the
# configured username and password. # configured username and password.
# This is mutually exclusive with other authentication mechanisms. # This is mutually exclusive with other authentication mechanisms.
# username and username_file are mutually exclusive.
# password and password_file are mutually exclusive. # password and password_file are mutually exclusive.
basic_auth: basic_auth:
[ username: <string> ] [ username: <string> ]
[ username_file: <string> ]
[ password: <secret> ] [ password: <secret> ]
[ password_file: <string> ] [ password_file: <string> ]
@ -2942,11 +2973,13 @@ The following meta labels are available on targets during [relabeling](#relabel_
# Authentication information used to authenticate to the nomad server. # Authentication information used to authenticate to the nomad server.
# Note that `basic_auth`, `authorization` and `oauth2` options are # Note that `basic_auth`, `authorization` and `oauth2` options are
# mutually exclusive. # mutually exclusive.
# `username` and `username_file` are mutually exclusive.
# `password` and `password_file` are mutually exclusive. # `password` and `password_file` are mutually exclusive.
# Optional HTTP basic authentication information. # Optional HTTP basic authentication information.
basic_auth: basic_auth:
[ username: <string> ] [ username: <string> ]
[ username_file: <string> ]
[ password: <secret> ] [ password: <secret> ]
[ password_file: <string> ] [ password_file: <string> ]
@ -3137,9 +3170,11 @@ server: <string>
# Sets the `Authorization` header on every request with the # Sets the `Authorization` header on every request with the
# configured username and password. # configured username and password.
# username and username_file are mutually exclusive.
# password and password_file are mutually exclusive. # password and password_file are mutually exclusive.
basic_auth: basic_auth:
[ username: <string> ] [ username: <string> ]
[ username_file: <string> ]
[ password: <secret> ] [ password: <secret> ]
[ password_file: <string> ] [ password_file: <string> ]
@ -3370,6 +3405,7 @@ password: <secret>
# Optional HTTP basic authentication information, currently not supported by Uyuni. # Optional HTTP basic authentication information, currently not supported by Uyuni.
basic_auth: basic_auth:
[ username: <string> ] [ username: <string> ]
[ username_file: <string> ]
[ password: <secret> ] [ password: <secret> ]
[ password_file: <string> ] [ password_file: <string> ]
@ -3459,11 +3495,13 @@ The following meta labels are available on targets during [relabeling](#relabel_
# Authentication information used to authenticate to the API server. # Authentication information used to authenticate to the API server.
# Note that `basic_auth` and `authorization` options are # Note that `basic_auth` and `authorization` options are
# mutually exclusive. # mutually exclusive.
# username and username_file are mutually exclusive.
# password and password_file are mutually exclusive. # password and password_file are mutually exclusive.
# Optional HTTP basic authentication information, not currently supported by Vultr. # Optional HTTP basic authentication information, not currently supported by Vultr.
basic_auth: basic_auth:
[ username: <string> ] [ username: <string> ]
[ username_file: <string> ]
[ password: <secret> ] [ password: <secret> ]
[ password_file: <string> ] [ password_file: <string> ]
@ -3675,9 +3713,11 @@ through the `__alerts_path__` label.
# Sets the `Authorization` header on every request with the # Sets the `Authorization` header on every request with the
# configured username and password. # configured username and password.
# username and username_file are mutually exclusive.
# password and password_file are mutually exclusive. # password and password_file are mutually exclusive.
basic_auth: basic_auth:
[ username: <string> ] [ username: <string> ]
[ username_file: <string> ]
[ password: <secret> ] [ password: <secret> ]
[ password_file: <string> ] [ password_file: <string> ]
@ -3921,9 +3961,11 @@ write_relabel_configs:
# Sets the `Authorization` header on every remote write request with the # Sets the `Authorization` header on every remote write request with the
# configured username and password. # configured username and password.
# username and username_file are mutually exclusive.
# password and password_file are mutually exclusive. # password and password_file are mutually exclusive.
basic_auth: basic_auth:
[ username: <string> ] [ username: <string> ]
[ username_file: <string> ]
[ password: <secret> ] [ password: <secret> ]
[ password_file: <string> ] [ password_file: <string> ]
@ -4102,9 +4144,11 @@ headers:
# Sets the `Authorization` header on every remote read request with the # Sets the `Authorization` header on every remote read request with the
# configured username and password. # configured username and password.
# username and username_file are mutually exclusive.
# password and password_file are mutually exclusive. # password and password_file are mutually exclusive.
basic_auth: basic_auth:
[ username: <string> ] [ username: <string> ]
[ username_file: <string> ]
[ password: <secret> ] [ password: <secret> ]
[ password_file: <string> ] [ password_file: <string> ]