--- title: 'Addon: OpenEBS Mayastor clustered storage v2.0.0' description: Canonical makes open source secure, reliable and easy to use, providing support for Ubuntu and a portfolio of enterprise-grade technologies. Founded in 2004, Canonical operates globally with team members in over 80 countries. url: https://canonical.com/microk8s/docs/addon-mayastor?format=md --- *Submit* # Addon: OpenEBS Mayastor clustered storage v2.0.0 **Compatibility**: **Source**: [Mayastor](https://github.com/openebs/mayastor) MicroK8s supports a cluster-ready replicated storage solution based on OpenEBS [Mayastor](https://github.com/openebs/mayastor). This does require some initial setup and configuration, as detailed below. **Note:** This documentation page describes the Mayastor addon v2.0.0, available in MicroK8s 1.27 or newer. For Mayastor v1.0.0 found in previous versions, see [mayastor v1.0.0](https://canonical.com/microk8s/docs/addon-mayastor-1) ## [Requirements](https://canonical.com/microk8s/docs/addon-mayastor?format=md#p-38896-requirements) **Note:** These requirements apply to **ALL** the nodes in a MicroK8s cluster. Please run the commands on each node. 1. HugePages must be enabled. Mayastor requires at least 1024 4MB HugePages. This can be achieved by running the following commands *on each host*: ``` sudo sysctl vm.nr_hugepages=1024 echo 'vm.nr_hugepages=1024' | sudo tee -a /etc/sysctl.conf ``` 2. The `nvme_fabrics` and `nvme_tcp` modules are required on all hosts. Install the modules with: ``` sudo apt install -y linux-modules-extra-$(uname -r) ``` Then enable them with: ``` sudo modprobe nvme_tcp echo 'nvme-tcp' | sudo tee -a /etc/modules-load.d/microk8s-mayastor.conf ``` 3. If MicroK8s is already installed, you should restart MicroK8s at this point: ``` microk8s stop microk8s start ``` 4. The MicroK8s [DNS](https://canonical.com/microk8s/docs/addon-dns) and Helm3 addons. These will be automatically installed if missing. ## [Installation](https://canonical.com/microk8s/docs/addon-mayastor?format=md#p-38896-installation) Assuming you have configured your cluster as mentioned above, you can now enable Mayastor. 1. Enable the Mayastor addon: ``` sudo microk8s enable core/mayastor --default-pool-size 20G ``` 2. Wait for the mayastor control plane and data plane pods to come up: ``` microk8s kubectl get pod -n mayastor ``` 3. The mayastor addon will automatically create one DiskPool per node in the MicroK8s cluster. This pool is backed by a sparse image file. Refer to the [Mayastor documentation](https://mayastor.gitbook.io/introduction/quickstart/configure-mayastor#create-diskpool-s) for information on using existing block devices. Verify that all diskpools are up and running with: ``` microk8s kubectl get diskpool -n mayastor ``` In a 3-node cluster, the output should look like this: ``` NAME NODE STATUS CAPACITY USED AVAILABLE microk8s-m2-pool m2 Online 21449670656 0 21449670656 microk8s-m1-pool m1 Online 21449670656 0 21449670656 microk8s-m3-pool m3 Online 21449670656 0 21449670656 ``` Mayastor is now deployed! ## [Deploy a test workload](https://canonical.com/microk8s/docs/addon-mayastor?format=md#p-38896-deploy-a-test-workload) The `mayastor` addon creates two storage classes: * `mayastor`: This can be used in single-node clusters. * `mayastor-3`: This requires at least 3 cluster nodes, as it replicates volume data across 3 storage pools, ensuring data redundancy. Let’s create a simple pod that uses the `mayastor` storage class: ``` # pod-with-pvc.yaml --- apiVersion: v1 kind: PersistentVolumeClaim metadata: name: test-pvc spec: storageClassName: mayastor accessModes: [ReadWriteOnce] resources: { requests: { storage: 5Gi } } --- apiVersion: v1 kind: Pod metadata: name: test-nginx spec: volumes: - name: pvc persistentVolumeClaim: claimName: test-pvc containers: - name: nginx image: nginx ports: - containerPort: 80 volumeMounts: - name: pvc mountPath: /usr/share/nginx/html ``` Then, create the pod with: ``` microk8s kubectl create -f pod-with-pvc.yaml ``` Verify that our PVC and pod have been created with: ``` microk8s kubectl get pod,pvc ``` The output should look like this: ``` NAME READY STATUS RESTARTS AGE pod/test-nginx 1/1 Running 0 4m NAME STATUS VOLUME CAPACITY ACCESS MODES STORAGECLASS AGE persistentvolumeclaim/test-pvc Bound pvc-e280b734-3224-4af3-af0b-e7ad3c4e6d79 5Gi RWO mayastor 4m ``` ## [Configure storage classes](https://canonical.com/microk8s/docs/addon-mayastor?format=md#p-38896-configure-storage-classes) For advanced use-cases, it is possible to define a custom storage class and configure parameters for the number of replicas, the underlying protocol etc. For example, to define a storage class with 2 replicas, execute the following: ``` microk8s kubectl apply -f - <