This website/page will be End-of-life (EOL) after 31 August 2024. We recommend you to visit 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 section of this guide.
In this Quickstart guide we demonstrate deploying Mayastor by using the Kubernetes manifest files provided within the project's repositories (, ). 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.
serviceaccount/mayastor-service-account created
clusterrole.rbac.authorization.k8s.io/mayastor-cluster-role created
clusterrolebinding.rbac.authorization.k8s.io/mayastor-cluster-role-binding created
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".
kubectl -n mayastor get pods --selector=app=nats
NAME READY STATUS RESTARTS AGE
nats-0 2/2 Running 0 50s
nats-1 2/2 Running 0 30s
nats-2 2/2 Running 0 10s
etcd
To deploy the PersistentVolumes that will be used by the etcd in the next step, execute:
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".
kubectl -n mayastor get pods --selector=app.kubernetes.io/name=etcd
NAME READY STATUS RESTARTS AGE
mayastor-etcd-0 1/1 Running 0 70m
mayastor-etcd-1 1/1 Running 0 70m
mayastor-etcd-2 1/1 Running 0 70m
NAME DESIRED CURRENT READY UP-TO-DATE AVAILABLE NODE SELECTOR AGE
mayastor 3 3 3 3 3 kubernetes.io/arch=amd64,openebs.io/engine=mayastor 108s
kubectl mayastor get nodes
NAME STATE AGE
aks-agentpool-12194210-0 online 8m18s
aks-agentpool-12194210-1 online 8m19s
aks-agentpool-12194210-2 online 8m15s
Mayastor uses , an Open Source messaging system, as an event bus for some aspects of control plane operations.
Mayastor uses , 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.
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 "" stage).
The number and status of mayastor pods can be observed by using the . Check that the expected number of nodes are reporting their State as online
