istio
1193 строки · 53.3 Кб
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
8http://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.apimachinery.pkg.apis.meta.v1;
23
24import "k8s.io/apimachinery/pkg/runtime/generated.proto";
25import "k8s.io/apimachinery/pkg/runtime/schema/generated.proto";
26
27// Package-wide variables from generator "generated".
28option go_package = "k8s.io/apimachinery/pkg/apis/meta/v1";
29
30// APIGroup contains the name, the supported versions, and the preferred version
31// of a group.
32message APIGroup {
33// name is the name of the group.
34optional string name = 1;
35
36// versions are the versions supported in this group.
37repeated GroupVersionForDiscovery versions = 2;
38
39// preferredVersion is the version preferred by the API server, which
40// probably is the storage version.
41// +optional
42optional GroupVersionForDiscovery preferredVersion = 3;
43
44// a map of client CIDR to server address that is serving this group.
45// This is to help clients reach servers in the most network-efficient way possible.
46// Clients can use the appropriate server address as per the CIDR that they match.
47// In case of multiple matches, clients should use the longest matching CIDR.
48// The server returns only those CIDRs that it thinks that the client can match.
49// For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP.
50// Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP.
51// +optional
52repeated ServerAddressByClientCIDR serverAddressByClientCIDRs = 4;
53}
54
55// APIGroupList is a list of APIGroup, to allow clients to discover the API at
56// /apis.
57message APIGroupList {
58// groups is a list of APIGroup.
59repeated APIGroup groups = 1;
60}
61
62// APIResource specifies the name of a resource and whether it is namespaced.
63message APIResource {
64// name is the plural name of the resource.
65optional string name = 1;
66
67// singularName is the singular name of the resource. This allows clients to handle plural and singular opaquely.
68// The singularName is more correct for reporting status on a single item and both singular and plural are allowed
69// from the kubectl CLI interface.
70optional string singularName = 6;
71
72// namespaced indicates if a resource is namespaced or not.
73optional bool namespaced = 2;
74
75// group is the preferred group of the resource. Empty implies the group of the containing resource list.
76// For subresources, this may have a different value, for example: Scale".
77optional string group = 8;
78
79// version is the preferred version of the resource. Empty implies the version of the containing resource list
80// For subresources, this may have a different value, for example: v1 (while inside a v1beta1 version of the core resource's group)".
81optional string version = 9;
82
83// kind is the kind for the resource (e.g. 'Foo' is the kind for a resource 'foo')
84optional string kind = 3;
85
86// verbs is a list of supported kube verbs (this includes get, list, watch, create,
87// update, patch, delete, deletecollection, and proxy)
88optional Verbs verbs = 4;
89
90// shortNames is a list of suggested short names of the resource.
91repeated string shortNames = 5;
92
93// categories is a list of the grouped resources this resource belongs to (e.g. 'all')
94repeated string categories = 7;
95
96// The hash value of the storage version, the version this resource is
97// converted to when written to the data store. Value must be treated
98// as opaque by clients. Only equality comparison on the value is valid.
99// This is an alpha feature and may change or be removed in the future.
100// The field is populated by the apiserver only if the
101// StorageVersionHash feature gate is enabled.
102// This field will remain optional even if it graduates.
103// +optional
104optional string storageVersionHash = 10;
105}
106
107// APIResourceList is a list of APIResource, it is used to expose the name of the
108// resources supported in a specific group and version, and if the resource
109// is namespaced.
110message APIResourceList {
111// groupVersion is the group and version this APIResourceList is for.
112optional string groupVersion = 1;
113
114// resources contains the name of the resources and if they are namespaced.
115repeated APIResource resources = 2;
116}
117
118// APIVersions lists the versions that are available, to allow clients to
119// discover the API at /api, which is the root path of the legacy v1 API.
120//
121// +protobuf.options.(gogoproto.goproto_stringer)=false
122// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
123message APIVersions {
124// versions are the api versions that are available.
125repeated string versions = 1;
126
127// a map of client CIDR to server address that is serving this group.
128// This is to help clients reach servers in the most network-efficient way possible.
129// Clients can use the appropriate server address as per the CIDR that they match.
130// In case of multiple matches, clients should use the longest matching CIDR.
131// The server returns only those CIDRs that it thinks that the client can match.
132// For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP.
133// Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP.
134repeated ServerAddressByClientCIDR serverAddressByClientCIDRs = 2;
135}
136
137// ApplyOptions may be provided when applying an API object.
138// FieldManager is required for apply requests.
139// ApplyOptions is equivalent to PatchOptions. It is provided as a convenience with documentation
140// that speaks specifically to how the options fields relate to apply.
141message ApplyOptions {
142// When present, indicates that modifications should not be
143// persisted. An invalid or unrecognized dryRun directive will
144// result in an error response and no further processing of the
145// request. Valid values are:
146// - All: all dry run stages will be processed
147// +optional
148repeated string dryRun = 1;
149
150// Force is going to "force" Apply requests. It means user will
151// re-acquire conflicting fields owned by other people.
152optional bool force = 2;
153
154// fieldManager is a name associated with the actor or entity
155// that is making these changes. The value must be less than or
156// 128 characters long, and only contain printable characters,
157// as defined by https://golang.org/pkg/unicode/#IsPrint. This
158// field is required.
159optional string fieldManager = 3;
160}
161
162// Condition contains details for one aspect of the current state of this API Resource.
163// ---
164// This struct is intended for direct use as an array at the field path .status.conditions. For example,
165//
166// type FooStatus struct{
167// // Represents the observations of a foo's current state.
168// // Known .status.conditions.type are: "Available", "Progressing", and "Degraded"
169// // +patchMergeKey=type
170// // +patchStrategy=merge
171// // +listType=map
172// // +listMapKey=type
173// Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"`
174//
175// // other fields
176// }
177message Condition {
178// type of condition in CamelCase or in foo.example.com/CamelCase.
179// ---
180// Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be
181// useful (see .node.status.conditions), the ability to deconflict is important.
182// The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)
183// +required
184// +kubebuilder:validation:Required
185// +kubebuilder:validation:Pattern=`^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$`
186// +kubebuilder:validation:MaxLength=316
187optional string type = 1;
188
189// status of the condition, one of True, False, Unknown.
190// +required
191// +kubebuilder:validation:Required
192// +kubebuilder:validation:Enum=True;False;Unknown
193optional string status = 2;
194
195// observedGeneration represents the .metadata.generation that the condition was set based upon.
196// For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
197// with respect to the current state of the instance.
198// +optional
199// +kubebuilder:validation:Minimum=0
200optional int64 observedGeneration = 3;
201
202// lastTransitionTime is the last time the condition transitioned from one status to another.
203// This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
204// +required
205// +kubebuilder:validation:Required
206// +kubebuilder:validation:Type=string
207// +kubebuilder:validation:Format=date-time
208optional Time lastTransitionTime = 4;
209
210// reason contains a programmatic identifier indicating the reason for the condition's last transition.
211// Producers of specific condition types may define expected values and meanings for this field,
212// and whether the values are considered a guaranteed API.
213// The value should be a CamelCase string.
214// This field may not be empty.
215// +required
216// +kubebuilder:validation:Required
217// +kubebuilder:validation:MaxLength=1024
218// +kubebuilder:validation:MinLength=1
219// +kubebuilder:validation:Pattern=`^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$`
220optional string reason = 5;
221
222// message is a human readable message indicating details about the transition.
223// This may be an empty string.
224// +required
225// +kubebuilder:validation:Required
226// +kubebuilder:validation:MaxLength=32768
227optional string message = 6;
228}
229
230// CreateOptions may be provided when creating an API object.
231message CreateOptions {
232// When present, indicates that modifications should not be
233// persisted. An invalid or unrecognized dryRun directive will
234// result in an error response and no further processing of the
235// request. Valid values are:
236// - All: all dry run stages will be processed
237// +optional
238repeated string dryRun = 1;
239
240// fieldManager is a name associated with the actor or entity
241// that is making these changes. The value must be less than or
242// 128 characters long, and only contain printable characters,
243// as defined by https://golang.org/pkg/unicode/#IsPrint.
244// +optional
245optional string fieldManager = 3;
246
247// fieldValidation instructs the server on how to handle
248// objects in the request (POST/PUT/PATCH) containing unknown
249// or duplicate fields. Valid values are:
250// - Ignore: This will ignore any unknown fields that are silently
251// dropped from the object, and will ignore all but the last duplicate
252// field that the decoder encounters. This is the default behavior
253// prior to v1.23.
254// - Warn: This will send a warning via the standard warning response
255// header for each unknown field that is dropped from the object, and
256// for each duplicate field that is encountered. The request will
257// still succeed if there are no other errors, and will only persist
258// the last of any duplicate fields. This is the default in v1.23+
259// - Strict: This will fail the request with a BadRequest error if
260// any unknown fields would be dropped from the object, or if any
261// duplicate fields are present. The error returned from the server
262// will contain all unknown and duplicate fields encountered.
263// +optional
264optional string fieldValidation = 4;
265}
266
267// DeleteOptions may be provided when deleting an API object.
268message DeleteOptions {
269// The duration in seconds before the object should be deleted. Value must be non-negative integer.
270// The value zero indicates delete immediately. If this value is nil, the default grace period for the
271// specified type will be used.
272// Defaults to a per object value if not specified. zero means delete immediately.
273// +optional
274optional int64 gracePeriodSeconds = 1;
275
276// Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be
277// returned.
278// +k8s:conversion-gen=false
279// +optional
280optional Preconditions preconditions = 2;
281
282// Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7.
283// Should the dependent objects be orphaned. If true/false, the "orphan"
284// finalizer will be added to/removed from the object's finalizers list.
285// Either this field or PropagationPolicy may be set, but not both.
286// +optional
287optional bool orphanDependents = 3;
288
289// Whether and how garbage collection will be performed.
290// Either this field or OrphanDependents may be set, but not both.
291// The default policy is decided by the existing finalizer set in the
292// metadata.finalizers and the resource-specific default policy.
293// Acceptable values are: 'Orphan' - orphan the dependents; 'Background' -
294// allow the garbage collector to delete the dependents in the background;
295// 'Foreground' - a cascading policy that deletes all dependents in the
296// foreground.
297// +optional
298optional string propagationPolicy = 4;
299
300// When present, indicates that modifications should not be
301// persisted. An invalid or unrecognized dryRun directive will
302// result in an error response and no further processing of the
303// request. Valid values are:
304// - All: all dry run stages will be processed
305// +optional
306repeated string dryRun = 5;
307}
308
309// Duration is a wrapper around time.Duration which supports correct
310// marshaling to YAML and JSON. In particular, it marshals into strings, which
311// can be used as map keys in json.
312message Duration {
313optional int64 duration = 1;
314}
315
316// FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format.
317//
318// Each key is either a '.' representing the field itself, and will always map to an empty set,
319// or a string representing a sub-field or item. The string will follow one of these four formats:
320// 'f:<name>', where <name> is the name of a field in a struct, or key in a map
321// 'v:<value>', where <value> is the exact json formatted value of a list item
322// 'i:<index>', where <index> is position of a item in a list
323// 'k:<keys>', where <keys> is a map of a list item's key fields to their unique values
324// If a key maps to an empty Fields value, the field that key represents is part of the set.
325//
326// The exact format is defined in sigs.k8s.io/structured-merge-diff
327// +protobuf.options.(gogoproto.goproto_stringer)=false
328message FieldsV1 {
329// Raw is the underlying serialization of this object.
330optional bytes Raw = 1;
331}
332
333// GetOptions is the standard query options to the standard REST get call.
334message GetOptions {
335// resourceVersion sets a constraint on what resource versions a request may be served from.
336// See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for
337// details.
338//
339// Defaults to unset
340// +optional
341optional string resourceVersion = 1;
342}
343
344// GroupKind specifies a Group and a Kind, but does not force a version. This is useful for identifying
345// concepts during lookup stages without having partially valid types
346//
347// +protobuf.options.(gogoproto.goproto_stringer)=false
348message GroupKind {
349optional string group = 1;
350
351optional string kind = 2;
352}
353
354// GroupResource specifies a Group and a Resource, but does not force a version. This is useful for identifying
355// concepts during lookup stages without having partially valid types
356//
357// +protobuf.options.(gogoproto.goproto_stringer)=false
358message GroupResource {
359optional string group = 1;
360
361optional string resource = 2;
362}
363
364// GroupVersion contains the "group" and the "version", which uniquely identifies the API.
365//
366// +protobuf.options.(gogoproto.goproto_stringer)=false
367message GroupVersion {
368optional string group = 1;
369
370optional string version = 2;
371}
372
373// GroupVersion contains the "group/version" and "version" string of a version.
374// It is made a struct to keep extensibility.
375message GroupVersionForDiscovery {
376// groupVersion specifies the API group and version in the form "group/version"
377optional string groupVersion = 1;
378
379// version specifies the version in the form of "version". This is to save
380// the clients the trouble of splitting the GroupVersion.
381optional string version = 2;
382}
383
384// GroupVersionKind unambiguously identifies a kind. It doesn't anonymously include GroupVersion
385// to avoid automatic coercion. It doesn't use a GroupVersion to avoid custom marshalling
386//
387// +protobuf.options.(gogoproto.goproto_stringer)=false
388message GroupVersionKind {
389optional string group = 1;
390
391optional string version = 2;
392
393optional string kind = 3;
394}
395
396// GroupVersionResource unambiguously identifies a resource. It doesn't anonymously include GroupVersion
397// to avoid automatic coercion. It doesn't use a GroupVersion to avoid custom marshalling
398//
399// +protobuf.options.(gogoproto.goproto_stringer)=false
400message GroupVersionResource {
401optional string group = 1;
402
403optional string version = 2;
404
405optional string resource = 3;
406}
407
408// A label selector is a label query over a set of resources. The result of matchLabels and
409// matchExpressions are ANDed. An empty label selector matches all objects. A null
410// label selector matches no objects.
411// +structType=atomic
412message LabelSelector {
413// matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
414// map is equivalent to an element of matchExpressions, whose key field is "key", the
415// operator is "In", and the values array contains only "value". The requirements are ANDed.
416// +optional
417map<string, string> matchLabels = 1;
418
419// matchExpressions is a list of label selector requirements. The requirements are ANDed.
420// +optional
421repeated LabelSelectorRequirement matchExpressions = 2;
422}
423
424// A label selector requirement is a selector that contains values, a key, and an operator that
425// relates the key and values.
426message LabelSelectorRequirement {
427// key is the label key that the selector applies to.
428// +patchMergeKey=key
429// +patchStrategy=merge
430optional string key = 1;
431
432// operator represents a key's relationship to a set of values.
433// Valid operators are In, NotIn, Exists and DoesNotExist.
434optional string operator = 2;
435
436// values is an array of string values. If the operator is In or NotIn,
437// the values array must be non-empty. If the operator is Exists or DoesNotExist,
438// the values array must be empty. This array is replaced during a strategic
439// merge patch.
440// +optional
441repeated string values = 3;
442}
443
444// List holds a list of objects, which may not be known by the server.
445message List {
446// Standard list metadata.
447// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
448// +optional
449optional ListMeta metadata = 1;
450
451// List of objects
452repeated k8s.io.apimachinery.pkg.runtime.RawExtension items = 2;
453}
454
455// ListMeta describes metadata that synthetic resources must have, including lists and
456// various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
457message ListMeta {
458// Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
459// +optional
460optional string selfLink = 1;
461
462// String that identifies the server's internal version of this object that
463// can be used by clients to determine when objects have changed.
464// Value must be treated as opaque by clients and passed unmodified back to the server.
465// Populated by the system.
466// Read-only.
467// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
468// +optional
469optional string resourceVersion = 2;
470
471// continue may be set if the user set a limit on the number of items returned, and indicates that
472// the server has more data available. The value is opaque and may be used to issue another request
473// to the endpoint that served this list to retrieve the next set of available objects. Continuing a
474// consistent list may not be possible if the server configuration has changed or more than a few
475// minutes have passed. The resourceVersion field returned when using this continue value will be
476// identical to the value in the first response, unless you have received this token from an error
477// message.
478optional string continue = 3;
479
480// remainingItemCount is the number of subsequent items in the list which are not included in this
481// list response. If the list request contained label or field selectors, then the number of
482// remaining items is unknown and the field will be left unset and omitted during serialization.
483// If the list is complete (either because it is not chunking or because this is the last chunk),
484// then there are no more remaining items and this field will be left unset and omitted during
485// serialization.
486// Servers older than v1.15 do not set this field.
487// The intended use of the remainingItemCount is *estimating* the size of a collection. Clients
488// should not rely on the remainingItemCount to be set or to be exact.
489// +optional
490optional int64 remainingItemCount = 4;
491}
492
493// ListOptions is the query options to a standard REST list call.
494message ListOptions {
495// A selector to restrict the list of returned objects by their labels.
496// Defaults to everything.
497// +optional
498optional string labelSelector = 1;
499
500// A selector to restrict the list of returned objects by their fields.
501// Defaults to everything.
502// +optional
503optional string fieldSelector = 2;
504
505// Watch for changes to the described resources and return them as a stream of
506// add, update, and remove notifications. Specify resourceVersion.
507// +optional
508optional bool watch = 3;
509
510// allowWatchBookmarks requests watch events with type "BOOKMARK".
511// Servers that do not implement bookmarks may ignore this flag and
512// bookmarks are sent at the server's discretion. Clients should not
513// assume bookmarks are returned at any specific interval, nor may they
514// assume the server will send any BOOKMARK event during a session.
515// If this is not a watch, this field is ignored.
516// +optional
517optional bool allowWatchBookmarks = 9;
518
519// resourceVersion sets a constraint on what resource versions a request may be served from.
520// See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for
521// details.
522//
523// Defaults to unset
524// +optional
525optional string resourceVersion = 4;
526
527// resourceVersionMatch determines how resourceVersion is applied to list calls.
528// It is highly recommended that resourceVersionMatch be set for list calls where
529// resourceVersion is set
530// See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for
531// details.
532//
533// Defaults to unset
534// +optional
535optional string resourceVersionMatch = 10;
536
537// Timeout for the list/watch call.
538// This limits the duration of the call, regardless of any activity or inactivity.
539// +optional
540optional int64 timeoutSeconds = 5;
541
542// limit is a maximum number of responses to return for a list call. If more items exist, the
543// server will set the `continue` field on the list metadata to a value that can be used with the
544// same initial query to retrieve the next set of results. Setting a limit may return fewer than
545// the requested amount of items (up to zero items) in the event all requested objects are
546// filtered out and clients should only use the presence of the continue field to determine whether
547// more results are available. Servers may choose not to support the limit argument and will return
548// all of the available results. If limit is specified and the continue field is empty, clients may
549// assume that no more results are available. This field is not supported if watch is true.
550//
551// The server guarantees that the objects returned when using continue will be identical to issuing
552// a single list call without a limit - that is, no objects created, modified, or deleted after the
553// first request is issued will be included in any subsequent continued requests. This is sometimes
554// referred to as a consistent snapshot, and ensures that a client that is using limit to receive
555// smaller chunks of a very large result can ensure they see all possible objects. If objects are
556// updated during a chunked list the version of the object that was present at the time the first list
557// result was calculated is returned.
558optional int64 limit = 7;
559
560// The continue option should be set when retrieving more results from the server. Since this value is
561// server defined, clients may only use the continue value from a previous query result with identical
562// query parameters (except for the value of continue) and the server may reject a continue value it
563// does not recognize. If the specified continue value is no longer valid whether due to expiration
564// (generally five to fifteen minutes) or a configuration change on the server, the server will
565// respond with a 410 ResourceExpired error together with a continue token. If the client needs a
566// consistent list, it must restart their list without the continue field. Otherwise, the client may
567// send another list request with the token received with the 410 error, the server will respond with
568// a list starting from the next key, but from the latest snapshot, which is inconsistent from the
569// previous list results - objects that are created, modified, or deleted after the first list request
570// will be included in the response, as long as their keys are after the "next key".
571//
572// This field is not supported when watch is true. Clients may start a watch from the last
573// resourceVersion value returned by the server and not miss any modifications.
574optional string continue = 8;
575
576// `sendInitialEvents=true` may be set together with `watch=true`.
577// In that case, the watch stream will begin with synthetic events to
578// produce the current state of objects in the collection. Once all such
579// events have been sent, a synthetic "Bookmark" event will be sent.
580// The bookmark will report the ResourceVersion (RV) corresponding to the
581// set of objects, and be marked with `"k8s.io/initial-events-end": "true"` annotation.
582// Afterwards, the watch stream will proceed as usual, sending watch events
583// corresponding to changes (subsequent to the RV) to objects watched.
584//
585// When `sendInitialEvents` option is set, we require `resourceVersionMatch`
586// option to also be set. The semantic of the watch request is as following:
587// - `resourceVersionMatch` = NotOlderThan
588// is interpreted as "data at least as new as the provided `resourceVersion`"
589// and the bookmark event is send when the state is synced
590// to a `resourceVersion` at least as fresh as the one provided by the ListOptions.
591// If `resourceVersion` is unset, this is interpreted as "consistent read" and the
592// bookmark event is send when the state is synced at least to the moment
593// when request started being processed.
594// - `resourceVersionMatch` set to any other value or unset
595// Invalid error is returned.
596//
597// Defaults to true if `resourceVersion=""` or `resourceVersion="0"` (for backward
598// compatibility reasons) and to false otherwise.
599// +optional
600optional bool sendInitialEvents = 11;
601}
602
603// ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource
604// that the fieldset applies to.
605message ManagedFieldsEntry {
606// Manager is an identifier of the workflow managing these fields.
607optional string manager = 1;
608
609// Operation is the type of operation which lead to this ManagedFieldsEntry being created.
610// The only valid values for this field are 'Apply' and 'Update'.
611optional string operation = 2;
612
613// APIVersion defines the version of this resource that this field set
614// applies to. The format is "group/version" just like the top-level
615// APIVersion field. It is necessary to track the version of a field
616// set because it cannot be automatically converted.
617optional string apiVersion = 3;
618
619// Time is the timestamp of when the ManagedFields entry was added. The
620// timestamp will also be updated if a field is added, the manager
621// changes any of the owned fields value or removes a field. The
622// timestamp does not update when a field is removed from the entry
623// because another manager took it over.
624// +optional
625optional Time time = 4;
626
627// FieldsType is the discriminator for the different fields format and version.
628// There is currently only one possible value: "FieldsV1"
629optional string fieldsType = 6;
630
631// FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.
632// +optional
633optional FieldsV1 fieldsV1 = 7;
634
635// Subresource is the name of the subresource used to update that object, or
636// empty string if the object was updated through the main resource. The
637// value of this field is used to distinguish between managers, even if they
638// share the same name. For example, a status update will be distinct from a
639// regular update using the same manager name.
640// Note that the APIVersion field is not related to the Subresource field and
641// it always corresponds to the version of the main resource.
642optional string subresource = 8;
643}
644
645// MicroTime is version of Time with microsecond level precision.
646//
647// +protobuf.options.marshal=false
648// +protobuf.as=Timestamp
649// +protobuf.options.(gogoproto.goproto_stringer)=false
650message MicroTime {
651// Represents seconds of UTC time since Unix epoch
652// 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
653// 9999-12-31T23:59:59Z inclusive.
654optional int64 seconds = 1;
655
656// Non-negative fractions of a second at nanosecond resolution. Negative
657// second values with fractions must still have non-negative nanos values
658// that count forward in time. Must be from 0 to 999,999,999
659// inclusive. This field may be limited in precision depending on context.
660optional int32 nanos = 2;
661}
662
663// ObjectMeta is metadata that all persisted resources must have, which includes all objects
664// users must create.
665message ObjectMeta {
666// Name must be unique within a namespace. Is required when creating resources, although
667// some resources may allow a client to request the generation of an appropriate name
668// automatically. Name is primarily intended for creation idempotence and configuration
669// definition.
670// Cannot be updated.
671// More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
672// +optional
673optional string name = 1;
674
675// GenerateName is an optional prefix, used by the server, to generate a unique
676// name ONLY IF the Name field has not been provided.
677// If this field is used, the name returned to the client will be different
678// than the name passed. This value will also be combined with a unique suffix.
679// The provided value has the same validation rules as the Name field,
680// and may be truncated by the length of the suffix required to make the value
681// unique on the server.
682//
683// If this field is specified and the generated name exists, the server will return a 409.
684//
685// Applied only if Name is not specified.
686// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
687// +optional
688optional string generateName = 2;
689
690// Namespace defines the space within which each name must be unique. An empty namespace is
691// equivalent to the "default" namespace, but "default" is the canonical representation.
692// Not all objects are required to be scoped to a namespace - the value of this field for
693// those objects will be empty.
694//
695// Must be a DNS_LABEL.
696// Cannot be updated.
697// More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces
698// +optional
699optional string namespace = 3;
700
701// Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
702// +optional
703optional string selfLink = 4;
704
705// UID is the unique in time and space value for this object. It is typically generated by
706// the server on successful creation of a resource and is not allowed to change on PUT
707// operations.
708//
709// Populated by the system.
710// Read-only.
711// More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
712// +optional
713optional string uid = 5;
714
715// An opaque value that represents the internal version of this object that can
716// be used by clients to determine when objects have changed. May be used for optimistic
717// concurrency, change detection, and the watch operation on a resource or set of resources.
718// Clients must treat these values as opaque and passed unmodified back to the server.
719// They may only be valid for a particular resource or set of resources.
720//
721// Populated by the system.
722// Read-only.
723// Value must be treated as opaque by clients and .
724// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
725// +optional
726optional string resourceVersion = 6;
727
728// A sequence number representing a specific generation of the desired state.
729// Populated by the system. Read-only.
730// +optional
731optional int64 generation = 7;
732
733// CreationTimestamp is a timestamp representing the server time when this object was
734// created. It is not guaranteed to be set in happens-before order across separate operations.
735// Clients may not set this value. It is represented in RFC3339 form and is in UTC.
736//
737// Populated by the system.
738// Read-only.
739// Null for lists.
740// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
741// +optional
742optional Time creationTimestamp = 8;
743
744// DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This
745// field is set by the server when a graceful deletion is requested by the user, and is not
746// directly settable by a client. The resource is expected to be deleted (no longer visible
747// from resource lists, and not reachable by name) after the time in this field, once the
748// finalizers list is empty. As long as the finalizers list contains items, deletion is blocked.
749// Once the deletionTimestamp is set, this value may not be unset or be set further into the
750// future, although it may be shortened or the resource may be deleted prior to this time.
751// For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react
752// by sending a graceful termination signal to the containers in the pod. After that 30 seconds,
753// the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,
754// remove the pod from the API. In the presence of network partitions, this object may still
755// exist after this timestamp, until an administrator or automated process can determine the
756// resource is fully terminated.
757// If not set, graceful deletion of the object has not been requested.
758//
759// Populated by the system when a graceful deletion is requested.
760// Read-only.
761// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
762// +optional
763optional Time deletionTimestamp = 9;
764
765// Number of seconds allowed for this object to gracefully terminate before
766// it will be removed from the system. Only set when deletionTimestamp is also set.
767// May only be shortened.
768// Read-only.
769// +optional
770optional int64 deletionGracePeriodSeconds = 10;
771
772// Map of string keys and values that can be used to organize and categorize
773// (scope and select) objects. May match selectors of replication controllers
774// and services.
775// More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels
776// +optional
777map<string, string> labels = 11;
778
779// Annotations is an unstructured key value map stored with a resource that may be
780// set by external tools to store and retrieve arbitrary metadata. They are not
781// queryable and should be preserved when modifying objects.
782// More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations
783// +optional
784map<string, string> annotations = 12;
785
786// List of objects depended by this object. If ALL objects in the list have
787// been deleted, this object will be garbage collected. If this object is managed by a controller,
788// then an entry in this list will point to this controller, with the controller field set to true.
789// There cannot be more than one managing controller.
790// +optional
791// +patchMergeKey=uid
792// +patchStrategy=merge
793repeated OwnerReference ownerReferences = 13;
794
795// Must be empty before the object is deleted from the registry. Each entry
796// is an identifier for the responsible component that will remove the entry
797// from the list. If the deletionTimestamp of the object is non-nil, entries
798// in this list can only be removed.
799// Finalizers may be processed and removed in any order. Order is NOT enforced
800// because it introduces significant risk of stuck finalizers.
801// finalizers is a shared field, any actor with permission can reorder it.
802// If the finalizer list is processed in order, then this can lead to a situation
803// in which the component responsible for the first finalizer in the list is
804// waiting for a signal (field value, external system, or other) produced by a
805// component responsible for a finalizer later in the list, resulting in a deadlock.
806// Without enforced ordering finalizers are free to order amongst themselves and
807// are not vulnerable to ordering changes in the list.
808// +optional
809// +patchStrategy=merge
810repeated string finalizers = 14;
811
812// ManagedFields maps workflow-id and version to the set of fields
813// that are managed by that workflow. This is mostly for internal
814// housekeeping, and users typically shouldn't need to set or
815// understand this field. A workflow can be the user's name, a
816// controller's name, or the name of a specific apply path like
817// "ci-cd". The set of fields is always in the version that the
818// workflow used when modifying the object.
819//
820// +optional
821repeated ManagedFieldsEntry managedFields = 17;
822}
823
824// OwnerReference contains enough information to let you identify an owning
825// object. An owning object must be in the same namespace as the dependent, or
826// be cluster-scoped, so there is no namespace field.
827// +structType=atomic
828message OwnerReference {
829// API version of the referent.
830optional string apiVersion = 5;
831
832// Kind of the referent.
833// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
834optional string kind = 1;
835
836// Name of the referent.
837// More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
838optional string name = 3;
839
840// UID of the referent.
841// More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
842optional string uid = 4;
843
844// If true, this reference points to the managing controller.
845// +optional
846optional bool controller = 6;
847
848// If true, AND if the owner has the "foregroundDeletion" finalizer, then
849// the owner cannot be deleted from the key-value store until this
850// reference is removed.
851// See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion
852// for how the garbage collector interacts with this field and enforces the foreground deletion.
853// Defaults to false.
854// To set this field, a user needs "delete" permission of the owner,
855// otherwise 422 (Unprocessable Entity) will be returned.
856// +optional
857optional bool blockOwnerDeletion = 7;
858}
859
860// PartialObjectMetadata is a generic representation of any object with ObjectMeta. It allows clients
861// to get access to a particular ObjectMeta schema without knowing the details of the version.
862// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
863message PartialObjectMetadata {
864// Standard object's metadata.
865// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
866// +optional
867optional ObjectMeta metadata = 1;
868}
869
870// PartialObjectMetadataList contains a list of objects containing only their metadata
871// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
872message PartialObjectMetadataList {
873// Standard list metadata.
874// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
875// +optional
876optional ListMeta metadata = 1;
877
878// items contains each of the included items.
879repeated PartialObjectMetadata items = 2;
880}
881
882// Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.
883message Patch {
884}
885
886// PatchOptions may be provided when patching an API object.
887// PatchOptions is meant to be a superset of UpdateOptions.
888message PatchOptions {
889// When present, indicates that modifications should not be
890// persisted. An invalid or unrecognized dryRun directive will
891// result in an error response and no further processing of the
892// request. Valid values are:
893// - All: all dry run stages will be processed
894// +optional
895repeated string dryRun = 1;
896
897// Force is going to "force" Apply requests. It means user will
898// re-acquire conflicting fields owned by other people. Force
899// flag must be unset for non-apply patch requests.
900// +optional
901optional bool force = 2;
902
903// fieldManager is a name associated with the actor or entity
904// that is making these changes. The value must be less than or
905// 128 characters long, and only contain printable characters,
906// as defined by https://golang.org/pkg/unicode/#IsPrint. This
907// field is required for apply requests
908// (application/apply-patch) but optional for non-apply patch
909// types (JsonPatch, MergePatch, StrategicMergePatch).
910// +optional
911optional string fieldManager = 3;
912
913// fieldValidation instructs the server on how to handle
914// objects in the request (POST/PUT/PATCH) containing unknown
915// or duplicate fields. Valid values are:
916// - Ignore: This will ignore any unknown fields that are silently
917// dropped from the object, and will ignore all but the last duplicate
918// field that the decoder encounters. This is the default behavior
919// prior to v1.23.
920// - Warn: This will send a warning via the standard warning response
921// header for each unknown field that is dropped from the object, and
922// for each duplicate field that is encountered. The request will
923// still succeed if there are no other errors, and will only persist
924// the last of any duplicate fields. This is the default in v1.23+
925// - Strict: This will fail the request with a BadRequest error if
926// any unknown fields would be dropped from the object, or if any
927// duplicate fields are present. The error returned from the server
928// will contain all unknown and duplicate fields encountered.
929// +optional
930optional string fieldValidation = 4;
931}
932
933// Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.
934message Preconditions {
935// Specifies the target UID.
936// +optional
937optional string uid = 1;
938
939// Specifies the target ResourceVersion
940// +optional
941optional string resourceVersion = 2;
942}
943
944// RootPaths lists the paths available at root.
945// For example: "/healthz", "/apis".
946message RootPaths {
947// paths are the paths available at root.
948repeated string paths = 1;
949}
950
951// ServerAddressByClientCIDR helps the client to determine the server address that they should use, depending on the clientCIDR that they match.
952message ServerAddressByClientCIDR {
953// The CIDR with which clients can match their IP to figure out the server address that they should use.
954optional string clientCIDR = 1;
955
956// Address of this server, suitable for a client that matches the above CIDR.
957// This can be a hostname, hostname:port, IP or IP:port.
958optional string serverAddress = 2;
959}
960
961// Status is a return value for calls that don't return other objects.
962message Status {
963// Standard list metadata.
964// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
965// +optional
966optional ListMeta metadata = 1;
967
968// Status of the operation.
969// One of: "Success" or "Failure".
970// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
971// +optional
972optional string status = 2;
973
974// A human-readable description of the status of this operation.
975// +optional
976optional string message = 3;
977
978// A machine-readable description of why this operation is in the
979// "Failure" status. If this value is empty there
980// is no information available. A Reason clarifies an HTTP status
981// code but does not override it.
982// +optional
983optional string reason = 4;
984
985// Extended data associated with the reason. Each reason may define its
986// own extended details. This field is optional and the data returned
987// is not guaranteed to conform to any schema except that defined by
988// the reason type.
989// +optional
990optional StatusDetails details = 5;
991
992// Suggested HTTP return code for this status, 0 if not set.
993// +optional
994optional int32 code = 6;
995}
996
997// StatusCause provides more information about an api.Status failure, including
998// cases when multiple errors are encountered.
999message StatusCause {
1000// A machine-readable description of the cause of the error. If this value is
1001// empty there is no information available.
1002// +optional
1003optional string reason = 1;
1004
1005// A human-readable description of the cause of the error. This field may be
1006// presented as-is to a reader.
1007// +optional
1008optional string message = 2;
1009
1010// The field of the resource that has caused this error, as named by its JSON
1011// serialization. May include dot and postfix notation for nested attributes.
1012// Arrays are zero-indexed. Fields may appear more than once in an array of
1013// causes due to fields having multiple errors.
1014// Optional.
1015//
1016// Examples:
1017// "name" - the field "name" on the current resource
1018// "items[0].name" - the field "name" on the first array entry in "items"
1019// +optional
1020optional string field = 3;
1021}
1022
1023// StatusDetails is a set of additional properties that MAY be set by the
1024// server to provide additional information about a response. The Reason
1025// field of a Status object defines what attributes will be set. Clients
1026// must ignore fields that do not match the defined type of each attribute,
1027// and should assume that any attribute may be empty, invalid, or under
1028// defined.
1029message StatusDetails {
1030// The name attribute of the resource associated with the status StatusReason
1031// (when there is a single name which can be described).
1032// +optional
1033optional string name = 1;
1034
1035// The group attribute of the resource associated with the status StatusReason.
1036// +optional
1037optional string group = 2;
1038
1039// The kind attribute of the resource associated with the status StatusReason.
1040// On some operations may differ from the requested resource Kind.
1041// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
1042// +optional
1043optional string kind = 3;
1044
1045// UID of the resource.
1046// (when there is a single resource which can be described).
1047// More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
1048// +optional
1049optional string uid = 6;
1050
1051// The Causes array includes more details associated with the StatusReason
1052// failure. Not all StatusReasons may provide detailed causes.
1053// +optional
1054repeated StatusCause causes = 4;
1055
1056// If specified, the time in seconds before the operation should be retried. Some errors may indicate
1057// the client must take an alternate action - for those errors this field may indicate how long to wait
1058// before taking the alternate action.
1059// +optional
1060optional int32 retryAfterSeconds = 5;
1061}
1062
1063// TableOptions are used when a Table is requested by the caller.
1064// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
1065message TableOptions {
1066// includeObject decides whether to include each object along with its columnar information.
1067// Specifying "None" will return no object, specifying "Object" will return the full object contents, and
1068// specifying "Metadata" (the default) will return the object's metadata in the PartialObjectMetadata kind
1069// in version v1beta1 of the meta.k8s.io API group.
1070optional string includeObject = 1;
1071}
1072
1073// Time is a wrapper around time.Time which supports correct
1074// marshaling to YAML and JSON. Wrappers are provided for many
1075// of the factory methods that the time package offers.
1076//
1077// +protobuf.options.marshal=false
1078// +protobuf.as=Timestamp
1079// +protobuf.options.(gogoproto.goproto_stringer)=false
1080message Time {
1081// Represents seconds of UTC time since Unix epoch
1082// 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
1083// 9999-12-31T23:59:59Z inclusive.
1084optional int64 seconds = 1;
1085
1086// Non-negative fractions of a second at nanosecond resolution. Negative
1087// second values with fractions must still have non-negative nanos values
1088// that count forward in time. Must be from 0 to 999,999,999
1089// inclusive. This field may be limited in precision depending on context.
1090optional int32 nanos = 2;
1091}
1092
1093// Timestamp is a struct that is equivalent to Time, but intended for
1094// protobuf marshalling/unmarshalling. It is generated into a serialization
1095// that matches Time. Do not use in Go structs.
1096message Timestamp {
1097// Represents seconds of UTC time since Unix epoch
1098// 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
1099// 9999-12-31T23:59:59Z inclusive.
1100optional int64 seconds = 1;
1101
1102// Non-negative fractions of a second at nanosecond resolution. Negative
1103// second values with fractions must still have non-negative nanos values
1104// that count forward in time. Must be from 0 to 999,999,999
1105// inclusive. This field may be limited in precision depending on context.
1106optional int32 nanos = 2;
1107}
1108
1109// TypeMeta describes an individual object in an API response or request
1110// with strings representing the type of the object and its API schema version.
1111// Structures that are versioned or persisted should inline TypeMeta.
1112//
1113// +k8s:deepcopy-gen=false
1114message TypeMeta {
1115// Kind is a string value representing the REST resource this object represents.
1116// Servers may infer this from the endpoint the client submits requests to.
1117// Cannot be updated.
1118// In CamelCase.
1119// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
1120// +optional
1121optional string kind = 1;
1122
1123// APIVersion defines the versioned schema of this representation of an object.
1124// Servers should convert recognized schemas to the latest internal value, and
1125// may reject unrecognized values.
1126// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
1127// +optional
1128optional string apiVersion = 2;
1129}
1130
1131// UpdateOptions may be provided when updating an API object.
1132// All fields in UpdateOptions should also be present in PatchOptions.
1133message UpdateOptions {
1134// When present, indicates that modifications should not be
1135// persisted. An invalid or unrecognized dryRun directive will
1136// result in an error response and no further processing of the
1137// request. Valid values are:
1138// - All: all dry run stages will be processed
1139// +optional
1140repeated string dryRun = 1;
1141
1142// fieldManager is a name associated with the actor or entity
1143// that is making these changes. The value must be less than or
1144// 128 characters long, and only contain printable characters,
1145// as defined by https://golang.org/pkg/unicode/#IsPrint.
1146// +optional
1147optional string fieldManager = 2;
1148
1149// fieldValidation instructs the server on how to handle
1150// objects in the request (POST/PUT/PATCH) containing unknown
1151// or duplicate fields. Valid values are:
1152// - Ignore: This will ignore any unknown fields that are silently
1153// dropped from the object, and will ignore all but the last duplicate
1154// field that the decoder encounters. This is the default behavior
1155// prior to v1.23.
1156// - Warn: This will send a warning via the standard warning response
1157// header for each unknown field that is dropped from the object, and
1158// for each duplicate field that is encountered. The request will
1159// still succeed if there are no other errors, and will only persist
1160// the last of any duplicate fields. This is the default in v1.23+
1161// - Strict: This will fail the request with a BadRequest error if
1162// any unknown fields would be dropped from the object, or if any
1163// duplicate fields are present. The error returned from the server
1164// will contain all unknown and duplicate fields encountered.
1165// +optional
1166optional string fieldValidation = 3;
1167}
1168
1169// Verbs masks the value so protobuf can generate
1170//
1171// +protobuf.nullable=true
1172// +protobuf.options.(gogoproto.goproto_stringer)=false
1173message Verbs {
1174// items, if empty, will result in an empty slice
1175
1176repeated string items = 1;
1177}
1178
1179// Event represents a single event to a watched resource.
1180//
1181// +protobuf=true
1182// +k8s:deepcopy-gen=true
1183// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
1184message WatchEvent {
1185optional string type = 1;
1186
1187// Object is:
1188// * If Type is Added or Modified: the new state of the object.
1189// * If Type is Deleted: the state of the object immediately before deletion.
1190// * If Type is Error: *Status is recommended; other types may make sense
1191// depending on context.
1192optional k8s.io.apimachinery.pkg.runtime.RawExtension object = 2;
1193}
1194
1195