qingcloud-csi

README

QingCloud-CSI

• Description
• Disk Plugin
  • Kubernetes Compatibility Matrix
  • Feature Matrix
  • Installation
  • Uninstall
  • Document
• Support

---

Description

QingCloud CSI plugin implements an interface between Container Storage Interface (CSI) enabled Container Orchestrator (CO) and the storage of QingCloud. Currently, QingCloud CSI disk plugin has been developed and manages disk volume in QingCloud platform.

Disk Plugin

Disk plugin's design and installation use Kubernetes community recommended CSI plugin architecture. Plugin architecture contains Controller part and Node part. In the part of Controller, one Pod is created by Deployment in Kubernetes cluster. In the part of Node, one Pod is created by DaemonSet on every node. Now, it has been passed the CSI test in Kubernetes v1.15 environment.

After plugin installation completes, user can create volumes based on several types of disk, such as Standard disk, SSD Enterprise disk, High Performance disk, Super High Performance disk, NeonSAN disk, NeonSAN HDD disk and High Capacity disk, with ReadWriteOnce access mode and mount volumes on workloads.

Kubernetes Compatibility Matrix

QingCloud CSI	Kubernetes v1.10-v1.13	Kubernetes v1.14-1.15	Kubernetes v1.16	Kubernetes v1.17
v0.2.x	✓	-	-	-
v1.1.0	-	✓	-	-
v1.2.0	-	-	✓	✓

Feature Matrix

QingCloud CSI	Volume Management*	Volume Expansion	Volume Monitor	Volume Cloning	Snapshot Management**	Topology Awareness
v0.2.x	✓	-	-	-	-	-
v1.1.0	✓	✓	✓	✓	✓	✓
v1.2.0	✓	✓	✓	✓	✓***	✓

Notes:

• *: Volume Management including creating/deleting volume and mounting/unmount volume on Pod.
• **: Snapshot management including creating/deleting snapshot and restoring volume from snapshot.
• ***: Only supports Snapshot Management on Kubernetes v1.17+ because snapshot features goes into Beta on this version.

Installation

This guide will install CSI plugin in the kube-system namespace of Kubernetes v1.16+. You can also deploy the plugin in other namespace.

• Set Kubernetes Parameters
  • For Kubernetes v1.16
    • Enable --allow-privileged=true on kube-apiserver, kube-controller-manager, kube-scheduler, kubelet.
    • Enable (Default enabled) Mount Propagation feature gate。
    • Enable (Default enabled) --feature-gates=CSINodeInfo=true,CSIDriverRegistry=true,ExpandCSIVolumes=true option on kube-apiserver, kube-controller-manager, kube-scheduler, kubelet
    • Enable --read-only-port=10255 on kubelet
  • For Kubernetes v1.17+
    • Enable --allow-privileged=true on kube-apiserver, kube-controller-manager, kube-scheduler, kubelet.
    • Enable (Default enabled) Mount Propagation feature gate。
    • Enable (Default enabled) --feature-gates=CSINodeInfo=true,CSIDriverRegistry=true,ExpandCSIVolumes=true,VolumePVCDataSource=true option on kube-apiserver, kube-controller-manager, kube-scheduler, kubelet
    • Enable --read-only-port=10255 on kubelet
    • Install Snapshot CRD

      kubectl create -f https://raw.githubusercontent.com/kubernetes-csi/external-snapshotter/v2.1.1/config/crd/snapshot.storage.k8s.io_volumesnapshotclasses.yaml
      kubectl create -f https://raw.githubusercontent.com/kubernetes-csi/external-snapshotter/v2.1.1/config/crd/snapshot.storage.k8s.io_volumesnapshotcontents.yaml
      kubectl create -f https://raw.githubusercontent.com/kubernetes-csi/external-snapshotter/v2.1.1/config/crd/snapshot.storage.k8s.io_volumesnapshots.yaml
      

    • Install Snapshot Controller

      kubectl create -f https://raw.githubusercontent.com/kubernetes-csi/external-snapshotter/v2.1.1/deploy/kubernetes/snapshot-controller/rbac-snapshot-controller.yaml
      kubectl create -f https://raw.githubusercontent.com/kubernetes-csi/external-snapshotter/v2.1.1/deploy/kubernetes/snapshot-controller/setup-snapshot-controller.yaml
      

• Download installation file
  • For Kubernetes v1.16

$ wget https://raw.githubusercontent.com/yunify/qingcloud-csi/master/deploy/disk/kubernetes/releases/qingcloud-csi-disk-v1.16.yaml

• For Kubernetes v1.17

$ wget https://raw.githubusercontent.com/yunify/qingcloud-csi/master/deploy/disk/kubernetes/releases/qingcloud-csi-disk-v1.17.yaml

• Add QingCloud platform parameter on ConfigMap QingCloud CSI plugin manipulates cloud resource by QingCloud platform API. User must test the connection between QingCloud platform API and user's own instance by and check QingCloud platform configuration by QingCloud CLI.

  • Modify csi-qingcloud ConfigMap parameters in installation file

    qy_access_key_id: 'ACCESS_KEY_ID'
    qy_secret_access_key: 'ACCESS_KEY_SECRET'
    zone: 'ZONE'
    host: 'api.qingcloud.com'
    port: 443
    protocol: 'https'
    uri: '/iaas'
    connection_retries: 3
    connection_timeout: 30
    

    • qy_access_key_id, qy_secret_access_key: Access key pair can be created in QingCloud console. The access key pair must have the power to manipulate QingCloud IaaS platform resource.

    • zone: zone should be the same as Kubernetes cluster. CSI plugin will manipulate resources in this region or zone. For example, zone can be set to sh1 or ap2a.

    • host, port. protocol, uri: QingCloud IaaS platform service url.

• Deploy CSI plugin

IMPORTANT: If kubelet, a component of Kubernetes, set the --root-dir option (default: "/var/lib/kubelet"), please replace "/var/lib/kubelet" with the value of --root-dir at the CSI DaemonSet YAML file's spec.template.spec.containers[name=csi-qingcloud].volumeMounts[name=mount-dir].mountPath and spec.template.spec.volumes[name=mount-dir].hostPath.path fields. For instance, in Kubernetes cluster based on QingCloud AppCenter, you should replace "/var/lib/kubelet" with "/data/var/lib/kubelet" in the CSI DaemonSet YAML file.

$ kubectl apply -f qingcloud-csi-disk-v1.x.yaml

• Check CSI plugin

$ kubectl get pods -n kube-system --selector=app=csi-qingcloud
  NAME                                       READY   STATUS    RESTARTS   AGE
  csi-qingcloud-controller-5bd48bb49-dw9rs   5/5     Running   0          3h16m
  csi-qingcloud-node-d2kdt                   2/2     Running   0          3h16m
  csi-qingcloud-node-hvtq7                   2/2     Running   0          3h16m
  csi-qingcloud-node-njghb                   2/2     Running   0          3h16m
  csi-qingcloud-node-wssdt                   2/2     Running   0          3h16m

Uninstall

$ kubectl delete -f qingcloud-csi-disk-v1.x.yaml

Document

• User Guide
• Developer Guide

Support

If you have any qustions or suggestions, please submit an issue at qingcloud-csi