---
title: Getting Started with Datadog
description: Datadog, the leading service for cloud-scale monitoring.
breadcrumbs: Docs > Infrastructure > Datadog Resource Catalog
---

# gcp_k8s_persistent_volume{% #gcp_k8s_persistent_volume %}

## `ancestors`{% #ancestors %}

**Type**: `UNORDERED_LIST_STRING`

## `api_version`{% #api_version %}

**Type**: `STRING`**Provider name**: `apiVersion`**Description**: APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: [https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources](https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources)

## `gcp_status`{% #gcp_status %}

**Type**: `STRUCT`**Provider name**: `status`**Description**: 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](https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistent-volumes)

- `last_phase_transition_time`**Type**: `TIMESTAMP`**Provider name**: `lastPhaseTransitionTime`**Description**: lastPhaseTransitionTime is the time the phase transitioned from one to another and automatically resets to current time everytime a volume phase transitions.
- `message`**Type**: `STRING`**Provider name**: `message`**Description**: message is a human-readable message indicating details about why the volume is in this state.
- `phase`**Type**: `STRING`**Provider name**: `phase`**Description**: 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](https://kubernetes.io/docs/concepts/storage/persistent-volumes#phase)
- `reason`**Type**: `STRING`**Provider name**: `reason`**Description**: reason is a brief CamelCase string that describes any failure and is meant for machine parsing and tidy display in the CLI.

## `kind`{% #kind %}

**Type**: `STRING`**Provider name**: `kind`**Description**: Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: [https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds](https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds)

## `labels`{% #labels %}

**Type**: `UNORDERED_LIST_STRING`

## `metadata`{% #metadata %}

**Type**: `STRUCT`**Provider name**: `metadata`**Description**: Standard object's metadata. More info: [https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata](https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata)

- `annotations`**Type**: `MAP_STRING_STRING`**Provider name**: `annotations`**Description**: Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: [https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations)
- `creation_timestamp`**Type**: `TIMESTAMP`**Provider name**: `creationTimestamp`**Description**: CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.Populated by the system. Read-only. Null for lists. More info: [https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata](https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata)
- `deletion_grace_period_seconds`**Type**: `INT64`**Provider name**: `deletionGracePeriodSeconds`**Description**: Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.
- `deletion_timestamp`**Type**: `TIMESTAMP`**Provider name**: `deletionTimestamp`**Description**: DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.Populated by the system when a graceful deletion is requested. Read-only. More info: [https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata](https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata)
- `finalizers`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `finalizers`**Description**: Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.
- `generate_name`**Type**: `STRING`**Provider name**: `generateName`**Description**: GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.If this field is specified and the generated name exists, the server will return a 409.Applied only if Name is not specified. More info: [https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency](https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency)
- `generation`**Type**: `INT64`**Provider name**: `generation`**Description**: A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
- `managed_fields`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `managedFields`**Description**: ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.
  - `api_version`**Type**: `STRING`**Provider name**: `apiVersion`**Description**: APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.
  - `fields_type`**Type**: `STRING`**Provider name**: `fieldsType`**Description**: FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"
  - `manager`**Type**: `STRING`**Provider name**: `manager`**Description**: Manager is an identifier of the workflow managing these fields.
  - `operation`**Type**: `STRING`**Provider name**: `operation`**Description**: Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.
  - `subresource`**Type**: `STRING`**Provider name**: `subresource`**Description**: Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.
  - `time`**Type**: `TIMESTAMP`**Provider name**: `time`**Description**: 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.
- `name`**Type**: `STRING`**Provider name**: `name`**Description**: Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: [https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names](https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names)
- `namespace`**Type**: `STRING`**Provider name**: `namespace`**Description**: Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.Must be a DNS_LABEL. Cannot be updated. More info: [https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces)
- `owner_references`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `ownerReferences`**Description**: List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
  - `api_version`**Type**: `STRING`**Provider name**: `apiVersion`**Description**: API version of the referent.
  - `block_owner_deletion`**Type**: `BOOLEAN`**Provider name**: `blockOwnerDeletion`**Description**: If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See [https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion](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.
  - `controller`**Type**: `BOOLEAN`**Provider name**: `controller`**Description**: If true, this reference points to the managing controller.
  - `kind`**Type**: `STRING`**Provider name**: `kind`**Description**: Kind of the referent. More info: [https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds](https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds)
  - `name`**Type**: `STRING`**Provider name**: `name`**Description**: Name of the referent. More info: [https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names](https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names)
  - `uid`**Type**: `STRING`**Provider name**: `uid`**Description**: UID of the referent. More info: [https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids](https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids)
- `resource_version`**Type**: `STRING`**Provider name**: `resourceVersion`**Description**: An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: [https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency](https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency)
- `self_link`**Type**: `STRING`**Provider name**: `selfLink`**Description**: Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
- `uid`**Type**: `STRING`**Provider name**: `uid`**Description**: UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.Populated by the system. Read-only. More info: [https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids](https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids)

## `organization_id`{% #organization_id %}

**Type**: `STRING`

## `parent`{% #parent %}

**Type**: `STRING`

## `project_id`{% #project_id %}

**Type**: `STRING`

## `project_number`{% #project_number %}

**Type**: `STRING`

## `region_id`{% #region_id %}

**Type**: `STRING`

## `resource_name`{% #resource_name %}

**Type**: `STRING`

## `spec`{% #spec %}

**Type**: `STRUCT`**Provider name**: `spec`**Description**: 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](https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistent-volumes)

- `access_modes`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `accessModes`**Description**: accessModes contains all ways the volume can be mounted. More info: [https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes](https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes)
- `aws_elastic_block_store`**Type**: `STRUCT`**Provider name**: `awsElasticBlockStore`**Description**: awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Deprecated: AWSElasticBlockStore is deprecated. All operations for the in-tree awsElasticBlockStore type are redirected to the ebs.csi.aws.com CSI driver. More info: [https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore](https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore)
  - `fs_type`**Type**: `STRING`**Provider name**: `fsType`**Description**: fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: [https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore](https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore)
  - `partition`**Type**: `INT32`**Provider name**: `partition`**Description**: partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).
  - `read_only`**Type**: `BOOLEAN`**Provider name**: `readOnly`**Description**: readOnly value true will force the readOnly setting in VolumeMounts. More info: [https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore](https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore)
  - `volume_id`**Type**: `STRING`**Provider name**: `volumeID`**Description**: volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: [https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore](https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore)
