Integrate with Container Storage Interface (CSI)

Để integrate CSI với Kubernetes cluser, hãy làm theo các bước sau đây:

Chuẩn bị

• Tạo một Kubernetes cluster trên VNGCloud, hoặc sử dụng một cluster đã có. Lưu ý: đảm bảo bạn đã tải xuống cluster configuration file sau khi cluster được khởi tạo thành công và truy cập vào cluster của bạn.

Khởi tạo Service Account và cài đặt VNGCloud BlockStorage CSI Driver

Chú ý:

• Khi bạn thực hiện khởi tạo Cluster theo hướng dẫn bên trên, nếu bạn chưa bật option Enable BlockStore Persistent Disk CSI Driver, mặc định chúng tôi sẽ không cài sẵn plugin này vào Cluster của bạn. Bạn cần tự thực hiện Khởi tạo Service Account và cài đặt VNGCloud BlockStorage CSI Driver theo hướng dẫn bên dưới. Nếu bạn đã bật option Enable BlockStore Persistent Disk CSI Driver, thì chúng tôi đã cài sẵn plugin này vào Cluster của bạn, hãy bỏ qua bước Khởi tạo Service Account, cài đặt VNGCloud BlockStorage CSI Driver và tiếp tục thực hiện theo hướng dẫn kể từ Deploy một Workload.

• VNGCloud BlockStorage CSI Driver chỉ hỗ trợ attach volume với một node (VM) duy nhất trong suốt vòng đời của volume đó. Nếu bạn có nhu cầu ReadWriteMany, bạn có thể cân nhắc sử dụng NFS CSI Driver, vì nó cho phép nhiều nodes có thể Read và Write trên cùng một volume cùng một lúc. Điều này rất hữu ích cho các ứng dụng cần chia sẻ dữ liệu giữa nhiều pods hoặc services trong Kubernetes.

Khởi tạo Service Account và cài đặt VNGCloud BlockStorage CSI Driver

Khởi tạo Service Account

• Khởi tạo hoặc sử dụng một service account đã tạo trên IAM và gắn policy: vServerFullAccess. Để tạo service account bạn truy cập tại đây và thực hiện theo các bước sau:

  • Chọn "Create a Service Account", điền tên cho Service Account và nhấn Next Step để gắn quyền cho Service Account

  • Tìm và chọn Policy: vServerFullAccess, sau đó nhấn "Create a Service Account" để tạo Service Account, Policy: vLBFullAccess vàPolicy: vServerFullAccess do VNG Cloud tạo ra, bạn không thể xóa các policy này.

  • Sau khi tạo thành công bạn cần phải lưu lại Client_ID và Secret_Key của Service Account để thực hiện bước tiếp theo.

Cài đặt VNGCloud BlockStorage CSI Driver

• Cài đặt Helm phiên bản từ 3.0 trở lên. Tham khảo tại https://helm.sh/docs/intro/install/ để biết cách cài đặt.

• Thêm repo này vào cluster của bạn qua lệnh:

  helm repo add vks-helm-charts https://vngcloud.github.io/vks-helm-charts
  helm repo update

• Thay thế thông tin ClientID, Client Secret và ClusterID của cụm K8S của bạn và tiếp tục chạy:

  helm install vngcloud-blockstorage-csi-driver vks-helm-charts/vngcloud-blockstorage-csi-driver \
    --replace --namespace kube-system \
    --set vngcloudAccessSecret.keyId=${VNGCLOUD_CLIENT_ID} \
    --set vngcloudAccessSecret.accessKey=${VNGCLOUD_CLIENT_SECRET} \
    --set vngcloudAccessSecret.vksClusterId=${VNGCLOUD_VKS_CLUSTER_ID}  # Optional

• Sau khi việc cài đặt hoàn tất, thực hiện kiểm tra trạng thái của vngcloud-blockstorage-csi-driver pods:

  kubectl get pods -n kube-system | grep vngcloud-csi-

• Ví dụ như ảnh bên dưới là bạn đã cài đặt thành công vngcloud-blockstorage-csi-driver:

  NAME                                           READY   STATUS    RESTARTS       AGE
  vngcloud-csi-controller-56bd7b85f-ctpns        7/7     Running   6 (2d4h ago)   2d4h
  vngcloud-csi-controller-56bd7b85f-npp9n        7/7     Running   2 (2d4h ago)   2d4h
  vngcloud-csi-node-c8r2w                        3/3     Running   0              2d4h

---

Deploy một Workload

Sau đây là hướng dẫn để bạn deploy service nginx trên Kubernetes.

Bước 1: Tạo Deployment cho Nginx app.

• Tạo file nginx-service.yaml với nội dung sau:

  apiVersion: apps/v1
  kind: Deployment
  metadata:
    name: nginx-app
  spec:
    selector:
      matchLabels:
        app: nginx
    replicas: 1
    template:
      metadata:
        labels:
          app: nginx
      spec:
        containers:
        - name: nginx
          image: nginx:1.19.1
          ports:
          - containerPort: 80
  ---
  apiVersion: v1
  kind: Service
  metadata:
    name: nginx-service
  spec:
    selector:
      app: nginx 
    ports:
      - protocol: TCP
        port: 80
        targetPort: 80

• Deploy Deployment này bằng lệch:

  kubectl apply -f nginx-service.yaml

---

Bước 2: Kiểm tra thông tin Deployment, Service vừa deploy

• Chạy câu lệnh sau đây để kiểm tra Deployment

  kubectl get svc,deploy,pod -owide
• Nếu kết quả trả về như bên dưới tức là bạn đã deploy Deployment thành công.

  NAME                    TYPE           CLUSTER-IP      EXTERNAL-IP   PORT(S)           AGE     SELECTOR
  service/kubernetes      ClusterIP      10.96.0.1       <none>        443/TCP           2d4h    <none>
  service/nginx-app       NodePort       10.96.215.192   <none>        30080:31289/TCP   6m12s   app=nginx
  service/nginx-service   LoadBalancer   10.96.179.221   <pending>     80:32624/TCP      16s     app=nginx
  
  NAME                        READY   UP-TO-DATE   AVAILABLE   AGE   CONTAINERS   IMAGES         SELECTOR
  deployment.apps/nginx-app   1/1     1            1           16s   nginx        nginx:1.19.1   app=nginx
  
  NAME                             READY   STATUS    RESTARTS   AGE   IP              NODE                                            NOMINATED NODE   READINESS GATES
  pod/nginx-app-7f45b65946-t7d7k   1/1     Running   0          16s   172.16.24.202   ng-3f06013a-f6a5-47ba-a51f-bc5e9c2b10a7-ecea1   <none>           <none>

---

Tạo Persistent Volume

• Tạo file persistent-volume.yaml với nội dung sau:

  apiVersion: storage.k8s.io/v1
  kind: StorageClass
  metadata:
    name: my-expansion-storage-class                    # [1] The StorageClass name, CAN be changed
  provisioner: bs.csi.vngcloud.vn                       # The VNG-CLOUD CSI driver name
  parameters:
    type: vtype-61c3fc5b-f4e9-45b4-8957-8aa7b6029018    # The volume type UUID
  allowVolumeExpansion: true                            # MUST set this value to turn on volume expansion feature
  ---
  
  apiVersion: v1
  kind: PersistentVolumeClaim
  metadata:
    name: my-expansion-pvc                           # [2] The PVC name, CAN be changed
  spec:
    accessModes:
      - ReadWriteOnce
    resources:
      requests:
        storage: 20Gi                                # [3] The PVC size, CAN be changed, this value MUST be in the valid range of the proper volume type
    storageClassName: my-expansion-storage-class     # [4] The StorageClass name, MUST be the same as [1]
  ---
  
  apiVersion: v1
  kind: Pod
  metadata:
    name: nginx                                      # [5] The Pod name, CAN be changed
  spec:
    containers:
      - image: nginx
        imagePullPolicy: IfNotPresent
        name: nginx
        ports:
          - containerPort: 80
            protocol: TCP
        volumeMounts:
          - mountPath: /var/lib/www/html
            name: my-volume-name                     # MUST be the same as [6]
    volumes:
      - name: my-volume-name                         # [6] The volume name, CAN be changed
        persistentVolumeClaim:
          claimName: my-expansion-pvc                # MUST be the same as [2]
          readOnly: false
• Chạy câu lệnh sau đây để triển khai 1 Pod sử dụng Persistent Volume

  kubectl apply -f persistent-volume.yaml

Lúc này, hệ thống vServer sẽ tự động tạo một Volume tương ứng với file yaml bên trên, ví dụ:

---

Tạo Snapshot

Snapshot là phương pháp sao lưu giữ liệu với chi phí thấp, thuận tiện và hiệu quả và có thể được sử dụng để tạo image, phục hồi dữ liệu và phân phối các bản sao dữ liệu. Nếu bạn là người dùng mới chưa từng sử dụng dịch vụ Snapshot, bạn cần thực hiện Activate Snapshot Service (Kích hoạt dịch vụ Snapshot) trước khi có thể tạo Snapshot cho Persistent Volume của bạn.

Activate Snapshot Service

Để có thể tạo Snapshot, bạn cần thực hiện Activate Snapshot Service. Bạn sẽ không bị tính phí khi kích hoạt dịch vụ snapshot. Sau khi bạn tạo snapshot, chi phí sẽ được tính dựa trên dung lượng lưu trữ và thời gian lưu trữ của các bản snapshot này. Thực hiện theo các bước sau đây để kích hoạt dịch vụ Snapshot:

Bước 1: Truy cập vào https://hcm-3.console.vngcloud.vn/vserver/block-store/snapshot/overview

Bước 2: Chọn Activate Snapshot Service.

Ví dụ:

Cài đặt VNGCloud Snapshot Controller

• Cài đặt Helm phiên bản từ 3.0 trở lên. Tham khảo tại https://helm.sh/docs/intro/install/ để biết cách cài đặt.
• Thêm repo này vào cluster của bạn qua lệnh:

  helm repo add vks-helm-charts https://vngcloud.github.io/vks-helm-charts
  helm repo update
• Tiếp tục chạy:

  helm install vngcloud-snapshot-controller vks-helm-charts/vngcloud-snapshot-controller \
    --replace --namespace kube-system
• Sau khi việc cài đặt hoàn tất, thực hiện kiểm tra trạng thái của vngcloud-blockstorage-csi-driver pods:

  kubectl get pods -n kube-system | grep snapshot-controller

Ví dụ như ảnh bên dưới là bạn đã cài đặt thành công vngcloud-snapshot-controller:

NAME                                           READY   STATUS              RESTARTS       AGE
snapshot-controller-7fdd984f89-745tg           0/1     ContainerCreating   0              3s
snapshot-controller-7fdd984f89-k94wq           0/1     ContainerCreating   0              3s

Tạo file snapshot.yaml với nội dung sau

apiVersion: snapshot.storage.k8s.io/v1
kind: VolumeSnapshotClass
metadata:
  name: my-snapshot-storage-class  # [2] The name of the volume snapshot class, CAN be changed
driver: bs.csi.vngcloud.vn
deletionPolicy: Delete
parameters:
  force-create: "false"
---

apiVersion: snapshot.storage.k8s.io/v1
kind: VolumeSnapshot
metadata:
  name: my-snapshot-pvc  # [4] The name of the snapshot, CAN be changed
spec:
  volumeSnapshotClassName: my-snapshot-storage-class  # MUST match with [2]
  source:
    persistentVolumeClaimName: my-expansion-pvc  # MUST match with [3]

• Chạy câu lệnh sau đây để triển khai Volume Snapshot

kubectl apply -f snapshot.yaml

---

Kiểm tra PVC và Snapshot vừa tạo

• Sau khi apply tập tin thành công, bạn có thể kiểm tra danh sách service, pvc thông qua:

  kubectl get sc,pvc,pod -owide

  NAME                                                       PROVISIONER          RECLAIMPOLICY   VOLUMEBINDINGMODE   ALLOWVOLUMEEXPANSION   AGE
  storageclass.storage.k8s.io/my-expansion-storage-class     bs.csi.vngcloud.vn   Delete          Immediate           true                   10m
  storageclass.storage.k8s.io/sc-iops-200-retain (default)   bs.csi.vngcloud.vn   Retain          Immediate           false                  2d4h
  
  NAME                                     STATUS   VOLUME                                     CAPACITY   ACCESS MODES   STORAGECLASS                 AGE   VOLUMEMODE
  persistentvolumeclaim/my-expansion-pvc   Bound    pvc-14456f4a-ee9e-435d-a94f-5a2e820954e9   20Gi       RWO            my-expansion-storage-class   10m   Filesystem
  
  NAME                             READY   STATUS    RESTARTS   AGE   IP              NODE                                            NOMINATED NODE   READINESS GATES
  pod/nginx                        1/1     Running   0          10m   172.16.24.203   ng-3f06013a-f6a5-47ba-a51f-bc5e9c2b10a7-ecea1   <none>           <none>
  pod/nginx-app-7f45b65946-t7d7k   1/1     Running   0          94m   172.16.24.202   ng-3f06013a-f6a5-47ba-a51f-bc5e9c2b10a7-ecea1   <none>           <none>

