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: meshmetrics.kuma.io
8
spec:
9
  group: kuma.io
10
  names:
11
    categories:
12
    - kuma
13
    kind: MeshMetric
14
    listKind: MeshMetricList
15
    plural: meshmetrics
16
    singular: meshmetric
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 MeshMetric resource.
49
            properties:
50
              default:
51
                description: MeshMetric configuration.
52
                properties:
53
                  applications:
54
                    description: Applications is a list of application that Dataplane
55
                      Proxy will scrape
56
                    items:
57
                      properties:
58
                        address:
59
                          description: Address on which an application listens.
60
                          type: string
61
                        name:
62
                          description: Name of the application to scrape
63
                          type: string
64
                        path:
65
                          default: /metrics/prometheus
66
                          description: Path on which an application expose HTTP endpoint
67
                            with metrics.
68
                          type: string
69
                        port:
70
                          description: Port on which an application expose HTTP endpoint
71
                            with metrics.
72
                          format: int32
73
                          type: integer
74
                      required:
75
                      - port
76
                      type: object
77
                    type: array
78
                  backends:
79
                    description: Backends list that will be used to collect metrics.
80
                    items:
81
                      properties:
82
                        openTelemetry:
83
                          description: OpenTelemetry backend configuration
84
                          properties:
85
                            endpoint:
86
                              description: Endpoint for OpenTelemetry collector
87
                              type: string
88
                          required:
89
                          - endpoint
90
                          type: object
91
                        prometheus:
92
                          description: Prometheus backend configuration.
93
                          properties:
94
                            clientId:
95
                              description: ClientId of the Prometheus backend. Needed
96
                                when using MADS for DP discovery.
97
                              type: string
98
                            path:
99
                              default: /metrics
100
                              description: Path on which a dataplane should expose
101
                                HTTP endpoint with Prometheus metrics.
102
                              type: string
103
                            port:
104
                              default: 5670
105
                              description: Port on which a dataplane should expose
106
                                HTTP endpoint with Prometheus metrics.
107
                              format: int32
108
                              type: integer
109
                            tls:
110
                              description: Configuration of TLS for prometheus listener.
111
                              properties:
112
                                mode:
113
                                  default: Disabled
114
                                  description: Configuration of TLS for Prometheus
115
                                    listener.
116
                                  enum:
117
                                  - Disabled
118
                                  - ProvidedTLS
119
                                  - ActiveMTLSBackend
120
                                  type: string
121
                              required:
122
                              - mode
123
                              type: object
124
                          required:
125
                          - path
126
                          - port
127
                          type: object
128
                        type:
129
                          description: Type of the backend that will be used to collect
130
                            metrics. At the moment only Prometheus backend is available.
131
                          enum:
132
                          - Prometheus
133
                          - OpenTelemetry
134
                          type: string
135
                      required:
136
                      - type
137
                      type: object
138
                    type: array
139
                  sidecar:
140
                    description: Sidecar metrics collection configuration
141
                    properties:
142
                      includeUnused:
143
                        default: false
144
                        description: |-
145
                          IncludeUnused if false will scrape only metrics that has been by sidecar (counters incremented
146
                          at least once, gauges changed at least once, and histograms added to at
147
                          least once). If true will scrape all metrics (even the ones with zeros).
148
                        type: boolean
149
                      regex:
150
                        description: Regex that will be used to filter sidecar metrics.
151
                          It uses Google RE2 engine https://github.com/google/re2
152
                        type: string
153
                    type: object
154
                type: object
155
              targetRef:
156
                description: |-
157
                  TargetRef is a reference to the resource the policy takes an effect on.
158
                  The resource could be either a real store object or virtual resource
159
                  defined in-place.
160
                properties:
161
                  kind:
162
                    description: Kind of the referenced resource
163
                    enum:
164
                    - Mesh
165
                    - MeshSubset
166
                    - MeshGateway
167
                    - MeshService
168
                    - MeshServiceSubset
169
                    - MeshHTTPRoute
170
                    type: string
171
                  mesh:
172
                    description: Mesh is reserved for future use to identify cross
173
                      mesh resources.
174
                    type: string
175
                  name:
176
                    description: |-
177
                      Name of the referenced resource. Can only be used with kinds: `MeshService`,
178
                      `MeshServiceSubset` and `MeshGatewayRoute`
179
                    type: string
180
                  proxyTypes:
181
                    description: |-
182
                      ProxyTypes specifies the data plane types that are subject to the policy. When not specified,
183
                      all data plane types are targeted by the policy.
184
                    items:
185
                      enum:
186
                      - Sidecar
187
                      - Gateway
188
                      type: string
189
                    minItems: 1
190
                    type: array
191
                  tags:
192
                    additionalProperties:
193
                      type: string
194
                    description: |-
195
                      Tags used to select a subset of proxies by tags. Can only be used with kinds
196
                      `MeshSubset` and `MeshServiceSubset`
197
                    type: object
198
                type: object
199
            required:
200
            - targetRef
201
            type: object
202
        type: object
203
    served: true
204
    storage: true
205
    subresources: {}
206