Deploy Mayastor

This website/page will be End-of-life (EOL) after 31 August 2024. We recommend you to visit OpenEBS Documentation for the latest Mayastor documentation (v2.6 and above).

Mayastor is now also referred to as OpenEBS Replicated PV Mayastor.

Overview

Before deploying and using Mayastor please consult the Known Issues section of this guide.

In this Quickstart guide we demonstrate deploying Mayastor by using the Kubernetes manifest files provided within the project's repositories (control plane components, data plane components). These repositories are configured for the GitFlow release model, wherein the master branch contains official releases. By extension, the head of the master branch represents the latest official release. Previous releases are identifiable by their annotated git tags.

The steps and commands which follow are intended only for use with, and have only be tested against, the latest release for version 1.x. Earlier releases or development versions may require a modified or different installation process and will require that the manifest files appropriate to that specific release are used. These are available in the repositories named above - use the files from the tagged commit appropriate to the release you wish to deploy.

Create Mayastor Application Resources

Namespace

Command (GitHub Latest)

kubectl create namespace mayastor

RBAC Resources

Command (GitHub Latest)

kubectl apply -f https://raw.githubusercontent.com/openebs/mayastor-control-plane/v1.0.5/deploy/operator-rbac.yaml

Expected Output

Custom Resource Definitions

Command (GitHub Latest)

kubectl apply -f https://raw.githubusercontent.com/openebs/mayastor-control-plane/v1.0.5/deploy/mayastorpoolcrd.yaml

Deploy Mayastor Dependencies

NATS

Mayastor uses NATS, an Open Source messaging system, as an event bus for some aspects of control plane operations.

Command (GitHub Latest)

kubectl apply -f https://raw.githubusercontent.com/openebs/mayastor/v1.0.5/deploy/nats-deployment.yaml

Verify that the deployment of the NATS application to the cluster was successful. Within the mayastor namespace ensure that there are 3 replicas with the name "nats-x", and with a reported status of "Running".

Command

kubectl -n mayastor get pods --selector=app=nats

Example Output

etcd

Mayastor uses etcd, a distributed, reliable key-value store, to persist configuration. The steps described below deploy a dedicated, clustered etcd instance for Mayastor's own use. This is the only configuration supported by this release.

To deploy the PersistentVolumes that will be used by the etcd in the next step, execute:

Command (GitHub Latest)

kubectl apply -f https://raw.githubusercontent.com/openebs/mayastor/v1.0.5/deploy/etcd/storage/localpv.yaml

Command (GitHub Latest)

kubectl apply -f https://raw.githubusercontent.com/openebs/mayastor/v1.0.5/deploy/etcd/statefulset.yaml 
kubectl apply -f https://raw.githubusercontent.com/openebs/mayastor/v1.0.5/deploy/etcd/svc.yaml
kubectl apply -f https://raw.githubusercontent.com/openebs/mayastor/v1.0.5/deploy/etcd/svc-headless.yaml

Verify that the deployment of etcd to the cluster was successful. Within the mayastor namespace there should be 3 replicas with a name of the form "mayastor-etcd-" and with a reported status of "Running".

Command

kubectl -n mayastor get pods --selector=app.kubernetes.io/name=etcd

Example Output

Deploy Mayastor Components

CSI Node Plugin

Command (GitHub Latest)

kubectl apply -f https://raw.githubusercontent.com/openebs/mayastor/v1.0.5/deploy/csi-daemonset.yaml

Verify that the CSI Node Plugin DaemonSet has been correctly deployed to all worker nodes in the cluster.

Command

kubectl -n mayastor get daemonset mayastor-csi

Example Output

Control Plane

Core Agents

Command (GitHub Latest)

kubectl apply -f https://raw.githubusercontent.com/openebs/mayastor-control-plane/v1.0.5/deploy/core-agents-deployment.yaml

Verify that the core agent pod is running.

Command

kubectl get pods -n mayastor --selector=app=core-agents

Example Output

REST

Command (GitHub Latest)

kubectl apply -f https://raw.githubusercontent.com/openebs/mayastor-control-plane/v1.0.5/deploy/rest-deployment.yaml
kubectl apply -f https://raw.githubusercontent.com/openebs/mayastor-control-plane/v1.0.5/deploy/rest-service.yaml

Example Output

Verify that the REST pod is running.

Command

kubectl get pods -n mayastor --selector=app=rest

Example Output

CSI Controller

Command (GitHub Latest)

kubectl apply -f https://raw.githubusercontent.com/openebs/mayastor-control-plane/v1.0.5/deploy/csi-deployment.yaml

Verify that the CSI-controller pod is running.

Command

kubectl get pods -n mayastor --selector=app=csi-controller

Example Output

MSP Operator

Command (GitHub Latest)

kubectl apply -f https://raw.githubusercontent.com/openebs/mayastor-control-plane/v1.0.5/deploy/msp-deployment.yaml

Verify that the pool operator pod is running.

Command

kubectl get pods -n mayastor --selector=app=msp-operator

Example Output

Data Plane

Command (GitHub Latest)

kubectl apply -f https://raw.githubusercontent.com/openebs/mayastor/v1.0.5/deploy/mayastor-daemonset.yaml

Verify that the Mayastor DaemonSet has been correctly deployed. The reported Desired, Ready and Available instance counts should be equal, and should match the count of worker nodes which carry the label openebs.io/engine=mayastor (as performed earlier in the "Preparing the Cluster" stage).

Command

kubectl -n mayastor get daemonset mayastor

Example Output

The number and status of mayastor pods can be observed by using the Mayastor kubectl plugin. Check that the expected number of nodes are reporting their State as online

Command

kubectl mayastor get nodes

Example Output