- `azure_disk`**Type**: `STRUCT`**Provider name**: `azureDisk`**Description**: azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. Deprecated: AzureDisk is deprecated. All operations for the in-tree azureDisk type are redirected to the disk.csi.azure.com CSI driver.
  - `caching_mode`**Type**: `STRING`**Provider name**: `cachingMode`**Description**: cachingMode is the Host Caching mode: None, Read Only, Read Write.
  - `disk_name`**Type**: `STRING`**Provider name**: `diskName`**Description**: diskName is the Name of the data disk in the blob storage
  - `disk_uri`**Type**: `STRING`**Provider name**: `diskURI`**Description**: diskURI is the URI of data disk in the blob storage
  - `fs_type`**Type**: `STRING`**Provider name**: `fsType`**Description**: fsType is Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
  - `kind`**Type**: `STRING`**Provider name**: `kind`**Description**: kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared
  - `read_only`**Type**: `BOOLEAN`**Provider name**: `readOnly`**Description**: readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
- `azure_file`**Type**: `STRUCT`**Provider name**: `azureFile`**Description**: azureFile represents an Azure File Service mount on the host and bind mount to the pod. Deprecated: AzureFile is deprecated. All operations for the in-tree azureFile type are redirected to the file.csi.azure.com CSI driver.
  - `read_only`**Type**: `BOOLEAN`**Provider name**: `readOnly`**Description**: readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
  - `secret_name`**Type**: `STRING`**Provider name**: `secretName`**Description**: secretName is the name of secret that contains Azure Storage Account Name and Key
  - `secret_namespace`**Type**: `STRING`**Provider name**: `secretNamespace`**Description**: secretNamespace is the namespace of the secret that contains Azure Storage Account Name and Key default is the same as the Pod
  - `share_name`**Type**: `STRING`**Provider name**: `shareName`**Description**: shareName is the azure Share Name
