Skip to content

[observability pipelines] add tls.verify_certificate field to multiple push sources #3537

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
api-clients-generation-pipeline wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[observability pipelines] add tls.verify_certificate field to multiple push sources #3537

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 33 additions & 10 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50232,7 +50232,7 @@ components:
example: "fluent-source"
type: string
tls:
$ref: "#/components/schemas/ObservabilityPipelineTls"
$ref: "#/components/schemas/ObservabilityPipelineMtlsServerTls"
type:
$ref: "#/components/schemas/ObservabilityPipelineFluentBitSourceType"
required:
Expand Down Expand Up @@ -50264,7 +50264,7 @@ components:
example: "fluent-source"
type: string
tls:
$ref: "#/components/schemas/ObservabilityPipelineTls"
$ref: "#/components/schemas/ObservabilityPipelineMtlsServerTls"
type:
$ref: "#/components/schemas/ObservabilityPipelineFluentdSourceType"
required:
Expand Down Expand Up @@ -50865,7 +50865,7 @@ components:
example: HTTP_AUTH_PASSWORD
type: string
tls:
$ref: "#/components/schemas/ObservabilityPipelineTls"
$ref: "#/components/schemas/ObservabilityPipelineMtlsServerTls"
type:
$ref: "#/components/schemas/ObservabilityPipelineHttpServerSourceType"
username_key:
Expand Down Expand Up @@ -51120,7 +51120,7 @@ components:
example: logstash-source
type: string
tls:
$ref: "#/components/schemas/ObservabilityPipelineTls"
$ref: "#/components/schemas/ObservabilityPipelineMtlsServerTls"
type:
$ref: "#/components/schemas/ObservabilityPipelineLogstashSourceType"
required:
Expand Down Expand Up @@ -51271,6 +51271,29 @@ components:
oneOf:
- $ref: "#/components/schemas/ObservabilityPipelineGeneratedMetricIncrementByOne"
- $ref: "#/components/schemas/ObservabilityPipelineGeneratedMetricIncrementByField"
ObservabilityPipelineMtlsServerTls:
description: Configuration for enabling TLS encryption between the pipeline component and external connecting clients.
properties:
ca_file:
description: Path to the Certificate Authority (CA) file used to validate connecting clients' TLS certificates.
type: string
crt_file:
description: Path to the TLS server certificate file used to used to identify the pipeline component to connecting clients.
example: "/path/to/cert.crt"
type: string
key_file:
description: Path to the private key file associated with the TLS server certificate.
type: string
key_pass_key:
description: Name of the environment variable or secret that holds the passphrase for the private key file.
example: TLS_KEY_PASSPHRASE
type: string
verify_certificate:
description: When `true`, requires client connections to present a valid certificate, enabling mutual TLS authentication.
type: boolean
required:
- crt_file
type: object
ObservabilityPipelineNewRelicDestination:
description: |-
The `new_relic` destination sends logs to the New Relic platform.
Expand Down Expand Up @@ -51610,7 +51633,7 @@ components:
example: opentelemetry-source
type: string
tls:
$ref: "#/components/schemas/ObservabilityPipelineTls"
$ref: "#/components/schemas/ObservabilityPipelineMtlsServerTls"
type:
$ref: "#/components/schemas/ObservabilityPipelineOpentelemetrySourceType"
required:
Expand Down Expand Up @@ -52238,7 +52261,7 @@ components:
mode:
$ref: "#/components/schemas/ObservabilityPipelineSyslogSourceMode"
tls:
$ref: "#/components/schemas/ObservabilityPipelineTls"
$ref: "#/components/schemas/ObservabilityPipelineMtlsServerTls"
type:
$ref: "#/components/schemas/ObservabilityPipelineRsyslogSourceType"
required:
Expand Down Expand Up @@ -52809,7 +52832,7 @@ components:
mode:
$ref: "#/components/schemas/ObservabilityPipelineSocketSourceMode"
tls:
$ref: "#/components/schemas/ObservabilityPipelineTls"
$ref: "#/components/schemas/ObservabilityPipelineMtlsServerTls"
description: TLS configuration. Relevant only when `mode` is `tcp`.
type:
$ref: "#/components/schemas/ObservabilityPipelineSocketSourceType"
Expand Down Expand Up @@ -53113,7 +53136,7 @@ components:
example: true
type: boolean
tls:
$ref: "#/components/schemas/ObservabilityPipelineTls"
$ref: "#/components/schemas/ObservabilityPipelineMtlsServerTls"
type:
$ref: "#/components/schemas/ObservabilityPipelineSplunkHecSourceType"
required:
Expand Down Expand Up @@ -53146,7 +53169,7 @@ components:
example: splunk-tcp-source
type: string
tls:
$ref: "#/components/schemas/ObservabilityPipelineTls"
$ref: "#/components/schemas/ObservabilityPipelineMtlsServerTls"
type:
$ref: "#/components/schemas/ObservabilityPipelineSplunkTcpSourceType"
required:
Expand Down Expand Up @@ -53340,7 +53363,7 @@ components:
mode:
$ref: "#/components/schemas/ObservabilityPipelineSyslogSourceMode"
tls:
$ref: "#/components/schemas/ObservabilityPipelineTls"
$ref: "#/components/schemas/ObservabilityPipelineMtlsServerTls"
type:
$ref: "#/components/schemas/ObservabilityPipelineSyslogNgSourceType"
required:
Expand Down
7 changes: 7 additions & 0 deletions docs/datadog_api_client.v2.model.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21984,6 +21984,13 @@ datadog\_api\_client.v2.model.observability\_pipeline\_metric\_value module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.observability\_pipeline\_mtls\_server\_tls module
-------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.observability_pipeline_mtls_server_tls
:members:
:show-inheritance:

