Merge pull request #32833 from feloy/api-reference-multi-pages
API reference multi pages for v1.24pull/33265/head
Kubernetes Prow Robot
GitHub
commit
61095d4544
File diff suppressed because it is too large
Load Diff
|
|
@ -405,6 +405,7 @@
|
|||
- fields:
|
||||
- jobTemplate
|
||||
- schedule
|
||||
- timeZone
|
||||
- concurrencyPolicy
|
||||
- startingDeadlineSeconds
|
||||
- suspend
|
||||
|
|
|
|||
|
|
@ -124,7 +124,7 @@ parts:
|
|||
version: v1
|
||||
- name: CSIStorageCapacity
|
||||
group: storage.k8s.io
|
||||
version: v1beta1
|
||||
version: v1
|
||||
- name: Authentication Resources
|
||||
chapters:
|
||||
- name: ServiceAccount
|
||||
|
|
|
|||
|
|
@ -109,8 +109,6 @@ CertificateSigningRequestSpec contains the certificate request.
|
|||
3. Signer whose configured minimum is longer than the requested duration
|
||||
|
||||
The minimum valid value for expirationSeconds is 600, i.e. 10 minutes.
|
||||
|
||||
As of v1.22, this field is beta and is controlled via the CSRDuration feature gate.
|
||||
|
||||
- **extra** (map[string][]string)
|
||||
|
||||
|
|
@ -212,11 +210,6 @@ CertificateSigningRequestStatus contains conditions used to indicate approved/de
|
|||
Approved and Denied conditions are mutually exclusive. Approved, Denied, and Failed conditions cannot be removed once added.
|
||||
|
||||
Only one condition of a given type is allowed.
|
||||
|
||||
Possible enum values:
|
||||
- `"Approved"` Approved indicates the request was approved and should be issued by the signer.
|
||||
- `"Denied"` Denied indicates the request was denied and should not be issued by the signer.
|
||||
- `"Failed"` Failed indicates the signer failed to issue the certificate.
|
||||
|
||||
- **conditions.lastTransitionTime** (Time)
|
||||
|
||||
|
|
|
|||
|
|
@ -54,7 +54,7 @@ ServiceAccount binds together: * a name, understood by users, and perhaps by per
|
|||
|
||||
*Patch strategy: merge on key `name`*
|
||||
|
||||
Secrets is the list of secrets allowed to be used by pods running using this ServiceAccount. More info: https://kubernetes.io/docs/concepts/configuration/secret
|
||||
Secrets is a list of the secrets in the same namespace that pods running using this ServiceAccount are allowed to use. Pods are only limited to this list if this service account has a "kubernetes.io/enforce-mountable-secrets" annotation set to "true". This field should not be used to find auto-generated service account token secrets for use outside of pods. Instead, tokens can be requested directly using the TokenRequest API, or service account token secrets can be manually created. More info: https://kubernetes.io/docs/concepts/configuration/secret
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -90,13 +90,6 @@ NamespaceStatus is information about the current status of a Namespace.
|
|||
- **conditions.type** (string), required
|
||||
|
||||
Type of namespace controller condition.
|
||||
|
||||
Possible enum values:
|
||||
- `"NamespaceContentRemaining"` contains information about resources remaining in a namespace.
|
||||
- `"NamespaceDeletionContentFailure"` contains information about namespace deleter errors during deletion of resources.
|
||||
- `"NamespaceDeletionDiscoveryFailure"` contains information about namespace deleter errors during resource discovery.
|
||||
- `"NamespaceDeletionGroupVersionParsingFailure"` contains information about namespace deleter errors parsing GV for legacy types.
|
||||
- `"NamespaceFinalizersRemaining"` contains information about which finalizers are on resources remaining in a namespace.
|
||||
|
||||
- **conditions.lastTransitionTime** (Time)
|
||||
|
||||
|
|
@ -114,9 +107,7 @@ NamespaceStatus is information about the current status of a Namespace.
|
|||
|
||||
Phase is the current lifecycle phase of the namespace. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/
|
||||
|
||||
Possible enum values:
|
||||
- `"Active"` means the namespace is available for use in the system
|
||||
- `"Terminating"` means the namespace is undergoing graceful termination
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -62,7 +62,7 @@ NodeSpec describes the attributes that a node is created with.
|
|||
|
||||
- **configSource** (NodeConfigSource)
|
||||
|
||||
Deprecated. If specified, the source of the node's configuration. The DynamicKubeletConfig feature gate must be enabled for the Kubelet to use this field. This field is deprecated as of 1.22: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration
|
||||
Deprecated: Previously used to specify the source of the node's configuration for the DynamicKubeletConfig feature. This feature is removed from Kubelets as of 1.24 and will be fully removed in 1.26.
|
||||
|
||||
<a name="NodeConfigSource"></a>
|
||||
*NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil. This API is deprecated since 1.22*
|
||||
|
|
@ -121,10 +121,7 @@ NodeSpec describes the attributes that a node is created with.
|
|||
|
||||
Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute.
|
||||
|
||||
Possible enum values:
|
||||
- `"NoExecute"` Evict any already-running pods that do not tolerate the taint. Currently enforced by NodeController.
|
||||
- `"NoSchedule"` Do not allow new pods to schedule onto the node unless they tolerate the taint, but allow all pods submitted to Kubelet without going through the scheduler to start, and allow all already-running pods to continue running. Enforced by the scheduler.
|
||||
- `"PreferNoSchedule"` Like TaintEffectNoSchedule, but the scheduler tries not to schedule new pods onto the node, rather than prohibiting new pods from scheduling onto the node entirely. Enforced by the scheduler.
|
||||
|
||||
|
||||
- **taints.key** (string), required
|
||||
|
||||
|
|
@ -171,13 +168,6 @@ NodeStatus is information about the current status of a node.
|
|||
- **addresses.type** (string), required
|
||||
|
||||
Node address type, one of Hostname, ExternalIP or InternalIP.
|
||||
|
||||
Possible enum values:
|
||||
- `"ExternalDNS"` identifies a DNS name which resolves to an IP address which has the characteristics of a NodeExternalIP. The IP it resolves to may or may not be a listed NodeExternalIP address.
|
||||
- `"ExternalIP"` identifies an IP address which is, in some way, intended to be more usable from outside the cluster then an internal IP, though no specific semantics are defined. It may be a globally routable IP, though it is not required to be. External IPs may be assigned directly to an interface on the node, like a NodeInternalIP, or alternatively, packets sent to the external IP may be NAT'ed to an internal node IP rather than being delivered directly (making the IP less efficient for node-to-node traffic than a NodeInternalIP).
|
||||
- `"Hostname"` identifies a name of the node. Although every node can be assumed to have a NodeAddress of this type, its exact syntax and semantics are not defined, and are not consistent between different clusters.
|
||||
- `"InternalDNS"` identifies a DNS name which resolves to an IP address which has the characteristics of a NodeInternalIP. The IP it resolves to may or may not be a listed NodeInternalIP address.
|
||||
- `"InternalIP"` identifies an IP address which is assigned to one of the node's network interfaces. Every node should have at least one address of this type. An internal IP is normally expected to be reachable from every other node, but may not be visible to hosts outside the cluster. By default it is assumed that kube-apiserver can reach node internal IPs, though it is possible to configure clusters where this is not the case. NodeInternalIP is the default type of node IP, and does not necessarily imply that the IP is ONLY reachable internally. If a node has multiple internal IPs, no specific semantics are assigned to the additional IPs.
|
||||
|
||||
- **allocatable** (map[string]<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
|
||||
|
||||
|
|
@ -203,13 +193,6 @@ NodeStatus is information about the current status of a node.
|
|||
- **conditions.type** (string), required
|
||||
|
||||
Type of node condition.
|
||||
|
||||
Possible enum values:
|
||||
- `"DiskPressure"` means the kubelet is under pressure due to insufficient available disk.
|
||||
- `"MemoryPressure"` means the kubelet is under pressure due to insufficient available memory.
|
||||
- `"NetworkUnavailable"` means that network for the node is not correctly configured.
|
||||
- `"PIDPressure"` means the kubelet is under pressure due to insufficient available PID.
|
||||
- `"Ready"` means kubelet is healthy and ready to accept pods.
|
||||
|
||||
- **conditions.lastHeartbeatTime** (Time)
|
||||
|
||||
|
|
@ -396,7 +379,7 @@ NodeStatus is information about the current status of a node.
|
|||
|
||||
- **nodeInfo.containerRuntimeVersion** (string), required
|
||||
|
||||
ContainerRuntime Version reported by the node through runtime remote API (e.g. docker://1.5.0).
|
||||
ContainerRuntime Version reported by the node through runtime remote API (e.g. containerd://1.4.2).
|
||||
|
||||
- **nodeInfo.kernelVersion** (string), required
|
||||
|
||||
|
|
@ -430,10 +413,7 @@ NodeStatus is information about the current status of a node.
|
|||
|
||||
NodePhase is the recently observed lifecycle phase of the node. More info: https://kubernetes.io/docs/concepts/nodes/node/#phase The field is never populated, and now is deprecated.
|
||||
|
||||
Possible enum values:
|
||||
- `"Pending"` means the node has been created/added by the system, but not configured.
|
||||
- `"Running"` means the node has been configured and has Kubernetes components running.
|
||||
- `"Terminated"` means the node has been removed from the cluster.
|
||||
|
||||
|
||||
- **volumesAttached** ([]AttachedVolume)
|
||||
|
||||
|
|
|
|||
|
|
@ -50,7 +50,6 @@ RuntimeClass defines a class of container runtime supported in the cluster. The
|
|||
|
||||
Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. For more details, see
|
||||
https://kubernetes.io/docs/concepts/scheduling-eviction/pod-overhead/
|
||||
This field is in beta starting v1.18 and is only honored by servers that enable the PodOverhead feature.
|
||||
|
||||
<a name="Overhead"></a>
|
||||
*Overhead structure represents the resource overhead associated with running a pod.*
|
||||
|
|
@ -87,9 +86,7 @@ RuntimeClass defines a class of container runtime supported in the cluster. The
|
|||
|
||||
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.
|
||||
|
||||
Possible enum values:
|
||||
- `"Equal"`
|
||||
- `"Exists"`
|
||||
|
||||
|
||||
- **scheduling.tolerations.value** (string)
|
||||
|
||||
|
|
@ -99,10 +96,7 @@ RuntimeClass defines a class of container runtime supported in the cluster. The
|
|||
|
||||
Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
|
||||
|
||||
Possible enum values:
|
||||
- `"NoExecute"` Evict any already-running pods that do not tolerate the taint. Currently enforced by NodeController.
|
||||
- `"NoSchedule"` Do not allow new pods to schedule onto the node unless they tolerate the taint, but allow all pods submitted to Kubelet without going through the scheduler to start, and allow all already-running pods to continue running. Enforced by the scheduler.
|
||||
- `"PreferNoSchedule"` Like TaintEffectNoSchedule, but the scheduler tries not to schedule new pods onto the node, rather than prohibiting new pods from scheduling onto the node entirely. Enforced by the scheduler.
|
||||
|
||||
|
||||
- **scheduling.tolerations.tolerationSeconds** (int64)
|
||||
|
||||
|
|
|
|||
|
|
@ -44,9 +44,7 @@ ListMeta describes metadata that synthetic resources must have, including lists
|
|||
|
||||
- **selfLink** (string)
|
||||
|
||||
selfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
|
||||
DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.
|
||||
Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -38,13 +38,7 @@ A node selector requirement is a selector that contains values, a key, and an op
|
|||
|
||||
Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
|
||||
|
||||
Possible enum values:
|
||||
- `"DoesNotExist"`
|
||||
- `"Exists"`
|
||||
- `"Gt"`
|
||||
- `"In"`
|
||||
- `"Lt"`
|
||||
- `"NotIn"`
|
||||
|
||||
|
||||
- **values** ([]string)
|
||||
|
||||
|
|
|
|||
|
|
@ -38,7 +38,7 @@ ObjectMeta is metadata that all persisted resources must have, which includes al
|
|||
|
||||
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 NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).
|
||||
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
|
||||
|
||||
|
|
@ -105,7 +105,7 @@ ObjectMeta is metadata that all persisted resources must have, which includes al
|
|||
|
||||
- **managedFields.time** (Time)
|
||||
|
||||
Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply'
|
||||
Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.
|
||||
|
||||
<a name="Time"></a>
|
||||
*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.*
|
||||
|
|
@ -137,7 +137,7 @@ ObjectMeta is metadata that all persisted resources must have, which includes al
|
|||
|
||||
- **ownerReferences.blockOwnerDeletion** (boolean)
|
||||
|
||||
If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.
|
||||
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.
|
||||
|
||||
- **ownerReferences.controller** (boolean)
|
||||
|
||||
|
|
@ -180,9 +180,7 @@ ObjectMeta is metadata that all persisted resources must have, which includes al
|
|||
|
||||
- **selfLink** (string)
|
||||
|
||||
SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
|
||||
DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.
|
||||
Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
|
||||
|
||||
- **uid** (string)
|
||||
|
||||
|
|
@ -195,7 +193,9 @@ ObjectMeta is metadata that all persisted resources must have, which includes al
|
|||
|
||||
- **clusterName** (string)
|
||||
|
||||
The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.
|
||||
Deprecated: ClusterName is a legacy field that was always cleared by the system and never used; it will be removed completely in 1.25.
|
||||
|
||||
The name in the go struct is changed to help clients detect accidental use.
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -80,7 +80,7 @@ A selector to restrict the list of returned objects by their fields. Defaults to
|
|||
|
||||
## fieldValidation {#fieldValidation}
|
||||
|
||||
fieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
|
||||
fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the `ServerSideFieldValidation` feature gate is also enabled. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23 and is the default behavior when the `ServerSideFieldValidation` feature gate is disabled. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default when the `ServerSideFieldValidation` feature gate is enabled. - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|
||||
|
||||
<hr>
|
||||
|
||||
|
|
|
|||
|
|
@ -94,8 +94,6 @@ CSIDriverSpec is the specification of a CSIDriver.
|
|||
Alternatively, the driver can be deployed with the field unset or false and it can be flipped later when storage capacity information has been published.
|
||||
|
||||
This field was immutable in Kubernetes \<= 1.22 and now is mutable.
|
||||
|
||||
This is a beta field and only available when the CSIStorageCapacity feature is enabled. The default is false.
|
||||
|
||||
- **tokenRequests** ([]TokenRequest)
|
||||
|
||||
|
|
|
|||
|
|
@ -1,11 +1,11 @@
|
|||
---
|
||||
api_metadata:
|
||||
apiVersion: "storage.k8s.io/v1beta1"
|
||||
import: "k8s.io/api/storage/v1beta1"
|
||||
apiVersion: "storage.k8s.io/v1"
|
||||
import: "k8s.io/api/storage/v1"
|
||||
kind: "CSIStorageCapacity"
|
||||
content_type: "api_reference"
|
||||
description: "CSIStorageCapacity stores the result of one CSI GetCapacity call."
|
||||
title: "CSIStorageCapacity v1beta1"
|
||||
title: "CSIStorageCapacity"
|
||||
weight: 10
|
||||
auto_generated: true
|
||||
---
|
||||
|
|
@ -21,9 +21,9 @@ guide. You can file document formatting bugs against the
|
|||
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
|
||||
-->
|
||||
|
||||
`apiVersion: storage.k8s.io/v1beta1`
|
||||
`apiVersion: storage.k8s.io/v1`
|
||||
|
||||
`import "k8s.io/api/storage/v1beta1"`
|
||||
`import "k8s.io/api/storage/v1"`
|
||||
|
||||
|
||||
## CSIStorageCapacity {#CSIStorageCapacity}
|
||||
|
|
@ -36,11 +36,11 @@ The following three cases all imply that no capacity is available for a certain
|
|||
|
||||
The producer of these objects can decide which approach is more suitable.
|
||||
|
||||
They are consumed by the kube-scheduler if the CSIStorageCapacity beta feature gate is enabled there and a CSI driver opts into capacity-aware scheduling with CSIDriver.StorageCapacity.
|
||||
They are consumed by the kube-scheduler when a CSI driver opts into capacity-aware scheduling with CSIDriverSpec.StorageCapacity. The scheduler compares the MaximumVolumeSize against the requested size of pending volumes to filter out unsuitable nodes. If MaximumVolumeSize is unset, it falls back to a comparison against the less precise Capacity. If that is also unset, the scheduler assumes that capacity is insufficient and tries some other node.
|
||||
|
||||
<hr>
|
||||
|
||||
- **apiVersion**: storage.k8s.io/v1beta1
|
||||
- **apiVersion**: storage.k8s.io/v1
|
||||
|
||||
|
||||
- **kind**: CSIStorageCapacity
|
||||
|
|
@ -62,7 +62,7 @@ They are consumed by the kube-scheduler if the CSIStorageCapacity beta feature g
|
|||
|
||||
Capacity is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields.
|
||||
|
||||
The semantic is currently (CSI spec 1.2) defined as: The available capacity, in bytes, of the storage that can be used to provision volumes. If not set, that information is currently unavailable and treated like zero capacity.
|
||||
The semantic is currently (CSI spec 1.2) defined as: The available capacity, in bytes, of the storage that can be used to provision volumes. If not set, that information is currently unavailable.
|
||||
|
||||
- **maximumVolumeSize** (<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
|
||||
|
||||
|
|
@ -84,7 +84,7 @@ CSIStorageCapacityList is a collection of CSIStorageCapacity objects.
|
|||
|
||||
<hr>
|
||||
|
||||
- **apiVersion**: storage.k8s.io/v1beta1
|
||||
- **apiVersion**: storage.k8s.io/v1
|
||||
|
||||
|
||||
- **kind**: CSIStorageCapacityList
|
||||
|
|
@ -94,7 +94,7 @@ CSIStorageCapacityList is a collection of CSIStorageCapacity objects.
|
|||
|
||||
Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
|
||||
|
||||
- **items** ([]<a href="{{< ref "../config-and-storage-resources/csi-storage-capacity-v1beta1#CSIStorageCapacity" >}}">CSIStorageCapacity</a>), required
|
||||
- **items** ([]<a href="{{< ref "../config-and-storage-resources/csi-storage-capacity-v1#CSIStorageCapacity" >}}">CSIStorageCapacity</a>), required
|
||||
|
||||
*Map: unique values on key name will be kept during a merge*
|
||||
|
||||
|
|
@ -119,7 +119,7 @@ CSIStorageCapacityList is a collection of CSIStorageCapacity objects.
|
|||
|
||||
#### HTTP Request
|
||||
|
||||
GET /apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities/{name}
|
||||
GET /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities/{name}
|
||||
|
||||
#### Parameters
|
||||
|
||||
|
|
@ -143,7 +143,7 @@ GET /apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities/{na
|
|||
#### Response
|
||||
|
||||
|
||||
200 (<a href="{{< ref "../config-and-storage-resources/csi-storage-capacity-v1beta1#CSIStorageCapacity" >}}">CSIStorageCapacity</a>): OK
|
||||
200 (<a href="{{< ref "../config-and-storage-resources/csi-storage-capacity-v1#CSIStorageCapacity" >}}">CSIStorageCapacity</a>): OK
|
||||
|
||||
401: Unauthorized
|
||||
|
||||
|
|
@ -152,7 +152,7 @@ GET /apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities/{na
|
|||
|
||||
#### HTTP Request
|
||||
|
||||
GET /apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities
|
||||
GET /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities
|
||||
|
||||
#### Parameters
|
||||
|
||||
|
|
@ -216,7 +216,7 @@ GET /apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities
|
|||
#### Response
|
||||
|
||||
|
||||
200 (<a href="{{< ref "../config-and-storage-resources/csi-storage-capacity-v1beta1#CSIStorageCapacityList" >}}">CSIStorageCapacityList</a>): OK
|
||||
200 (<a href="{{< ref "../config-and-storage-resources/csi-storage-capacity-v1#CSIStorageCapacityList" >}}">CSIStorageCapacityList</a>): OK
|
||||
|
||||
401: Unauthorized
|
||||
|
||||
|
|
@ -225,7 +225,7 @@ GET /apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities
|
|||
|
||||
#### HTTP Request
|
||||
|
||||
GET /apis/storage.k8s.io/v1beta1/csistoragecapacities
|
||||
GET /apis/storage.k8s.io/v1/csistoragecapacities
|
||||
|
||||
#### Parameters
|
||||
|
||||
|
|
@ -284,7 +284,7 @@ GET /apis/storage.k8s.io/v1beta1/csistoragecapacities
|
|||
#### Response
|
||||
|
||||
|
||||
200 (<a href="{{< ref "../config-and-storage-resources/csi-storage-capacity-v1beta1#CSIStorageCapacityList" >}}">CSIStorageCapacityList</a>): OK
|
||||
200 (<a href="{{< ref "../config-and-storage-resources/csi-storage-capacity-v1#CSIStorageCapacityList" >}}">CSIStorageCapacityList</a>): OK
|
||||
|
||||
401: Unauthorized
|
||||
|
||||
|
|
@ -293,7 +293,7 @@ GET /apis/storage.k8s.io/v1beta1/csistoragecapacities
|
|||
|
||||
#### HTTP Request
|
||||
|
||||
POST /apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities
|
||||
POST /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities
|
||||
|
||||
#### Parameters
|
||||
|
||||
|
|
@ -303,7 +303,7 @@ POST /apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities
|
|||
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
|
||||
|
||||
|
||||
- **body**: <a href="{{< ref "../config-and-storage-resources/csi-storage-capacity-v1beta1#CSIStorageCapacity" >}}">CSIStorageCapacity</a>, required
|
||||
- **body**: <a href="{{< ref "../config-and-storage-resources/csi-storage-capacity-v1#CSIStorageCapacity" >}}">CSIStorageCapacity</a>, required
|
||||
|
||||
|
||||
|
||||
|
|
@ -332,11 +332,11 @@ POST /apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities
|
|||
#### Response
|
||||
|
||||
|
||||
200 (<a href="{{< ref "../config-and-storage-resources/csi-storage-capacity-v1beta1#CSIStorageCapacity" >}}">CSIStorageCapacity</a>): OK
|
||||
200 (<a href="{{< ref "../config-and-storage-resources/csi-storage-capacity-v1#CSIStorageCapacity" >}}">CSIStorageCapacity</a>): OK
|
||||
|
||||
201 (<a href="{{< ref "../config-and-storage-resources/csi-storage-capacity-v1beta1#CSIStorageCapacity" >}}">CSIStorageCapacity</a>): Created
|
||||
201 (<a href="{{< ref "../config-and-storage-resources/csi-storage-capacity-v1#CSIStorageCapacity" >}}">CSIStorageCapacity</a>): Created
|
||||
|
||||
202 (<a href="{{< ref "../config-and-storage-resources/csi-storage-capacity-v1beta1#CSIStorageCapacity" >}}">CSIStorageCapacity</a>): Accepted
|
||||
202 (<a href="{{< ref "../config-and-storage-resources/csi-storage-capacity-v1#CSIStorageCapacity" >}}">CSIStorageCapacity</a>): Accepted
|
||||
|
||||
401: Unauthorized
|
||||
|
||||
|
|
@ -345,7 +345,7 @@ POST /apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities
|
|||
|
||||
#### HTTP Request
|
||||
|
||||
PUT /apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities/{name}
|
||||
PUT /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities/{name}
|
||||
|
||||
#### Parameters
|
||||
|
||||
|
|
@ -360,7 +360,7 @@ PUT /apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities/{na
|
|||
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
|
||||
|
||||
|
||||
- **body**: <a href="{{< ref "../config-and-storage-resources/csi-storage-capacity-v1beta1#CSIStorageCapacity" >}}">CSIStorageCapacity</a>, required
|
||||
- **body**: <a href="{{< ref "../config-and-storage-resources/csi-storage-capacity-v1#CSIStorageCapacity" >}}">CSIStorageCapacity</a>, required
|
||||
|
||||
|
||||
|
||||
|
|
@ -389,9 +389,9 @@ PUT /apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities/{na
|
|||
#### Response
|
||||
|
||||
|
||||
200 (<a href="{{< ref "../config-and-storage-resources/csi-storage-capacity-v1beta1#CSIStorageCapacity" >}}">CSIStorageCapacity</a>): OK
|
||||
200 (<a href="{{< ref "../config-and-storage-resources/csi-storage-capacity-v1#CSIStorageCapacity" >}}">CSIStorageCapacity</a>): OK
|
||||
|
||||
201 (<a href="{{< ref "../config-and-storage-resources/csi-storage-capacity-v1beta1#CSIStorageCapacity" >}}">CSIStorageCapacity</a>): Created
|
||||
201 (<a href="{{< ref "../config-and-storage-resources/csi-storage-capacity-v1#CSIStorageCapacity" >}}">CSIStorageCapacity</a>): Created
|
||||
|
||||
401: Unauthorized
|
||||
|
||||
|
|
@ -400,7 +400,7 @@ PUT /apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities/{na
|
|||
|
||||
#### HTTP Request
|
||||
|
||||
PATCH /apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities/{name}
|
||||
PATCH /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities/{name}
|
||||
|
||||
#### Parameters
|
||||
|
||||
|
|
@ -449,9 +449,9 @@ PATCH /apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities/{
|
|||
#### Response
|
||||
|
||||
|
||||
200 (<a href="{{< ref "../config-and-storage-resources/csi-storage-capacity-v1beta1#CSIStorageCapacity" >}}">CSIStorageCapacity</a>): OK
|
||||
200 (<a href="{{< ref "../config-and-storage-resources/csi-storage-capacity-v1#CSIStorageCapacity" >}}">CSIStorageCapacity</a>): OK
|
||||
|
||||
201 (<a href="{{< ref "../config-and-storage-resources/csi-storage-capacity-v1beta1#CSIStorageCapacity" >}}">CSIStorageCapacity</a>): Created
|
||||
201 (<a href="{{< ref "../config-and-storage-resources/csi-storage-capacity-v1#CSIStorageCapacity" >}}">CSIStorageCapacity</a>): Created
|
||||
|
||||
401: Unauthorized
|
||||
|
||||
|
|
@ -460,7 +460,7 @@ PATCH /apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities/{
|
|||
|
||||
#### HTTP Request
|
||||
|
||||
DELETE /apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities/{name}
|
||||
DELETE /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities/{name}
|
||||
|
||||
#### Parameters
|
||||
|
||||
|
|
@ -515,7 +515,7 @@ DELETE /apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities/
|
|||
|
||||
#### HTTP Request
|
||||
|
||||
DELETE /apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities
|
||||
DELETE /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities
|
||||
|
||||
#### Parameters
|
||||
|
||||
|
|
@ -44,11 +44,11 @@ PersistentVolumeClaim is a user's request for and claim to a persistent volume
|
|||
|
||||
- **spec** (<a href="{{< ref "../config-and-storage-resources/persistent-volume-claim-v1#PersistentVolumeClaimSpec" >}}">PersistentVolumeClaimSpec</a>)
|
||||
|
||||
Spec defines the desired characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
|
||||
spec defines the desired characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
|
||||
|
||||
- **status** (<a href="{{< ref "../config-and-storage-resources/persistent-volume-claim-v1#PersistentVolumeClaimStatus" >}}">PersistentVolumeClaimStatus</a>)
|
||||
|
||||
Status represents the current information/status of a persistent volume claim. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
|
||||
status represents the current information/status of a persistent volume claim. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
|
||||
|
||||
|
||||
|
||||
|
|
@ -62,15 +62,15 @@ PersistentVolumeClaimSpec describes the common attributes of storage devices and
|
|||
|
||||
- **accessModes** ([]string)
|
||||
|
||||
AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
|
||||
accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
|
||||
|
||||
- **selector** (<a href="{{< ref "../common-definitions/label-selector#LabelSelector" >}}">LabelSelector</a>)
|
||||
|
||||
A label query over volumes to consider for binding.
|
||||
selector is a label query over volumes to consider for binding.
|
||||
|
||||
- **resources** (ResourceRequirements)
|
||||
|
||||
Resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
|
||||
resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
|
||||
|
||||
<a name="ResourceRequirements"></a>
|
||||
*ResourceRequirements describes the compute resource requirements.*
|
||||
|
|
@ -85,11 +85,11 @@ PersistentVolumeClaimSpec describes the common attributes of storage devices and
|
|||
|
||||
- **volumeName** (string)
|
||||
|
||||
VolumeName is the binding reference to the PersistentVolume backing this claim.
|
||||
volumeName is the binding reference to the PersistentVolume backing this claim.
|
||||
|
||||
- **storageClassName** (string)
|
||||
|
||||
Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
|
||||
storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
|
||||
|
||||
- **volumeMode** (string)
|
||||
|
||||
|
|
@ -102,16 +102,16 @@ PersistentVolumeClaimSpec describes the common attributes of storage devices and
|
|||
|
||||
- **dataSource** (<a href="{{< ref "../common-definitions/typed-local-object-reference#TypedLocalObjectReference" >}}">TypedLocalObjectReference</a>)
|
||||
|
||||
This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field.
|
||||
dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field.
|
||||
|
||||
- **dataSourceRef** (<a href="{{< ref "../common-definitions/typed-local-object-reference#TypedLocalObjectReference" >}}">TypedLocalObjectReference</a>)
|
||||
|
||||
Specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef
|
||||
dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef
|
||||
allows any non-core object, as well as PersistentVolumeClaim objects.
|
||||
* While DataSource ignores disallowed values (dropping them), DataSourceRef
|
||||
preserves all values, and generates an error if a disallowed value is
|
||||
specified.
|
||||
(Alpha) Using this field requires the AnyVolumeDataSource feature gate to be enabled.
|
||||
(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.
|
||||
|
||||
|
||||
|
||||
|
|
@ -123,21 +123,21 @@ PersistentVolumeClaimStatus is the current status of a persistent volume claim.
|
|||
|
||||
- **accessModes** ([]string)
|
||||
|
||||
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
|
||||
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
|
||||
|
||||
- **allocatedResources** (map[string]<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
- **capacity** (map[string]<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
|
||||
|
||||
Represents the actual resources of the underlying volume.
|
||||
capacity represents the actual resources of the underlying volume.
|
||||
|
||||
- **conditions** ([]PersistentVolumeClaimCondition)
|
||||
|
||||
*Patch strategy: merge on key `type`*
|
||||
|
||||
Current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'ResizeStarted'.
|
||||
conditions is the current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'ResizeStarted'.
|
||||
|
||||
<a name="PersistentVolumeClaimCondition"></a>
|
||||
*PersistentVolumeClaimCondition contails details about state of pvc*
|
||||
|
|
@ -147,47 +147,38 @@ PersistentVolumeClaimStatus is the current status of a persistent volume claim.
|
|||
|
||||
- **conditions.type** (string), required
|
||||
|
||||
|
||||
|
||||
|
||||
Possible enum values:
|
||||
- `"FileSystemResizePending"` - controller resize is finished and a file system resize is pending on node
|
||||
- `"Resizing"` - a user trigger resize of pvc has been started
|
||||
|
||||
- **conditions.lastProbeTime** (Time)
|
||||
|
||||
Last time we probed the condition.
|
||||
lastProbeTime is the time we probed the condition.
|
||||
|
||||
<a name="Time"></a>
|
||||
*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.*
|
||||
|
||||
- **conditions.lastTransitionTime** (Time)
|
||||
|
||||
Last time the condition transitioned from one status to another.
|
||||
lastTransitionTime is the time the condition transitioned from one status to another.
|
||||
|
||||
<a name="Time"></a>
|
||||
*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.*
|
||||
|
||||
- **conditions.message** (string)
|
||||
|
||||
Human-readable message indicating details about last transition.
|
||||
message is the human-readable message indicating details about last transition.
|
||||
|
||||
- **conditions.reason** (string)
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
- **phase** (string)
|
||||
|
||||
Phase represents the current phase of PersistentVolumeClaim.
|
||||
phase represents the current phase of PersistentVolumeClaim.
|
||||
|
||||
|
||||
Possible enum values:
|
||||
- `"Bound"` used for PersistentVolumeClaims that are bound
|
||||
- `"Lost"` used for PersistentVolumeClaims that lost their underlying PersistentVolume. The claim was bound to a PersistentVolume and this volume does not exist any longer and all data on it was lost.
|
||||
- `"Pending"` used for PersistentVolumeClaims that are not yet bound
|
||||
|
||||
- **resizeStatus** (string)
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
|
||||
|
||||
|
|
@ -211,7 +202,7 @@ PersistentVolumeClaimList is a list of PersistentVolumeClaim items.
|
|||
|
||||
- **items** ([]<a href="{{< ref "../config-and-storage-resources/persistent-volume-claim-v1#PersistentVolumeClaim" >}}">PersistentVolumeClaim</a>), required
|
||||
|
||||
A list of persistent volume claims. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
|
||||
items is a list of persistent volume claims. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -44,11 +44,11 @@ PersistentVolume (PV) is a storage resource provisioned by an administrator. It
|
|||
|
||||
- **spec** (<a href="{{< ref "../config-and-storage-resources/persistent-volume-v1#PersistentVolumeSpec" >}}">PersistentVolumeSpec</a>)
|
||||
|
||||
Spec defines a specification of a persistent volume owned by the cluster. Provisioned by an administrator. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistent-volumes
|
||||
spec defines a specification of a persistent volume owned by the cluster. Provisioned by an administrator. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistent-volumes
|
||||
|
||||
- **status** (<a href="{{< ref "../config-and-storage-resources/persistent-volume-v1#PersistentVolumeStatus" >}}">PersistentVolumeStatus</a>)
|
||||
|
||||
Status represents the current information/status for the persistent volume. Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistent-volumes
|
||||
status represents the current information/status for the persistent volume. Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistent-volumes
|
||||
|
||||
|
||||
|
||||
|
|
@ -62,30 +62,30 @@ PersistentVolumeSpec is the specification of a persistent volume.
|
|||
|
||||
- **accessModes** ([]string)
|
||||
|
||||
AccessModes contains all ways the volume can be mounted. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes
|
||||
accessModes contains all ways the volume can be mounted. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes
|
||||
|
||||
- **capacity** (map[string]<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
|
||||
|
||||
A description of the persistent volume's resources and capacity. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity
|
||||
capacity is the description of the persistent volume's resources and capacity. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity
|
||||
|
||||
- **claimRef** (<a href="{{< ref "../common-definitions/object-reference#ObjectReference" >}}">ObjectReference</a>)
|
||||
|
||||
ClaimRef is part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim. Expected to be non-nil when bound. claim.VolumeName is the authoritative bind between PV and PVC. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding
|
||||
claimRef is part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim. Expected to be non-nil when bound. claim.VolumeName is the authoritative bind between PV and PVC. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding
|
||||
|
||||
- **mountOptions** ([]string)
|
||||
|
||||
A list of mount options, e.g. ["ro", "soft"]. Not validated - mount will simply fail if one is invalid. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options
|
||||
mountOptions is the list of mount options, e.g. ["ro", "soft"]. Not validated - mount will simply fail if one is invalid. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options
|
||||
|
||||
- **nodeAffinity** (VolumeNodeAffinity)
|
||||
|
||||
NodeAffinity defines constraints that limit what nodes this volume can be accessed from. This field influences the scheduling of pods that use this volume.
|
||||
nodeAffinity defines constraints that limit what nodes this volume can be accessed from. This field influences the scheduling of pods that use this volume.
|
||||
|
||||
<a name="VolumeNodeAffinity"></a>
|
||||
*VolumeNodeAffinity defines constraints that limit what nodes this volume can be accessed from.*
|
||||
|
||||
- **nodeAffinity.required** (NodeSelector)
|
||||
|
||||
Required specifies hard node constraints that must be met.
|
||||
required specifies hard node constraints that must be met.
|
||||
|
||||
<a name="NodeSelector"></a>
|
||||
*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.*
|
||||
|
|
@ -107,16 +107,13 @@ PersistentVolumeSpec is the specification of a persistent volume.
|
|||
|
||||
- **persistentVolumeReclaimPolicy** (string)
|
||||
|
||||
What happens to a persistent volume when released from its claim. Valid options are Retain (default for manually created PersistentVolumes), Delete (default for dynamically provisioned PersistentVolumes), and Recycle (deprecated). Recycle must be supported by the volume plugin underlying this PersistentVolume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming
|
||||
persistentVolumeReclaimPolicy defines what happens to a persistent volume when released from its claim. Valid options are Retain (default for manually created PersistentVolumes), Delete (default for dynamically provisioned PersistentVolumes), and Recycle (deprecated). Recycle must be supported by the volume plugin underlying this PersistentVolume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming
|
||||
|
||||
|
||||
Possible enum values:
|
||||
- `"Delete"` means the volume will be deleted from Kubernetes on release from its claim. The volume plugin must support Deletion.
|
||||
- `"Recycle"` means the volume will be recycled back into the pool of unbound persistent volumes on release from its claim. The volume plugin must support Recycling.
|
||||
- `"Retain"` means the volume will be left in its current phase (Released) for manual reclamation by the administrator. The default policy is Retain.
|
||||
|
||||
- **storageClassName** (string)
|
||||
|
||||
Name of StorageClass to which this persistent volume belongs. Empty value means that this volume does not belong to any StorageClass.
|
||||
storageClassName is the name of StorageClass to which this persistent volume belongs. Empty value means that this volume does not belong to any StorageClass.
|
||||
|
||||
- **volumeMode** (string)
|
||||
|
||||
|
|
@ -129,40 +126,40 @@ PersistentVolumeSpec is the specification of a persistent volume.
|
|||
|
||||
- **hostPath** (HostPathVolumeSource)
|
||||
|
||||
HostPath represents a directory on the host. Provisioned by a developer or tester. This is useful for single-node development and testing only! On-host storage is not supported in any way and WILL NOT WORK in a multi-node cluster. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
|
||||
hostPath represents a directory on the host. Provisioned by a developer or tester. This is useful for single-node development and testing only! On-host storage is not supported in any way and WILL NOT WORK in a multi-node cluster. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
|
||||
|
||||
<a name="HostPathVolumeSource"></a>
|
||||
*Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.*
|
||||
|
||||
- **hostPath.path** (string), required
|
||||
|
||||
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
|
||||
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
|
||||
|
||||
- **hostPath.type** (string)
|
||||
|
||||
Type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
|
||||
type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
|
||||
|
||||
- **local** (LocalVolumeSource)
|
||||
|
||||
Local represents directly-attached storage with node affinity
|
||||
local represents directly-attached storage with node affinity
|
||||
|
||||
<a name="LocalVolumeSource"></a>
|
||||
*Local represents directly-attached storage with node affinity (Beta feature)*
|
||||
|
||||
- **local.path** (string), required
|
||||
|
||||
The full path to the volume on the node. It can be either a directory or block device (disk, partition, ...).
|
||||
path of the full path to the volume on the node. It can be either a directory or block device (disk, partition, ...).
|
||||
|
||||
- **local.fsType** (string)
|
||||
|
||||
Filesystem type to mount. It applies only when the Path is a block device. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default value is to auto-select a filesystem if unspecified.
|
||||
fsType is the filesystem type to mount. It applies only when the Path is a block device. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default value is to auto-select a filesystem if unspecified.
|
||||
|
||||
### Persistent volumes
|
||||
|
||||
|
||||
- **awsElasticBlockStore** (AWSElasticBlockStoreVolumeSource)
|
||||
|
||||
AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
|
||||
awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
|
||||
|
||||
<a name="AWSElasticBlockStoreVolumeSource"></a>
|
||||
*Represents a Persistent Disk resource in AWS.
|
||||
|
|
@ -171,320 +168,320 @@ PersistentVolumeSpec is the specification of a persistent volume.
|
|||
|
||||
- **awsElasticBlockStore.volumeID** (string), required
|
||||
|
||||
Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
|
||||
volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
|
||||
|
||||
- **awsElasticBlockStore.fsType** (string)
|
||||
|
||||
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
|
||||
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
|
||||
|
||||
- **awsElasticBlockStore.partition** (int32)
|
||||
|
||||
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).
|
||||
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).
|
||||
|
||||
- **awsElasticBlockStore.readOnly** (boolean)
|
||||
|
||||
Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". If omitted, the default is "false". More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
|
||||
readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
|
||||
|
||||
- **azureDisk** (AzureDiskVolumeSource)
|
||||
|
||||
AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
|
||||
azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
|
||||
|
||||
<a name="AzureDiskVolumeSource"></a>
|
||||
*AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.*
|
||||
|
||||
- **azureDisk.diskName** (string), required
|
||||
|
||||
The Name of the data disk in the blob storage
|
||||
diskName is the Name of the data disk in the blob storage
|
||||
|
||||
- **azureDisk.diskURI** (string), required
|
||||
|
||||
The URI the data disk in the blob storage
|
||||
diskURI is the URI of data disk in the blob storage
|
||||
|
||||
- **azureDisk.cachingMode** (string)
|
||||
|
||||
Host Caching mode: None, Read Only, Read Write.
|
||||
cachingMode is the Host Caching mode: None, Read Only, Read Write.
|
||||
|
||||
- **azureDisk.fsType** (string)
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
- **azureDisk.kind** (string)
|
||||
|
||||
Expected values 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
|
||||
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
|
||||
|
||||
- **azureDisk.readOnly** (boolean)
|
||||
|
||||
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
|
||||
readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
|
||||
|
||||
- **azureFile** (AzureFilePersistentVolumeSource)
|
||||
|
||||
AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
|
||||
azureFile represents an Azure File Service mount on the host and bind mount to the pod.
|
||||
|
||||
<a name="AzureFilePersistentVolumeSource"></a>
|
||||
*AzureFile represents an Azure File Service mount on the host and bind mount to the pod.*
|
||||
|
||||
- **azureFile.secretName** (string), required
|
||||
|
||||
the name of secret that contains Azure Storage Account Name and Key
|
||||
secretName is the name of secret that contains Azure Storage Account Name and Key
|
||||
|
||||
- **azureFile.shareName** (string), required
|
||||
|
||||
Share Name
|
||||
shareName is the azure Share Name
|
||||
|
||||
- **azureFile.readOnly** (boolean)
|
||||
|
||||
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
|
||||
readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
|
||||
|
||||
- **azureFile.secretNamespace** (string)
|
||||
|
||||
the namespace of the secret that contains Azure Storage Account Name and Key default is the same as the Pod
|
||||
secretNamespace is the namespace of the secret that contains Azure Storage Account Name and Key default is the same as the Pod
|
||||
|
||||
- **cephfs** (CephFSPersistentVolumeSource)
|
||||
|
||||
CephFS represents a Ceph FS mount on the host that shares a pod's lifetime
|
||||
cephFS represents a Ceph FS mount on the host that shares a pod's lifetime
|
||||
|
||||
<a name="CephFSPersistentVolumeSource"></a>
|
||||
*Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.*
|
||||
|
||||
- **cephfs.monitors** ([]string), required
|
||||
|
||||
Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
|
||||
monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
|
||||
|
||||
- **cephfs.path** (string)
|
||||
|
||||
Optional: Used as the mounted root, rather than the full Ceph tree, default is /
|
||||
path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /
|
||||
|
||||
- **cephfs.readOnly** (boolean)
|
||||
|
||||
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
|
||||
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
|
||||
|
||||
- **cephfs.secretFile** (string)
|
||||
|
||||
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
|
||||
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
|
||||
|
||||
- **cephfs.secretRef** (SecretReference)
|
||||
|
||||
Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
|
||||
secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
|
||||
|
||||
<a name="SecretReference"></a>
|
||||
*SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace*
|
||||
|
||||
- **cephfs.secretRef.name** (string)
|
||||
|
||||
Name is unique within a namespace to reference a secret resource.
|
||||
name is unique within a namespace to reference a secret resource.
|
||||
|
||||
- **cephfs.secretRef.namespace** (string)
|
||||
|
||||
Namespace defines the space within which the secret name must be unique.
|
||||
namespace defines the space within which the secret name must be unique.
|
||||
|
||||
- **cephfs.user** (string)
|
||||
|
||||
Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
|
||||
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
|
||||
|
||||
- **cinder** (CinderPersistentVolumeSource)
|
||||
|
||||
Cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
|
||||
cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
|
||||
|
||||
<a name="CinderPersistentVolumeSource"></a>
|
||||
*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.*
|
||||
|
||||
- **cinder.volumeID** (string), required
|
||||
|
||||
volume id used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
|
||||
volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
|
||||
|
||||
- **cinder.fsType** (string)
|
||||
|
||||
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
|
||||
fsType 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
|
||||
|
||||
- **cinder.readOnly** (boolean)
|
||||
|
||||
Optional: 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
|
||||
readOnly is Optional: 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
|
||||
|
||||
- **cinder.secretRef** (SecretReference)
|
||||
|
||||
Optional: points to a secret object containing parameters used to connect to OpenStack.
|
||||
secretRef is Optional: points to a secret object containing parameters used to connect to OpenStack.
|
||||
|
||||
<a name="SecretReference"></a>
|
||||
*SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace*
|
||||
|
||||
- **cinder.secretRef.name** (string)
|
||||
|
||||
Name is unique within a namespace to reference a secret resource.
|
||||
name is unique within a namespace to reference a secret resource.
|
||||
|
||||
- **cinder.secretRef.namespace** (string)
|
||||
|
||||
Namespace defines the space within which the secret name must be unique.
|
||||
namespace defines the space within which the secret name must be unique.
|
||||
|
||||
- **csi** (CSIPersistentVolumeSource)
|
||||
|
||||
CSI represents storage that is handled by an external CSI driver (Beta feature).
|
||||
csi represents storage that is handled by an external CSI driver (Beta feature).
|
||||
|
||||
<a name="CSIPersistentVolumeSource"></a>
|
||||
*Represents storage that is managed by an external CSI volume driver (Beta feature)*
|
||||
|
||||
- **csi.driver** (string), required
|
||||
|
||||
Driver is the name of the driver to use for this volume. Required.
|
||||
driver is the name of the driver to use for this volume. Required.
|
||||
|
||||
- **csi.volumeHandle** (string), required
|
||||
|
||||
VolumeHandle is the unique volume name returned by the CSI volume plugin’s CreateVolume to refer to the volume on all subsequent calls. Required.
|
||||
volumeHandle is the unique volume name returned by the CSI volume plugin’s CreateVolume to refer to the volume on all subsequent calls. Required.
|
||||
|
||||
- **csi.controllerExpandSecretRef** (SecretReference)
|
||||
|
||||
ControllerExpandSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerExpandVolume call. This is an alpha field and requires enabling ExpandCSIVolumes feature gate. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.
|
||||
controllerExpandSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerExpandVolume call. This is an alpha field and requires enabling ExpandCSIVolumes feature gate. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.
|
||||
|
||||
<a name="SecretReference"></a>
|
||||
*SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace*
|
||||
|
||||
- **csi.controllerExpandSecretRef.name** (string)
|
||||
|
||||
Name is unique within a namespace to reference a secret resource.
|
||||
name is unique within a namespace to reference a secret resource.
|
||||
|
||||
- **csi.controllerExpandSecretRef.namespace** (string)
|
||||
|
||||
Namespace defines the space within which the secret name must be unique.
|
||||
namespace defines the space within which the secret name must be unique.
|
||||
|
||||
- **csi.controllerPublishSecretRef** (SecretReference)
|
||||
|
||||
ControllerPublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerPublishVolume and ControllerUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.
|
||||
controllerPublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerPublishVolume and ControllerUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.
|
||||
|
||||
<a name="SecretReference"></a>
|
||||
*SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace*
|
||||
|
||||
- **csi.controllerPublishSecretRef.name** (string)
|
||||
|
||||
Name is unique within a namespace to reference a secret resource.
|
||||
name is unique within a namespace to reference a secret resource.
|
||||
|
||||
- **csi.controllerPublishSecretRef.namespace** (string)
|
||||
|
||||
Namespace defines the space within which the secret name must be unique.
|
||||
namespace defines the space within which the secret name must be unique.
|
||||
|
||||
- **csi.fsType** (string)
|
||||
|
||||
Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs".
|
||||
fsType to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs".
|
||||
|
||||
- **csi.nodePublishSecretRef** (SecretReference)
|
||||
|
||||
NodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.
|
||||
nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.
|
||||
|
||||
<a name="SecretReference"></a>
|
||||
*SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace*
|
||||
|
||||
- **csi.nodePublishSecretRef.name** (string)
|
||||
|
||||
Name is unique within a namespace to reference a secret resource.
|
||||
name is unique within a namespace to reference a secret resource.
|
||||
|
||||
- **csi.nodePublishSecretRef.namespace** (string)
|
||||
|
||||
Namespace defines the space within which the secret name must be unique.
|
||||
namespace defines the space within which the secret name must be unique.
|
||||
|
||||
- **csi.nodeStageSecretRef** (SecretReference)
|
||||
|
||||
NodeStageSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodeStageVolume and NodeStageVolume and NodeUnstageVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.
|
||||
nodeStageSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodeStageVolume and NodeStageVolume and NodeUnstageVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.
|
||||
|
||||
<a name="SecretReference"></a>
|
||||
*SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace*
|
||||
|
||||
- **csi.nodeStageSecretRef.name** (string)
|
||||
|
||||
Name is unique within a namespace to reference a secret resource.
|
||||
name is unique within a namespace to reference a secret resource.
|
||||
|
||||
- **csi.nodeStageSecretRef.namespace** (string)
|
||||
|
||||
Namespace defines the space within which the secret name must be unique.
|
||||
namespace defines the space within which the secret name must be unique.
|
||||
|
||||
- **csi.readOnly** (boolean)
|
||||
|
||||
Optional: The value to pass to ControllerPublishVolumeRequest. Defaults to false (read/write).
|
||||
readOnly value to pass to ControllerPublishVolumeRequest. Defaults to false (read/write).
|
||||
|
||||
- **csi.volumeAttributes** (map[string]string)
|
||||
|
||||
Attributes of the volume to publish.
|
||||
volumeAttributes of the volume to publish.
|
||||
|
||||
- **fc** (FCVolumeSource)
|
||||
|
||||
FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
|
||||
fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
|
||||
|
||||
<a name="FCVolumeSource"></a>
|
||||
*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.*
|
||||
|
||||
- **fc.fsType** (string)
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
- **fc.lun** (int32)
|
||||
|
||||
Optional: FC target lun number
|
||||
lun is Optional: FC target lun number
|
||||
|
||||
- **fc.readOnly** (boolean)
|
||||
|
||||
Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
|
||||
readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
|
||||
|
||||
- **fc.targetWWNs** ([]string)
|
||||
|
||||
Optional: FC target worldwide names (WWNs)
|
||||
targetWWNs is Optional: FC target worldwide names (WWNs)
|
||||
|
||||
- **fc.wwids** ([]string)
|
||||
|
||||
Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.
|
||||
wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.
|
||||
|
||||
- **flexVolume** (FlexPersistentVolumeSource)
|
||||
|
||||
FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.
|
||||
flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.
|
||||
|
||||
<a name="FlexPersistentVolumeSource"></a>
|
||||
*FlexPersistentVolumeSource represents a generic persistent volume resource that is provisioned/attached using an exec based plugin.*
|
||||
|
||||
- **flexVolume.driver** (string), required
|
||||
|
||||
Driver is the name of the driver to use for this volume.
|
||||
driver is the name of the driver to use for this volume.
|
||||
|
||||
- **flexVolume.fsType** (string)
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
- **flexVolume.options** (map[string]string)
|
||||
|
||||
Optional: Extra command options if any.
|
||||
options is Optional: this field holds extra command options if any.
|
||||
|
||||
- **flexVolume.readOnly** (boolean)
|
||||
|
||||
Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
|
||||
readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
|
||||
|
||||
- **flexVolume.secretRef** (SecretReference)
|
||||
|
||||
Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.
|
||||
secretRef is Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.
|
||||
|
||||
<a name="SecretReference"></a>
|
||||
*SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace*
|
||||
|
||||
- **flexVolume.secretRef.name** (string)
|
||||
|
||||
Name is unique within a namespace to reference a secret resource.
|
||||
name is unique within a namespace to reference a secret resource.
|
||||
|
||||
- **flexVolume.secretRef.namespace** (string)
|
||||
|
||||
Namespace defines the space within which the secret name must be unique.
|
||||
namespace defines the space within which the secret name must be unique.
|
||||
|
||||
- **flocker** (FlockerVolumeSource)
|
||||
|
||||
Flocker represents a Flocker volume attached to a kubelet's host machine and exposed to the pod for its usage. This depends on the Flocker control service being running
|
||||
flocker represents a Flocker volume attached to a kubelet's host machine and exposed to the pod for its usage. This depends on the Flocker control service being running
|
||||
|
||||
<a name="FlockerVolumeSource"></a>
|
||||
*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.*
|
||||
|
||||
- **flocker.datasetName** (string)
|
||||
|
||||
Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated
|
||||
datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated
|
||||
|
||||
- **flocker.datasetUUID** (string)
|
||||
|
||||
UUID of the dataset. This is unique identifier of a Flocker dataset
|
||||
datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset
|
||||
|
||||
- **gcePersistentDisk** (GCEPersistentDiskVolumeSource)
|
||||
|
||||
GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
|
||||
gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
|
||||
|
||||
<a name="GCEPersistentDiskVolumeSource"></a>
|
||||
*Represents a Persistent Disk resource in Google Compute Engine.
|
||||
|
|
@ -493,346 +490,346 @@ PersistentVolumeSpec is the specification of a persistent volume.
|
|||
|
||||
- **gcePersistentDisk.pdName** (string), required
|
||||
|
||||
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
|
||||
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
|
||||
|
||||
- **gcePersistentDisk.fsType** (string)
|
||||
|
||||
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
|
||||
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
|
||||
|
||||
- **gcePersistentDisk.partition** (int32)
|
||||
|
||||
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
|
||||
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
|
||||
|
||||
- **gcePersistentDisk.readOnly** (boolean)
|
||||
|
||||
ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
|
||||
readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
|
||||
|
||||
- **glusterfs** (GlusterfsPersistentVolumeSource)
|
||||
|
||||
Glusterfs represents a Glusterfs volume that is attached to a host and exposed to the pod. Provisioned by an admin. More info: https://examples.k8s.io/volumes/glusterfs/README.md
|
||||
glusterfs represents a Glusterfs volume that is attached to a host and exposed to the pod. Provisioned by an admin. More info: https://examples.k8s.io/volumes/glusterfs/README.md
|
||||
|
||||
<a name="GlusterfsPersistentVolumeSource"></a>
|
||||
*Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.*
|
||||
|
||||
- **glusterfs.endpoints** (string), required
|
||||
|
||||
EndpointsName is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
|
||||
endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
|
||||
|
||||
- **glusterfs.path** (string), required
|
||||
|
||||
Path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
|
||||
path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
|
||||
|
||||
- **glusterfs.endpointsNamespace** (string)
|
||||
|
||||
EndpointsNamespace is the namespace that contains Glusterfs endpoint. If this field is empty, the EndpointNamespace defaults to the same namespace as the bound PVC. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
|
||||
endpointsNamespace is the namespace that contains Glusterfs endpoint. If this field is empty, the EndpointNamespace defaults to the same namespace as the bound PVC. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
|
||||
|
||||
- **glusterfs.readOnly** (boolean)
|
||||
|
||||
ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
|
||||
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
|
||||
|
||||
- **iscsi** (ISCSIPersistentVolumeSource)
|
||||
|
||||
ISCSI represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Provisioned by an admin.
|
||||
iscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Provisioned by an admin.
|
||||
|
||||
<a name="ISCSIPersistentVolumeSource"></a>
|
||||
*ISCSIPersistentVolumeSource represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.*
|
||||
|
||||
- **iscsi.iqn** (string), required
|
||||
|
||||
Target iSCSI Qualified Name.
|
||||
iqn is Target iSCSI Qualified Name.
|
||||
|
||||
- **iscsi.lun** (int32), required
|
||||
|
||||
iSCSI Target Lun number.
|
||||
lun is iSCSI Target Lun number.
|
||||
|
||||
- **iscsi.targetPortal** (string), required
|
||||
|
||||
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).
|
||||
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).
|
||||
|
||||
- **iscsi.chapAuthDiscovery** (boolean)
|
||||
|
||||
whether support iSCSI Discovery CHAP authentication
|
||||
chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication
|
||||
|
||||
- **iscsi.chapAuthSession** (boolean)
|
||||
|
||||
whether support iSCSI Session CHAP authentication
|
||||
chapAuthSession defines whether support iSCSI Session CHAP authentication
|
||||
|
||||
- **iscsi.fsType** (string)
|
||||
|
||||
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
|
||||
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
|
||||
|
||||
- **iscsi.initiatorName** (string)
|
||||
|
||||
Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface \<target portal>:\<volume name> will be created for the connection.
|
||||
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.
|
||||
|
||||
- **iscsi.iscsiInterface** (string)
|
||||
|
||||
iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).
|
||||
iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).
|
||||
|
||||
- **iscsi.portals** ([]string)
|
||||
|
||||
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).
|
||||
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).
|
||||
|
||||
- **iscsi.readOnly** (boolean)
|
||||
|
||||
ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
|
||||
readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
|
||||
|
||||
- **iscsi.secretRef** (SecretReference)
|
||||
|
||||
CHAP Secret for iSCSI target and initiator authentication
|
||||
secretRef is the CHAP Secret for iSCSI target and initiator authentication
|
||||
|
||||
<a name="SecretReference"></a>
|
||||
*SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace*
|
||||
|
||||
- **iscsi.secretRef.name** (string)
|
||||
|
||||
Name is unique within a namespace to reference a secret resource.
|
||||
name is unique within a namespace to reference a secret resource.
|
||||
|
||||
- **iscsi.secretRef.namespace** (string)
|
||||
|
||||
Namespace defines the space within which the secret name must be unique.
|
||||
namespace defines the space within which the secret name must be unique.
|
||||
|
||||
- **nfs** (NFSVolumeSource)
|
||||
|
||||
NFS represents an NFS mount on the host. Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
|
||||
nfs represents an NFS mount on the host. Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
|
||||
|
||||
<a name="NFSVolumeSource"></a>
|
||||
*Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling.*
|
||||
|
||||
- **nfs.path** (string), required
|
||||
|
||||
Path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
|
||||
path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
|
||||
|
||||
- **nfs.server** (string), required
|
||||
|
||||
Server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
|
||||
server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
|
||||
|
||||
- **nfs.readOnly** (boolean)
|
||||
|
||||
ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
|
||||
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
|
||||
|
||||
- **photonPersistentDisk** (PhotonPersistentDiskVolumeSource)
|
||||
|
||||
PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
|
||||
photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
|
||||
|
||||
<a name="PhotonPersistentDiskVolumeSource"></a>
|
||||
*Represents a Photon Controller persistent disk resource.*
|
||||
|
||||
- **photonPersistentDisk.pdID** (string), required
|
||||
|
||||
ID that identifies Photon Controller persistent disk
|
||||
pdID is the ID that identifies Photon Controller persistent disk
|
||||
|
||||
- **photonPersistentDisk.fsType** (string)
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
- **portworxVolume** (PortworxVolumeSource)
|
||||
|
||||
PortworxVolume represents a portworx volume attached and mounted on kubelets host machine
|
||||
portworxVolume represents a portworx volume attached and mounted on kubelets host machine
|
||||
|
||||
<a name="PortworxVolumeSource"></a>
|
||||
*PortworxVolumeSource represents a Portworx volume resource.*
|
||||
|
||||
- **portworxVolume.volumeID** (string), required
|
||||
|
||||
VolumeID uniquely identifies a Portworx volume
|
||||
volumeID uniquely identifies a Portworx volume
|
||||
|
||||
- **portworxVolume.fsType** (string)
|
||||
|
||||
FSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.
|
||||
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.
|
||||
|
||||
- **portworxVolume.readOnly** (boolean)
|
||||
|
||||
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
|
||||
readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
|
||||
|
||||
- **quobyte** (QuobyteVolumeSource)
|
||||
|
||||
Quobyte represents a Quobyte mount on the host that shares a pod's lifetime
|
||||
quobyte represents a Quobyte mount on the host that shares a pod's lifetime
|
||||
|
||||
<a name="QuobyteVolumeSource"></a>
|
||||
*Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.*
|
||||
|
||||
- **quobyte.registry** (string), required
|
||||
|
||||
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
|
||||
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
|
||||
|
||||
- **quobyte.volume** (string), required
|
||||
|
||||
Volume is a string that references an already created Quobyte volume by name.
|
||||
volume is a string that references an already created Quobyte volume by name.
|
||||
|
||||
- **quobyte.group** (string)
|
||||
|
||||
Group to map volume access to Default is no group
|
||||
group to map volume access to Default is no group
|
||||
|
||||
- **quobyte.readOnly** (boolean)
|
||||
|
||||
ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.
|
||||
readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.
|
||||
|
||||
- **quobyte.tenant** (string)
|
||||
|
||||
Tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin
|
||||
tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin
|
||||
|
||||
- **quobyte.user** (string)
|
||||
|
||||
User to map volume access to Defaults to serivceaccount user
|
||||
user to map volume access to Defaults to serivceaccount user
|
||||
|
||||
- **rbd** (RBDPersistentVolumeSource)
|
||||
|
||||
RBD represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md
|
||||
rbd represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md
|
||||
|
||||
<a name="RBDPersistentVolumeSource"></a>
|
||||
*Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.*
|
||||
|
||||
- **rbd.image** (string), required
|
||||
|
||||
The rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
|
||||
image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
|
||||
|
||||
- **rbd.monitors** ([]string), required
|
||||
|
||||
A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
|
||||
monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
|
||||
|
||||
- **rbd.fsType** (string)
|
||||
|
||||
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
|
||||
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
|
||||
|
||||
- **rbd.keyring** (string)
|
||||
|
||||
Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
|
||||
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
|
||||
|
||||
- **rbd.pool** (string)
|
||||
|
||||
The rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
|
||||
pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
|
||||
|
||||
- **rbd.readOnly** (boolean)
|
||||
|
||||
ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
|
||||
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
|
||||
|
||||
- **rbd.secretRef** (SecretReference)
|
||||
|
||||
SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
|
||||
secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
|
||||
|
||||
<a name="SecretReference"></a>
|
||||
*SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace*
|
||||
|
||||
- **rbd.secretRef.name** (string)
|
||||
|
||||
Name is unique within a namespace to reference a secret resource.
|
||||
name is unique within a namespace to reference a secret resource.
|
||||
|
||||
- **rbd.secretRef.namespace** (string)
|
||||
|
||||
Namespace defines the space within which the secret name must be unique.
|
||||
namespace defines the space within which the secret name must be unique.
|
||||
|
||||
- **rbd.user** (string)
|
||||
|
||||
The rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
|
||||
user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
|
||||
|
||||
- **scaleIO** (ScaleIOPersistentVolumeSource)
|
||||
|
||||
ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
|
||||
scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
|
||||
|
||||
<a name="ScaleIOPersistentVolumeSource"></a>
|
||||
*ScaleIOPersistentVolumeSource represents a persistent ScaleIO volume*
|
||||
|
||||
- **scaleIO.gateway** (string), required
|
||||
|
||||
The host address of the ScaleIO API Gateway.
|
||||
gateway is the host address of the ScaleIO API Gateway.
|
||||
|
||||
- **scaleIO.secretRef** (SecretReference), required
|
||||
|
||||
SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
|
||||
secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
|
||||
|
||||
<a name="SecretReference"></a>
|
||||
*SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace*
|
||||
|
||||
- **scaleIO.secretRef.name** (string)
|
||||
|
||||
Name is unique within a namespace to reference a secret resource.
|
||||
name is unique within a namespace to reference a secret resource.
|
||||
|
||||
- **scaleIO.secretRef.namespace** (string)
|
||||
|
||||
Namespace defines the space within which the secret name must be unique.
|
||||
namespace defines the space within which the secret name must be unique.
|
||||
|
||||
- **scaleIO.system** (string), required
|
||||
|
||||
The name of the storage system as configured in ScaleIO.
|
||||
system is the name of the storage system as configured in ScaleIO.
|
||||
|
||||
- **scaleIO.fsType** (string)
|
||||
|
||||
Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs"
|
||||
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"
|
||||
|
||||
- **scaleIO.protectionDomain** (string)
|
||||
|
||||
The name of the ScaleIO Protection Domain for the configured storage.
|
||||
protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.
|
||||
|
||||
- **scaleIO.readOnly** (boolean)
|
||||
|
||||
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
|
||||
readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
|
||||
|
||||
- **scaleIO.sslEnabled** (boolean)
|
||||
|
||||
Flag to enable/disable SSL communication with Gateway, default false
|
||||
sslEnabled is the flag to enable/disable SSL communication with Gateway, default false
|
||||
|
||||
- **scaleIO.storageMode** (string)
|
||||
|
||||
Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.
|
||||
storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.
|
||||
|
||||
- **scaleIO.storagePool** (string)
|
||||
|
||||
The ScaleIO Storage Pool associated with the protection domain.
|
||||
storagePool is the ScaleIO Storage Pool associated with the protection domain.
|
||||
|
||||
- **scaleIO.volumeName** (string)
|
||||
|
||||
The name of a volume already created in the ScaleIO system that is associated with this volume source.
|
||||
volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.
|
||||
|
||||
- **storageos** (StorageOSPersistentVolumeSource)
|
||||
|
||||
StorageOS represents a StorageOS volume that is attached to the kubelet's host machine and mounted into the pod More info: https://examples.k8s.io/volumes/storageos/README.md
|
||||
storageOS represents a StorageOS volume that is attached to the kubelet's host machine and mounted into the pod More info: https://examples.k8s.io/volumes/storageos/README.md
|
||||
|
||||
<a name="StorageOSPersistentVolumeSource"></a>
|
||||
*Represents a StorageOS persistent volume resource.*
|
||||
|
||||
- **storageos.fsType** (string)
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
- **storageos.readOnly** (boolean)
|
||||
|
||||
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
|
||||
readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
|
||||
|
||||
- **storageos.secretRef** (<a href="{{< ref "../common-definitions/object-reference#ObjectReference" >}}">ObjectReference</a>)
|
||||
|
||||
SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
|
||||
secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
|
||||
|
||||
- **storageos.volumeName** (string)
|
||||
|
||||
VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.
|
||||
volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.
|
||||
|
||||
- **storageos.volumeNamespace** (string)
|
||||
|
||||
VolumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.
|
||||
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.
|
||||
|
||||
- **vsphereVolume** (VsphereVirtualDiskVolumeSource)
|
||||
|
||||
VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine
|
||||
vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine
|
||||
|
||||
<a name="VsphereVirtualDiskVolumeSource"></a>
|
||||
*Represents a vSphere volume resource.*
|
||||
|
||||
- **vsphereVolume.volumePath** (string), required
|
||||
|
||||
Path that identifies vSphere volume vmdk
|
||||
volumePath is the path that identifies vSphere volume vmdk
|
||||
|
||||
- **vsphereVolume.fsType** (string)
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
- **vsphereVolume.storagePolicyID** (string)
|
||||
|
||||
Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
|
||||
storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
|
||||
|
||||
- **vsphereVolume.storagePolicyName** (string)
|
||||
|
||||
Storage Policy Based Management (SPBM) profile name.
|
||||
storagePolicyName is the storage Policy Based Management (SPBM) profile name.
|
||||
|
||||
|
||||
|
||||
|
|
@ -844,22 +841,17 @@ PersistentVolumeStatus is the current status of a persistent volume.
|
|||
|
||||
- **message** (string)
|
||||
|
||||
A human-readable message indicating details about why the volume is in this state.
|
||||
message is a human-readable message indicating details about why the volume is in this state.
|
||||
|
||||
- **phase** (string)
|
||||
|
||||
Phase indicates if a volume is available, bound to a claim, or released by a claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#phase
|
||||
phase indicates if a volume is available, bound to a claim, or released by a claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#phase
|
||||
|
||||
|
||||
Possible enum values:
|
||||
- `"Available"` used for PersistentVolumes that are not yet bound Available volumes are held by the binder and matched to PersistentVolumeClaims
|
||||
- `"Bound"` used for PersistentVolumes that are bound
|
||||
- `"Failed"` used for PersistentVolumes that failed to be correctly recycled or deleted after being released from a claim
|
||||
- `"Pending"` used for PersistentVolumes that are not available
|
||||
- `"Released"` used for PersistentVolumes where the bound PersistentVolumeClaim was deleted released volumes must be recycled before becoming available again this phase is used by the persistent volume claim binder to signal to another process to reclaim the resource
|
||||
|
||||
- **reason** (string)
|
||||
|
||||
Reason is a brief CamelCase string that describes any failure and is meant for machine parsing and tidy display in the CLI.
|
||||
reason is a brief CamelCase string that describes any failure and is meant for machine parsing and tidy display in the CLI.
|
||||
|
||||
|
||||
|
||||
|
|
@ -883,7 +875,7 @@ PersistentVolumeList is a list of PersistentVolume items.
|
|||
|
||||
- **items** ([]<a href="{{< ref "../config-and-storage-resources/persistent-volume-v1#PersistentVolume" >}}">PersistentVolume</a>), required
|
||||
|
||||
List of persistent volumes. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes
|
||||
items is a list of persistent volumes. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -34,7 +34,7 @@ Volume represents a named volume in a pod that may be accessed by any container
|
|||
|
||||
- **name** (string), required
|
||||
|
||||
Volume's name. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||||
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
|
||||
|
||||
|
||||
|
||||
|
|
@ -43,25 +43,25 @@ Volume represents a named volume in a pod that may be accessed by any container
|
|||
|
||||
- **persistentVolumeClaim** (PersistentVolumeClaimVolumeSource)
|
||||
|
||||
PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
|
||||
persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
|
||||
|
||||
<a name="PersistentVolumeClaimVolumeSource"></a>
|
||||
*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).*
|
||||
|
||||
- **persistentVolumeClaim.claimName** (string), required
|
||||
|
||||
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
|
||||
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
|
||||
|
||||
- **persistentVolumeClaim.readOnly** (boolean)
|
||||
|
||||
Will force the ReadOnly setting in VolumeMounts. Default false.
|
||||
readOnly Will force the ReadOnly setting in VolumeMounts. Default false.
|
||||
|
||||
### Projections
|
||||
|
||||
|
||||
- **configMap** (ConfigMapVolumeSource)
|
||||
|
||||
ConfigMap represents a configMap that should populate this volume
|
||||
configMap represents a configMap that should populate this volume
|
||||
|
||||
<a name="ConfigMapVolumeSource"></a>
|
||||
*Adapts a ConfigMap into a volume.
|
||||
|
|
@ -74,19 +74,19 @@ Volume represents a named volume in a pod that may be accessed by any container
|
|||
|
||||
- **configMap.optional** (boolean)
|
||||
|
||||
Specify whether the ConfigMap or its keys must be defined
|
||||
optional specify whether the ConfigMap or its keys must be defined
|
||||
|
||||
- **configMap.defaultMode** (int32)
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
- **configMap.items** ([]<a href="{{< ref "../config-and-storage-resources/volume#KeyToPath" >}}">KeyToPath</a>)
|
||||
|
||||
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 '..'.
|
||||
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 '..'.
|
||||
|
||||
- **secret** (SecretVolumeSource)
|
||||
|
||||
Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
|
||||
secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
|
||||
|
||||
<a name="SecretVolumeSource"></a>
|
||||
*Adapts a Secret into a volume.
|
||||
|
|
@ -95,23 +95,23 @@ Volume represents a named volume in a pod that may be accessed by any container
|
|||
|
||||
- **secret.secretName** (string)
|
||||
|
||||
Name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
|
||||
secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
|
||||
|
||||
- **secret.optional** (boolean)
|
||||
|
||||
Specify whether the Secret or its keys must be defined
|
||||
optional field specify whether the Secret or its keys must be defined
|
||||
|
||||
- **secret.defaultMode** (int32)
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
- **secret.items** ([]<a href="{{< ref "../config-and-storage-resources/volume#KeyToPath" >}}">KeyToPath</a>)
|
||||
|
||||
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 '..'.
|
||||
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 '..'.
|
||||
|
||||
- **downwardAPI** (DownwardAPIVolumeSource)
|
||||
|
||||
DownwardAPI represents downward API about the pod that should populate this volume
|
||||
downwardAPI represents downward API about the pod that should populate this volume
|
||||
|
||||
<a name="DownwardAPIVolumeSource"></a>
|
||||
*DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling.*
|
||||
|
|
@ -126,25 +126,25 @@ Volume represents a named volume in a pod that may be accessed by any container
|
|||
|
||||
- **projected** (ProjectedVolumeSource)
|
||||
|
||||
Items for all in one resources secrets, configmaps, and downward API
|
||||
projected items for all in one resources secrets, configmaps, and downward API
|
||||
|
||||
<a name="ProjectedVolumeSource"></a>
|
||||
*Represents a projected volume source*
|
||||
|
||||
- **projected.defaultMode** (int32)
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
- **projected.sources** ([]VolumeProjection)
|
||||
|
||||
list of volume projections
|
||||
sources is the list of volume projections
|
||||
|
||||
<a name="VolumeProjection"></a>
|
||||
*Projection that may be projected along with other supported volume types*
|
||||
|
||||
- **projected.sources.configMap** (ConfigMapProjection)
|
||||
|
||||
information about the configMap data to project
|
||||
configMap information about the configMap data to project
|
||||
|
||||
<a name="ConfigMapProjection"></a>
|
||||
*Adapts a ConfigMap into a projected volume.
|
||||
|
|
@ -157,15 +157,15 @@ Volume represents a named volume in a pod that may be accessed by any container
|
|||
|
||||
- **projected.sources.configMap.optional** (boolean)
|
||||
|
||||
Specify whether the ConfigMap or its keys must be defined
|
||||
optional specify whether the ConfigMap or its keys must be defined
|
||||
|
||||
- **projected.sources.configMap.items** ([]<a href="{{< ref "../config-and-storage-resources/volume#KeyToPath" >}}">KeyToPath</a>)
|
||||
|
||||
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 '..'.
|
||||
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 '..'.
|
||||
|
||||
- **projected.sources.downwardAPI** (DownwardAPIProjection)
|
||||
|
||||
information about the downwardAPI data to project
|
||||
downwardAPI information about the downwardAPI data to project
|
||||
|
||||
<a name="DownwardAPIProjection"></a>
|
||||
*Represents downward API info for projecting into a projected volume. Note that this is identical to a downwardAPI volume source without the default mode.*
|
||||
|
|
@ -176,7 +176,7 @@ Volume represents a named volume in a pod that may be accessed by any container
|
|||
|
||||
- **projected.sources.secret** (SecretProjection)
|
||||
|
||||
information about the secret data to project
|
||||
secret information about the secret data to project
|
||||
|
||||
<a name="SecretProjection"></a>
|
||||
*Adapts a secret into a projected volume.
|
||||
|
|
@ -189,70 +189,70 @@ Volume represents a named volume in a pod that may be accessed by any container
|
|||
|
||||
- **projected.sources.secret.optional** (boolean)
|
||||
|
||||
Specify whether the Secret or its key must be defined
|
||||
optional field specify whether the Secret or its key must be defined
|
||||
|
||||
- **projected.sources.secret.items** ([]<a href="{{< ref "../config-and-storage-resources/volume#KeyToPath" >}}">KeyToPath</a>)
|
||||
|
||||
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 '..'.
|
||||
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 '..'.
|
||||
|
||||
- **projected.sources.serviceAccountToken** (ServiceAccountTokenProjection)
|
||||
|
||||
information about the serviceAccountToken data to project
|
||||
serviceAccountToken is information about the serviceAccountToken data to project
|
||||
|
||||
<a name="ServiceAccountTokenProjection"></a>
|
||||
*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).*
|
||||
|
||||
- **projected.sources.serviceAccountToken.path** (string), required
|
||||
|
||||
Path is the path relative to the mount point of the file to project the token into.
|
||||
path is the path relative to the mount point of the file to project the token into.
|
||||
|
||||
- **projected.sources.serviceAccountToken.audience** (string)
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
- **projected.sources.serviceAccountToken.expirationSeconds** (int64)
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
### Local / Temporary Directory
|
||||
|
||||
|
||||
- **emptyDir** (EmptyDirVolumeSource)
|
||||
|
||||
EmptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
|
||||
emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
|
||||
|
||||
<a name="EmptyDirVolumeSource"></a>
|
||||
*Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling.*
|
||||
|
||||
- **emptyDir.medium** (string)
|
||||
|
||||
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
|
||||
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
|
||||
|
||||
- **emptyDir.sizeLimit** (<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
|
||||
|
||||
Total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir
|
||||
sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir
|
||||
|
||||
- **hostPath** (HostPathVolumeSource)
|
||||
|
||||
HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
|
||||
hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
|
||||
|
||||
<a name="HostPathVolumeSource"></a>
|
||||
*Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.*
|
||||
|
||||
- **hostPath.path** (string), required
|
||||
|
||||
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
|
||||
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
|
||||
|
||||
- **hostPath.type** (string)
|
||||
|
||||
Type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
|
||||
type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
|
||||
|
||||
### Persistent volumes
|
||||
|
||||
|
||||
- **awsElasticBlockStore** (AWSElasticBlockStoreVolumeSource)
|
||||
|
||||
AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
|
||||
awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
|
||||
|
||||
<a name="AWSElasticBlockStoreVolumeSource"></a>
|
||||
*Represents a Persistent Disk resource in AWS.
|
||||
|
|
@ -261,223 +261,223 @@ Volume represents a named volume in a pod that may be accessed by any container
|
|||
|
||||
- **awsElasticBlockStore.volumeID** (string), required
|
||||
|
||||
Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
|
||||
volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
|
||||
|
||||
- **awsElasticBlockStore.fsType** (string)
|
||||
|
||||
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
|
||||
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
|
||||
|
||||
- **awsElasticBlockStore.partition** (int32)
|
||||
|
||||
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).
|
||||
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).
|
||||
|
||||
- **awsElasticBlockStore.readOnly** (boolean)
|
||||
|
||||
Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". If omitted, the default is "false". More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
|
||||
readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
|
||||
|
||||
- **azureDisk** (AzureDiskVolumeSource)
|
||||
|
||||
AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
|
||||
azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
|
||||
|
||||
<a name="AzureDiskVolumeSource"></a>
|
||||
*AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.*
|
||||
|
||||
- **azureDisk.diskName** (string), required
|
||||
|
||||
The Name of the data disk in the blob storage
|
||||
diskName is the Name of the data disk in the blob storage
|
||||
|
||||
- **azureDisk.diskURI** (string), required
|
||||
|
||||
The URI the data disk in the blob storage
|
||||
diskURI is the URI of data disk in the blob storage
|
||||
|
||||
- **azureDisk.cachingMode** (string)
|
||||
|
||||
Host Caching mode: None, Read Only, Read Write.
|
||||
cachingMode is the Host Caching mode: None, Read Only, Read Write.
|
||||
|
||||
- **azureDisk.fsType** (string)
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
- **azureDisk.kind** (string)
|
||||
|
||||
Expected values 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
|
||||
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
|
||||
|
||||
- **azureDisk.readOnly** (boolean)
|
||||
|
||||
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
|
||||
readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
|
||||
|
||||
- **azureFile** (AzureFileVolumeSource)
|
||||
|
||||
AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
|
||||
azureFile represents an Azure File Service mount on the host and bind mount to the pod.
|
||||
|
||||
<a name="AzureFileVolumeSource"></a>
|
||||
*AzureFile represents an Azure File Service mount on the host and bind mount to the pod.*
|
||||
|
||||
- **azureFile.secretName** (string), required
|
||||
|
||||
the name of secret that contains Azure Storage Account Name and Key
|
||||
secretName is the name of secret that contains Azure Storage Account Name and Key
|
||||
|
||||
- **azureFile.shareName** (string), required
|
||||
|
||||
Share Name
|
||||
shareName is the azure share Name
|
||||
|
||||
- **azureFile.readOnly** (boolean)
|
||||
|
||||
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
|
||||
readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
|
||||
|
||||
- **cephfs** (CephFSVolumeSource)
|
||||
|
||||
CephFS represents a Ceph FS mount on the host that shares a pod's lifetime
|
||||
cephFS represents a Ceph FS mount on the host that shares a pod's lifetime
|
||||
|
||||
<a name="CephFSVolumeSource"></a>
|
||||
*Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.*
|
||||
|
||||
- **cephfs.monitors** ([]string), required
|
||||
|
||||
Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
|
||||
monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
|
||||
|
||||
- **cephfs.path** (string)
|
||||
|
||||
Optional: Used as the mounted root, rather than the full Ceph tree, default is /
|
||||
path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /
|
||||
|
||||
- **cephfs.readOnly** (boolean)
|
||||
|
||||
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
|
||||
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
|
||||
|
||||
- **cephfs.secretFile** (string)
|
||||
|
||||
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
|
||||
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
|
||||
|
||||
- **cephfs.secretRef** (<a href="{{< ref "../common-definitions/local-object-reference#LocalObjectReference" >}}">LocalObjectReference</a>)
|
||||
|
||||
Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
|
||||
secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
|
||||
|
||||
- **cephfs.user** (string)
|
||||
|
||||
Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
|
||||
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
|
||||
|
||||
- **cinder** (CinderVolumeSource)
|
||||
|
||||
Cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
|
||||
cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
|
||||
|
||||
<a name="CinderVolumeSource"></a>
|
||||
*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.*
|
||||
|
||||
- **cinder.volumeID** (string), required
|
||||
|
||||
volume id used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
|
||||
volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
|
||||
|
||||
- **cinder.fsType** (string)
|
||||
|
||||
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
|
||||
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
|
||||
|
||||
- **cinder.readOnly** (boolean)
|
||||
|
||||
Optional: 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
|
||||
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
|
||||
|
||||
- **cinder.secretRef** (<a href="{{< ref "../common-definitions/local-object-reference#LocalObjectReference" >}}">LocalObjectReference</a>)
|
||||
|
||||
Optional: points to a secret object containing parameters used to connect to OpenStack.
|
||||
secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.
|
||||
|
||||
- **csi** (CSIVolumeSource)
|
||||
|
||||
CSI (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).
|
||||
csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).
|
||||
|
||||
<a name="CSIVolumeSource"></a>
|
||||
*Represents a source location of a volume to mount, managed by an external CSI driver*
|
||||
|
||||
- **csi.driver** (string), required
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
- **csi.fsType** (string)
|
||||
|
||||
Filesystem type 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.
|
||||
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.
|
||||
|
||||
- **csi.nodePublishSecretRef** (<a href="{{< ref "../common-definitions/local-object-reference#LocalObjectReference" >}}">LocalObjectReference</a>)
|
||||
|
||||
NodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.
|
||||
nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.
|
||||
|
||||
- **csi.readOnly** (boolean)
|
||||
|
||||
Specifies a read-only configuration for the volume. Defaults to false (read/write).
|
||||
readOnly specifies a read-only configuration for the volume. Defaults to false (read/write).
|
||||
|
||||
- **csi.volumeAttributes** (map[string]string)
|
||||
|
||||
VolumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.
|
||||
volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.
|
||||
|
||||
- **fc** (FCVolumeSource)
|
||||
|
||||
FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
|
||||
fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
|
||||
|
||||
<a name="FCVolumeSource"></a>
|
||||
*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.*
|
||||
|
||||
- **fc.fsType** (string)
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
- **fc.lun** (int32)
|
||||
|
||||
Optional: FC target lun number
|
||||
lun is Optional: FC target lun number
|
||||
|
||||
- **fc.readOnly** (boolean)
|
||||
|
||||
Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
|
||||
readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
|
||||
|
||||
- **fc.targetWWNs** ([]string)
|
||||
|
||||
Optional: FC target worldwide names (WWNs)
|
||||
targetWWNs is Optional: FC target worldwide names (WWNs)
|
||||
|
||||
- **fc.wwids** ([]string)
|
||||
|
||||
Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.
|
||||
wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.
|
||||
|
||||
- **flexVolume** (FlexVolumeSource)
|
||||
|
||||
FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.
|
||||
flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.
|
||||
|
||||
<a name="FlexVolumeSource"></a>
|
||||
*FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.*
|
||||
|
||||
- **flexVolume.driver** (string), required
|
||||
|
||||
Driver is the name of the driver to use for this volume.
|
||||
driver is the name of the driver to use for this volume.
|
||||
|
||||
- **flexVolume.fsType** (string)
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
- **flexVolume.options** (map[string]string)
|
||||
|
||||
Optional: Extra command options if any.
|
||||
options is Optional: this field holds extra command options if any.
|
||||
|
||||
- **flexVolume.readOnly** (boolean)
|
||||
|
||||
Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
|
||||
readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
|
||||
|
||||
- **flexVolume.secretRef** (<a href="{{< ref "../common-definitions/local-object-reference#LocalObjectReference" >}}">LocalObjectReference</a>)
|
||||
|
||||
Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.
|
||||
secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.
|
||||
|
||||
- **flocker** (FlockerVolumeSource)
|
||||
|
||||
Flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running
|
||||
flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running
|
||||
|
||||
<a name="FlockerVolumeSource"></a>
|
||||
*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.*
|
||||
|
||||
- **flocker.datasetName** (string)
|
||||
|
||||
Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated
|
||||
datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated
|
||||
|
||||
- **flocker.datasetUUID** (string)
|
||||
|
||||
UUID of the dataset. This is unique identifier of a Flocker dataset
|
||||
datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset
|
||||
|
||||
- **gcePersistentDisk** (GCEPersistentDiskVolumeSource)
|
||||
|
||||
GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
|
||||
gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
|
||||
|
||||
<a name="GCEPersistentDiskVolumeSource"></a>
|
||||
*Represents a Persistent Disk resource in Google Compute Engine.
|
||||
|
|
@ -486,316 +486,316 @@ Volume represents a named volume in a pod that may be accessed by any container
|
|||
|
||||
- **gcePersistentDisk.pdName** (string), required
|
||||
|
||||
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
|
||||
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
|
||||
|
||||
- **gcePersistentDisk.fsType** (string)
|
||||
|
||||
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
|
||||
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
|
||||
|
||||
- **gcePersistentDisk.partition** (int32)
|
||||
|
||||
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
|
||||
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
|
||||
|
||||
- **gcePersistentDisk.readOnly** (boolean)
|
||||
|
||||
ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
|
||||
readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
|
||||
|
||||
- **glusterfs** (GlusterfsVolumeSource)
|
||||
|
||||
Glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md
|
||||
glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md
|
||||
|
||||
<a name="GlusterfsVolumeSource"></a>
|
||||
*Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.*
|
||||
|
||||
- **glusterfs.endpoints** (string), required
|
||||
|
||||
EndpointsName is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
|
||||
endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
|
||||
|
||||
- **glusterfs.path** (string), required
|
||||
|
||||
Path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
|
||||
path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
|
||||
|
||||
- **glusterfs.readOnly** (boolean)
|
||||
|
||||
ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
|
||||
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
|
||||
|
||||
- **iscsi** (ISCSIVolumeSource)
|
||||
|
||||
ISCSI represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md
|
||||
iscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md
|
||||
|
||||
<a name="ISCSIVolumeSource"></a>
|
||||
*Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.*
|
||||
|
||||
- **iscsi.iqn** (string), required
|
||||
|
||||
Target iSCSI Qualified Name.
|
||||
iqn is the target iSCSI Qualified Name.
|
||||
|
||||
- **iscsi.lun** (int32), required
|
||||
|
||||
iSCSI Target Lun number.
|
||||
lun represents iSCSI Target Lun number.
|
||||
|
||||
- **iscsi.targetPortal** (string), required
|
||||
|
||||
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).
|
||||
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).
|
||||
|
||||
- **iscsi.chapAuthDiscovery** (boolean)
|
||||
|
||||
whether support iSCSI Discovery CHAP authentication
|
||||
chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication
|
||||
|
||||
- **iscsi.chapAuthSession** (boolean)
|
||||
|
||||
whether support iSCSI Session CHAP authentication
|
||||
chapAuthSession defines whether support iSCSI Session CHAP authentication
|
||||
|
||||
- **iscsi.fsType** (string)
|
||||
|
||||
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
|
||||
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
|
||||
|
||||
- **iscsi.initiatorName** (string)
|
||||
|
||||
Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface \<target portal>:\<volume name> will be created for the connection.
|
||||
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.
|
||||
|
||||
- **iscsi.iscsiInterface** (string)
|
||||
|
||||
iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).
|
||||
iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).
|
||||
|
||||
- **iscsi.portals** ([]string)
|
||||
|
||||
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).
|
||||
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).
|
||||
|
||||
- **iscsi.readOnly** (boolean)
|
||||
|
||||
ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
|
||||
readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
|
||||
|
||||
- **iscsi.secretRef** (<a href="{{< ref "../common-definitions/local-object-reference#LocalObjectReference" >}}">LocalObjectReference</a>)
|
||||
|
||||
CHAP Secret for iSCSI target and initiator authentication
|
||||
secretRef is the CHAP Secret for iSCSI target and initiator authentication
|
||||
|
||||
- **nfs** (NFSVolumeSource)
|
||||
|
||||
NFS represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
|
||||
nfs represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
|
||||
|
||||
<a name="NFSVolumeSource"></a>
|
||||
*Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling.*
|
||||
|
||||
- **nfs.path** (string), required
|
||||
|
||||
Path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
|
||||
path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
|
||||
|
||||
- **nfs.server** (string), required
|
||||
|
||||
Server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
|
||||
server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
|
||||
|
||||
- **nfs.readOnly** (boolean)
|
||||
|
||||
ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
|
||||
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
|
||||
|
||||
- **photonPersistentDisk** (PhotonPersistentDiskVolumeSource)
|
||||
|
||||
PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
|
||||
photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
|
||||
|
||||
<a name="PhotonPersistentDiskVolumeSource"></a>
|
||||
*Represents a Photon Controller persistent disk resource.*
|
||||
|
||||
- **photonPersistentDisk.pdID** (string), required
|
||||
|
||||
ID that identifies Photon Controller persistent disk
|
||||
pdID is the ID that identifies Photon Controller persistent disk
|
||||
|
||||
- **photonPersistentDisk.fsType** (string)
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
- **portworxVolume** (PortworxVolumeSource)
|
||||
|
||||
PortworxVolume represents a portworx volume attached and mounted on kubelets host machine
|
||||
portworxVolume represents a portworx volume attached and mounted on kubelets host machine
|
||||
|
||||
<a name="PortworxVolumeSource"></a>
|
||||
*PortworxVolumeSource represents a Portworx volume resource.*
|
||||
|
||||
- **portworxVolume.volumeID** (string), required
|
||||
|
||||
VolumeID uniquely identifies a Portworx volume
|
||||
volumeID uniquely identifies a Portworx volume
|
||||
|
||||
- **portworxVolume.fsType** (string)
|
||||
|
||||
FSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.
|
||||
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.
|
||||
|
||||
- **portworxVolume.readOnly** (boolean)
|
||||
|
||||
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
|
||||
readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
|
||||
|
||||
- **quobyte** (QuobyteVolumeSource)
|
||||
|
||||
Quobyte represents a Quobyte mount on the host that shares a pod's lifetime
|
||||
quobyte represents a Quobyte mount on the host that shares a pod's lifetime
|
||||
|
||||
<a name="QuobyteVolumeSource"></a>
|
||||
*Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.*
|
||||
|
||||
- **quobyte.registry** (string), required
|
||||
|
||||
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
|
||||
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
|
||||
|
||||
- **quobyte.volume** (string), required
|
||||
|
||||
Volume is a string that references an already created Quobyte volume by name.
|
||||
volume is a string that references an already created Quobyte volume by name.
|
||||
|
||||
- **quobyte.group** (string)
|
||||
|
||||
Group to map volume access to Default is no group
|
||||
group to map volume access to Default is no group
|
||||
|
||||
- **quobyte.readOnly** (boolean)
|
||||
|
||||
ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.
|
||||
readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.
|
||||
|
||||
- **quobyte.tenant** (string)
|
||||
|
||||
Tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin
|
||||
tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin
|
||||
|
||||
- **quobyte.user** (string)
|
||||
|
||||
User to map volume access to Defaults to serivceaccount user
|
||||
user to map volume access to Defaults to serivceaccount user
|
||||
|
||||
- **rbd** (RBDVolumeSource)
|
||||
|
||||
RBD represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md
|
||||
rbd represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md
|
||||
|
||||
<a name="RBDVolumeSource"></a>
|
||||
*Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.*
|
||||
|
||||
- **rbd.image** (string), required
|
||||
|
||||
The rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
|
||||
image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
|
||||
|
||||
- **rbd.monitors** ([]string), required
|
||||
|
||||
A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
|
||||
monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
|
||||
|
||||
- **rbd.fsType** (string)
|
||||
|
||||
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
|
||||
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
|
||||
|
||||
- **rbd.keyring** (string)
|
||||
|
||||
Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
|
||||
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
|
||||
|
||||
- **rbd.pool** (string)
|
||||
|
||||
The rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
|
||||
pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
|
||||
|
||||
- **rbd.readOnly** (boolean)
|
||||
|
||||
ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
|
||||
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
|
||||
|
||||
- **rbd.secretRef** (<a href="{{< ref "../common-definitions/local-object-reference#LocalObjectReference" >}}">LocalObjectReference</a>)
|
||||
|
||||
SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
|
||||
secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
|
||||
|
||||
- **rbd.user** (string)
|
||||
|
||||
The rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
|
||||
user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
|
||||
|
||||
- **scaleIO** (ScaleIOVolumeSource)
|
||||
|
||||
ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
|
||||
scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
|
||||
|
||||
<a name="ScaleIOVolumeSource"></a>
|
||||
*ScaleIOVolumeSource represents a persistent ScaleIO volume*
|
||||
|
||||
- **scaleIO.gateway** (string), required
|
||||
|
||||
The host address of the ScaleIO API Gateway.
|
||||
gateway is the host address of the ScaleIO API Gateway.
|
||||
|
||||
- **scaleIO.secretRef** (<a href="{{< ref "../common-definitions/local-object-reference#LocalObjectReference" >}}">LocalObjectReference</a>), required
|
||||
|
||||
SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
|
||||
secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
|
||||
|
||||
- **scaleIO.system** (string), required
|
||||
|
||||
The name of the storage system as configured in ScaleIO.
|
||||
system is the name of the storage system as configured in ScaleIO.
|
||||
|
||||
- **scaleIO.fsType** (string)
|
||||
|
||||
Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs".
|
||||
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".
|
||||
|
||||
- **scaleIO.protectionDomain** (string)
|
||||
|
||||
The name of the ScaleIO Protection Domain for the configured storage.
|
||||
protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.
|
||||
|
||||
- **scaleIO.readOnly** (boolean)
|
||||
|
||||
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
|
||||
readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
|
||||
|
||||
- **scaleIO.sslEnabled** (boolean)
|
||||
|
||||
Flag to enable/disable SSL communication with Gateway, default false
|
||||
sslEnabled Flag enable/disable SSL communication with Gateway, default false
|
||||
|
||||
- **scaleIO.storageMode** (string)
|
||||
|
||||
Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.
|
||||
storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.
|
||||
|
||||
- **scaleIO.storagePool** (string)
|
||||
|
||||
The ScaleIO Storage Pool associated with the protection domain.
|
||||
storagePool is the ScaleIO Storage Pool associated with the protection domain.
|
||||
|
||||
- **scaleIO.volumeName** (string)
|
||||
|
||||
The name of a volume already created in the ScaleIO system that is associated with this volume source.
|
||||
volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.
|
||||
|
||||
- **storageos** (StorageOSVolumeSource)
|
||||
|
||||
StorageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.
|
||||
storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.
|
||||
|
||||
<a name="StorageOSVolumeSource"></a>
|
||||
*Represents a StorageOS persistent volume resource.*
|
||||
|
||||
- **storageos.fsType** (string)
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
- **storageos.readOnly** (boolean)
|
||||
|
||||
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
|
||||
readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
|
||||
|
||||
- **storageos.secretRef** (<a href="{{< ref "../common-definitions/local-object-reference#LocalObjectReference" >}}">LocalObjectReference</a>)
|
||||
|
||||
SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
|
||||
secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
|
||||
|
||||
- **storageos.volumeName** (string)
|
||||
|
||||
VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.
|
||||
volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.
|
||||
|
||||
- **storageos.volumeNamespace** (string)
|
||||
|
||||
VolumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.
|
||||
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.
|
||||
|
||||
- **vsphereVolume** (VsphereVirtualDiskVolumeSource)
|
||||
|
||||
VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine
|
||||
vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine
|
||||
|
||||
<a name="VsphereVirtualDiskVolumeSource"></a>
|
||||
*Represents a vSphere volume resource.*
|
||||
|
||||
- **vsphereVolume.volumePath** (string), required
|
||||
|
||||
Path that identifies vSphere volume vmdk
|
||||
volumePath is the path that identifies vSphere volume vmdk
|
||||
|
||||
- **vsphereVolume.fsType** (string)
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
- **vsphereVolume.storagePolicyID** (string)
|
||||
|
||||
Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
|
||||
storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
|
||||
|
||||
- **vsphereVolume.storagePolicyName** (string)
|
||||
|
||||
Storage Policy Based Management (SPBM) profile name.
|
||||
storagePolicyName is the storage Policy Based Management (SPBM) profile name.
|
||||
|
||||
### Alpha level
|
||||
|
||||
|
||||
- **ephemeral** (EphemeralVolumeSource)
|
||||
|
||||
Ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed.
|
||||
ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed.
|
||||
|
||||
Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity
|
||||
tracking are needed,
|
||||
|
|
@ -839,7 +839,7 @@ Volume represents a named volume in a pod that may be accessed by any container
|
|||
|
||||
- **gitRepo** (GitRepoVolumeSource)
|
||||
|
||||
GitRepo represents a git repository at a particular revision. 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.
|
||||
gitRepo represents a git repository at a particular revision. 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.
|
||||
|
||||
<a name="GitRepoVolumeSource"></a>
|
||||
*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.
|
||||
|
|
@ -848,15 +848,15 @@ Volume represents a named volume in a pod that may be accessed by any container
|
|||
|
||||
- **gitRepo.repository** (string), required
|
||||
|
||||
Repository URL
|
||||
repository is the URL
|
||||
|
||||
- **gitRepo.directory** (string)
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
- **gitRepo.revision** (string)
|
||||
|
||||
Commit hash for the specified revision.
|
||||
revision is the commit hash for the specified revision.
|
||||
|
||||
|
||||
|
||||
|
|
@ -894,15 +894,15 @@ Maps a string key to a path within a volume.
|
|||
|
||||
- **key** (string), required
|
||||
|
||||
The key to project.
|
||||
key is the key to project.
|
||||
|
||||
- **path** (string), required
|
||||
|
||||
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 '..'.
|
||||
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 '..'.
|
||||
|
||||
- **mode** (int32)
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -66,11 +66,6 @@ LimitRangeSpec defines a min/max usage limit for resources that match on kind.
|
|||
- **limits.type** (string), required
|
||||
|
||||
Type of resource that this limit applies to.
|
||||
|
||||
Possible enum values:
|
||||
- `"Container"` Limit that applies to all containers in a namespace
|
||||
- `"PersistentVolumeClaim"` Limit that applies to all persistent volume claims in a namespace
|
||||
- `"Pod"` Limit that applies to all pods in a namespace
|
||||
|
||||
- **limits.default** (map[string]<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
|
||||
|
||||
|
|
|
|||
|
|
@ -46,6 +46,10 @@ NetworkPolicy describes what network traffic is allowed for a set of Pods
|
|||
|
||||
Specification of the desired behavior for this NetworkPolicy.
|
||||
|
||||
- **status** (<a href="{{< ref "../policy-resources/network-policy-v1#NetworkPolicyStatus" >}}">NetworkPolicyStatus</a>)
|
||||
|
||||
Status is the current state of the NetworkPolicy. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -194,6 +198,54 @@ NetworkPolicySpec provides the specification of a NetworkPolicy
|
|||
|
||||
|
||||
|
||||
## NetworkPolicyStatus {#NetworkPolicyStatus}
|
||||
|
||||
NetworkPolicyStatus describe the current state of the NetworkPolicy.
|
||||
|
||||
<hr>
|
||||
|
||||
- **conditions** ([]Condition)
|
||||
|
||||
*Patch strategy: merge on key `type`*
|
||||
|
||||
*Map: unique values on key type will be kept during a merge*
|
||||
|
||||
Conditions holds an array of metav1.Condition that describe the state of the NetworkPolicy. Current service state
|
||||
|
||||
<a name="Condition"></a>
|
||||
*Condition contains details for one aspect of the current state of this API Resource.*
|
||||
|
||||
- **conditions.lastTransitionTime** (Time), required
|
||||
|
||||
lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
|
||||
|
||||
<a name="Time"></a>
|
||||
*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.*
|
||||
|
||||
- **conditions.message** (string), required
|
||||
|
||||
message is a human readable message indicating details about the transition. This may be an empty string.
|
||||
|
||||
- **conditions.reason** (string), required
|
||||
|
||||
reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
|
||||
|
||||
- **conditions.status** (string), required
|
||||
|
||||
status of the condition, one of True, False, Unknown.
|
||||
|
||||
- **conditions.type** (string), required
|
||||
|
||||
type of condition in CamelCase or in foo.example.com/CamelCase.
|
||||
|
||||
- **conditions.observedGeneration** (int64)
|
||||
|
||||
observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## NetworkPolicyList {#NetworkPolicyList}
|
||||
|
||||
NetworkPolicyList is a list of NetworkPolicy objects.
|
||||
|
|
@ -254,6 +306,39 @@ GET /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name}
|
|||
|
||||
|
||||
|
||||
#### Response
|
||||
|
||||
|
||||
200 (<a href="{{< ref "../policy-resources/network-policy-v1#NetworkPolicy" >}}">NetworkPolicy</a>): OK
|
||||
|
||||
401: Unauthorized
|
||||
|
||||
|
||||
### `get` read status of the specified NetworkPolicy
|
||||
|
||||
#### HTTP Request
|
||||
|
||||
GET /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name}/status
|
||||
|
||||
#### Parameters
|
||||
|
||||
|
||||
- **name** (*in path*): string, required
|
||||
|
||||
name of the NetworkPolicy
|
||||
|
||||
|
||||
- **namespace** (*in path*): string, required
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
|
||||
|
||||
|
||||
- **pretty** (*in query*): string
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
|
||||
|
||||
|
||||
|
||||
#### Response
|
||||
|
||||
|
||||
|
|
@ -479,6 +564,61 @@ PUT /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name}
|
|||
|
||||
|
||||
|
||||
- **dryRun** (*in query*): string
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun</a>
|
||||
|
||||
|
||||
- **fieldManager** (*in query*): string
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a>
|
||||
|
||||
|
||||
- **fieldValidation** (*in query*): string
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation</a>
|
||||
|
||||
|
||||
- **pretty** (*in query*): string
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
|
||||
|
||||
|
||||
|
||||
#### Response
|
||||
|
||||
|
||||
200 (<a href="{{< ref "../policy-resources/network-policy-v1#NetworkPolicy" >}}">NetworkPolicy</a>): OK
|
||||
|
||||
201 (<a href="{{< ref "../policy-resources/network-policy-v1#NetworkPolicy" >}}">NetworkPolicy</a>): Created
|
||||
|
||||
401: Unauthorized
|
||||
|
||||
|
||||
### `update` replace status of the specified NetworkPolicy
|
||||
|
||||
#### HTTP Request
|
||||
|
||||
PUT /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name}/status
|
||||
|
||||
#### Parameters
|
||||
|
||||
|
||||
- **name** (*in path*): string, required
|
||||
|
||||
name of the NetworkPolicy
|
||||
|
||||
|
||||
- **namespace** (*in path*): string, required
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
|
||||
|
||||
|
||||
- **body**: <a href="{{< ref "../policy-resources/network-policy-v1#NetworkPolicy" >}}">NetworkPolicy</a>, required
|
||||
|
||||
|
||||
|
||||
|
||||
- **dryRun** (*in query*): string
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun</a>
|
||||
|
|
@ -534,6 +674,66 @@ PATCH /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name}
|
|||
|
||||
|
||||
|
||||
- **dryRun** (*in query*): string
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun</a>
|
||||
|
||||
|
||||
- **fieldManager** (*in query*): string
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a>
|
||||
|
||||
|
||||
- **fieldValidation** (*in query*): string
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation</a>
|
||||
|
||||
|
||||
- **force** (*in query*): boolean
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#force" >}}">force</a>
|
||||
|
||||
|
||||
- **pretty** (*in query*): string
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
|
||||
|
||||
|
||||
|
||||
#### Response
|
||||
|
||||
|
||||
200 (<a href="{{< ref "../policy-resources/network-policy-v1#NetworkPolicy" >}}">NetworkPolicy</a>): OK
|
||||
|
||||
201 (<a href="{{< ref "../policy-resources/network-policy-v1#NetworkPolicy" >}}">NetworkPolicy</a>): Created
|
||||
|
||||
401: Unauthorized
|
||||
|
||||
|
||||
### `patch` partially update status of the specified NetworkPolicy
|
||||
|
||||
#### HTTP Request
|
||||
|
||||
PATCH /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name}/status
|
||||
|
||||
#### Parameters
|
||||
|
||||
|
||||
- **name** (*in path*): string, required
|
||||
|
||||
name of the NetworkPolicy
|
||||
|
||||
|
||||
- **namespace** (*in path*): string, required
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
|
||||
|
||||
|
||||
- **body**: <a href="{{< ref "../common-definitions/patch#Patch" >}}">Patch</a>, required
|
||||
|
||||
|
||||
|
||||
|
||||
- **dryRun** (*in query*): string
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun</a>
|
||||
|
|
|
|||
|
|
@ -82,23 +82,13 @@ ResourceQuotaSpec defines the desired hard limits to enforce for Quota.
|
|||
|
||||
Represents a scope's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist.
|
||||
|
||||
Possible enum values:
|
||||
- `"DoesNotExist"`
|
||||
- `"Exists"`
|
||||
- `"In"`
|
||||
- `"NotIn"`
|
||||
|
||||
|
||||
- **scopeSelector.matchExpressions.scopeName** (string), required
|
||||
|
||||
The name of the scope that the selector applies to.
|
||||
|
||||
Possible enum values:
|
||||
- `"BestEffort"` Match all pod objects that have best effort quality of service
|
||||
- `"CrossNamespacePodAffinity"` Match all pod objects that have cross-namespace pod (anti)affinity mentioned. This is a beta feature enabled by the PodAffinityNamespaceSelector feature flag.
|
||||
- `"NotBestEffort"` Match all pod objects that do not have best effort quality of service
|
||||
- `"NotTerminating"` Match all pod objects where spec.activeDeadlineSeconds is nil
|
||||
- `"PriorityClass"` Match all pod objects that have priority class mentioned
|
||||
- `"Terminating"` Match all pod objects where spec.activeDeadlineSeconds >=0
|
||||
|
||||
|
||||
- **scopeSelector.matchExpressions.values** ([]string)
|
||||
|
||||
|
|
|
|||
|
|
@ -46,10 +46,7 @@ EndpointSlice represents a subset of the endpoints that implement a service. For
|
|||
|
||||
addressType specifies the type of address carried by this EndpointSlice. All addresses in this slice must be the same type. This field is immutable after creation. The following address types are currently supported: * IPv4: Represents an IPv4 Address. * IPv6: Represents an IPv6 Address. * FQDN: Represents a Fully Qualified Domain Name.
|
||||
|
||||
Possible enum values:
|
||||
- `"FQDN"` represents a FQDN.
|
||||
- `"IPv4"` represents an IPv4 Address.
|
||||
- `"IPv6"` represents an IPv6 Address.
|
||||
|
||||
|
||||
- **endpoints** ([]Endpoint), required
|
||||
|
||||
|
|
@ -64,7 +61,7 @@ EndpointSlice represents a subset of the endpoints that implement a service. For
|
|||
|
||||
*Set: unique values will be kept during a merge*
|
||||
|
||||
addresses of this endpoint. The contents of this field are interpreted according to the corresponding EndpointSlice addressType field. Consumers must handle different types of addresses in the context of their own capabilities. This must contain at least one address but no more than 100.
|
||||
addresses of this endpoint. The contents of this field are interpreted according to the corresponding EndpointSlice addressType field. Consumers must handle different types of addresses in the context of their own capabilities. This must contain at least one address but no more than 100. These are all assumed to be fungible and clients may choose to only use the first element. Refer to: https://issue.k8s.io/106267
|
||||
|
||||
- **endpoints.conditions** (EndpointConditions)
|
||||
|
||||
|
|
@ -148,7 +145,7 @@ EndpointSlice represents a subset of the endpoints that implement a service. For
|
|||
|
||||
- **ports.appProtocol** (string)
|
||||
|
||||
The application protocol for this port. This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and http://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol.
|
||||
The application protocol for this port. This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and https://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol.
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -128,10 +128,7 @@ Endpoints is a collection of endpoints that implement the actual service. Exampl
|
|||
|
||||
The IP protocol for this port. Must be UDP, TCP, or SCTP. Default is TCP.
|
||||
|
||||
Possible enum values:
|
||||
- `"SCTP"` is the SCTP protocol.
|
||||
- `"TCP"` is the TCP protocol.
|
||||
- `"UDP"` is the UDP protocol.
|
||||
|
||||
|
||||
- **subsets.ports.name** (string)
|
||||
|
||||
|
|
@ -139,7 +136,7 @@ Endpoints is a collection of endpoints that implement the actual service. Exampl
|
|||
|
||||
- **subsets.ports.appProtocol** (string)
|
||||
|
||||
The application protocol for this port. This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and http://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol.
|
||||
The application protocol for this port. This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and https://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol.
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -235,10 +235,7 @@ IngressStatus describe the current state of the Ingress.
|
|||
|
||||
Protocol is the protocol of the service port of which status is recorded here The supported values are: "TCP", "UDP", "SCTP"
|
||||
|
||||
Possible enum values:
|
||||
- `"SCTP"` is the SCTP protocol.
|
||||
- `"TCP"` is the TCP protocol.
|
||||
- `"UDP"` is the UDP protocol.
|
||||
|
||||
|
||||
- **loadBalancer.ingress.ports.error** (string)
|
||||
|
||||
|
|
|
|||
|
|
@ -90,10 +90,7 @@ ServiceSpec describes the attributes that a user creates on a service.
|
|||
|
||||
The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". Default is TCP.
|
||||
|
||||
Possible enum values:
|
||||
- `"SCTP"` is the SCTP protocol.
|
||||
- `"TCP"` is the TCP protocol.
|
||||
- `"UDP"` is the UDP protocol.
|
||||
|
||||
|
||||
- **ports.name** (string)
|
||||
|
||||
|
|
@ -105,17 +102,13 @@ ServiceSpec describes the attributes that a user creates on a service.
|
|||
|
||||
- **ports.appProtocol** (string)
|
||||
|
||||
The application protocol for this port. This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and http://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol.
|
||||
The application protocol for this port. This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and https://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol.
|
||||
|
||||
- **type** (string)
|
||||
|
||||
type determines how the Service is exposed. Defaults to ClusterIP. Valid options are ExternalName, ClusterIP, NodePort, and LoadBalancer. "ClusterIP" allocates a cluster-internal IP address for load-balancing to endpoints. Endpoints are determined by the selector or if that is not specified, by manual construction of an Endpoints object or EndpointSlice objects. If clusterIP is "None", no virtual IP is allocated and the endpoints are published as a set of endpoints rather than a virtual IP. "NodePort" builds on ClusterIP and allocates a port on every node which routes to the same endpoints as the clusterIP. "LoadBalancer" builds on NodePort and creates an external load-balancer (if supported in the current cloud) which routes to the same endpoints as the clusterIP. "ExternalName" aliases this service to the specified externalName. Several other fields do not apply to ExternalName services. More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types
|
||||
|
||||
Possible enum values:
|
||||
- `"ClusterIP"` means a service will only be accessible inside the cluster, via the cluster IP.
|
||||
- `"ExternalName"` means a service consists of only a reference to an external name that kubedns or equivalent will return as a CNAME record, with no exposing or proxying of any pods involved.
|
||||
- `"LoadBalancer"` means a service will be exposed via an external load balancer (if the cloud provider supports it), in addition to 'NodePort' type.
|
||||
- `"NodePort"` means a service will be exposed on one port of every node, in addition to 'ClusterIP' type.
|
||||
|
||||
|
||||
- **ipFamilies** ([]string)
|
||||
|
||||
|
|
@ -149,13 +142,11 @@ ServiceSpec describes the attributes that a user creates on a service.
|
|||
|
||||
Supports "ClientIP" and "None". Used to maintain session affinity. Enable client IP based session affinity. Must be ClientIP or None. Defaults to None. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
|
||||
|
||||
Possible enum values:
|
||||
- `"ClientIP"` is the Client IP based.
|
||||
- `"None"` - no session affinity.
|
||||
|
||||
|
||||
- **loadBalancerIP** (string)
|
||||
|
||||
Only applies to Service Type: LoadBalancer LoadBalancer will get created with the IP specified in this field. This feature depends on whether the underlying cloud-provider supports specifying the loadBalancerIP when a load balancer is created. This field will be ignored if the cloud-provider does not support the feature.
|
||||
Only applies to Service Type: LoadBalancer. This feature depends on whether the underlying cloud-provider supports specifying the loadBalancerIP when a load balancer is created. This field will be ignored if the cloud-provider does not support the feature. Deprecated: This field was under-specified and its meaning varies across implementations, and it cannot support dual-stack. As of Kubernetes v1.24, users are encouraged to use implementation-specific annotations when available. This field may be removed in a future API version.
|
||||
|
||||
- **loadBalancerSourceRanges** ([]string)
|
||||
|
||||
|
|
@ -173,9 +164,7 @@ ServiceSpec describes the attributes that a user creates on a service.
|
|||
|
||||
externalTrafficPolicy denotes if this Service desires to route external traffic to node-local or cluster-wide endpoints. "Local" preserves the client source IP and avoids a second hop for LoadBalancer and Nodeport type services, but risks potentially imbalanced traffic spreading. "Cluster" obscures the client source IP and may cause a second hop to another node, but should have good overall load-spreading.
|
||||
|
||||
Possible enum values:
|
||||
- `"Cluster"` specifies node-global (legacy) behavior.
|
||||
- `"Local"` specifies node-local endpoints behavior.
|
||||
|
||||
|
||||
- **internalTrafficPolicy** (string)
|
||||
|
||||
|
|
@ -209,7 +198,7 @@ ServiceSpec describes the attributes that a user creates on a service.
|
|||
|
||||
- **allocateLoadBalancerNodePorts** (boolean)
|
||||
|
||||
allocateLoadBalancerNodePorts defines if NodePorts will be automatically allocated for services with type LoadBalancer. Default is "true". It may be set to "false" if the cluster load-balancer does not rely on NodePorts. If the caller requests specific NodePorts (by specifying a value), those requests will be respected, regardless of this field. This field may only be set for services with type LoadBalancer and will be cleared if the type is changed to any other type. This field is beta-level and is only honored by servers that enable the ServiceLBNodePortControl feature.
|
||||
allocateLoadBalancerNodePorts defines if NodePorts will be automatically allocated for services with type LoadBalancer. Default is "true". It may be set to "false" if the cluster load-balancer does not rely on NodePorts. If the caller requests specific NodePorts (by specifying a value), those requests will be respected, regardless of this field. This field may only be set for services with type LoadBalancer and will be cleared if the type is changed to any other type.
|
||||
|
||||
|
||||
|
||||
|
|
@ -298,10 +287,7 @@ ServiceStatus represents the current status of a service.
|
|||
|
||||
Protocol is the protocol of the service port of which status is recorded here The supported values are: "TCP", "UDP", "SCTP"
|
||||
|
||||
Possible enum values:
|
||||
- `"SCTP"` is the SCTP protocol.
|
||||
- `"TCP"` is the TCP protocol.
|
||||
- `"UDP"` is the UDP protocol.
|
||||
|
||||
|
||||
- **loadBalancer.ingress.ports.error** (string)
|
||||
|
||||
|
|
|
|||
|
|
@ -79,14 +79,15 @@ CronJobSpec describes how the job execution will look like and when it will actu
|
|||
|
||||
The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
|
||||
|
||||
- **timeZone** (string)
|
||||
|
||||
The time zone for the given schedule, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. If not specified, this will rely on the time zone of the kube-controller-manager process. ALPHA: This field is in alpha and must be enabled via the `CronJobTimeZone` feature gate.
|
||||
|
||||
- **concurrencyPolicy** (string)
|
||||
|
||||
Specifies how to treat concurrent executions of a Job. Valid values are: - "Allow" (default): allows CronJobs to run concurrently; - "Forbid": forbids concurrent runs, skipping next run if previous run hasn't finished yet; - "Replace": cancels currently running job and replaces it with a new one
|
||||
|
||||
Possible enum values:
|
||||
- `"Allow"` allows CronJobs to run concurrently.
|
||||
- `"Forbid"` forbids concurrent runs, skipping next run if previous hasn't finished yet.
|
||||
- `"Replace"` cancels currently running job and replaces it with a new one.
|
||||
|
||||
|
||||
- **startingDeadlineSeconds** (int64)
|
||||
|
||||
|
|
|
|||
|
|
@ -83,9 +83,7 @@ DaemonSetSpec is the specification of a daemon set.
|
|||
|
||||
Type of daemon set update. Can be "RollingUpdate" or "OnDelete". Default is RollingUpdate.
|
||||
|
||||
Possible enum values:
|
||||
- `"OnDelete"` Replace the old daemons only when it's killed
|
||||
- `"RollingUpdate"` Replace the old daemons by new ones using rolling update i.e replace them on each node one after the other.
|
||||
|
||||
|
||||
- **updateStrategy.rollingUpdate** (RollingUpdateDaemonSet)
|
||||
|
||||
|
|
|
|||
|
|
@ -89,9 +89,7 @@ DeploymentSpec is the specification of the desired behavior of the Deployment.
|
|||
|
||||
Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate.
|
||||
|
||||
Possible enum values:
|
||||
- `"Recreate"` Kill all existing pods before creating new ones.
|
||||
- `"RollingUpdate"` Replace the old ReplicaSets by new one using rolling update i.e gradually scale down the old ReplicaSets and scale up the new one.
|
||||
|
||||
|
||||
- **strategy.rollingUpdate** (RollingUpdateDeployment)
|
||||
|
||||
|
|
|
|||
|
|
@ -88,7 +88,7 @@ JobSpec describes how the job execution will look like.
|
|||
|
||||
`Indexed` means that the Pods of a Job get an associated completion index from 0 to (.spec.completions - 1), available in the annotation batch.kubernetes.io/job-completion-index. The Job is considered complete when there is one successfully completed Pod for each index. When value is `Indexed`, .spec.completions must be specified and `.spec.parallelism` must be less than or equal to 10^5. In addition, The Pod name takes the form `$(job-name)-$(index)-$(random-string)`, the Pod hostname takes the form `$(job-name)-$(index)`.
|
||||
|
||||
This field is beta-level. More completion modes can be added in the future. If the Job controller observes a mode that it doesn't recognize, the controller skips updates for the Job.
|
||||
More completion modes can be added in the future. If the Job controller observes a mode that it doesn't recognize, which is possible during upgrades due to version skew, the controller skips updates for the Job.
|
||||
|
||||
- **backoffLimit** (int32)
|
||||
|
||||
|
|
@ -105,8 +105,6 @@ JobSpec describes how the job execution will look like.
|
|||
- **suspend** (boolean)
|
||||
|
||||
Suspend specifies whether the Job controller should create Pods or not. If a Job is created with suspend set to true, no Pods are created by the Job controller. If a Job is suspended after creation (i.e. the flag goes from false to true), the Job controller will delete all active Pods associated with this Job. Users must design their workload to gracefully handle this. Suspending a Job will reset the StartTime field of the Job, effectively resetting the ActiveDeadlineSeconds timer too. Defaults to false.
|
||||
|
||||
This field is beta-level, gated by SuspendJob feature flag (enabled by default).
|
||||
|
||||
### Selector
|
||||
|
||||
|
|
@ -175,11 +173,6 @@ JobStatus represents the current state of a Job.
|
|||
- **conditions.type** (string), required
|
||||
|
||||
Type of job condition, Complete or Failed.
|
||||
|
||||
Possible enum values:
|
||||
- `"Complete"` means the job has completed its execution.
|
||||
- `"Failed"` means the job has failed its execution.
|
||||
- `"Suspended"` means the job has been suspended.
|
||||
|
||||
- **conditions.lastProbeTime** (Time)
|
||||
|
||||
|
|
@ -236,7 +229,7 @@ JobStatus represents the current state of a Job.
|
|||
|
||||
The number of pods which have a Ready condition.
|
||||
|
||||
This field is alpha-level. The job controller populates the field when the feature gate JobReadyPods is enabled (disabled by default).
|
||||
This field is beta-level. The job controller populates the field when the feature gate JobReadyPods is enabled (enabled by default).
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -81,7 +81,7 @@ PodSpec is a description of a pod.
|
|||
|
||||
*Patch strategy: merge on key `name`*
|
||||
|
||||
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. For example, in the case of docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod
|
||||
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
|
||||
|
||||
- **enableServiceLinks** (boolean)
|
||||
|
||||
|
|
@ -93,7 +93,7 @@ PodSpec is a description of a pod.
|
|||
|
||||
If the OS field is set to linux, the following fields must be unset: -securityContext.windowsOptions
|
||||
|
||||
If the OS field is set to windows, following fields must be unset: - spec.hostPID - spec.hostIPC - spec.securityContext.seLinuxOptions - spec.securityContext.seccompProfile - spec.securityContext.fsGroup - spec.securityContext.fsGroupChangePolicy - spec.securityContext.sysctls - spec.shareProcessNamespace - spec.securityContext.runAsUser - spec.securityContext.runAsGroup - spec.securityContext.supplementalGroups - spec.containers[*].securityContext.seLinuxOptions - spec.containers[*].securityContext.seccompProfile - spec.containers[*].securityContext.capabilities - spec.containers[*].securityContext.readOnlyRootFilesystem - spec.containers[*].securityContext.privileged - spec.containers[*].securityContext.allowPrivilegeEscalation - spec.containers[*].securityContext.procMount - spec.containers[*].securityContext.runAsUser - spec.containers[*].securityContext.runAsGroup This is an alpha field and requires the IdentifyPodOS feature
|
||||
If the OS field is set to windows, following fields must be unset: - spec.hostPID - spec.hostIPC - spec.securityContext.seLinuxOptions - spec.securityContext.seccompProfile - spec.securityContext.fsGroup - spec.securityContext.fsGroupChangePolicy - spec.securityContext.sysctls - spec.shareProcessNamespace - spec.securityContext.runAsUser - spec.securityContext.runAsGroup - spec.securityContext.supplementalGroups - spec.containers[*].securityContext.seLinuxOptions - spec.containers[*].securityContext.seccompProfile - spec.containers[*].securityContext.capabilities - spec.containers[*].securityContext.readOnlyRootFilesystem - spec.containers[*].securityContext.privileged - spec.containers[*].securityContext.allowPrivilegeEscalation - spec.containers[*].securityContext.procMount - spec.containers[*].securityContext.runAsUser - spec.containers[*].securityContext.runAsGroup This is a beta field and requires the IdentifyPodOS feature
|
||||
|
||||
<a name="PodOS"></a>
|
||||
*PodOS defines the OS parameters of a pod.*
|
||||
|
|
@ -156,9 +156,7 @@ PodSpec is a description of a pod.
|
|||
|
||||
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.
|
||||
|
||||
Possible enum values:
|
||||
- `"Equal"`
|
||||
- `"Exists"`
|
||||
|
||||
|
||||
- **tolerations.value** (string)
|
||||
|
||||
|
|
@ -168,10 +166,7 @@ PodSpec is a description of a pod.
|
|||
|
||||
Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
|
||||
|
||||
Possible enum values:
|
||||
- `"NoExecute"` Evict any already-running pods that do not tolerate the taint. Currently enforced by NodeController.
|
||||
- `"NoSchedule"` Do not allow new pods to schedule onto the node unless they tolerate the taint, but allow all pods submitted to Kubelet without going through the scheduler to start, and allow all already-running pods to continue running. Enforced by the scheduler.
|
||||
- `"PreferNoSchedule"` Like TaintEffectNoSchedule, but the scheduler tries not to schedule new pods onto the node, rather than prohibiting new pods from scheduling onto the node entirely. Enforced by the scheduler.
|
||||
|
||||
|
||||
- **tolerations.tolerationSeconds** (int64)
|
||||
|
||||
|
|
@ -183,7 +178,7 @@ PodSpec is a description of a pod.
|
|||
|
||||
- **runtimeClassName** (string)
|
||||
|
||||
RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used to run this pod. If no RuntimeClass resource matches the named class, the pod will not be run. If unset or empty, the "legacy" RuntimeClass will be used, which is an implicit class with an empty definition that uses the default runtime handler. More info: https://git.k8s.io/enhancements/keps/sig-node/585-runtime-class This is a beta feature as of Kubernetes v1.14.
|
||||
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
|
||||
|
||||
- **priorityClassName** (string)
|
||||
|
||||
|
|
@ -206,11 +201,11 @@ PodSpec is a description of a pod.
|
|||
|
||||
- **topologySpreadConstraints.maxSkew** (int32), required
|
||||
|
||||
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. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 1/1/0: | zone1 | zone2 | zone3 | | P | P | | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 1/1/1; scheduling it onto zone1(zone2) would make the ActualSkew(2-0) 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.
|
||||
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.
|
||||
|
||||
- **topologySpreadConstraints.topologyKey** (string), required
|
||||
|
||||
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. It's a required field.
|
||||
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 match the node selector. 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.
|
||||
|
||||
- **topologySpreadConstraints.whenUnsatisfiable** (string), required
|
||||
|
||||
|
|
@ -219,14 +214,20 @@ PodSpec is a description of a pod.
|
|||
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.
|
||||
|
||||
Possible enum values:
|
||||
- `"DoNotSchedule"` instructs the scheduler not to schedule the pod when constraints are not satisfied.
|
||||
- `"ScheduleAnyway"` instructs the scheduler to schedule the pod even if constraints are not satisfied.
|
||||
|
||||
|
||||
- **topologySpreadConstraints.labelSelector** (<a href="{{< ref "../common-definitions/label-selector#LabelSelector" >}}">LabelSelector</a>)
|
||||
|
||||
LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain.
|
||||
|
||||
- **topologySpreadConstraints.minDomains** (int32)
|
||||
|
||||
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 an alpha field and requires enabling MinDomainsInPodTopologySpread feature gate.
|
||||
|
||||
### Lifecycle
|
||||
|
||||
|
||||
|
|
@ -234,10 +235,7 @@ PodSpec is a description of a pod.
|
|||
|
||||
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
|
||||
|
||||
Possible enum values:
|
||||
- `"Always"`
|
||||
- `"Never"`
|
||||
- `"OnFailure"`
|
||||
|
||||
|
||||
- **terminationGracePeriodSeconds** (int64)
|
||||
|
||||
|
|
@ -257,12 +255,6 @@ PodSpec is a description of a pod.
|
|||
- **readinessGates.conditionType** (string), required
|
||||
|
||||
ConditionType refers to a condition in the pod's condition list with matching type.
|
||||
|
||||
Possible enum values:
|
||||
- `"ContainersReady"` indicates whether all containers in the pod are ready.
|
||||
- `"Initialized"` means that all init containers in the pod have started successfully.
|
||||
- `"PodScheduled"` represents status of the scheduling process for this pod.
|
||||
- `"Ready"` means the pod is able to service requests and should be added to the load balancing pools of all matching services.
|
||||
|
||||
### Hostname and Name resolution
|
||||
|
||||
|
|
@ -329,11 +321,7 @@ PodSpec is a description of a pod.
|
|||
|
||||
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'.
|
||||
|
||||
Possible enum values:
|
||||
- `"ClusterFirst"` indicates that the pod should use cluster DNS first unless hostNetwork is true, if it is available, then fall back on the default (as determined by kubelet) DNS settings.
|
||||
- `"ClusterFirstWithHostNet"` indicates that the pod should use cluster DNS first, if it is available, then fall back on the default (as determined by kubelet) DNS settings.
|
||||
- `"Default"` indicates that the pod should use the default (as determined by kubelet) DNS settings.
|
||||
- `"None"` indicates that the pod should use empty DNS settings. DNS parameters such as nameservers and search paths should be defined via DNSConfig.
|
||||
|
||||
|
||||
### Hosts namespaces
|
||||
|
||||
|
|
@ -416,10 +404,7 @@ PodSpec is a description of a pod.
|
|||
|
||||
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.
|
||||
|
||||
Possible enum values:
|
||||
- `"Localhost"` indicates a profile defined in a file on the node should be used. The file's location relative to \<kubelet-root-dir>/seccomp.
|
||||
- `"RuntimeDefault"` represents the default container runtime seccomp profile.
|
||||
- `"Unconfined"` indicates no seccomp profile is applied (A.K.A. unconfined).
|
||||
|
||||
|
||||
- **securityContext.seccompProfile.localhostProfile** (string)
|
||||
|
||||
|
|
@ -497,11 +482,11 @@ PodSpec is a description of a pod.
|
|||
|
||||
- **preemptionPolicy** (string)
|
||||
|
||||
PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is beta-level, gated by the NonPreemptingPriority feature-gate.
|
||||
PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset.
|
||||
|
||||
- **overhead** (map[string]<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
|
||||
|
||||
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 This field is beta-level as of Kubernetes v1.18, and is only honored by servers that enable the PodOverhead feature.
|
||||
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
|
||||
|
||||
### Deprecated
|
||||
|
||||
|
|
@ -529,27 +514,24 @@ A single application container that you want to run within a pod.
|
|||
|
||||
- **image** (string)
|
||||
|
||||
Docker 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.
|
||||
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.
|
||||
|
||||
- **imagePullPolicy** (string)
|
||||
|
||||
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
|
||||
|
||||
Possible enum values:
|
||||
- `"Always"` means that kubelet always attempts to pull the latest image. Container will fail If the pull fails.
|
||||
- `"IfNotPresent"` means that kubelet pulls if the image isn't present on disk. Container will fail if the image isn't present and the pull fails.
|
||||
- `"Never"` means that kubelet never pulls an image, but only uses a local image. Container will fail if the image isn't present
|
||||
|
||||
|
||||
### Entrypoint
|
||||
|
||||
|
||||
- **command** ([]string)
|
||||
|
||||
Entrypoint array. Not executed within a shell. The docker 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
|
||||
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
|
||||
|
||||
- **args** ([]string)
|
||||
|
||||
Arguments to the entrypoint. The docker 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
|
||||
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
|
||||
|
||||
- **workingDir** (string)
|
||||
|
||||
|
|
@ -589,10 +571,7 @@ A single application container that you want to run within a pod.
|
|||
|
||||
Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".
|
||||
|
||||
Possible enum values:
|
||||
- `"SCTP"` is the SCTP protocol.
|
||||
- `"TCP"` is the TCP protocol.
|
||||
- `"UDP"` is the UDP protocol.
|
||||
|
||||
|
||||
### Environment variables
|
||||
|
||||
|
|
@ -809,9 +788,7 @@ A single application container that you want to run within a pod.
|
|||
|
||||
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.
|
||||
|
||||
Possible enum values:
|
||||
- `"FallbackToLogsOnError"` will read the most recent contents of the container logs for the container status message when the container exits with an error and the terminationMessagePath has no contents.
|
||||
- `"File"` is the default behavior and will set the container status message to the contents of the container's terminationMessagePath when the container exits.
|
||||
|
||||
|
||||
- **livenessProbe** (<a href="{{< ref "../workload-resources/pod-v1#Probe" >}}">Probe</a>)
|
||||
|
||||
|
|
@ -891,10 +868,7 @@ A single application container that you want to run within a pod.
|
|||
|
||||
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.
|
||||
|
||||
Possible enum values:
|
||||
- `"Localhost"` indicates a profile defined in a file on the node should be used. The file's location relative to \<kubelet-root-dir>/seccomp.
|
||||
- `"RuntimeDefault"` represents the default container runtime seccomp profile.
|
||||
- `"Unconfined"` indicates no seccomp profile is applied (A.K.A. unconfined).
|
||||
|
||||
|
||||
- **securityContext.seccompProfile.localhostProfile** (string)
|
||||
|
||||
|
|
@ -990,27 +964,24 @@ This is a beta feature available on clusters that haven't disabled the Ephemeral
|
|||
|
||||
- **image** (string)
|
||||
|
||||
Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images
|
||||
Container image name. More info: https://kubernetes.io/docs/concepts/containers/images
|
||||
|
||||
- **imagePullPolicy** (string)
|
||||
|
||||
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
|
||||
|
||||
Possible enum values:
|
||||
- `"Always"` means that kubelet always attempts to pull the latest image. Container will fail If the pull fails.
|
||||
- `"IfNotPresent"` means that kubelet pulls if the image isn't present on disk. Container will fail if the image isn't present and the pull fails.
|
||||
- `"Never"` means that kubelet never pulls an image, but only uses a local image. Container will fail if the image isn't present
|
||||
|
||||
|
||||
### Entrypoint
|
||||
|
||||
|
||||
- **command** ([]string)
|
||||
|
||||
Entrypoint array. Not executed within a shell. The docker 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
|
||||
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
|
||||
|
||||
- **args** ([]string)
|
||||
|
||||
Arguments to the entrypoint. The docker 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
|
||||
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
|
||||
|
||||
- **workingDir** (string)
|
||||
|
||||
|
|
@ -1198,9 +1169,7 @@ This is a beta feature available on clusters that haven't disabled the Ephemeral
|
|||
|
||||
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.
|
||||
|
||||
Possible enum values:
|
||||
- `"FallbackToLogsOnError"` will read the most recent contents of the container logs for the container status message when the container exits with an error and the terminationMessagePath has no contents.
|
||||
- `"File"` is the default behavior and will set the container status message to the contents of the container's terminationMessagePath when the container exits.
|
||||
|
||||
|
||||
### Debugging
|
||||
|
||||
|
|
@ -1283,10 +1252,7 @@ This is a beta feature available on clusters that haven't disabled the Ephemeral
|
|||
|
||||
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.
|
||||
|
||||
Possible enum values:
|
||||
- `"Localhost"` indicates a profile defined in a file on the node should be used. The file's location relative to \<kubelet-root-dir>/seccomp.
|
||||
- `"RuntimeDefault"` represents the default container runtime seccomp profile.
|
||||
- `"Unconfined"` indicates no seccomp profile is applied (A.K.A. unconfined).
|
||||
|
||||
|
||||
- **securityContext.seccompProfile.localhostProfile** (string)
|
||||
|
||||
|
|
@ -1372,10 +1338,7 @@ This is a beta feature available on clusters that haven't disabled the Ephemeral
|
|||
|
||||
Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".
|
||||
|
||||
Possible enum values:
|
||||
- `"SCTP"` is the SCTP protocol.
|
||||
- `"TCP"` is the TCP protocol.
|
||||
- `"UDP"` is the UDP protocol.
|
||||
|
||||
|
||||
- **resources** (ResourceRequirements)
|
||||
|
||||
|
|
@ -1479,9 +1442,7 @@ LifecycleHandler defines a specific action that should be taken in a lifecycle h
|
|||
|
||||
Scheme to use for connecting to the host. Defaults to HTTP.
|
||||
|
||||
Possible enum values:
|
||||
- `"HTTP"` means that the scheme used will be http://
|
||||
- `"HTTPS"` means that the scheme used will be https://
|
||||
|
||||
|
||||
- **tcpSocket** (TCPSocketAction)
|
||||
|
||||
|
|
@ -1593,11 +1554,11 @@ Pod affinity is a group of inter pod affinity scheduling rules.
|
|||
|
||||
- **preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector** (<a href="{{< ref "../common-definitions/label-selector#LabelSelector" >}}">LabelSelector</a>)
|
||||
|
||||
A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled.
|
||||
A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.
|
||||
|
||||
- **preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaces** ([]string)
|
||||
|
||||
namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace"
|
||||
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".
|
||||
|
||||
- **preferredDuringSchedulingIgnoredDuringExecution.weight** (int32), required
|
||||
|
||||
|
|
@ -1620,11 +1581,11 @@ Pod affinity is a group of inter pod affinity scheduling rules.
|
|||
|
||||
- **requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector** (<a href="{{< ref "../common-definitions/label-selector#LabelSelector" >}}">LabelSelector</a>)
|
||||
|
||||
A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled.
|
||||
A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.
|
||||
|
||||
- **requiredDuringSchedulingIgnoredDuringExecution.namespaces** ([]string)
|
||||
|
||||
namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace"
|
||||
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".
|
||||
|
||||
|
||||
|
||||
|
|
@ -1660,11 +1621,11 @@ Pod anti affinity is a group of inter pod anti affinity scheduling rules.
|
|||
|
||||
- **preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector** (<a href="{{< ref "../common-definitions/label-selector#LabelSelector" >}}">LabelSelector</a>)
|
||||
|
||||
A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled.
|
||||
A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.
|
||||
|
||||
- **preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaces** ([]string)
|
||||
|
||||
namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace"
|
||||
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".
|
||||
|
||||
- **preferredDuringSchedulingIgnoredDuringExecution.weight** (int32), required
|
||||
|
||||
|
|
@ -1687,11 +1648,11 @@ Pod anti affinity is a group of inter pod anti affinity scheduling rules.
|
|||
|
||||
- **requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector** (<a href="{{< ref "../common-definitions/label-selector#LabelSelector" >}}">LabelSelector</a>)
|
||||
|
||||
A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled.
|
||||
A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.
|
||||
|
||||
- **requiredDuringSchedulingIgnoredDuringExecution.namespaces** ([]string)
|
||||
|
||||
namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace"
|
||||
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".
|
||||
|
||||
|
||||
|
||||
|
|
@ -1755,9 +1716,7 @@ Probe describes a health check to be performed against a container to determine
|
|||
|
||||
Scheme to use for connecting to the host. Defaults to HTTP.
|
||||
|
||||
Possible enum values:
|
||||
- `"HTTP"` means that the scheme used will be http://
|
||||
- `"HTTPS"` means that the scheme used will be https://
|
||||
|
||||
|
||||
- **tcpSocket** (TCPSocketAction)
|
||||
|
||||
|
|
@ -1803,7 +1762,7 @@ Probe describes a health check to be performed against a container to determine
|
|||
|
||||
- **grpc** (GRPCAction)
|
||||
|
||||
GRPC specifies an action involving a GRPC port. This is an alpha field and requires enabling GRPCContainerProbe feature gate.
|
||||
GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.
|
||||
|
||||
<a name="GRPCAction"></a>
|
||||
**
|
||||
|
|
@ -1851,12 +1810,7 @@ PodStatus represents information about the status of a pod. Status may trail the
|
|||
|
||||
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-phase
|
||||
|
||||
Possible enum values:
|
||||
- `"Failed"` means that all containers in the pod have terminated, and at least one container has terminated in a failure (exited with a non-zero exit code or was stopped by the system).
|
||||
- `"Pending"` means the pod has been accepted by the system, but one or more of the containers has not been started. This includes time before being bound to a node, as well as time spent pulling images onto the host.
|
||||
- `"Running"` means the pod has been bound to a node and all of the containers have been started. At least one container is still running or is in the process of being restarted.
|
||||
- `"Succeeded"` means that all containers in the pod have voluntarily terminated with a container exit code of 0, and the system is not going to restart any of these containers.
|
||||
- `"Unknown"` means that for some reason the state of the pod could not be obtained, typically due to an error in communicating with the host of the pod. Deprecated: It isn't being set since 2015 (74da3b14b0c0f658b3bb8d2def5094686d0e9095)
|
||||
|
||||
|
||||
- **message** (string)
|
||||
|
||||
|
|
@ -1900,12 +1854,6 @@ PodStatus represents information about the status of a pod. Status may trail the
|
|||
- **conditions.type** (string), required
|
||||
|
||||
Type is the type of the condition. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions
|
||||
|
||||
Possible enum values:
|
||||
- `"ContainersReady"` indicates whether all containers in the pod are ready.
|
||||
- `"Initialized"` means that all init containers in the pod have started successfully.
|
||||
- `"PodScheduled"` represents status of the scheduling process for this pod.
|
||||
- `"Ready"` means the pod is able to service requests and should be added to the load balancing pools of all matching services.
|
||||
|
||||
- **conditions.lastProbeTime** (Time)
|
||||
|
||||
|
|
@ -1933,10 +1881,7 @@ PodStatus represents information about the status of a pod. Status may trail the
|
|||
|
||||
The Quality of Service (QOS) classification assigned to the pod based on resource requirements See PodQOSClass type for available QOS classes More info: https://git.k8s.io/community/contributors/design-proposals/node/resource-qos.md
|
||||
|
||||
Possible enum values:
|
||||
- `"BestEffort"` is the BestEffort qos class.
|
||||
- `"Burstable"` is the Burstable qos class.
|
||||
- `"Guaranteed"` is the Guaranteed qos class.
|
||||
|
||||
|
||||
- **initContainerStatuses** ([]ContainerStatus)
|
||||
|
||||
|
|
@ -1959,7 +1904,7 @@ PodStatus represents information about the status of a pod. Status may trail the
|
|||
|
||||
- **initContainerStatuses.containerID** (string)
|
||||
|
||||
Container's ID in the format 'docker://\<container_id>'.
|
||||
Container's ID in the format '\<type>://\<container_id>'.
|
||||
|
||||
- **initContainerStatuses.state** (ContainerState)
|
||||
|
||||
|
|
@ -1991,7 +1936,7 @@ PodStatus represents information about the status of a pod. Status may trail the
|
|||
|
||||
- **initContainerStatuses.state.terminated.containerID** (string)
|
||||
|
||||
Container's ID in the format 'docker://\<container_id>'
|
||||
Container's ID in the format '\<type>://\<container_id>'
|
||||
|
||||
- **initContainerStatuses.state.terminated.exitCode** (int32), required
|
||||
|
||||
|
|
@ -2068,7 +2013,7 @@ PodStatus represents information about the status of a pod. Status may trail the
|
|||
|
||||
- **initContainerStatuses.lastState.terminated.containerID** (string)
|
||||
|
||||
Container's ID in the format 'docker://\<container_id>'
|
||||
Container's ID in the format '\<type>://\<container_id>'
|
||||
|
||||
- **initContainerStatuses.lastState.terminated.exitCode** (int32), required
|
||||
|
||||
|
|
@ -2129,7 +2074,7 @@ PodStatus represents information about the status of a pod. Status may trail the
|
|||
|
||||
- **containerStatuses** ([]ContainerStatus)
|
||||
|
||||
The list has one entry per container in the manifest. Each entry is currently the output of `docker inspect`. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status
|
||||
The list has one entry per container in the manifest. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status
|
||||
|
||||
<a name="ContainerStatus"></a>
|
||||
*ContainerStatus contains details for the current status of this container.*
|
||||
|
|
@ -2148,7 +2093,7 @@ PodStatus represents information about the status of a pod. Status may trail the
|
|||
|
||||
- **containerStatuses.containerID** (string)
|
||||
|
||||
Container's ID in the format 'docker://\<container_id>'.
|
||||
Container's ID in the format '\<type>://\<container_id>'.
|
||||
|
||||
- **containerStatuses.state** (ContainerState)
|
||||
|
||||
|
|
@ -2180,7 +2125,7 @@ PodStatus represents information about the status of a pod. Status may trail the
|
|||
|
||||
- **containerStatuses.state.terminated.containerID** (string)
|
||||
|
||||
Container's ID in the format 'docker://\<container_id>'
|
||||
Container's ID in the format '\<type>://\<container_id>'
|
||||
|
||||
- **containerStatuses.state.terminated.exitCode** (int32), required
|
||||
|
||||
|
|
@ -2257,7 +2202,7 @@ PodStatus represents information about the status of a pod. Status may trail the
|
|||
|
||||
- **containerStatuses.lastState.terminated.containerID** (string)
|
||||
|
||||
Container's ID in the format 'docker://\<container_id>'
|
||||
Container's ID in the format '\<type>://\<container_id>'
|
||||
|
||||
- **containerStatuses.lastState.terminated.exitCode** (int32), required
|
||||
|
||||
|
|
@ -2337,7 +2282,7 @@ PodStatus represents information about the status of a pod. Status may trail the
|
|||
|
||||
- **ephemeralContainerStatuses.containerID** (string)
|
||||
|
||||
Container's ID in the format 'docker://\<container_id>'.
|
||||
Container's ID in the format '\<type>://\<container_id>'.
|
||||
|
||||
- **ephemeralContainerStatuses.state** (ContainerState)
|
||||
|
||||
|
|
@ -2369,7 +2314,7 @@ PodStatus represents information about the status of a pod. Status may trail the
|
|||
|
||||
- **ephemeralContainerStatuses.state.terminated.containerID** (string)
|
||||
|
||||
Container's ID in the format 'docker://\<container_id>'
|
||||
Container's ID in the format '\<type>://\<container_id>'
|
||||
|
||||
- **ephemeralContainerStatuses.state.terminated.exitCode** (int32), required
|
||||
|
||||
|
|
@ -2446,7 +2391,7 @@ PodStatus represents information about the status of a pod. Status may trail the
|
|||
|
||||
- **ephemeralContainerStatuses.lastState.terminated.containerID** (string)
|
||||
|
||||
Container's ID in the format 'docker://\<container_id>'
|
||||
Container's ID in the format '\<type>://\<container_id>'
|
||||
|
||||
- **ephemeralContainerStatuses.lastState.terminated.exitCode** (int32), required
|
||||
|
||||
|
|
|
|||
|
|
@ -56,7 +56,7 @@ PriorityClass defines mapping from a priority class name to the priority integer
|
|||
|
||||
- **preemptionPolicy** (string)
|
||||
|
||||
PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is beta-level, gated by the NonPreemptingPriority feature-gate.
|
||||
PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset.
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -90,9 +90,7 @@ A StatefulSetSpec is the specification of a StatefulSet.
|
|||
|
||||
Type indicates the type of the StatefulSetUpdateStrategy. Default is RollingUpdate.
|
||||
|
||||
Possible enum values:
|
||||
- `"OnDelete"` triggers the legacy behavior. Version tracking and ordered rolling restarts are disabled. Pods are recreated from the StatefulSetSpec when they are manually deleted. When a scale operation is performed with this strategy,specification version indicated by the StatefulSet's currentRevision.
|
||||
- `"RollingUpdate"` indicates that update will be applied to all Pods in the StatefulSet with respect to the StatefulSet ordering constraints. When a scale operation is performed with this strategy, new Pods will be created from the specification version indicated by the StatefulSet's updateRevision.
|
||||
|
||||
|
||||
- **updateStrategy.rollingUpdate** (RollingUpdateStatefulSetStrategy)
|
||||
|
||||
|
|
@ -101,17 +99,22 @@ A StatefulSetSpec is the specification of a StatefulSet.
|
|||
<a name="RollingUpdateStatefulSetStrategy"></a>
|
||||
*RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType.*
|
||||
|
||||
- **updateStrategy.rollingUpdate.maxUnavailable** (IntOrString)
|
||||
|
||||
The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding up. This can not be 0. Defaults to 1. This field is alpha-level and is only honored by servers that enable the MaxUnavailableStatefulSet feature. The field applies to all pods in the range 0 to Replicas-1. That means if there is any unavailable pod in the range 0 to Replicas-1, it will be counted towards MaxUnavailable.
|
||||
|
||||
<a name="IntOrString"></a>
|
||||
*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.*
|
||||
|
||||
- **updateStrategy.rollingUpdate.partition** (int32)
|
||||
|
||||
Partition indicates the ordinal at which the StatefulSet should be partitioned. Default value is 0.
|
||||
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.
|
||||
|
||||
- **podManagementPolicy** (string)
|
||||
|
||||
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.
|
||||
|
||||
Possible enum values:
|
||||
- `"OrderedReady"` will create pods in strictly increasing order on scale up and strictly decreasing order on scale down, progressing only when the previous pod is ready or terminated. At most one pod will be changed at any time.
|
||||
- `"Parallel"` will create and delete pods as soon as the stateful set replica count is changed, and will not wait for pods to be ready or complete termination.
|
||||
|
||||
|
||||
- **revisionHistoryLimit** (int32)
|
||||
|
||||
|
|
@ -166,7 +169,7 @@ StatefulSetStatus represents the current state of a StatefulSet.
|
|||
|
||||
updatedReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by updateRevision.
|
||||
|
||||
- **availableReplicas** (int32), required
|
||||
- **availableReplicas** (int32)
|
||||
|
||||
Total number of available pods (ready for at least minReadySeconds) targeted by this statefulset. This is a beta field and enabled/disabled by StatefulSetMinReadySeconds feature gate.
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue