Skip to main content
Version: v2.9

Create Kubernetes Persistent Volumes and Storage Classes

When deploying an application that needs to retain data, you'll need to create persistent storage. Persistent storage allows you to store application data external from the pod running your application. This storage practice allows you to maintain application data, even if the application's pod fails.

The documents in this section assume that you understand the Kubernetes concepts of persistent volumes, persistent volume claims, and storage classes. For more information, refer to the section on how storage works.

Prerequisites​

To set up persistent storage, the Manage Volumes role is required.

If you are provisioning storage for a cluster hosted in the cloud, the storage and cluster hosts must have the same cloud provider.

For provisioning new storage with Rancher, the cloud provider must be enabled. For details on enabling cloud providers, refer to this page.

For attaching existing persistent storage to a cluster, the cloud provider does not need to be enabled.

Setting up Existing Storage​

The overall workflow for setting up existing storage is as follows:

  1. Set up your persistent storage. This may be storage in an infrastructure provider, or it could be your own storage.
  2. Add a persistent volume (PV) that refers to the persistent storage.
  3. Add a persistent volume claim (PVC) that refers to the PV.
  4. Mount the PVC as a volume in your workload.

For details and prerequisites, refer to this page.

Dynamically Provisioning New Storage in Rancher​

The overall workflow for provisioning new storage is as follows:

  1. Add a StorageClass and configure it to use your storage provider. The StorageClass could refer to storage in an infrastructure provider, or it could refer to your own storage.
  2. Add a persistent volume claim (PVC) that refers to the storage class.
  3. Mount the PVC as a volume for your workload.

For details and prerequisites, refer to this page.

Longhorn Storage​

Longhorn is a lightweight, reliable and easy-to-use distributed block storage system for Kubernetes.

Longhorn is free, open source software. Originally developed by Rancher Labs, it is now being developed as a sandbox project of the Cloud Native Computing Foundation. It can be installed on any Kubernetes cluster with Helm, with kubectl, or with the Rancher UI.

If you have a pool of block storage, Longhorn can help you provide persistent storage to your Kubernetes cluster without relying on cloud providers. For more information about Longhorn features, refer to the documentation.

Rancher v2.5 simplified the process of installing Longhorn on a Rancher-managed cluster. For more information, see Cloud Native Storage with Longhorn.

Provisioning Storage Examples​

We provide examples of how to provision storage with NFS, vSphere, and Amazon's EBS.

GlusterFS Volumes​

In clusters that store data on GlusterFS volumes, you may experience an issue where pods fail to mount volumes after restarting the kubelet. For details on preventing this from happening, refer to this page.

iSCSI Volumes​

In Rancher Launched Kubernetes clusters that store data on iSCSI volumes, you may experience an issue where kubelets fail to automatically connect with iSCSI volumes. For details on resolving this issue, refer to this page.

hostPath Volumes​

Before you create a hostPath volume, you need to set up an extra_bind in your cluster configuration. This will mount the path as a volume in your kubelets, which can then be used for hostPath volumes in your workloads.

Migrating VMware vSphere Cloud Provider from In-tree to Out-of-tree​

Kubernetes is moving away from maintaining cloud providers in-tree. vSphere has an out-of-tree cloud provider that can be used by installing the vSphere cloud provider and cloud storage plugins.

For instructions on how to migrate from the in-tree vSphere cloud provider to out-of-tree, and manage the existing VMs post migration, refer to this page.