datadog\_api\_client.v2.model.observability\_pipeline\_new\_relic\_destination module
-------------------------------------------------------------------------------------

Expand Down
14 changes: 8 additions & 6 deletions src/datadog_api_client/v2/model/observability_pipeline_fluent_bit_source.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@


if TYPE_CHECKING:
from datadog_api_client.v2.model.observability_pipeline_tls import ObservabilityPipelineTls
from datadog_api_client.v2.model.observability_pipeline_mtls_server_tls import ObservabilityPipelineMtlsServerTls
from datadog_api_client.v2.model.observability_pipeline_fluent_bit_source_type import (
ObservabilityPipelineFluentBitSourceType,
)
Expand All @@ -23,15 +23,17 @@
class ObservabilityPipelineFluentBitSource(ModelNormal):
@cached_property
def openapi_types(_):
from datadog_api_client.v2.model.observability_pipeline_tls import ObservabilityPipelineTls
from datadog_api_client.v2.model.observability_pipeline_mtls_server_tls import (
ObservabilityPipelineMtlsServerTls,
)
from datadog_api_client.v2.model.observability_pipeline_fluent_bit_source_type import (
ObservabilityPipelineFluentBitSourceType,
)

return {
"address_key": (str,),
"id": (str,),
"tls": (ObservabilityPipelineTls,),
"tls": (ObservabilityPipelineMtlsServerTls,),
"type": (ObservabilityPipelineFluentBitSourceType,),
}

Expand All @@ -47,7 +49,7 @@ def __init__(
id: str,
type: ObservabilityPipelineFluentBitSourceType,
address_key: Union[str, UnsetType] = unset,
tls: Union[ObservabilityPipelineTls, UnsetType] = unset,
tls: Union[ObservabilityPipelineMtlsServerTls, UnsetType] = unset,
**kwargs,
):
"""
Expand All @@ -61,8 +63,8 @@ def __init__(
:param id: The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the ``input`` to downstream components).
:type id: str

:param tls: Configuration for enabling TLS encryption between the pipeline component and external services.
:type tls: ObservabilityPipelineTls, optional
:param tls: Configuration for enabling TLS encryption between the pipeline component and external connecting clients.
:type tls: ObservabilityPipelineMtlsServerTls, optional

:param type: The source type. The value should always be ``fluent_bit``.
:type type: ObservabilityPipelineFluentBitSourceType
Expand Down
14 changes: 8 additions & 6 deletions src/datadog_api_client/v2/model/observability_pipeline_fluentd_source.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@


if TYPE_CHECKING:
from datadog_api_client.v2.model.observability_pipeline_tls import ObservabilityPipelineTls
from datadog_api_client.v2.model.observability_pipeline_mtls_server_tls import ObservabilityPipelineMtlsServerTls
from datadog_api_client.v2.model.observability_pipeline_fluentd_source_type import (
ObservabilityPipelineFluentdSourceType,
)
Expand All @@ -23,15 +23,17 @@
class ObservabilityPipelineFluentdSource(ModelNormal):
@cached_property
def openapi_types(_):
from datadog_api_client.v2.model.observability_pipeline_tls import ObservabilityPipelineTls
from datadog_api_client.v2.model.observability_pipeline_mtls_server_tls import (
ObservabilityPipelineMtlsServerTls,
)
from datadog_api_client.v2.model.observability_pipeline_fluentd_source_type import (
ObservabilityPipelineFluentdSourceType,
)

return {
"address_key": (str,),
"id": (str,),
"tls": (ObservabilityPipelineTls,),
"tls": (ObservabilityPipelineMtlsServerTls,),
"type": (ObservabilityPipelineFluentdSourceType,),
}

Expand All @@ -47,7 +49,7 @@ def __init__(
id: str,
type: ObservabilityPipelineFluentdSourceType,
address_key: Union[str, UnsetType] = unset,
tls: Union[ObservabilityPipelineTls, UnsetType] = unset,
tls: Union[ObservabilityPipelineMtlsServerTls, UnsetType] = unset,
**kwargs,
):
"""
Expand All @@ -61,8 +63,8 @@ def __init__(
:param id: The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the ``input`` to downstream components).
:type id: str

:param tls: Configuration for enabling TLS encryption between the pipeline component and external services.
:type tls: ObservabilityPipelineTls, optional
:param tls: Configuration for enabling TLS encryption between the pipeline component and external connecting clients.
:type tls: ObservabilityPipelineMtlsServerTls, optional

