Add tls_protocols_allowed option documentation (#11251)

* Sync models * Sync configuration * Bump minimum base package * Rename option * Update description
DataDog · Feb 4, 2022 · 3e129cc · 3e129cc
1 parent 0263d56
commit 3e129cc
Show file tree

Hide file tree

Showing 272 changed files with 1,403 additions and 70 deletions.
diff --git a/activemq_xml/datadog_checks/activemq_xml/config_models/defaults.py b/activemq_xml/datadog_checks/activemq_xml/config_models/defaults.py
@@ -178,6 +178,10 @@ def instance_tls_private_key(field, value):
     return get_default_field_value(field, value)
 
 
+def instance_tls_protocols_allowed(field, value):
+    return get_default_field_value(field, value)
+
+
 def instance_tls_use_host_header(field, value):
     return False
 

diff --git a/activemq_xml/datadog_checks/activemq_xml/config_models/instance.py b/activemq_xml/datadog_checks/activemq_xml/config_models/instance.py
@@ -78,6 +78,7 @@ class Config:
     tls_cert: Optional[str]
     tls_ignore_warning: Optional[bool]
     tls_private_key: Optional[str]
+    tls_protocols_allowed: Optional[Sequence[str]]
     tls_use_host_header: Optional[bool]
     tls_verify: Optional[bool]
     url: str

diff --git a/activemq_xml/datadog_checks/activemq_xml/data/conf.yaml.example b/activemq_xml/datadog_checks/activemq_xml/data/conf.yaml.example
@@ -314,6 +314,20 @@ instances:
     #
     # tls_ca_cert: <CA_CERT_PATH>
 
+    ## @param tls_protocols_allowed - list of strings - optional
+    ## The expected versions of TLS/SSL when fetching intermediate certificates.
+    ## Only `SSLv3`, `TLSv1.2`, `TLSv1.3` are allowed by default. The possible values are:
+    ##   SSLv3
+    ##   TLSv1
+    ##   TLSv1.1
+    ##   TLSv1.2
+    ##   TLSv1.3
+    #
+    # tls_protocols_allowed:
+    #   - SSLv3
+    #   - TLSv1.2
+    #   - TLSv1.3
+
     ## @param headers - mapping - optional
     ## The headers parameter allows you to send specific headers with every request.
     ## You can use it for explicitly specifying the host header or adding headers for

diff --git a/activemq_xml/setup.py b/activemq_xml/setup.py
@@ -29,7 +29,7 @@ def get_dependencies():
         return f.readlines()
 
 
-CHECKS_BASE_REQ = 'datadog-checks-base>=15.7.0'
+CHECKS_BASE_REQ = 'datadog-checks-base>=24.0.0'
 
 setup(
     name='datadog-activemq_xml',

diff --git a/airflow/datadog_checks/airflow/config_models/defaults.py b/airflow/datadog_checks/airflow/config_models/defaults.py
@@ -162,6 +162,10 @@ def instance_tls_private_key(field, value):
     return get_default_field_value(field, value)
 
 
+def instance_tls_protocols_allowed(field, value):
+    return get_default_field_value(field, value)
+
+
 def instance_tls_use_host_header(field, value):
     return False
 

diff --git a/airflow/datadog_checks/airflow/config_models/instance.py b/airflow/datadog_checks/airflow/config_models/instance.py
@@ -74,6 +74,7 @@ class Config:
     tls_cert: Optional[str]
     tls_ignore_warning: Optional[bool]
     tls_private_key: Optional[str]
+    tls_protocols_allowed: Optional[Sequence[str]]
     tls_use_host_header: Optional[bool]
     tls_verify: Optional[bool]
     url: str

diff --git a/airflow/datadog_checks/airflow/data/conf.yaml.example b/airflow/datadog_checks/airflow/data/conf.yaml.example
@@ -285,6 +285,20 @@ instances:
     #
     # tls_ca_cert: <CA_CERT_PATH>
 
+    ## @param tls_protocols_allowed - list of strings - optional
+    ## The expected versions of TLS/SSL when fetching intermediate certificates.
+    ## Only `SSLv3`, `TLSv1.2`, `TLSv1.3` are allowed by default. The possible values are:
+    ##   SSLv3
+    ##   TLSv1
+    ##   TLSv1.1
+    ##   TLSv1.2
+    ##   TLSv1.3
+    #
+    # tls_protocols_allowed:
+    #   - SSLv3
+    #   - TLSv1.2
+    #   - TLSv1.3
+
     ## @param headers - mapping - optional
     ## The headers parameter allows you to send specific headers with every request.
     ## You can use it for explicitly specifying the host header or adding headers for

diff --git a/airflow/setup.py b/airflow/setup.py
@@ -27,7 +27,7 @@ def get_dependencies():
         return f.readlines()
 
 
-CHECKS_BASE_REQ = 'datadog-checks-base>=11.2.0'
+CHECKS_BASE_REQ = 'datadog-checks-base>=24.0.0'
 
 
 setup(

diff --git a/amazon_msk/datadog_checks/amazon_msk/config_models/defaults.py b/amazon_msk/datadog_checks/amazon_msk/config_models/defaults.py
@@ -278,6 +278,10 @@ def instance_tls_private_key(field, value):
     return get_default_field_value(field, value)
 
 
+def instance_tls_protocols_allowed(field, value):
+    return get_default_field_value(field, value)
+
+
 def instance_tls_use_host_header(field, value):
     return False
 

diff --git a/amazon_msk/datadog_checks/amazon_msk/config_models/instance.py b/amazon_msk/datadog_checks/amazon_msk/config_models/instance.py
@@ -130,6 +130,7 @@ class Config:
     tls_cert: Optional[str]
     tls_ignore_warning: Optional[bool]
     tls_private_key: Optional[str]
+    tls_protocols_allowed: Optional[Sequence[str]]
     tls_use_host_header: Optional[bool]
     tls_verify: Optional[bool]
     use_latest_spec: Optional[bool]

diff --git a/amazon_msk/datadog_checks/amazon_msk/data/conf.yaml.example b/amazon_msk/datadog_checks/amazon_msk/data/conf.yaml.example
@@ -551,6 +551,20 @@ instances:
     #
     # tls_ca_cert: <CA_CERT_PATH>
 
+    ## @param tls_protocols_allowed - list of strings - optional
+    ## The expected versions of TLS/SSL when fetching intermediate certificates.
+    ## Only `SSLv3`, `TLSv1.2`, `TLSv1.3` are allowed by default. The possible values are:
+    ##   SSLv3
+    ##   TLSv1
+    ##   TLSv1.1
+    ##   TLSv1.2
+    ##   TLSv1.3
+    #
+    # tls_protocols_allowed:
+    #   - SSLv3
+    #   - TLSv1.2
+    #   - TLSv1.3
+
     ## @param headers - mapping - optional
     ## The headers parameter allows you to send specific headers with every request.
     ## You can use it for explicitly specifying the host header or adding headers for

diff --git a/amazon_msk/setup.py b/amazon_msk/setup.py
@@ -27,7 +27,7 @@ def get_dependencies():
         return f.readlines()
 
 
-CHECKS_BASE_REQ = 'datadog-checks-base>=23.2.0'
+CHECKS_BASE_REQ = 'datadog-checks-base>=24.0.0'
 
 
 setup(

diff --git a/ambari/datadog_checks/ambari/config_models/defaults.py b/ambari/datadog_checks/ambari/config_models/defaults.py
@@ -174,6 +174,10 @@ def instance_tls_private_key(field, value):
     return get_default_field_value(field, value)
 
 
+def instance_tls_protocols_allowed(field, value):
+    return get_default_field_value(field, value)
+
+
 def instance_tls_use_host_header(field, value):
     return False
 

diff --git a/ambari/datadog_checks/ambari/config_models/instance.py b/ambari/datadog_checks/ambari/config_models/instance.py
@@ -75,6 +75,7 @@ class Config:
     tls_cert: Optional[str]
     tls_ignore_warning: Optional[bool]
     tls_private_key: Optional[str]
+    tls_protocols_allowed: Optional[Sequence[str]]
     tls_use_host_header: Optional[bool]
     tls_verify: Optional[bool]
     url: str

diff --git a/ambari/datadog_checks/ambari/data/conf.yaml.example b/ambari/datadog_checks/ambari/data/conf.yaml.example
@@ -314,6 +314,20 @@ instances:
     #
     # tls_ca_cert: <CA_CERT_PATH>
 
+    ## @param tls_protocols_allowed - list of strings - optional
+    ## The expected versions of TLS/SSL when fetching intermediate certificates.
+    ## Only `SSLv3`, `TLSv1.2`, `TLSv1.3` are allowed by default. The possible values are:
+    ##   SSLv3
+    ##   TLSv1
+    ##   TLSv1.1
+    ##   TLSv1.2
+    ##   TLSv1.3
+    #
+    # tls_protocols_allowed:
+    #   - SSLv3
+    #   - TLSv1.2
+    #   - TLSv1.3
+
     ## @param headers - mapping - optional
     ## The headers parameter allows you to send specific headers with every request.
     ## You can use it for explicitly specifying the host header or adding headers for

diff --git a/ambari/setup.py b/ambari/setup.py
@@ -27,7 +27,7 @@ def get_dependencies():
         return f.readlines()
 
 
-CHECKS_BASE_REQ = 'datadog-checks-base>=11.2.0'
+CHECKS_BASE_REQ = 'datadog-checks-base>=24.0.0'
 
 
 setup(

diff --git a/apache/datadog_checks/apache/config_models/defaults.py b/apache/datadog_checks/apache/config_models/defaults.py
@@ -162,6 +162,10 @@ def instance_tls_private_key(field, value):
     return get_default_field_value(field, value)
 
 
+def instance_tls_protocols_allowed(field, value):
+    return get_default_field_value(field, value)
+
+
 def instance_tls_use_host_header(field, value):
     return False
 

diff --git a/apache/datadog_checks/apache/config_models/instance.py b/apache/datadog_checks/apache/config_models/instance.py
@@ -75,6 +75,7 @@ class Config:
     tls_cert: Optional[str]
     tls_ignore_warning: Optional[bool]
     tls_private_key: Optional[str]
+    tls_protocols_allowed: Optional[Sequence[str]]
     tls_use_host_header: Optional[bool]
     tls_verify: Optional[bool]
     use_legacy_auth_encoding: Optional[bool]

diff --git a/apache/datadog_checks/apache/data/conf.yaml.example b/apache/datadog_checks/apache/data/conf.yaml.example
@@ -285,6 +285,20 @@ instances:
     #
     # tls_ca_cert: <CA_CERT_PATH>
 
+    ## @param tls_protocols_allowed - list of strings - optional
+    ## The expected versions of TLS/SSL when fetching intermediate certificates.
+    ## Only `SSLv3`, `TLSv1.2`, `TLSv1.3` are allowed by default. The possible values are:
+    ##   SSLv3
+    ##   TLSv1
+    ##   TLSv1.1
+    ##   TLSv1.2
+    ##   TLSv1.3
+    #
+    # tls_protocols_allowed:
+    #   - SSLv3
+    #   - TLSv1.2
+    #   - TLSv1.3
+
     ## @param headers - mapping - optional
     ## The headers parameter allows you to send specific headers with every request.
     ## You can use it for explicitly specifying the host header or adding headers for

diff --git a/apache/setup.py b/apache/setup.py
@@ -37,7 +37,7 @@ def get_dependencies():
         return f.readlines()
 
 
-CHECKS_BASE_REQ = 'datadog-checks-base>=15.0.0'
+CHECKS_BASE_REQ = 'datadog-checks-base>=24.0.0'
 
 setup(
     name='datadog-apache',

diff --git a/avi_vantage/datadog_checks/avi_vantage/config_models/defaults.py b/avi_vantage/datadog_checks/avi_vantage/config_models/defaults.py
@@ -258,6 +258,10 @@ def instance_tls_private_key(field, value):
     return get_default_field_value(field, value)
 
 
+def instance_tls_protocols_allowed(field, value):
+    return get_default_field_value(field, value)
+
+
 def instance_tls_use_host_header(field, value):
     return False
 

diff --git a/avi_vantage/datadog_checks/avi_vantage/config_models/instance.py b/avi_vantage/datadog_checks/avi_vantage/config_models/instance.py
@@ -125,6 +125,7 @@ class Config:
     tls_cert: Optional[str]
     tls_ignore_warning: Optional[bool]
     tls_private_key: Optional[str]
+    tls_protocols_allowed: Optional[Sequence[str]]
     tls_use_host_header: Optional[bool]
     tls_verify: Optional[bool]
     use_latest_spec: Optional[bool]

diff --git a/avi_vantage/datadog_checks/avi_vantage/data/conf.yaml.example b/avi_vantage/datadog_checks/avi_vantage/data/conf.yaml.example
@@ -513,6 +513,20 @@ instances:
     #
     # tls_ca_cert: <CA_CERT_PATH>
 
+    ## @param tls_protocols_allowed - list of strings - optional
+    ## The expected versions of TLS/SSL when fetching intermediate certificates.
+    ## Only `SSLv3`, `TLSv1.2`, `TLSv1.3` are allowed by default. The possible values are:
+    ##   SSLv3
+    ##   TLSv1
+    ##   TLSv1.1
+    ##   TLSv1.2
+    ##   TLSv1.3
+    #
+    # tls_protocols_allowed:
+    #   - SSLv3
+    #   - TLSv1.2
+    #   - TLSv1.3
+
     ## @param headers - mapping - optional
     ## The headers parameter allows you to send specific headers with every request.
     ## You can use it for explicitly specifying the host header or adding headers for

diff --git a/avi_vantage/setup.py b/avi_vantage/setup.py
@@ -27,7 +27,7 @@ def get_dependencies():
         return f.readlines()
 
 
-CHECKS_BASE_REQ = 'datadog-checks-base>=23.2.0'
+CHECKS_BASE_REQ = 'datadog-checks-base>=24.0.0'
 
 
 setup(

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
@@ -246,6 +246,10 @@ def instance_tls_private_key(field, value):
     return get_default_field_value(field, value)
 
 
+def instance_tls_protocols_allowed(field, value):
+    return get_default_field_value(field, value)
+
+
 def instance_tls_use_host_header(field, value):
     return False
 

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
@@ -120,6 +120,7 @@ class Config:
     tls_cert: Optional[str]
     tls_ignore_warning: Optional[bool]
     tls_private_key: Optional[str]
+    tls_protocols_allowed: Optional[Sequence[str]]
     tls_use_host_header: Optional[bool]
     tls_verify: Optional[bool]
     type_overrides: Optional[Mapping[str, Any]]

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
@@ -420,6 +420,20 @@ instances:
     #
     # tls_ca_cert: <CA_CERT_PATH>
 
+    ## @param tls_protocols_allowed - list of strings - optional
+    ## The expected versions of TLS/SSL when fetching intermediate certificates.
+    ## Only `SSLv3`, `TLSv1.2`, `TLSv1.3` are allowed by default. The possible values are:
+    ##   SSLv3
+    ##   TLSv1
+    ##   TLSv1.1
+    ##   TLSv1.2
+    ##   TLSv1.3
+    #
+    # tls_protocols_allowed:
+    #   - SSLv3
+    #   - TLSv1.2
+    #   - TLSv1.3
+
     ## @param headers - mapping - optional
     ## The headers parameter allows you to send specific headers with every request.
     ## You can use it for explicitly specifying the host header or adding headers for

diff --git a/azure_iot_edge/setup.py b/azure_iot_edge/setup.py
@@ -27,7 +27,7 @@ def get_dependencies():
         return f.readlines()
 
 
-CHECKS_BASE_REQ = 'datadog-checks-base>=23.2.0'
+CHECKS_BASE_REQ = 'datadog-checks-base>=24.0.0'
 
 
 setup(

diff --git a/cilium/datadog_checks/cilium/config_models/defaults.py b/cilium/datadog_checks/cilium/config_models/defaults.py
@@ -326,6 +326,10 @@ def instance_tls_private_key(field, value):
     return get_default_field_value(field, value)
 
 
+def instance_tls_protocols_allowed(field, value):
+    return get_default_field_value(field, value)
+
+
 def instance_tls_use_host_header(field, value):
     return False
 

diff --git a/cilium/datadog_checks/cilium/config_models/instance.py b/cilium/datadog_checks/cilium/config_models/instance.py
@@ -164,6 +164,7 @@ class Config:
     tls_cert: Optional[str]
     tls_ignore_warning: Optional[bool]
     tls_private_key: Optional[str]
+    tls_protocols_allowed: Optional[Sequence[str]]
     tls_use_host_header: Optional[bool]
     tls_verify: Optional[bool]
     type_overrides: Optional[Mapping[str, Any]]

diff --git a/cilium/datadog_checks/cilium/data/conf.yaml.example b/cilium/datadog_checks/cilium/data/conf.yaml.example
@@ -518,6 +518,20 @@ instances:
     #
     # tls_ca_cert: <CA_CERT_PATH>
 
+    ## @param tls_protocols_allowed - list of strings - optional
+    ## The expected versions of TLS/SSL when fetching intermediate certificates.
+    ## Only `SSLv3`, `TLSv1.2`, `TLSv1.3` are allowed by default. The possible values are:
+    ##   SSLv3
+    ##   TLSv1
+    ##   TLSv1.1
+    ##   TLSv1.2
+    ##   TLSv1.3
+    #
+    # tls_protocols_allowed:
+    #   - SSLv3
+    #   - TLSv1.2
+    #   - TLSv1.3
+
     ## @param headers - mapping - optional
     ## The headers parameter allows you to send specific headers with every request.
     ## You can use it for explicitly specifying the host header or adding headers for

diff --git a/cilium/setup.py b/cilium/setup.py
@@ -27,7 +27,7 @@ def get_dependencies():
         return f.readlines()
 
 
-CHECKS_BASE_REQ = 'datadog-checks-base>=23.2.0'
+CHECKS_BASE_REQ = 'datadog-checks-base>=24.0.0'
 
 
 setup(
-Original file line number
+Diff line change
@@ Expand Up / @@ -27,7 +27,7 @@ def get_dependencies(): @@
             return f.readlines()
-    CHECKS_BASE_REQ = 'datadog-checks-base>=11.2.0'
+    CHECKS_BASE_REQ = 'datadog-checks-base>=24.0.0'
     setup(
@@ Expand Down @@