Skip to content

Commit fe072a4

Browse files
committed
updated docs
Signed-off-by: Praful Khanduri <holiodin@gmail.com>
1 parent f5e2e2b commit fe072a4

9 files changed

Lines changed: 164 additions & 0 deletions

.chloggen/mtls.yaml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
2+
change_type: enhancement
3+
4+
# The name of the component, or a single word describing the area of concern, (e.g. collector, target allocator, auto-instrumentation, opamp, github action)
5+
component: target allocator
6+
7+
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
8+
note: "Added a configurable mTLS option to the Target Allocator, allowing users to enable or disable mutual TLS via CRD instead of relying on a feature flag."
9+
10+
# One or more tracking issues related to the change
11+
issues: [4915]
12+
13+
# (Optional) One or more lines of additional information to render under the primary note.
14+
# These lines will be padded with 2 spaces and then inserted directly into the document.
15+
# Use pipe (|) for multiline entries.
16+
subtext:
17+

bundle/community/manifests/opentelemetry.io_opentelemetrycollectors.yaml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3255,6 +3255,11 @@ spec:
32553255
type: string
32563256
image:
32573257
type: string
3258+
mtls:
3259+
properties:
3260+
enabled:
3261+
type: boolean
3262+
type: object
32583263
nodeSelector:
32593264
additionalProperties:
32603265
type: string
@@ -8186,6 +8191,11 @@ spec:
81868191
type: string
81878192
image:
81888193
type: string
8194+
mtls:
8195+
properties:
8196+
enabled:
8197+
type: boolean
8198+
type: object
81898199
nodeSelector:
81908200
additionalProperties:
81918201
type: string

bundle/community/manifests/opentelemetry.io_targetallocators.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2299,6 +2299,11 @@ spec:
22992299
- managed
23002300
- unmanaged
23012301
type: string
2302+
mtls:
2303+
properties:
2304+
enabled:
2305+
type: boolean
2306+
type: object
23022307
networkPolicy:
23032308
properties:
23042309
enabled:

bundle/openshift/manifests/opentelemetry.io_opentelemetrycollectors.yaml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3254,6 +3254,11 @@ spec:
32543254
type: string
32553255
image:
32563256
type: string
3257+
mtls:
3258+
properties:
3259+
enabled:
3260+
type: boolean
3261+
type: object
32573262
nodeSelector:
32583263
additionalProperties:
32593264
type: string
@@ -8185,6 +8190,11 @@ spec:
81858190
type: string
81868191
image:
81878192
type: string
8193+
mtls:
8194+
properties:
8195+
enabled:
8196+
type: boolean
8197+
type: object
81888198
nodeSelector:
81898199
additionalProperties:
81908200
type: string

bundle/openshift/manifests/opentelemetry.io_targetallocators.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2299,6 +2299,11 @@ spec:
22992299
- managed
23002300
- unmanaged
23012301
type: string
2302+
mtls:
2303+
properties:
2304+
enabled:
2305+
type: boolean
2306+
type: object
23022307
networkPolicy:
23032308
properties:
23042309
enabled:

config/crd/bases/opentelemetry.io_opentelemetrycollectors.yaml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3241,6 +3241,11 @@ spec:
32413241
type: string
32423242
image:
32433243
type: string
3244+
mtls:
3245+
properties:
3246+
enabled:
3247+
type: boolean
3248+
type: object
32443249
nodeSelector:
32453250
additionalProperties:
32463251
type: string
@@ -8172,6 +8177,11 @@ spec:
81728177
type: string
81738178
image:
81748179
type: string
8180+
mtls:
8181+
properties:
8182+
enabled:
8183+
type: boolean
8184+
type: object
81758185
nodeSelector:
81768186
additionalProperties:
81778187
type: string

config/crd/bases/opentelemetry.io_targetallocators.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2297,6 +2297,11 @@ spec:
22972297
- managed
22982298
- unmanaged
22992299
type: string
2300+
mtls:
2301+
properties:
2302+
enabled:
2303+
type: boolean
2304+
type: object
23002305
networkPolicy:
23012306
properties:
23022307
enabled:

docs/api/opentelemetrycollectors.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11386,6 +11386,13 @@ The default is relabel-config.<br/>
1138611386
Image indicates the container image to use for the OpenTelemetry TargetAllocator.<br/>
1138711387
</td>
1138811388
<td>false</td>
11389+
</tr><tr>
11390+
<td><b><a href="#opentelemetrycollectorspectargetallocatormtls">mtls</a></b></td>
11391+
<td>object</td>
11392+
<td>
11393+
Mtls defines the mTLS configuration for the target allocator. If enabled, the target allocator will communicate with the collector over mTLS.<br/>
11394+
</td>
11395+
<td>false</td>
1138911396
</tr><tr>
1139011397
<td><b>nodeSelector</b></td>
1139111398
<td>map[string]string</td>
@@ -13440,6 +13447,33 @@ More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/nam
1344013447
</table>
1344113448

1344213449

