Skip to content

Instantly share code, notes, and snippets.

@sebhoss

sebhoss/schema.json

Created October 27, 2022 06:01
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save sebhoss/886a7588ffff04aca04f9a88a3748503 to your computer and use it in GitHub Desktop.
Save sebhoss/886a7588ffff04aca04f9a88a3748503 to your computer and use it in GitHub Desktop.
Download ZIP
terraform providers schema -json
Raw
schema.json
{
"version": 0,
"block": {
"attributes": {
"api_version": {
"type": "string",
"description": "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",
"description_kind": "markdown",
"computed": true
},
"id": {
"type": "number",
"description": "The timestamp of the last change to this resource.",
"description_kind": "markdown",
"computed": true
},
"kind": {
"type": "string",
"description": "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",
"description_kind": "markdown",
"computed": true
},
"metadata": {
"nested_type": {
"attributes": {
"annotations": {
"type": [
"map",
"string"
],
"description": "Keys and values that can be used by external tooling to store and retrieve arbitrary metadata about this object. See https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/ for more details.",
"description_kind": "markdown",
"optional": true
},
"labels": {
"type": [
"map",
"string"
],
"description": "Keys and values that can be used to organize and categorize objects. See https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ for more details.",
"description_kind": "markdown",
"optional": true
},
"name": {
"type": "string",
"description": "Unique identifier for this object. See https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names for more details.",
"description_kind": "markdown",
"required": true
},
"namespace": {
"type": "string",
"description": "Namespaces provides a mechanism for isolating groups of resources within a single cluster. See https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ for more details.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "Data that helps uniquely identify this object. See https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#metadata for more details.",
"description_kind": "markdown",
"required": true
},
"spec": {
"nested_type": {
"attributes": {
"min_ready_seconds": {
"type": "number",
"description": "Minimum number of seconds for which a newly created pod should be ready without any of its container crashing for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)",
"description_kind": "markdown",
"optional": true
},
"persistent_volume_claim_retention_policy": {
"nested_type": {
"attributes": {
"when_deleted": {
"type": "string",
"description": "WhenDeleted specifies what happens to PVCs created from StatefulSet VolumeClaimTemplates when the StatefulSet is deleted. The default policy of 'Retain' causes PVCs to not be affected by StatefulSet deletion. The 'Delete' policy causes those PVCs to be deleted.",
"description_kind": "markdown",
"optional": true
},
"when_scaled": {
"type": "string",
"description": "WhenScaled specifies what happens to PVCs created from StatefulSet VolumeClaimTemplates when the StatefulSet is scaled down. The default policy of 'Retain' causes PVCs to not be affected by a scaledown. The 'Delete' policy causes the associated PVCs for any excess pods above the replica count to be deleted.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "StatefulSetPersistentVolumeClaimRetentionPolicy describes the policy used for PVCs created from the StatefulSet VolumeClaimTemplates.",
"description_kind": "markdown",
"optional": true
},
"pod_management_policy": {
"type": "string",
"description": "podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. The default policy is 'OrderedReady', where pods are created in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is ready before continuing. When scaling down, the pods are removed in the opposite order. The alternative policy is 'Parallel' which will create pods in parallel to match the desired scale without waiting, and on scale down will delete all pods at once.",
"description_kind": "markdown",
"optional": true
},
"replicas": {
"type": "number",
"description": "replicas is the desired number of replicas of the given Template. These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent identity. If unspecified, defaults to 1.",
"description_kind": "markdown",
"optional": true
},
"revision_history_limit": {
"type": "number",
"description": "revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history. The revision history consists of all revisions not represented by a currently applied StatefulSetSpec version. The default value is 10.",
"description_kind": "markdown",
"optional": true
},
"selector": {
"nested_type": {
"attributes": {
"match_expressions": {
"nested_type": {
"attributes": {
"key": {
"type": "string",
"description": "key is the label key that the selector applies to.",
"description_kind": "markdown",
"required": true
},
"operator": {
"type": "string",
"description": "operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.",
"description_kind": "markdown",
"required": true
},
"values": {
"type": [
"list",
"string"
],
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "list"
},
"description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.",
"description_kind": "markdown",
"optional": true
},
"match_labels": {
"type": [
"map",
"string"
],
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "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.",
"description_kind": "markdown",
"required": true
},
"service_name": {
"type": "string",
"description": "serviceName is the name of the service that governs this StatefulSet. This service must exist before the StatefulSet, and is responsible for the network identity of the set. Pods get DNS/hostnames that follow the pattern: pod-specific-string.serviceName.default.svc.cluster.local where 'pod-specific-string' is managed by the StatefulSet controller.",
"description_kind": "markdown",
"required": true
},
"template": {
"nested_type": {
"attributes": {
"metadata": {
"nested_type": {
"attributes": {
"annotations": {
"type": [
"map",
"string"
],
"description": "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: http://kubernetes.io/docs/user-guide/annotations",
"description_kind": "markdown",
"optional": true
},
"creation_timestamp": {
"type": "string",
"description": "Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.",
"description_kind": "markdown",
"optional": true
},
"deletion_grace_period_seconds": {
"type": "number",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"deletion_timestamp": {
"type": "string",
"description": "Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.",
"description_kind": "markdown",
"optional": true
},
"finalizers": {
"type": [
"list",
"string"
],
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"generate_name": {
"type": "string",
"description": "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",
"description_kind": "markdown",
"optional": true
},
"generation": {
"type": "number",
"description": "A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.",
"description_kind": "markdown",
"optional": true
},
"labels": {
"type": [
"map",
"string"
],
"description": "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: http://kubernetes.io/docs/user-guide/labels",
"description_kind": "markdown",
"optional": true
},
"managed_fields": {
"nested_type": {
"attributes": {
"api_version": {
"type": "string",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"fields_type": {
"type": "string",
"description": "FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: 'FieldsV1'",
"description_kind": "markdown",
"optional": true
},
"fields_v1": {
"type": [
"map",
"string"
],
"description": "FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format.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:<name>', where <name> is the name of a field in a struct, or key in a map 'v:<value>', where <value> is the exact json formatted value of a list item 'i:<index>', where <index> is position of a item in a list 'k:<keys>', where <keys> 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",
"description_kind": "markdown",
"optional": true
},
"manager": {
"type": "string",
"description": "Manager is an identifier of the workflow managing these fields.",
"description_kind": "markdown",
"optional": true
},
"operation": {
"type": "string",
"description": "Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.",
"description_kind": "markdown",
"optional": true
},
"subresource": {
"type": "string",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"time": {
"type": "string",
"description": "Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "list"
},
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"name": {
"type": "string",
"description": "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: http://kubernetes.io/docs/user-guide/identifiers#names",
"description_kind": "markdown",
"optional": true
},
"namespace": {
"type": "string",
"description": "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: http://kubernetes.io/docs/user-guide/namespaces",
"description_kind": "markdown",
"optional": true
},
"owner_references": {
"nested_type": {
"attributes": {
"api_version": {
"type": "string",
"description": "API version of the referent.",
"description_kind": "markdown",
"required": true
},
"block_owner_deletion": {
"type": "bool",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"controller": {
"type": "bool",
"description": "If true, this reference points to the managing controller.",
"description_kind": "markdown",
"optional": true
},
"kind": {
"type": "string",
"description": "Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"description_kind": "markdown",
"required": true
},
"name": {
"type": "string",
"description": "Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names",
"description_kind": "markdown",
"required": true
},
"uid": {
"type": "string",
"description": "UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "list"
},
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"resource_version": {
"type": "string",
"description": "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",
"description_kind": "markdown",
"optional": true
},
"self_link": {
"type": "string",
"description": "Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.",
"description_kind": "markdown",
"optional": true
},
"uid": {
"type": "string",
"description": "UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.",
"description_kind": "markdown",
"optional": true
},
"spec": {
"nested_type": {
"attributes": {
"active_deadline_seconds": {
"type": "number",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"affinity": {
"nested_type": {
"attributes": {
"node_affinity": {
"nested_type": {
"attributes": {
"preferred_during_scheduling_ignored_during_execution": {
"nested_type": {
"attributes": {
"preference": {
"nested_type": {
"attributes": {
"match_expressions": {
"nested_type": {
"attributes": {
"key": {
"type": "string",
"description": "The label key that the selector applies to.",
"description_kind": "markdown",
"required": true
},
"operator": {
"type": "string",
"description": "Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.",
"description_kind": "markdown",
"required": true
},
"values": {
"type": [
"list",
"string"
],
"description": "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. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "list"
},
"description": "A list of node selector requirements by node's labels.",
"description_kind": "markdown",
"optional": true
},
"match_fields": {
"nested_type": {
"attributes": {
"key": {
"type": "string",
"description": "The label key that the selector applies to.",
"description_kind": "markdown",
"required": true
},
"operator": {
"type": "string",
"description": "Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.",
"description_kind": "markdown",
"required": true
},
"values": {
"type": [
"list",
"string"
],
"description": "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. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "list"
},
"description": "A list of node selector requirements by node's fields.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "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.",
"description_kind": "markdown",
"required": true
},
"weight": {
"type": "number",
"description": "Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "list"
},
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"required_during_scheduling_ignored_during_execution": {
"nested_type": {
"attributes": {
"node_selector_terms": {
"nested_type": {
"attributes": {
"match_expressions": {
"nested_type": {
"attributes": {
"key": {
"type": "string",
"description": "The label key that the selector applies to.",
"description_kind": "markdown",
"required": true
},
"operator": {
"type": "string",
"description": "Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.",
"description_kind": "markdown",
"required": true
},
"values": {
"type": [
"list",
"string"
],
"description": "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. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "list"
},
"description": "A list of node selector requirements by node's labels.",
"description_kind": "markdown",
"optional": true
},
"match_fields": {
"nested_type": {
"attributes": {
"key": {
"type": "string",
"description": "The label key that the selector applies to.",
"description_kind": "markdown",
"required": true
},
"operator": {
"type": "string",
"description": "Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.",
"description_kind": "markdown",
"required": true
},
"values": {
"type": [
"list",
"string"
],
"description": "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. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "list"
},
"description": "A list of node selector requirements by node's fields.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "list"
},
"description": "Required. A list of node selector terms. The terms are ORed.",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "single"
},
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "Node affinity is a group of node affinity scheduling rules.",
"description_kind": "markdown",
"optional": true
},
"pod_affinity": {
"nested_type": {
"attributes": {
"preferred_during_scheduling_ignored_during_execution": {
"nested_type": {
"attributes": {
"pod_affinity_term": {
"nested_type": {
"attributes": {
"label_selector": {
"nested_type": {
"attributes": {
"match_expressions": {
"nested_type": {
"attributes": {
"key": {
"type": "string",
"description": "key is the label key that the selector applies to.",
"description_kind": "markdown",
"required": true
},
"operator": {
"type": "string",
"description": "operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.",
"description_kind": "markdown",
"required": true
},
"values": {
"type": [
"list",
"string"
],
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "list"
},
"description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.",
"description_kind": "markdown",
"optional": true
},
"match_labels": {
"type": [
"map",
"string"
],
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"namespace_selector": {
"nested_type": {
"attributes": {
"match_expressions": {
"nested_type": {
"attributes": {
"key": {
"type": "string",
"description": "key is the label key that the selector applies to.",
"description_kind": "markdown",
"required": true
},
"operator": {
"type": "string",
"description": "operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.",
"description_kind": "markdown",
"required": true
},
"values": {
"type": [
"list",
"string"
],
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "list"
},
"description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.",
"description_kind": "markdown",
"optional": true
},
"match_labels": {
"type": [
"map",
"string"
],
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"namespaces": {
"type": [
"list",
"string"
],
"description": "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'.",
"description_kind": "markdown",
"optional": true
},
"topology_key": {
"type": "string",
"description": "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.",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "single"
},
"description": "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 <topologyKey> matches that of any node on which a pod of the set of pods is running",
"description_kind": "markdown",
"required": true
},
"weight": {
"type": "number",
"description": "weight associated with matching the corresponding podAffinityTerm, in the range 1-100.",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "list"
},
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"required_during_scheduling_ignored_during_execution": {
"nested_type": {
"attributes": {
"label_selector": {
"nested_type": {
"attributes": {
"match_expressions": {
"nested_type": {
"attributes": {
"key": {
"type": "string",
"description": "key is the label key that the selector applies to.",
"description_kind": "markdown",
"required": true
},
"operator": {
"type": "string",
"description": "operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.",
"description_kind": "markdown",
"required": true
},
"values": {
"type": [
"list",
"string"
],
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "list"
},
"description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.",
"description_kind": "markdown",
"optional": true
},
"match_labels": {
"type": [
"map",
"string"
],
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"namespace_selector": {
"nested_type": {
"attributes": {
"match_expressions": {
"nested_type": {
"attributes": {
"key": {
"type": "string",
"description": "key is the label key that the selector applies to.",
"description_kind": "markdown",
"required": true
},
"operator": {
"type": "string",
"description": "operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.",
"description_kind": "markdown",
"required": true
},
"values": {
"type": [
"list",
"string"
],
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "list"
},
"description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.",
"description_kind": "markdown",
"optional": true
},
"match_labels": {
"type": [
"map",
"string"
],
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"namespaces": {
"type": [
"list",
"string"
],
"description": "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'.",
"description_kind": "markdown",
"optional": true
},
"topology_key": {
"type": "string",
"description": "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.",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "list"
},
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "Pod affinity is a group of inter pod affinity scheduling rules.",
"description_kind": "markdown",
"optional": true
},
"pod_anti_affinity": {
"nested_type": {
"attributes": {
"preferred_during_scheduling_ignored_during_execution": {
"nested_type": {
"attributes": {
"pod_affinity_term": {
"nested_type": {
"attributes": {
"label_selector": {
"nested_type": {
"attributes": {
"match_expressions": {
"nested_type": {
"attributes": {
"key": {
"type": "string",
"description": "key is the label key that the selector applies to.",
"description_kind": "markdown",
"required": true
},
"operator": {
"type": "string",
"description": "operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.",
"description_kind": "markdown",
"required": true
},
"values": {
"type": [
"list",
"string"
],
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "list"
},
"description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.",
"description_kind": "markdown",
"optional": true
},
"match_labels": {
"type": [
"map",
"string"
],
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"namespace_selector": {
"nested_type": {
"attributes": {
"match_expressions": {
"nested_type": {
"attributes": {
"key": {
"type": "string",
"description": "key is the label key that the selector applies to.",
"description_kind": "markdown",
"required": true
},
"operator": {
"type": "string",
"description": "operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.",
"description_kind": "markdown",
"required": true
},
"values": {
"type": [
"list",
"string"
],
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "list"
},
"description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.",
"description_kind": "markdown",
"optional": true
},
"match_labels": {
"type": [
"map",
"string"
],
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"namespaces": {
"type": [
"list",
"string"
],
"description": "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'.",
"description_kind": "markdown",
"optional": true
},
"topology_key": {
"type": "string",
"description": "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.",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "single"
},
"description": "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 <topologyKey> matches that of any node on which a pod of the set of pods is running",
"description_kind": "markdown",
"required": true
},
"weight": {
"type": "number",
"description": "weight associated with matching the corresponding podAffinityTerm, in the range 1-100.",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "list"
},
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"required_during_scheduling_ignored_during_execution": {
"nested_type": {
"attributes": {
"label_selector": {
"nested_type": {
"attributes": {
"match_expressions": {
"nested_type": {
"attributes": {
"key": {
"type": "string",
"description": "key is the label key that the selector applies to.",
"description_kind": "markdown",
"required": true
},
"operator": {
"type": "string",
"description": "operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.",
"description_kind": "markdown",
"required": true
},
"values": {
"type": [
"list",
"string"
],
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "list"
},
"description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.",
"description_kind": "markdown",
"optional": true
},
"match_labels": {
"type": [
"map",
"string"
],
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"namespace_selector": {
"nested_type": {
"attributes": {
"match_expressions": {
"nested_type": {
"attributes": {
"key": {
"type": "string",
"description": "key is the label key that the selector applies to.",
"description_kind": "markdown",
"required": true
},
"operator": {
"type": "string",
"description": "operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.",
"description_kind": "markdown",
"required": true
},
"values": {
"type": [
"list",
"string"
],
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "list"
},
"description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.",
"description_kind": "markdown",
"optional": true
},
"match_labels": {
"type": [
"map",
"string"
],
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"namespaces": {
"type": [
"list",
"string"
],
"description": "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'.",
"description_kind": "markdown",
"optional": true
},
"topology_key": {
"type": "string",
"description": "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.",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "list"
},
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "Pod anti affinity is a group of inter pod anti affinity scheduling rules.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "Affinity is a group of affinity scheduling rules.",
"description_kind": "markdown",
"optional": true
},
"automount_service_account_token": {
"type": "bool",
"description": "AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.",
"description_kind": "markdown",
"optional": true
},
"containers": {
"nested_type": {
"attributes": {
"args": {
"type": [
"list",
"string"
],
"description": "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",
"description_kind": "markdown",
"optional": true
},
"command": {
"type": [
"list",
"string"
],
"description": "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",
"description_kind": "markdown",
"optional": true
},
"env": {
"nested_type": {
"attributes": {
"name": {
"type": "string",
"description": "Name of the environment variable. Must be a C_IDENTIFIER.",
"description_kind": "markdown",
"required": true
},
"value": {
"type": "string",
"description": "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 ''.",
"description_kind": "markdown",
"optional": true
},
"value_from": {
"nested_type": {
"attributes": {
"config_map_key_ref": {
"nested_type": {
"attributes": {
"key": {
"type": "string",
"description": "The key to select.",
"description_kind": "markdown",
"required": true
},
"name": {
"type": "string",
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"description_kind": "markdown",
"optional": true
},
"optional": {
"type": "bool",
"description": "Specify whether the ConfigMap or its key must be defined",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "Selects a key from a ConfigMap.",
"description_kind": "markdown",
"optional": true
},
"field_ref": {
"nested_type": {
"attributes": {
"api_version": {
"type": "string",
"description": "Version of the schema the FieldPath is written in terms of, defaults to 'v1'.",
"description_kind": "markdown",
"optional": true
},
"field_path": {
"type": "string",
"description": "Path of the field to select in the specified API version.",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "single"
},
"description": "ObjectFieldSelector selects an APIVersioned field of an object.",
"description_kind": "markdown",
"optional": true
},
"resource_field_ref": {
"nested_type": {
"attributes": {
"container_name": {
"type": "string",
"description": "Container name: required for volumes, optional for env vars",
"description_kind": "markdown",
"optional": true
},
"divisor": {
"type": "string",
"description": "Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors.The serialization format is:''' <quantity> ::= <signedNumber><suffix>\t(Note that <suffix> may be empty, from the '' case in <decimalSI>.)<digit> ::= 0 | 1 | ... | 9 <digits> ::= <digit> | <digit><digits> <number> ::= <digits> | <digits>.<digits> | <digits>. | .<digits> <sign> ::= '+' | '-' <signedNumber> ::= <number> | <sign><number> <suffix> ::= <binarySI> | <decimalExponent> | <decimalSI> <binarySI> ::= Ki | Mi | Gi | Ti | Pi | Ei\t(International System of units; See: http://physics.nist.gov/cuu/Units/binary.html)<decimalSI> ::= m | '' | k | M | G | T | P | E\t(Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.)<decimalExponent> ::= 'e' <signedNumber> | 'E' <signedNumber> '''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.",
"description_kind": "markdown",
"optional": true
},
"resource": {
"type": "string",
"description": "Required: resource to select",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "single"
},
"description": "ResourceFieldSelector represents container resources (cpu, memory) and their output format",
"description_kind": "markdown",
"optional": true
},
"secret_key_ref": {
"nested_type": {
"attributes": {
"key": {
"type": "string",
"description": "The key of the secret to select from. Must be a valid secret key.",
"description_kind": "markdown",
"required": true
},
"name": {
"type": "string",
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"description_kind": "markdown",
"optional": true
},
"optional": {
"type": "bool",
"description": "Specify whether the Secret or its key must be defined",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "SecretKeySelector selects a key of a Secret.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "EnvVarSource represents a source for the value of an EnvVar.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "list"
},
"description": "List of environment variables to set in the container. Cannot be updated.",
"description_kind": "markdown",
"optional": true
},
"env_from": {
"nested_type": {
"attributes": {
"config_map_ref": {
"nested_type": {
"attributes": {
"name": {
"type": "string",
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"description_kind": "markdown",
"optional": true
},
"optional": {
"type": "bool",
"description": "Specify whether the ConfigMap must be defined",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "ConfigMapEnvSource selects a ConfigMap to populate the environment variables with.The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables.",
"description_kind": "markdown",
"optional": true
},
"prefix": {
"type": "string",
"description": "An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.",
"description_kind": "markdown",
"optional": true
},
"secret_ref": {
"nested_type": {
"attributes": {
"name": {
"type": "string",
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"description_kind": "markdown",
"optional": true
},
"optional": {
"type": "bool",
"description": "Specify whether the Secret must be defined",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "SecretEnvSource selects a Secret to populate the environment variables with.The contents of the target Secret's Data field will represent the key-value pairs as environment variables.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "list"
},
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"image": {
"type": "string",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"image_pull_policy": {
"type": "string",
"description": "Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images",
"description_kind": "markdown",
"optional": true
},
"lifecycle": {
"nested_type": {
"attributes": {
"post_start": {
"nested_type": {
"attributes": {
"exec": {
"nested_type": {
"attributes": {
"command": {
"type": [
"list",
"string"
],
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "ExecAction describes a 'run in container' action.",
"description_kind": "markdown",
"optional": true
},
"http_get": {
"nested_type": {
"attributes": {
"host": {
"type": "string",
"description": "Host name to connect to, defaults to the pod IP. You probably want to set 'Host' in httpHeaders instead.",
"description_kind": "markdown",
"optional": true
},
"http_headers": {
"nested_type": {
"attributes": {
"name": {
"type": "string",
"description": "The header field name",
"description_kind": "markdown",
"required": true
},
"value": {
"type": "string",
"description": "The header field value",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "list"
},
"description": "Custom headers to set in the request. HTTP allows repeated headers.",
"description_kind": "markdown",
"optional": true
},
"path": {
"type": "string",
"description": "Path to access on the HTTP server.",
"description_kind": "markdown",
"optional": true
},
"port": {
"type": "dynamic",
"description": "IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.",
"description_kind": "markdown",
"required": true
},
"scheme": {
"type": "string",
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "HTTPGetAction describes an action based on HTTP Get requests.",
"description_kind": "markdown",
"optional": true
},
"tcp_socket": {
"nested_type": {
"attributes": {
"host": {
"type": "string",
"description": "Optional: Host name to connect to, defaults to the pod IP.",
"description_kind": "markdown",
"optional": true
},
"port": {
"type": "dynamic",
"description": "IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "single"
},
"description": "TCPSocketAction describes an action based on opening a socket",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"pre_stop": {
"nested_type": {
"attributes": {
"exec": {
"nested_type": {
"attributes": {
"command": {
"type": [
"list",
"string"
],
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "ExecAction describes a 'run in container' action.",
"description_kind": "markdown",
"optional": true
},
"http_get": {
"nested_type": {
"attributes": {
"host": {
"type": "string",
"description": "Host name to connect to, defaults to the pod IP. You probably want to set 'Host' in httpHeaders instead.",
"description_kind": "markdown",
"optional": true
},
"http_headers": {
"nested_type": {
"attributes": {
"name": {
"type": "string",
"description": "The header field name",
"description_kind": "markdown",
"required": true
},
"value": {
"type": "string",
"description": "The header field value",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "list"
},
"description": "Custom headers to set in the request. HTTP allows repeated headers.",
"description_kind": "markdown",
"optional": true
},
"path": {
"type": "string",
"description": "Path to access on the HTTP server.",
"description_kind": "markdown",
"optional": true
},
"port": {
"type": "dynamic",
"description": "IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.",
"description_kind": "markdown",
"required": true
},
"scheme": {
"type": "string",
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "HTTPGetAction describes an action based on HTTP Get requests.",
"description_kind": "markdown",
"optional": true
},
"tcp_socket": {
"nested_type": {
"attributes": {
"host": {
"type": "string",
"description": "Optional: Host name to connect to, defaults to the pod IP.",
"description_kind": "markdown",
"optional": true
},
"port": {
"type": "dynamic",
"description": "IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "single"
},
"description": "TCPSocketAction describes an action based on opening a socket",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"liveness_probe": {
"nested_type": {
"attributes": {
"exec": {
"nested_type": {
"attributes": {
"command": {
"type": [
"list",
"string"
],
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "ExecAction describes a 'run in container' action.",
"description_kind": "markdown",
"optional": true
},
"failure_threshold": {
"type": "number",
"description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.",
"description_kind": "markdown",
"optional": true
},
"grpc": {
"nested_type": {
"attributes": {
"port": {
"type": "number",
"description": "Port number of the gRPC service. Number must be in the range 1 to 65535.",
"description_kind": "markdown",
"required": true
},
"service": {
"type": "string",
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description_kind": "plain",
"optional": true
},
"http_get": {
"nested_type": {
"attributes": {
"host": {
"type": "string",
"description": "Host name to connect to, defaults to the pod IP. You probably want to set 'Host' in httpHeaders instead.",
"description_kind": "markdown",
"optional": true
},
"http_headers": {
"nested_type": {
"attributes": {
"name": {
"type": "string",
"description": "The header field name",
"description_kind": "markdown",
"required": true
},
"value": {
"type": "string",
"description": "The header field value",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "list"
},
"description": "Custom headers to set in the request. HTTP allows repeated headers.",
"description_kind": "markdown",
"optional": true
},
"path": {
"type": "string",
"description": "Path to access on the HTTP server.",
"description_kind": "markdown",
"optional": true
},
"port": {
"type": "dynamic",
"description": "IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.",
"description_kind": "markdown",
"required": true
},
"scheme": {
"type": "string",
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "HTTPGetAction describes an action based on HTTP Get requests.",
"description_kind": "markdown",
"optional": true
},
"initial_delay_seconds": {
"type": "number",
"description": "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",
"description_kind": "markdown",
"optional": true
},
"period_seconds": {
"type": "number",
"description": "How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.",
"description_kind": "markdown",
"optional": true
},
"success_threshold": {
"type": "number",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"tcp_socket": {
"nested_type": {
"attributes": {
"host": {
"type": "string",
"description": "Optional: Host name to connect to, defaults to the pod IP.",
"description_kind": "markdown",
"optional": true
},
"port": {
"type": "dynamic",
"description": "IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "single"
},
"description": "TCPSocketAction describes an action based on opening a socket",
"description_kind": "markdown",
"optional": true
},
"termination_grace_period_seconds": {
"type": "number",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"timeout_seconds": {
"type": "number",
"description": "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",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
"description_kind": "markdown",
"optional": true
},
"name": {
"type": "string",
"description": "Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.",
"description_kind": "markdown",
"required": true
},
"ports": {
"nested_type": {
"attributes": {
"container_port": {
"type": "number",
"description": "Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.",
"description_kind": "markdown",
"required": true
},
"host_ip": {
"type": "string",
"description": "What host IP to bind the external port to.",
"description_kind": "markdown",
"optional": true
},
"host_port": {
"type": "number",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"name": {
"type": "string",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"protocol": {
"type": "string",
"description": "Protocol for port. Must be UDP, TCP, or SCTP. Defaults to 'TCP'.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "list"
},
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"readiness_probe": {
"nested_type": {
"attributes": {
"exec": {
"nested_type": {
"attributes": {
"command": {
"type": [
"list",
"string"
],
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "ExecAction describes a 'run in container' action.",
"description_kind": "markdown",
"optional": true
},
"failure_threshold": {
"type": "number",
"description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.",
"description_kind": "markdown",
"optional": true
},
"grpc": {
"nested_type": {
"attributes": {
"port": {
"type": "number",
"description": "Port number of the gRPC service. Number must be in the range 1 to 65535.",
"description_kind": "markdown",
"required": true
},
"service": {
"type": "string",
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description_kind": "plain",
"optional": true
},
"http_get": {
"nested_type": {
"attributes": {
"host": {
"type": "string",
"description": "Host name to connect to, defaults to the pod IP. You probably want to set 'Host' in httpHeaders instead.",
"description_kind": "markdown",
"optional": true
},
"http_headers": {
"nested_type": {
"attributes": {
"name": {
"type": "string",
"description": "The header field name",
"description_kind": "markdown",
"required": true
},
"value": {
"type": "string",
"description": "The header field value",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "list"
},
"description": "Custom headers to set in the request. HTTP allows repeated headers.",
"description_kind": "markdown",
"optional": true
},
"path": {
"type": "string",
"description": "Path to access on the HTTP server.",
"description_kind": "markdown",
"optional": true
},
"port": {
"type": "dynamic",
"description": "IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.",
"description_kind": "markdown",
"required": true
},
"scheme": {
"type": "string",
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "HTTPGetAction describes an action based on HTTP Get requests.",
"description_kind": "markdown",
"optional": true
},
"initial_delay_seconds": {
"type": "number",
"description": "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",
"description_kind": "markdown",
"optional": true
},
"period_seconds": {
"type": "number",
"description": "How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.",
"description_kind": "markdown",
"optional": true
},
"success_threshold": {
"type": "number",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"tcp_socket": {
"nested_type": {
"attributes": {
"host": {
"type": "string",
"description": "Optional: Host name to connect to, defaults to the pod IP.",
"description_kind": "markdown",
"optional": true
},
"port": {
"type": "dynamic",
"description": "IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "single"
},
"description": "TCPSocketAction describes an action based on opening a socket",
"description_kind": "markdown",
"optional": true
},
"termination_grace_period_seconds": {
"type": "number",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"timeout_seconds": {
"type": "number",
"description": "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",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
"description_kind": "markdown",
"optional": true
},
"resources": {
"nested_type": {
"attributes": {
"limits": {
"type": [
"map",
"string"
],
"description": "Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/",
"description_kind": "markdown",
"optional": true
},
"requests": {
"type": [
"map",
"string"
],
"description": "Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "ResourceRequirements describes the compute resource requirements.",
"description_kind": "markdown",
"optional": true
},
"security_context": {
"nested_type": {
"attributes": {
"allow_privilege_escalation": {
"type": "bool",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"capabilities": {
"nested_type": {
"attributes": {
"add": {
"type": [
"list",
"string"
],
"description": "Added capabilities",
"description_kind": "markdown",
"optional": true
},
"drop": {
"type": [
"list",
"string"
],
"description": "Removed capabilities",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "Adds and removes POSIX capabilities from running containers.",
"description_kind": "markdown",
"optional": true
},
"privileged": {
"type": "bool",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"proc_mount": {
"type": "string",
"description": "procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.",
"description_kind": "markdown",
"optional": true
},
"read_only_root_filesystem": {
"type": "bool",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"run_as_group": {
"type": "number",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"run_as_non_root": {
"type": "bool",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"run_as_user": {
"type": "number",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"se_linux_options": {
"nested_type": {
"attributes": {
"level": {
"type": "string",
"description": "Level is SELinux level label that applies to the container.",
"description_kind": "markdown",
"optional": true
},
"role": {
"type": "string",
"description": "Role is a SELinux role label that applies to the container.",
"description_kind": "markdown",
"optional": true
},
"type": {
"type": "string",
"description": "Type is a SELinux type label that applies to the container.",
"description_kind": "markdown",
"optional": true
},
"user": {
"type": "string",
"description": "User is a SELinux user label that applies to the container.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "SELinuxOptions are the labels to be applied to the container",
"description_kind": "markdown",
"optional": true
},
"seccomp_profile": {
"nested_type": {
"attributes": {
"localhost_profile": {
"type": "string",
"description": "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 only be set if type is 'Localhost'.",
"description_kind": "markdown",
"optional": true
},
"type": {
"type": "string",
"description": "type indicates which kind of seccomp profile will be applied. Valid options are:Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "single"
},
"description": "SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set.",
"description_kind": "markdown",
"optional": true
},
"windows_options": {
"nested_type": {
"attributes": {
"gmsa_credential_spec": {
"type": "string",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"gmsa_credential_spec_name": {
"type": "string",
"description": "GMSACredentialSpecName is the name of the GMSA credential spec to use.",
"description_kind": "markdown",
"optional": true
},
"host_process": {
"type": "bool",
"description": "HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. 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.",
"description_kind": "markdown",
"optional": true
},
"run_as_user_name": {
"type": "string",
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "WindowsSecurityContextOptions contain Windows-specific options and credentials.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.",
"description_kind": "markdown",
"optional": true
},
"startup_probe": {
"nested_type": {
"attributes": {
"exec": {
"nested_type": {
"attributes": {
"command": {
"type": [
"list",
"string"
],
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "ExecAction describes a 'run in container' action.",
"description_kind": "markdown",
"optional": true
},
"failure_threshold": {
"type": "number",
"description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.",
"description_kind": "markdown",
"optional": true
},
"grpc": {
"nested_type": {
"attributes": {
"port": {
"type": "number",
"description": "Port number of the gRPC service. Number must be in the range 1 to 65535.",
"description_kind": "markdown",
"required": true
},
"service": {
"type": "string",
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description_kind": "plain",
"optional": true
},
"http_get": {
"nested_type": {
"attributes": {
"host": {
"type": "string",
"description": "Host name to connect to, defaults to the pod IP. You probably want to set 'Host' in httpHeaders instead.",
"description_kind": "markdown",
"optional": true
},
"http_headers": {
"nested_type": {
"attributes": {
"name": {
"type": "string",
"description": "The header field name",
"description_kind": "markdown",
"required": true
},
"value": {
"type": "string",
"description": "The header field value",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "list"
},
"description": "Custom headers to set in the request. HTTP allows repeated headers.",
"description_kind": "markdown",
"optional": true
},
"path": {
"type": "string",
"description": "Path to access on the HTTP server.",
"description_kind": "markdown",
"optional": true
},
"port": {
"type": "dynamic",
"description": "IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.",
"description_kind": "markdown",
"required": true
},
"scheme": {
"type": "string",
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "HTTPGetAction describes an action based on HTTP Get requests.",
"description_kind": "markdown",
"optional": true
},
"initial_delay_seconds": {
"type": "number",
"description": "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",
"description_kind": "markdown",
"optional": true
},
"period_seconds": {
"type": "number",
"description": "How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.",
"description_kind": "markdown",
"optional": true
},
"success_threshold": {
"type": "number",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"tcp_socket": {
"nested_type": {
"attributes": {
"host": {
"type": "string",
"description": "Optional: Host name to connect to, defaults to the pod IP.",
"description_kind": "markdown",
"optional": true
},
"port": {
"type": "dynamic",
"description": "IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "single"
},
"description": "TCPSocketAction describes an action based on opening a socket",
"description_kind": "markdown",
"optional": true
},
"termination_grace_period_seconds": {
"type": "number",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"timeout_seconds": {
"type": "number",
"description": "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",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
"description_kind": "markdown",
"optional": true
},
"stdin": {
"type": "bool",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"stdin_once": {
"type": "bool",
"description": "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",
"description_kind": "markdown",
"optional": true
},
"termination_message_path": {
"type": "string",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"termination_message_policy": {
"type": "string",
"description": "Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.",
"description_kind": "markdown",
"optional": true
},
"tty": {
"type": "bool",
"description": "Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.",
"description_kind": "markdown",
"optional": true
},
"volume_devices": {
"nested_type": {
"attributes": {
"device_path": {
"type": "string",
"description": "devicePath is the path inside of the container that the device will be mapped to.",
"description_kind": "markdown",
"required": true
},
"name": {
"type": "string",
"description": "name must match the name of a persistentVolumeClaim in the pod",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "list"
},
"description": "volumeDevices is the list of block devices to be used by the container.",
"description_kind": "markdown",
"optional": true
},
"volume_mounts": {
"nested_type": {
"attributes": {
"mount_path": {
"type": "string",
"description": "Path within the container at which the volume should be mounted. Must not contain ':'.",
"description_kind": "markdown",
"required": true
},
"mount_propagation": {
"type": "string",
"description": "mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.",
"description_kind": "markdown",
"optional": true
},
"name": {
"type": "string",
"description": "This must match the Name of a Volume.",
"description_kind": "markdown",
"required": true
},
"read_only": {
"type": "bool",
"description": "Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.",
"description_kind": "markdown",
"optional": true
},
"sub_path": {
"type": "string",
"description": "Path within the volume from which the container's volume should be mounted. Defaults to '' (volume's root).",
"description_kind": "markdown",
"optional": true
},
"sub_path_expr": {
"type": "string",
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "list"
},
"description": "Pod volumes to mount into the container's filesystem. Cannot be updated.",
"description_kind": "markdown",
"optional": true
},
"working_dir": {
"type": "string",
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "list"
},
"description": "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.",
"description_kind": "markdown",
"required": true
},
"dns_config": {
"nested_type": {
"attributes": {
"nameservers": {
"type": [
"list",
"string"
],
"description": "A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed.",
"description_kind": "markdown",
"optional": true
},
"options": {
"nested_type": {
"attributes": {
"name": {
"type": "string",
"description": "Required.",
"description_kind": "markdown",
"optional": true
},
"value": {
"type": "string",
"description_kind": "plain",
"optional": true
}
},
"nesting_mode": "list"
},
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"searches": {
"type": [
"list",
"string"
],
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy.",
"description_kind": "markdown",
"optional": true
},
"dns_policy": {
"type": "string",
"description": "Set DNS policy for the pod. Defaults to 'ClusterFirst'. Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'.",
"description_kind": "markdown",
"optional": true
},
"enable_service_links": {
"type": "bool",
"description": "EnableServiceLinks indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. Optional: Defaults to true.",
"description_kind": "markdown",
"optional": true
},
"ephemeral_containers": {
"nested_type": {
"attributes": {
"args": {
"type": [
"list",
"string"
],
"description": "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",
"description_kind": "markdown",
"optional": true
},
"command": {
"type": [
"list",
"string"
],
"description": "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",
"description_kind": "markdown",
"optional": true
},
"env": {
"nested_type": {
"attributes": {
"name": {
"type": "string",
"description": "Name of the environment variable. Must be a C_IDENTIFIER.",
"description_kind": "markdown",
"required": true
},
"value": {
"type": "string",
"description": "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 ''.",
"description_kind": "markdown",
"optional": true
},
"value_from": {
"nested_type": {
"attributes": {
"config_map_key_ref": {
"nested_type": {
"attributes": {
"key": {
"type": "string",
"description": "The key to select.",
"description_kind": "markdown",
"required": true
},
"name": {
"type": "string",
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"description_kind": "markdown",
"optional": true
},
"optional": {
"type": "bool",
"description": "Specify whether the ConfigMap or its key must be defined",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "Selects a key from a ConfigMap.",
"description_kind": "markdown",
"optional": true
},
"field_ref": {
"nested_type": {
"attributes": {
"api_version": {
"type": "string",
"description": "Version of the schema the FieldPath is written in terms of, defaults to 'v1'.",
"description_kind": "markdown",
"optional": true
},
"field_path": {
"type": "string",
"description": "Path of the field to select in the specified API version.",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "single"
},
"description": "ObjectFieldSelector selects an APIVersioned field of an object.",
"description_kind": "markdown",
"optional": true
},
"resource_field_ref": {
"nested_type": {
"attributes": {
"container_name": {
"type": "string",
"description": "Container name: required for volumes, optional for env vars",
"description_kind": "markdown",
"optional": true
},
"divisor": {
"type": "string",
"description": "Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors.The serialization format is:''' <quantity> ::= <signedNumber><suffix>\t(Note that <suffix> may be empty, from the '' case in <decimalSI>.)<digit> ::= 0 | 1 | ... | 9 <digits> ::= <digit> | <digit><digits> <number> ::= <digits> | <digits>.<digits> | <digits>. | .<digits> <sign> ::= '+' | '-' <signedNumber> ::= <number> | <sign><number> <suffix> ::= <binarySI> | <decimalExponent> | <decimalSI> <binarySI> ::= Ki | Mi | Gi | Ti | Pi | Ei\t(International System of units; See: http://physics.nist.gov/cuu/Units/binary.html)<decimalSI> ::= m | '' | k | M | G | T | P | E\t(Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.)<decimalExponent> ::= 'e' <signedNumber> | 'E' <signedNumber> '''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.",
"description_kind": "markdown",
"optional": true
},
"resource": {
"type": "string",
"description": "Required: resource to select",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "single"
},
"description": "ResourceFieldSelector represents container resources (cpu, memory) and their output format",
"description_kind": "markdown",
"optional": true
},
"secret_key_ref": {
"nested_type": {
"attributes": {
"key": {
"type": "string",
"description": "The key of the secret to select from. Must be a valid secret key.",
"description_kind": "markdown",
"required": true
},
"name": {
"type": "string",
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"description_kind": "markdown",
"optional": true
},
"optional": {
"type": "bool",
"description": "Specify whether the Secret or its key must be defined",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "SecretKeySelector selects a key of a Secret.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "EnvVarSource represents a source for the value of an EnvVar.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "list"
},
"description": "List of environment variables to set in the container. Cannot be updated.",
"description_kind": "markdown",
"optional": true
},
"env_from": {
"nested_type": {
"attributes": {
"config_map_ref": {
"nested_type": {
"attributes": {
"name": {
"type": "string",
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"description_kind": "markdown",
"optional": true
},
"optional": {
"type": "bool",
"description": "Specify whether the ConfigMap must be defined",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "ConfigMapEnvSource selects a ConfigMap to populate the environment variables with.The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables.",
"description_kind": "markdown",
"optional": true
},
"prefix": {
"type": "string",
"description": "An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.",
"description_kind": "markdown",
"optional": true
},
"secret_ref": {
"nested_type": {
"attributes": {
"name": {
"type": "string",
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"description_kind": "markdown",
"optional": true
},
"optional": {
"type": "bool",
"description": "Specify whether the Secret must be defined",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "SecretEnvSource selects a Secret to populate the environment variables with.The contents of the target Secret's Data field will represent the key-value pairs as environment variables.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "list"
},
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"image": {
"type": "string",
"description": "Container image name. More info: https://kubernetes.io/docs/concepts/containers/images",
"description_kind": "markdown",
"optional": true
},
"image_pull_policy": {
"type": "string",
"description": "Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images",
"description_kind": "markdown",
"optional": true
},
"lifecycle": {
"nested_type": {
"attributes": {
"post_start": {
"nested_type": {
"attributes": {
"exec": {
"nested_type": {
"attributes": {
"command": {
"type": [
"list",
"string"
],
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "ExecAction describes a 'run in container' action.",
"description_kind": "markdown",
"optional": true
},
"http_get": {
"nested_type": {
"attributes": {
"host": {
"type": "string",
"description": "Host name to connect to, defaults to the pod IP. You probably want to set 'Host' in httpHeaders instead.",
"description_kind": "markdown",
"optional": true
},
"http_headers": {
"nested_type": {
"attributes": {
"name": {
"type": "string",
"description": "The header field name",
"description_kind": "markdown",
"required": true
},
"value": {
"type": "string",
"description": "The header field value",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "list"
},
"description": "Custom headers to set in the request. HTTP allows repeated headers.",
"description_kind": "markdown",
"optional": true
},
"path": {
"type": "string",
"description": "Path to access on the HTTP server.",
"description_kind": "markdown",
"optional": true
},
"port": {
"type": "dynamic",
"description": "IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.",
"description_kind": "markdown",
"required": true
},
"scheme": {
"type": "string",
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "HTTPGetAction describes an action based on HTTP Get requests.",
"description_kind": "markdown",
"optional": true
},
"tcp_socket": {
"nested_type": {
"attributes": {
"host": {
"type": "string",
"description": "Optional: Host name to connect to, defaults to the pod IP.",
"description_kind": "markdown",
"optional": true
},
"port": {
"type": "dynamic",
"description": "IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "single"
},
"description": "TCPSocketAction describes an action based on opening a socket",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"pre_stop": {
"nested_type": {
"attributes": {
"exec": {
"nested_type": {
"attributes": {
"command": {
"type": [
"list",
"string"
],
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "ExecAction describes a 'run in container' action.",
"description_kind": "markdown",
"optional": true
},
"http_get": {
"nested_type": {
"attributes": {
"host": {
"type": "string",
"description": "Host name to connect to, defaults to the pod IP. You probably want to set 'Host' in httpHeaders instead.",
"description_kind": "markdown",
"optional": true
},
"http_headers": {
"nested_type": {
"attributes": {
"name": {
"type": "string",
"description": "The header field name",
"description_kind": "markdown",
"required": true
},
"value": {
"type": "string",
"description": "The header field value",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "list"
},
"description": "Custom headers to set in the request. HTTP allows repeated headers.",
"description_kind": "markdown",
"optional": true
},
"path": {
"type": "string",
"description": "Path to access on the HTTP server.",
"description_kind": "markdown",
"optional": true
},
"port": {
"type": "dynamic",
"description": "IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.",
"description_kind": "markdown",
"required": true
},
"scheme": {
"type": "string",
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "HTTPGetAction describes an action based on HTTP Get requests.",
"description_kind": "markdown",
"optional": true
},
"tcp_socket": {
"nested_type": {
"attributes": {
"host": {
"type": "string",
"description": "Optional: Host name to connect to, defaults to the pod IP.",
"description_kind": "markdown",
"optional": true
},
"port": {
"type": "dynamic",
"description": "IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "single"
},
"description": "TCPSocketAction describes an action based on opening a socket",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"liveness_probe": {
"nested_type": {
"attributes": {
"exec": {
"nested_type": {
"attributes": {
"command": {
"type": [
"list",
"string"
],
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "ExecAction describes a 'run in container' action.",
"description_kind": "markdown",
"optional": true
},
"failure_threshold": {
"type": "number",
"description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.",
"description_kind": "markdown",
"optional": true
},
"grpc": {
"nested_type": {
"attributes": {
"port": {
"type": "number",
"description": "Port number of the gRPC service. Number must be in the range 1 to 65535.",
"description_kind": "markdown",
"required": true
},
"service": {
"type": "string",
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description_kind": "plain",
"optional": true
},
"http_get": {
"nested_type": {
"attributes": {
"host": {
"type": "string",
"description": "Host name to connect to, defaults to the pod IP. You probably want to set 'Host' in httpHeaders instead.",
"description_kind": "markdown",
"optional": true
},
"http_headers": {
"nested_type": {
"attributes": {
"name": {
"type": "string",
"description": "The header field name",
"description_kind": "markdown",
"required": true
},
"value": {
"type": "string",
"description": "The header field value",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "list"
},
"description": "Custom headers to set in the request. HTTP allows repeated headers.",
"description_kind": "markdown",
"optional": true
},
"path": {
"type": "string",
"description": "Path to access on the HTTP server.",
"description_kind": "markdown",
"optional": true
},
"port": {
"type": "dynamic",
"description": "IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.",
"description_kind": "markdown",
"required": true
},
"scheme": {
"type": "string",
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "HTTPGetAction describes an action based on HTTP Get requests.",
"description_kind": "markdown",
"optional": true
},
"initial_delay_seconds": {
"type": "number",
"description": "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",
"description_kind": "markdown",
"optional": true
},
"period_seconds": {
"type": "number",
"description": "How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.",
"description_kind": "markdown",
"optional": true
},
"success_threshold": {
"type": "number",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"tcp_socket": {
"nested_type": {
"attributes": {
"host": {
"type": "string",
"description": "Optional: Host name to connect to, defaults to the pod IP.",
"description_kind": "markdown",
"optional": true
},
"port": {
"type": "dynamic",
"description": "IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "single"
},
"description": "TCPSocketAction describes an action based on opening a socket",
"description_kind": "markdown",
"optional": true
},
"termination_grace_period_seconds": {
"type": "number",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"timeout_seconds": {
"type": "number",
"description": "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",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
"description_kind": "markdown",
"optional": true
},
"name": {
"type": "string",
"description": "Name of the ephemeral container specified as a DNS_LABEL. This name must be unique among all containers, init containers and ephemeral containers.",
"description_kind": "markdown",
"required": true
},
"ports": {
"nested_type": {
"attributes": {
"container_port": {
"type": "number",
"description": "Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.",
"description_kind": "markdown",
"required": true
},
"host_ip": {
"type": "string",
"description": "What host IP to bind the external port to.",
"description_kind": "markdown",
"optional": true
},
"host_port": {
"type": "number",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"name": {
"type": "string",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"protocol": {
"type": "string",
"description": "Protocol for port. Must be UDP, TCP, or SCTP. Defaults to 'TCP'.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "list"
},
"description": "Ports are not allowed for ephemeral containers.",
"description_kind": "markdown",
"optional": true
},
"readiness_probe": {
"nested_type": {
"attributes": {
"exec": {
"nested_type": {
"attributes": {
"command": {
"type": [
"list",
"string"
],
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "ExecAction describes a 'run in container' action.",
"description_kind": "markdown",
"optional": true
},
"failure_threshold": {
"type": "number",
"description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.",
"description_kind": "markdown",
"optional": true
},
"grpc": {
"nested_type": {
"attributes": {
"port": {
"type": "number",
"description": "Port number of the gRPC service. Number must be in the range 1 to 65535.",
"description_kind": "markdown",
"required": true
},
"service": {
"type": "string",
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description_kind": "plain",
"optional": true
},
"http_get": {
"nested_type": {
"attributes": {
"host": {
"type": "string",
"description": "Host name to connect to, defaults to the pod IP. You probably want to set 'Host' in httpHeaders instead.",
"description_kind": "markdown",
"optional": true
},
"http_headers": {
"nested_type": {
"attributes": {
"name": {
"type": "string",
"description": "The header field name",
"description_kind": "markdown",
"required": true
},
"value": {
"type": "string",
"description": "The header field value",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "list"
},
"description": "Custom headers to set in the request. HTTP allows repeated headers.",
"description_kind": "markdown",
"optional": true
},
"path": {
"type": "string",
"description": "Path to access on the HTTP server.",
"description_kind": "markdown",
"optional": true
},
"port": {
"type": "dynamic",
"description": "IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.",
"description_kind": "markdown",
"required": true
},
"scheme": {
"type": "string",
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "HTTPGetAction describes an action based on HTTP Get requests.",
"description_kind": "markdown",
"optional": true
},
"initial_delay_seconds": {
"type": "number",
"description": "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",
"description_kind": "markdown",
"optional": true
},
"period_seconds": {
"type": "number",
"description": "How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.",
"description_kind": "markdown",
"optional": true
},
"success_threshold": {
"type": "number",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"tcp_socket": {
"nested_type": {
"attributes": {
"host": {
"type": "string",
"description": "Optional: Host name to connect to, defaults to the pod IP.",
"description_kind": "markdown",
"optional": true
},
"port": {
"type": "dynamic",
"description": "IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "single"
},
"description": "TCPSocketAction describes an action based on opening a socket",
"description_kind": "markdown",
"optional": true
},
"termination_grace_period_seconds": {
"type": "number",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"timeout_seconds": {
"type": "number",
"description": "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",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
"description_kind": "markdown",
"optional": true
},
"resources": {
"nested_type": {
"attributes": {
"limits": {
"type": [
"map",
"string"
],
"description": "Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/",
"description_kind": "markdown",
"optional": true
},
"requests": {
"type": [
"map",
"string"
],
"description": "Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "ResourceRequirements describes the compute resource requirements.",
"description_kind": "markdown",
"optional": true
},
"security_context": {
"nested_type": {
"attributes": {
"allow_privilege_escalation": {
"type": "bool",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"capabilities": {
"nested_type": {
"attributes": {
"add": {
"type": [
"list",
"string"
],
"description": "Added capabilities",
"description_kind": "markdown",
"optional": true
},
"drop": {
"type": [
"list",
"string"
],
"description": "Removed capabilities",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "Adds and removes POSIX capabilities from running containers.",
"description_kind": "markdown",
"optional": true
},
"privileged": {
"type": "bool",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"proc_mount": {
"type": "string",
"description": "procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.",
"description_kind": "markdown",
"optional": true
},
"read_only_root_filesystem": {
"type": "bool",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"run_as_group": {
"type": "number",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"run_as_non_root": {
"type": "bool",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"run_as_user": {
"type": "number",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"se_linux_options": {
"nested_type": {
"attributes": {
"level": {
"type": "string",
"description": "Level is SELinux level label that applies to the container.",
"description_kind": "markdown",
"optional": true
},
"role": {
"type": "string",
"description": "Role is a SELinux role label that applies to the container.",
"description_kind": "markdown",
"optional": true
},
"type": {
"type": "string",
"description": "Type is a SELinux type label that applies to the container.",
"description_kind": "markdown",
"optional": true
},
"user": {
"type": "string",
"description": "User is a SELinux user label that applies to the container.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "SELinuxOptions are the labels to be applied to the container",
"description_kind": "markdown",
"optional": true
},
"seccomp_profile": {
"nested_type": {
"attributes": {
"localhost_profile": {
"type": "string",
"description": "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 only be set if type is 'Localhost'.",
"description_kind": "markdown",
"optional": true
},
"type": {
"type": "string",
"description": "type indicates which kind of seccomp profile will be applied. Valid options are:Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "single"
},
"description": "SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set.",
"description_kind": "markdown",
"optional": true
},
"windows_options": {
"nested_type": {
"attributes": {
"gmsa_credential_spec": {
"type": "string",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"gmsa_credential_spec_name": {
"type": "string",
"description": "GMSACredentialSpecName is the name of the GMSA credential spec to use.",
"description_kind": "markdown",
"optional": true
},
"host_process": {
"type": "bool",
"description": "HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. 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.",
"description_kind": "markdown",
"optional": true
},
"run_as_user_name": {
"type": "string",
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "WindowsSecurityContextOptions contain Windows-specific options and credentials.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.",
"description_kind": "markdown",
"optional": true
},
"startup_probe": {
"nested_type": {
"attributes": {
"exec": {
"nested_type": {
"attributes": {
"command": {
"type": [
"list",
"string"
],
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "ExecAction describes a 'run in container' action.",
"description_kind": "markdown",
"optional": true
},
"failure_threshold": {
"type": "number",
"description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.",
"description_kind": "markdown",
"optional": true
},
"grpc": {
"nested_type": {
"attributes": {
"port": {
"type": "number",
"description": "Port number of the gRPC service. Number must be in the range 1 to 65535.",
"description_kind": "markdown",
"required": true
},
"service": {
"type": "string",
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description_kind": "plain",
"optional": true
},
"http_get": {
"nested_type": {
"attributes": {
"host": {
"type": "string",
"description": "Host name to connect to, defaults to the pod IP. You probably want to set 'Host' in httpHeaders instead.",
"description_kind": "markdown",
"optional": true
},
"http_headers": {
"nested_type": {
"attributes": {
"name": {
"type": "string",
"description": "The header field name",
"description_kind": "markdown",
"required": true
},
"value": {
"type": "string",
"description": "The header field value",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "list"
},
"description": "Custom headers to set in the request. HTTP allows repeated headers.",
"description_kind": "markdown",
"optional": true
},
"path": {
"type": "string",
"description": "Path to access on the HTTP server.",
"description_kind": "markdown",
"optional": true
},
"port": {
"type": "dynamic",
"description": "IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.",
"description_kind": "markdown",
"required": true
},
"scheme": {
"type": "string",
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "HTTPGetAction describes an action based on HTTP Get requests.",
"description_kind": "markdown",
"optional": true
},
"initial_delay_seconds": {
"type": "number",
"description": "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",
"description_kind": "markdown",
"optional": true
},
"period_seconds": {
"type": "number",
"description": "How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.",
"description_kind": "markdown",
"optional": true
},
"success_threshold": {
"type": "number",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"tcp_socket": {
"nested_type": {
"attributes": {
"host": {
"type": "string",
"description": "Optional: Host name to connect to, defaults to the pod IP.",
"description_kind": "markdown",
"optional": true
},
"port": {
"type": "dynamic",
"description": "IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "single"
},
"description": "TCPSocketAction describes an action based on opening a socket",
"description_kind": "markdown",
"optional": true
},
"termination_grace_period_seconds": {
"type": "number",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"timeout_seconds": {
"type": "number",
"description": "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",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
"description_kind": "markdown",
"optional": true
},
"stdin": {
"type": "bool",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"stdin_once": {
"type": "bool",
"description": "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",
"description_kind": "markdown",
"optional": true
},
"target_container_name": {
"type": "string",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"termination_message_path": {
"type": "string",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"termination_message_policy": {
"type": "string",
"description": "Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.",
"description_kind": "markdown",
"optional": true
},
"tty": {
"type": "bool",
"description": "Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.",
"description_kind": "markdown",
"optional": true
},
"volume_devices": {
"nested_type": {
"attributes": {
"device_path": {
"type": "string",
"description": "devicePath is the path inside of the container that the device will be mapped to.",
"description_kind": "markdown",
"required": true
},
"name": {
"type": "string",
"description": "name must match the name of a persistentVolumeClaim in the pod",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "list"
},
"description": "volumeDevices is the list of block devices to be used by the container.",
"description_kind": "markdown",
"optional": true
},
"volume_mounts": {
"nested_type": {
"attributes": {
"mount_path": {
"type": "string",
"description": "Path within the container at which the volume should be mounted. Must not contain ':'.",
"description_kind": "markdown",
"required": true
},
"mount_propagation": {
"type": "string",
"description": "mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.",
"description_kind": "markdown",
"optional": true
},
"name": {
"type": "string",
"description": "This must match the Name of a Volume.",
"description_kind": "markdown",
"required": true
},
"read_only": {
"type": "bool",
"description": "Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.",
"description_kind": "markdown",
"optional": true
},
"sub_path": {
"type": "string",
"description": "Path within the volume from which the container's volume should be mounted. Defaults to '' (volume's root).",
"description_kind": "markdown",
"optional": true
},
"sub_path_expr": {
"type": "string",
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "list"
},
"description": "Pod volumes to mount into the container's filesystem. Subpath mounts are not allowed for ephemeral containers. Cannot be updated.",
"description_kind": "markdown",
"optional": true
},
"working_dir": {
"type": "string",
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "list"
},
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"host_aliases": {
"nested_type": {
"attributes": {
"hostnames": {
"type": [
"list",
"string"
],
"description": "Hostnames for the above IP address.",
"description_kind": "markdown",
"optional": true
},
"ip": {
"type": "string",
"description": "IP address of the host file entry.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "list"
},
"description": "HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified. This is only valid for non-hostNetwork pods.",
"description_kind": "markdown",
"optional": true
},
"host_ipc": {
"type": "bool",
"description": "Use the host's ipc namespace. Optional: Default to false.",
"description_kind": "markdown",
"optional": true
},
"host_network": {
"type": "bool",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"host_pid": {
"type": "bool",
"description": "Use the host's pid namespace. Optional: Default to false.",
"description_kind": "markdown",
"optional": true
},
"host_users": {
"type": "bool",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"hostname": {
"type": "string",
"description": "Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value.",
"description_kind": "markdown",
"optional": true
},
"image_pull_secrets": {
"nested_type": {
"attributes": {
"name": {
"type": "string",
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "list"
},
"description": "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",
"description_kind": "markdown",
"optional": true
},
"init_containers": {
"nested_type": {
"attributes": {
"args": {
"type": [
"list",
"string"
],
"description": "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",
"description_kind": "markdown",
"optional": true
},
"command": {
"type": [
"list",
"string"
],
"description": "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",
"description_kind": "markdown",
"optional": true
},
"env": {
"nested_type": {
"attributes": {
"name": {
"type": "string",
"description": "Name of the environment variable. Must be a C_IDENTIFIER.",
"description_kind": "markdown",
"required": true
},
"value": {
"type": "string",
"description": "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 ''.",
"description_kind": "markdown",
"optional": true
},
"value_from": {
"nested_type": {
"attributes": {
"config_map_key_ref": {
"nested_type": {
"attributes": {
"key": {
"type": "string",
"description": "The key to select.",
"description_kind": "markdown",
"required": true
},
"name": {
"type": "string",
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"description_kind": "markdown",
"optional": true
},
"optional": {
"type": "bool",
"description": "Specify whether the ConfigMap or its key must be defined",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "Selects a key from a ConfigMap.",
"description_kind": "markdown",
"optional": true
},
"field_ref": {
"nested_type": {
"attributes": {
"api_version": {
"type": "string",
"description": "Version of the schema the FieldPath is written in terms of, defaults to 'v1'.",
"description_kind": "markdown",
"optional": true
},
"field_path": {
"type": "string",
"description": "Path of the field to select in the specified API version.",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "single"
},
"description": "ObjectFieldSelector selects an APIVersioned field of an object.",
"description_kind": "markdown",
"optional": true
},
"resource_field_ref": {
"nested_type": {
"attributes": {
"container_name": {
"type": "string",
"description": "Container name: required for volumes, optional for env vars",
"description_kind": "markdown",
"optional": true
},
"divisor": {
"type": "string",
"description": "Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors.The serialization format is:''' <quantity> ::= <signedNumber><suffix>\t(Note that <suffix> may be empty, from the '' case in <decimalSI>.)<digit> ::= 0 | 1 | ... | 9 <digits> ::= <digit> | <digit><digits> <number> ::= <digits> | <digits>.<digits> | <digits>. | .<digits> <sign> ::= '+' | '-' <signedNumber> ::= <number> | <sign><number> <suffix> ::= <binarySI> | <decimalExponent> | <decimalSI> <binarySI> ::= Ki | Mi | Gi | Ti | Pi | Ei\t(International System of units; See: http://physics.nist.gov/cuu/Units/binary.html)<decimalSI> ::= m | '' | k | M | G | T | P | E\t(Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.)<decimalExponent> ::= 'e' <signedNumber> | 'E' <signedNumber> '''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.",
"description_kind": "markdown",
"optional": true
},
"resource": {
"type": "string",
"description": "Required: resource to select",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "single"
},
"description": "ResourceFieldSelector represents container resources (cpu, memory) and their output format",
"description_kind": "markdown",
"optional": true
},
"secret_key_ref": {
"nested_type": {
"attributes": {
"key": {
"type": "string",
"description": "The key of the secret to select from. Must be a valid secret key.",
"description_kind": "markdown",
"required": true
},
"name": {
"type": "string",
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"description_kind": "markdown",
"optional": true
},
"optional": {
"type": "bool",
"description": "Specify whether the Secret or its key must be defined",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "SecretKeySelector selects a key of a Secret.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "EnvVarSource represents a source for the value of an EnvVar.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "list"
},
"description": "List of environment variables to set in the container. Cannot be updated.",
"description_kind": "markdown",
"optional": true
},
"env_from": {
"nested_type": {
"attributes": {
"config_map_ref": {
"nested_type": {
"attributes": {
"name": {
"type": "string",
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"description_kind": "markdown",
"optional": true
},
"optional": {
"type": "bool",
"description": "Specify whether the ConfigMap must be defined",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "ConfigMapEnvSource selects a ConfigMap to populate the environment variables with.The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables.",
"description_kind": "markdown",
"optional": true
},
"prefix": {
"type": "string",
"description": "An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.",
"description_kind": "markdown",
"optional": true
},
"secret_ref": {
"nested_type": {
"attributes": {
"name": {
"type": "string",
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"description_kind": "markdown",
"optional": true
},
"optional": {
"type": "bool",
"description": "Specify whether the Secret must be defined",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "SecretEnvSource selects a Secret to populate the environment variables with.The contents of the target Secret's Data field will represent the key-value pairs as environment variables.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "list"
},
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"image": {
"type": "string",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"image_pull_policy": {
"type": "string",
"description": "Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images",
"description_kind": "markdown",
"optional": true
},
"lifecycle": {
"nested_type": {
"attributes": {
"post_start": {
"nested_type": {
"attributes": {
"exec": {
"nested_type": {
"attributes": {
"command": {
"type": [
"list",
"string"
],
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "ExecAction describes a 'run in container' action.",
"description_kind": "markdown",
"optional": true
},
"http_get": {
"nested_type": {
"attributes": {
"host": {
"type": "string",
"description": "Host name to connect to, defaults to the pod IP. You probably want to set 'Host' in httpHeaders instead.",
"description_kind": "markdown",
"optional": true
},
"http_headers": {
"nested_type": {
"attributes": {
"name": {
"type": "string",
"description": "The header field name",
"description_kind": "markdown",
"required": true
},
"value": {
"type": "string",
"description": "The header field value",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "list"
},
"description": "Custom headers to set in the request. HTTP allows repeated headers.",
"description_kind": "markdown",
"optional": true
},
"path": {
"type": "string",
"description": "Path to access on the HTTP server.",
"description_kind": "markdown",
"optional": true
},
"port": {
"type": "dynamic",
"description": "IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.",
"description_kind": "markdown",
"required": true
},
"scheme": {
"type": "string",
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "HTTPGetAction describes an action based on HTTP Get requests.",
"description_kind": "markdown",
"optional": true
},
"tcp_socket": {
"nested_type": {
"attributes": {
"host": {
"type": "string",
"description": "Optional: Host name to connect to, defaults to the pod IP.",
"description_kind": "markdown",
"optional": true
},
"port": {
"type": "dynamic",
"description": "IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "single"
},
"description": "TCPSocketAction describes an action based on opening a socket",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"pre_stop": {
"nested_type": {
"attributes": {
"exec": {
"nested_type": {
"attributes": {
"command": {
"type": [
"list",
"string"
],
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "ExecAction describes a 'run in container' action.",
"description_kind": "markdown",
"optional": true
},
"http_get": {
"nested_type": {
"attributes": {
"host": {
"type": "string",
"description": "Host name to connect to, defaults to the pod IP. You probably want to set 'Host' in httpHeaders instead.",
"description_kind": "markdown",
"optional": true
},
"http_headers": {
"nested_type": {
"attributes": {
"name": {
"type": "string",
"description": "The header field name",
"description_kind": "markdown",
"required": true
},
"value": {
"type": "string",
"description": "The header field value",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "list"
},
"description": "Custom headers to set in the request. HTTP allows repeated headers.",
"description_kind": "markdown",
"optional": true
},
"path": {
"type": "string",
"description": "Path to access on the HTTP server.",
"description_kind": "markdown",
"optional": true
},
"port": {
"type": "dynamic",
"description": "IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.",
"description_kind": "markdown",
"required": true
},
"scheme": {
"type": "string",
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "HTTPGetAction describes an action based on HTTP Get requests.",
"description_kind": "markdown",
"optional": true
},
"tcp_socket": {
"nested_type": {
"attributes": {
"host": {
"type": "string",
"description": "Optional: Host name to connect to, defaults to the pod IP.",
"description_kind": "markdown",
"optional": true
},
"port": {
"type": "dynamic",
"description": "IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "single"
},
"description": "TCPSocketAction describes an action based on opening a socket",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"liveness_probe": {
"nested_type": {
"attributes": {
"exec": {
"nested_type": {
"attributes": {
"command": {
"type": [
"list",
"string"
],
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "ExecAction describes a 'run in container' action.",
"description_kind": "markdown",
"optional": true
},
"failure_threshold": {
"type": "number",
"description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.",
"description_kind": "markdown",
"optional": true
},
"grpc": {
"nested_type": {
"attributes": {
"port": {
"type": "number",
"description": "Port number of the gRPC service. Number must be in the range 1 to 65535.",
"description_kind": "markdown",
"required": true
},
"service": {
"type": "string",
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description_kind": "plain",
"optional": true
},
"http_get": {
"nested_type": {
"attributes": {
"host": {
"type": "string",
"description": "Host name to connect to, defaults to the pod IP. You probably want to set 'Host' in httpHeaders instead.",
"description_kind": "markdown",
"optional": true
},
"http_headers": {
"nested_type": {
"attributes": {
"name": {
"type": "string",
"description": "The header field name",
"description_kind": "markdown",
"required": true
},
"value": {
"type": "string",
"description": "The header field value",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "list"
},
"description": "Custom headers to set in the request. HTTP allows repeated headers.",
"description_kind": "markdown",
"optional": true
},
"path": {
"type": "string",
"description": "Path to access on the HTTP server.",
"description_kind": "markdown",
"optional": true
},
"port": {
"type": "dynamic",
"description": "IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.",
"description_kind": "markdown",
"required": true
},
"scheme": {
"type": "string",
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "HTTPGetAction describes an action based on HTTP Get requests.",
"description_kind": "markdown",
"optional": true
},
"initial_delay_seconds": {
"type": "number",
"description": "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",
"description_kind": "markdown",
"optional": true
},
"period_seconds": {
"type": "number",
"description": "How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.",
"description_kind": "markdown",
"optional": true
},
"success_threshold": {
"type": "number",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"tcp_socket": {
"nested_type": {
"attributes": {
"host": {
"type": "string",
"description": "Optional: Host name to connect to, defaults to the pod IP.",
"description_kind": "markdown",
"optional": true
},
"port": {
"type": "dynamic",
"description": "IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "single"
},
"description": "TCPSocketAction describes an action based on opening a socket",
"description_kind": "markdown",
"optional": true
},
"termination_grace_period_seconds": {
"type": "number",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"timeout_seconds": {
"type": "number",
"description": "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",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
"description_kind": "markdown",
"optional": true
},
"name": {
"type": "string",
"description": "Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.",
"description_kind": "markdown",
"required": true
},
"ports": {
"nested_type": {
"attributes": {
"container_port": {
"type": "number",
"description": "Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.",
"description_kind": "markdown",
"required": true
},
"host_ip": {
"type": "string",
"description": "What host IP to bind the external port to.",
"description_kind": "markdown",
"optional": true
},
"host_port": {
"type": "number",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"name": {
"type": "string",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"protocol": {
"type": "string",
"description": "Protocol for port. Must be UDP, TCP, or SCTP. Defaults to 'TCP'.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "list"
},
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"readiness_probe": {
"nested_type": {
"attributes": {
"exec": {
"nested_type": {
"attributes": {
"command": {
"type": [
"list",
"string"
],
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "ExecAction describes a 'run in container' action.",
"description_kind": "markdown",
"optional": true
},
"failure_threshold": {
"type": "number",
"description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.",
"description_kind": "markdown",
"optional": true
},
"grpc": {
"nested_type": {
"attributes": {
"port": {
"type": "number",
"description": "Port number of the gRPC service. Number must be in the range 1 to 65535.",
"description_kind": "markdown",
"required": true
},
"service": {
"type": "string",
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description_kind": "plain",
"optional": true
},
"http_get": {
"nested_type": {
"attributes": {
"host": {
"type": "string",
"description": "Host name to connect to, defaults to the pod IP. You probably want to set 'Host' in httpHeaders instead.",
"description_kind": "markdown",
"optional": true
},
"http_headers": {
"nested_type": {
"attributes": {
"name": {
"type": "string",
"description": "The header field name",
"description_kind": "markdown",
"required": true
},
"value": {
"type": "string",
"description": "The header field value",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "list"
},
"description": "Custom headers to set in the request. HTTP allows repeated headers.",
"description_kind": "markdown",
"optional": true
},
"path": {
"type": "string",
"description": "Path to access on the HTTP server.",
"description_kind": "markdown",
"optional": true
},
"port": {
"type": "dynamic",
"description": "IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.",
"description_kind": "markdown",
"required": true
},
"scheme": {
"type": "string",
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "HTTPGetAction describes an action based on HTTP Get requests.",
"description_kind": "markdown",
"optional": true
},
"initial_delay_seconds": {
"type": "number",
"description": "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",
"description_kind": "markdown",
"optional": true
},
"period_seconds": {
"type": "number",
"description": "How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.",
"description_kind": "markdown",
"optional": true
},
"success_threshold": {
"type": "number",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"tcp_socket": {
"nested_type": {
"attributes": {
"host": {
"type": "string",
"description": "Optional: Host name to connect to, defaults to the pod IP.",
"description_kind": "markdown",
"optional": true
},
"port": {
"type": "dynamic",
"description": "IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "single"
},
"description": "TCPSocketAction describes an action based on opening a socket",
"description_kind": "markdown",
"optional": true
},
"termination_grace_period_seconds": {
"type": "number",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"timeout_seconds": {
"type": "number",
"description": "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",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
"description_kind": "markdown",
"optional": true
},
"resources": {
"nested_type": {
"attributes": {
"limits": {
"type": [
"map",
"string"
],
"description": "Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/",
"description_kind": "markdown",
"optional": true
},
"requests": {
"type": [
"map",
"string"
],
"description": "Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "ResourceRequirements describes the compute resource requirements.",
"description_kind": "markdown",
"optional": true
},
"security_context": {
"nested_type": {
"attributes": {
"allow_privilege_escalation": {
"type": "bool",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"capabilities": {
"nested_type": {
"attributes": {
"add": {
"type": [
"list",
"string"
],
"description": "Added capabilities",
"description_kind": "markdown",
"optional": true
},
"drop": {
"type": [
"list",
"string"
],
"description": "Removed capabilities",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "Adds and removes POSIX capabilities from running containers.",
"description_kind": "markdown",
"optional": true
},
"privileged": {
"type": "bool",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"proc_mount": {
"type": "string",
"description": "procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.",
"description_kind": "markdown",
"optional": true
},
"read_only_root_filesystem": {
"type": "bool",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"run_as_group": {
"type": "number",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"run_as_non_root": {
"type": "bool",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"run_as_user": {
"type": "number",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"se_linux_options": {
"nested_type": {
"attributes": {
"level": {
"type": "string",
"description": "Level is SELinux level label that applies to the container.",
"description_kind": "markdown",
"optional": true
},
"role": {
"type": "string",
"description": "Role is a SELinux role label that applies to the container.",
"description_kind": "markdown",
"optional": true
},
"type": {
"type": "string",
"description": "Type is a SELinux type label that applies to the container.",
"description_kind": "markdown",
"optional": true
},
"user": {
"type": "string",
"description": "User is a SELinux user label that applies to the container.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "SELinuxOptions are the labels to be applied to the container",
"description_kind": "markdown",
"optional": true
},
"seccomp_profile": {
"nested_type": {
"attributes": {
"localhost_profile": {
"type": "string",
"description": "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 only be set if type is 'Localhost'.",
"description_kind": "markdown",
"optional": true
},
"type": {
"type": "string",
"description": "type indicates which kind of seccomp profile will be applied. Valid options are:Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "single"
},
"description": "SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set.",
"description_kind": "markdown",
"optional": true
},
"windows_options": {
"nested_type": {
"attributes": {
"gmsa_credential_spec": {
"type": "string",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"gmsa_credential_spec_name": {
"type": "string",
"description": "GMSACredentialSpecName is the name of the GMSA credential spec to use.",
"description_kind": "markdown",
"optional": true
},
"host_process": {
"type": "bool",
"description": "HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. 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.",
"description_kind": "markdown",
"optional": true
},
"run_as_user_name": {
"type": "string",
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "WindowsSecurityContextOptions contain Windows-specific options and credentials.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.",
"description_kind": "markdown",
"optional": true
},
"startup_probe": {
"nested_type": {
"attributes": {
"exec": {
"nested_type": {
"attributes": {
"command": {
"type": [
"list",
"string"
],
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "ExecAction describes a 'run in container' action.",
"description_kind": "markdown",
"optional": true
},
"failure_threshold": {
"type": "number",
"description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.",
"description_kind": "markdown",
"optional": true
},
"grpc": {
"nested_type": {
"attributes": {
"port": {
"type": "number",
"description": "Port number of the gRPC service. Number must be in the range 1 to 65535.",
"description_kind": "markdown",
"required": true
},
"service": {
"type": "string",
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description_kind": "plain",
"optional": true
},
"http_get": {
"nested_type": {
"attributes": {
"host": {
"type": "string",
"description": "Host name to connect to, defaults to the pod IP. You probably want to set 'Host' in httpHeaders instead.",
"description_kind": "markdown",
"optional": true
},
"http_headers": {
"nested_type": {
"attributes": {
"name": {
"type": "string",
"description": "The header field name",
"description_kind": "markdown",
"required": true
},
"value": {
"type": "string",
"description": "The header field value",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "list"
},
"description": "Custom headers to set in the request. HTTP allows repeated headers.",
"description_kind": "markdown",
"optional": true
},
"path": {
"type": "string",
"description": "Path to access on the HTTP server.",
"description_kind": "markdown",
"optional": true
},
"port": {
"type": "dynamic",
"description": "IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.",
"description_kind": "markdown",
"required": true
},
"scheme": {
"type": "string",
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "HTTPGetAction describes an action based on HTTP Get requests.",
"description_kind": "markdown",
"optional": true
},
"initial_delay_seconds": {
"type": "number",
"description": "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",
"description_kind": "markdown",
"optional": true
},
"period_seconds": {
"type": "number",
"description": "How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.",
"description_kind": "markdown",
"optional": true
},
"success_threshold": {
"type": "number",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"tcp_socket": {
"nested_type": {
"attributes": {
"host": {
"type": "string",
"description": "Optional: Host name to connect to, defaults to the pod IP.",
"description_kind": "markdown",
"optional": true
},
"port": {
"type": "dynamic",
"description": "IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "single"
},
"description": "TCPSocketAction describes an action based on opening a socket",
"description_kind": "markdown",
"optional": true
},
"termination_grace_period_seconds": {
"type": "number",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"timeout_seconds": {
"type": "number",
"description": "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",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
"description_kind": "markdown",
"optional": true
},
"stdin": {
"type": "bool",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"stdin_once": {
"type": "bool",
"description": "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",
"description_kind": "markdown",
"optional": true
},
"termination_message_path": {
"type": "string",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"termination_message_policy": {
"type": "string",
"description": "Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.",
"description_kind": "markdown",
"optional": true
},
"tty": {
"type": "bool",
"description": "Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.",
"description_kind": "markdown",
"optional": true
},
"volume_devices": {
"nested_type": {
"attributes": {
"device_path": {
"type": "string",
"description": "devicePath is the path inside of the container that the device will be mapped to.",
"description_kind": "markdown",
"required": true
},
"name": {
"type": "string",
"description": "name must match the name of a persistentVolumeClaim in the pod",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "list"
},
"description": "volumeDevices is the list of block devices to be used by the container.",
"description_kind": "markdown",
"optional": true
},
"volume_mounts": {
"nested_type": {
"attributes": {
"mount_path": {
"type": "string",
"description": "Path within the container at which the volume should be mounted. Must not contain ':'.",
"description_kind": "markdown",
"required": true
},
"mount_propagation": {
"type": "string",
"description": "mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.",
"description_kind": "markdown",
"optional": true
},
"name": {
"type": "string",
"description": "This must match the Name of a Volume.",
"description_kind": "markdown",
"required": true
},
"read_only": {
"type": "bool",
"description": "Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.",
"description_kind": "markdown",
"optional": true
},
"sub_path": {
"type": "string",
"description": "Path within the volume from which the container's volume should be mounted. Defaults to '' (volume's root).",
"description_kind": "markdown",
"optional": true
},
"sub_path_expr": {
"type": "string",
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "list"
},
"description": "Pod volumes to mount into the container's filesystem. Cannot be updated.",
"description_kind": "markdown",
"optional": true
},
"working_dir": {
"type": "string",
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "list"
},
"description": "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 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/",
"description_kind": "markdown",
"optional": true
},
"node_name": {
"type": "string",
"description": "NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements.",
"description_kind": "markdown",
"optional": true
},
"node_selector": {
"type": [
"map",
"string"
],
"description": "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/",
"description_kind": "markdown",
"optional": true
},
"os": {
"nested_type": {
"attributes": {
"name": {
"type": "string",
"description": "Name is the name of the operating system. The currently supported values are linux and windows. Additional value may be defined in future and can be one of: https://github.com/opencontainers/runtime-spec/blob/master/config.md#platform-specific-configuration Clients should expect to handle additional values and treat unrecognized values in this field as os: null",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "single"
},
"description": "PodOS defines the OS parameters of a pod.",
"description_kind": "markdown",
"optional": true
},
"overhead": {
"type": [
"map",
"string"
],
"description": "Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. This field will be autopopulated at admission time by the RuntimeClass admission controller. If the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. The RuntimeClass admission controller will reject Pod create requests which have the overhead already set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. More info: https://git.k8s.io/enhancements/keps/sig-node/688-pod-overhead/README.md",
"description_kind": "markdown",
"optional": true
},
"preemption_policy": {
"type": "string",
"description": "PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset.",
"description_kind": "markdown",
"optional": true
},
"priority": {
"type": "number",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"priority_class_name": {
"type": "string",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"readiness_gates": {
"nested_type": {
"attributes": {
"condition_type": {
"type": "string",
"description": "ConditionType refers to a condition in the pod's condition list with matching type.",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "list"
},
"description": "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",
"description_kind": "markdown",
"optional": true
},
"restart_policy": {
"type": "string",
"description": "Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy",
"description_kind": "markdown",
"optional": true
},
"runtime_class_name": {
"type": "string",
"description": "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",
"description_kind": "markdown",
"optional": true
},
"scheduler_name": {
"type": "string",
"description": "If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler.",
"description_kind": "markdown",
"optional": true
},
"security_context": {
"nested_type": {
"attributes": {
"fs_group": {
"type": "number",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"fs_group_change_policy": {
"type": "string",
"description": "fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are 'OnRootMismatch' and 'Always'. If not specified, 'Always' is used. Note that this field cannot be set when spec.os.name is windows.",
"description_kind": "markdown",
"optional": true
},
"run_as_group": {
"type": "number",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"run_as_non_root": {
"type": "bool",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"run_as_user": {
"type": "number",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"se_linux_options": {
"nested_type": {
"attributes": {
"level": {
"type": "string",
"description": "Level is SELinux level label that applies to the container.",
"description_kind": "markdown",
"optional": true
},
"role": {
"type": "string",
"description": "Role is a SELinux role label that applies to the container.",
"description_kind": "markdown",
"optional": true
},
"type": {
"type": "string",
"description": "Type is a SELinux type label that applies to the container.",
"description_kind": "markdown",
"optional": true
},
"user": {
"type": "string",
"description": "User is a SELinux user label that applies to the container.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "SELinuxOptions are the labels to be applied to the container",
"description_kind": "markdown",
"optional": true
},
"seccomp_profile": {
"nested_type": {
"attributes": {
"localhost_profile": {
"type": "string",
"description": "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 only be set if type is 'Localhost'.",
"description_kind": "markdown",
"optional": true
},
"type": {
"type": "string",
"description": "type indicates which kind of seccomp profile will be applied. Valid options are:Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "single"
},
"description": "SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set.",
"description_kind": "markdown",
"optional": true
},
"supplemental_groups": {
"type": [
"list",
"string"
],
"description": "A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container. Note that this field cannot be set when spec.os.name is windows.",
"description_kind": "markdown",
"optional": true
},
"sysctls": {
"nested_type": {
"attributes": {
"name": {
"type": "string",
"description": "Name of a property to set",
"description_kind": "markdown",
"required": true
},
"value": {
"type": "string",
"description": "Value of a property to set",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "list"
},
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"windows_options": {
"nested_type": {
"attributes": {
"gmsa_credential_spec": {
"type": "string",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"gmsa_credential_spec_name": {
"type": "string",
"description": "GMSACredentialSpecName is the name of the GMSA credential spec to use.",
"description_kind": "markdown",
"optional": true
},
"host_process": {
"type": "bool",
"description": "HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. 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.",
"description_kind": "markdown",
"optional": true
},
"run_as_user_name": {
"type": "string",
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "WindowsSecurityContextOptions contain Windows-specific options and credentials.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.",
"description_kind": "markdown",
"optional": true
},
"service_account": {
"type": "string",
"description": "DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead.",
"description_kind": "markdown",
"optional": true
},
"service_account_name": {
"type": "string",
"description": "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/",
"description_kind": "markdown",
"optional": true
},
"set_hostname_as_fqdn": {
"type": "bool",
"description": "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_MACHINESYSTEMCurrentControlSetServicesTcpipParameters to FQDN. If a pod does not have FQDN, this has no effect. Default to false.",
"description_kind": "markdown",
"optional": true
},
"share_process_namespace": {
"type": "bool",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"subdomain": {
"type": "string",
"description": "If specified, the fully qualified Pod hostname will be '<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>'. If not specified, the pod will not have a domainname at all.",
"description_kind": "markdown",
"optional": true
},
"termination_grace_period_seconds": {
"type": "number",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"tolerations": {
"nested_type": {
"attributes": {
"effect": {
"type": "string",
"description": "Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.",
"description_kind": "markdown",
"optional": true
},
"key": {
"type": "string",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"operator": {
"type": "string",
"description": "Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.",
"description_kind": "markdown",
"optional": true
},
"toleration_seconds": {
"type": "number",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"value": {
"type": "string",
"description": "Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "list"
},
"description": "If specified, the pod's tolerations.",
"description_kind": "markdown",
"optional": true
},
"topology_spread_constraints": {
"nested_type": {
"attributes": {
"label_selector": {
"nested_type": {
"attributes": {
"match_expressions": {
"nested_type": {
"attributes": {
"key": {
"type": "string",
"description": "key is the label key that the selector applies to.",
"description_kind": "markdown",
"required": true
},
"operator": {
"type": "string",
"description": "operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.",
"description_kind": "markdown",
"required": true
},
"values": {
"type": [
"list",
"string"
],
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "list"
},
"description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.",
"description_kind": "markdown",
"optional": true
},
"match_labels": {
"type": [
"map",
"string"
],
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"match_label_keys": {
"type": [
"list",
"string"
],
"description": "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. Keys that don't exist in the incoming pod labels will be ignored. A null or empty list means only match against labelSelector.",
"description_kind": "markdown",
"optional": true
},
"max_skew": {
"type": "number",
"description": "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.",
"description_kind": "markdown",
"required": true
},
"min_domains": {
"type": "number",
"description": "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.This is a beta field and requires the MinDomainsInPodTopologySpread feature gate to be enabled (enabled by default).",
"description_kind": "markdown",
"optional": true
},
"node_affinity_policy": {
"type": "string",
"description": "NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector when calculating pod topology spread skew. Options are: - Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations. - Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations.If this value is nil, the behavior is equivalent to the Honor policy. This is a alpha-level feature enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.",
"description_kind": "markdown",
"optional": true
},
"node_taints_policy": {
"type": "string",
"description": "NodeTaintsPolicy indicates how we will treat node taints when calculating pod topology spread skew. Options are: - Honor: nodes without taints, along with tainted nodes for which the incoming pod has a toleration, are included. - Ignore: node taints are ignored. All nodes are included.If this value is nil, the behavior is equivalent to the Ignore policy. This is a alpha-level feature enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.",
"description_kind": "markdown",
"optional": true
},
"topology_key": {
"type": "string",
"description": "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 <key, value> 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.",
"description_kind": "markdown",
"required": true
},
"when_unsatisfiable": {
"type": "string",
"description": "WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location, but giving higher precedence to topologies that would help reduce the skew.A constraint is considered 'Unsatisfiable' for an incoming pod if and only if every possible node assignment for that pod would violate 'MaxSkew' on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it *more* imbalanced. It's a required field.",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "list"
},
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"volumes": {
"nested_type": {
"attributes": {
"aws_elastic_block_store": {
"nested_type": {
"attributes": {
"fs_type": {
"type": "string",
"description": "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",
"description_kind": "markdown",
"optional": true
},
"partition": {
"type": "number",
"description": "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).",
"description_kind": "markdown",
"optional": true
},
"read_only": {
"type": "bool",
"description": "readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore",
"description_kind": "markdown",
"optional": true
},
"volume_id": {
"type": "string",
"description": "volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "single"
},
"description": "Represents a Persistent Disk resource in AWS.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.",
"description_kind": "markdown",
"optional": true
},
"azure_disk": {
"nested_type": {
"attributes": {
"caching_mode": {
"type": "string",
"description": "cachingMode is the Host Caching mode: None, Read Only, Read Write.",
"description_kind": "markdown",
"optional": true
},
"disk_name": {
"type": "string",
"description": "diskName is the Name of the data disk in the blob storage",
"description_kind": "markdown",
"required": true
},
"disk_uri": {
"type": "string",
"description": "diskURI is the URI of data disk in the blob storage",
"description_kind": "markdown",
"required": true
},
"fs_type": {
"type": "string",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"kind": {
"type": "string",
"description": "kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared",
"description_kind": "markdown",
"optional": true
},
"read_only": {
"type": "bool",
"description": "readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.",
"description_kind": "markdown",
"optional": true
},
"azure_file": {
"nested_type": {
"attributes": {
"read_only": {
"type": "bool",
"description": "readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.",
"description_kind": "markdown",
"optional": true
},
"secret_name": {
"type": "string",
"description": "secretName is the name of secret that contains Azure Storage Account Name and Key",
"description_kind": "markdown",
"required": true
},
"share_name": {
"type": "string",
"description": "shareName is the azure share Name",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "single"
},
"description": "AzureFile represents an Azure File Service mount on the host and bind mount to the pod.",
"description_kind": "markdown",
"optional": true
},
"cephfs": {
"nested_type": {
"attributes": {
"monitors": {
"type": [
"list",
"string"
],
"description": "monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it",
"description_kind": "markdown",
"required": true
},
"path": {
"type": "string",
"description": "path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /",
"description_kind": "markdown",
"optional": true
},
"read_only": {
"type": "bool",
"description": "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",
"description_kind": "markdown",
"optional": true
},
"secret_file": {
"type": "string",
"description": "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",
"description_kind": "markdown",
"optional": true
},
"secret_ref": {
"nested_type": {
"attributes": {
"name": {
"type": "string",
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.",
"description_kind": "markdown",
"optional": true
},
"user": {
"type": "string",
"description": "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",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.",
"description_kind": "markdown",
"optional": true
},
"cinder": {
"nested_type": {
"attributes": {
"fs_type": {
"type": "string",
"description": "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",
"description_kind": "markdown",
"optional": true
},
"read_only": {
"type": "bool",
"description": "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",
"description_kind": "markdown",
"optional": true
},
"secret_ref": {
"nested_type": {
"attributes": {
"name": {
"type": "string",
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.",
"description_kind": "markdown",
"optional": true
},
"volume_id": {
"type": "string",
"description": "volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "single"
},
"description": "Represents a cinder volume resource in Openstack. 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.",
"description_kind": "markdown",
"optional": true
},
"config_map": {
"nested_type": {
"attributes": {
"default_mode": {
"type": "number",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"items": {
"nested_type": {
"attributes": {
"key": {
"type": "string",
"description": "key is the key to project.",
"description_kind": "markdown",
"required": true
},
"mode": {
"type": "number",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"path": {
"type": "string",
"description": "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 '..'.",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "list"
},
"description": "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 '..'.",
"description_kind": "markdown",
"optional": true
},
"name": {
"type": "string",
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"description_kind": "markdown",
"optional": true
},
"optional": {
"type": "bool",
"description": "optional specify whether the ConfigMap or its keys must be defined",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "Adapts a ConfigMap into a volume.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.",
"description_kind": "markdown",
"optional": true
},
"csi": {
"nested_type": {
"attributes": {
"driver": {
"type": "string",
"description": "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.",
"description_kind": "markdown",
"required": true
},
"fs_type": {
"type": "string",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"node_publish_secret_ref": {
"nested_type": {
"attributes": {
"name": {
"type": "string",
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.",
"description_kind": "markdown",
"optional": true
},
"read_only": {
"type": "bool",
"description": "readOnly specifies a read-only configuration for the volume. Defaults to false (read/write).",
"description_kind": "markdown",
"optional": true
},
"volume_attributes": {
"type": [
"map",
"string"
],
"description": "volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "Represents a source location of a volume to mount, managed by an external CSI driver",
"description_kind": "markdown",
"optional": true
},
"downward_api": {
"nested_type": {
"attributes": {
"default_mode": {
"type": "number",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"items": {
"nested_type": {
"attributes": {
"field_ref": {
"nested_type": {
"attributes": {
"api_version": {
"type": "string",
"description": "Version of the schema the FieldPath is written in terms of, defaults to 'v1'.",
"description_kind": "markdown",
"optional": true
},
"field_path": {
"type": "string",
"description": "Path of the field to select in the specified API version.",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "single"
},
"description": "ObjectFieldSelector selects an APIVersioned field of an object.",
"description_kind": "markdown",
"optional": true
},
"mode": {
"type": "number",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"path": {
"type": "string",
"description": "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 '..'",
"description_kind": "markdown",
"required": true
},
"resource_field_ref": {
"nested_type": {
"attributes": {
"container_name": {
"type": "string",
"description": "Container name: required for volumes, optional for env vars",
"description_kind": "markdown",
"optional": true
},
"divisor": {
"type": "string",
"description": "Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors.The serialization format is:''' <quantity> ::= <signedNumber><suffix>\t(Note that <suffix> may be empty, from the '' case in <decimalSI>.)<digit> ::= 0 | 1 | ... | 9 <digits> ::= <digit> | <digit><digits> <number> ::= <digits> | <digits>.<digits> | <digits>. | .<digits> <sign> ::= '+' | '-' <signedNumber> ::= <number> | <sign><number> <suffix> ::= <binarySI> | <decimalExponent> | <decimalSI> <binarySI> ::= Ki | Mi | Gi | Ti | Pi | Ei\t(International System of units; See: http://physics.nist.gov/cuu/Units/binary.html)<decimalSI> ::= m | '' | k | M | G | T | P | E\t(Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.)<decimalExponent> ::= 'e' <signedNumber> | 'E' <signedNumber> '''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.",
"description_kind": "markdown",
"optional": true
},
"resource": {
"type": "string",
"description": "Required: resource to select",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "single"
},
"description": "ResourceFieldSelector represents container resources (cpu, memory) and their output format",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "list"
},
"description": "Items is a list of downward API volume file",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling.",
"description_kind": "markdown",
"optional": true
},
"empty_dir": {
"nested_type": {
"attributes": {
"medium": {
"type": "string",
"description": "medium represents what type of storage medium should back this directory. The default is '' which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir",
"description_kind": "markdown",
"optional": true
},
"size_limit": {
"type": "string",
"description": "Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors.The serialization format is:''' <quantity> ::= <signedNumber><suffix>\t(Note that <suffix> may be empty, from the '' case in <decimalSI>.)<digit> ::= 0 | 1 | ... | 9 <digits> ::= <digit> | <digit><digits> <number> ::= <digits> | <digits>.<digits> | <digits>. | .<digits> <sign> ::= '+' | '-' <signedNumber> ::= <number> | <sign><number> <suffix> ::= <binarySI> | <decimalExponent> | <decimalSI> <binarySI> ::= Ki | Mi | Gi | Ti | Pi | Ei\t(International System of units; See: http://physics.nist.gov/cuu/Units/binary.html)<decimalSI> ::= m | '' | k | M | G | T | P | E\t(Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.)<decimalExponent> ::= 'e' <signedNumber> | 'E' <signedNumber> '''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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling.",
"description_kind": "markdown",
"optional": true
},
"ephemeral": {
"nested_type": {
"attributes": {
"volume_claim_template": {
"nested_type": {
"attributes": {
"metadata": {
"nested_type": {
"attributes": {
"annotations": {
"type": [
"map",
"string"
],
"description": "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: http://kubernetes.io/docs/user-guide/annotations",
"description_kind": "markdown",
"optional": true
},
"creation_timestamp": {
"type": "string",
"description": "Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.",
"description_kind": "markdown",
"optional": true
},
"deletion_grace_period_seconds": {
"type": "number",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"deletion_timestamp": {
"type": "string",
"description": "Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.",
"description_kind": "markdown",
"optional": true
},
"finalizers": {
"type": [
"list",
"string"
],
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"generate_name": {
"type": "string",
"description": "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",
"description_kind": "markdown",
"optional": true
},
"generation": {
"type": "number",
"description": "A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.",
"description_kind": "markdown",
"optional": true
},
"labels": {
"type": [
"map",
"string"
],
"description": "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: http://kubernetes.io/docs/user-guide/labels",
"description_kind": "markdown",
"optional": true
},
"managed_fields": {
"nested_type": {
"attributes": {
"api_version": {
"type": "string",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"fields_type": {
"type": "string",
"description": "FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: 'FieldsV1'",
"description_kind": "markdown",
"optional": true
},
"fields_v1": {
"type": [
"map",
"string"
],
"description": "FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format.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:<name>', where <name> is the name of a field in a struct, or key in a map 'v:<value>', where <value> is the exact json formatted value of a list item 'i:<index>', where <index> is position of a item in a list 'k:<keys>', where <keys> 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",
"description_kind": "markdown",
"optional": true
},
"manager": {
"type": "string",
"description": "Manager is an identifier of the workflow managing these fields.",
"description_kind": "markdown",
"optional": true
},
"operation": {
"type": "string",
"description": "Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.",
"description_kind": "markdown",
"optional": true
},
"subresource": {
"type": "string",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"time": {
"type": "string",
"description": "Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "list"
},
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"name": {
"type": "string",
"description": "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: http://kubernetes.io/docs/user-guide/identifiers#names",
"description_kind": "markdown",
"optional": true
},
"namespace": {
"type": "string",
"description": "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: http://kubernetes.io/docs/user-guide/namespaces",
"description_kind": "markdown",
"optional": true
},
"owner_references": {
"nested_type": {
"attributes": {
"api_version": {
"type": "string",
"description": "API version of the referent.",
"description_kind": "markdown",
"required": true
},
"block_owner_deletion": {
"type": "bool",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"controller": {
"type": "bool",
"description": "If true, this reference points to the managing controller.",
"description_kind": "markdown",
"optional": true
},
"kind": {
"type": "string",
"description": "Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"description_kind": "markdown",
"required": true
},
"name": {
"type": "string",
"description": "Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names",
"description_kind": "markdown",
"required": true
},
"uid": {
"type": "string",
"description": "UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "list"
},
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"resource_version": {
"type": "string",
"description": "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",
"description_kind": "markdown",
"optional": true
},
"self_link": {
"type": "string",
"description": "Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.",
"description_kind": "markdown",
"optional": true
},
"uid": {
"type": "string",
"description": "UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.",
"description_kind": "markdown",
"optional": true
},
"spec": {
"nested_type": {
"attributes": {
"access_modes": {
"type": [
"list",
"string"
],
"description": "accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1",
"description_kind": "markdown",
"optional": true
},
"data_source": {
"nested_type": {
"attributes": {
"api_group": {
"type": "string",
"description": "APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.",
"description_kind": "markdown",
"optional": true
},
"kind": {
"type": "string",
"description": "Kind is the type of resource being referenced",
"description_kind": "markdown",
"required": true
},
"name": {
"type": "string",
"description": "Name is the name of resource being referenced",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "single"
},
"description": "TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace.",
"description_kind": "markdown",
"optional": true
},
"data_source_ref": {
"nested_type": {
"attributes": {
"api_group": {
"type": "string",
"description": "APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.",
"description_kind": "markdown",
"optional": true
},
"kind": {
"type": "string",
"description": "Kind is the type of resource being referenced",
"description_kind": "markdown",
"required": true
},
"name": {
"type": "string",
"description": "Name is the name of resource being referenced",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "single"
},
"description": "TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace.",
"description_kind": "markdown",
"optional": true
},
"resources": {
"nested_type": {
"attributes": {
"limits": {
"type": [
"map",
"string"
],
"description": "Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/",
"description_kind": "markdown",
"optional": true
},
"requests": {
"type": [
"map",
"string"
],
"description": "Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "ResourceRequirements describes the compute resource requirements.",
"description_kind": "markdown",
"optional": true
},
"selector": {
"nested_type": {
"attributes": {
"match_expressions": {
"nested_type": {
"attributes": {
"key": {
"type": "string",
"description": "key is the label key that the selector applies to.",
"description_kind": "markdown",
"required": true
},
"operator": {
"type": "string",
"description": "operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.",
"description_kind": "markdown",
"required": true
},
"values": {
"type": [
"list",
"string"
],
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "list"
},
"description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.",
"description_kind": "markdown",
"optional": true
},
"match_labels": {
"type": [
"map",
"string"
],
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"storage_class_name": {
"type": "string",
"description": "storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1",
"description_kind": "markdown",
"optional": true
},
"volume_mode": {
"type": "string",
"description": "volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.",
"description_kind": "markdown",
"optional": true
},
"volume_name": {
"type": "string",
"description": "volumeName is the binding reference to the PersistentVolume backing this claim.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "single"
},
"description": "PersistentVolumeClaimTemplate is used to produce PersistentVolumeClaim objects as part of an EphemeralVolumeSource.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "Represents an ephemeral volume that is handled by a normal storage driver.",
"description_kind": "markdown",
"optional": true
},
"fc": {
"nested_type": {
"attributes": {
"fs_type": {
"type": "string",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"lun": {
"type": "number",
"description": "lun is Optional: FC target lun number",
"description_kind": "markdown",
"optional": true
},
"read_only": {
"type": "bool",
"description": "readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.",
"description_kind": "markdown",
"optional": true
},
"target_ww_ns": {
"type": [
"list",
"string"
],
"description": "targetWWNs is Optional: FC target worldwide names (WWNs)",
"description_kind": "markdown",
"optional": true
},
"wwids": {
"type": [
"list",
"string"
],
"description": "wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling.",
"description_kind": "markdown",
"optional": true
},
"flex_volume": {
"nested_type": {
"attributes": {
"driver": {
"type": "string",
"description": "driver is the name of the driver to use for this volume.",
"description_kind": "markdown",
"required": true
},
"fs_type": {
"type": "string",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"options": {
"type": [
"map",
"string"
],
"description": "options is Optional: this field holds extra command options if any.",
"description_kind": "markdown",
"optional": true
},
"read_only": {
"type": "bool",
"description": "readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.",
"description_kind": "markdown",
"optional": true
},
"secret_ref": {
"nested_type": {
"attributes": {
"name": {
"type": "string",
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.",
"description_kind": "markdown",
"optional": true
},
"flocker": {
"nested_type": {
"attributes": {
"dataset_name": {
"type": "string",
"description": "datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated",
"description_kind": "markdown",
"optional": true
},
"dataset_uuid": {
"type": "string",
"description": "datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling.",
"description_kind": "markdown",
"optional": true
},
"gce_persistent_disk": {
"nested_type": {
"attributes": {
"fs_type": {
"type": "string",
"description": "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",
"description_kind": "markdown",
"optional": true
},
"partition": {
"type": "number",
"description": "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",
"description_kind": "markdown",
"optional": true
},
"pd_name": {
"type": "string",
"description": "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",
"description_kind": "markdown",
"required": true
},
"read_only": {
"type": "bool",
"description": "readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "Represents a Persistent Disk resource in Google Compute Engine.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.",
"description_kind": "markdown",
"optional": true
},
"git_repo": {
"nested_type": {
"attributes": {
"directory": {
"type": "string",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"repository": {
"type": "string",
"description": "repository is the URL",
"description_kind": "markdown",
"required": true
},
"revision": {
"type": "string",
"description": "revision is the commit hash for the specified revision.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling.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.",
"description_kind": "markdown",
"optional": true
},
"glusterfs": {
"nested_type": {
"attributes": {
"endpoints": {
"type": "string",
"description": "endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod",
"description_kind": "markdown",
"required": true
},
"path": {
"type": "string",
"description": "path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod",
"description_kind": "markdown",
"required": true
},
"read_only": {
"type": "bool",
"description": "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",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.",
"description_kind": "markdown",
"optional": true
},
"host_path": {
"nested_type": {
"attributes": {
"path": {
"type": "string",
"description": "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",
"description_kind": "markdown",
"required": true
},
"type": {
"type": "string",
"description": "type for HostPath Volume Defaults to '' More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.",
"description_kind": "markdown",
"optional": true
},
"iscsi": {
"nested_type": {
"attributes": {
"chap_auth_discovery": {
"type": "bool",
"description": "chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication",
"description_kind": "markdown",
"optional": true
},
"chap_auth_session": {
"type": "bool",
"description": "chapAuthSession defines whether support iSCSI Session CHAP authentication",
"description_kind": "markdown",
"optional": true
},
"fs_type": {
"type": "string",
"description": "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",
"description_kind": "markdown",
"optional": true
},
"initiator_name": {
"type": "string",
"description": "initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection.",
"description_kind": "markdown",
"optional": true
},
"iqn": {
"type": "string",
"description": "iqn is the target iSCSI Qualified Name.",
"description_kind": "markdown",
"required": true
},
"iscsi_interface": {
"type": "string",
"description": "iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).",
"description_kind": "markdown",
"optional": true
},
"lun": {
"type": "number",
"description": "lun represents iSCSI Target Lun number.",
"description_kind": "markdown",
"required": true
},
"portals": {
"type": [
"list",
"string"
],
"description": "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).",
"description_kind": "markdown",
"optional": true
},
"read_only": {
"type": "bool",
"description": "readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.",
"description_kind": "markdown",
"optional": true
},
"secret_ref": {
"nested_type": {
"attributes": {
"name": {
"type": "string",
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.",
"description_kind": "markdown",
"optional": true
},
"target_portal": {
"type": "string",
"description": "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).",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "single"
},
"description": "Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.",
"description_kind": "markdown",
"optional": true
},
"name": {
"type": "string",
"description": "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",
"description_kind": "markdown",
"required": true
},
"nfs": {
"nested_type": {
"attributes": {
"path": {
"type": "string",
"description": "path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs",
"description_kind": "markdown",
"required": true
},
"read_only": {
"type": "bool",
"description": "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",
"description_kind": "markdown",
"optional": true
},
"server": {
"type": "string",
"description": "server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "single"
},
"description": "Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling.",
"description_kind": "markdown",
"optional": true
},
"persistent_volume_claim": {
"nested_type": {
"attributes": {
"claim_name": {
"type": "string",
"description": "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",
"description_kind": "markdown",
"required": true
},
"read_only": {
"type": "bool",
"description": "readOnly Will force the ReadOnly setting in VolumeMounts. Default false.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "PersistentVolumeClaimVolumeSource references the user's PVC in the same namespace. 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).",
"description_kind": "markdown",
"optional": true
},
"photon_persistent_disk": {
"nested_type": {
"attributes": {
"fs_type": {
"type": "string",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"pd_id": {
"type": "string",
"description": "pdID is the ID that identifies Photon Controller persistent disk",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "single"
},
"description": "Represents a Photon Controller persistent disk resource.",
"description_kind": "markdown",
"optional": true
},
"portworx_volume": {
"nested_type": {
"attributes": {
"fs_type": {
"type": "string",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"read_only": {
"type": "bool",
"description": "readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.",
"description_kind": "markdown",
"optional": true
},
"volume_id": {
"type": "string",
"description": "volumeID uniquely identifies a Portworx volume",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "single"
},
"description": "PortworxVolumeSource represents a Portworx volume resource.",
"description_kind": "markdown",
"optional": true
},
"projected": {
"nested_type": {
"attributes": {
"default_mode": {
"type": "number",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"sources": {
"nested_type": {
"attributes": {
"config_map": {
"nested_type": {
"attributes": {
"items": {
"nested_type": {
"attributes": {
"key": {
"type": "string",
"description": "key is the key to project.",
"description_kind": "markdown",
"required": true
},
"mode": {
"type": "number",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"path": {
"type": "string",
"description": "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 '..'.",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "list"
},
"description": "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 '..'.",
"description_kind": "markdown",
"optional": true
},
"name": {
"type": "string",
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"description_kind": "markdown",
"optional": true
},
"optional": {
"type": "bool",
"description": "optional specify whether the ConfigMap or its keys must be defined",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "Adapts a ConfigMap into a projected volume.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.",
"description_kind": "markdown",
"optional": true
},
"downward_api": {
"nested_type": {
"attributes": {
"items": {
"nested_type": {
"attributes": {
"field_ref": {
"nested_type": {
"attributes": {
"api_version": {
"type": "string",
"description": "Version of the schema the FieldPath is written in terms of, defaults to 'v1'.",
"description_kind": "markdown",
"optional": true
},
"field_path": {
"type": "string",
"description": "Path of the field to select in the specified API version.",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "single"
},
"description": "ObjectFieldSelector selects an APIVersioned field of an object.",
"description_kind": "markdown",
"optional": true
},
"mode": {
"type": "number",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"path": {
"type": "string",
"description": "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 '..'",
"description_kind": "markdown",
"required": true
},
"resource_field_ref": {
"nested_type": {
"attributes": {
"container_name": {
"type": "string",
"description": "Container name: required for volumes, optional for env vars",
"description_kind": "markdown",
"optional": true
},
"divisor": {
"type": "string",
"description": "Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors.The serialization format is:''' <quantity> ::= <signedNumber><suffix>\t(Note that <suffix> may be empty, from the '' case in <decimalSI>.)<digit> ::= 0 | 1 | ... | 9 <digits> ::= <digit> | <digit><digits> <number> ::= <digits> | <digits>.<digits> | <digits>. | .<digits> <sign> ::= '+' | '-' <signedNumber> ::= <number> | <sign><number> <suffix> ::= <binarySI> | <decimalExponent> | <decimalSI> <binarySI> ::= Ki | Mi | Gi | Ti | Pi | Ei\t(International System of units; See: http://physics.nist.gov/cuu/Units/binary.html)<decimalSI> ::= m | '' | k | M | G | T | P | E\t(Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.)<decimalExponent> ::= 'e' <signedNumber> | 'E' <signedNumber> '''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.",
"description_kind": "markdown",
"optional": true
},
"resource": {
"type": "string",
"description": "Required: resource to select",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "single"
},
"description": "ResourceFieldSelector represents container resources (cpu, memory) and their output format",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "list"
},
"description": "Items is a list of DownwardAPIVolume file",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "Represents downward API info for projecting into a projected volume. Note that this is identical to a downwardAPI volume source without the default mode.",
"description_kind": "markdown",
"optional": true
},
"secret": {
"nested_type": {
"attributes": {
"items": {
"nested_type": {
"attributes": {
"key": {
"type": "string",
"description": "key is the key to project.",
"description_kind": "markdown",
"required": true
},
"mode": {
"type": "number",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"path": {
"type": "string",
"description": "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 '..'.",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "list"
},
"description": "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 '..'.",
"description_kind": "markdown",
"optional": true
},
"name": {
"type": "string",
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"description_kind": "markdown",
"optional": true
},
"optional": {
"type": "bool",
"description": "optional field specify whether the Secret or its key must be defined",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "Adapts a secret into a projected volume.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.",
"description_kind": "markdown",
"optional": true
},
"service_account_token": {
"nested_type": {
"attributes": {
"audience": {
"type": "string",
"description": "audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.",
"description_kind": "markdown",
"optional": true
},
"expiration_seconds": {
"type": "number",
"description": "expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes.",
"description_kind": "markdown",
"optional": true
},
"path": {
"type": "string",
"description": "path is the path relative to the mount point of the file to project the token into.",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "single"
},
"description": "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).",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "list"
},
"description": "sources is the list of volume projections",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "Represents a projected volume source",
"description_kind": "markdown",
"optional": true
},
"quobyte": {
"nested_type": {
"attributes": {
"group": {
"type": "string",
"description": "group to map volume access to Default is no group",
"description_kind": "markdown",
"optional": true
},
"read_only": {
"type": "bool",
"description": "readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.",
"description_kind": "markdown",
"optional": true
},
"registry": {
"type": "string",
"description": "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",
"description_kind": "markdown",
"required": true
},
"tenant": {
"type": "string",
"description": "tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin",
"description_kind": "markdown",
"optional": true
},
"user": {
"type": "string",
"description": "user to map volume access to Defaults to serivceaccount user",
"description_kind": "markdown",
"optional": true
},
"volume": {
"type": "string",
"description": "volume is a string that references an already created Quobyte volume by name.",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "single"
},
"description": "Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.",
"description_kind": "markdown",
"optional": true
},
"rbd": {
"nested_type": {
"attributes": {
"fs_type": {
"type": "string",
"description": "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",
"description_kind": "markdown",
"optional": true
},
"image": {
"type": "string",
"description": "image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it",
"description_kind": "markdown",
"required": true
},
"keyring": {
"type": "string",
"description": "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",
"description_kind": "markdown",
"optional": true
},
"monitors": {
"type": [
"list",
"string"
],
"description": "monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it",
"description_kind": "markdown",
"required": true
},
"pool": {
"type": "string",
"description": "pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it",
"description_kind": "markdown",
"optional": true
},
"read_only": {
"type": "bool",
"description": "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",
"description_kind": "markdown",
"optional": true
},
"secret_ref": {
"nested_type": {
"attributes": {
"name": {
"type": "string",
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.",
"description_kind": "markdown",
"optional": true
},
"user": {
"type": "string",
"description": "user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.",
"description_kind": "markdown",
"optional": true
},
"scale_io": {
"nested_type": {
"attributes": {
"fs_type": {
"type": "string",
"description": "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'.",
"description_kind": "markdown",
"optional": true
},
"gateway": {
"type": "string",
"description": "gateway is the host address of the ScaleIO API Gateway.",
"description_kind": "markdown",
"required": true
},
"protection_domain": {
"type": "string",
"description": "protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.",
"description_kind": "markdown",
"optional": true
},
"read_only": {
"type": "bool",
"description": "readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.",
"description_kind": "markdown",
"optional": true
},
"secret_ref": {
"nested_type": {
"attributes": {
"name": {
"type": "string",
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.",
"description_kind": "markdown",
"required": true
},
"ssl_enabled": {
"type": "bool",
"description": "sslEnabled Flag enable/disable SSL communication with Gateway, default false",
"description_kind": "markdown",
"optional": true
},
"storage_mode": {
"type": "string",
"description": "storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.",
"description_kind": "markdown",
"optional": true
},
"storage_pool": {
"type": "string",
"description": "storagePool is the ScaleIO Storage Pool associated with the protection domain.",
"description_kind": "markdown",
"optional": true
},
"system": {
"type": "string",
"description": "system is the name of the storage system as configured in ScaleIO.",
"description_kind": "markdown",
"required": true
},
"volume_name": {
"type": "string",
"description": "volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "ScaleIOVolumeSource represents a persistent ScaleIO volume",
"description_kind": "markdown",
"optional": true
},
"secret": {
"nested_type": {
"attributes": {
"default_mode": {
"type": "number",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"items": {
"nested_type": {
"attributes": {
"key": {
"type": "string",
"description": "key is the key to project.",
"description_kind": "markdown",
"required": true
},
"mode": {
"type": "number",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"path": {
"type": "string",
"description": "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 '..'.",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "list"
},
"description": "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 '..'.",
"description_kind": "markdown",
"optional": true
},
"optional": {
"type": "bool",
"description": "optional field specify whether the Secret or its keys must be defined",
"description_kind": "markdown",
"optional": true
},
"secret_name": {
"type": "string",
"description": "secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "Adapts a Secret into a volume.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.",
"description_kind": "markdown",
"optional": true
},
"storageos": {
"nested_type": {
"attributes": {
"fs_type": {
"type": "string",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"read_only": {
"type": "bool",
"description": "readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.",
"description_kind": "markdown",
"optional": true
},
"secret_ref": {
"nested_type": {
"attributes": {
"name": {
"type": "string",
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.",
"description_kind": "markdown",
"optional": true
},
"volume_name": {
"type": "string",
"description": "volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.",
"description_kind": "markdown",
"optional": true
},
"volume_namespace": {
"type": "string",
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "Represents a StorageOS persistent volume resource.",
"description_kind": "markdown",
"optional": true
},
"vsphere_volume": {
"nested_type": {
"attributes": {
"fs_type": {
"type": "string",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"storage_policy_id": {
"type": "string",
"description": "storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.",
"description_kind": "markdown",
"optional": true
},
"storage_policy_name": {
"type": "string",
"description": "storagePolicyName is the storage Policy Based Management (SPBM) profile name.",
"description_kind": "markdown",
"optional": true
},
"volume_path": {
"type": "string",
"description": "volumePath is the path that identifies vSphere volume vmdk",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "single"
},
"description": "Represents a vSphere volume resource.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "list"
},
"description": "List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "PodSpec is a description of a pod.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "PodTemplateSpec describes the data a pod should have when created from a template",
"description_kind": "markdown",
"required": true
},
"update_strategy": {
"nested_type": {
"attributes": {
"rolling_update": {
"nested_type": {
"attributes": {
"max_unavailable": {
"type": "dynamic",
"description": "IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.",
"description_kind": "markdown",
"optional": true
},
"partition": {
"type": "number",
"description": "Partition indicates the ordinal at which the StatefulSet should be partitioned for updates. During a rolling update, all pods from ordinal Replicas-1 to Partition are updated. All pods from ordinal Partition-1 to 0 remain untouched. This is helpful in being able to do a canary based deployment. The default value is 0.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType.",
"description_kind": "markdown",
"optional": true
},
"type": {
"type": "string",
"description": "Type indicates the type of the StatefulSetUpdateStrategy. Default is RollingUpdate.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "StatefulSetUpdateStrategy indicates the strategy that the StatefulSet controller will use to perform updates. It includes any additional parameters necessary to perform the update for the indicated strategy.",
"description_kind": "markdown",
"optional": true
},
"volume_claim_templates": {
"nested_type": {
"attributes": {
"api_version": {
"type": "string",
"description": "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",
"description_kind": "markdown",
"optional": true
},
"kind": {
"type": "string",
"description": "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",
"description_kind": "markdown",
"optional": true
},
"metadata": {
"nested_type": {
"attributes": {
"annotations": {
"type": [
"map",
"string"
],
"description": "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: http://kubernetes.io/docs/user-guide/annotations",
"description_kind": "markdown",
"optional": true
},
"creation_timestamp": {
"type": "string",
"description": "Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.",
"description_kind": "markdown",
"optional": true
},
"deletion_grace_period_seconds": {
"type": "number",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"deletion_timestamp": {
"type": "string",
"description": "Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.",
"description_kind": "markdown",
"optional": true
},
"finalizers": {
"type": [
"list",
"string"
],
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"generate_name": {
"type": "string",
"description": "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",
"description_kind": "markdown",
"optional": true
},
"generation": {
"type": "number",
"description": "A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.",
"description_kind": "markdown",
"optional": true
},
"labels": {
"type": [
"map",
"string"
],
"description": "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: http://kubernetes.io/docs/user-guide/labels",
"description_kind": "markdown",
"optional": true
},
"managed_fields": {
"nested_type": {
"attributes": {
"api_version": {
"type": "string",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"fields_type": {
"type": "string",
"description": "FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: 'FieldsV1'",
"description_kind": "markdown",
"optional": true
},
"fields_v1": {
"type": [
"map",
"string"
],
"description": "FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format.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:<name>', where <name> is the name of a field in a struct, or key in a map 'v:<value>', where <value> is the exact json formatted value of a list item 'i:<index>', where <index> is position of a item in a list 'k:<keys>', where <keys> 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",
"description_kind": "markdown",
"optional": true
},
"manager": {
"type": "string",
"description": "Manager is an identifier of the workflow managing these fields.",
"description_kind": "markdown",
"optional": true
},
"operation": {
"type": "string",
"description": "Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.",
"description_kind": "markdown",
"optional": true
},
"subresource": {
"type": "string",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"time": {
"type": "string",
"description": "Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "list"
},
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"name": {
"type": "string",
"description": "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: http://kubernetes.io/docs/user-guide/identifiers#names",
"description_kind": "markdown",
"optional": true
},
"namespace": {
"type": "string",
"description": "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: http://kubernetes.io/docs/user-guide/namespaces",
"description_kind": "markdown",
"optional": true
},
"owner_references": {
"nested_type": {
"attributes": {
"api_version": {
"type": "string",
"description": "API version of the referent.",
"description_kind": "markdown",
"required": true
},
"block_owner_deletion": {
"type": "bool",
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"controller": {
"type": "bool",
"description": "If true, this reference points to the managing controller.",
"description_kind": "markdown",
"optional": true
},
"kind": {
"type": "string",
"description": "Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"description_kind": "markdown",
"required": true
},
"name": {
"type": "string",
"description": "Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names",
"description_kind": "markdown",
"required": true
},
"uid": {
"type": "string",
"description": "UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "list"
},
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"resource_version": {
"type": "string",
"description": "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",
"description_kind": "markdown",
"optional": true
},
"self_link": {
"type": "string",
"description": "Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.",
"description_kind": "markdown",
"optional": true
},
"uid": {
"type": "string",
"description": "UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.",
"description_kind": "markdown",
"optional": true
},
"spec": {
"nested_type": {
"attributes": {
"access_modes": {
"type": [
"list",
"string"
],
"description": "accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1",
"description_kind": "markdown",
"optional": true
},
"data_source": {
"nested_type": {
"attributes": {
"api_group": {
"type": "string",
"description": "APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.",
"description_kind": "markdown",
"optional": true
},
"kind": {
"type": "string",
"description": "Kind is the type of resource being referenced",
"description_kind": "markdown",
"required": true
},
"name": {
"type": "string",
"description": "Name is the name of resource being referenced",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "single"
},
"description": "TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace.",
"description_kind": "markdown",
"optional": true
},
"data_source_ref": {
"nested_type": {
"attributes": {
"api_group": {
"type": "string",
"description": "APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.",
"description_kind": "markdown",
"optional": true
},
"kind": {
"type": "string",
"description": "Kind is the type of resource being referenced",
"description_kind": "markdown",
"required": true
},
"name": {
"type": "string",
"description": "Name is the name of resource being referenced",
"description_kind": "markdown",
"required": true
}
},
"nesting_mode": "single"
},
"description": "TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace.",
"description_kind": "markdown",
"optional": true
},
"resources": {
"nested_type": {
"attributes": {
"limits": {
"type": [
"map",
"string"
],
"description": "Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/",
"description_kind": "markdown",
"optional": true
},
"requests": {
"type": [
"map",
"string"
],
"description": "Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "ResourceRequirements describes the compute resource requirements.",
"description_kind": "markdown",
"optional": true
},
"selector": {
"nested_type": {
"attributes": {
"match_expressions": {
"nested_type": {
"attributes": {
"key": {
"type": "string",
"description": "key is the label key that the selector applies to.",
"description_kind": "markdown",
"required": true
},
"operator": {
"type": "string",
"description": "operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.",
"description_kind": "markdown",
"required": true
},
"values": {
"type": [
"list",
"string"
],
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "list"
},
"description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.",
"description_kind": "markdown",
"optional": true
},
"match_labels": {
"type": [
"map",
"string"
],
"description": "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.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "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.",
"description_kind": "markdown",
"optional": true
},
"storage_class_name": {
"type": "string",
"description": "storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1",
"description_kind": "markdown",
"optional": true
},
"volume_mode": {
"type": "string",
"description": "volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.",
"description_kind": "markdown",
"optional": true
},
"volume_name": {
"type": "string",
"description": "volumeName is the binding reference to the PersistentVolume backing this claim.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes",
"description_kind": "markdown",
"optional": true
},
"status": {
"nested_type": {
"attributes": {
"access_modes": {
"type": [
"list",
"string"
],
"description": "accessModes contains the actual access modes the volume backing the PVC has. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1",
"description_kind": "markdown",
"optional": true
},
"allocated_resources": {
"type": [
"map",
"string"
],
"description": "allocatedResources is the storage resource within AllocatedResources tracks the capacity allocated to a PVC. It may be larger than the actual capacity when a volume expansion operation is requested. For storage quota, the larger value from allocatedResources and PVC.spec.resources is used. If allocatedResources is not set, PVC.spec.resources alone is used for quota calculation. If a volume expansion capacity request is lowered, allocatedResources is only lowered if there are no expansion operations in progress and if the actual volume capacity is equal or lower than the requested capacity. This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.",
"description_kind": "markdown",
"optional": true
},
"capacity": {
"type": [
"map",
"string"
],
"description": "capacity represents the actual resources of the underlying volume.",
"description_kind": "markdown",
"optional": true
},
"conditions": {
"nested_type": {
"attributes": {
"last_probe_time": {
"type": "string",
"description": "Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.",
"description_kind": "markdown",
"optional": true
},
"last_transition_time": {
"type": "string",
"description": "Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.",
"description_kind": "markdown",
"optional": true
},
"message": {
"type": "string",
"description": "message is the human-readable message indicating details about last transition.",
"description_kind": "markdown",
"optional": true
},
"reason": {
"type": "string",
"description": "reason is a unique, this should be a short, machine understandable string that gives the reason for condition's last transition. If it reports 'ResizeStarted' that means the underlying persistent volume is being resized.",
"description_kind": "markdown",
"optional": true
},
"status": {
"type": "string",
"description_kind": "plain",
"required": true
},
"type": {
"type": "string",
"description_kind": "plain",
"required": true
}
},
"nesting_mode": "list"
},
"description": "conditions is the current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'ResizeStarted'.",
"description_kind": "markdown",
"optional": true
},
"phase": {
"type": "string",
"description": "phase represents the current phase of PersistentVolumeClaim.",
"description_kind": "markdown",
"optional": true
},
"resize_status": {
"type": "string",
"description": "resizeStatus stores status of resize operation. ResizeStatus is not set by default but when expansion is complete resizeStatus is set to empty string by resize controller or kubelet. This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "PersistentVolumeClaimStatus is the current status of a persistent volume claim.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "list"
},
"description": "volumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name.",
"description_kind": "markdown",
"optional": true
}
},
"nesting_mode": "single"
},
"description": "A StatefulSetSpec is the specification of a StatefulSet.",
"description_kind": "markdown",
"optional": true
},
"yaml": {
"type": "string",
"description": "The generated manifest in YAML format.",
"description_kind": "markdown",
"computed": true
}
},
"description": "StatefulSet represents a set of pods with consistent identities. Identities are defined as: - Network: A single stable DNS and hostname. - Storage: As many VolumeClaims as requested.The StatefulSet guarantees that a given network identity will always map to the same storage identity.",
"description_kind": "markdown"
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment