Chapter 3. Creating Persistent Volumes

1. To specify the endpoints you want to create, update the copied sample-gluster-endpoints.yaml file with the endpoints to be created based on the environment. Each Red Hat Gluster Storage trusted storage pool requires its own endpoint with the IP of the nodes in the trusted storage pool.

   # cat sample-gluster-endpoints.yaml
   apiVersion: v1
   kind: Endpoints
   metadata:
     name: glusterfs-cluster
   subsets:
     - addresses:
         - ip: 192.168.10.100
       ports:
         - port: 1
     - addresses:
         - ip: 192.168.10.101
       ports:
         - port: 1
     - addresses:
         - ip: 192.168.10.102
       ports:
   - port: 1

   name

   The name of the endpoint.

   ip

   The ip address of the Red Hat Gluster Storage nodes.

2. Execute the following command to create the endpoints:

   # oc create -f <name_of_endpoint_file>

   For example:

   # oc create -f sample-gluster-endpoints.yaml
   endpoints "glusterfs-cluster" created

3. To verify that the endpoints are created, execute the following command:

   # oc get endpoints

   For example:

   # oc get endpoints
   NAME                       ENDPOINTS                                                     AGE
   storage-project-router     192.168.121.233:80,192.168.121.233:443,192.168.121.233:1936   2d
   glusterfs-cluster          192.168.121.168:1,192.168.121.172:1,192.168.121.233:1         3s
   heketi                     10.1.1.3:8080                                                 2m
   heketi-storage-endpoints   192.168.121.168:1,192.168.121.172:1,192.168.121.233:1         3m

4. Execute the following command to create a gluster service:

   # oc create -f <name_of_service_file>

   For example:

   # cat sample-gluster-service.yaml
   apiVersion: v1
   kind: Service
   metadata:
     name: glusterfs-cluster
   spec:
     ports:
   - port: 1

   # oc create -f sample-gluster-service.yaml
   service "glusterfs-cluster" created

5. To verify that the service is created, execute the following command:

   # oc get service

   For example:

   # oc get service
   NAME                       CLUSTER-IP      EXTERNAL-IP   PORT(S)                   AGE
   storage-project-router     172.30.94.109   <none>        80/TCP,443/TCP,1936/TCP   2d
   glusterfs-cluster          172.30.212.6    <none>        1/TCP                     5s
   heketi                     172.30.175.7    <none>        8080/TCP                  2m
   heketi-storage-endpoints   172.30.18.24    <none>        1/TCP                     3m

   Note

   The endpoints and the services must be created for each project that requires a persistent storage.