---

Thay đổi thông số IOPS của Persistent Volume vừa tạo

Để thay đổi thông số IOPS của Persistent Volume vừa tạo, hãy thực hiện theo các bước sau đây:

Bước 1: Chạy lệnh bên dưới để liệt kê các PVC trong Cluster của bạn

kubectl get persistentvolumes

Bước 2: Chỉnh sửa tệp tin YAML của PVC theo lệnh

kubectl edit pvc my-expansion-pvc

• Nếu bạn chưa chỉnh sửa IOPS của Persistent Volume lần nào trước đó, khi bạn chạy lệnh trên, bạn hãy thêm 1 annotation bs.csi.vngcloud.vn/volume-type: "volume-type-id" . Ví dụ: bên dưới tôi đang thay đổi IOPS của Persistent Volume từ 200 (Volume type id = vtype-61c3fc5b-f4e9-45b4-8957-8aa7b6029018) lên 1000 (Volume type id = vtype-85b39362-a360-4bbb-9afa-a36a40cea748)

  apiVersion: v1
  kind: PersistentVolumeClaim
  metadata:
    annotations:
      bs.csi.vngcloud.vn/volume-type: "vtype-85b39362-a360-4bbb-9afa-a36a40cea748"
      kubectl.kubernetes.io/last-applied-configuration: |
        {"apiVersion":"v1","kind":"PersistentVolumeClaim","metadata":{"annotations":{},"name":"my-expansion-pvc","namespace":"default"},"spec":{"accessModes":["ReadWriteOnce"],"resources":{"requests":{"storage":"20Gi"}},"storageClassName":"my-expansion-storage-class"}}
      pv.kubernetes.io/bind-completed: "yes"
      pv.kubernetes.io/bound-by-controller: "yes"
      volume.beta.kubernetes.io/storage-provisioner: bs.csi.vngcloud.vn
      volume.kubernetes.io/storage-provisioner: bs.csi.vngcloud.vn
    creationTimestamp: "2024-04-21T14:16:53Z"
    finalizers:
    - kubernetes.io/pvc-protection
    name: my-expansion-pvc
    namespace: default
    resourceVersion: "11041591"
    uid: 14456f4a-ee9e-435d-a94f-5a2e820954e9
  spec:
    accessModes:
    - ReadWriteOnce
    resources:
      requests:
        storage: 20Gi
    storageClassName: my-expansion-storage-class
    volumeMode: Filesystem
    volumeName: pvc-14456f4a-ee9e-435d-a94f-5a2e820954e9
  status:
    accessModes:
    - ReadWriteOnce
    capacity:
      storage: 20Gi
    phase: Bound
• Nếu bạn đã chỉnh sửa IOPS của Persistent Volume lần nào trước đó, khi bạn chạy lệnh trên, tệp tin yaml của bạn đã có sẵn annotation bs.csi.vngcloud.vn/volume-type: "volume-type-id" . Lúc này, hãy chỉnh sửa annotation này về Volume type id có IOPS mà bạn mong muốn.

Thay đổi Disk Volume của Persistent Volume vừa tạo

Để thay đổi Disk Volume của Persistent Volume vừa tạo, hãy thực hiện chạy lệnh sau:

Ví dụ: ban đầu PVC được tạo có kích cỡ 20 Gi, hiện tại tôi sẽ tăng nó lên 30Gi

kubectl patch pvc my-expansion-pvc -p '{"spec":{"resources":{"requests":{"storage":"30Gi"}}}}'

Chú ý:

• Bạn chỉ có thể thực hiện tăng Disk Volume mà không thể thực hiện giảm kích thước Disk Volume này.

Restore Persistent Volume từ Snapshot

Để khôi phục Persistent Volume từ Snapshot, bạn hãy thực hiện theo các bước sau:

• Tạo file restore-volume.yaml với nội dung sau:

  apiVersion: v1
  kind: PersistentVolumeClaim
  metadata:
    name: my-restore-pvc  # The name of the PVC, CAN be changed
  spec:
    storageClassName: my-expansion-storage-class  
    dataSource:
      name: my-snapshot-pvc # MUST match with [4] from the section 5.2
      kind: VolumeSnapshot
      apiGroup: snapshot.storage.k8s.io
    accessModes:
      - ReadWriteOnce
    resources:
      requests:
        storage: 20Gi