Skip to content

Commit cc0bebb

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
observability pipelines add tls.verify_certificate field to multiple push sources (#4174)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 1373dfc commit cc0bebb

14 files changed

Lines changed: 161 additions & 50 deletions

.generator/schemas/v2/openapi.yaml

Lines changed: 33 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -54546,7 +54546,7 @@ components:
5454654546
example: "fluent-source"
5454754547
type: string
5454854548
tls:
54549-
$ref: "#/components/schemas/ObservabilityPipelineTls"
54549+
$ref: "#/components/schemas/ObservabilityPipelineMtlsServerTls"
5455054550
type:
5455154551
$ref: "#/components/schemas/ObservabilityPipelineFluentBitSourceType"
5455254552
required:
@@ -54578,7 +54578,7 @@ components:
5457854578
example: "fluent-source"
5457954579
type: string
5458054580
tls:
54581-
$ref: "#/components/schemas/ObservabilityPipelineTls"
54581+
$ref: "#/components/schemas/ObservabilityPipelineMtlsServerTls"
5458254582
type:
5458354583
$ref: "#/components/schemas/ObservabilityPipelineFluentdSourceType"
5458454584
required:
@@ -55179,7 +55179,7 @@ components:
5517955179
example: HTTP_AUTH_PASSWORD
5518055180
type: string
5518155181
tls:
55182-
$ref: "#/components/schemas/ObservabilityPipelineTls"
55182+
$ref: "#/components/schemas/ObservabilityPipelineMtlsServerTls"
5518355183
type:
5518455184
$ref: "#/components/schemas/ObservabilityPipelineHttpServerSourceType"
5518555185
username_key:
@@ -55493,7 +55493,7 @@ components:
5549355493
example: logstash-source
5549455494
type: string
5549555495
tls:
55496-
$ref: "#/components/schemas/ObservabilityPipelineTls"
55496+
$ref: "#/components/schemas/ObservabilityPipelineMtlsServerTls"
5549755497
type:
5549855498
$ref: "#/components/schemas/ObservabilityPipelineLogstashSourceType"
5549955499
required:
@@ -55644,6 +55644,29 @@ components:
5564455644
oneOf:
5564555645
- $ref: "#/components/schemas/ObservabilityPipelineGeneratedMetricIncrementByOne"
5564655646
- $ref: "#/components/schemas/ObservabilityPipelineGeneratedMetricIncrementByField"
55647+
ObservabilityPipelineMtlsServerTls:
55648+
description: Configuration for enabling TLS encryption between the pipeline component and external connecting clients.
55649+
properties:
55650+
ca_file:
55651+
description: Path to the Certificate Authority (CA) file used to validate connecting clients' TLS certificates.
55652+
type: string
55653+
crt_file:
55654+
description: Path to the TLS server certificate file used to used to identify the pipeline component to connecting clients.
55655+
example: "/path/to/cert.crt"
55656+
type: string
55657+
key_file:
55658+
description: Path to the private key file associated with the TLS server certificate.
55659+
type: string
55660+
key_pass_key:
55661+
description: Name of the environment variable or secret that holds the passphrase for the private key file.
55662+
example: TLS_KEY_PASSPHRASE
55663+
type: string
55664+
verify_certificate:
55665+
description: When `true`, requires client connections to present a valid certificate, enabling mutual TLS authentication.
55666+
type: boolean
55667+
required:
55668+
- crt_file
55669+
type: object
5564755670
ObservabilityPipelineNewRelicDestination:
5564855671
description: |-
5564955672
The `new_relic` destination sends logs to the New Relic platform.
@@ -55983,7 +56006,7 @@ components:
5598356006
example: opentelemetry-source
5598456007
type: string
5598556008
tls:
55986-
$ref: "#/components/schemas/ObservabilityPipelineTls"
56009+
$ref: "#/components/schemas/ObservabilityPipelineMtlsServerTls"
5598756010
type:
5598856011
$ref: "#/components/schemas/ObservabilityPipelineOpentelemetrySourceType"
5598956012
required:
@@ -56611,7 +56634,7 @@ components:
5661156634
mode:
5661256635
$ref: "#/components/schemas/ObservabilityPipelineSyslogSourceMode"
5661356636
tls:
56614-
$ref: "#/components/schemas/ObservabilityPipelineTls"
56637+
$ref: "#/components/schemas/ObservabilityPipelineMtlsServerTls"
5661556638
type:
5661656639
$ref: "#/components/schemas/ObservabilityPipelineRsyslogSourceType"
5661756640
required:
@@ -57182,7 +57205,7 @@ components:
5718257205
mode:
5718357206
$ref: "#/components/schemas/ObservabilityPipelineSocketSourceMode"
5718457207
tls:
57185-
$ref: "#/components/schemas/ObservabilityPipelineTls"
57208+
$ref: "#/components/schemas/ObservabilityPipelineMtlsServerTls"
5718657209
description: TLS configuration. Relevant only when `mode` is `tcp`.
5718757210
type:
5718857211
$ref: "#/components/schemas/ObservabilityPipelineSocketSourceType"
@@ -57507,7 +57530,7 @@ components:
5750757530
example: true
5750857531
type: boolean
5750957532
tls:
57510-
$ref: "#/components/schemas/ObservabilityPipelineTls"
57533+
$ref: "#/components/schemas/ObservabilityPipelineMtlsServerTls"
5751157534
type:
5751257535
$ref: "#/components/schemas/ObservabilityPipelineSplunkHecSourceType"
5751357536
valid_tokens:
@@ -57569,7 +57592,7 @@ components:
5756957592
example: splunk-tcp-source
5757057593
type: string
5757157594
tls:
57572-
$ref: "#/components/schemas/ObservabilityPipelineTls"
57595+
$ref: "#/components/schemas/ObservabilityPipelineMtlsServerTls"
5757357596
type:
5757457597
$ref: "#/components/schemas/ObservabilityPipelineSplunkTcpSourceType"
5757557598
required:
@@ -57763,7 +57786,7 @@ components:
5776357786
mode:
5776457787
$ref: "#/components/schemas/ObservabilityPipelineSyslogSourceMode"
5776557788
tls:
57766-
$ref: "#/components/schemas/ObservabilityPipelineTls"
57789+
$ref: "#/components/schemas/ObservabilityPipelineMtlsServerTls"
5776757790
type:
5776857791
$ref: "#/components/schemas/ObservabilityPipelineSyslogNgSourceType"
5776957792
required:

packages/datadog-api-client-v2/index.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4855,6 +4855,7 @@ export { ObservabilityPipelineMetricTagsProcessorRuleAction } from "./models/Obs
48554855
export { ObservabilityPipelineMetricTagsProcessorRuleMode } from "./models/ObservabilityPipelineMetricTagsProcessorRuleMode";
48564856
export { ObservabilityPipelineMetricTagsProcessorType } from "./models/ObservabilityPipelineMetricTagsProcessorType";
48574857
export { ObservabilityPipelineMetricValue } from "./models/ObservabilityPipelineMetricValue";
4858+
export { ObservabilityPipelineMtlsServerTls } from "./models/ObservabilityPipelineMtlsServerTls";
48584859
export { ObservabilityPipelineNewRelicDestination } from "./models/ObservabilityPipelineNewRelicDestination";
48594860
export { ObservabilityPipelineNewRelicDestinationRegion } from "./models/ObservabilityPipelineNewRelicDestinationRegion";
48604861
export { ObservabilityPipelineNewRelicDestinationType } from "./models/ObservabilityPipelineNewRelicDestinationType";

packages/datadog-api-client-v2/models/ObjectSerializer.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2596,6 +2596,7 @@ import { ObservabilityPipelineMemoryBufferSizeOptions } from "./ObservabilityPip
25962596
import { ObservabilityPipelineMetadataEntry } from "./ObservabilityPipelineMetadataEntry";
25972597
import { ObservabilityPipelineMetricTagsProcessor } from "./ObservabilityPipelineMetricTagsProcessor";
25982598
import { ObservabilityPipelineMetricTagsProcessorRule } from "./ObservabilityPipelineMetricTagsProcessorRule";
2599+
import { ObservabilityPipelineMtlsServerTls } from "./ObservabilityPipelineMtlsServerTls";
25992600
import { ObservabilityPipelineNewRelicDestination } from "./ObservabilityPipelineNewRelicDestination";
26002601
import { ObservabilityPipelineOcsfMapperProcessor } from "./ObservabilityPipelineOcsfMapperProcessor";
26012602
import { ObservabilityPipelineOcsfMapperProcessorMapping } from "./ObservabilityPipelineOcsfMapperProcessorMapping";
@@ -9956,6 +9957,7 @@ const typeMap: { [index: string]: any } = {
99569957
ObservabilityPipelineMetricTagsProcessor,
99579958
ObservabilityPipelineMetricTagsProcessorRule:
99589959
ObservabilityPipelineMetricTagsProcessorRule,
9960+
ObservabilityPipelineMtlsServerTls: ObservabilityPipelineMtlsServerTls,
99599961
ObservabilityPipelineNewRelicDestination:
99609962
ObservabilityPipelineNewRelicDestination,
99619963
ObservabilityPipelineOcsfMapperProcessor:

packages/datadog-api-client-v2/models/ObservabilityPipelineFluentBitSource.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
* Copyright 2020-Present Datadog, Inc.
55
*/
66
import { ObservabilityPipelineFluentBitSourceType } from "./ObservabilityPipelineFluentBitSourceType";
7-
import { ObservabilityPipelineTls } from "./ObservabilityPipelineTls";
7+
import { ObservabilityPipelineMtlsServerTls } from "./ObservabilityPipelineMtlsServerTls";
88

99
import { AttributeTypeMap } from "../../datadog-api-client-common/util";
1010

@@ -23,9 +23,9 @@ export class ObservabilityPipelineFluentBitSource {
2323
*/
2424
"id": string;
2525
/**
26-
* Configuration for enabling TLS encryption between the pipeline component and external services.
26+
* Configuration for enabling TLS encryption between the pipeline component and external connecting clients.
2727
*/
28-
"tls"?: ObservabilityPipelineTls;
28+
"tls"?: ObservabilityPipelineMtlsServerTls;
2929
/**
3030
* The source type. The value should always be `fluent_bit`.
3131
*/
@@ -58,7 +58,7 @@ export class ObservabilityPipelineFluentBitSource {
5858
},
5959
tls: {
6060
baseName: "tls",
61-
type: "ObservabilityPipelineTls",
61+
type: "ObservabilityPipelineMtlsServerTls",
6262
},
6363
type: {
6464
baseName: "type",

packages/datadog-api-client-v2/models/ObservabilityPipelineFluentdSource.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
* Copyright 2020-Present Datadog, Inc.
55
*/
66
import { ObservabilityPipelineFluentdSourceType } from "./ObservabilityPipelineFluentdSourceType";
7-
import { ObservabilityPipelineTls } from "./ObservabilityPipelineTls";
7+
import { ObservabilityPipelineMtlsServerTls } from "./ObservabilityPipelineMtlsServerTls";
88

99
import { AttributeTypeMap } from "../../datadog-api-client-common/util";
1010

@@ -23,9 +23,9 @@ export class ObservabilityPipelineFluentdSource {
2323
*/
2424
"id": string;
2525
/**
26-
* Configuration for enabling TLS encryption between the pipeline component and external services.
26+
* Configuration for enabling TLS encryption between the pipeline component and external connecting clients.
2727
*/
28-
"tls"?: ObservabilityPipelineTls;
28+
"tls"?: ObservabilityPipelineMtlsServerTls;
2929
/**
3030
* The source type. The value should always be `fluentd.
3131
*/
@@ -58,7 +58,7 @@ export class ObservabilityPipelineFluentdSource {
5858
},
5959
tls: {
6060
baseName: "tls",
61-
type: "ObservabilityPipelineTls",
61+
type: "ObservabilityPipelineMtlsServerTls",
6262
},
6363
type: {
6464
baseName: "type",

packages/datadog-api-client-v2/models/ObservabilityPipelineHttpServerSource.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import { ObservabilityPipelineDecoding } from "./ObservabilityPipelineDecoding";
77
import { ObservabilityPipelineHttpServerSourceAuthStrategy } from "./ObservabilityPipelineHttpServerSourceAuthStrategy";
88
import { ObservabilityPipelineHttpServerSourceType } from "./ObservabilityPipelineHttpServerSourceType";
99
import { ObservabilityPipelineHttpServerSourceValidToken } from "./ObservabilityPipelineHttpServerSourceValidToken";
10-
import { ObservabilityPipelineTls } from "./ObservabilityPipelineTls";
10+
import { ObservabilityPipelineMtlsServerTls } from "./ObservabilityPipelineMtlsServerTls";
1111

1212
import { AttributeTypeMap } from "../../datadog-api-client-common/util";
1313

@@ -42,9 +42,9 @@ export class ObservabilityPipelineHttpServerSource {
4242
*/
4343
"passwordKey"?: string;
4444
/**
45-
* Configuration for enabling TLS encryption between the pipeline component and external services.
45+
* Configuration for enabling TLS encryption between the pipeline component and external connecting clients.
4646
*/
47-
"tls"?: ObservabilityPipelineTls;
47+
"tls"?: ObservabilityPipelineMtlsServerTls;
4848
/**
4949
* The source type. The value should always be `http_server`.
5050
*/
@@ -105,7 +105,7 @@ export class ObservabilityPipelineHttpServerSource {
105105
},
106106
tls: {
107107
baseName: "tls",
108-
type: "ObservabilityPipelineTls",
108+
type: "ObservabilityPipelineMtlsServerTls",
109109
},
110110
type: {
111111
baseName: "type",

packages/datadog-api-client-v2/models/ObservabilityPipelineLogstashSource.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
* Copyright 2020-Present Datadog, Inc.
55
*/
66
import { ObservabilityPipelineLogstashSourceType } from "./ObservabilityPipelineLogstashSourceType";
7-
import { ObservabilityPipelineTls } from "./ObservabilityPipelineTls";
7+
import { ObservabilityPipelineMtlsServerTls } from "./ObservabilityPipelineMtlsServerTls";
88

99
import { AttributeTypeMap } from "../../datadog-api-client-common/util";
1010

@@ -23,9 +23,9 @@ export class ObservabilityPipelineLogstashSource {
2323
*/
2424
"id": string;
2525
/**
26-
* Configuration for enabling TLS encryption between the pipeline component and external services.
26+
* Configuration for enabling TLS encryption between the pipeline component and external connecting clients.
2727
*/
28-
"tls"?: ObservabilityPipelineTls;
28+
"tls"?: ObservabilityPipelineMtlsServerTls;
2929
/**
3030
* The source type. The value should always be `logstash`.
3131
*/
@@ -58,7 +58,7 @@ export class ObservabilityPipelineLogstashSource {
5858
},
5959
tls: {
6060
baseName: "tls",
61-
type: "ObservabilityPipelineTls",
61+
type: "ObservabilityPipelineMtlsServerTls",
6262
},
6363
type: {
6464
baseName: "type",
Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
/**
2+
* Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
3+
* This product includes software developed at Datadog (https://www.datadoghq.com/).
4+
* Copyright 2020-Present Datadog, Inc.
5+
*/
6+
7+
import { AttributeTypeMap } from "../../datadog-api-client-common/util";
8+
9+
/**
10+
* Configuration for enabling TLS encryption between the pipeline component and external connecting clients.
11+
*/
12+
export class ObservabilityPipelineMtlsServerTls {
13+
/**
14+
* Path to the Certificate Authority (CA) file used to validate connecting clients' TLS certificates.
15+
*/
16+
"caFile"?: string;
17+
/**
18+
* Path to the TLS server certificate file used to used to identify the pipeline component to connecting clients.
19+
*/
20+
"crtFile": string;
21+
/**
22+
* Path to the private key file associated with the TLS server certificate.
23+
*/
24+
"keyFile"?: string;
25+
/**
26+
* Name of the environment variable or secret that holds the passphrase for the private key file.
27+
*/
28+
"keyPassKey"?: string;
29+
/**
30+
* When `true`, requires client connections to present a valid certificate, enabling mutual TLS authentication.
31+
*/
32+
"verifyCertificate"?: boolean;
33+
34+
/**
35+
* A container for additional, undeclared properties.
36+
* This is a holder for any undeclared properties as specified with
37+
* the 'additionalProperties' keyword in the OAS document.
38+
*/
39+
"additionalProperties"?: { [key: string]: any };
40+
41+
/**
42+
* @ignore
43+
*/
44+
"_unparsed"?: boolean;
45+
46+
/**
47+
* @ignore
48+
*/
49+
static readonly attributeTypeMap: AttributeTypeMap = {
50+
caFile: {
51+
baseName: "ca_file",
52+
type: "string",
53+
},
54+
crtFile: {
55+
baseName: "crt_file",
56+
type: "string",
57+
required: true,
58+
},
59+
keyFile: {
60+
baseName: "key_file",
61+
type: "string",
62+
},
63+
keyPassKey: {
64+
baseName: "key_pass_key",
65+
type: "string",
66+
},
67+
verifyCertificate: {
68+
baseName: "verify_certificate",
69+
type: "boolean",
70+
},
71+
additionalProperties: {
72+
baseName: "additionalProperties",
73+
type: "{ [key: string]: any; }",
74+
},
75+
};
76+
77+
/**
78+
* @ignore
79+
*/
80+
static getAttributeTypeMap(): AttributeTypeMap {
81+
return ObservabilityPipelineMtlsServerTls.attributeTypeMap;
82+
}
83+
84+
public constructor() {}
85+
}

packages/datadog-api-client-v2/models/ObservabilityPipelineOpentelemetrySource.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
* This product includes software developed at Datadog (https://www.datadoghq.com/).
44
* Copyright 2020-Present Datadog, Inc.
55
*/
6+
import { ObservabilityPipelineMtlsServerTls } from "./ObservabilityPipelineMtlsServerTls";
67
import { ObservabilityPipelineOpentelemetrySourceType } from "./ObservabilityPipelineOpentelemetrySourceType";
7-
import { ObservabilityPipelineTls } from "./ObservabilityPipelineTls";
88

99
import { AttributeTypeMap } from "../../datadog-api-client-common/util";
1010

@@ -27,9 +27,9 @@ export class ObservabilityPipelineOpentelemetrySource {
2727
*/
2828
"id": string;
2929
/**
30-
* Configuration for enabling TLS encryption between the pipeline component and external services.
30+
* Configuration for enabling TLS encryption between the pipeline component and external connecting clients.
3131
*/
32-
"tls"?: ObservabilityPipelineTls;
32+
"tls"?: ObservabilityPipelineMtlsServerTls;
3333
/**
3434
* The source type. The value should always be `opentelemetry`.
3535
*/
@@ -66,7 +66,7 @@ export class ObservabilityPipelineOpentelemetrySource {
6666
},
6767
tls: {
6868
baseName: "tls",
69-
type: "ObservabilityPipelineTls",
69+
type: "ObservabilityPipelineMtlsServerTls",
7070
},
7171
type: {
7272
baseName: "type",

0 commit comments

Comments
 (0)