From d0d57ff642c8d4f731d1938160add4ec66adc43c Mon Sep 17 00:00:00 2001 From: Nihal <38865967+wasim-nihal@users.noreply.github.com> Date: Tue, 17 Sep 2024 16:50:31 +0530 Subject: [PATCH] [DOC] Add username_file in basic auth http client config (#12749) Signed-off-by: Wasim Nihal --- docs/configuration/configuration.md | 44 +++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) diff --git a/docs/configuration/configuration.md b/docs/configuration/configuration.md index a14dd0271..2ca7ce67e 100644 --- a/docs/configuration/configuration.md +++ b/docs/configuration/configuration.md @@ -266,9 +266,11 @@ params: # Sets the `Authorization` header on every scrape request with the # configured username and password. +# username and username_file are mutually exclusive. # password and password_file are mutually exclusive. basic_auth: [ username: ] + [ username_file: ] [ password: ] [ password_file: ] @@ -684,11 +686,13 @@ subscription_id: # Authentication information used to authenticate to the Azure API. # Note that `basic_auth`, `authorization` and `oauth2` options are # mutually exclusive. +# `username` and `username_file` are mutually exclusive. # `password` and `password_file` are mutually exclusive. # Optional HTTP basic authentication information, currently not support by Azure. basic_auth: [ username: ] + [ username_file: ] [ password: ] [ password_file: ] @@ -809,11 +813,13 @@ tags: # Authentication information used to authenticate to the consul server. # Note that `basic_auth`, `authorization` and `oauth2` options are # mutually exclusive. +# `username` and `username_file` are mutually exclusive. # `password` and `password_file` are mutually exclusive. # Optional HTTP basic authentication information. basic_auth: [ username: ] + [ username_file: ] [ password: ] [ password_file: ] @@ -907,11 +913,13 @@ The following meta labels are available on targets during [relabeling](#relabel_ # Authentication information used to authenticate to the API server. # Note that `basic_auth` and `authorization` options are # mutually exclusive. +# username and username_file are mutually exclusive. # password and password_file are mutually exclusive. # Optional HTTP basic authentication information, not currently supported by DigitalOcean. basic_auth: [ username: ] + [ username_file: ] [ password: ] [ password_file: ] @@ -1055,11 +1063,13 @@ tls_config: # Authentication information used to authenticate to the Docker daemon. # Note that `basic_auth` and `authorization` options are # mutually exclusive. +# username and username_file are mutually exclusive. # password and password_file are mutually exclusive. # Optional HTTP basic authentication information. basic_auth: [ username: ] + [ username_file: ] [ password: ] [ password_file: ] @@ -1244,11 +1254,13 @@ role: # Authentication information used to authenticate to the Docker daemon. # Note that `basic_auth` and `authorization` options are # mutually exclusive. +# username and username_file are mutually exclusive. # password and password_file are mutually exclusive. # Optional HTTP basic authentication information. basic_auth: [ username: ] + [ username_file: ] [ password: ] [ password_file: ] @@ -1391,11 +1403,13 @@ filters: # Authentication information used to authenticate to the EC2 API. # Note that `basic_auth`, `authorization` and `oauth2` options are # mutually exclusive. +# `username` and `username_file` are mutually exclusive. # `password` and `password_file` are mutually exclusive. # Optional HTTP basic authentication information, currently not supported by AWS. basic_auth: [ username: ] + [ username_file: ] [ password: ] [ password_file: ] @@ -1684,6 +1698,7 @@ tls_config: # Optional HTTP basic authentication information. basic_auth: [ username: ] + [ username_file: ] [ password: ] [ password_file: ] @@ -1915,12 +1930,14 @@ role: # Authentication information used to authenticate to the API server. # Note that `basic_auth` and `authorization` options are # mutually exclusive. +# username and username_file are mutually exclusive. # password and password_file are mutually exclusive. # Optional HTTP basic authentication information, required when role is robot # Role hcloud does not support basic auth. basic_auth: [ username: ] + [ username_file: ] [ password: ] [ password_file: ] @@ -2024,11 +2041,13 @@ url: # Authentication information used to authenticate to the API server. # Note that `basic_auth`, `authorization` and `oauth2` options are # mutually exclusive. +# `username` and `username_file` are mutually exclusive. # `password` and `password_file` are mutually exclusive. # Optional HTTP basic authentication information. basic_auth: [ username: ] + [ username_file: ] [ password: ] [ password_file: ] @@ -2116,12 +2135,14 @@ datacenter_id: # Authentication information used to authenticate to the API server. # Note that `basic_auth` and `authorization` options are # mutually exclusive. +# username and username_file are mutually exclusive. # password and password_file are mutually exclusive. # Optional HTTP basic authentication information, required when using IONOS # Cloud username and password as authentication method. basic_auth: [ username: ] + [ username_file: ] [ password: ] [ password_file: ] @@ -2368,11 +2389,13 @@ role: # Optional authentication information used to authenticate to the API server. # Note that `basic_auth` and `authorization` options are mutually exclusive. +# username and username_file are mutually exclusive. # password and password_file are mutually exclusive. # Optional HTTP basic authentication information. basic_auth: [ username: ] + [ username_file: ] [ password: ] [ password_file: ] @@ -2526,11 +2549,13 @@ tls_config: # Authentication information used to authenticate to the Docker daemon. # Note that `basic_auth` and `authorization` options are # mutually exclusive. +# username and username_file are mutually exclusive. # password and password_file are mutually exclusive. # Optional HTTP basic authentication information. basic_auth: [ username: ] + [ username_file: ] [ password: ] [ password_file: ] @@ -2611,11 +2636,13 @@ See below for the configuration options for Lightsail discovery: # Authentication information used to authenticate to the Lightsail API. # Note that `basic_auth`, `authorization` and `oauth2` options are # mutually exclusive. +# `username` and `username_file` are mutually exclusive. # `password` and `password_file` are mutually exclusive. # Optional HTTP basic authentication information, currently not supported by AWS. basic_auth: [ username: ] + [ username_file: ] [ password: ] [ password_file: ] @@ -2707,12 +2734,14 @@ The following meta labels are available on targets during [relabeling](#relabel_ # Authentication information used to authenticate to the API server. # Note that `basic_auth` and `authorization` options are # mutually exclusive. +# username and username_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' # Optional HTTP basic authentication information, not currently supported by Linode APIv4. basic_auth: [ username: ] + [ username_file: ] [ password: ] [ password_file: ] @@ -2820,9 +2849,11 @@ servers: # Sets the `Authorization` header on every request with the # configured username and password. # This is mutually exclusive with other authentication mechanisms. +# username and username_file are mutually exclusive. # password and password_file are mutually exclusive. basic_auth: [ username: ] + [ username_file: ] [ password: ] [ password_file: ] @@ -2942,11 +2973,13 @@ The following meta labels are available on targets during [relabeling](#relabel_ # Authentication information used to authenticate to the nomad server. # Note that `basic_auth`, `authorization` and `oauth2` options are # mutually exclusive. +# `username` and `username_file` are mutually exclusive. # `password` and `password_file` are mutually exclusive. # Optional HTTP basic authentication information. basic_auth: [ username: ] + [ username_file: ] [ password: ] [ password_file: ] @@ -3137,9 +3170,11 @@ server: # Sets the `Authorization` header on every request with the # configured username and password. +# username and username_file are mutually exclusive. # password and password_file are mutually exclusive. basic_auth: [ username: ] + [ username_file: ] [ password: ] [ password_file: ] @@ -3370,6 +3405,7 @@ password: # Optional HTTP basic authentication information, currently not supported by Uyuni. basic_auth: [ username: ] + [ username_file: ] [ password: ] [ password_file: ] @@ -3459,11 +3495,13 @@ The following meta labels are available on targets during [relabeling](#relabel_ # Authentication information used to authenticate to the API server. # Note that `basic_auth` and `authorization` options are # mutually exclusive. +# username and username_file are mutually exclusive. # password and password_file are mutually exclusive. # Optional HTTP basic authentication information, not currently supported by Vultr. basic_auth: [ username: ] + [ username_file: ] [ password: ] [ password_file: ] @@ -3675,9 +3713,11 @@ through the `__alerts_path__` label. # Sets the `Authorization` header on every request with the # configured username and password. +# username and username_file are mutually exclusive. # password and password_file are mutually exclusive. basic_auth: [ username: ] + [ username_file: ] [ password: ] [ password_file: ] @@ -3921,9 +3961,11 @@ write_relabel_configs: # Sets the `Authorization` header on every remote write request with the # configured username and password. +# username and username_file are mutually exclusive. # password and password_file are mutually exclusive. basic_auth: [ username: ] + [ username_file: ] [ password: ] [ password_file: ] @@ -4102,9 +4144,11 @@ headers: # Sets the `Authorization` header on every remote read request with the # configured username and password. +# username and username_file are mutually exclusive. # password and password_file are mutually exclusive. basic_auth: [ username: ] + [ username_file: ] [ password: ] [ password_file: ]