6. Create a 100G persistent volume with Replica 3 from GlusterFS and output a persistent volume specification describing this volume to the file pv001.json:

   $ heketi-cli volume create --size=100 --persistent-volume-file=pv001.json

   cat pv001.json
   {
     "kind": "PersistentVolume",
     "apiVersion": "v1",
     "metadata": {
       "name": "glusterfs-f8c612ee",
       "creationTimestamp": null
     },
     "spec": {
       "capacity": {
         "storage": "100Gi"
       },
       "glusterfs": {
         "endpoints": "TYPE ENDPOINT HERE",
         "path": "vol_f8c612eea57556197511f6b8c54b6070"
       },
       "accessModes": [
         "ReadWriteMany"
       ],
       "persistentVolumeReclaimPolicy": "Retain"
     },
     "status": {}

   Important

   You must manually add the Labels information to the .json file.

   Following is the example YAML file for reference:

   apiVersion: v1
   kind: PersistentVolume
   metadata:
     name: pv-storage-project-glusterfs1
     labels:
       storage-tier: gold
   spec:
     capacity:
       storage: 12Gi
     accessModes:
       - ReadWriteMany
     persistentVolumeReclaimPolicy: Retain
     glusterfs:
       endpoints: TYPE END POINTS NAME HERE,
   path: vol_e6b77204ff54c779c042f570a71b1407

   name

   The name of the volume.

   storage

   The amount of storage allocated to this volume

   glusterfs

   The volume type being used, in this case the glusterfs plug-in

   endpoints

   The endpoints name that defines the trusted storage pool created

   path

   The Red Hat Gluster Storage volume that will be accessed from the Trusted Storage Pool.

   accessModes

   accessModes are used as labels to match a PV and a PVC. They currently do not define any form of access control.

   labels

   Use labels to identify common attributes or characteristics shared among volumes. In this case, we have defined the gluster volume to have a custom attribute (key) named storage-tier with a value of gold assigned. A claim will be able to select a PV with storage-tier=gold to match this PV.

   Note

   • heketi-cli also accepts the endpoint name on the command line (--persistent-volume-endpoint=”TYPE ENDPOINT HERE”). This can then be piped to oc create -f - to create the persistent volume immediately.
   • If there are multiple Red Hat Gluster Storage trusted storage pools in your environment, you can check on which trusted storage pool the volume is created using the heketi-cli volume list command. This command lists the cluster name. You can then update the endpoint information in the pv001.json file accordingly.
   • When creating a Heketi volume with only two nodes with the replica count set to the default value of three (replica 3), an error "No space" is displayed by Heketi as there is no space to create a replica set of three disks on three different nodes.
   • If all the heketi-cli write operations (ex: volume create, cluster create..etc) fails and the read operations ( ex: topology info, volume info ..etc) are successful, then the possibility is that the gluster volume is operating in read-only mode.

7. Edit the pv001.json file and enter the name of the endpoint in the endpoint’s section:

   cat pv001.json
   {
     "kind": "PersistentVolume",
     "apiVersion": "v1",
     "metadata": {
       "name": "glusterfs-f8c612ee",
       "creationTimestamp": null,
       "labels": {
         "storage-tier": "gold"
       }
     },
     "spec": {
       "capacity": {
         "storage": "12Gi"
       },
       "glusterfs": {
         "endpoints": "glusterfs-cluster",
         "path": "vol_f8c612eea57556197511f6b8c54b6070"
       },
       "accessModes": [
         "ReadWriteMany"
       ],
       "persistentVolumeReclaimPolicy": "Retain"
     },
     "status": {}
   }

8. Create a persistent volume by executing the following command:

   # oc create -f pv001.json

   For example:

   # oc create -f pv001.json
   persistentvolume "glusterfs-4fc22ff9" created

9. To verify that the persistent volume is created, execute the following command:

   # oc get pv

   For example:

   # oc get pv
   
   NAME                 CAPACITY   ACCESSMODES   STATUS      CLAIM     REASON    AGE
   glusterfs-4fc22ff9   100Gi      RWX           Available                       4s

10. Create a persistent volume claim file. For example:

    # cat pvc.yaml
    apiVersion: v1
    kind: PersistentVolumeClaim
    metadata:
      name: glusterfs-claim
    spec:
      accessModes:
        - ReadWriteMany
      resources:
        requests:
          storage: 100Gi
        selector:
          matchLabels:
    storage-tier: gold

11. Bind the persistent volume to the persistent volume claim by executing the following command:

    # oc create -f pvc.yaml

    For example:

    # oc create -f pvc.yaml
    persistentvolumeclaim"glusterfs-claim" created

12. To verify that the persistent volume and the persistent volume claim is bound, execute the following commands:

    # oc get pv
    # oc get pvc

    For example:

    # oc get pv
    
    NAME                 CAPACITY   ACCESSMODES   STATUS    CLAIM                  REASON    AGE
    glusterfs-4fc22ff9   100Gi      RWX           Bound     storage-project/glusterfs-claim             1m

    # oc get pvc
    
    NAME              STATUS    VOLUME               CAPACITY   ACCESSMODES   AGE
    glusterfs-claim   Bound     glusterfs-4fc22ff9   100Gi      RWX           11s

13. The claim can now be used in the application. For example:

    # cat app.yaml
    
    apiVersion: v1
    kind: Pod
    metadata:
      name: busybox
    spec:
      containers:
        - image: busybox
          command:
            - sleep
            - "3600"
          name: busybox
          volumeMounts:
            - mountPath: /usr/share/busybox
              name: mypvc
      volumes:
        - name: mypvc
          persistentVolumeClaim:
    claimName: glusterfs-claim

    # oc create -f app.yaml
    pod "busybox" created

    For more information about using the glusterfs claim in the application see, https://access.redhat.com/documentation/en-us/openshift_container_platform/3.11/html-single/configuring_clusters/#install-config-storage-examples-gluster-example.

14. To verify that the pod is created, execute the following command:

    # oc get pods -n <storage_project_name>

    For example:

    # oc get pods -n storage-project
    
    NAME                               READY     STATUS    RESTARTS   AGE
    block-test-router-1-deploy         0/1       Running     0          4h
    busybox                            1/1       Running   0          43s
    glusterblock-provisioner-1-bjpz4   1/1       Running   0          4h
    glusterfs-7l5xf                    1/1       Running   0          4h
    glusterfs-hhxtk                    1/1       Running   3          4h
    glusterfs-m4rbc                    1/1       Running   0          4h
    heketi-1-3h9nb                     1/1       Running   0          4h

15. To verify that the persistent volume is mounted inside the container, execute the following command:

    # oc rsh busybox

    / $ df -h
    Filesystem                Size      Used Available Use% Mounted on
    /dev/mapper/docker-253:0-1310998-81732b5fd87c197f627a24bcd2777f12eec4ee937cc2660656908b2fa6359129
                          100.0G     34.1M     99.9G   0% /
    tmpfs                     1.5G         0      1.5G   0% /dev
    tmpfs                     1.5G         0      1.5G   0% /sys/fs/cgroup
    192.168.121.168:vol_4fc22ff934e531dec3830cfbcad1eeae
                           99.9G     66.1M     99.9G   0% /usr/share/busybox
    tmpfs                     1.5G         0      1.5G   0% /run/secrets
    /dev/mapper/vg_vagrant-lv_root
                           37.7G      3.8G     32.0G  11% /dev/termination-log
    tmpfs                     1.5G     12.0K      1.5G   0% /var/run/secretgit s/kubernetes.io/serviceaccount

1. Create a storage class file with the GID values. For example:

   # cat glusterfs-storageclass.yaml
   
   apiVersion: storage.k8s.io/v1
   kind: StorageClass
   metadata:
     name: gluster-container
   provisioner: kubernetes.io/glusterfs
   parameters:
     resturl: "http://heketi-storage-project.cloudapps.mystorage.com"
     restuser: "admin"
     secretNamespace: "default"
     secretName: "heketi-secret"
     gidMin: "2000"
   gidMax: "4000"

   Note

   If the gidMin and gidMax values are not provided, then the dynamic provisioned volumes will have the GID between 2000 and 2147483647.

2. Create a persistent volume claim. For more information see, Section 3.1.2.1.3, “Creating a Persistent Volume Claim”
3. Use the claim in the pod. Ensure that this pod is non-privileged. For more information see, Section 3.1.2.1.6, “Using the Claim in a Pod”

4. To verify if the GID is within the range specified, execute the following command:

   # oc rsh busybox

   $ id

   For example:

   $ id
   uid=1000060000 gid=0(root) groups=0(root),2001

   where, 2001 in the above output is the allocated GID for the persistent volume, which is within the range specified in the storage class. You can write to this volume with the allocated GID.

   Note

   When the persistent volume claim is deleted, the GID of the persistent volume is released from the pool.

Procedure

1. Apply the required tags on the heketi devices.

   # heketi-cli device settags <device-name> <key>:<value>

   Example :

   # heketi-cli device settags 1fe1b83e5660efb53cc56433cedf7771 disktype:hdd

2. Remove the applied tag from the device.

   # heketi-cli device rmtags <device-name> <key>

   Example :

   # heketi-cli device rmtags 1fe1b83e5660efb53cc56433cedf7771 disktype

3. Verify the added tag on the device.

   # heketi-cli device info <device-name>

   Example :

   # heketi-cli device info 1fe1b83e5660efb53cc56433cedf7771

   Example output :

   Device Id: 1fe1b83e5660efb53cc56433cedf7771
   State: online
   Size (GiB): 49
   Used (GiB): 41
   Free (GiB): 8
   Create Path: /dev/vdc
   Physical Volume UUID: GpAnb4-gY8e-p5m9-0UU3-lV3J-zQWY-zFgO92
   Known Paths: /dev/disk/by-id/virtio-bf48c436-04a9-48ed-9 /dev/disk/by-path/pci-0000:00:08.0 /dev/disk/by-path/virtio-pci-0000:00:08.0 /dev/vdc
   Tags:
     disktype: hdd    ---> added tag

4. Use tagged devices to create the volume.

    # heketi-cli volume create --size=<size in GiB> --gluster-volume-options'user.heketi.device-tag-match <key>=<value>’

   Important

   • When creating volumes, you must pass a new volume option user.heketi.device-tag-match where the value of the option is a tag key followed by either "=" or "!=" and followed by a tag value.
   • All matches are exact and case sensitive and only one device-tag-match can be specified.

   Example :

   # heketi-cli volume create --size=5 --gluster-volume-options 'user.heketi.device-tag-match disktype=hdd’

   Note

   Once a volume is created the volume options list is fixed. The tag-match rules persist with the volume metadata for volume expansion and brick replacement purposes.

5. Create a storage class.

   • Create a storage class that only creates volumes on hard disks.

     # cat hdd-storageclass.yaml

     apiVersion: storage.k8s.io/v1
     kind: StorageClass
     metadata:
       annotations:
         storageclass.kubernetes.io/is-default-class: "false"
       name: glusterfs-storage-hdd
       selfLink: /apis/storage.k8s.io/v1/storageclasses/glusterfs-storage
     parameters:
       resturl: http://heketi-storage.glusterfs.svc:8080
       restuser: admin
       secretName: heketi-storage-admin-secret
       secretNamespace: glusterfs
       volumeoptions: "user.heketi.device-tag-match disktype=hdd"
     provisioner: kubernetes.io/glusterfs
     reclaimPolicy: Delete
     volumeBindingMode: Immediate

   • Create a storage class that only creates volumes using faster solid state storage.

     Important

     You must use a negative tag matching rule that excludes hard disk devices.

     # cat sdd-storageclass.yaml

     apiVersion: storage.k8s.io/v1
     kind: StorageClass
     metadata:
       annotations:
         storageclass.kubernetes.io/is-default-class: "false"
       name: glusterfs-storage-dd
       selfLink: /apis/storage.k8s.io/v1/storageclasses/glusterfs-storage
     parameters:
       resturl: http://heketi-storage.glusterfs.svc:8080
       restuser: admin
       secretName: heketi-storage-admin-secret
       secretNamespace: glusterfs
       volumeoptions: "user.heketi.device-tag-match disktype!=hdd"
     provisioner: kubernetes.io/glusterfs
     reclaimPolicy: Delete
     volumeBindingMode: Immediate

1. Execute the following command to fetch the zone and cluster info from heketi

   # heketi-cli topology info --user=<user> --secret=<user key>

   --user

   heketi user

   --secret

   Secret key for a specified user

2. After obtaining the cluster id and zone id, refer to Adding New Nodes to add a new node.

3. Execute the following command to add the device

   # heketi-cli device add --name=<device name> --node=<node id> --user=<user> --secret=<user key>

   --name

   Name of device to add

   --node

   Newly added node id

   For example:

   # heketi-cli device add --name=/dev/vdc --node=2639c473a2805f6e19d45997bb18cb9c --user=admin --secret=adminkey
   Device added successfully

4. After the new node and its associated devices are added to heketi, the faulty or unwanted node can be removed from heketi

   To remove any node from heketi, follow this workflow:

   • node disable (Disallow usage of a node by placing it offline)
   • node replace (Removes a node and all its associated devices from Heketi)
   • device delete (Deletes a device from Heketi node)
   • node delete (Deletes a node from Heketi management)

5. Execute the following command to fetch the node list from heketi

   #heketi-cli node list --user=<user> --secret=<user key>

   For example:

   # heketi-cli node list --user=admin --secret=adminkey
   Id:05746c562d6738cb5d7de149be1dac04    Cluster:607204cb27346a221f39887a97cf3f90
   Id:ab37fc5aabbd714eb8b09c9a868163df    Cluster:607204cb27346a221f39887a97cf3f90
   Id:c513da1f9bda528a9fd6da7cb546a1ee    Cluster:607204cb27346a221f39887a97cf3f90
   Id:e6ab1fe377a420b8b67321d9e60c1ad1    Cluster:607204cb27346a221f39887a97cf3f90

6. Execute the following command to fetch the node info of the node, that has to be deleted from heketi:

   # heketi-cli node info <nodeid> --user=<user> --secret=<user key>

   For example:

   # heketi-cli node info c513da1f9bda528a9fd6da7cb546a1ee --user=admin --secret=adminkey
   Node Id: c513da1f9bda528a9fd6da7cb546a1ee
   State: online
   Cluster Id: 607204cb27346a221f39887a97cf3f90
   Zone: 1
   Management Hostname: dhcp43-171.lab.eng.blr.redhat.com
   Storage Hostname: 10.70.43.171
   Devices:
   Id:3a1e0717e6352a8830ab43978347a103   Name:/dev/vdc            State:online    Size (GiB):499     Used (GiB):100     Free (GiB):399     Bricks:1
   Id:89a57ace1c3184826e1317fef785e6b7   Name:/dev/vdd            State:online    Size (GiB):499     Used (GiB):10      Free (GiB):489     Bricks:5

7. Execute the following command to disable the node from heketi. This makes the node go offline:

   # heketi-cli node disable <node-id> --user=<user> --secret=<user key>

   For example:

   # heketi-cli node disable ab37fc5aabbd714eb8b09c9a868163df --user=admin --secret=adminkey
   Node ab37fc5aabbd714eb8b09c9a868163df is now offline

8. Execute the following command to remove a node and all its associated devices from Heketi:

   #heketi-cli node remove <node-id> --user=<user> --secret=<user key>

   For example:

   # heketi-cli node remove ab37fc5aabbd714eb8b09c9a868163df --user=admin --secret=adminkey
   Node ab37fc5aabbd714eb8b09c9a868163df is now removed

9. Execute the following command to delete the devices from heketi node:

   # heketi-cli device delete <device-id> --user=<user> --secret=<user key>

   For example:

   # heketi-cli device delete 0fca78c3a94faabfbe5a5a9eef01b99c --user=admin --secret=adminkey
   Device 0fca78c3a94faabfbe5a5a9eef01b99c deleted

10. Execute the following command to delete a node from Heketi management:

    #heketi-cli node delete <nodeid> --user=<user> --secret=<user key>

    For example:

    # heketi-cli node delete ab37fc5aabbd714eb8b09c9a868163df --user=admin --secret=adminkey
    Node ab37fc5aabbd714eb8b09c9a868163df deleted

11. Execute the following commands on any one of the gluster pods to replace the faulty node with the new node:

    1. Execute the following command to get a list of block volumes hosted under block-hosting-volume:

       # gluster-block list <block-hosting-volume> --json-pretty

    2. Execute the following command to get the list of servers that are hosting the block volume, also save the GBID and PASSWORD values for later use:

       # gluster-block info <block-hosting-volume>/<block-volume> --json-pretty

    3. Execute the following command to replace the faulty node with the new node:

       # gluster-block replace <volname/blockname> <old-node> <new-node> [force]

       For example:

       {
         "NAME":"block",
         "CREATE SUCCESS":"192.168.124.73",
         "DELETE SUCCESS":"192.168.124.63",
         "REPLACE PORTAL SUCCESS ON":[
           "192.168.124.79"
         ],
         "RESULT":"SUCCESS"
       }
       
       Note: If the old node is down and does not come up again then you can force replace:
       gluster-block replace sample/block 192.168.124.63 192.168.124.73 force --json-pretty
       
       {
         "NAME":"block",
         "CREATE SUCCESS":"192.168.124.73",
         "DELETE FAILED (ignored)":"192.168.124.63",
         "REPLACE PORTAL SUCCESS ON":[
           "192.168.124.79"
         ],
         "RESULT":"SUCCESS"
       }

    Note

    The next steps are to be executed only if the block that is to be replaced is still in use.

12. Skip this step if the block volume is not currently mounted. If the block volume is in use by the application, we need to reload the mapper device on the initiator side.

    1. Identify the initiator node and targetname:

       To find initiator node:

       # oc get pods -o wide | grep <podname>

       where podname is the name of the pod on which the blockvolume is mounted.

       For example

       # oc get pods -o wide | grep cirros1 cirros1-1-x6b5n   1/1       Running   0          1h        10.130.0.5     dhcp46-31.lab.eng.blr.redhat.com    <none>

       To find the targetname:

       # oc describe pv <pv_name> | grep IQN

       For example:

       # oc describe pv pvc-c50c69db-5f76-11ea-b27b-005056b253d1 | grep IQN
         IQN: iqn.2016-12.org.gluster-block:87ffbcf3-e21e-4fa5-bd21-7db2598e8d3f

    2. Execute the following command on the initiator node to find the mapper device:

       # mount | grep <targetname>

    3. Reload the mapper device:

       # multipath -r mpathX

       For example:

       # mount | grep iqn.2016-12.org.gluster-block:d6d18f43-8a74-4b2c-a5b7-df1fa3f5bc9a/dev/mapper/mpatha on /var/lib/origin/openshift.local.volumes/plugins/kubernetes.io/iscsi/iface-default/192.168.124.63:3260-iqn.2016-12.org.gluster-block:d6d18f43-8a74-4b2c-a5b7-df1fa3f5bc9a-lun-0 type xfs (rw,relatime,seclabel,attr2,inode64,noquota)
       # multipath -r mpatha

13. Log out of the old portal by executing the following command on the initiator:

    # iscsiadm -m node -T <targetname> -p <old node> -u

    For example:

    # iscsiadm -m node -T iqn.2016-12.org.gluster-block:d6d18f43-8a74-4b2c-a5b7-df1fa3f5bc9a -p 192.168.124.63 -u
    Logging out of session [sid: 8, target: iqn.2016-12.org.gluster-block:d6d18f43-8a74-4b2c-a5b7-df1fa3f5bc9a, portal: 192.168.124.63,3260]
    Logout of [sid: 8, target: iqn.2016-12.org.gluster-block:d6d18f43-8a74-4b2c-a5b7-df1fa3f5bc9a, portal: 192.168.124.63,3260] successful.

14. To re-discover the new node execute the following command:

    # iscsiadm -m discovery -t st -p <new node>

    For example:

    # iscsiadm -m discovery -t st -p 192.168.124.73
    192.168.124.79:3260,1 iqn.2016-12.org.gluster-block:d6d18f43-8a74-4b2c-a5b7-df1fa3f5bc9a
    192.168.124.73:3260,2 iqn.2016-12.org.gluster-block:d6d18f43-8a74-4b2c-a5b7-df1fa3f5bc9a

15. Log in to the new portal by executing the following:

    1. Update the authentication credentials (use GBID and PASSWORD from step 11ii)

       # iscsiadm -m node -T <targetname> -o update -n node.session.auth.authmethod -v CHAP -n node.session.auth.username -v <GBID> -n node.session.auth.password -v <PASSWORD> -p <new node ip>

    2. Log in to the new portal

       # iscsiadm -m node -T <targetname> -p <new node ip> -l

       For example:

       # iscsiadm -m node -T iqn.2016-12.org.gluster-block:d6d18f43-8a74-4b2c-a5b7-df1fa3f5bc9a -o update -n node.session.auth.authmethod -v CHAP -n node.session.auth.username -v d6d18f43-8a74-4b2c-a5b7-df1fa3f5bc9a -n node.session.auth.password -v a6a9081f-3d0d-4e8b-b9b0-d2be703b455d -p 192.168.124.73
       # iscsiadm -m node -T iqn.2016-12.org.gluster-block:d6d18f43-8a74-4b2c-a5b7-df1fa3f5bc9a -p 192.168.124.73 -l

16. To verify if the enabled hosting volume is replaced and running successfully, execute the following command on the initiator:

    # ll /dev/disk/by-path/ip-* | grep <targetname> | grep <“new node ip”>

17. Ensure that you update a gluster block Persistent Volume (PV) with the new IP address.

    The PVs are immutable by definition, so you cannot edit the PV, which means that you cannot change the old IP address on the PV. A document was created with the procedure to workaroud this issue (recreate a new PV and delete the old PV definition using the same data/underlying storage device), see the Red Hat Knowledgebase solution Gluster block PVs are not updated with new IPs after gluster node replacement.