--- title: "Get details about a single pod running when a support bundle was collected." method: GET path: "/supportbundle/{bundle_id}/pod" tags: ["supportBundle"] --- # Get details about a single pod running when a support bundle was collected. `GET /supportbundle/{bundle_id}/pod` Return details about a specific pod that was running in the cluster at the time the specified support bundle was collected. It includes the pod's definition, events, and a list of containers with paths to their logs. Required RBAC Policy: kots/app/[:appid]/supportbundle/read ## Path parameters - `bundle_id` string, required ## Response `200` GetPodDetailsResponse contains the pod details response properties - object - `error` string - `podContainers` PodContainer[] - `isInitContainer` boolean - `logsFilePath` string - `name` string - `podDefinition` Pod — Pod is a collection of containers that can run on a host. This resource is created by clients and scheduled onto hosts. - `annotations` object — Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations +optional - `apiVersion` string — APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +optional - `creationTimestamp` string — CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional - `deletionGracePeriodSeconds` integer — Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. +optional - `deletionTimestamp` string — DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional - `finalizers` string[] — Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. +optional +patchStrategy=merge +listType=set - `generateName` string — GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will return a 409. Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency +optional - `generation` integer — A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. +optional - `kind` string — Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional - `labels` object — Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels +optional - `managedFields` ManagedFieldsEntry[] — ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object. +optional +listType=atomic - `apiVersion` string — APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted. - `fieldsType` string — FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1" - `fieldsV1` FieldsV1 — Each key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:', where is the name of a field in a struct, or key in a map 'v:', where is the exact json formatted value of a list item 'i:', where is position of a item in a list 'k:', where is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set. The exact format is defined in sigs.k8s.io/structured-merge-diff +protobuf.options.(gogoproto.goproto_stringer)=false - `manager` string — Manager is an identifier of the workflow managing these fields. - `operation` string - `subresource` string — Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource. - `time` string — Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over. +optional - `name` string — Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names +optional - `namespace` string — Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces +optional - `ownerReferences` OwnerReference[] — List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. +optional +patchMergeKey=uid +patchStrategy=merge +listType=map +listMapKey=uid - `apiVersion` string — API version of the referent. - `blockOwnerDeletion` boolean — If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. +optional - `controller` boolean — If true, this reference points to the managing controller. +optional - `kind` string — Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - `name` string — Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names - `uid` string — UID is a type that holds unique ID values, including UUIDs. Because we don't ONLY use UUIDs, this is an alias to string. Being a type captures intent and helps make sure that UIDs and names do not get conflated. - `resourceVersion` string — An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency +optional - `selfLink` string — Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. +optional - `spec` PodSpec - `activeDeadlineSeconds` integer — Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer. +optional - `affinity` Affinity - `nodeAffinity` NodeAffinity - `preferredDuringSchedulingIgnoredDuringExecution` PreferredSchedulingTerm[] — The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred. +optional +listType=atomic - `preference` NodeSelectorTerm — A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. +structType=atomic - … - `weight` integer — Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. - `requiredDuringSchedulingIgnoredDuringExecution` NodeSelector — A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms. +structType=atomic - `nodeSelectorTerms` NodeSelectorTerm[] — Required. A list of node selector terms. The terms are ORed. +listType=atomic - … - `podAffinity` PodAffinity - `preferredDuringSchedulingIgnoredDuringExecution` WeightedPodAffinityTerm[] — The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. +optional +listType=atomic - `podAffinityTerm` PodAffinityTerm — Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running - … - `weight` integer — weight associated with matching the corresponding podAffinityTerm, in the range 1-100. - `requiredDuringSchedulingIgnoredDuringExecution` PodAffinityTerm[] — If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. +optional +listType=atomic - `labelSelector` LabelSelector — A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. +structType=atomic - … - `matchLabelKeys` string[] — MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set. +listType=atomic +optional - `mismatchLabelKeys` string[] — MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set. +listType=atomic +optional - `namespaceSelector` LabelSelector — A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. +structType=atomic - … - `namespaces` string[] — namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". +optional +listType=atomic - `topologyKey` string — This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. - `podAntiAffinity` PodAntiAffinity - `preferredDuringSchedulingIgnoredDuringExecution` WeightedPodAffinityTerm[] — The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. +optional +listType=atomic - `podAffinityTerm` PodAffinityTerm — Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running - … - `weight` integer — weight associated with matching the corresponding podAffinityTerm, in the range 1-100. - `requiredDuringSchedulingIgnoredDuringExecution` PodAffinityTerm[] — If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. +optional +listType=atomic - `labelSelector` LabelSelector — A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. +structType=atomic - … - `matchLabelKeys` string[] — MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set. +listType=atomic +optional - `mismatchLabelKeys` string[] — MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set. +listType=atomic +optional - `namespaceSelector` LabelSelector — A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. +structType=atomic - … - `namespaces` string[] — namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". +optional +listType=atomic - `topologyKey` string — This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. - `automountServiceAccountToken` boolean — AutomountServiceAccountToken indicates whether a service account token should be automatically mounted. +optional - `containers` Container[] — List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated. +patchMergeKey=name +patchStrategy=merge +listType=map +listMapKey=name - `args` string[] — Arguments to the entrypoint. The container image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell +optional +listType=atomic - `command` string[] — Entrypoint array. Not executed within a shell. The container image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell +optional +listType=atomic - `env` EnvVar[] — List of environment variables to set in the container. Cannot be updated. +optional +patchMergeKey=name +patchStrategy=merge +listType=map +listMapKey=name - `name` string — Name of the environment variable. Must be a C_IDENTIFIER. - `value` string — Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". +optional - `valueFrom` EnvVarSource - `configMapKeyRef` ConfigMapKeySelector — +structType=atomic - … - `fieldRef` ObjectFieldSelector — +structType=atomic - … - `resourceFieldRef` ResourceFieldSelector — ResourceFieldSelector represents container resources (cpu, memory) and their output format +structType=atomic - … - `secretKeyRef` SecretKeySelector — +structType=atomic - … - `envFrom` EnvFromSource[] — List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. +optional +listType=atomic - `configMapRef` ConfigMapEnvSource — The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables. - `name` string — Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +optional +default="" +kubebuilder:default="" TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896. - `optional` boolean — Specify whether the ConfigMap must be defined +optional - `prefix` string — Optional text to prepend to the name of each environment variable. Must be a C_IDENTIFIER. +optional - `secretRef` SecretEnvSource — The contents of the target Secret's Data field will represent the key-value pairs as environment variables. - `name` string — Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +optional +default="" +kubebuilder:default="" TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896. - `optional` boolean — Specify whether the Secret must be defined +optional - `image` string — Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets. +optional - `imagePullPolicy` string — PullPolicy describes a policy for if/when to pull a container image +enum - `lifecycle` Lifecycle — Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted. - `postStart` LifecycleHandler — LifecycleHandler defines a specific action that should be taken in a lifecycle hook. One and only one of the fields, except TCPSocket must be specified. - `exec` ExecAction - … - `httpGet` HTTPGetAction - … - `sleep` SleepAction - … - `tcpSocket` TCPSocketAction — TCPSocketAction describes an action based on opening a socket - … - `preStop` LifecycleHandler — LifecycleHandler defines a specific action that should be taken in a lifecycle hook. One and only one of the fields, except TCPSocket must be specified. - `exec` ExecAction - … - `httpGet` HTTPGetAction - … - `sleep` SleepAction - … - `tcpSocket` TCPSocketAction — TCPSocketAction describes an action based on opening a socket - … - `stopSignal` string — Signal defines the stop signal of containers +enum - `livenessProbe` Probe — Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. - `exec` ExecAction - `command` string[] — Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. +optional +listType=atomic - `failureThreshold` integer — Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. +optional - `grpc` GRPCAction - `port` integer — Port number of the gRPC service. Number must be in the range 1 to 65535. - `service` string — Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC. +optional +default="" - `httpGet` HTTPGetAction - `host` string — Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. +optional - `httpHeaders` HTTPHeader[] — Custom headers to set in the request. HTTP allows repeated headers. +optional +listType=atomic - … - `path` string — Path to access on the HTTP server. +optional - `port` IntOrString — +protobuf=true +protobuf.options.(gogoproto.goproto_stringer)=false +k8s:openapi-gen=true - … - `scheme` string — URIScheme identifies the scheme used for connection to a host for Get actions +enum - `initialDelaySeconds` integer — Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes +optional - `periodSeconds` integer — How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. +optional - `successThreshold` integer — Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. +optional - `tcpSocket` TCPSocketAction — TCPSocketAction describes an action based on opening a socket - `host` string — Optional: Host name to connect to, defaults to the pod IP. +optional - `port` IntOrString — +protobuf=true +protobuf.options.(gogoproto.goproto_stringer)=false +k8s:openapi-gen=true - … - `terminationGracePeriodSeconds` integer — Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. +optional - `timeoutSeconds` integer — Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes +optional - `name` string — Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated. - `ports` ContainerPort[] — List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated. +optional +patchMergeKey=containerPort +patchStrategy=merge +listType=map +listMapKey=containerPort +listMapKey=protocol - `containerPort` integer — Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. - `hostIP` string — What host IP to bind the external port to. +optional - `hostPort` integer — Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. +optional - `name` string — If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services. +optional - `protocol` string — +enum - `readinessProbe` Probe — Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. - `exec` ExecAction - `command` string[] — Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. +optional +listType=atomic - `failureThreshold` integer — Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. +optional - `grpc` GRPCAction - `port` integer — Port number of the gRPC service. Number must be in the range 1 to 65535. - `service` string — Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC. +optional +default="" - `httpGet` HTTPGetAction - `host` string — Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. +optional - `httpHeaders` HTTPHeader[] — Custom headers to set in the request. HTTP allows repeated headers. +optional +listType=atomic - … - `path` string — Path to access on the HTTP server. +optional - `port` IntOrString — +protobuf=true +protobuf.options.(gogoproto.goproto_stringer)=false +k8s:openapi-gen=true - … - `scheme` string — URIScheme identifies the scheme used for connection to a host for Get actions +enum - `initialDelaySeconds` integer — Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes +optional - `periodSeconds` integer — How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. +optional - `successThreshold` integer — Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. +optional - `tcpSocket` TCPSocketAction — TCPSocketAction describes an action based on opening a socket - `host` string — Optional: Host name to connect to, defaults to the pod IP. +optional - `port` IntOrString — +protobuf=true +protobuf.options.(gogoproto.goproto_stringer)=false +k8s:openapi-gen=true - … - `terminationGracePeriodSeconds` integer — Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. +optional - `timeoutSeconds` integer — Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes +optional - `resizePolicy` ContainerResizePolicy[] — Resources resize policy for the container. +featureGate=InPlacePodVerticalScaling +optional +listType=atomic - `resourceName` string - `restartPolicy` string - `resources` ResourceRequirements - `claims` ResourceClaim[] — Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers. +listType=map +listMapKey=name +featureGate=DynamicResourceAllocation +optional - `name` string — Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container. - `request` string — Request is the name chosen for a request in the referenced claim. If empty, everything from the claim is made available, otherwise only the result of this request. +optional - `limits` ResourceList - `requests` ResourceList - `restartPolicy` string — This may only be set for init containers and only allowed value is "Always". - `securityContext` SecurityContext — Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence. - `allowPrivilegeEscalation` boolean — AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows. +optional - `appArmorProfile` AppArmorProfile — +union - `localhostProfile` string — localhostProfile indicates a profile loaded on the node that should be used. The profile must be preconfigured on the node to work. Must match the loaded name of the profile. Must be set if and only if type is "Localhost". +optional - `type` string — +enum - `capabilities` Capabilities - `add` Capability[] — Added capabilities +optional +listType=atomic - `drop` Capability[] — Removed capabilities +optional +listType=atomic - `privileged` boolean — Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows. +optional - `procMount` string — +enum - `readOnlyRootFilesystem` boolean — Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows. +optional - `runAsGroup` integer — The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. +optional - `runAsNonRoot` boolean — Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. +optional - `runAsUser` integer — The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. +optional - `seLinuxOptions` SELinuxOptions — SELinuxOptions are the labels to be applied to the container - `level` string — Level is SELinux level label that applies to the container. +optional - `role` string — Role is a SELinux role label that applies to the container. +optional - `type` string — Type is a SELinux type label that applies to the container. +optional - `user` string — User is a SELinux user label that applies to the container. +optional - `seccompProfile` SeccompProfile — Only one profile source may be set. +union - `localhostProfile` string — localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must be set if type is "Localhost". Must NOT be set for any other type. +optional - `type` string — +enum - `windowsOptions` WindowsSecurityContextOptions - `gmsaCredentialSpec` string — GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. +optional - `gmsaCredentialSpecName` string — GMSACredentialSpecName is the name of the GMSA credential spec to use. +optional - `hostProcess` boolean — HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true. +optional - `runAsUserName` string — The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. +optional - `startupProbe` Probe — Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. - `exec` ExecAction - `command` string[] — Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. +optional +listType=atomic - `failureThreshold` integer — Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. +optional - `grpc` GRPCAction - `port` integer — Port number of the gRPC service. Number must be in the range 1 to 65535. - `service` string — Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC. +optional +default="" - `httpGet` HTTPGetAction - `host` string — Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. +optional - `httpHeaders` HTTPHeader[] — Custom headers to set in the request. HTTP allows repeated headers. +optional +listType=atomic - … - `path` string — Path to access on the HTTP server. +optional - `port` IntOrString — +protobuf=true +protobuf.options.(gogoproto.goproto_stringer)=false +k8s:openapi-gen=true - … - `scheme` string — URIScheme identifies the scheme used for connection to a host for Get actions +enum - `initialDelaySeconds` integer — Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes +optional - `periodSeconds` integer — How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. +optional - `successThreshold` integer — Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. +optional - `tcpSocket` TCPSocketAction — TCPSocketAction describes an action based on opening a socket - `host` string — Optional: Host name to connect to, defaults to the pod IP. +optional - `port` IntOrString — +protobuf=true +protobuf.options.(gogoproto.goproto_stringer)=false +k8s:openapi-gen=true - … - `terminationGracePeriodSeconds` integer — Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. +optional - `timeoutSeconds` integer — Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes +optional - `stdin` boolean — Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. +optional - `stdinOnce` boolean — Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false +optional - `terminationMessagePath` string — Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. +optional - `terminationMessagePolicy` string — +enum - `tty` boolean — Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. +optional - `volumeDevices` VolumeDevice[] — volumeDevices is the list of block devices to be used by the container. +patchMergeKey=devicePath +patchStrategy=merge +listType=map +listMapKey=devicePath +optional - `devicePath` string — devicePath is the path inside of the container that the device will be mapped to. - `name` string — name must match the name of a persistentVolumeClaim in the pod - `volumeMounts` VolumeMount[] — Pod volumes to mount into the container's filesystem. Cannot be updated. +optional +patchMergeKey=mountPath +patchStrategy=merge +listType=map +listMapKey=mountPath - `mountPath` string — Path within the container at which the volume should be mounted. Must not contain ':'. - `mountPropagation` string — +enum - `name` string — This must match the Name of a Volume. - `readOnly` boolean — Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. +optional - `recursiveReadOnly` string - `subPath` string — Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). +optional - `subPathExpr` string — Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive. +optional - `workingDir` string — Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. +optional - `dnsConfig` PodDNSConfig — PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy. - `nameservers` string[] — A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed. +optional +listType=atomic - `options` PodDNSConfigOption[] — A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed. Resolution options given in Options will override those that appear in the base DNSPolicy. +optional +listType=atomic - `name` string — Name is this DNS resolver option's name. Required. - `value` string — Value is this DNS resolver option's value. +optional - `searches` string[] — A list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. Duplicated search paths will be removed. +optional +listType=atomic - `dnsPolicy` string — +enum - `enableServiceLinks` boolean — EnableServiceLinks indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. Optional: Defaults to true. +optional - `ephemeralContainers` EphemeralContainer[] — List of ephemeral containers run in this pod. Ephemeral containers may be run in an existing pod to perform user-initiated actions such as debugging. This list cannot be specified when creating a pod, and it cannot be modified by updating the pod spec. In order to add an ephemeral container to an existing pod, use the pod's ephemeralcontainers subresource. +optional +patchMergeKey=name +patchStrategy=merge +listType=map +listMapKey=name - `args` string[] — Arguments to the entrypoint. The image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell +optional +listType=atomic - `command` string[] — Entrypoint array. Not executed within a shell. The image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell +optional +listType=atomic - `env` EnvVar[] — List of environment variables to set in the container. Cannot be updated. +optional +patchMergeKey=name +patchStrategy=merge +listType=map +listMapKey=name - `name` string — Name of the environment variable. Must be a C_IDENTIFIER. - `value` string — Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". +optional - `valueFrom` EnvVarSource - `configMapKeyRef` ConfigMapKeySelector — +structType=atomic - … - `fieldRef` ObjectFieldSelector — +structType=atomic - … - `resourceFieldRef` ResourceFieldSelector — ResourceFieldSelector represents container resources (cpu, memory) and their output format +structType=atomic - … - `secretKeyRef` SecretKeySelector — +structType=atomic - … - `envFrom` EnvFromSource[] — List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. +optional +listType=atomic - `configMapRef` ConfigMapEnvSource — The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables. - `name` string — Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +optional +default="" +kubebuilder:default="" TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896. - `optional` boolean — Specify whether the ConfigMap must be defined +optional - `prefix` string — Optional text to prepend to the name of each environment variable. Must be a C_IDENTIFIER. +optional - `secretRef` SecretEnvSource — The contents of the target Secret's Data field will represent the key-value pairs as environment variables. - `name` string — Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +optional +default="" +kubebuilder:default="" TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896. - `optional` boolean — Specify whether the Secret must be defined +optional - `image` string — Container image name. More info: https://kubernetes.io/docs/concepts/containers/images - `imagePullPolicy` string — PullPolicy describes a policy for if/when to pull a container image +enum - `lifecycle` Lifecycle — Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted. - `postStart` LifecycleHandler — LifecycleHandler defines a specific action that should be taken in a lifecycle hook. One and only one of the fields, except TCPSocket must be specified. - `exec` ExecAction - … - `httpGet` HTTPGetAction - … - `sleep` SleepAction - … - `tcpSocket` TCPSocketAction — TCPSocketAction describes an action based on opening a socket - … - `preStop` LifecycleHandler — LifecycleHandler defines a specific action that should be taken in a lifecycle hook. One and only one of the fields, except TCPSocket must be specified. - `exec` ExecAction - … - `httpGet` HTTPGetAction - … - `sleep` SleepAction - … - `tcpSocket` TCPSocketAction — TCPSocketAction describes an action based on opening a socket - … - `stopSignal` string — Signal defines the stop signal of containers +enum - `livenessProbe` Probe — Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. - `exec` ExecAction - `command` string[] — Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. +optional +listType=atomic - `failureThreshold` integer — Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. +optional - `grpc` GRPCAction - `port` integer — Port number of the gRPC service. Number must be in the range 1 to 65535. - `service` string — Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC. +optional +default="" - `httpGet` HTTPGetAction - `host` string — Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. +optional - `httpHeaders` HTTPHeader[] — Custom headers to set in the request. HTTP allows repeated headers. +optional +listType=atomic - … - `path` string — Path to access on the HTTP server. +optional - `port` IntOrString — +protobuf=true +protobuf.options.(gogoproto.goproto_stringer)=false +k8s:openapi-gen=true - … - `scheme` string — URIScheme identifies the scheme used for connection to a host for Get actions +enum - `initialDelaySeconds` integer — Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes +optional - `periodSeconds` integer — How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. +optional - `successThreshold` integer — Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. +optional - `tcpSocket` TCPSocketAction — TCPSocketAction describes an action based on opening a socket - `host` string — Optional: Host name to connect to, defaults to the pod IP. +optional - `port` IntOrString — +protobuf=true +protobuf.options.(gogoproto.goproto_stringer)=false +k8s:openapi-gen=true - … - `terminationGracePeriodSeconds` integer — Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. +optional - `timeoutSeconds` integer — Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes +optional - `name` string — Name of the ephemeral container specified as a DNS_LABEL. This name must be unique among all containers, init containers and ephemeral containers. - `ports` ContainerPort[] — Ports are not allowed for ephemeral containers. +optional +patchMergeKey=containerPort +patchStrategy=merge +listType=map +listMapKey=containerPort +listMapKey=protocol - `containerPort` integer — Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. - `hostIP` string — What host IP to bind the external port to. +optional - `hostPort` integer — Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. +optional - `name` string — If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services. +optional - `protocol` string — +enum - `readinessProbe` Probe — Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. - `exec` ExecAction - `command` string[] — Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. +optional +listType=atomic - `failureThreshold` integer — Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. +optional - `grpc` GRPCAction - `port` integer — Port number of the gRPC service. Number must be in the range 1 to 65535. - `service` string — Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC. +optional +default="" - `httpGet` HTTPGetAction - `host` string — Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. +optional - `httpHeaders` HTTPHeader[] — Custom headers to set in the request. HTTP allows repeated headers. +optional +listType=atomic - … - `path` string — Path to access on the HTTP server. +optional - `port` IntOrString — +protobuf=true +protobuf.options.(gogoproto.goproto_stringer)=false +k8s:openapi-gen=true - … - `scheme` string — URIScheme identifies the scheme used for connection to a host for Get actions +enum - `initialDelaySeconds` integer — Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes +optional - `periodSeconds` integer — How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. +optional - `successThreshold` integer — Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. +optional - `tcpSocket` TCPSocketAction — TCPSocketAction describes an action based on opening a socket - `host` string — Optional: Host name to connect to, defaults to the pod IP. +optional - `port` IntOrString — +protobuf=true +protobuf.options.(gogoproto.goproto_stringer)=false +k8s:openapi-gen=true - … - `terminationGracePeriodSeconds` integer — Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. +optional - `timeoutSeconds` integer — Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes +optional - `resizePolicy` ContainerResizePolicy[] — Resources resize policy for the container. +featureGate=InPlacePodVerticalScaling +optional +listType=atomic - `resourceName` string - `restartPolicy` string - `resources` ResourceRequirements - `claims` ResourceClaim[] — Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers. +listType=map +listMapKey=name +featureGate=DynamicResourceAllocation +optional - `name` string — Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container. - `request` string — Request is the name chosen for a request in the referenced claim. If empty, everything from the claim is made available, otherwise only the result of this request. +optional - `limits` ResourceList - `requests` ResourceList - `restartPolicy` string — This may only be set for init containers and only allowed value is "Always". - `securityContext` SecurityContext — Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence. - `allowPrivilegeEscalation` boolean — AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows. +optional - `appArmorProfile` AppArmorProfile — +union - `localhostProfile` string — localhostProfile indicates a profile loaded on the node that should be used. The profile must be preconfigured on the node to work. Must match the loaded name of the profile. Must be set if and only if type is "Localhost". +optional - `type` string — +enum - `capabilities` Capabilities - `add` Capability[] — Added capabilities +optional +listType=atomic - `drop` Capability[] — Removed capabilities +optional +listType=atomic - `privileged` boolean — Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows. +optional - `procMount` string — +enum - `readOnlyRootFilesystem` boolean — Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows. +optional - `runAsGroup` integer — The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. +optional - `runAsNonRoot` boolean — Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. +optional - `runAsUser` integer — The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. +optional - `seLinuxOptions` SELinuxOptions — SELinuxOptions are the labels to be applied to the container - `level` string — Level is SELinux level label that applies to the container. +optional - `role` string — Role is a SELinux role label that applies to the container. +optional - `type` string — Type is a SELinux type label that applies to the container. +optional - `user` string — User is a SELinux user label that applies to the container. +optional - `seccompProfile` SeccompProfile — Only one profile source may be set. +union - `localhostProfile` string — localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must be set if type is "Localhost". Must NOT be set for any other type. +optional - `type` string — +enum - `windowsOptions` WindowsSecurityContextOptions - `gmsaCredentialSpec` string — GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. +optional - `gmsaCredentialSpecName` string — GMSACredentialSpecName is the name of the GMSA credential spec to use. +optional - `hostProcess` boolean — HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true. +optional - `runAsUserName` string — The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. +optional - `startupProbe` Probe — Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. - `exec` ExecAction - `command` string[] — Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. +optional +listType=atomic - `failureThreshold` integer — Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. +optional - `grpc` GRPCAction - `port` integer — Port number of the gRPC service. Number must be in the range 1 to 65535. - `service` string — Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC. +optional +default="" - `httpGet` HTTPGetAction - `host` string — Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. +optional - `httpHeaders` HTTPHeader[] — Custom headers to set in the request. HTTP allows repeated headers. +optional +listType=atomic - … - `path` string — Path to access on the HTTP server. +optional - `port` IntOrString — +protobuf=true +protobuf.options.(gogoproto.goproto_stringer)=false +k8s:openapi-gen=true - … - `scheme` string — URIScheme identifies the scheme used for connection to a host for Get actions +enum - `initialDelaySeconds` integer — Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes +optional - `periodSeconds` integer — How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. +optional - `successThreshold` integer — Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. +optional - `tcpSocket` TCPSocketAction — TCPSocketAction describes an action based on opening a socket - `host` string — Optional: Host name to connect to, defaults to the pod IP. +optional - `port` IntOrString — +protobuf=true +protobuf.options.(gogoproto.goproto_stringer)=false +k8s:openapi-gen=true - … - `terminationGracePeriodSeconds` integer — Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. +optional - `timeoutSeconds` integer — Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes +optional - `stdin` boolean — Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. +optional - `stdinOnce` boolean — Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false +optional - `targetContainerName` string — If set, the name of the container from PodSpec that this ephemeral container targets. The ephemeral container will be run in the namespaces (IPC, PID, etc) of this container. If not set then the ephemeral container uses the namespaces configured in the Pod spec. The container runtime must implement support for this feature. If the runtime does not support namespace targeting then the result of setting this field is undefined. +optional - `terminationMessagePath` string — Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. +optional - `terminationMessagePolicy` string — +enum - `tty` boolean — Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. +optional - `volumeDevices` VolumeDevice[] — volumeDevices is the list of block devices to be used by the container. +patchMergeKey=devicePath +patchStrategy=merge +listType=map +listMapKey=devicePath +optional - `devicePath` string — devicePath is the path inside of the container that the device will be mapped to. - `name` string — name must match the name of a persistentVolumeClaim in the pod - `volumeMounts` VolumeMount[] — Pod volumes to mount into the container's filesystem. Subpath mounts are not allowed for ephemeral containers. Cannot be updated. +optional +patchMergeKey=mountPath +patchStrategy=merge +listType=map +listMapKey=mountPath - `mountPath` string — Path within the container at which the volume should be mounted. Must not contain ':'. - `mountPropagation` string — +enum - `name` string — This must match the Name of a Volume. - `readOnly` boolean — Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. +optional - `recursiveReadOnly` string - `subPath` string — Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). +optional - `subPathExpr` string — Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive. +optional - `workingDir` string — Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. +optional - `hostAliases` HostAlias[] — HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified. +optional +patchMergeKey=ip +patchStrategy=merge +listType=map +listMapKey=ip - `hostnames` string[] — Hostnames for the above IP address. +listType=atomic - `ip` string — IP address of the host file entry. +required - `hostIPC` boolean — Use the host's ipc namespace. Optional: Default to false. +k8s:conversion-gen=false +optional - `hostNetwork` boolean — Host networking requested for this pod. Use the host's network namespace. If this option is set, the ports that will be used must be specified. Default to false. +k8s:conversion-gen=false +optional - `hostPID` boolean — Use the host's pid namespace. Optional: Default to false. +k8s:conversion-gen=false +optional - `hostUsers` boolean — Use the host's user namespace. Optional: Default to true. If set to true or not present, the pod will be run in the host user namespace, useful for when the pod needs a feature only available to the host user namespace, such as loading a kernel module with CAP_SYS_MODULE. When set to false, a new userns is created for the pod. Setting false is useful for mitigating container breakout vulnerabilities even allowing users to run their containers as root without actually having root privileges on the host. This field is alpha-level and is only honored by servers that enable the UserNamespacesSupport feature. +k8s:conversion-gen=false +optional - `hostname` string — Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value. +optional - `imagePullSecrets` LocalObjectReference[] — ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod +optional +patchMergeKey=name +patchStrategy=merge +listType=map +listMapKey=name - `name` string — Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +optional +default="" +kubebuilder:default="" TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896. - `initContainers` Container[] — List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ +patchMergeKey=name +patchStrategy=merge +listType=map +listMapKey=name - `args` string[] — Arguments to the entrypoint. The container image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell +optional +listType=atomic - `command` string[] — Entrypoint array. Not executed within a shell. The container image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell +optional +listType=atomic - `env` EnvVar[] — List of environment variables to set in the container. Cannot be updated. +optional +patchMergeKey=name +patchStrategy=merge +listType=map +listMapKey=name - `name` string — Name of the environment variable. Must be a C_IDENTIFIER. - `value` string — Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". +optional - `valueFrom` EnvVarSource - `configMapKeyRef` ConfigMapKeySelector — +structType=atomic - … - `fieldRef` ObjectFieldSelector — +structType=atomic - … - `resourceFieldRef` ResourceFieldSelector — ResourceFieldSelector represents container resources (cpu, memory) and their output format +structType=atomic - … - `secretKeyRef` SecretKeySelector — +structType=atomic - … - `envFrom` EnvFromSource[] — List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. +optional +listType=atomic - `configMapRef` ConfigMapEnvSource — The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables. - `name` string — Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +optional +default="" +kubebuilder:default="" TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896. - `optional` boolean — Specify whether the ConfigMap must be defined +optional - `prefix` string — Optional text to prepend to the name of each environment variable. Must be a C_IDENTIFIER. +optional - `secretRef` SecretEnvSource — The contents of the target Secret's Data field will represent the key-value pairs as environment variables. - `name` string — Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +optional +default="" +kubebuilder:default="" TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896. - `optional` boolean — Specify whether the Secret must be defined +optional - `image` string — Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets. +optional - `imagePullPolicy` string — PullPolicy describes a policy for if/when to pull a container image +enum - `lifecycle` Lifecycle — Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted. - `postStart` LifecycleHandler — LifecycleHandler defines a specific action that should be taken in a lifecycle hook. One and only one of the fields, except TCPSocket must be specified. - `exec` ExecAction - … - `httpGet` HTTPGetAction - … - `sleep` SleepAction - … - `tcpSocket` TCPSocketAction — TCPSocketAction describes an action based on opening a socket - … - `preStop` LifecycleHandler — LifecycleHandler defines a specific action that should be taken in a lifecycle hook. One and only one of the fields, except TCPSocket must be specified. - `exec` ExecAction - … - `httpGet` HTTPGetAction - … - `sleep` SleepAction - … - `tcpSocket` TCPSocketAction — TCPSocketAction describes an action based on opening a socket - … - `stopSignal` string — Signal defines the stop signal of containers +enum - `livenessProbe` Probe — Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. - `exec` ExecAction - `command` string[] — Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. +optional +listType=atomic - `failureThreshold` integer — Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. +optional - `grpc` GRPCAction - `port` integer — Port number of the gRPC service. Number must be in the range 1 to 65535. - `service` string — Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC. +optional +default="" - `httpGet` HTTPGetAction - `host` string — Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. +optional - `httpHeaders` HTTPHeader[] — Custom headers to set in the request. HTTP allows repeated headers. +optional +listType=atomic - … - `path` string — Path to access on the HTTP server. +optional - `port` IntOrString — +protobuf=true +protobuf.options.(gogoproto.goproto_stringer)=false +k8s:openapi-gen=true - … - `scheme` string — URIScheme identifies the scheme used for connection to a host for Get actions +enum - `initialDelaySeconds` integer — Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes +optional - `periodSeconds` integer — How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. +optional - `successThreshold` integer — Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. +optional - `tcpSocket` TCPSocketAction — TCPSocketAction describes an action based on opening a socket - `host` string — Optional: Host name to connect to, defaults to the pod IP. +optional - `port` IntOrString — +protobuf=true +protobuf.options.(gogoproto.goproto_stringer)=false +k8s:openapi-gen=true - … - `terminationGracePeriodSeconds` integer — Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. +optional - `timeoutSeconds` integer — Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes +optional - `name` string — Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated. - `ports` ContainerPort[] — List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated. +optional +patchMergeKey=containerPort +patchStrategy=merge +listType=map +listMapKey=containerPort +listMapKey=protocol - `containerPort` integer — Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. - `hostIP` string — What host IP to bind the external port to. +optional - `hostPort` integer — Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. +optional - `name` string — If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services. +optional - `protocol` string — +enum - `readinessProbe` Probe — Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. - `exec` ExecAction - `command` string[] — Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. +optional +listType=atomic - `failureThreshold` integer — Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. +optional - `grpc` GRPCAction - `port` integer — Port number of the gRPC service. Number must be in the range 1 to 65535. - `service` string — Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC. +optional +default="" - `httpGet` HTTPGetAction - `host` string — Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. +optional - `httpHeaders` HTTPHeader[] — Custom headers to set in the request. HTTP allows repeated headers. +optional +listType=atomic - … - `path` string — Path to access on the HTTP server. +optional - `port` IntOrString — +protobuf=true +protobuf.options.(gogoproto.goproto_stringer)=false +k8s:openapi-gen=true - … - `scheme` string — URIScheme identifies the scheme used for connection to a host for Get actions +enum - `initialDelaySeconds` integer — Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes +optional - `periodSeconds` integer — How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. +optional - `successThreshold` integer — Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. +optional - `tcpSocket` TCPSocketAction — TCPSocketAction describes an action based on opening a socket - `host` string — Optional: Host name to connect to, defaults to the pod IP. +optional - `port` IntOrString — +protobuf=true +protobuf.options.(gogoproto.goproto_stringer)=false +k8s:openapi-gen=true - … - `terminationGracePeriodSeconds` integer — Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. +optional - `timeoutSeconds` integer — Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes +optional - `resizePolicy` ContainerResizePolicy[] — Resources resize policy for the container. +featureGate=InPlacePodVerticalScaling +optional +listType=atomic - `resourceName` string - `restartPolicy` string - `resources` ResourceRequirements - `claims` ResourceClaim[] — Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers. +listType=map +listMapKey=name +featureGate=DynamicResourceAllocation +optional - `name` string — Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container. - `request` string — Request is the name chosen for a request in the referenced claim. If empty, everything from the claim is made available, otherwise only the result of this request. +optional - `limits` ResourceList - `requests` ResourceList - `restartPolicy` string — This may only be set for init containers and only allowed value is "Always". - `securityContext` SecurityContext — Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence. - `allowPrivilegeEscalation` boolean — AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows. +optional - `appArmorProfile` AppArmorProfile — +union - `localhostProfile` string — localhostProfile indicates a profile loaded on the node that should be used. The profile must be preconfigured on the node to work. Must match the loaded name of the profile. Must be set if and only if type is "Localhost". +optional - `type` string — +enum - `capabilities` Capabilities - `add` Capability[] — Added capabilities +optional +listType=atomic - `drop` Capability[] — Removed capabilities +optional +listType=atomic - `privileged` boolean — Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows. +optional - `procMount` string — +enum - `readOnlyRootFilesystem` boolean — Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows. +optional - `runAsGroup` integer — The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. +optional - `runAsNonRoot` boolean — Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. +optional - `runAsUser` integer — The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. +optional - `seLinuxOptions` SELinuxOptions — SELinuxOptions are the labels to be applied to the container - `level` string — Level is SELinux level label that applies to the container. +optional - `role` string — Role is a SELinux role label that applies to the container. +optional - `type` string — Type is a SELinux type label that applies to the container. +optional - `user` string — User is a SELinux user label that applies to the container. +optional - `seccompProfile` SeccompProfile — Only one profile source may be set. +union - `localhostProfile` string — localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must be set if type is "Localhost". Must NOT be set for any other type. +optional - `type` string — +enum - `windowsOptions` WindowsSecurityContextOptions - `gmsaCredentialSpec` string — GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. +optional - `gmsaCredentialSpecName` string — GMSACredentialSpecName is the name of the GMSA credential spec to use. +optional - `hostProcess` boolean — HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true. +optional - `runAsUserName` string — The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. +optional - `startupProbe` Probe — Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. - `exec` ExecAction - `command` string[] — Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. +optional +listType=atomic - `failureThreshold` integer — Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. +optional - `grpc` GRPCAction - `port` integer — Port number of the gRPC service. Number must be in the range 1 to 65535. - `service` string — Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC. +optional +default="" - `httpGet` HTTPGetAction - `host` string — Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. +optional - `httpHeaders` HTTPHeader[] — Custom headers to set in the request. HTTP allows repeated headers. +optional +listType=atomic - … - `path` string — Path to access on the HTTP server. +optional - `port` IntOrString — +protobuf=true +protobuf.options.(gogoproto.goproto_stringer)=false +k8s:openapi-gen=true - … - `scheme` string — URIScheme identifies the scheme used for connection to a host for Get actions +enum - `initialDelaySeconds` integer — Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes +optional - `periodSeconds` integer — How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. +optional - `successThreshold` integer — Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. +optional - `tcpSocket` TCPSocketAction — TCPSocketAction describes an action based on opening a socket - `host` string — Optional: Host name to connect to, defaults to the pod IP. +optional - `port` IntOrString — +protobuf=true +protobuf.options.(gogoproto.goproto_stringer)=false +k8s:openapi-gen=true - … - `terminationGracePeriodSeconds` integer — Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. +optional - `timeoutSeconds` integer — Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes +optional - `stdin` boolean — Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. +optional - `stdinOnce` boolean — Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false +optional - `terminationMessagePath` string — Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. +optional - `terminationMessagePolicy` string — +enum - `tty` boolean — Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. +optional - `volumeDevices` VolumeDevice[] — volumeDevices is the list of block devices to be used by the container. +patchMergeKey=devicePath +patchStrategy=merge +listType=map +listMapKey=devicePath +optional - `devicePath` string — devicePath is the path inside of the container that the device will be mapped to. - `name` string — name must match the name of a persistentVolumeClaim in the pod - `volumeMounts` VolumeMount[] — Pod volumes to mount into the container's filesystem. Cannot be updated. +optional +patchMergeKey=mountPath +patchStrategy=merge +listType=map +listMapKey=mountPath - `mountPath` string — Path within the container at which the volume should be mounted. Must not contain ':'. - `mountPropagation` string — +enum - `name` string — This must match the Name of a Volume. - `readOnly` boolean — Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. +optional - `recursiveReadOnly` string - `subPath` string — Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). +optional - `subPathExpr` string — Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive. +optional - `workingDir` string — Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. +optional - `nodeName` string — NodeName indicates in which node this pod is scheduled. If empty, this pod is a candidate for scheduling by the scheduler defined in schedulerName. Once this field is set, the kubelet for this node becomes responsible for the lifecycle of this pod. This field should not be used to express a desire for the pod to be scheduled on a specific node. https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodename +optional - `nodeSelector` object — NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ +optional +mapType=atomic - `os` PodOS - `name` string - `overhead` ResourceList - `preemptionPolicy` string — +enum - `priority` integer — The priority value. Various system components use this field to find the priority of the pod. When Priority Admission Controller is enabled, it prevents users from setting this field. The admission controller populates this field from PriorityClassName. The higher the value, the higher the priority. +optional - `priorityClassName` string — If specified, indicates the pod's priority. "system-node-critical" and "system-cluster-critical" are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default. +optional - `readinessGates` PodReadinessGate[] — If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to "True" More info: https://git.k8s.io/enhancements/keps/sig-network/580-pod-readiness-gates +optional +listType=atomic - `conditionType` string — PodConditionType is a valid value for PodCondition.Type - `resourceClaims` PodResourceClaim[] — ResourceClaims defines which ResourceClaims must be allocated and reserved before the Pod is allowed to start. The resources will be made available to those containers which consume them by name. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. +patchMergeKey=name +patchStrategy=merge,retainKeys +listType=map +listMapKey=name +featureGate=DynamicResourceAllocation +optional - `name` string — Name uniquely identifies this resource claim inside the pod. This must be a DNS_LABEL. - `resourceClaimName` string — ResourceClaimName is the name of a ResourceClaim object in the same namespace as this pod. Exactly one of ResourceClaimName and ResourceClaimTemplateName must be set. - `resourceClaimTemplateName` string — ResourceClaimTemplateName is the name of a ResourceClaimTemplate object in the same namespace as this pod. The template will be used to create a new ResourceClaim, which will be bound to this pod. When this pod is deleted, the ResourceClaim will also be deleted. The pod name and resource name, along with a generated component, will be used to form a unique name for the ResourceClaim, which will be recorded in pod.status.resourceClaimStatuses. This field is immutable and no changes will be made to the corresponding ResourceClaim by the control plane after creating the ResourceClaim. Exactly one of ResourceClaimName and ResourceClaimTemplateName must be set. - `resources` ResourceRequirements - `claims` ResourceClaim[] — Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers. +listType=map +listMapKey=name +featureGate=DynamicResourceAllocation +optional - `name` string — Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container. - `request` string — Request is the name chosen for a request in the referenced claim. If empty, everything from the claim is made available, otherwise only the result of this request. +optional - `limits` ResourceList - `requests` ResourceList - `restartPolicy` string — Only one of the following restart policies may be specified. If none of the following policies is specified, the default one is RestartPolicyAlways. +enum - `runtimeClassName` string — RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used to run this pod. If no RuntimeClass resource matches the named class, the pod will not be run. If unset or empty, the "legacy" RuntimeClass will be used, which is an implicit class with an empty definition that uses the default runtime handler. More info: https://git.k8s.io/enhancements/keps/sig-node/585-runtime-class +optional - `schedulerName` string — If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler. +optional - `schedulingGates` PodSchedulingGate[] — SchedulingGates is an opaque list of values that if specified will block scheduling the pod. If schedulingGates is not empty, the pod will stay in the SchedulingGated state and the scheduler will not attempt to schedule the pod. SchedulingGates can only be set at pod creation time, and be removed only afterwards. +patchMergeKey=name +patchStrategy=merge +listType=map +listMapKey=name +optional - `name` string — Name of the scheduling gate. Each scheduling gate must have a unique name field. - `securityContext` PodSecurityContext — Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext. - `appArmorProfile` AppArmorProfile — +union - `localhostProfile` string — localhostProfile indicates a profile loaded on the node that should be used. The profile must be preconfigured on the node to work. Must match the loaded name of the profile. Must be set if and only if type is "Localhost". +optional - `type` string — +enum - `fsGroup` integer — A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: 1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw---- If unset, the Kubelet will not modify the ownership and permissions of any volume. Note that this field cannot be set when spec.os.name is windows. +optional - `fsGroupChangePolicy` string — PodFSGroupChangePolicy holds policies that will be used for applying fsGroup to a volume when volume is mounted. +enum - `runAsGroup` integer — The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows. +optional - `runAsNonRoot` boolean — Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. +optional - `runAsUser` integer — The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows. +optional - `seLinuxChangePolicy` string - `seLinuxOptions` SELinuxOptions — SELinuxOptions are the labels to be applied to the container - `level` string — Level is SELinux level label that applies to the container. +optional - `role` string — Role is a SELinux role label that applies to the container. +optional - `type` string — Type is a SELinux type label that applies to the container. +optional - `user` string — User is a SELinux user label that applies to the container. +optional - `seccompProfile` SeccompProfile — Only one profile source may be set. +union - `localhostProfile` string — localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must be set if type is "Localhost". Must NOT be set for any other type. +optional - `type` string — +enum - `supplementalGroups` integer[] — A list of groups applied to the first process run in each container, in addition to the container's primary GID and fsGroup (if specified). If the SupplementalGroupsPolicy feature is enabled, the supplementalGroupsPolicy field determines whether these are in addition to or instead of any group memberships defined in the container image. If unspecified, no additional groups are added, though group memberships defined in the container image may still be used, depending on the supplementalGroupsPolicy field. Note that this field cannot be set when spec.os.name is windows. +optional +listType=atomic - `supplementalGroupsPolicy` string — SupplementalGroupsPolicy defines how supplemental groups of the first container processes are calculated. +enum - `sysctls` Sysctl[] — Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Note that this field cannot be set when spec.os.name is windows. +optional +listType=atomic - `name` string — Name of a property to set - `value` string — Value of a property to set - `windowsOptions` WindowsSecurityContextOptions - `gmsaCredentialSpec` string — GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. +optional - `gmsaCredentialSpecName` string — GMSACredentialSpecName is the name of the GMSA credential spec to use. +optional - `hostProcess` boolean — HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true. +optional - `runAsUserName` string — The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. +optional - `serviceAccount` string — DeprecatedServiceAccount is a deprecated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead. +k8s:conversion-gen=false +optional - `serviceAccountName` string — ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/ +optional - `setHostnameAsFQDN` boolean — If true the pod's hostname will be configured as the pod's FQDN, rather than the leaf name (the default). In Linux containers, this means setting the FQDN in the hostname field of the kernel (the nodename field of struct utsname). In Windows containers, this means setting the registry value of hostname for the registry key HKEY_LOCAL_MACHINE\\SYSTEM\\CurrentControlSet\\Services\\Tcpip\\Parameters to FQDN. If a pod does not have FQDN, this has no effect. Default to false. +optional - `shareProcessNamespace` boolean — Share a single process namespace between all of the containers in a pod. When this is set containers will be able to view and signal processes from other containers in the same pod, and the first process in each container will not be assigned PID 1. HostPID and ShareProcessNamespace cannot both be set. Optional: Default to false. +k8s:conversion-gen=false +optional - `subdomain` string — If specified, the fully qualified Pod hostname will be "...svc.". If not specified, the pod will not have a domainname at all. +optional - `terminationGracePeriodSeconds` integer — Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds. +optional - `tolerations` Toleration[] — If specified, the pod's tolerations. +optional +listType=atomic - `effect` string — +enum - `key` string — Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys. +optional - `operator` string — +enum - `tolerationSeconds` integer — TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. +optional - `value` string — Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. +optional - `topologySpreadConstraints` TopologySpreadConstraint[] — TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. All topologySpreadConstraints are ANDed. +optional +patchMergeKey=topologyKey +patchStrategy=merge +listType=map +listMapKey=topologyKey +listMapKey=whenUnsatisfiable - `labelSelector` LabelSelector — A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. +structType=atomic - `matchExpressions` LabelSelectorRequirement[] — matchExpressions is a list of label selector requirements. The requirements are ANDed. +optional +listType=atomic - `key` string — key is the label key that the selector applies to. - `operator` string - `values` string[] — values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. +optional +listType=atomic - `matchLabels` object — matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. +optional - `matchLabelKeys` string[] — MatchLabelKeys is a set of pod label keys to select the pods over which spreading will be calculated. The keys are used to lookup values from the incoming pod labels, those key-value labels are ANDed with labelSelector to select the group of existing pods over which spreading will be calculated for the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. MatchLabelKeys cannot be set when LabelSelector isn't set. Keys that don't exist in the incoming pod labels will be ignored. A null or empty list means only match against labelSelector. This is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default). +listType=atomic +optional - `maxSkew` integer — MaxSkew describes the degree to which pods may be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. The global minimum is the minimum number of matching pods in an eligible domain or zero if the number of eligible domains is less than MinDomains. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 2/2/1: In this case, the global minimum is 1. +-------+-------+-------+ zone1 | zone2 | zone3 | +-------+-------+-------+ P P | P P | P | +-------+-------+-------+ if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2; scheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2) violate MaxSkew(1). if MaxSkew is 2, incoming pod can be scheduled onto any zone. When `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed. - `minDomains` integer — MinDomains indicates a minimum number of eligible domains. When the number of eligible domains with matching topology keys is less than minDomains, Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed. And when the number of eligible domains with matching topology keys equals or greater than minDomains, this value has no effect on scheduling. As a result, when the number of eligible domains is less than minDomains, scheduler won't schedule more than maxSkew Pods to those domains. If value is nil, the constraint behaves as if MinDomains is equal to 1. Valid values are integers greater than 0. When value is not nil, WhenUnsatisfiable must be DoNotSchedule. For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same labelSelector spread as 2/2/2: +-------+-------+-------+ zone1 | zone2 | zone3 | +-------+-------+-------+ P P | P P | P P | +-------+-------+-------+ The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0. In this situation, new pod with the same labelSelector cannot be scheduled, because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones, it will violate MaxSkew. +optional - `nodeAffinityPolicy` string — NodeInclusionPolicy defines the type of node inclusion policy +enum - `nodeTaintsPolicy` string — NodeInclusionPolicy defines the type of node inclusion policy +enum - `topologyKey` string — TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each as a "bucket", and try to put balanced number of pods into each bucket. We define a domain as a particular instance of a topology. Also, we define an eligible domain as a domain whose nodes meet the requirements of nodeAffinityPolicy and nodeTaintsPolicy. e.g. If TopologyKey is "kubernetes.io/hostname", each Node is a domain of that topology. And, if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of that topology. It's a required field. - `whenUnsatisfiable` string — +enum - `volumes` Volume[] — List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes +optional +patchMergeKey=name +patchStrategy=merge,retainKeys +listType=map +listMapKey=name - `awsElasticBlockStore` AWSElasticBlockStoreVolumeSource — An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling. - `fsType` string — fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore TODO: how do we prevent errors in the filesystem from compromising the machine +optional - `partition` integer — partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). +optional - `readOnly` boolean — readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore +optional - `volumeID` string — volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore - `azureDisk` AzureDiskVolumeSource - `cachingMode` string — +enum - `diskName` string — diskName is the Name of the data disk in the blob storage - `diskURI` string — diskURI is the URI of data disk in the blob storage - `fsType` string — fsType is Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. +optional +default="ext4" - `kind` string — +enum - `readOnly` boolean — readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. +optional +default=false - `azureFile` AzureFileVolumeSource - `readOnly` boolean — readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. +optional - `secretName` string — secretName is the name of secret that contains Azure Storage Account Name and Key - `shareName` string — shareName is the azure share Name - `cephfs` CephFSVolumeSource — Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling. - `monitors` string[] — monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it +listType=atomic - `path` string — path is Optional: Used as the mounted root, rather than the full Ceph tree, default is / +optional - `readOnly` boolean — readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it +optional - `secretFile` string — secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it +optional - `secretRef` LocalObjectReference — New uses of this type are discouraged because of difficulty describing its usage when embedded in APIs. 1. Invalid usage help. It is impossible to add specific help for individual usage. In most embedded usages, there are particular restrictions like, "must refer only to types A and B" or "UID not honored" or "name must be restricted". Those cannot be well described when embedded. 2. Inconsistent validation. Because the usages are different, the validation rules are different by usage, which makes it hard for users to predict what will happen. 3. We cannot easily change it. Because this type is embedded in many locations, updates to this type will affect numerous schemas. Don't make new APIs embed an underspecified API type they do not control. Instead of using this type, create a locally provided and used type that is well-focused on your reference. For example, ServiceReferences for admission registration: https://github.com/kubernetes/api/blob/release-1.17/admissionregistration/v1/types.go#L533 . +structType=atomic - `name` string — Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +optional +default="" +kubebuilder:default="" TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896. - `user` string — user is optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it +optional - `cinder` CinderVolumeSource — A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling. - `fsType` string — fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md +optional - `readOnly` boolean — readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md +optional - `secretRef` LocalObjectReference — New uses of this type are discouraged because of difficulty describing its usage when embedded in APIs. 1. Invalid usage help. It is impossible to add specific help for individual usage. In most embedded usages, there are particular restrictions like, "must refer only to types A and B" or "UID not honored" or "name must be restricted". Those cannot be well described when embedded. 2. Inconsistent validation. Because the usages are different, the validation rules are different by usage, which makes it hard for users to predict what will happen. 3. We cannot easily change it. Because this type is embedded in many locations, updates to this type will affect numerous schemas. Don't make new APIs embed an underspecified API type they do not control. Instead of using this type, create a locally provided and used type that is well-focused on your reference. For example, ServiceReferences for admission registration: https://github.com/kubernetes/api/blob/release-1.17/admissionregistration/v1/types.go#L533 . +structType=atomic - `name` string — Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +optional +default="" +kubebuilder:default="" TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896. - `volumeID` string — volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md - `configMap` ConfigMapVolumeSource — The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling. - `defaultMode` integer — defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. +optional - `items` KeyToPath[] — items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. +optional +listType=atomic - `key` string — key is the key to project. - `mode` integer — mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. +optional - `path` string — path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. - `name` string — Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +optional +default="" +kubebuilder:default="" TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896. - `optional` boolean — optional specify whether the ConfigMap or its keys must be defined +optional - `csi` CSIVolumeSource — Represents a source location of a volume to mount, managed by an external CSI driver - `driver` string — driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster. - `fsType` string — fsType to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply. +optional - `nodePublishSecretRef` LocalObjectReference — New uses of this type are discouraged because of difficulty describing its usage when embedded in APIs. 1. Invalid usage help. It is impossible to add specific help for individual usage. In most embedded usages, there are particular restrictions like, "must refer only to types A and B" or "UID not honored" or "name must be restricted". Those cannot be well described when embedded. 2. Inconsistent validation. Because the usages are different, the validation rules are different by usage, which makes it hard for users to predict what will happen. 3. We cannot easily change it. Because this type is embedded in many locations, updates to this type will affect numerous schemas. Don't make new APIs embed an underspecified API type they do not control. Instead of using this type, create a locally provided and used type that is well-focused on your reference. For example, ServiceReferences for admission registration: https://github.com/kubernetes/api/blob/release-1.17/admissionregistration/v1/types.go#L533 . +structType=atomic - `name` string — Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +optional +default="" +kubebuilder:default="" TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896. - `readOnly` boolean — readOnly specifies a read-only configuration for the volume. Defaults to false (read/write). +optional - `volumeAttributes` object — volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values. +optional - `downwardAPI` DownwardAPIVolumeSource — Downward API volumes support ownership management and SELinux relabeling. - `defaultMode` integer — Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. +optional - `items` DownwardAPIVolumeFile[] — Items is a list of downward API volume file +optional +listType=atomic - `fieldRef` ObjectFieldSelector — +structType=atomic - … - `mode` integer — Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. +optional - `path` string — Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' - `resourceFieldRef` ResourceFieldSelector — ResourceFieldSelector represents container resources (cpu, memory) and their output format +structType=atomic - … - `emptyDir` EmptyDirVolumeSource — Empty directory volumes support ownership management and SELinux relabeling. - `medium` string - `sizeLimit` Quantity — The serialization format is: ``` ::= (Note that may be empty, from the "" case in .) ::= 0 | 1 | ... | 9 ::= | ::= | . | . | . ::= "+" | "-" ::= | ::= | | ::= Ki | Mi | Gi | Ti | Pi | Ei (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) ::= m | "" | k | M | G | T | P | E (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) ::= "e" | "E" ``` No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities. When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized. Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: No precision is lost No fractional digits will be emitted The exponent (or suffix) is as large as possible. The sign will be omitted unless the number is negative. Examples: 1.5 will be serialized as "1500m" 1.5Gi will be serialized as "1536Mi" Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise. Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.) This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation. +protobuf=true +protobuf.embed=string +protobuf.options.marshal=false +protobuf.options.(gogoproto.goproto_stringer)=false +k8s:deepcopy-gen=true +k8s:openapi-gen=true - `ephemeral` EphemeralVolumeSource - `volumeClaimTemplate` PersistentVolumeClaimTemplate — PersistentVolumeClaimTemplate is used to produce PersistentVolumeClaim objects as part of an EphemeralVolumeSource. - `annotations` object — Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations +optional - `creationTimestamp` string — CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional - `deletionGracePeriodSeconds` integer — Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. +optional - `deletionTimestamp` string — DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional - `finalizers` string[] — Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. +optional +patchStrategy=merge +listType=set - `generateName` string — GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will return a 409. Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency +optional - `generation` integer — A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. +optional - `labels` object — Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels +optional - `managedFields` ManagedFieldsEntry[] — ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object. +optional +listType=atomic - … - `name` string — Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names +optional - `namespace` string — Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces +optional - `ownerReferences` OwnerReference[] — List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. +optional +patchMergeKey=uid +patchStrategy=merge +listType=map +listMapKey=uid - … - `resourceVersion` string — An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency +optional - `selfLink` string — Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. +optional - `spec` PersistentVolumeClaimSpec — PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes - … - `uid` string — UID is a type that holds unique ID values, including UUIDs. Because we don't ONLY use UUIDs, this is an alias to string. Being a type captures intent and helps make sure that UIDs and names do not get conflated. - `fc` FCVolumeSource — Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling. - `fsType` string — fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. TODO: how do we prevent errors in the filesystem from compromising the machine +optional - `lun` integer — lun is Optional: FC target lun number +optional - `readOnly` boolean — readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. +optional - `targetWWNs` string[] — targetWWNs is Optional: FC target worldwide names (WWNs) +optional +listType=atomic - `wwids` string[] — wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously. +optional +listType=atomic - `flexVolume` FlexVolumeSource — FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. - `driver` string — driver is the name of the driver to use for this volume. - `fsType` string — fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script. +optional - `options` object — options is Optional: this field holds extra command options if any. +optional - `readOnly` boolean — readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. +optional - `secretRef` LocalObjectReference — New uses of this type are discouraged because of difficulty describing its usage when embedded in APIs. 1. Invalid usage help. It is impossible to add specific help for individual usage. In most embedded usages, there are particular restrictions like, "must refer only to types A and B" or "UID not honored" or "name must be restricted". Those cannot be well described when embedded. 2. Inconsistent validation. Because the usages are different, the validation rules are different by usage, which makes it hard for users to predict what will happen. 3. We cannot easily change it. Because this type is embedded in many locations, updates to this type will affect numerous schemas. Don't make new APIs embed an underspecified API type they do not control. Instead of using this type, create a locally provided and used type that is well-focused on your reference. For example, ServiceReferences for admission registration: https://github.com/kubernetes/api/blob/release-1.17/admissionregistration/v1/types.go#L533 . +structType=atomic - `name` string — Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +optional +default="" +kubebuilder:default="" TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896. - `flocker` FlockerVolumeSource — One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling. - `datasetName` string — datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated +optional - `datasetUUID` string — datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset +optional - `gcePersistentDisk` GCEPersistentDiskVolumeSource — A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling. - `fsType` string — fsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk TODO: how do we prevent errors in the filesystem from compromising the machine +optional - `partition` integer — partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk +optional - `pdName` string — pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk - `readOnly` boolean — readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk +optional - `gitRepo` GitRepoVolumeSource — DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container. - `directory` string — directory is the target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name. +optional - `repository` string — repository is the URL - `revision` string — revision is the commit hash for the specified revision. +optional - `glusterfs` GlusterfsVolumeSource — Glusterfs volumes do not support ownership management or SELinux relabeling. - `endpoints` string — endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod - `path` string — path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod - `readOnly` boolean — readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod +optional - `hostPath` HostPathVolumeSource — Host path volumes do not support ownership management or SELinux relabeling. - `path` string — path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath - `type` string — +enum - `image` ImageVolumeSource - `pullPolicy` string — PullPolicy describes a policy for if/when to pull a container image +enum - `reference` string — Required: Image or artifact reference to be used. Behaves in the same way as pod.spec.containers[*].image. Pull secrets will be assembled in the same way as for the container image by looking up node credentials, SA image pull secrets, and pod spec image pull secrets. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets. +optional - `iscsi` ISCSIVolumeSource — ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling. - `chapAuthDiscovery` boolean — chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication +optional - `chapAuthSession` boolean — chapAuthSession defines whether support iSCSI Session CHAP authentication +optional - `fsType` string — fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi TODO: how do we prevent errors in the filesystem from compromising the machine +optional - `initiatorName` string — initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection. +optional - `iqn` string — iqn is the target iSCSI Qualified Name. - `iscsiInterface` string — iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp). +optional +default="default" - `lun` integer — lun represents iSCSI Target Lun number. - `portals` string[] — portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). +optional +listType=atomic - `readOnly` boolean — readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. +optional - `secretRef` LocalObjectReference — New uses of this type are discouraged because of difficulty describing its usage when embedded in APIs. 1. Invalid usage help. It is impossible to add specific help for individual usage. In most embedded usages, there are particular restrictions like, "must refer only to types A and B" or "UID not honored" or "name must be restricted". Those cannot be well described when embedded. 2. Inconsistent validation. Because the usages are different, the validation rules are different by usage, which makes it hard for users to predict what will happen. 3. We cannot easily change it. Because this type is embedded in many locations, updates to this type will affect numerous schemas. Don't make new APIs embed an underspecified API type they do not control. Instead of using this type, create a locally provided and used type that is well-focused on your reference. For example, ServiceReferences for admission registration: https://github.com/kubernetes/api/blob/release-1.17/admissionregistration/v1/types.go#L533 . +structType=atomic - `name` string — Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +optional +default="" +kubebuilder:default="" TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896. - `targetPortal` string — targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). - `name` string — name of the volume. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - `nfs` NFSVolumeSource — NFS volumes do not support ownership management or SELinux relabeling. - `path` string — path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs - `readOnly` boolean — readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs +optional - `server` string — server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs - `persistentVolumeClaim` PersistentVolumeClaimVolumeSource — This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system). - `claimName` string — claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims - `readOnly` boolean — readOnly Will force the ReadOnly setting in VolumeMounts. Default false. +optional - `photonPersistentDisk` PhotonPersistentDiskVolumeSource - `fsType` string — fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. - `pdID` string — pdID is the ID that identifies Photon Controller persistent disk - `portworxVolume` PortworxVolumeSource - `fsType` string — fSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified. - `readOnly` boolean — readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. +optional - `volumeID` string — volumeID uniquely identifies a Portworx volume - `projected` ProjectedVolumeSource — Represents a projected volume source - `defaultMode` integer — defaultMode are the mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. +optional - `sources` VolumeProjection[] — sources is the list of volume projections. Each entry in this list handles one source. +optional +listType=atomic - `clusterTrustBundle` ClusterTrustBundleProjection — ClusterTrustBundleProjection describes how to select a set of ClusterTrustBundle objects and project their contents into the pod filesystem. - … - `configMap` ConfigMapProjection — The contents of the target ConfigMap's Data field will be presented in a projected volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. Note that this is identical to a configmap volume source without the default mode. - … - `downwardAPI` DownwardAPIProjection — Note that this is identical to a downwardAPI volume source without the default mode. - … - `secret` SecretProjection — The contents of the target Secret's Data field will be presented in a projected volume as files using the keys in the Data field as the file names. Note that this is identical to a secret volume source without the default mode. - … - `serviceAccountToken` ServiceAccountTokenProjection — ServiceAccountTokenProjection represents a projected service account token volume. This projection can be used to insert a service account token into the pods runtime filesystem for use against APIs (Kubernetes API Server or otherwise). - … - `quobyte` QuobyteVolumeSource — Quobyte volumes do not support ownership management or SELinux relabeling. - `group` string — group to map volume access to Default is no group +optional - `readOnly` boolean — readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false. +optional - `registry` string — registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes - `tenant` string — tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin +optional - `user` string — user to map volume access to Defaults to serivceaccount user +optional - `volume` string — volume is a string that references an already created Quobyte volume by name. - `rbd` RBDVolumeSource — RBD volumes support ownership management and SELinux relabeling. - `fsType` string — fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd TODO: how do we prevent errors in the filesystem from compromising the machine +optional - `image` string — image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it - `keyring` string — keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it +optional +default="/etc/ceph/keyring" - `monitors` string[] — monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it +listType=atomic - `pool` string — pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it +optional +default="rbd" - `readOnly` boolean — readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it +optional - `secretRef` LocalObjectReference — New uses of this type are discouraged because of difficulty describing its usage when embedded in APIs. 1. Invalid usage help. It is impossible to add specific help for individual usage. In most embedded usages, there are particular restrictions like, "must refer only to types A and B" or "UID not honored" or "name must be restricted". Those cannot be well described when embedded. 2. Inconsistent validation. Because the usages are different, the validation rules are different by usage, which makes it hard for users to predict what will happen. 3. We cannot easily change it. Because this type is embedded in many locations, updates to this type will affect numerous schemas. Don't make new APIs embed an underspecified API type they do not control. Instead of using this type, create a locally provided and used type that is well-focused on your reference. For example, ServiceReferences for admission registration: https://github.com/kubernetes/api/blob/release-1.17/admissionregistration/v1/types.go#L533 . +structType=atomic - `name` string — Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +optional +default="" +kubebuilder:default="" TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896. - `user` string — user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it +optional +default="admin" - `scaleIO` ScaleIOVolumeSource — ScaleIOVolumeSource represents a persistent ScaleIO volume - `fsType` string — fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs". +optional +default="xfs" - `gateway` string — gateway is the host address of the ScaleIO API Gateway. - `protectionDomain` string — protectionDomain is the name of the ScaleIO Protection Domain for the configured storage. +optional - `readOnly` boolean — readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. +optional - `secretRef` LocalObjectReference — New uses of this type are discouraged because of difficulty describing its usage when embedded in APIs. 1. Invalid usage help. It is impossible to add specific help for individual usage. In most embedded usages, there are particular restrictions like, "must refer only to types A and B" or "UID not honored" or "name must be restricted". Those cannot be well described when embedded. 2. Inconsistent validation. Because the usages are different, the validation rules are different by usage, which makes it hard for users to predict what will happen. 3. We cannot easily change it. Because this type is embedded in many locations, updates to this type will affect numerous schemas. Don't make new APIs embed an underspecified API type they do not control. Instead of using this type, create a locally provided and used type that is well-focused on your reference. For example, ServiceReferences for admission registration: https://github.com/kubernetes/api/blob/release-1.17/admissionregistration/v1/types.go#L533 . +structType=atomic - `name` string — Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +optional +default="" +kubebuilder:default="" TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896. - `sslEnabled` boolean — sslEnabled Flag enable/disable SSL communication with Gateway, default false +optional - `storageMode` string — storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned. +optional +default="ThinProvisioned" - `storagePool` string — storagePool is the ScaleIO Storage Pool associated with the protection domain. +optional - `system` string — system is the name of the storage system as configured in ScaleIO. - `volumeName` string — volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source. - `secret` SecretVolumeSource — The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling. - `defaultMode` integer — defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. +optional - `items` KeyToPath[] — items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. +optional +listType=atomic - `key` string — key is the key to project. - `mode` integer — mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. +optional - `path` string — path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. - `optional` boolean — optional field specify whether the Secret or its keys must be defined +optional - `secretName` string — secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret +optional - `storageos` StorageOSVolumeSource - `fsType` string — fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. +optional - `readOnly` boolean — readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. +optional - `secretRef` LocalObjectReference — New uses of this type are discouraged because of difficulty describing its usage when embedded in APIs. 1. Invalid usage help. It is impossible to add specific help for individual usage. In most embedded usages, there are particular restrictions like, "must refer only to types A and B" or "UID not honored" or "name must be restricted". Those cannot be well described when embedded. 2. Inconsistent validation. Because the usages are different, the validation rules are different by usage, which makes it hard for users to predict what will happen. 3. We cannot easily change it. Because this type is embedded in many locations, updates to this type will affect numerous schemas. Don't make new APIs embed an underspecified API type they do not control. Instead of using this type, create a locally provided and used type that is well-focused on your reference. For example, ServiceReferences for admission registration: https://github.com/kubernetes/api/blob/release-1.17/admissionregistration/v1/types.go#L533 . +structType=atomic - `name` string — Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +optional +default="" +kubebuilder:default="" TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896. - `volumeName` string — volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace. - `volumeNamespace` string — volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created. +optional - `vsphereVolume` VsphereVirtualDiskVolumeSource - `fsType` string — fsType is filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. +optional - `storagePolicyID` string — storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName. +optional - `storagePolicyName` string — storagePolicyName is the storage Policy Based Management (SPBM) profile name. +optional - `volumePath` string — volumePath is the path that identifies vSphere volume vmdk - `status` PodStatus — PodStatus represents information about the status of a pod. Status may trail the actual state of a system, especially if the node that hosts the pod cannot contact the control plane. - `conditions` PodCondition[] — Current service state of pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions +optional +patchMergeKey=type +patchStrategy=merge +listType=map +listMapKey=type - `lastProbeTime` string — Last time we probed the condition. +optional - `lastTransitionTime` string — Last time the condition transitioned from one status to another. +optional - `message` string — Human-readable message indicating details about last transition. +optional - `observedGeneration` integer — If set, this represents the .metadata.generation that the pod condition was set based upon. This is an alpha field. Enable PodObservedGenerationTracking to be able to use this field. +featureGate=PodObservedGenerationTracking +optional - `reason` string — Unique, one-word, CamelCase reason for the condition's last transition. +optional - `status` string - `type` string — PodConditionType is a valid value for PodCondition.Type - `containerStatuses` ContainerStatus[] — Statuses of containers in this pod. Each container in the pod should have at most one status in this list, and all statuses should be for containers in the pod. However this is not enforced. If a status for a non-existent container is present in the list, or the list has duplicate names, the behavior of various Kubernetes components is not defined and those statuses might be ignored. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status +optional +listType=atomic - `allocatedResources` ResourceList - `allocatedResourcesStatus` ResourceStatus[] — AllocatedResourcesStatus represents the status of various resources allocated for this Pod. +featureGate=ResourceHealthStatus +optional +patchMergeKey=name +patchStrategy=merge +listType=map +listMapKey=name - `name` string - `resources` ResourceHealth[] — List of unique resources health. Each element in the list contains an unique resource ID and its health. At a minimum, for the lifetime of a Pod, resource ID must uniquely identify the resource allocated to the Pod on the Node. If other Pod on the same Node reports the status with the same resource ID, it must be the same resource they share. See ResourceID type definition for a specific format it has in various use cases. +listType=map +listMapKey=resourceID - `health` string - `resourceID` string — DeviceID, where DeviceID is from the Device structure of DevicePlugin's ListAndWatchResponse type: https://github.com/kubernetes/kubernetes/blob/eda1c780543a27c078450e2f17d674471e00f494/staging/src/k8s.io/kubelet/pkg/apis/deviceplugin/v1alpha/api.proto#L61-L73 DevicePlugin ID is usually a constant for the lifetime of a Node and typically can be used to uniquely identify the device on the node. For DRA: //: such a device can be looked up in the information published by that DRA driver to learn more about it. It is designed to be globally unique in a cluster. - `containerID` string — ContainerID is the ID of the container in the format '://'. Where type is a container runtime identifier, returned from Version call of CRI API (for example "containerd"). +optional - `image` string — Image is the name of container image that the container is running. The container image may not match the image used in the PodSpec, as it may have been resolved by the runtime. More info: https://kubernetes.io/docs/concepts/containers/images. - `imageID` string — ImageID is the image ID of the container's image. The image ID may not match the image ID of the image used in the PodSpec, as it may have been resolved by the runtime. - `lastState` ContainerState — Only one of its members may be specified. If none of them is specified, the default one is ContainerStateWaiting. - `running` ContainerStateRunning - `startedAt` string — Time at which the container was last (re-)started +optional - `terminated` ContainerStateTerminated - `containerID` string — Container's ID in the format '://' +optional - `exitCode` integer — Exit status from the last termination of the container - `finishedAt` string — Time at which the container last terminated +optional - `message` string — Message regarding the last termination of the container +optional - `reason` string — (brief) reason from the last termination of the container +optional - `signal` integer — Signal from the last termination of the container +optional - `startedAt` string — Time at which previous execution of the container started +optional - `waiting` ContainerStateWaiting - `message` string — Message regarding why the container is not yet running. +optional - `reason` string — (brief) reason the container is not yet running. +optional - `name` string — Name is a DNS_LABEL representing the unique name of the container. Each container in a pod must have a unique name across all container types. Cannot be updated. - `ready` boolean — Ready specifies whether the container is currently passing its readiness check. The value will change as readiness probes keep executing. If no readiness probes are specified, this field defaults to true once the container is fully started (see Started field). The value is typically used to determine whether a container is ready to accept traffic. - `resources` ResourceRequirements - `claims` ResourceClaim[] — Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers. +listType=map +listMapKey=name +featureGate=DynamicResourceAllocation +optional - `name` string — Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container. - `request` string — Request is the name chosen for a request in the referenced claim. If empty, everything from the claim is made available, otherwise only the result of this request. +optional - `limits` ResourceList - `requests` ResourceList - `restartCount` integer — RestartCount holds the number of times the container has been restarted. Kubelet makes an effort to always increment the value, but there are cases when the state may be lost due to node restarts and then the value may be reset to 0. The value is never negative. - `started` boolean — Started indicates whether the container has finished its postStart lifecycle hook and passed its startup probe. Initialized as false, becomes true after startupProbe is considered successful. Resets to false when the container is restarted, or if kubelet loses state temporarily. In both cases, startup probes will run again. Is always true when no startupProbe is defined and container is running and has passed the postStart lifecycle hook. The null value must be treated the same as false. +optional - `state` ContainerState — Only one of its members may be specified. If none of them is specified, the default one is ContainerStateWaiting. - `running` ContainerStateRunning - `startedAt` string — Time at which the container was last (re-)started +optional - `terminated` ContainerStateTerminated - `containerID` string — Container's ID in the format '://' +optional - `exitCode` integer — Exit status from the last termination of the container - `finishedAt` string — Time at which the container last terminated +optional - `message` string — Message regarding the last termination of the container +optional - `reason` string — (brief) reason from the last termination of the container +optional - `signal` integer — Signal from the last termination of the container +optional - `startedAt` string — Time at which previous execution of the container started +optional - `waiting` ContainerStateWaiting - `message` string — Message regarding why the container is not yet running. +optional - `reason` string — (brief) reason the container is not yet running. +optional - `stopSignal` string — Signal defines the stop signal of containers +enum - `user` ContainerUser — ContainerUser represents user identity information - `linux` LinuxContainerUser — LinuxContainerUser represents user identity information in Linux containers - `gid` integer — GID is the primary gid initially attached to the first process in the container - `supplementalGroups` integer[] — SupplementalGroups are the supplemental groups initially attached to the first process in the container +optional +listType=atomic - `uid` integer — UID is the primary uid initially attached to the first process in the container - `volumeMounts` VolumeMountStatus[] — Status of volume mounts. +optional +patchMergeKey=mountPath +patchStrategy=merge +listType=map +listMapKey=mountPath +featureGate=RecursiveReadOnlyMounts - `mountPath` string — MountPath corresponds to the original VolumeMount. - `name` string — Name corresponds to the name of the original VolumeMount. - `readOnly` boolean — ReadOnly corresponds to the original VolumeMount. +optional - `recursiveReadOnly` string - `ephemeralContainerStatuses` ContainerStatus[] — Statuses for any ephemeral containers that have run in this pod. Each ephemeral container in the pod should have at most one status in this list, and all statuses should be for containers in the pod. However this is not enforced. If a status for a non-existent container is present in the list, or the list has duplicate names, the behavior of various Kubernetes components is not defined and those statuses might be ignored. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status +optional +listType=atomic - `allocatedResources` ResourceList - `allocatedResourcesStatus` ResourceStatus[] — AllocatedResourcesStatus represents the status of various resources allocated for this Pod. +featureGate=ResourceHealthStatus +optional +patchMergeKey=name +patchStrategy=merge +listType=map +listMapKey=name - `name` string - `resources` ResourceHealth[] — List of unique resources health. Each element in the list contains an unique resource ID and its health. At a minimum, for the lifetime of a Pod, resource ID must uniquely identify the resource allocated to the Pod on the Node. If other Pod on the same Node reports the status with the same resource ID, it must be the same resource they share. See ResourceID type definition for a specific format it has in various use cases. +listType=map +listMapKey=resourceID - `health` string - `resourceID` string — DeviceID, where DeviceID is from the Device structure of DevicePlugin's ListAndWatchResponse type: https://github.com/kubernetes/kubernetes/blob/eda1c780543a27c078450e2f17d674471e00f494/staging/src/k8s.io/kubelet/pkg/apis/deviceplugin/v1alpha/api.proto#L61-L73 DevicePlugin ID is usually a constant for the lifetime of a Node and typically can be used to uniquely identify the device on the node. For DRA: //: such a device can be looked up in the information published by that DRA driver to learn more about it. It is designed to be globally unique in a cluster. - `containerID` string — ContainerID is the ID of the container in the format '://'. Where type is a container runtime identifier, returned from Version call of CRI API (for example "containerd"). +optional - `image` string — Image is the name of container image that the container is running. The container image may not match the image used in the PodSpec, as it may have been resolved by the runtime. More info: https://kubernetes.io/docs/concepts/containers/images. - `imageID` string — ImageID is the image ID of the container's image. The image ID may not match the image ID of the image used in the PodSpec, as it may have been resolved by the runtime. - `lastState` ContainerState — Only one of its members may be specified. If none of them is specified, the default one is ContainerStateWaiting. - `running` ContainerStateRunning - `startedAt` string — Time at which the container was last (re-)started +optional - `terminated` ContainerStateTerminated - `containerID` string — Container's ID in the format '://' +optional - `exitCode` integer — Exit status from the last termination of the container - `finishedAt` string — Time at which the container last terminated +optional - `message` string — Message regarding the last termination of the container +optional - `reason` string — (brief) reason from the last termination of the container +optional - `signal` integer — Signal from the last termination of the container +optional - `startedAt` string — Time at which previous execution of the container started +optional - `waiting` ContainerStateWaiting - `message` string — Message regarding why the container is not yet running. +optional - `reason` string — (brief) reason the container is not yet running. +optional - `name` string — Name is a DNS_LABEL representing the unique name of the container. Each container in a pod must have a unique name across all container types. Cannot be updated. - `ready` boolean — Ready specifies whether the container is currently passing its readiness check. The value will change as readiness probes keep executing. If no readiness probes are specified, this field defaults to true once the container is fully started (see Started field). The value is typically used to determine whether a container is ready to accept traffic. - `resources` ResourceRequirements - `claims` ResourceClaim[] — Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers. +listType=map +listMapKey=name +featureGate=DynamicResourceAllocation +optional - `name` string — Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container. - `request` string — Request is the name chosen for a request in the referenced claim. If empty, everything from the claim is made available, otherwise only the result of this request. +optional - `limits` ResourceList - `requests` ResourceList - `restartCount` integer — RestartCount holds the number of times the container has been restarted. Kubelet makes an effort to always increment the value, but there are cases when the state may be lost due to node restarts and then the value may be reset to 0. The value is never negative. - `started` boolean — Started indicates whether the container has finished its postStart lifecycle hook and passed its startup probe. Initialized as false, becomes true after startupProbe is considered successful. Resets to false when the container is restarted, or if kubelet loses state temporarily. In both cases, startup probes will run again. Is always true when no startupProbe is defined and container is running and has passed the postStart lifecycle hook. The null value must be treated the same as false. +optional - `state` ContainerState — Only one of its members may be specified. If none of them is specified, the default one is ContainerStateWaiting. - `running` ContainerStateRunning - `startedAt` string — Time at which the container was last (re-)started +optional - `terminated` ContainerStateTerminated - `containerID` string — Container's ID in the format '://' +optional - `exitCode` integer — Exit status from the last termination of the container - `finishedAt` string — Time at which the container last terminated +optional - `message` string — Message regarding the last termination of the container +optional - `reason` string — (brief) reason from the last termination of the container +optional - `signal` integer — Signal from the last termination of the container +optional - `startedAt` string — Time at which previous execution of the container started +optional - `waiting` ContainerStateWaiting - `message` string — Message regarding why the container is not yet running. +optional - `reason` string — (brief) reason the container is not yet running. +optional - `stopSignal` string — Signal defines the stop signal of containers +enum - `user` ContainerUser — ContainerUser represents user identity information - `linux` LinuxContainerUser — LinuxContainerUser represents user identity information in Linux containers - `gid` integer — GID is the primary gid initially attached to the first process in the container - `supplementalGroups` integer[] — SupplementalGroups are the supplemental groups initially attached to the first process in the container +optional +listType=atomic - `uid` integer — UID is the primary uid initially attached to the first process in the container - `volumeMounts` VolumeMountStatus[] — Status of volume mounts. +optional +patchMergeKey=mountPath +patchStrategy=merge +listType=map +listMapKey=mountPath +featureGate=RecursiveReadOnlyMounts - `mountPath` string — MountPath corresponds to the original VolumeMount. - `name` string — Name corresponds to the name of the original VolumeMount. - `readOnly` boolean — ReadOnly corresponds to the original VolumeMount. +optional - `recursiveReadOnly` string - `hostIP` string — hostIP holds the IP address of the host to which the pod is assigned. Empty if the pod has not started yet. A pod can be assigned to a node that has a problem in kubelet which in turns mean that HostIP will not be updated even if there is a node is assigned to pod +optional - `hostIPs` HostIP[] — hostIPs holds the IP addresses allocated to the host. If this field is specified, the first entry must match the hostIP field. This list is empty if the pod has not started yet. A pod can be assigned to a node that has a problem in kubelet which in turns means that HostIPs will not be updated even if there is a node is assigned to this pod. +optional +patchStrategy=merge +patchMergeKey=ip +listType=atomic - `ip` string — IP is the IP address assigned to the host +required - `initContainerStatuses` ContainerStatus[] — Statuses of init containers in this pod. The most recent successful non-restartable init container will have ready = true, the most recently started container will have startTime set. Each init container in the pod should have at most one status in this list, and all statuses should be for containers in the pod. However this is not enforced. If a status for a non-existent container is present in the list, or the list has duplicate names, the behavior of various Kubernetes components is not defined and those statuses might be ignored. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#pod-and-container-status +listType=atomic - `allocatedResources` ResourceList - `allocatedResourcesStatus` ResourceStatus[] — AllocatedResourcesStatus represents the status of various resources allocated for this Pod. +featureGate=ResourceHealthStatus +optional +patchMergeKey=name +patchStrategy=merge +listType=map +listMapKey=name - `name` string - `resources` ResourceHealth[] — List of unique resources health. Each element in the list contains an unique resource ID and its health. At a minimum, for the lifetime of a Pod, resource ID must uniquely identify the resource allocated to the Pod on the Node. If other Pod on the same Node reports the status with the same resource ID, it must be the same resource they share. See ResourceID type definition for a specific format it has in various use cases. +listType=map +listMapKey=resourceID - `health` string - `resourceID` string — DeviceID, where DeviceID is from the Device structure of DevicePlugin's ListAndWatchResponse type: https://github.com/kubernetes/kubernetes/blob/eda1c780543a27c078450e2f17d674471e00f494/staging/src/k8s.io/kubelet/pkg/apis/deviceplugin/v1alpha/api.proto#L61-L73 DevicePlugin ID is usually a constant for the lifetime of a Node and typically can be used to uniquely identify the device on the node. For DRA: //: such a device can be looked up in the information published by that DRA driver to learn more about it. It is designed to be globally unique in a cluster. - `containerID` string — ContainerID is the ID of the container in the format '://'. Where type is a container runtime identifier, returned from Version call of CRI API (for example "containerd"). +optional - `image` string — Image is the name of container image that the container is running. The container image may not match the image used in the PodSpec, as it may have been resolved by the runtime. More info: https://kubernetes.io/docs/concepts/containers/images. - `imageID` string — ImageID is the image ID of the container's image. The image ID may not match the image ID of the image used in the PodSpec, as it may have been resolved by the runtime. - `lastState` ContainerState — Only one of its members may be specified. If none of them is specified, the default one is ContainerStateWaiting. - `running` ContainerStateRunning - `startedAt` string — Time at which the container was last (re-)started +optional - `terminated` ContainerStateTerminated - `containerID` string — Container's ID in the format '://' +optional - `exitCode` integer — Exit status from the last termination of the container - `finishedAt` string — Time at which the container last terminated +optional - `message` string — Message regarding the last termination of the container +optional - `reason` string — (brief) reason from the last termination of the container +optional - `signal` integer — Signal from the last termination of the container +optional - `startedAt` string — Time at which previous execution of the container started +optional - `waiting` ContainerStateWaiting - `message` string — Message regarding why the container is not yet running. +optional - `reason` string — (brief) reason the container is not yet running. +optional - `name` string — Name is a DNS_LABEL representing the unique name of the container. Each container in a pod must have a unique name across all container types. Cannot be updated. - `ready` boolean — Ready specifies whether the container is currently passing its readiness check. The value will change as readiness probes keep executing. If no readiness probes are specified, this field defaults to true once the container is fully started (see Started field). The value is typically used to determine whether a container is ready to accept traffic. - `resources` ResourceRequirements - `claims` ResourceClaim[] — Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers. +listType=map +listMapKey=name +featureGate=DynamicResourceAllocation +optional - `name` string — Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container. - `request` string — Request is the name chosen for a request in the referenced claim. If empty, everything from the claim is made available, otherwise only the result of this request. +optional - `limits` ResourceList - `requests` ResourceList - `restartCount` integer — RestartCount holds the number of times the container has been restarted. Kubelet makes an effort to always increment the value, but there are cases when the state may be lost due to node restarts and then the value may be reset to 0. The value is never negative. - `started` boolean — Started indicates whether the container has finished its postStart lifecycle hook and passed its startup probe. Initialized as false, becomes true after startupProbe is considered successful. Resets to false when the container is restarted, or if kubelet loses state temporarily. In both cases, startup probes will run again. Is always true when no startupProbe is defined and container is running and has passed the postStart lifecycle hook. The null value must be treated the same as false. +optional - `state` ContainerState — Only one of its members may be specified. If none of them is specified, the default one is ContainerStateWaiting. - `running` ContainerStateRunning - `startedAt` string — Time at which the container was last (re-)started +optional - `terminated` ContainerStateTerminated - `containerID` string — Container's ID in the format '://' +optional - `exitCode` integer — Exit status from the last termination of the container - `finishedAt` string — Time at which the container last terminated +optional - `message` string — Message regarding the last termination of the container +optional - `reason` string — (brief) reason from the last termination of the container +optional - `signal` integer — Signal from the last termination of the container +optional - `startedAt` string — Time at which previous execution of the container started +optional - `waiting` ContainerStateWaiting - `message` string — Message regarding why the container is not yet running. +optional - `reason` string — (brief) reason the container is not yet running. +optional - `stopSignal` string — Signal defines the stop signal of containers +enum - `user` ContainerUser — ContainerUser represents user identity information - `linux` LinuxContainerUser — LinuxContainerUser represents user identity information in Linux containers - `gid` integer — GID is the primary gid initially attached to the first process in the container - `supplementalGroups` integer[] — SupplementalGroups are the supplemental groups initially attached to the first process in the container +optional +listType=atomic - `uid` integer — UID is the primary uid initially attached to the first process in the container - `volumeMounts` VolumeMountStatus[] — Status of volume mounts. +optional +patchMergeKey=mountPath +patchStrategy=merge +listType=map +listMapKey=mountPath +featureGate=RecursiveReadOnlyMounts - `mountPath` string — MountPath corresponds to the original VolumeMount. - `name` string — Name corresponds to the name of the original VolumeMount. - `readOnly` boolean — ReadOnly corresponds to the original VolumeMount. +optional - `recursiveReadOnly` string - `message` string — A human readable message indicating details about why the pod is in this condition. +optional - `nominatedNodeName` string — nominatedNodeName is set only when this pod preempts other pods on the node, but it cannot be scheduled right away as preemption victims receive their graceful termination periods. This field does not guarantee that the pod will be scheduled on this node. Scheduler may decide to place the pod elsewhere if other nodes become available sooner. Scheduler may also decide to give the resources on this node to a higher priority pod that is created after preemption. As a result, this field may be different than PodSpec.nodeName when the pod is scheduled. +optional - `observedGeneration` integer — If set, this represents the .metadata.generation that the pod status was set based upon. This is an alpha field. Enable PodObservedGenerationTracking to be able to use this field. +featureGate=PodObservedGenerationTracking +optional - `phase` string — +enum - `podIP` string — podIP address allocated to the pod. Routable at least within the cluster. Empty if not yet allocated. +optional - `podIPs` PodIP[] — podIPs holds the IP addresses allocated to the pod. If this field is specified, the 0th entry must match the podIP field. Pods may be allocated at most 1 value for each of IPv4 and IPv6. This list is empty if no IPs have been allocated yet. +optional +patchStrategy=merge +patchMergeKey=ip +listType=map +listMapKey=ip - `ip` string — IP is the IP address assigned to the pod +required - `qosClass` string — +enum - `reason` string — A brief CamelCase message indicating details about why the pod is in this state. e.g. 'Evicted' +optional - `resize` string - `resourceClaimStatuses` PodResourceClaimStatus[] — Status of resource claims. +patchMergeKey=name +patchStrategy=merge,retainKeys +listType=map +listMapKey=name +featureGate=DynamicResourceAllocation +optional - `name` string — Name uniquely identifies this resource claim inside the pod. This must match the name of an entry in pod.spec.resourceClaims, which implies that the string must be a DNS_LABEL. - `resourceClaimName` string — ResourceClaimName is the name of the ResourceClaim that was generated for the Pod in the namespace of the Pod. If this is unset, then generating a ResourceClaim was not necessary. The pod.spec.resourceClaims entry can be ignored in this case. +optional - `startTime` string — RFC 3339 date and time at which the object was acknowledged by the Kubelet. This is before the Kubelet pulled the container image(s) for the pod. +optional - `uid` string — UID is a type that holds unique ID values, including UUIDs. Because we don't ONLY use UUIDs, this is an alias to string. Being a type captures intent and helps make sure that UIDs and names do not get conflated. - `podEvents` Event[] - `action` string — What action was taken/failed regarding to the Regarding object. +optional - `annotations` object — Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations +optional - `apiVersion` string — APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +optional - `count` integer — The number of times this event has occurred. +optional - `creationTimestamp` string — CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional - `deletionGracePeriodSeconds` integer — Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. +optional - `deletionTimestamp` string — DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional - `eventTime` string — Time when this Event was first observed. +optional - `finalizers` string[] — Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. +optional +patchStrategy=merge +listType=set - `firstTimestamp` string — The time at which the event was first recorded. (Time of server receipt is in TypeMeta.) +optional - `generateName` string — GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will return a 409. Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency +optional - `generation` integer — A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. +optional - `involvedObject` ObjectReference — New uses of this type are discouraged because of difficulty describing its usage when embedded in APIs. 1. Ignored fields. It includes many fields which are not generally honored. For instance, ResourceVersion and FieldPath are both very rarely valid in actual usage. 2. Invalid usage help. It is impossible to add specific help for individual usage. In most embedded usages, there are particular restrictions like, "must refer only to types A and B" or "UID not honored" or "name must be restricted". Those cannot be well described when embedded. 3. Inconsistent validation. Because the usages are different, the validation rules are different by usage, which makes it hard for users to predict what will happen. 4. The fields are both imprecise and overly precise. Kind is not a precise mapping to a URL. This can produce ambiguity during interpretation and require a REST mapping. In most cases, the dependency is on the group,resource tuple and the version of the actual struct is irrelevant. 5. We cannot easily change it. Because this type is embedded in many locations, updates to this type will affect numerous schemas. Don't make new APIs embed an underspecified API type they do not control. Instead of using this type, create a locally provided and used type that is well-focused on your reference. For example, ServiceReferences for admission registration: https://github.com/kubernetes/api/blob/release-1.17/admissionregistration/v1/types.go#L533 . +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object +structType=atomic - `apiVersion` string — API version of the referent. +optional - `fieldPath` string — If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future. +optional - `kind` string — Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional - `name` string — Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +optional - `namespace` string — Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ +optional - `resourceVersion` string — Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency +optional - `uid` string — UID is a type that holds unique ID values, including UUIDs. Because we don't ONLY use UUIDs, this is an alias to string. Being a type captures intent and helps make sure that UIDs and names do not get conflated. - `kind` string — Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional - `labels` object — Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels +optional - `lastTimestamp` string — The time at which the most recent occurrence of this event was recorded. +optional - `managedFields` ManagedFieldsEntry[] — ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object. +optional +listType=atomic - `apiVersion` string — APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted. - `fieldsType` string — FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1" - `fieldsV1` FieldsV1 — Each key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:', where is the name of a field in a struct, or key in a map 'v:', where is the exact json formatted value of a list item 'i:', where is position of a item in a list 'k:', where is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set. The exact format is defined in sigs.k8s.io/structured-merge-diff +protobuf.options.(gogoproto.goproto_stringer)=false - `manager` string — Manager is an identifier of the workflow managing these fields. - `operation` string - `subresource` string — Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource. - `time` string — Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over. +optional - `message` string — A human-readable description of the status of this operation. TODO: decide on maximum length. +optional - `name` string — Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names +optional - `namespace` string — Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces +optional - `ownerReferences` OwnerReference[] — List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. +optional +patchMergeKey=uid +patchStrategy=merge +listType=map +listMapKey=uid - `apiVersion` string — API version of the referent. - `blockOwnerDeletion` boolean — If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. +optional - `controller` boolean — If true, this reference points to the managing controller. +optional - `kind` string — Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - `name` string — Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names - `uid` string — UID is a type that holds unique ID values, including UUIDs. Because we don't ONLY use UUIDs, this is an alias to string. Being a type captures intent and helps make sure that UIDs and names do not get conflated. - `reason` string — This should be a short, machine understandable string that gives the reason for the transition into the object's current status. TODO: provide exact specification for format. +optional - `related` ObjectReference — New uses of this type are discouraged because of difficulty describing its usage when embedded in APIs. 1. Ignored fields. It includes many fields which are not generally honored. For instance, ResourceVersion and FieldPath are both very rarely valid in actual usage. 2. Invalid usage help. It is impossible to add specific help for individual usage. In most embedded usages, there are particular restrictions like, "must refer only to types A and B" or "UID not honored" or "name must be restricted". Those cannot be well described when embedded. 3. Inconsistent validation. Because the usages are different, the validation rules are different by usage, which makes it hard for users to predict what will happen. 4. The fields are both imprecise and overly precise. Kind is not a precise mapping to a URL. This can produce ambiguity during interpretation and require a REST mapping. In most cases, the dependency is on the group,resource tuple and the version of the actual struct is irrelevant. 5. We cannot easily change it. Because this type is embedded in many locations, updates to this type will affect numerous schemas. Don't make new APIs embed an underspecified API type they do not control. Instead of using this type, create a locally provided and used type that is well-focused on your reference. For example, ServiceReferences for admission registration: https://github.com/kubernetes/api/blob/release-1.17/admissionregistration/v1/types.go#L533 . +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object +structType=atomic - `apiVersion` string — API version of the referent. +optional - `fieldPath` string — If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future. +optional - `kind` string — Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional - `name` string — Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +optional - `namespace` string — Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ +optional - `resourceVersion` string — Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency +optional - `uid` string — UID is a type that holds unique ID values, including UUIDs. Because we don't ONLY use UUIDs, this is an alias to string. Being a type captures intent and helps make sure that UIDs and names do not get conflated. - `reportingComponent` string — Name of the controller that emitted this Event, e.g. `kubernetes.io/kubelet`. +optional - `reportingInstance` string — ID of the controller instance, e.g. `kubelet-xyzf`. +optional - `resourceVersion` string — An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency +optional - `selfLink` string — Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. +optional - `series` EventSeries — EventSeries contain information on series of events, i.e. thing that was/is happening continuously for some time. - `count` integer — Number of occurrences in this series up to the last heartbeat time - `lastObservedTime` string — Time of the last occurrence observed - `source` EventSource - `component` string — Component from which the event is generated. +optional - `host` string — Node name on which the event is generated. +optional - `type` string — Type of this event (Normal, Warning), new types could be added in the future +optional - `uid` string — UID is a type that holds unique ID values, including UUIDs. Because we don't ONLY use UUIDs, this is an alias to string. Being a type captures intent and helps make sure that UIDs and names do not get conflated. - `success` boolean ## Other responses - `400` — Returned on bad input - `401` — Return if the caller is not authorized - `403` — Returned if the caller does not have the needed permission - `404` — Returned on resource not found --- [API](https://skmtc.net/replicated/apis/vendor-api-v3-2.md) · [All operations](https://skmtc.net/replicated/apis/vendor-api-v3-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/replicated/vendor-api-v3-2/versions/6fcf9e54aba4/schema)