Fix the type of bearer_token_auth (#11144)

DataDog · Jan 18, 2022 · 945d005 · 945d005
1 parent c532872
commit 945d005
Show file tree

Hide file tree

Showing 53 changed files with 104 additions and 84 deletions.
diff --git a/azure_iot_edge/datadog_checks/azure_iot_edge/config_models/defaults.py b/azure_iot_edge/datadog_checks/azure_iot_edge/config_models/defaults.py
@@ -1,4 +1,4 @@
-# (C) Datadog, Inc. 2021-present
+# (C) Datadog, Inc. 2022-present
 # All rights reserved
 # Licensed under a 3-clause BSD style license (see LICENSE)
 
@@ -51,7 +51,7 @@ def instance_aws_service(field, value):
 
 
 def instance_bearer_token_auth(field, value):
-    return False
+    return get_default_field_value(field, value)
 
 
 def instance_bearer_token_path(field, value):

diff --git a/azure_iot_edge/datadog_checks/azure_iot_edge/config_models/instance.py b/azure_iot_edge/datadog_checks/azure_iot_edge/config_models/instance.py
@@ -1,4 +1,4 @@
-# (C) Datadog, Inc. 2021-present
+# (C) Datadog, Inc. 2022-present
 # All rights reserved
 # Licensed under a 3-clause BSD style license (see LICENSE)
 
@@ -69,7 +69,7 @@ class Config:
     aws_host: Optional[str]
     aws_region: Optional[str]
     aws_service: Optional[str]
-    bearer_token_auth: Optional[bool]
+    bearer_token_auth: Optional[Union[bool, str]]
     bearer_token_path: Optional[str]
     connect_timeout: Optional[float]
     disable_generic_tags: Optional[bool]

diff --git a/azure_iot_edge/datadog_checks/azure_iot_edge/data/conf.yaml.example b/azure_iot_edge/datadog_checks/azure_iot_edge/data/conf.yaml.example
@@ -144,8 +144,9 @@ instances:
     #
     # include_labels: []
 
-    ## @param bearer_token_auth - boolean - optional - default: false
+    ## @param bearer_token_auth - boolean or string - optional - default: false
     ## If set to true, adds a bearer token authentication header.
+    ## If set to 'tls_only', only adds a bearer token authentication header if the endpoint is secure https.
     ## Note: If bearer_token_path is not set, the default path is /var/run/secrets/kubernetes.io/serviceaccount/token.
     #
     # bearer_token_auth: false

diff --git a/cilium/datadog_checks/cilium/config_models/defaults.py b/cilium/datadog_checks/cilium/config_models/defaults.py
@@ -1,4 +1,4 @@
-# (C) Datadog, Inc. 2021-present
+# (C) Datadog, Inc. 2022-present
 # All rights reserved
 # Licensed under a 3-clause BSD style license (see LICENSE)
 
@@ -55,7 +55,7 @@ def instance_aws_service(field, value):
 
 
 def instance_bearer_token_auth(field, value):
-    return False
+    return get_default_field_value(field, value)
 
 
 def instance_bearer_token_path(field, value):

diff --git a/cilium/datadog_checks/cilium/config_models/instance.py b/cilium/datadog_checks/cilium/config_models/instance.py
@@ -1,4 +1,4 @@
-# (C) Datadog, Inc. 2021-present
+# (C) Datadog, Inc. 2022-present
 # All rights reserved
 # Licensed under a 3-clause BSD style license (see LICENSE)
 
@@ -96,7 +96,7 @@ class Config:
     aws_host: Optional[str]
     aws_region: Optional[str]
     aws_service: Optional[str]
-    bearer_token_auth: Optional[bool]
+    bearer_token_auth: Optional[Union[bool, str]]
     bearer_token_path: Optional[str]
     cache_metric_wildcards: Optional[bool]
     cache_shared_labels: Optional[bool]

diff --git a/cockroachdb/datadog_checks/cockroachdb/config_models/defaults.py b/cockroachdb/datadog_checks/cockroachdb/config_models/defaults.py
@@ -51,7 +51,7 @@ def instance_aws_service(field, value):
 
 
 def instance_bearer_token_auth(field, value):
-    return False
+    return get_default_field_value(field, value)
 
 
 def instance_bearer_token_path(field, value):

diff --git a/cockroachdb/datadog_checks/cockroachdb/config_models/instance.py b/cockroachdb/datadog_checks/cockroachdb/config_models/instance.py
@@ -95,7 +95,7 @@ class Config:
     aws_host: Optional[str]
     aws_region: Optional[str]
     aws_service: Optional[str]
-    bearer_token_auth: Optional[bool]
+    bearer_token_auth: Optional[Union[bool, str]]
     bearer_token_path: Optional[str]
     cache_metric_wildcards: Optional[bool]
     cache_shared_labels: Optional[bool]

diff --git a/coredns/datadog_checks/coredns/config_models/defaults.py b/coredns/datadog_checks/coredns/config_models/defaults.py
@@ -51,7 +51,7 @@ def instance_aws_service(field, value):
 
 
 def instance_bearer_token_auth(field, value):
-    return False
+    return get_default_field_value(field, value)
 
 
 def instance_bearer_token_path(field, value):

diff --git a/coredns/datadog_checks/coredns/config_models/instance.py b/coredns/datadog_checks/coredns/config_models/instance.py
@@ -95,7 +95,7 @@ class Config:
     aws_host: Optional[str]
     aws_region: Optional[str]
     aws_service: Optional[str]
-    bearer_token_auth: Optional[bool]
+    bearer_token_auth: Optional[Union[bool, str]]
     bearer_token_path: Optional[str]
     cache_metric_wildcards: Optional[bool]
     cache_shared_labels: Optional[bool]

diff --git a/crio/datadog_checks/crio/config_models/defaults.py b/crio/datadog_checks/crio/config_models/defaults.py
@@ -1,4 +1,4 @@
-# (C) Datadog, Inc. 2021-present
+# (C) Datadog, Inc. 2022-present
 # All rights reserved
 # Licensed under a 3-clause BSD style license (see LICENSE)
 
@@ -51,7 +51,7 @@ def instance_aws_service(field, value):
 
 
 def instance_bearer_token_auth(field, value):
-    return False
+    return get_default_field_value(field, value)
 
 
 def instance_bearer_token_path(field, value):

diff --git a/crio/datadog_checks/crio/config_models/instance.py b/crio/datadog_checks/crio/config_models/instance.py
@@ -1,4 +1,4 @@
-# (C) Datadog, Inc. 2021-present
+# (C) Datadog, Inc. 2022-present
 # All rights reserved
 # Licensed under a 3-clause BSD style license (see LICENSE)
 
@@ -69,7 +69,7 @@ class Config:
     aws_host: Optional[str]
     aws_region: Optional[str]
     aws_service: Optional[str]
-    bearer_token_auth: Optional[bool]
+    bearer_token_auth: Optional[Union[bool, str]]
     bearer_token_path: Optional[str]
     connect_timeout: Optional[float]
     disable_generic_tags: Optional[bool]

diff --git a/crio/datadog_checks/crio/data/conf.yaml.example b/crio/datadog_checks/crio/data/conf.yaml.example
@@ -139,8 +139,9 @@ instances:
     #
     # include_labels: []
 
-    ## @param bearer_token_auth - boolean - optional - default: false
+    ## @param bearer_token_auth - boolean or string - optional - default: false
     ## If set to true, adds a bearer token authentication header.
+    ## If set to 'tls_only', only adds a bearer token authentication header if the endpoint is secure https.
     ## Note: If bearer_token_path is not set, the default path is /var/run/secrets/kubernetes.io/serviceaccount/token.
     #
     # bearer_token_auth: false

diff --git a/...datadog_checks/dev/tooling/templates/configuration/instances/openmetrics_legacy_base.yaml b/...datadog_checks/dev/tooling/templates/configuration/instances/openmetrics_legacy_base.yaml
@@ -147,10 +147,13 @@
 - name: bearer_token_auth
   description: |
     If set to true, adds a bearer token authentication header.
+    If set to 'tls_only', only adds a bearer token authentication header if the endpoint is secure https.
     Note: If bearer_token_path is not set, the default path is /var/run/secrets/kubernetes.io/serviceaccount/token.
   value:
     example: false
-    type: boolean
+    anyOf:
+      - type: boolean
+      - type: string
 - name: bearer_token_path
   description: |
     The path to a Kubernetes service account bearer token file. Make sure the file exists and is mounted correctly.

diff --git a/datadog_cluster_agent/datadog_checks/datadog_cluster_agent/config_models/defaults.py b/datadog_cluster_agent/datadog_checks/datadog_cluster_agent/config_models/defaults.py
@@ -1,4 +1,4 @@
-# (C) Datadog, Inc. 2021-present
+# (C) Datadog, Inc. 2022-present
 # All rights reserved
 # Licensed under a 3-clause BSD style license (see LICENSE)
 
@@ -51,7 +51,7 @@ def instance_aws_service(field, value):
 
 
 def instance_bearer_token_auth(field, value):
-    return False
+    return get_default_field_value(field, value)
 
 
 def instance_bearer_token_path(field, value):

diff --git a/datadog_cluster_agent/datadog_checks/datadog_cluster_agent/config_models/instance.py b/datadog_cluster_agent/datadog_checks/datadog_cluster_agent/config_models/instance.py
@@ -1,4 +1,4 @@
-# (C) Datadog, Inc. 2021-present
+# (C) Datadog, Inc. 2022-present
 # All rights reserved
 # Licensed under a 3-clause BSD style license (see LICENSE)
 
@@ -69,7 +69,7 @@ class Config:
     aws_host: Optional[str]
     aws_region: Optional[str]
     aws_service: Optional[str]
-    bearer_token_auth: Optional[bool]
+    bearer_token_auth: Optional[Union[bool, str]]
     bearer_token_path: Optional[str]
     connect_timeout: Optional[float]
     disable_generic_tags: Optional[bool]

diff --git a/datadog_cluster_agent/datadog_checks/datadog_cluster_agent/data/auto_conf.yaml b/datadog_cluster_agent/datadog_checks/datadog_cluster_agent/data/auto_conf.yaml
@@ -147,8 +147,9 @@ instances:
     #
     # include_labels: []
 
-    ## @param bearer_token_auth - boolean - optional - default: false
+    ## @param bearer_token_auth - boolean or string - optional - default: false
     ## If set to true, adds a bearer token authentication header.
+    ## If set to 'tls_only', only adds a bearer token authentication header if the endpoint is secure https.
     ## Note: If bearer_token_path is not set, the default path is /var/run/secrets/kubernetes.io/serviceaccount/token.
     #
     # bearer_token_auth: false

diff --git a/datadog_cluster_agent/datadog_checks/datadog_cluster_agent/data/conf.yaml.example b/datadog_cluster_agent/datadog_checks/datadog_cluster_agent/data/conf.yaml.example
@@ -139,8 +139,9 @@ instances:
     #
     # include_labels: []
 
-    ## @param bearer_token_auth - boolean - optional - default: false
+    ## @param bearer_token_auth - boolean or string - optional - default: false
     ## If set to true, adds a bearer token authentication header.
+    ## If set to 'tls_only', only adds a bearer token authentication header if the endpoint is secure https.
     ## Note: If bearer_token_path is not set, the default path is /var/run/secrets/kubernetes.io/serviceaccount/token.
     #
     # bearer_token_auth: false

diff --git a/etcd/datadog_checks/etcd/config_models/defaults.py b/etcd/datadog_checks/etcd/config_models/defaults.py
@@ -1,4 +1,4 @@
-# (C) Datadog, Inc. 2021-present
+# (C) Datadog, Inc. 2022-present
 # All rights reserved
 # Licensed under a 3-clause BSD style license (see LICENSE)
 
@@ -51,7 +51,7 @@ def instance_aws_service(field, value):
 
 
 def instance_bearer_token_auth(field, value):
-    return False
+    return get_default_field_value(field, value)
 
 
 def instance_bearer_token_path(field, value):

diff --git a/etcd/datadog_checks/etcd/config_models/instance.py b/etcd/datadog_checks/etcd/config_models/instance.py
@@ -1,4 +1,4 @@
-# (C) Datadog, Inc. 2021-present
+# (C) Datadog, Inc. 2022-present
 # All rights reserved
 # Licensed under a 3-clause BSD style license (see LICENSE)
 
@@ -69,7 +69,7 @@ class Config:
     aws_host: Optional[str]
     aws_region: Optional[str]
     aws_service: Optional[str]
-    bearer_token_auth: Optional[bool]
+    bearer_token_auth: Optional[Union[bool, str]]
     bearer_token_path: Optional[str]
     connect_timeout: Optional[float]
     disable_generic_tags: Optional[bool]

diff --git a/etcd/datadog_checks/etcd/data/conf.yaml.example b/etcd/datadog_checks/etcd/data/conf.yaml.example
@@ -145,8 +145,9 @@ instances:
     #
     # include_labels: []
 
-    ## @param bearer_token_auth - boolean - optional - default: false
+    ## @param bearer_token_auth - boolean or string - optional - default: false
     ## If set to true, adds a bearer token authentication header.
+    ## If set to 'tls_only', only adds a bearer token authentication header if the endpoint is secure https.
     ## Note: If bearer_token_path is not set, the default path is /var/run/secrets/kubernetes.io/serviceaccount/token.
     #
     # bearer_token_auth: false

diff --git a/external_dns/datadog_checks/external_dns/config_models/defaults.py b/external_dns/datadog_checks/external_dns/config_models/defaults.py
@@ -1,4 +1,4 @@
-# (C) Datadog, Inc. 2021-present
+# (C) Datadog, Inc. 2022-present
 # All rights reserved
 # Licensed under a 3-clause BSD style license (see LICENSE)
 
@@ -51,7 +51,7 @@ def instance_aws_service(field, value):
 
 
 def instance_bearer_token_auth(field, value):
-    return False
+    return get_default_field_value(field, value)
 
 
 def instance_bearer_token_path(field, value):

diff --git a/external_dns/datadog_checks/external_dns/config_models/instance.py b/external_dns/datadog_checks/external_dns/config_models/instance.py
@@ -1,4 +1,4 @@
-# (C) Datadog, Inc. 2021-present
+# (C) Datadog, Inc. 2022-present
 # All rights reserved
 # Licensed under a 3-clause BSD style license (see LICENSE)
 
@@ -69,7 +69,7 @@ class Config:
     aws_host: Optional[str]
     aws_region: Optional[str]
     aws_service: Optional[str]
-    bearer_token_auth: Optional[bool]
+    bearer_token_auth: Optional[Union[bool, str]]
     bearer_token_path: Optional[str]
     connect_timeout: Optional[float]
     disable_generic_tags: Optional[bool]

diff --git a/external_dns/datadog_checks/external_dns/data/conf.yaml.example b/external_dns/datadog_checks/external_dns/data/conf.yaml.example
@@ -139,8 +139,9 @@ instances:
     #
     # include_labels: []
 
-    ## @param bearer_token_auth - boolean - optional - default: false
+    ## @param bearer_token_auth - boolean or string - optional - default: false
     ## If set to true, adds a bearer token authentication header.
+    ## If set to 'tls_only', only adds a bearer token authentication header if the endpoint is secure https.
     ## Note: If bearer_token_path is not set, the default path is /var/run/secrets/kubernetes.io/serviceaccount/token.
     #
     # bearer_token_auth: false

diff --git a/gitlab/datadog_checks/gitlab/config_models/defaults.py b/gitlab/datadog_checks/gitlab/config_models/defaults.py
@@ -1,4 +1,4 @@
-# (C) Datadog, Inc. 2021-present
+# (C) Datadog, Inc. 2022-present
 # All rights reserved
 # Licensed under a 3-clause BSD style license (see LICENSE)
 
@@ -59,7 +59,7 @@ def instance_aws_service(field, value):
 
 
 def instance_bearer_token_auth(field, value):
-    return False
+    return get_default_field_value(field, value)
 
 
 def instance_bearer_token_path(field, value):

diff --git a/gitlab/datadog_checks/gitlab/config_models/instance.py b/gitlab/datadog_checks/gitlab/config_models/instance.py
@@ -1,4 +1,4 @@
-# (C) Datadog, Inc. 2021-present
+# (C) Datadog, Inc. 2022-present
 # All rights reserved
 # Licensed under a 3-clause BSD style license (see LICENSE)
 
@@ -70,7 +70,7 @@ class Config:
     aws_host: Optional[str]
     aws_region: Optional[str]
     aws_service: Optional[str]
-    bearer_token_auth: Optional[bool]
+    bearer_token_auth: Optional[Union[bool, str]]
     bearer_token_path: Optional[str]
     connect_timeout: Optional[float]
     disable_generic_tags: Optional[bool]

diff --git a/gitlab/datadog_checks/gitlab/data/conf.yaml.example b/gitlab/datadog_checks/gitlab/data/conf.yaml.example
@@ -110,8 +110,9 @@ instances:
     #
     # include_labels: []
 
-    ## @param bearer_token_auth - boolean - optional - default: false
+    ## @param bearer_token_auth - boolean or string - optional - default: false
     ## If set to true, adds a bearer token authentication header.
+    ## If set to 'tls_only', only adds a bearer token authentication header if the endpoint is secure https.
     ## Note: If bearer_token_path is not set, the default path is /var/run/secrets/kubernetes.io/serviceaccount/token.
     #
     # bearer_token_auth: false

diff --git a/gitlab_runner/datadog_checks/gitlab_runner/config_models/defaults.py b/gitlab_runner/datadog_checks/gitlab_runner/config_models/defaults.py
@@ -1,4 +1,4 @@
-# (C) Datadog, Inc. 2021-present
+# (C) Datadog, Inc. 2022-present
 # All rights reserved
 # Licensed under a 3-clause BSD style license (see LICENSE)
 
@@ -51,7 +51,7 @@ def instance_aws_service(field, value):
 
 
 def instance_bearer_token_auth(field, value):
-    return False
+    return get_default_field_value(field, value)
 
 
 def instance_bearer_token_path(field, value):

diff --git a/gitlab_runner/datadog_checks/gitlab_runner/config_models/instance.py b/gitlab_runner/datadog_checks/gitlab_runner/config_models/instance.py
@@ -1,4 +1,4 @@
-# (C) Datadog, Inc. 2021-present
+# (C) Datadog, Inc. 2022-present
 # All rights reserved
 # Licensed under a 3-clause BSD style license (see LICENSE)
 
@@ -69,7 +69,7 @@ class Config:
     aws_host: Optional[str]
     aws_region: Optional[str]
     aws_service: Optional[str]
-    bearer_token_auth: Optional[bool]
+    bearer_token_auth: Optional[Union[bool, str]]
     bearer_token_path: Optional[str]
     connect_timeout: Optional[float]
     disable_generic_tags: Optional[bool]

diff --git a/gitlab_runner/datadog_checks/gitlab_runner/data/conf.yaml.example b/gitlab_runner/datadog_checks/gitlab_runner/data/conf.yaml.example
@@ -193,8 +193,9 @@ instances:
     #
     # include_labels: []
 
-    ## @param bearer_token_auth - boolean - optional - default: false
+    ## @param bearer_token_auth - boolean or string - optional - default: false
     ## If set to true, adds a bearer token authentication header.
+    ## If set to 'tls_only', only adds a bearer token authentication header if the endpoint is secure https.
     ## Note: If bearer_token_path is not set, the default path is /var/run/secrets/kubernetes.io/serviceaccount/token.
     #
     # bearer_token_auth: false

diff --git a/haproxy/datadog_checks/haproxy/config_models/defaults.py b/haproxy/datadog_checks/haproxy/config_models/defaults.py
@@ -1,4 +1,4 @@
-# (C) Datadog, Inc. 2021-present
+# (C) Datadog, Inc. 2022-present
 # All rights reserved
 # Licensed under a 3-clause BSD style license (see LICENSE)
 
@@ -55,7 +55,7 @@ def instance_aws_service(field, value):
 
 
 def instance_bearer_token_auth(field, value):
-    return False
+    return get_default_field_value(field, value)
 
 
 def instance_bearer_token_path(field, value):