- `cephfs`**Type**: `STRUCT`**Provider name**: `cephfs`**Description**: cephFS represents a Ceph FS mount on the host that shares a pod's lifetime. Deprecated: CephFS is deprecated and the in-tree cephfs type is no longer supported.
  - `monitors`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `monitors`**Description**: monitors is Required: Monitors is a collection of Ceph monitors More info: [https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it](https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it)
  - `path`**Type**: `STRING`**Provider name**: `path`**Description**: path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /
  - `read_only`**Type**: `BOOLEAN`**Provider name**: `readOnly`**Description**: readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: [https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it](https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it)
  - `secret_file`**Type**: `STRING`**Provider name**: `secretFile`**Description**: secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: [https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it](https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it)
  - `secret_ref`**Type**: `STRUCT`**Provider name**: `secretRef`**Description**: 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](https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it)
    - `name`**Type**: `STRING`**Provider name**: `name`**Description**: name is unique within a namespace to reference a secret resource.
    - `namespace`**Type**: `STRING`**Provider name**: `namespace`**Description**: namespace defines the space within which the secret name must be unique.
  - `user`**Type**: `STRING`**Provider name**: `user`**Description**: user is Optional: User is the rados user name, default is admin More info: [https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it](https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it)
- `cinder`**Type**: `STRUCT`**Provider name**: `cinder`**Description**: cinder represents a cinder volume attached and mounted on kubelets host machine. Deprecated: Cinder is deprecated. All operations for the in-tree cinder type are redirected to the cinder.csi.openstack.org CSI driver. More info: [https://examples.k8s.io/mysql-cinder-pd/README.md](https://examples.k8s.io/mysql-cinder-pd/README.md)
  - `fs_type`**Type**: `STRING`**Provider name**: `fsType`**Description**: 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](https://examples.k8s.io/mysql-cinder-pd/README.md)
  - `read_only`**Type**: `BOOLEAN`**Provider name**: `readOnly`**Description**: 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](https://examples.k8s.io/mysql-cinder-pd/README.md)
  - `secret_ref`**Type**: `STRUCT`**Provider name**: `secretRef`**Description**: secretRef is Optional: points to a secret object containing parameters used to connect to OpenStack.
    - `name`**Type**: `STRING`**Provider name**: `name`**Description**: name is unique within a namespace to reference a secret resource.
    - `namespace`**Type**: `STRING`**Provider name**: `namespace`**Description**: namespace defines the space within which the secret name must be unique.
  - `volume_id`**Type**: `STRING`**Provider name**: `volumeID`**Description**: volumeID used to identify the volume in cinder. More info: [https://examples.k8s.io/mysql-cinder-pd/README.md](https://examples.k8s.io/mysql-cinder-pd/README.md)
- `claim_ref`**Type**: `STRUCT`**Provider name**: `claimRef`**Description**: 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](https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding)
  - `api_version`**Type**: `STRING`**Provider name**: `apiVersion`**Description**: API version of the referent.
  - `field_path`**Type**: `STRING`**Provider name**: `fieldPath`**Description**: 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.
  - `kind`**Type**: `STRING`**Provider name**: `kind`**Description**: Kind of the referent. More info: [https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds](https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds)
  - `name`**Type**: `STRING`**Provider name**: `name`**Description**: Name of the referent. More info: [https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names)
  - `namespace`**Type**: `STRING`**Provider name**: `namespace`**Description**: Namespace of the referent. More info: [https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/)
  - `resource_version`**Type**: `STRING`**Provider name**: `resourceVersion`**Description**: Specific resourceVersion to which this reference is made, if any. More info: [https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency](https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency)
  - `uid`**Type**: `STRING`**Provider name**: `uid`**Description**: UID of the referent. More info: [https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids)
- `csi`**Type**: `STRUCT`**Provider name**: `csi`**Description**: csi represents storage that is handled by an external CSI driver.
  - `controller_expand_secret_ref`**Type**: `STRUCT`**Provider name**: `controllerExpandSecretRef`**Description**: controllerExpandSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerExpandVolume call. 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.
    - `name`**Type**: `STRING`**Provider name**: `name`**Description**: name is unique within a namespace to reference a secret resource.
    - `namespace`**Type**: `STRING`**Provider name**: `namespace`**Description**: namespace defines the space within which the secret name must be unique.
  - `controller_publish_secret_ref`**Type**: `STRUCT`**Provider name**: `controllerPublishSecretRef`**Description**: 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.
    - `name`**Type**: `STRING`**Provider name**: `name`**Description**: name is unique within a namespace to reference a secret resource.
    - `namespace`**Type**: `STRING`**Provider name**: `namespace`**Description**: namespace defines the space within which the secret name must be unique.
  - `driver`**Type**: `STRING`**Provider name**: `driver`**Description**: driver is the name of the driver to use for this volume. Required.
  - `fs_type`**Type**: `STRING`**Provider name**: `fsType`**Description**: fsType to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs".
  - `node_expand_secret_ref`**Type**: `STRUCT`**Provider name**: `nodeExpandSecretRef`**Description**: nodeExpandSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodeExpandVolume call. This field is optional, may be omitted if no secret is required. If the secret object contains more than one secret, all secrets are passed.
    - `name`**Type**: `STRING`**Provider name**: `name`**Description**: name is unique within a namespace to reference a secret resource.
    - `namespace`**Type**: `STRING`**Provider name**: `namespace`**Description**: namespace defines the space within which the secret name must be unique.
  - `node_publish_secret_ref`**Type**: `STRUCT`**Provider name**: `nodePublishSecretRef`**Description**: 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.
    - `name`**Type**: `STRING`**Provider name**: `name`**Description**: name is unique within a namespace to reference a secret resource.
    - `namespace`**Type**: `STRING`**Provider name**: `namespace`**Description**: namespace defines the space within which the secret name must be unique.
  - `node_stage_secret_ref`**Type**: `STRUCT`**Provider name**: `nodeStageSecretRef`**Description**: 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.
    - `name`**Type**: `STRING`**Provider name**: `name`**Description**: name is unique within a namespace to reference a secret resource.
    - `namespace`**Type**: `STRING`**Provider name**: `namespace`**Description**: namespace defines the space within which the secret name must be unique.
  - `read_only`**Type**: `BOOLEAN`**Provider name**: `readOnly`**Description**: readOnly value to pass to ControllerPublishVolumeRequest. Defaults to false (read/write).
  - `volume_handle`**Type**: `STRING`**Provider name**: `volumeHandle`**Description**: volumeHandle is the unique volume name returned by the CSI volume plugin's CreateVolume to refer to the volume on all subsequent calls. Required.
- `fc`**Type**: `STRUCT`**Provider name**: `fc`**Description**: fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
  - `fs_type`**Type**: `STRING`**Provider name**: `fsType`**Description**: fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
  - `lun`**Type**: `INT32`**Provider name**: `lun`**Description**: lun is Optional: FC target lun number
  - `read_only`**Type**: `BOOLEAN`**Provider name**: `readOnly`**Description**: readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
  - `target_ww_ns`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `targetWWNs`**Description**: targetWWNs is Optional: FC target worldwide names (WWNs)
  - `wwids`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `wwids`**Description**: wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.
- `flex_volume`**Type**: `STRUCT`**Provider name**: `flexVolume`**Description**: flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. Deprecated: FlexVolume is deprecated. Consider using a CSIDriver instead.
  - `driver`**Type**: `STRING`**Provider name**: `driver`**Description**: driver is the name of the driver to use for this volume.
  - `fs_type`**Type**: `STRING`**Provider name**: `fsType`**Description**: fsType is the Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.
  - `read_only`**Type**: `BOOLEAN`**Provider name**: `readOnly`**Description**: readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
  - `secret_ref`**Type**: `STRUCT`**Provider name**: `secretRef`**Description**: 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.
    - `name`**Type**: `STRING`**Provider name**: `name`**Description**: name is unique within a namespace to reference a secret resource.
    - `namespace`**Type**: `STRING`**Provider name**: `namespace`**Description**: namespace defines the space within which the secret name must be unique.
- `flocker`**Type**: `STRUCT`**Provider name**: `flocker`**Description**: 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. Deprecated: Flocker is deprecated and the in-tree flocker type is no longer supported.
  - `dataset_name`**Type**: `STRING`**Provider name**: `datasetName`**Description**: datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated
  - `dataset_uuid`**Type**: `STRING`**Provider name**: `datasetUUID`**Description**: datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset
- `gce_persistent_disk`**Type**: `STRUCT`**Provider name**: `gcePersistentDisk`**Description**: 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. Deprecated: GCEPersistentDisk is deprecated. All operations for the in-tree gcePersistentDisk type are redirected to the pd.csi.storage.gke.io CSI driver. More info: [https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk](https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk)
  - `fs_type`**Type**: `STRING`**Provider name**: `fsType`**Description**: fsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: [https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk](https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk)
  - `partition`**Type**: `INT32`**Provider name**: `partition`**Description**: partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: [https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk](https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk)
  - `pd_name`**Type**: `STRING`**Provider name**: `pdName`**Description**: pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: [https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk](https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk)
  - `read_only`**Type**: `BOOLEAN`**Provider name**: `readOnly`**Description**: readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: [https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk](https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk)
- `glusterfs`**Type**: `STRUCT`**Provider name**: `glusterfs`**Description**: glusterfs represents a Glusterfs volume that is attached to a host and exposed to the pod. Provisioned by an admin. Deprecated: Glusterfs is deprecated and the in-tree glusterfs type is no longer supported. More info: [https://examples.k8s.io/volumes/glusterfs/README.md](https://examples.k8s.io/volumes/glusterfs/README.md)
  - `endpoints`**Type**: `STRING`**Provider name**: `endpoints`**Description**: endpoints is the endpoint name that details Glusterfs topology. More info: [https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod](https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod)
  - `endpoints_namespace`**Type**: `STRING`**Provider name**: `endpointsNamespace`**Description**: 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](https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod)
  - `path`**Type**: `STRING`**Provider name**: `path`**Description**: path is the Glusterfs volume path. More info: [https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod](https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod)
  - `read_only`**Type**: `BOOLEAN`**Provider name**: `readOnly`**Description**: readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: [https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod](https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod)
- `host_path`**Type**: `STRUCT`**Provider name**: `hostPath`**Description**: 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](https://kubernetes.io/docs/concepts/storage/volumes#hostpath)
  - `path`**Type**: `STRING`**Provider name**: `path`**Description**: path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: [https://kubernetes.io/docs/concepts/storage/volumes#hostpath](https://kubernetes.io/docs/concepts/storage/volumes#hostpath)
  - `type`**Type**: `STRING`**Provider name**: `type`**Description**: type for HostPath Volume Defaults to "" More info: [https://kubernetes.io/docs/concepts/storage/volumes#hostpath](https://kubernetes.io/docs/concepts/storage/volumes#hostpath)
- `iscsi`**Type**: `STRUCT`**Provider name**: `iscsi`**Description**: 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.
  - `chap_auth_discovery`**Type**: `BOOLEAN`**Provider name**: `chapAuthDiscovery`**Description**: chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication
  - `chap_auth_session`**Type**: `BOOLEAN`**Provider name**: `chapAuthSession`**Description**: chapAuthSession defines whether support iSCSI Session CHAP authentication
  - `fs_type`**Type**: `STRING`**Provider name**: `fsType`**Description**: fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: [https://kubernetes.io/docs/concepts/storage/volumes#iscsi](https://kubernetes.io/docs/concepts/storage/volumes#iscsi)
  - `initiator_name`**Type**: `STRING`**Provider name**: `initiatorName`**Description**: initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface:will be created for the connection.
  - `iqn`**Type**: `STRING`**Provider name**: `iqn`**Description**: iqn is Target iSCSI Qualified Name.
  - `iscsi_interface`**Type**: `STRING`**Provider name**: `iscsiInterface`**Description**: iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).
  - `lun`**Type**: `INT32`**Provider name**: `lun`**Description**: lun is iSCSI Target Lun number.
  - `portals`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `portals`**Description**: portals is the iSCSI Target Portal List. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
  - `read_only`**Type**: `BOOLEAN`**Provider name**: `readOnly`**Description**: readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
  - `secret_ref`**Type**: `STRUCT`**Provider name**: `secretRef`**Description**: secretRef is the CHAP Secret for iSCSI target and initiator authentication
    - `name`**Type**: `STRING`**Provider name**: `name`**Description**: name is unique within a namespace to reference a secret resource.
    - `namespace`**Type**: `STRING`**Provider name**: `namespace`**Description**: namespace defines the space within which the secret name must be unique.
  - `target_portal`**Type**: `STRING`**Provider name**: `targetPortal`**Description**: targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
- `local`**Type**: `STRUCT`**Provider name**: `local`**Description**: local represents directly-attached storage with node affinity
  - `fs_type`**Type**: `STRING`**Provider name**: `fsType`**Description**: 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.
  - `path`**Type**: `STRING`**Provider name**: `path`**Description**: path of the full path to the volume on the node. It can be either a directory or block device (disk, partition, …).
- `mount_options`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `mountOptions`**Description**: 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](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options)
- `nfs`**Type**: `STRUCT`**Provider name**: `nfs`**Description**: nfs represents an NFS mount on the host. Provisioned by an admin. More info: [https://kubernetes.io/docs/concepts/storage/volumes#nfs](https://kubernetes.io/docs/concepts/storage/volumes#nfs)
  - `path`**Type**: `STRING`**Provider name**: `path`**Description**: path that is exported by the NFS server. More info: [https://kubernetes.io/docs/concepts/storage/volumes#nfs](https://kubernetes.io/docs/concepts/storage/volumes#nfs)
  - `read_only`**Type**: `BOOLEAN`**Provider name**: `readOnly`**Description**: readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: [https://kubernetes.io/docs/concepts/storage/volumes#nfs](https://kubernetes.io/docs/concepts/storage/volumes#nfs)
  - `server`**Type**: `STRING`**Provider name**: `server`**Description**: server is the hostname or IP address of the NFS server. More info: [https://kubernetes.io/docs/concepts/storage/volumes#nfs](https://kubernetes.io/docs/concepts/storage/volumes#nfs)
- `node_affinity`**Type**: `STRUCT`**Provider name**: `nodeAffinity`**Description**: nodeAffinity defines constraints that limit what nodes this volume can be accessed from. This field influences the scheduling of pods that use this volume.
  - `required`**Type**: `STRUCT`**Provider name**: `required`**Description**: required specifies hard node constraints that must be met.
    - `node_selector_terms`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `nodeSelectorTerms`**Description**: Required. A list of node selector terms. The terms are ORed.
      - `match_expressions`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `matchExpressions`**Description**: A list of node selector requirements by node's labels.
        - `key`**Type**: `STRING`**Provider name**: `key`**Description**: The label key that the selector applies to.
        - `operator`**Type**: `STRING`**Provider name**: `operator`**Description**: Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
        - `values`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `values`**Description**: An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
      - `match_fields`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `matchFields`**Description**: A list of node selector requirements by node's fields.
        - `key`**Type**: `STRING`**Provider name**: `key`**Description**: The label key that the selector applies to.
        - `operator`**Type**: `STRING`**Provider name**: `operator`**Description**: Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
        - `values`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `values`**Description**: An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
- `persistent_volume_reclaim_policy`**Type**: `STRING`**Provider name**: `persistentVolumeReclaimPolicy`**Description**: 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](https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming)
- `photon_persistent_disk`**Type**: `STRUCT`**Provider name**: `photonPersistentDisk`**Description**: photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine. Deprecated: PhotonPersistentDisk is deprecated and the in-tree photonPersistentDisk type is no longer supported.
  - `fs_type`**Type**: `STRING`**Provider name**: `fsType`**Description**: fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
  - `pd_id`**Type**: `STRING`**Provider name**: `pdID`**Description**: pdID is the ID that identifies Photon Controller persistent disk
- `portworx_volume`**Type**: `STRUCT`**Provider name**: `portworxVolume`**Description**: portworxVolume represents a portworx volume attached and mounted on kubelets host machine. Deprecated: PortworxVolume is deprecated. All operations for the in-tree portworxVolume type are redirected to the pxd.portworx.com CSI driver when the CSIMigrationPortworx feature-gate is on.
  - `fs_type`**Type**: `STRING`**Provider name**: `fsType`**Description**: fSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.
  - `read_only`**Type**: `BOOLEAN`**Provider name**: `readOnly`**Description**: readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
  - `volume_id`**Type**: `STRING`**Provider name**: `volumeID`**Description**: volumeID uniquely identifies a Portworx volume
- `quobyte`**Type**: `STRUCT`**Provider name**: `quobyte`**Description**: quobyte represents a Quobyte mount on the host that shares a pod's lifetime. Deprecated: Quobyte is deprecated and the in-tree quobyte type is no longer supported.
  - `group`**Type**: `STRING`**Provider name**: `group`**Description**: group to map volume access to Default is no group
  - `read_only`**Type**: `BOOLEAN`**Provider name**: `readOnly`**Description**: readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.
  - `registry`**Type**: `STRING`**Provider name**: `registry`**Description**: registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes
  - `tenant`**Type**: `STRING`**Provider name**: `tenant`**Description**: tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin
  - `user`**Type**: `STRING`**Provider name**: `user`**Description**: user to map volume access to Defaults to serivceaccount user
  - `volume`**Type**: `STRING`**Provider name**: `volume`**Description**: volume is a string that references an already created Quobyte volume by name.
- `rbd`**Type**: `STRUCT`**Provider name**: `rbd`**Description**: rbd represents a Rados Block Device mount on the host that shares a pod's lifetime. Deprecated: RBD is deprecated and the in-tree rbd type is no longer supported. More info: [https://examples.k8s.io/volumes/rbd/README.md](https://examples.k8s.io/volumes/rbd/README.md)
  - `fs_type`**Type**: `STRING`**Provider name**: `fsType`**Description**: fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: [https://kubernetes.io/docs/concepts/storage/volumes#rbd](https://kubernetes.io/docs/concepts/storage/volumes#rbd)
  - `image`**Type**: `STRING`**Provider name**: `image`**Description**: image is the rados image name. More info: [https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it](https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it)
  - `keyring`**Type**: `STRING`**Provider name**: `keyring`**Description**: keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: [https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it](https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it)
  - `monitors`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `monitors`**Description**: monitors is a collection of Ceph monitors. More info: [https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it](https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it)
  - `pool`**Type**: `STRING`**Provider name**: `pool`**Description**: pool is the rados pool name. Default is rbd. More info: [https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it](https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it)
  - `read_only`**Type**: `BOOLEAN`**Provider name**: `readOnly`**Description**: readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: [https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it](https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it)
  - `secret_ref`**Type**: `STRUCT`**Provider name**: `secretRef`**Description**: 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](https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it)
    - `name`**Type**: `STRING`**Provider name**: `name`**Description**: name is unique within a namespace to reference a secret resource.
    - `namespace`**Type**: `STRING`**Provider name**: `namespace`**Description**: namespace defines the space within which the secret name must be unique.
  - `user`**Type**: `STRING`**Provider name**: `user`**Description**: user is the rados user name. Default is admin. More info: [https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it](https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it)
- `scale_io`**Type**: `STRUCT`**Provider name**: `scaleIO`**Description**: scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. Deprecated: ScaleIO is deprecated and the in-tree scaleIO type is no longer supported.
  - `fs_type`**Type**: `STRING`**Provider name**: `fsType`**Description**: fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs"
  - `gateway`**Type**: `STRING`**Provider name**: `gateway`**Description**: gateway is the host address of the ScaleIO API Gateway.
  - `protection_domain`**Type**: `STRING`**Provider name**: `protectionDomain`**Description**: protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.
  - `read_only`**Type**: `BOOLEAN`**Provider name**: `readOnly`**Description**: readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
  - `secret_ref`**Type**: `STRUCT`**Provider name**: `secretRef`**Description**: secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
    - `name`**Type**: `STRING`**Provider name**: `name`**Description**: name is unique within a namespace to reference a secret resource.
    - `namespace`**Type**: `STRING`**Provider name**: `namespace`**Description**: namespace defines the space within which the secret name must be unique.
  - `ssl_enabled`**Type**: `BOOLEAN`**Provider name**: `sslEnabled`**Description**: sslEnabled is the flag to enable/disable SSL communication with Gateway, default false
  - `storage_mode`**Type**: `STRING`**Provider name**: `storageMode`**Description**: storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.
  - `storage_pool`**Type**: `STRING`**Provider name**: `storagePool`**Description**: storagePool is the ScaleIO Storage Pool associated with the protection domain.
  - `system`**Type**: `STRING`**Provider name**: `system`**Description**: system is the name of the storage system as configured in ScaleIO.
  - `volume_name`**Type**: `STRING`**Provider name**: `volumeName`**Description**: volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.
- `storage_class_name`**Type**: `STRING`**Provider name**: `storageClassName`**Description**: storageClassName is the name of StorageClass to which this persistent volume belongs. Empty value means that this volume does not belong to any StorageClass.
- `storageos`**Type**: `STRUCT`**Provider name**: `storageos`**Description**: storageOS represents a StorageOS volume that is attached to the kubelet's host machine and mounted into the pod. Deprecated: StorageOS is deprecated and the in-tree storageos type is no longer supported. More info: [https://examples.k8s.io/volumes/storageos/README.md](https://examples.k8s.io/volumes/storageos/README.md)
  - `fs_type`**Type**: `STRING`**Provider name**: `fsType`**Description**: fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
  - `read_only`**Type**: `BOOLEAN`**Provider name**: `readOnly`**Description**: readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
  - `secret_ref`**Type**: `STRUCT`**Provider name**: `secretRef`**Description**: secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
    - `api_version`**Type**: `STRING`**Provider name**: `apiVersion`**Description**: API version of the referent.
    - `field_path`**Type**: `STRING`**Provider name**: `fieldPath`**Description**: 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.
    - `kind`**Type**: `STRING`**Provider name**: `kind`**Description**: Kind of the referent. More info: [https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds](https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds)
    - `name`**Type**: `STRING`**Provider name**: `name`**Description**: Name of the referent. More info: [https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names)
    - `namespace`**Type**: `STRING`**Provider name**: `namespace`**Description**: Namespace of the referent. More info: [https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/)
    - `resource_version`**Type**: `STRING`**Provider name**: `resourceVersion`**Description**: Specific resourceVersion to which this reference is made, if any. More info: [https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency](https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency)
    - `uid`**Type**: `STRING`**Provider name**: `uid`**Description**: UID of the referent. More info: [https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids)
  - `volume_name`**Type**: `STRING`**Provider name**: `volumeName`**Description**: volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.
  - `volume_namespace`**Type**: `STRING`**Provider name**: `volumeNamespace`**Description**: volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.
- `volume_attributes_class_name`**Type**: `STRING`**Provider name**: `volumeAttributesClassName`**Description**: Name of VolumeAttributesClass to which this persistent volume belongs. Empty value is not allowed. When this field is not set, it indicates that this volume does not belong to any VolumeAttributesClass. This field is mutable and can be changed by the CSI driver after a volume has been updated successfully to a new class. For an unbound PersistentVolume, the volumeAttributesClassName will be matched with unbound PersistentVolumeClaims during the binding process.
- `volume_mode`**Type**: `STRING`**Provider name**: `volumeMode`**Description**: 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.
- `vsphere_volume`**Type**: `STRUCT`**Provider name**: `vsphereVolume`**Description**: vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine. Deprecated: VsphereVolume is deprecated. All operations for the in-tree vsphereVolume type are redirected to the csi.vsphere.vmware.com CSI driver.
  - `fs_type`**Type**: `STRING`**Provider name**: `fsType`**Description**: fsType is filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
  - `storage_policy_id`**Type**: `STRING`**Provider name**: `storagePolicyID`**Description**: storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
  - `storage_policy_name`**Type**: `STRING`**Provider name**: `storagePolicyName`**Description**: storagePolicyName is the storage Policy Based Management (SPBM) profile name.
  - `volume_path`**Type**: `STRING`**Provider name**: `volumePath`**Description**: volumePath is the path that identifies vSphere volume vmdk

## `tags`{% #tags %}

**Type**: `UNORDERED_LIST_STRING`

## `zone_id`{% #zone_id %}

**Type**: `STRING`