1/*
2Copyright The Kubernetes Authors.
3
4Licensed under the Apache License, Version 2.0 (the "License");
5you may not use this file except in compliance with the License.
6You may obtain a copy of the License at
7
8    http://www.apache.org/licenses/LICENSE-2.0
9
10Unless required by applicable law or agreed to in writing, software
11distributed under the License is distributed on an "AS IS" BASIS,
12WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13See the License for the specific language governing permissions and
14limitations under the License.
15*/
16
17
18// This file was autogenerated by go-to-protobuf. Do not edit it manually!
19
20syntax = "proto2";
21
22package k8s.io.apiextensions_apiserver.pkg.apis.apiextensions.v1;
23
24import "k8s.io/apimachinery/pkg/apis/meta/v1/generated.proto";
25import "k8s.io/apimachinery/pkg/runtime/generated.proto";
26import "k8s.io/apimachinery/pkg/runtime/schema/generated.proto";
27
28// Package-wide variables from generator "generated".
29option go_package = "v1";
30
31// ConversionRequest describes the conversion request parameters.
32message ConversionRequest {
33  // uid is an identifier for the individual request/response. It allows distinguishing instances of requests which are
34  // otherwise identical (parallel requests, etc).
35  // The UID is meant to track the round trip (request/response) between the Kubernetes API server and the webhook, not the user request.
36  // It is suitable for correlating log entries between the webhook and apiserver, for either auditing or debugging.
37  optional string uid = 1;
38
39  // desiredAPIVersion is the version to convert given objects to. e.g. "myapi.example.com/v1"
40  optional string desiredAPIVersion = 2;
41
42  // objects is the list of custom resource objects to be converted.
43  repeated k8s.io.apimachinery.pkg.runtime.RawExtension objects = 3;
44}
45
46// ConversionResponse describes a conversion response.
47message ConversionResponse {
48  // uid is an identifier for the individual request/response.
49  // This should be copied over from the corresponding `request.uid`.
50  optional string uid = 1;
51
52  // convertedObjects is the list of converted version of `request.objects` if the `result` is successful, otherwise empty.
53  // The webhook is expected to set `apiVersion` of these objects to the `request.desiredAPIVersion`. The list
54  // must also have the same size as the input list with the same objects in the same order (equal kind, metadata.uid, metadata.name and metadata.namespace).
55  // The webhook is allowed to mutate labels and annotations. Any other change to the metadata is silently ignored.
56  repeated k8s.io.apimachinery.pkg.runtime.RawExtension convertedObjects = 2;
57
58  // result contains the result of conversion with extra details if the conversion failed. `result.status` determines if
59  // the conversion failed or succeeded. The `result.status` field is required and represents the success or failure of the
60  // conversion. A successful conversion must set `result.status` to `Success`. A failed conversion must set
61  // `result.status` to `Failure` and provide more details in `result.message` and return http status 200. The `result.message`
62  // will be used to construct an error message for the end user.
63  optional k8s.io.apimachinery.pkg.apis.meta.v1.Status result = 3;
64}
65
66// ConversionReview describes a conversion request/response.
67message ConversionReview {
68  // request describes the attributes for the conversion request.
69  // +optional
70  optional ConversionRequest request = 1;
71
72  // response describes the attributes for the conversion response.
73  // +optional
74  optional ConversionResponse response = 2;
75}
76
77// CustomResourceColumnDefinition specifies a column for server side printing.
78message CustomResourceColumnDefinition {
79  // name is a human readable name for the column.
80  optional string name = 1;
81
82  // type is an OpenAPI type definition for this column.
83  // See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for details.
84  optional string type = 2;
85
86  // format is an optional OpenAPI type definition for this column. The 'name' format is applied
87  // to the primary identifier column to assist in clients identifying column is the resource name.
88  // See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for details.
89  // +optional
90  optional string format = 3;
91
92  // description is a human readable description of this column.
93  // +optional
94  optional string description = 4;
95
96  // priority is an integer defining the relative importance of this column compared to others. Lower
97  // numbers are considered higher priority. Columns that may be omitted in limited space scenarios
98  // should be given a priority greater than 0.
99  // +optional
100  optional int32 priority = 5;
101
102  // jsonPath is a simple JSON path (i.e. with array notation) which is evaluated against
103  // each custom resource to produce the value for this column.
104  optional string jsonPath = 6;
105}
106
107// CustomResourceConversion describes how to convert different versions of a CR.
108message CustomResourceConversion {
109  // strategy specifies how custom resources are converted between versions. Allowed values are:
110  // - `None`: The converter only change the apiVersion and would not touch any other field in the custom resource.
111  // - `Webhook`: API Server will call to an external webhook to do the conversion. Additional information
112  //   is needed for this option. This requires spec.preserveUnknownFields to be false, and spec.conversion.webhook to be set.
113  optional string strategy = 1;
114
115  // webhook describes how to call the conversion webhook. Required when `strategy` is set to `Webhook`.
116  // +optional
117  optional WebhookConversion webhook = 2;
118}
119
120// CustomResourceDefinition represents a resource that should be exposed on the API server.  Its name MUST be in the format
121// <.spec.name>.<.spec.group>.
122message CustomResourceDefinition {
123  // Standard object's metadata
124  // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
125  // +optional
126  optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
127
128  // spec describes how the user wants the resources to appear
129  optional CustomResourceDefinitionSpec spec = 2;
130
131  // status indicates the actual state of the CustomResourceDefinition
132  // +optional
133  optional CustomResourceDefinitionStatus status = 3;
134}
135
136// CustomResourceDefinitionCondition contains details for the current condition of this pod.
137message CustomResourceDefinitionCondition {
138  // type is the type of the condition. Types include Established, NamesAccepted and Terminating.
139  optional string type = 1;
140
141  // status is the status of the condition.
142  // Can be True, False, Unknown.
143  optional string status = 2;
144
145  // lastTransitionTime last time the condition transitioned from one status to another.
146  // +optional
147  optional k8s.io.apimachinery.pkg.apis.meta.v1.Time lastTransitionTime = 3;
148
149  // reason is a unique, one-word, CamelCase reason for the condition's last transition.
150  // +optional
151  optional string reason = 4;
152
153  // message is a human-readable message indicating details about last transition.
154  // +optional
155  optional string message = 5;
156}
157
158// CustomResourceDefinitionList is a list of CustomResourceDefinition objects.
159message CustomResourceDefinitionList {
160  // Standard object's metadata
161  // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
162  // +optional
163  optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
164
165  // items list individual CustomResourceDefinition objects
166  repeated CustomResourceDefinition items = 2;
167}
168
169// CustomResourceDefinitionNames indicates the names to serve this CustomResourceDefinition
170message CustomResourceDefinitionNames {
171  // plural is the plural name of the resource to serve.
172  // The custom resources are served under `/apis/<group>/<version>/.../<plural>`.
173  // Must match the name of the CustomResourceDefinition (in the form `<names.plural>.<group>`).
174  // Must be all lowercase.
175  optional string plural = 1;
176
177  // singular is the singular name of the resource. It must be all lowercase. Defaults to lowercased `kind`.
178  // +optional
179  optional string singular = 2;
180
181  // shortNames are short names for the resource, exposed in API discovery documents,
182  // and used by clients to support invocations like `kubectl get <shortname>`.
183  // It must be all lowercase.
184  // +optional
185  repeated string shortNames = 3;
186
187  // kind is the serialized kind of the resource. It is normally CamelCase and singular.
188  // Custom resource instances will use this value as the `kind` attribute in API calls.
189  optional string kind = 4;
190
191  // listKind is the serialized kind of the list for this resource. Defaults to "`kind`List".
192  // +optional
193  optional string listKind = 5;
194
195  // categories is a list of grouped resources this custom resource belongs to (e.g. 'all').
196  // This is published in API discovery documents, and used by clients to support invocations like
197  // `kubectl get all`.
198  // +optional
199  repeated string categories = 6;
200}
201
202// CustomResourceDefinitionSpec describes how a user wants their resource to appear
203message CustomResourceDefinitionSpec {
204  // group is the API group of the defined custom resource.
205  // The custom resources are served under `/apis/<group>/...`.
206  // Must match the name of the CustomResourceDefinition (in the form `<names.plural>.<group>`).
207  optional string group = 1;
208
209  // names specify the resource and kind names for the custom resource.
210  optional CustomResourceDefinitionNames names = 3;
211
212  // scope indicates whether the defined custom resource is cluster- or namespace-scoped.
213  // Allowed values are `Cluster` and `Namespaced`.
214  optional string scope = 4;
215
216  // versions is the list of all API versions of the defined custom resource.
217  // Version names are used to compute the order in which served versions are listed in API discovery.
218  // If the version string is "kube-like", it will sort above non "kube-like" version strings, which are ordered
219  // lexicographically. "Kube-like" versions start with a "v", then are followed by a number (the major version),
220  // then optionally the string "alpha" or "beta" and another number (the minor version). These are sorted first
221  // by GA > beta > alpha (where GA is a version with no suffix such as beta or alpha), and then by comparing
222  // major version, then minor version. An example sorted list of versions:
223  // v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10.
224  repeated CustomResourceDefinitionVersion versions = 7;
225
226  // conversion defines conversion settings for the CRD.
227  // +optional
228  optional CustomResourceConversion conversion = 9;
229
230  // preserveUnknownFields indicates that object fields which are not specified
231  // in the OpenAPI schema should be preserved when persisting to storage.
232  // apiVersion, kind, metadata and known fields inside metadata are always preserved.
233  // This field is deprecated in favor of setting `x-preserve-unknown-fields` to true in `spec.versions[*].schema.openAPIV3Schema`.
234  // See https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/#pruning-versus-preserving-unknown-fields for details.
235  // +optional
236  optional bool preserveUnknownFields = 10;
237}
238
239// CustomResourceDefinitionStatus indicates the state of the CustomResourceDefinition
240message CustomResourceDefinitionStatus {
241  // conditions indicate state for particular aspects of a CustomResourceDefinition
242  // +optional
243  // +listType=map
244  // +listMapKey=type
245  repeated CustomResourceDefinitionCondition conditions = 1;
246
247  // acceptedNames are the names that are actually being used to serve discovery.
248  // They may be different than the names in spec.
249  // +optional
250  optional CustomResourceDefinitionNames acceptedNames = 2;
251
252  // storedVersions lists all versions of CustomResources that were ever persisted. Tracking these
253  // versions allows a migration path for stored versions in etcd. The field is mutable
254  // so a migration controller can finish a migration to another version (ensuring
255  // no old objects are left in storage), and then remove the rest of the
256  // versions from this list.
257  // Versions may not be removed from `spec.versions` while they exist in this list.
258  // +optional
259  repeated string storedVersions = 3;
260}
261
262// CustomResourceDefinitionVersion describes a version for CRD.
263message CustomResourceDefinitionVersion {
264  // name is the version name, e.g. “v1”, “v2beta1”, etc.
265  // The custom resources are served under this version at `/apis/<group>/<version>/...` if `served` is true.
266  optional string name = 1;
267
268  // served is a flag enabling/disabling this version from being served via REST APIs
269  optional bool served = 2;
270
271  // storage indicates this version should be used when persisting custom resources to storage.
272  // There must be exactly one version with storage=true.
273  optional bool storage = 3;
274
275  // deprecated indicates this version of the custom resource API is deprecated.
276  // When set to true, API requests to this version receive a warning header in the server response.
277  // Defaults to false.
278  // +optional
279  optional bool deprecated = 7;
280
281  // deprecationWarning overrides the default warning returned to API clients.
282  // May only be set when `deprecated` is true.
283  // The default warning indicates this version is deprecated and recommends use
284  // of the newest served version of equal or greater stability, if one exists.
285  // +optional
286  optional string deprecationWarning = 8;
287
288  // schema describes the schema used for validation, pruning, and defaulting of this version of the custom resource.
289  // +optional
290  optional CustomResourceValidation schema = 4;
291
292  // subresources specify what subresources this version of the defined custom resource have.
293  // +optional
294  optional CustomResourceSubresources subresources = 5;
295
296  // additionalPrinterColumns specifies additional columns returned in Table output.
297  // See https://kubernetes.io/docs/reference/using-api/api-concepts/#receiving-resources-as-tables for details.
298  // If no columns are specified, a single column displaying the age of the custom resource is used.
299  // +optional
300  repeated CustomResourceColumnDefinition additionalPrinterColumns = 6;
301}
302
303// CustomResourceSubresourceScale defines how to serve the scale subresource for CustomResources.
304message CustomResourceSubresourceScale {
305  // specReplicasPath defines the JSON path inside of a custom resource that corresponds to Scale `spec.replicas`.
306  // Only JSON paths without the array notation are allowed.
307  // Must be a JSON Path under `.spec`.
308  // If there is no value under the given path in the custom resource, the `/scale` subresource will return an error on GET.
309  optional string specReplicasPath = 1;
310
311  // statusReplicasPath defines the JSON path inside of a custom resource that corresponds to Scale `status.replicas`.
312  // Only JSON paths without the array notation are allowed.
313  // Must be a JSON Path under `.status`.
314  // If there is no value under the given path in the custom resource, the `status.replicas` value in the `/scale` subresource
315  // will default to 0.
316  optional string statusReplicasPath = 2;
317
318  // labelSelectorPath defines the JSON path inside of a custom resource that corresponds to Scale `status.selector`.
319  // Only JSON paths without the array notation are allowed.
320  // Must be a JSON Path under `.status` or `.spec`.
321  // Must be set to work with HorizontalPodAutoscaler.
322  // The field pointed by this JSON path must be a string field (not a complex selector struct)
323  // which contains a serialized label selector in string form.
324  // More info: https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions#scale-subresource
325  // If there is no value under the given path in the custom resource, the `status.selector` value in the `/scale`
326  // subresource will default to the empty string.
327  // +optional
328  optional string labelSelectorPath = 3;
329}
330
331// CustomResourceSubresourceStatus defines how to serve the status subresource for CustomResources.
332// Status is represented by the `.status` JSON path inside of a CustomResource. When set,
333// * exposes a /status subresource for the custom resource
334// * PUT requests to the /status subresource take a custom resource object, and ignore changes to anything except the status stanza
335// * PUT/POST/PATCH requests to the custom resource ignore changes to the status stanza
336message CustomResourceSubresourceStatus {
337}
338
339// CustomResourceSubresources defines the status and scale subresources for CustomResources.
340message CustomResourceSubresources {
341  // status indicates the custom resource should serve a `/status` subresource.
342  // When enabled:
343  // 1. requests to the custom resource primary endpoint ignore changes to the `status` stanza of the object.
344  // 2. requests to the custom resource `/status` subresource ignore changes to anything other than the `status` stanza of the object.
345  // +optional
346  optional CustomResourceSubresourceStatus status = 1;
347
348  // scale indicates the custom resource should serve a `/scale` subresource that returns an `autoscaling/v1` Scale object.
349  // +optional
350  optional CustomResourceSubresourceScale scale = 2;
351}
352
353// CustomResourceValidation is a list of validation methods for CustomResources.
354message CustomResourceValidation {
355  // openAPIV3Schema is the OpenAPI v3 schema to use for validation and pruning.
356  // +optional
357  optional JSONSchemaProps openAPIV3Schema = 1;
358}
359
360// ExternalDocumentation allows referencing an external resource for extended documentation.
361message ExternalDocumentation {
362  optional string description = 1;
363
364  optional string url = 2;
365}
366
367// JSON represents any valid JSON value.
368// These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
369message JSON {
370  optional bytes raw = 1;
371}
372
373// JSONSchemaProps is a JSON-Schema following Specification Draft 4 (http://json-schema.org/).
374message JSONSchemaProps {
375  optional string id = 1;
376
377  optional string schema = 2;
378
379  optional string ref = 3;
380
381  optional string description = 4;
382
383  optional string type = 5;
384
385  // format is an OpenAPI v3 format string. Unknown formats are ignored. The following formats are validated:
386  //
387  // - bsonobjectid: a bson object ID, i.e. a 24 characters hex string
388  // - uri: an URI as parsed by Golang net/url.ParseRequestURI
389  // - email: an email address as parsed by Golang net/mail.ParseAddress
390  // - hostname: a valid representation for an Internet host name, as defined by RFC 1034, section 3.1 [RFC1034].
391  // - ipv4: an IPv4 IP as parsed by Golang net.ParseIP
392  // - ipv6: an IPv6 IP as parsed by Golang net.ParseIP
393  // - cidr: a CIDR as parsed by Golang net.ParseCIDR
394  // - mac: a MAC address as parsed by Golang net.ParseMAC
395  // - uuid: an UUID that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$
396  // - uuid3: an UUID3 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$
397  // - uuid4: an UUID4 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
398  // - uuid5: an UUID5 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
399  // - isbn: an ISBN10 or ISBN13 number string like "0321751043" or "978-0321751041"
400  // - isbn10: an ISBN10 number string like "0321751043"
401  // - isbn13: an ISBN13 number string like "978-0321751041"
402  // - creditcard: a credit card number defined by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\\d{3})\\d{11})$ with any non digit characters mixed in
403  // - ssn: a U.S. social security number following the regex ^\\d{3}[- ]?\\d{2}[- ]?\\d{4}$
404  // - hexcolor: an hexadecimal color code like "#FFFFFF: following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
405  // - rgbcolor: an RGB color code like rgb like "rgb(255,255,2559"
406  // - byte: base64 encoded binary data
407  // - password: any kind of string
408  // - date: a date string like "2006-01-02" as defined by full-date in RFC3339
409  // - duration: a duration string like "22 ns" as parsed by Golang time.ParseDuration or compatible with Scala duration format
410  // - datetime: a date time string like "2014-12-15T19:30:20.000Z" as defined by date-time in RFC3339.
411  optional string format = 6;
412
413  optional string title = 7;
414
415  // default is a default value for undefined object fields.
416  // Defaulting is a beta feature under the CustomResourceDefaulting feature gate.
417  // Defaulting requires spec.preserveUnknownFields to be false.
418  optional JSON default = 8;
419
420  optional double maximum = 9;
421
422  optional bool exclusiveMaximum = 10;
423
424  optional double minimum = 11;
425
426  optional bool exclusiveMinimum = 12;
427
428  optional int64 maxLength = 13;
429
430  optional int64 minLength = 14;
431
432  optional string pattern = 15;
433
434  optional int64 maxItems = 16;
435
436  optional int64 minItems = 17;
437
438  optional bool uniqueItems = 18;
439
440  optional double multipleOf = 19;
441
442  repeated JSON enum = 20;
443
444  optional int64 maxProperties = 21;
445
446  optional int64 minProperties = 22;
447
448  repeated string required = 23;
449
450  optional JSONSchemaPropsOrArray items = 24;
451
452  repeated JSONSchemaProps allOf = 25;
453
454  repeated JSONSchemaProps oneOf = 26;
455
456  repeated JSONSchemaProps anyOf = 27;
457
458  optional JSONSchemaProps not = 28;
459
460  map<string, JSONSchemaProps> properties = 29;
461
462  optional JSONSchemaPropsOrBool additionalProperties = 30;
463
464  map<string, JSONSchemaProps> patternProperties = 31;
465
466  map<string, JSONSchemaPropsOrStringArray> dependencies = 32;
467
468  optional JSONSchemaPropsOrBool additionalItems = 33;
469
470  map<string, JSONSchemaProps> definitions = 34;
471
472  optional ExternalDocumentation externalDocs = 35;
473
474  optional JSON example = 36;
475
476  optional bool nullable = 37;
477
478  // x-kubernetes-preserve-unknown-fields stops the API server
479  // decoding step from pruning fields which are not specified
480  // in the validation schema. This affects fields recursively,
481  // but switches back to normal pruning behaviour if nested
482  // properties or additionalProperties are specified in the schema.
483  // This can either be true or undefined. False is forbidden.
484  optional bool xKubernetesPreserveUnknownFields = 38;
485
486  // x-kubernetes-embedded-resource defines that the value is an
487  // embedded Kubernetes runtime.Object, with TypeMeta and
488  // ObjectMeta. The type must be object. It is allowed to further
489  // restrict the embedded object. kind, apiVersion and metadata
490  // are validated automatically. x-kubernetes-preserve-unknown-fields
491  // is allowed to be true, but does not have to be if the object
492  // is fully specified (up to kind, apiVersion, metadata).
493  optional bool xKubernetesEmbeddedResource = 39;
494
495  // x-kubernetes-int-or-string specifies that this value is
496  // either an integer or a string. If this is true, an empty
497  // type is allowed and type as child of anyOf is permitted
498  // if following one of the following patterns:
499  //
500  // 1) anyOf:
501  //    - type: integer
502  //    - type: string
503  // 2) allOf:
504  //    - anyOf:
505  //      - type: integer
506  //      - type: string
507  //    - ... zero or more
508  optional bool xKubernetesIntOrString = 40;
509
510  // x-kubernetes-list-map-keys annotates an array with the x-kubernetes-list-type `map` by specifying the keys used
511  // as the index of the map.
512  //
513  // This tag MUST only be used on lists that have the "x-kubernetes-list-type"
514  // extension set to "map". Also, the values specified for this attribute must
515  // be a scalar typed field of the child structure (no nesting is supported).
516  //
517  // The properties specified must either be required or have a default value,
518  // to ensure those properties are present for all list items.
519  //
520  // +optional
521  repeated string xKubernetesListMapKeys = 41;
522
523  // x-kubernetes-list-type annotates an array to further describe its topology.
524  // This extension must only be used on lists and may have 3 possible values:
525  //
526  // 1) `atomic`: the list is treated as a single entity, like a scalar.
527  //      Atomic lists will be entirely replaced when updated. This extension
528  //      may be used on any type of list (struct, scalar, ...).
529  // 2) `set`:
530  //      Sets are lists that must not have multiple items with the same value. Each
531  //      value must be a scalar, an object with x-kubernetes-map-type `atomic` or an
532  //      array with x-kubernetes-list-type `atomic`.
533  // 3) `map`:
534  //      These lists are like maps in that their elements have a non-index key
535  //      used to identify them. Order is preserved upon merge. The map tag
536  //      must only be used on a list with elements of type object.
537  // Defaults to atomic for arrays.
538  // +optional
539  optional string xKubernetesListType = 42;
540
541  // x-kubernetes-map-type annotates an object to further describe its topology.
542  // This extension must only be used when type is object and may have 2 possible values:
543  //
544  // 1) `granular`:
545  //      These maps are actual maps (key-value pairs) and each fields are independent
546  //      from each other (they can each be manipulated by separate actors). This is
547  //      the default behaviour for all maps.
548  // 2) `atomic`: the list is treated as a single entity, like a scalar.
549  //      Atomic maps will be entirely replaced when updated.
550  // +optional
551  optional string xKubernetesMapType = 43;
552}
553
554// JSONSchemaPropsOrArray represents a value that can either be a JSONSchemaProps
555// or an array of JSONSchemaProps. Mainly here for serialization purposes.
556message JSONSchemaPropsOrArray {
557  optional JSONSchemaProps schema = 1;
558
559  repeated JSONSchemaProps jSONSchemas = 2;
560}
561
562// JSONSchemaPropsOrBool represents JSONSchemaProps or a boolean value.
563// Defaults to true for the boolean property.
564message JSONSchemaPropsOrBool {
565  optional bool allows = 1;
566
567  optional JSONSchemaProps schema = 2;
568}
569
570// JSONSchemaPropsOrStringArray represents a JSONSchemaProps or a string array.
571message JSONSchemaPropsOrStringArray {
572  optional JSONSchemaProps schema = 1;
573
574  repeated string property = 2;
575}
576
577// ServiceReference holds a reference to Service.legacy.k8s.io
578message ServiceReference {
579  // namespace is the namespace of the service.
580  // Required
581  optional string namespace = 1;
582
583  // name is the name of the service.
584  // Required
585  optional string name = 2;
586
587  // path is an optional URL path at which the webhook will be contacted.
588  // +optional
589  optional string path = 3;
590
591  // port is an optional service port at which the webhook will be contacted.
592  // `port` should be a valid port number (1-65535, inclusive).
593  // Defaults to 443 for backward compatibility.
594  // +optional
595  optional int32 port = 4;
596}
597
598// WebhookClientConfig contains the information to make a TLS connection with the webhook.
599message WebhookClientConfig {
600  // url gives the location of the webhook, in standard URL form
601  // (`scheme://host:port/path`). Exactly one of `url` or `service`
602  // must be specified.
603  //
604  // The `host` should not refer to a service running in the cluster; use
605  // the `service` field instead. The host might be resolved via external
606  // DNS in some apiservers (e.g., `kube-apiserver` cannot resolve
607  // in-cluster DNS as that would be a layering violation). `host` may
608  // also be an IP address.
609  //
610  // Please note that using `localhost` or `127.0.0.1` as a `host` is
611  // risky unless you take great care to run this webhook on all hosts
612  // which run an apiserver which might need to make calls to this
613  // webhook. Such installs are likely to be non-portable, i.e., not easy
614  // to turn up in a new cluster.
615  //
616  // The scheme must be "https"; the URL must begin with "https://".
617  //
618  // A path is optional, and if present may be any string permissible in
619  // a URL. You may use the path to pass an arbitrary string to the
620  // webhook, for example, a cluster identifier.
621  //
622  // Attempting to use a user or basic auth e.g. "user:password@" is not
623  // allowed. Fragments ("#...") and query parameters ("?...") are not
624  // allowed, either.
625  //
626  // +optional
627  optional string url = 3;
628
629  // service is a reference to the service for this webhook. Either
630  // service or url must be specified.
631  //
632  // If the webhook is running within the cluster, then you should use `service`.
633  //
634  // +optional
635  optional ServiceReference service = 1;
636
637  // caBundle is a PEM encoded CA bundle which will be used to validate the webhook's server certificate.
638  // If unspecified, system trust roots on the apiserver are used.
639  // +optional
640  optional bytes caBundle = 2;
641}
642
643// WebhookConversion describes how to call a conversion webhook
644message WebhookConversion {
645  // clientConfig is the instructions for how to call the webhook if strategy is `Webhook`.
646  // +optional
647  optional WebhookClientConfig clientConfig = 2;
648
649  // conversionReviewVersions is an ordered list of preferred `ConversionReview`
650  // versions the Webhook expects. The API server will use the first version in
651  // the list which it supports. If none of the versions specified in this list
652  // are supported by API server, conversion will fail for the custom resource.
653  // If a persisted Webhook configuration specifies allowed versions and does not
654  // include any versions known to the API Server, calls to the webhook will fail.
655  repeated string conversionReviewVersions = 3;
656}
657
658