» kubernetes_persistent_volume

The resource provides a piece of networked storage in the cluster provisioned by an administrator. It is a resource in the cluster just like a node is a cluster resource. Persistent Volumes have a lifecycle independent of any individual pod that uses the PV.

For more info see Kubernetes reference/

» Example Usage

resource "kubernetes_persistent_volume" "example" {
    metadata {
        name = "terraform-example"
    }
    spec {
        capacity {
            storage = "2Gi"
        }
        access_modes = ["ReadWriteMany"]
        persistent_volume_source {
            vsphere_volume {
                volume_path = "/absolute/path"
            }
        }
    }
}

» Argument Reference

The following arguments are supported:

  • metadata - (Required) Standard persistent volume's metadata. For more info see Kubernetes reference
  • spec - (Required) Spec of the persistent volume owned by the cluster. See below.

» Nested Blocks

» spec

» Arguments

» persistent_volume_source

» Arguments

  • aws_elastic_block_store - (Optional) Represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. For more info see Kubernetes reference
  • azure_disk - (Optional) Represents an Azure Data Disk mount on the host and bind mount to the pod.
  • azure_file - (Optional) Represents an Azure File Service mount on the host and bind mount to the pod.
  • ceph_fs - (Optional) Represents a Ceph FS mount on the host that shares a pod's lifetime
  • cinder - (Optional) Represents a cinder volume attached and mounted on kubelets host machine. For more info see http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md
  • fc - (Optional) Represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
  • flex_volume - (Optional) Represents a generic volume resource that is provisioned/attached using an exec based plugin. This is an alpha feature and may change in future.
  • flocker - (Optional) 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
  • gce_persistent_disk - (Optional) Represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Provisioned by an admin. For more info see Kubernetes reference
  • glusterfs - (Optional) Represents a Glusterfs volume that is attached to a host and exposed to the pod. Provisioned by an admin. For more info see http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md
  • host_path - (Optional) 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. For more info see Kubernetes reference
  • iscsi - (Optional) Represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Provisioned by an admin.
  • nfs - (Optional) Represents an NFS mount on the host. Provisioned by an admin. For more info see Kubernetes reference
  • photon_persistent_disk - (Optional) Represents a PhotonController persistent disk attached and mounted on kubelets host machine
  • quobyte - (Optional) Quobyte represents a Quobyte mount on the host that shares a pod's lifetime
  • rbd - (Optional) Represents a Rados Block Device mount on the host that shares a pod's lifetime. For more info see http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md
  • vsphere_volume - (Optional) Represents a vSphere volume attached and mounted on kubelets host machine

» aws_elastic_block_store

» Arguments

  • fs_type - (Optional) 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. For more info see Kubernetes reference
  • partition - (Optional) 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 - (Optional) Whether to set the read-only property in VolumeMounts to "true". If omitted, the default is "false". For more info see Kubernetes reference
  • volume_id - (Required) Unique ID of the persistent disk resource in AWS (Amazon EBS volume). For more info see Kubernetes reference

» azure_disk

» Arguments

  • caching_mode - (Required) Host Caching mode: None, Read Only, Read Write.
  • data_disk_uri - (Required) The URI the data disk in the blob storage
  • disk_name - (Required) The Name of the data disk in the blob storage
  • fs_type - (Optional) 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 - (Optional) Whether to force the read-only setting in VolumeMounts. Defaults to false (read/write).

» azure_file

» Arguments

  • read_only - (Optional) Whether to force the read-only setting in VolumeMounts. Defaults to false (read/write).
  • secret_name - (Required) The name of secret that contains Azure Storage Account Name and Key
  • share_name - (Required) Share Name

» ceph_fs

» Arguments

» cinder

» Arguments

» fc

» Arguments

  • fs_type - (Optional) 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 - (Required) FC target lun number
  • read_only - (Optional) Whether to force the read-only setting in VolumeMounts. Defaults to false (read/write).
  • target_ww_ns - (Required) FC target worldwide names (WWNs)

» flex_volume

» Arguments

  • driver - (Required) Driver is the name of the driver to use for this volume.
  • fs_type - (Optional) 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.
  • options - (Optional) Extra command options if any.
  • read_only - (Optional) Whether to force the ReadOnly setting in VolumeMounts. Defaults to false (read/write).
  • secret_ref - (Optional) Reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.

» flocker

» Arguments

  • dataset_name - (Optional) Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated
  • dataset_uuid - (Optional) UUID of the dataset. This is unique identifier of a Flocker dataset

» gce_persistent_disk

» Arguments

  • fs_type - (Optional) 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. For more info see Kubernetes reference
  • partition - (Optional) 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). For more info see Kubernetes reference
  • pd_name - (Required) Unique name of the PD resource in GCE. Used to identify the disk in GCE. For more info see Kubernetes reference
  • read_only - (Optional) Whether to force the ReadOnly setting in VolumeMounts. Defaults to false. For more info see Kubernetes reference

» glusterfs

» Arguments

» host_path

» Arguments

» iscsi

» Arguments

  • fs_type - (Optional) 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. For more info see Kubernetes reference
  • iqn - (Required) Target iSCSI Qualified Name.
  • iscsi_interface - (Optional) iSCSI interface name that uses an iSCSI transport. Defaults to 'default' (tcp).
  • lun - (Optional) iSCSI target lun number.
  • read_only - (Optional) Whether to force the read-only setting in VolumeMounts. Defaults to false.
  • target_portal - (Required) iSCSI target portal. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).

» metadata

» Arguments

  • annotations - (Optional) An unstructured key value map stored with the persistent volume that may be used to store arbitrary metadata. For more info see Kubernetes reference
  • labels - (Optional) Map of string keys and values that can be used to organize and categorize (scope and select) the persistent volume. May match selectors of replication controllers and services. For more info see Kubernetes reference
  • name - (Optional) Name of the persistent volume, must be unique. Cannot be updated. For more info see Kubernetes reference

» Attributes

  • generation - A sequence number representing a specific generation of the desired state.
  • resource_version - An opaque value that represents the internal version of this persistent volume that can be used by clients to determine when persistent volume has changed. For more info see Kubernetes reference
  • self_link - A URL representing this persistent volume.
  • uid - The unique in time and space value for this persistent volume. For more info see Kubernetes reference

» nfs

» Arguments

» photon_persistent_disk

» Arguments

  • fs_type - (Optional) 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 - (Required) ID that identifies Photon Controller persistent disk

» quobyte

» Arguments

  • group - (Optional) Group to map volume access to Default is no group
  • read_only - (Optional) Whether to force the Quobyte volume to be mounted with read-only permissions. Defaults to false.
  • registry - (Required) Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes
  • user - (Optional) User to map volume access to Defaults to serivceaccount user
  • volume - (Required) Volume is a string that references an already created Quobyte volume by name.

» rbd

» Arguments

» secret_ref

» Arguments

» vsphere_volume

» Arguments

  • fs_type - (Optional) 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.
  • volume_path - (Required) Path that identifies vSphere volume vmdk

» Import

Persistent Volume can be imported using its name, e.g.

$ terraform import kubernetes_persistent_volume.example terraform-example