/csi-baremetal-operator

Primary LanguageGoApache License 2.0Apache-2.0

PR validation codecov

Bare-metal CSI Operator

Kubernetes Operator to deploy and manage lifecycle of Bare-Metal CSI Driver

Supported environments

  • Kubernetes: 1.18, 1.19, 1.20, 1.21
  • OpenShift: 4.6
  • Node OS:
    • Ubuntu 18.04 / 20.04 LTS
    • Red Hat Enterprise Linux 7.7 / CoreOS 4.6
    • CentOS Linux 7 / 8
  • Helm: 3.0

Installation process

  • Prerequisites

    • lvm2 packet installed on the Kubernetes nodes
    • helm v3+
    • kubectl v1.16+

  • Add helm repository

    helm repo add csi https://dell.github.io/csi-baremetal-operator
helm repo update
helm search repo csi --devel -l

  • Setup environment variables

    export REGISTRY=docker.io/objectscale
export DOCKER_REGISTRY_SECRET=dockerhub-pull-secret

  • Create docker registry secret

    kubectl create secret docker-registry $DOCKER_REGISTRY_SECRET --docker-username=<USER NAME> \
--docker-password=<PASSWORD> --docker-email=<EMAIL>

  • Install CSI Operator

    helm install csi-baremetal-operator csi/csi-baremetal-operator --devel --set global.registry=$REGISTRY \
--set global.registrySecret=$DOCKER_REGISTRY_SECRET

  • Install CSI

    • Vanilla Kubernetes 
      helm install csi-baremetal csi/csi-baremetal-deployment --devel --set scheduler.patcher.enable=true \
--set global.registry=$REGISTRY --set global.registrySecret=$DOCKER_REGISTRY_SECRET
    • RKE2 
      helm install csi-baremetal csi/csi-baremetal-deployment --devel --set scheduler.patcher.enable=true \
--set platform=rke --set global.registry=$REGISTRY --set global.registrySecret=$DOCKER_REGISTRY_SECRET
    • OpenShift 
      helm install csi-baremetal csi/csi-baremetal-deployment --devel --set scheduler.patcher.enable=true \
--set platform=openshift --set global.registry=$REGISTRY --set global.registrySecret=$DOCKER_REGISTRY_SECRET
    • Kind (for testing purposes only) 
      helm install csi-baremetal csi/csi-baremetal-deployment --devel --set scheduler.patcher.enable=true \
--set driver.drivemgr.type=loopbackmgr --set driver.drivemgr.deployConfig=true --set global.registry=$REGISTRY \
--set global.registrySecret=$DOCKER_REGISTRY_SECRET
    • Not supported platform or system with third party Kubernetes scheduler extender - refer documentation for manual patching of Kubernetes scheduler configuration 
      helm install csi-baremetal csi/csi-baremetal-deployment --devel --set global.registry=$REGISTRY \
--set global.registrySecret=$DOCKER_REGISTRY_SECRET

Usage

  • Storage classes

    • Use storage class without lvg postfix if you need to provision PV bypassing LVM. Size of the resulting PV will be equal to the size of underlying physical drive.

    • Use storage class with lvg postfix if you need to provision PVC based on the logical volume. Size of the resulting PV will be equal to the size of PVC.

  • To obtain information about:

    • Node IDs assigned by CSI - kubectl get nodes.csi-baremetal.dell.com

    • Local Drives discovered by CSI - kubectl get drives.csi-baremetal.dell.com

    • Capacity available for allocation - kubectl get availablecapacities.csi-baremetal.dell.com

    • Provisioned logical volume groups - kubectl get logicalvolumegroups.csi-baremetal.dell.com

    • Provisioned volumes - kubectl get volumes.csi-baremetal.dell.com

Upgrade process

To upgrade please reference Installation process section but replace helm install by helm upgrade command

Uninstallation process

  • Delete custom resources 
    kubectl delete pvc --all
kubectl delete volumes --all -A
kubectl delete lvgs --all
kubectl delete csibmnodes --all
  • Delete helm releases 
    helm delete csi-baremetal
helm delete csi-baremetal-operator
  • Delete custom resource definitions 
    kubectl delete crd deployments.csi-baremetal.dell.com availablecapacities.csi-baremetal.dell.com \
availablecapacityreservations.csi-baremetal.dell.com logicalvolumegroups.csi-baremetal.dell.com \
volumes.csi-baremetal.dell.com drives.csi-baremetal.dell.com nodes.csi-baremetal.dell.com