kuma

1
---
2
apiVersion: apiextensions.k8s.io/v1
3
kind: CustomResourceDefinition
4
metadata:
5
  annotations:
6
    controller-gen.kubebuilder.io/version: v0.14.0
7
  name: meshaccesslogs.kuma.io
8
spec:
9
  group: kuma.io
10
  names:
11
    categories:
12
    - kuma
13
    kind: MeshAccessLog
14
    listKind: MeshAccessLogList
15
    plural: meshaccesslogs
16
    singular: meshaccesslog
17
  scope: Namespaced
18
  versions:
19
  - additionalPrinterColumns:
20
    - jsonPath: .spec.targetRef.kind
21
      name: TargetRef Kind
22
      type: string
23
    - jsonPath: .spec.targetRef.name
24
      name: TargetRef Name
25
      type: string
26
    name: v1alpha1
27
    schema:
28
      openAPIV3Schema:
29
        properties:
30
          apiVersion:
31
            description: |-
32
              APIVersion defines the versioned schema of this representation of an object.
33
              Servers should convert recognized schemas to the latest internal value, and
34
              may reject unrecognized values.
35
              More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
36
            type: string
37
          kind:
38
            description: |-
39
              Kind is a string value representing the REST resource this object represents.
40
              Servers may infer this from the endpoint the client submits requests to.
41
              Cannot be updated.
42
              In CamelCase.
43
              More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
44
            type: string
45
          metadata:
46
            type: object
47
          spec:
48
            description: Spec is the specification of the Kuma MeshAccessLog resource.
49
            properties:
50
              from:
51
                description: From list makes a match between clients and corresponding
52
                  configurations
53
                items:
54
                  properties:
55
                    default:
56
                      description: |-
57
                        Default is a configuration specific to the group of clients referenced in
58
                        'targetRef'
59
                      properties:
60
                        backends:
61
                          items:
62
                            properties:
63
                              file:
64
                                description: FileBackend defines configuration for
65
                                  file based access logs
66
                                properties:
67
                                  format:
68
                                    description: |-
69
                                      Format of access logs. Placeholders available on
70
                                      https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage#command-operators
71
                                    properties:
72
                                      json:
73
                                        example:
74
                                        - key: start_time
75
                                          value: '%START_TIME%'
76
                                        - key: bytes_received
77
                                          value: '%BYTES_RECEIVED%'
78
                                        items:
79
                                          properties:
80
                                            key:
81
                                              type: string
82
                                            value:
83
                                              type: string
84
                                          type: object
85
                                        type: array
86
                                      omitEmptyValues:
87
                                        default: false
88
                                        type: boolean
89
                                      plain:
90
                                        example: '[%START_TIME%] %KUMA_MESH% %UPSTREAM_HOST%'
91
                                        type: string
92
                                      type:
93
                                        enum:
94
                                        - Plain
95
                                        - Json
96
                                        type: string
97
                                    required:
98
                                    - type
99
                                    type: object
100
                                  path:
101
                                    description: Path to a file that logs will be
102
                                      written to
103
                                    example: /tmp/access.log
104
                                    minLength: 1
105
                                    type: string
106
                                required:
107
                                - path
108
                                type: object
109
                              openTelemetry:
110
                                description: Defines an OpenTelemetry logging backend.
111
                                properties:
112
                                  attributes:
113
                                    description: |-
114
                                      Attributes can contain placeholders available on
115
                                      https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage#command-operators
116
                                    example:
117
                                    - key: mesh
118
                                      value: '%KUMA_MESH%'
119
                                    items:
120
                                      properties:
121
                                        key:
122
                                          type: string
123
                                        value:
124
                                          type: string
125
                                      type: object
126
                                    type: array
127
                                  body:
128
                                    description: |-
129
                                      Body is a raw string or an OTLP any value as described at
130
                                      https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/logs/data-model.md#field-body
131
                                      It can contain placeholders available on
132
                                      https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage#command-operators
133
                                    example:
134
                                      kvlistValue:
135
                                        values:
136
                                        - key: mesh
137
                                          value:
138
                                            stringValue: '%KUMA_MESH%'
139
                                    x-kubernetes-preserve-unknown-fields: true
140
                                  endpoint:
141
                                    description: Endpoint of OpenTelemetry collector.
142
                                      An empty port defaults to 4317.
143
                                    example: otel-collector:4317
144
                                    minLength: 1
145
                                    type: string
146
                                required:
147
                                - endpoint
148
                                type: object
149
                              tcp:
150
                                description: TCPBackend defines a TCP logging backend.
151
                                properties:
152
                                  address:
153
                                    description: Address of the TCP logging backend
154
                                    example: 127.0.0.1:5000
155
                                    minLength: 1
156
                                    type: string
157
                                  format:
158
                                    description: |-
159
                                      Format of access logs. Placeholders available on
160
                                      https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage#command-operators
161
                                    properties:
162
                                      json:
163
                                        example:
164
                                        - key: start_time
165
                                          value: '%START_TIME%'
