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

Adding storage task

Browse Source
This commit is contained in:
galal-hussein
2018-07-05 10:28:49 -07:00
committed by Mark Bishop
parent 743bf8fda3
commit 6fd169a3f4
1 changed files with 157 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
content/rancher/v2.x/en/tasks/clusters/adding-storage/_index.md
+157 -3
View File
@@ -3,12 +3,166 @@ title: Adding Storage
weight: 3500
draft: true
---
Coming Soon
Rancher allows the user to create Persistent volumes at the cluster level as well as Storage Classes for different cloud provisioners including Amazon EBS and Azure Disks.
## Adding Persistent Volumes
Coming Soon
Rancher support different volume plugins for persistent volumes, including Local Node Disks, Amazon EBS, Azure Disk and many more.
### Local Node Path Persistent Volume
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 **Local Node Path** from the **Volume Plugin** drop down.
5. Use the desired **Capacity** for the persistent volume in **Gib**.
6. Choose the **Path** where this volume will be mounted on the node.
7. 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_
8. 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.
9. 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
Coming Soon
To add a storage class in Rancher:
1. From the **Cluster** View select **Storage** > **Storage Classes**.
2. Click on **Add Class**.
3. Select **Name** of the class.
4. Select one of the available **Provisioners**.
5. Each provisioner has its own options, for example Amazon EBS:
- **Volume Type**: this can be `gp2`, `io1`, `st1`, and `sc1`
- **Availability Zone**: can be `Automatic` or `Manual`.
- **Encryption**: whether to `enable` or `disable` encryption.
6. Click on **Save**.
## Mounting Persistent volumes
Persistent volumes can be mounted by either adding persistent volume claim or mount the persistent volume directly into a workload:
### Create Persistent Volume Claim and mount it to Workload
1. In Project view, for example **Default** go to **Volumes**.
2. Click on **Add Volume**.
3. Select a **Name** for the volume claim.
4. Select the **Namespace** of the volume claim.
5. Select **Use an existing persistent volume**.
6. From the drop down menu of **Persistent Volume**, select the pre-created persistent volume or storage class.
7. Click **Create**
After creating a pvc, it can be used in any workload:
```
> kubectl get pvc
NAME STATUS VOLUME CAPACITY ACCESS MODES STORAGECLASS AGE
ebsvolumeclaim Bound ebsdisk 10Gi RWO 1m
```
To use it in a workload:
1. In Project view, for example **Default** go to **Workloads**.
2. Click on **Deploy**.
3. In **Deploy Workload** view select **Volumes**.
4. Click on **Add Volume**.
5. Select **Use an existing persistent Volume (claim)**.
6. Specify **Mount Point** path.
7. Optionally **Subpath** can be specified.
>**Note:**
>
> For EBS volumes to be mounted, the nodes must be in the same AZ and have the IAM permission to attach/unattach volumes and more importantly the Cluster must be using AWS cloud provider to be able to use ebs-volume plugin
The volume be seen mounted within the pods:
```
root@nginx-6b8c57bbb7-hk2pc:/# lsblk
NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINT
xvda 202:0 0 16G 0 disk
`-xvda1 202:1 0 16G 0 part /etc/hosts
xvdcc 202:20480 0 10G 0 disk /tmp/test
```