VolumeAttachment captures the intent to attach or detach the specified volume to/from the specified node.
VolumeAttachment objects are non-namespaced.
new()
Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
mixinInstance(metadata)
withAnnotations(annotations)
Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations
withAnnotationsMixin(annotations)
Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations
withClusterName(clusterName)
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.
withFinalizers(finalizers)
Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.
withFinalizersMixin(finalizers)
Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.
withGenerateName(generateName)
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).
Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency
withLabels(labels)
Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
withLabelsMixin(labels)
Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
withManagedFields(managedFields)
ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn’t need to set or understand this field. A workflow can be the user’s name, a controller’s name, or the name of a specific apply path like “ci-cd”. The set of fields is always in the version that the workflow used when modifying the object.
This field is alpha and can be changed or removed without notice.
withManagedFields takes an array of type managedFieldsType. You can create
an instance of managedFieldsType with hidden.meta.v1.managedFieldsEntry.new().
see hidden.meta.v1.managedFieldsEntry
withManagedFieldsMixin(managedFields)
ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn’t need to set or understand this field. A workflow can be the user’s name, a controller’s name, or the name of a specific apply path like “ci-cd”. The set of fields is always in the version that the workflow used when modifying the object.
This field is alpha and can be changed or removed without notice.
withManagedFieldsMixin takes an array of type managedFieldsType. You can create
an instance of managedFieldsType with hidden.meta.v1.managedFieldsEntry.new().
see hidden.meta.v1.managedFieldsEntry
withName(name)
Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names
withNamespace(namespace)
Namespace defines the space within each name must be unique. An empty namespace is equivalent to the “default” namespace, but “default” is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.
Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces
withOwnerReferences(ownerReferences)
List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
withOwnerReferences takes an array of type ownerReferencesType. You can create
an instance of ownerReferencesType with hidden.meta.v1.ownerReference.new().
see hidden.meta.v1.ownerReference
withOwnerReferencesMixin(ownerReferences)
List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
withOwnerReferencesMixin takes an array of type ownerReferencesType. You can create
an instance of ownerReferencesType with hidden.meta.v1.ownerReference.new().
see hidden.meta.v1.ownerReference
An initializer is a controller which enforces some system invariant at object creation time. This field is a list of initializers that have not yet acted on this object. If nil or empty, this object has been completely initialized. Otherwise, the object is considered uninitialized and is hidden (in list/watch and get calls) from clients that haven't explicitly asked to observe uninitialized objects.
When an object is created, the system will populate this list with the current set of initializers. Only privileged users may set or modify this list. Once it is empty, it may not be modified further by any user.
DEPRECATED - initializers are an alpha field and will be removed in v1.15.
mixinInstance(initializers)
withPending(pending)
Pending is a list of initializers that must execute in order before this object is visible. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients.
withPending takes an array of type pendingType. You can create
an instance of pendingType with hidden.meta.v1.initializer.new().
see hidden.meta.v1.initializer
withPendingMixin(pending)
Pending is a list of initializers that must execute in order before this object is visible. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients.
withPendingMixin takes an array of type pendingType. You can create
an instance of pendingType with hidden.meta.v1.initializer.new().
see hidden.meta.v1.initializer
Specification of the desired attach/detach volume behavior. Populated by the Kubernetes system.
mixinInstance(spec)
withAttacher(attacher)
Attacher indicates the name of the volume driver that MUST handle this request. This is the name returned by GetPluginName().
withNodeName(nodeName)
The node that the volume should be attached to.
Source represents the volume that should be attached.
mixinInstance(source)
withPersistentVolumeName(persistentVolumeName)
Name of the persistent volume to attach.
inlineVolumeSpec contains all the information necessary to attach a persistent volume defined by a pod's inline VolumeSource. This field is populated only for the CSIMigration feature. It contains translated fields from a pod's inline VolumeSource to a PersistentVolumeSpec. This field is alpha-level and is only honored by servers that enabled the CSIMigration feature.
mixinInstance(inlineVolumeSpec)
withAccessModes(accessModes)
AccessModes contains all ways the volume can be mounted. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes
withAccessModesMixin(accessModes)
AccessModes contains all ways the volume can be mounted. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes
withCapacity(capacity)
A description of the persistent volume’s resources and capacity. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity
withCapacityMixin(capacity)
A description of the persistent volume’s resources and capacity. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity
withMountOptions(mountOptions)
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
withMountOptionsMixin(mountOptions)
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
withPersistentVolumeReclaimPolicy(persistentVolumeReclaimPolicy)
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
withStorageClassName(storageClassName)
Name of StorageClass to which this persistent volume belongs. Empty value means that this volume does not belong to any StorageClass.
withVolumeMode(volumeMode)
volumeMode defines if a volume is intended to be used with a formatted filesystem or to remain in raw block state. Value of Filesystem is implied when not included in spec. This is a beta feature.
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
mixinInstance(awsElasticBlockStore)
withFsType(fsType)
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
withPartition(partition)
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).
withReadOnly(readOnly)
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
withVolumeId(volumeId)
Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
mixinInstance(azureDisk)
withCachingMode(cachingMode)
Host Caching mode: None, Read Only, Read Write.
withDiskName(diskName)
The Name of the data disk in the blob storage
withDiskUri(diskUri)
The URI the data disk in the blob storage
withFsType(fsType)
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.
withReadOnly(readOnly)
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
mixinInstance(azureFile)
withReadOnly(readOnly)
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
withSecretName(secretName)
the name of secret that contains Azure Storage Account Name and Key
withSecretNamespace(secretNamespace)
the namespace of the secret that contains Azure Storage Account Name and Key default is the same as the Pod
CephFS represents a Ceph FS mount on the host that shares a pod's lifetime
mixinInstance(cephfs)
withMonitors(monitors)
Required: Monitors is a collection of Ceph monitors More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it
withMonitorsMixin(monitors)
Required: Monitors is a collection of Ceph monitors More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it
withPath(path)
Optional: Used as the mounted root, rather than the full Ceph tree, default is /
withReadOnly(readOnly)
Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it
withSecretFile(secretFile)
Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it
withUser(user)
Optional: User is the rados user name, default is admin More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it
Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it
mixinInstance(secretRef)
withName(name)
Name is unique within a namespace to reference a secret resource.
withNamespace(namespace)
Namespace defines the space within which the secret name must be unique.
Cinder represents a cinder volume attached and mounted on kubelets host machine More info: https://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md
mixinInstance(cinder)
withFsType(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://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md
withReadOnly(readOnly)
Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md
withVolumeId(volumeId)
volume id used to identify the volume in cinder More info: https://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md
Optional: points to a secret object containing parameters used to connect to OpenStack.
mixinInstance(secretRef)
withName(name)
Name is unique within a namespace to reference a secret resource.
withNamespace(namespace)
Namespace defines the space within which the secret name must be unique.
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
mixinInstance(claimRef)
withFieldPath(fieldPath)
If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: “spec.containers{name}” (where “name” refers to the name of the container that triggered the event) or if no container name is specified “spec.containers[2]” (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.
withName(name)
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
withNamespace(namespace)
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
withResourceVersion(resourceVersion)
Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
withUid(uid)
UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
CSI represents storage that is handled by an external CSI driver (Beta feature).
mixinInstance(csi)
withDriver(driver)
Driver is the name of the driver to use for this volume. Required.
withFsType(fsType)
Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. “ext4”, “xfs”, “ntfs”.
withReadOnly(readOnly)
Optional: The value to pass to ControllerPublishVolumeRequest. Defaults to false (read/write).
withVolumeAttributes(volumeAttributes)
Attributes of the volume to publish.
withVolumeAttributesMixin(volumeAttributes)
Attributes of the volume to publish.
withVolumeHandle(volumeHandle)
VolumeHandle is the unique volume name returned by the CSI volume plugin’s CreateVolume to refer to the volume on all subsequent calls. Required.
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.
mixinInstance(controllerExpandSecretRef)
withName(name)
Name is unique within a namespace to reference a secret resource.
withNamespace(namespace)
Namespace defines the space within which the secret name must be unique.
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.
mixinInstance(controllerPublishSecretRef)
withName(name)
Name is unique within a namespace to reference a secret resource.
withNamespace(namespace)
Namespace defines the space within which the secret name must be unique.
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.
mixinInstance(nodePublishSecretRef)
withName(name)
Name is unique within a namespace to reference a secret resource.
withNamespace(namespace)
Namespace defines the space within which the secret name must be unique.
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.
mixinInstance(nodeStageSecretRef)
withName(name)
Name is unique within a namespace to reference a secret resource.
withNamespace(namespace)
Namespace defines the space within which the secret name must be unique.
FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
mixinInstance(fc)
withFsType(fsType)
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.
withLun(lun)
Optional: FC target lun number
withReadOnly(readOnly)
Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
withTargetWwns(targetWwns)
Optional: FC target worldwide names (WWNs)
withTargetWwnsMixin(targetWwns)
Optional: FC target worldwide names (WWNs)
withWwids(wwids)
Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.
withWwidsMixin(wwids)
Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.
FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.
mixinInstance(flexVolume)
withDriver(driver)
Driver is the name of the driver to use for this volume.
withFsType(fsType)
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.
withOptions(options)
Optional: Extra command options if any.
withOptionsMixin(options)
Optional: Extra command options if any.
withReadOnly(readOnly)
Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
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.
mixinInstance(secretRef)
withName(name)
Name is unique within a namespace to reference a secret resource.
withNamespace(namespace)
Namespace defines the space within which the secret name must be unique.
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
mixinInstance(flocker)
withDatasetName(datasetName)
Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated
withDatasetUuid(datasetUuid)
UUID of the dataset. This is unique identifier of a Flocker dataset
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
mixinInstance(gcePersistentDisk)
withFsType(fsType)
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
withPartition(partition)
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
withPdName(pdName)
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
withReadOnly(readOnly)
ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
Glusterfs represents a Glusterfs volume that is attached to a host and exposed to the pod. Provisioned by an admin. More info: https://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md
mixinInstance(glusterfs)
withEndpoints(endpoints)
EndpointsName is the endpoint name that details Glusterfs topology. More info: https://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod
withEndpointsNamespace(endpointsNamespace)
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://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod
withPath(path)
Path is the Glusterfs volume path. More info: https://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod
withReadOnly(readOnly)
ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod
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
mixinInstance(hostPath)
withPath(path)
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
withType(type)
Type for HostPath Volume Defaults to “” More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
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.
mixinInstance(iscsi)
withChapAuthDiscovery(chapAuthDiscovery)
whether support iSCSI Discovery CHAP authentication
withChapAuthSession(chapAuthSession)
whether support iSCSI Session CHAP authentication
withFsType(fsType)
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
withInitiatorName(initiatorName)
Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface
withIqn(iqn)
Target iSCSI Qualified Name.
withIscsiInterface(iscsiInterface)
iSCSI Interface Name that uses an iSCSI transport. Defaults to ‘default’ (tcp).
withLun(lun)
iSCSI Target Lun number.
withPortals(portals)
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).
withPortalsMixin(portals)
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).
withReadOnly(readOnly)
ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
withTargetPortal(targetPortal)
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).
CHAP Secret for iSCSI target and initiator authentication
mixinInstance(secretRef)
withName(name)
Name is unique within a namespace to reference a secret resource.
withNamespace(namespace)
Namespace defines the space within which the secret name must be unique.
Local represents directly-attached storage with node affinity
mixinInstance(localStorage)
withFsType(fsType)
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 fileystem if unspecified.
withPath(path)
The full path to the volume on the node. It can be either a directory or block device (disk, partition, …).
NFS represents an NFS mount on the host. Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
mixinInstance(nfs)
withPath(path)
Path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
withReadOnly(readOnly)
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
withServer(server)
Server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
NodeAffinity defines constraints that limit what nodes this volume can be accessed from. This field influences the scheduling of pods that use this volume.
mixinInstance(nodeAffinity)
Required specifies hard node constraints that must be met.
mixinInstance(required)
withNodeSelectorTerms(nodeSelectorTerms)
Required. A list of node selector terms. The terms are ORed.
withNodeSelectorTerms takes an array of type nodeSelectorTermsType. You can create
an instance of nodeSelectorTermsType with hidden.core.v1.nodeSelectorTerm.new().
see hidden.core.v1.nodeSelectorTerm
withNodeSelectorTermsMixin(nodeSelectorTerms)
Required. A list of node selector terms. The terms are ORed.
withNodeSelectorTermsMixin takes an array of type nodeSelectorTermsType. You can create
an instance of nodeSelectorTermsType with hidden.core.v1.nodeSelectorTerm.new().
see hidden.core.v1.nodeSelectorTerm
PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
mixinInstance(photonPersistentDisk)
withFsType(fsType)
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.
withPdId(pdId)
ID that identifies Photon Controller persistent disk
PortworxVolume represents a portworx volume attached and mounted on kubelets host machine
mixinInstance(portworxVolume)
withFsType(fsType)
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.
withReadOnly(readOnly)
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
withVolumeId(volumeId)
VolumeID uniquely identifies a Portworx volume
Quobyte represents a Quobyte mount on the host that shares a pod's lifetime
mixinInstance(quobyte)
withGroup(group)
Group to map volume access to Default is no group
withReadOnly(readOnly)
ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.
withRegistry(registry)
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
withTenant(tenant)
Tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin
withUser(user)
User to map volume access to Defaults to serivceaccount user
withVolume(volume)
Volume is a string that references an already created Quobyte volume by name.
RBD represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md
mixinInstance(rbd)
withFsType(fsType)
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
withImage(image)
The rados image name. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it
withKeyring(keyring)
Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it
withMonitors(monitors)
A collection of Ceph monitors. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it
withMonitorsMixin(monitors)
A collection of Ceph monitors. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it
withPool(pool)
The rados pool name. Default is rbd. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it
withReadOnly(readOnly)
ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it
withUser(user)
The rados user name. Default is admin. More info: https://releases.k8s.io/HEAD/examples/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://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it
mixinInstance(secretRef)
withName(name)
Name is unique within a namespace to reference a secret resource.
withNamespace(namespace)
Namespace defines the space within which the secret name must be unique.
ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
mixinInstance(scaleIo)
withFsType(fsType)
Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. “ext4”, “xfs”, “ntfs”. Default is “xfs”
withGateway(gateway)
The host address of the ScaleIO API Gateway.
withProtectionDomain(protectionDomain)
The name of the ScaleIO Protection Domain for the configured storage.
withReadOnly(readOnly)
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
withSslEnabled(sslEnabled)
Flag to enable/disable SSL communication with Gateway, default false
withStorageMode(storageMode)
Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.
withStoragePool(storagePool)
The ScaleIO Storage Pool associated with the protection domain.
withSystem(system)
The name of the storage system as configured in ScaleIO.
withVolumeName(volumeName)
The name of a volume already created in the ScaleIO system that is associated with this volume source.
SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
mixinInstance(secretRef)
withName(name)
Name is unique within a namespace to reference a secret resource.
withNamespace(namespace)
Namespace defines the space within which the secret name must be unique.
StorageOS represents a StorageOS volume that is attached to the kubelet's host machine and mounted into the pod More info: https://releases.k8s.io/HEAD/examples/volumes/storageos/README.md
mixinInstance(storageos)
withFsType(fsType)
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.
withReadOnly(readOnly)
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
withVolumeName(volumeName)
VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.
withVolumeNamespace(volumeNamespace)
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.
SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
mixinInstance(secretRef)
withFieldPath(fieldPath)
If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: “spec.containers{name}” (where “name” refers to the name of the container that triggered the event) or if no container name is specified “spec.containers[2]” (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.
withName(name)
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
withNamespace(namespace)
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
withResourceVersion(resourceVersion)
Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
withUid(uid)
UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine
mixinInstance(vsphereVolume)
withFsType(fsType)
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.
withStoragePolicyId(storagePolicyId)
Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
withStoragePolicyName(storagePolicyName)
Storage Policy Based Management (SPBM) profile name.
withVolumePath(volumePath)
Path that identifies vSphere volume vmdk