166
                                        - key: bytes_received
167
                                          value: '%BYTES_RECEIVED%'
168
                                        items:
169
                                          properties:
170
                                            key:
171
                                              type: string
172
                                            value:
173
                                              type: string
174
                                          type: object
175
                                        type: array
176
                                      omitEmptyValues:
177
                                        default: false
178
                                        type: boolean
179
                                      plain:
180
                                        example: '[%START_TIME%] %KUMA_MESH% %UPSTREAM_HOST%'
181
                                        type: string
182
                                      type:
183
                                        enum:
184
                                        - Plain
185
                                        - Json
186
                                        type: string
187
                                    required:
188
                                    - type
189
                                    type: object
190
                                required:
191
                                - address
192
                                type: object
193
                              type:
194
                                enum:
195
                                - Tcp
196
                                - File
197
                                - OpenTelemetry
198
                                type: string
199
                            required:
200
                            - type
201
                            type: object
202
                          type: array
203
                      type: object
204
                    targetRef:
205
                      description: |-
206
                        TargetRef is a reference to the resource that represents a group of
207
                        clients.
208
                      properties:
209
                        kind:
210
                          description: Kind of the referenced resource
211
                          enum:
212
                          - Mesh
213
                          - MeshSubset
214
                          - MeshGateway
215
                          - MeshService
216
                          - MeshServiceSubset
217
                          - MeshHTTPRoute
218
                          type: string
219
                        mesh:
220
                          description: Mesh is reserved for future use to identify
221
                            cross mesh resources.
222
                          type: string
223
                        name:
224
                          description: |-
225
                            Name of the referenced resource. Can only be used with kinds: `MeshService`,
226
                            `MeshServiceSubset` and `MeshGatewayRoute`
227
                          type: string
228
                        proxyTypes:
229
                          description: |-
230
                            ProxyTypes specifies the data plane types that are subject to the policy. When not specified,
231
                            all data plane types are targeted by the policy.
232
                          items:
233
                            enum:
234
                            - Sidecar
235
                            - Gateway
236
                            type: string
237
                          minItems: 1
238
                          type: array
239
                        tags:
240
                          additionalProperties:
241
                            type: string
242
                          description: |-
243
                            Tags used to select a subset of proxies by tags. Can only be used with kinds
244
                            `MeshSubset` and `MeshServiceSubset`
245
                          type: object
246
                      type: object
247
                  required:
248
                  - targetRef
249
                  type: object
250
                type: array
251
              targetRef:
252
                description: |-
253
                  TargetRef is a reference to the resource the policy takes an effect on.
254
                  The resource could be either a real store object or virtual resource
255
                  defined in-place.
256
                properties:
257
                  kind:
258
                    description: Kind of the referenced resource
259
                    enum:
260
                    - Mesh
261
                    - MeshSubset
262
                    - MeshGateway
263
                    - MeshService
264
                    - MeshServiceSubset
265
                    - MeshHTTPRoute
266
                    type: string
267
                  mesh:
268
                    description: Mesh is reserved for future use to identify cross
269
                      mesh resources.
270
                    type: string
271
                  name:
272
                    description: |-
273
                      Name of the referenced resource. Can only be used with kinds: `MeshService`,
274
                      `MeshServiceSubset` and `MeshGatewayRoute`
275
                    type: string
276
                  proxyTypes:
277
                    description: |-
278
                      ProxyTypes specifies the data plane types that are subject to the policy. When not specified,
279
                      all data plane types are targeted by the policy.
280
                    items:
281
                      enum:
282
                      - Sidecar
283
                      - Gateway
284
                      type: string
285
                    minItems: 1
286
                    type: array
287
                  tags:
288
                    additionalProperties:
289
                      type: string
290
                    description: |-
291
                      Tags used to select a subset of proxies by tags. Can only be used with kinds
292
                      `MeshSubset` and `MeshServiceSubset`
293
                    type: object
294
                type: object
295
              to:
296
                description: To list makes a match between the consumed services and
297
                  corresponding configurations
298
                items:
299
                  properties:
300
                    default:
301
                      description: |-
302
                        Default is a configuration specific to the group of destinations referenced in
303
                        'targetRef'
304
                      properties:
305
                        backends:
306
                          items:
307
                            properties:
308
                              file:
309
                                description: FileBackend defines configuration for
310
                                  file based access logs
311
                                properties:
312
                                  format:
313
                                    description: |-
314
                                      Format of access logs. Placeholders available on
315
                                      https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage#command-operators
316
                                    properties:
317
                                      json:
318
                                        example:
319
                                        - key: start_time
320
                                          value: '%START_TIME%'
321
                                        - key: bytes_received
322
                                          value: '%BYTES_RECEIVED%'
323
                                        items:
324
                                          properties:
325
                                            key:
326
                                              type: string
327
                                            value:
328
                                              type: string
329
                                          type: object
330
                                        type: array
331
                                      omitEmptyValues:
332
                                        default: false
333
                                        type: boolean
