How to Deploy PortWorx as a Storage Backend for your Kubernetes Cluster using CSI

Introduction

This guide provides step by step instructions for configuring Portworx storage as a backend for persistent volumes created on your Kubernetes cluster.

Prerequisites

A valid Kubernetes cluster. You can create one quickly for free using Platform9 Managed Kubernetes. Signup for a Free PMK Account Here and create your Kubernetes cluster using PMK. You can also use this guide on any other Kubernetes cluster you may have.
A Kubectl installation with your Kubernetes cluster from the step above configured as the primary cluster.
A Portworx installation that is setup with CSI enabled. If your Portworx installation isn't setup with CSI enabled, view the Portworx document here to enable CSI.

This tutorial will use a Platform9 Managed Kubernetes Free Tier cluster, however you can use this tutorial to configure Portworx storage on any other Kubernetes cluster of your choice.

Step 1 - Create a Storage Class for Portworx

Once Portworx installation is running you need to create a storage class with the fowling configuration, this can be applied via the Platform9 UI using the Storage Class dashboards.

 YAML 
    
xxxxxxxxxx
 
kind: StorageClassapiVersion: storage.k8s.io/v1metadata:  name: portworx-csi-scprovisioner: pxd.portworx.comparameters:  repl: "1"
Copy

Next, enter the details for the storage class.

Finally, review the configuration, ensure it matches the example below including the replication parameter at the bottom of the YAML spec. Once the YAML is correct click Complete and Platform9 will create the storage class.

 YAML 
    
xxxxxxxxxx
 
kind: StorageClassapiVersion: storage.k8s.io/v1metadata:  name: portworx-csi-scprovisioner: pxd.portworx.comparameters:  repl: "1"
Copy

You Portworx storage class is now created and should be listed under the Storage Classes tab.

Step 2 - Create a Test PVC

You can test the CSI based storage class by creating a Kubernetes Persistent Volume Claim (PVC) with the following YAML spec and applying it to your cluster. Copy the YAML to a file locally and use kubectl to add the PVC. Ensure the StorageClassName matches the storage class that you created above

 YAML 
    
xxxxxxxxxx
 
kind: PersistentVolumeClaimapiVersion: v1metadata:   name: px-mysql-pvcspec:   storageClassName: portworx-csi-sc   accessModes:     - ReadWriteOnce   resources:     requests:       storage: 2Gi
Copy

Create the PVC from the YAML file with the command below:

 Bash 
    
xxxxxxxxxx
 
kubectl apply -f pvc-test-portworx.yaml
Copy

 output 
    
xxxxxxxxxx
 
persistentvolumeclaim/px-mysql-pvc created
Copy

To view the state of the PVC run

 Bash 
    
xxxxxxxxxx
 
kubectl get pvc px-mysql-pvc
Copy

 Output 
    
xxxxxxxxxx
 
NAME           STATUS   VOLUME                                     CAPACITY   ACCESS MODES   STORAGECLASS      AGEpx-mysql-pvc   Bound    pvc-81fae0ac-fda5-43e3-a760-d93359079896   2Gi        RWO            portworx-csi-sc   8s
Copy

Step 3 - Create MySQL Using the PVC

The following YAML spec creates an example MySQL application that uses the new PVC.

 YAML 
    
xxxxxxxxxx
 
apiVersion: apps/v1kind: Deploymentmetadata:  name: mysqlspec:  selector:    matchLabels:      app: mysql  strategy:    rollingUpdate:      maxSurge: 1      maxUnavailable: 1    type: RollingUpdate  replicas: 1  template:    metadata:      labels:        app: mysql        version: "1"    spec:      containers:      - image: mysql:5.6        name: mysql        env:        - name: MYSQL_ROOT_PASSWORD          value: password        ports:        - containerPort: 3306        volumeMounts:        - name: mysql-persistent-storage          mountPath: /var/lib/mysql      volumes:      - name: mysql-persistent-storage        persistentVolumeClaim:          claimName: px-mysql-pvc
Copy

Use Kubectl to apply the spec.

 Bash 
    
xxxxxxxxxx
 
kubectl apply -f mysql-example.yaml
Copy

Run the following command to view the running deployment:

 Bash 
    
​x
 
kubectl get all -n defaultNAME                         READY   STATUS    RESTARTS   AGEpod/mysql-67f5996b5f-jwctm   1/1     Running   0          3m53s​NAME                 TYPE        CLUSTER-IP   EXTERNAL-IP   PORT(S)   AGEservice/kubernetes   ClusterIP   10.21.0.1    <none>        443/TCP   98m​NAME                    READY   UP-TO-DATE   AVAILABLE   AGEdeployment.apps/mysql   1/1     1            1           3m53s​NAME                               DESIRED   CURRENT   READY   AGEreplicaset.apps/mysql-67f5996b5f   1         1         1       3m53s
Copy

Last updated on Jan 24, 2022

Was this page helpful?