13450+
### OpenTelemetryCollector.spec.targetAllocator.mtls
13451+
<sup><sup>[↩ Parent](#opentelemetrycollectorspectargetallocator)</sup></sup>
13452+
13453+
13454+
13455+
Mtls defines the mTLS configuration for the target allocator. If enabled, the target allocator will communicate with the collector over mTLS.
13456+
13457+
<table>
13458+
<thead>
13459+
<tr>
13460+
<th>Name</th>
13461+
<th>Type</th>
13462+
<th>Description</th>
13463+
<th>Required</th>
13464+
</tr>
13465+
</thead>
13466+
<tbody><tr>
13467+
<td><b>enabled</b></td>
13468+
<td>boolean</td>
13469+
<td>
13470+
Enabled indicates whether to enable mTLS between the target allocator and the collector.<br/>
13471+
</td>
13472+
<td>false</td>
13473+
</tr></tbody>
13474+
</table>
13475+
13476+
1344313477
### OpenTelemetryCollector.spec.targetAllocator.observability
1344413478
<sup><sup>[↩ Parent](#opentelemetrycollectorspectargetallocator)</sup></sup>
1344513479

@@ -32251,6 +32285,13 @@ The default is relabel-config.<br/>
3225132285
Image indicates the container image to use for the OpenTelemetry TargetAllocator.<br/>
3225232286
</td>
3225332287
<td>false</td>
32288+
</tr><tr>
32289+
<td><b><a href="#opentelemetrycollectorspectargetallocatormtls-1">mtls</a></b></td>
32290+
<td>object</td>
32291+
<td>
32292+
Mtls defines the mTLS configuration for the target allocator. If enabled, the target allocator will communicate with the collector over mTLS.<br/>
32293+
</td>
32294+
<td>false</td>
3225432295
</tr><tr>
3225532296
<td><b>nodeSelector</b></td>
3225632297
<td>map[string]string</td>
@@ -34306,6 +34347,33 @@ More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/nam
3430634347
</table>
3430734348

3430834349

34350+
### OpenTelemetryCollector.spec.targetAllocator.mtls
34351+
<sup><sup>[↩ Parent](#opentelemetrycollectorspectargetallocator-1)</sup></sup>
34352+
34353+
34354+
34355+
Mtls defines the mTLS configuration for the target allocator. If enabled, the target allocator will communicate with the collector over mTLS.
34356+
34357+
<table>
34358+
<thead>
34359+
<tr>
34360+
<th>Name</th>
34361+
<th>Type</th>
34362+
<th>Description</th>
34363+
<th>Required</th>
34364+
</tr>
34365+
</thead>
34366+
<tbody><tr>
34367+
<td><b>enabled</b></td>
34368+
<td>boolean</td>
34369+
<td>
34370+
Enabled indicates whether to enable mTLS between the target allocator and the collector.<br/>
34371+
</td>
34372+
<td>false</td>
34373+
</tr></tbody>
34374+
</table>
34375+
34376+
3430934377
### OpenTelemetryCollector.spec.targetAllocator.observability
3431034378
<sup><sup>[↩ Parent](#opentelemetrycollectorspectargetallocator-1)</sup></sup>
3431134379

docs/api/targetallocators.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -274,6 +274,13 @@ Default is managed.<br/>
274274
<i>Default</i>: managed<br/>
275275
</td>
276276
<td>false</td>
277+
</tr><tr>
278+
<td><b><a href="#targetallocatorspecmtls">mtls</a></b></td>
279+
<td>object</td>
280+
<td>
281+
Mtls defines the mTLS configuration for the target allocator. If enabled, the target allocator will communicate with the collector over mTLS.<br/>
282+
</td>
283+
<td>false</td>
277284
</tr><tr>
278285
<td><b><a href="#targetallocatorspecnetworkpolicy">networkPolicy</a></b></td>
279286
<td>object</td>
@@ -9586,6 +9593,33 @@ Name must be an IANA_SVC_NAME.<br/>
95869593
</table>
95879594

95889595

9596+
### TargetAllocator.spec.mtls
9597+
<sup><sup>[↩ Parent](#targetallocatorspec)</sup></sup>
9598+
9599+
9600+
9601+
Mtls defines the mTLS configuration for the target allocator. If enabled, the target allocator will communicate with the collector over mTLS.
9602+
9603+
<table>
9604+
<thead>
9605+
<tr>
9606+
<th>Name</th>
9607+
<th>Type</th>
9608+
<th>Description</th>
9609+
<th>Required</th>
9610+
</tr>
9611+
</thead>
9612+
<tbody><tr>
9613+
<td><b>enabled</b></td>
9614+
<td>boolean</td>
9615+
<td>
9616+
Enabled indicates whether to enable mTLS between the target allocator and the collector.<br/>
9617+
</td>
9618+
<td>false</td>
9619+
</tr></tbody>
9620+
</table>
9621+
9622+
95899623
### TargetAllocator.spec.networkPolicy
95909624
<sup><sup>[↩ Parent](#targetallocatorspec)</sup></sup>
95919625

0 commit comments

Comments
 (0)