:param type: The source type. The value should always be `fluentd.
:type type: ObservabilityPipelineFluentdSourceType
Expand Down
14 changes: 8 additions & 6 deletions src/datadog_api_client/v2/model/observability_pipeline_http_server_source.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
ObservabilityPipelineHttpServerSourceAuthStrategy,
)
from datadog_api_client.v2.model.observability_pipeline_decoding import ObservabilityPipelineDecoding
from datadog_api_client.v2.model.observability_pipeline_tls import ObservabilityPipelineTls
from datadog_api_client.v2.model.observability_pipeline_mtls_server_tls import ObservabilityPipelineMtlsServerTls
from datadog_api_client.v2.model.observability_pipeline_http_server_source_type import (
ObservabilityPipelineHttpServerSourceType,
)
Expand All @@ -31,7 +31,9 @@ def openapi_types(_):
ObservabilityPipelineHttpServerSourceAuthStrategy,
)
from datadog_api_client.v2.model.observability_pipeline_decoding import ObservabilityPipelineDecoding
from datadog_api_client.v2.model.observability_pipeline_tls import ObservabilityPipelineTls
from datadog_api_client.v2.model.observability_pipeline_mtls_server_tls import (
ObservabilityPipelineMtlsServerTls,
)
from datadog_api_client.v2.model.observability_pipeline_http_server_source_type import (
ObservabilityPipelineHttpServerSourceType,
)
Expand All @@ -43,7 +45,7 @@ def openapi_types(_):
"decoding": (ObservabilityPipelineDecoding,),
"id": (str,),
"password_key": (str,),
"tls": (ObservabilityPipelineTls,),
"tls": (ObservabilityPipelineMtlsServerTls,),
"type": (ObservabilityPipelineHttpServerSourceType,),
"username_key": (str,),
}
Expand All @@ -69,7 +71,7 @@ def __init__(
address_key: Union[str, UnsetType] = unset,
custom_key: Union[str, UnsetType] = unset,
password_key: Union[str, UnsetType] = unset,
tls: Union[ObservabilityPipelineTls, UnsetType] = unset,
tls: Union[ObservabilityPipelineMtlsServerTls, UnsetType] = unset,
username_key: Union[str, UnsetType] = unset,
**kwargs,
):
Expand All @@ -96,8 +98,8 @@ def __init__(
:param password_key: Name of the environment variable or secret that holds the password (used when ``auth_strategy`` is ``plain`` ).
:type password_key: str, optional

:param tls: Configuration for enabling TLS encryption between the pipeline component and external services.
:type tls: ObservabilityPipelineTls, optional
:param tls: Configuration for enabling TLS encryption between the pipeline component and external connecting clients.
:type tls: ObservabilityPipelineMtlsServerTls, optional

:param type: The source type. The value should always be ``http_server``.
:type type: ObservabilityPipelineHttpServerSourceType
Expand Down
14 changes: 8 additions & 6 deletions src/datadog_api_client/v2/model/observability_pipeline_logstash_source.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@


if TYPE_CHECKING:
from datadog_api_client.v2.model.observability_pipeline_tls import ObservabilityPipelineTls
from datadog_api_client.v2.model.observability_pipeline_mtls_server_tls import ObservabilityPipelineMtlsServerTls
from datadog_api_client.v2.model.observability_pipeline_logstash_source_type import (
ObservabilityPipelineLogstashSourceType,
)
Expand All @@ -23,15 +23,17 @@
class ObservabilityPipelineLogstashSource(ModelNormal):
@cached_property
def openapi_types(_):
from datadog_api_client.v2.model.observability_pipeline_tls import ObservabilityPipelineTls
from datadog_api_client.v2.model.observability_pipeline_mtls_server_tls import (
ObservabilityPipelineMtlsServerTls,
)
from datadog_api_client.v2.model.observability_pipeline_logstash_source_type import (
ObservabilityPipelineLogstashSourceType,
)

return {
"address_key": (str,),
"id": (str,),
"tls": (ObservabilityPipelineTls,),
"tls": (ObservabilityPipelineMtlsServerTls,),
"type": (ObservabilityPipelineLogstashSourceType,),
}

Expand All @@ -47,7 +49,7 @@ def __init__(
id: str,
type: ObservabilityPipelineLogstashSourceType,
address_key: Union[str, UnsetType] = unset,
tls: Union[ObservabilityPipelineTls, UnsetType] = unset,
tls: Union[ObservabilityPipelineMtlsServerTls, UnsetType] = unset,
**kwargs,
):
"""
Expand All @@ -61,8 +63,8 @@ def __init__(
:param id: The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the ``input`` to downstream components).
:type id: str

:param tls: Configuration for enabling TLS encryption between the pipeline component and external services.
:type tls: ObservabilityPipelineTls, optional
:param tls: Configuration for enabling TLS encryption between the pipeline component and external connecting clients.
:type tls: ObservabilityPipelineMtlsServerTls, optional

:param type: The source type. The value should always be ``logstash``.
:type type: ObservabilityPipelineLogstashSourceType
Expand Down
Loading
Loading