334
                                      plain:
335
                                        example: '[%START_TIME%] %KUMA_MESH% %UPSTREAM_HOST%'
336
                                        type: string
337
                                      type:
338
                                        enum:
339
                                        - Plain
340
                                        - Json
341
                                        type: string
342
                                    required:
343
                                    - type
344
                                    type: object
345
                                  path:
346
                                    description: Path to a file that logs will be
347
                                      written to
348
                                    example: /tmp/access.log
349
                                    minLength: 1
350
                                    type: string
351
                                required:
352
                                - path
353
                                type: object
354
                              openTelemetry:
355
                                description: Defines an OpenTelemetry logging backend.
356
                                properties:
357
                                  attributes:
358
                                    description: |-
359
                                      Attributes can contain placeholders available on
360
                                      https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage#command-operators
361
                                    example:
362
                                    - key: mesh
363
                                      value: '%KUMA_MESH%'
364
                                    items:
365
                                      properties:
366
                                        key:
367
                                          type: string
368
                                        value:
369
                                          type: string
370
                                      type: object
371
                                    type: array
372
                                  body:
373
                                    description: |-
374
                                      Body is a raw string or an OTLP any value as described at
375
                                      https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/logs/data-model.md#field-body
376
                                      It can contain placeholders available on
377
                                      https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage#command-operators
378
                                    example:
379
                                      kvlistValue:
380
                                        values:
381
                                        - key: mesh
382
                                          value:
383
                                            stringValue: '%KUMA_MESH%'
384
                                    x-kubernetes-preserve-unknown-fields: true
385
                                  endpoint:
386
                                    description: Endpoint of OpenTelemetry collector.
387
                                      An empty port defaults to 4317.
388
                                    example: otel-collector:4317
389
                                    minLength: 1
390
                                    type: string
391
                                required:
392
                                - endpoint
393
                                type: object
394
                              tcp:
395
                                description: TCPBackend defines a TCP logging backend.
396
                                properties:
397
                                  address:
398
                                    description: Address of the TCP logging backend
399
                                    example: 127.0.0.1:5000
400
                                    minLength: 1
401
                                    type: string
402
                                  format:
403
                                    description: |-
404
                                      Format of access logs. Placeholders available on
405
                                      https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage#command-operators
406
                                    properties:
407
                                      json:
408
                                        example:
409
                                        - key: start_time
410
                                          value: '%START_TIME%'
411
                                        - key: bytes_received
412
                                          value: '%BYTES_RECEIVED%'
413
                                        items:
414
                                          properties:
415
                                            key:
416
                                              type: string
417
                                            value:
418
                                              type: string
419
                                          type: object
420
                                        type: array
421
                                      omitEmptyValues:
422
                                        default: false
423
                                        type: boolean
424
                                      plain:
425
                                        example: '[%START_TIME%] %KUMA_MESH% %UPSTREAM_HOST%'
426
                                        type: string
427
                                      type:
428
                                        enum:
429
                                        - Plain
430
                                        - Json
431
                                        type: string
432
                                    required:
433
                                    - type
434
                                    type: object
435
                                required:
436
                                - address
437
                                type: object
438
                              type:
439
                                enum:
440
                                - Tcp
441
                                - File
442
                                - OpenTelemetry
443
                                type: string
444
                            required:
445
                            - type
446
                            type: object
447
                          type: array
448
                      type: object
449
                    targetRef:
450
                      description: |-
451
                        TargetRef is a reference to the resource that represents a group of
452
                        destinations.
453
                      properties:
454
                        kind:
455
                          description: Kind of the referenced resource
456
                          enum:
457
                          - Mesh
458
                          - MeshSubset
459
                          - MeshGateway
460
                          - MeshService
461
                          - MeshServiceSubset
462
                          - MeshHTTPRoute
463
                          type: string
464
                        mesh:
465
                          description: Mesh is reserved for future use to identify
466
                            cross mesh resources.
467
                          type: string
468
                        name:
469
                          description: |-
470
                            Name of the referenced resource. Can only be used with kinds: `MeshService`,
471
                            `MeshServiceSubset` and `MeshGatewayRoute`
472
                          type: string
473
                        proxyTypes:
474
                          description: |-
475
                            ProxyTypes specifies the data plane types that are subject to the policy. When not specified,
476
                            all data plane types are targeted by the policy.
477
                          items:
478
                            enum:
479
                            - Sidecar
480
                            - Gateway
481
                            type: string
482
                          minItems: 1
483
                          type: array
484
                        tags:
485
                          additionalProperties:
486
                            type: string
487
                          description: |-
488
                            Tags used to select a subset of proxies by tags. Can only be used with kinds
489
                            `MeshSubset` and `MeshServiceSubset`
490
                          type: object
491
                      type: object
492
                  required:
493
                  - targetRef
494
                  type: object
495
                type: array
496
            required:
497
            - targetRef
498
            type: object
499
        type: object
500
    served: true
501
    storage: true
502
    subresources: {}
503