public/rancher-docs
1
0
Fork 0
mirror of https://github.com/rancher/rancher-docs.git synced 2026-09-29 06:29:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

updating instructions

Browse Source
This commit is contained in:
Mark Bishop
2018-07-05 10:28:49 -07:00
committed by Mark Bishop
parent 2af6f3621f
commit 9241734e87
1 changed files with 22 additions and 150 deletions
Download Patch File Download Diff File Expand all files Collapse all files
content/rancher/v2.x/en/tasks/clusters/adding-storage/_index.md
+22 -150
View File
@@ -4,23 +4,15 @@ weight: 3500
draft: true draft: true
--- ---
Rancher supports two different types of storage for your containers: Persistent Volumes and Storage Classes.
- [Persistent Volumes](#adding-a-persistent-volume):
Your Docker containers can store data within themselves, but if a container failes, that data is lost. To solve this issue, Kubernetes offers _persistent volumes_, which is external storage that your container can access. If a container goes down, it can recover data by accessing the persistent volume. Persistent volumes can either be created locally on your nodes, or externally by a vendor, such as Amazon EBS, Azure Disk, and many more.
- [Storage Classes](#adding-storage-classes):
_StorageClasses_ are different categories of storage. For example, you can create different storage classes divide your services into different service level, or you can use them to create a backup storage category.
### Adding a Persistent Volume ### Adding a Persistent Volume
>**Note:** Rancher supports numerous persistent volumes plugins from a variety of different vendors. Therefore, we've written thorough documentation for the most popular plugins, but for plugins that aren't as popular, we wrote a generic procudure that points to external documents that can help. Your containers can store data on themselves, but if a container fails, that data is lost. To solve this issue, Kubernetes offers _persistent volumes_, which are external storage disks or filesystems that your container can access. If a container goes down, the container that replaces it can access the data in a persistent volume without any data loss. Persistent volumes can either be a disk hosted by you on premise, or externally by a vendor, such as Amazon EBS, Azure Disk, and many more.
#### Adding a Pesistent Volume: Generic Directions >**Prerequisite:**
>
>Create a storage volume either on premise or using one of the vendor services listed in the `Volume Plugin` drop-down.
1. From the **Global** view, open the cluster containing the nodes you want to add persistent volume storage to. 1. From the **Global** view, open the cluster running the containers that you want to add persistent volume storage to.
1. From the main menu, select **Storage > Persistent Volumes**. 1. From the main menu, select **Storage > Persistent Volumes**.
@@ -28,42 +20,31 @@ Rancher supports two different types of storage for your containers: Persistent
1. Enter a **Name** for the persistent volume. 1. Enter a **Name** for the persistent volume.
1. Select a **Volume Plugin**. 1. Select the **Volume Plugin** for the disk type or service that you're using.
1. Complete the **Plugin Configuration** form. Each plugin type requires information specific to the vendor. For more information about each plugin's form, refer to the reference table below. 1. Enter the **Capacity** of your volume in gigabytes.
1. Complete the **Customize** form. This form features 1. Complete the **Plugin Configuration** form. Each plugin type requires information specific to the vendor of disk type. For more information about each plugin's form, refer to the reference table below.
- [Access Modes](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#access-modes): This options sets how many nodes can access the volume, along with the node read/write permissions. The [Kubernettes Documentation](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#access-modes) includes a table that lists which access modes are supported by the plugins available. 1. **Optional:** Complete the **Customize** form. This form features:
- [Mount Options](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options): Each volume plugin allows you to specify additional command line options during the mounting process. You can enter these options in the **Mount Option** fields. Consult each plugin's documentation for the mount options available.
- [Assign to Storage Class]():
1. Use the desired **Capacity** for the persistent volume in **Gib**. - [Access Modes](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#access-modes):
This options sets how many nodes can access the volume, along with the node read/write permissions. The [Kubernettes Documentation](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#access-modes) includes a table that lists which access modes are supported by the plugins available.
1. Choose the **Path** where this volume will be mounted on the node. - [Mount Options](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options):
Each volume plugin allows you to specify additional command line options during the mounting process. You can enter these options in the **Mount Option** fields. Consult each plugin's documentation for the mount options available.
1. Select From **The Path on the Node must be** drop-down select the type of the host path: - **Assign to Storage Class:**
If you want to automatically provision persistent volumes identical to volume that you've specified here, assign it a storage class. Later, when you create a workload that includes persistent volume claims, Rancher will automatically provision a persistent volume for each container with a claim.
- AnyThing: do not check the target path >**Note:** You must [add a storage class](#adding-storage-classes) before you can assign it to a persistent volume.
- A directory, or create if doesn't exist
- An existing directory
- An existing file
- An existing socket_
- An existing character device
- An existing block device
1. FThe volume can be customized with advanced options including:
- Access Modes: this option can be one of the following:
- Single Node Read-Write
- Many Nodes Read-Only
- Many Nodes Read-Write
- **Mount Options:** this option include any extra mount options for the volume mount.
1. Click **Save**. 1. Click **Save**.
After clicking **Save** a new persistent volume will be created with the specified name, this volume is a _hostPath_ volume in Kubernetes: **Result:** Your new persistent volume is created. For example, this volume is a _hostPath_ volume in Kubernetes:
``` ```
> kubectl get pv > kubectl get pv
@@ -88,119 +69,10 @@ status:
phase: Available phase: Available
``` ```
### Adding a Local Volume
1. From the **Global** view, open the cluster containing the nodes you want to add persistent volume storage to.
1. From the main menu, select **Storage > Persistent Volumes**.
1. Click **Add Volume**.
1. From **Add Volume**, enter a **Name** for the persistent volume.
1. Select **Local Node Path** from the **Volume Plugin** drop down.
1. Use the desired **Capacity** for the persistent volume in **Gib**.
1. Choose the **Path** where this volume will be mounted on the node.
1. From **The Path on the Node must be** drop-down select the type of the host path:
- AnyThing: do not check the target path
- A directory, or create if doesn't exist
- An existing directory
- An existing file
- An existing socket_
- An existing character device
- An existing block device
1. The volume can be customized with advanced options including:
- **Access Modes:** this option can be one of the following:
- Single Node Read-Write
- Many Nodes Read-Only
- Many Nodes Read-Write
- **Mount Options:** this option include any extra mount options for the volume mount.
1. Click **Save**.
After clicking **Save** a new persistent volume will be created with the specified name, this volume is a _hostPath_ volume in Kubernetes:
```
> kubectl get pv
NAME CAPACITY ACCESS MODES RECLAIM POLICY STATUS CLAIM STORAGECLASS REASON AGE
test 10Gi RWO Retain Available 23m
> kubectl get pv/test -o yaml
apiVersion: v1
kind: PersistentVolume
metadata:
...
spec:
accessModes:
- ReadWriteOnce
capacity:
storage: 10Gi
hostPath:
path: /tmp/test
type: ""
persistentVolumeReclaimPolicy: Retain
status:
phase: Available
```
### Amazon EBS Disk
To Create an Amazon EBS persistent volume use the following steps:
1. From the **Cluster** View select **Storage** > **Persistent Volumes**.
2. Click **Add Volume**.
3. In the **Add Volume** view choose the **Name** of the persistent volume.
4. Select the **Amazon EBS Disk** from the **Volume Plugin** drop down.
5. Use the desired **Capacity** for the persistent volume in **Gib**.
6. In **Plugin Configuration** menu Enter the following:
- **Filesystem Type**: for example ext4.
- **Partition**: number of partitions for this EBS disk.
- **Read Only**: specify the read-write options for the disk.
- **Volume ID**: id of the EBS disk eg: `vol-0768676b73d2f5b60`.
7. The volume can be customized with advanced options including:
- **Access Modes:** this option can be one of the following:
- _Single Node Read-Write_
- _Many Nodes Read-Only_
- _Many Nodes Read-Write_
- **Mount Options:** this option include any extra mount options for the volume mount.
8. Click **Save**
After Clicking **Save** a Persistent volume of type `awsElasticBlockStore` will be created:
```
> kubectl get pv/ebsdisk
NAME CAPACITY ACCESS MODES RECLAIM POLICY STATUS CLAIM STORAGECLASS REASON AGE
ebsdisk 10Gi RWO Retain Available 4m
> kubectl get pv/ebsdisk -o yaml
apiVersion: v1
kind: PersistentVolume
metadata:
...
name: ebsdisk
...
spec:
accessModes:
- ReadWriteOnce
awsElasticBlockStore:
fsType: ext4
volumeID: vol-0768676b73d2f5b60
capacity:
storage: 10Gi
persistentVolumeReclaimPolicy: Retain
status:
phase: Available
```
## Adding Storage Classes ## Adding Storage Classes
_Storage Classes_ allow you to automate the creation of persistent volumes.
To add a storage class in Rancher: To add a storage class in Rancher:
1. From the **Cluster** View select **Storage** > **Storage Classes**. 1. From the **Cluster** View select **Storage** > **Storage Classes**.