diff --git a/README.md b/README.md index 5dedcb8..f14656b 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,12 @@ description: 'The native NVMe-oF CAS engine of OpenEBS' --- # Welcome to Mayastor! +{% hint style="danger" %} +This website/page will be End-of-life (EOL) after 31 August 2024. We recommend you to visit [OpenEBS Documentation](https://openebs.io/docs/user-guides/replicated-storage-user-guide/replicated-pv-mayastor/rs-installation) for the latest Mayastor documentation (v2.6 and above). + +Mayastor is now also referred to as OpenEBS Replicated PV Mayastor. +{% endhint %} + ## What is Mayastor? **Mayastor** is a performance optimised "Container Attached Storage" (CAS) solution of the CNCF project [**OpenEBS**](https://openebs.io/). The goal of OpenEBS is to extend Kubernetes with a declarative data plane, providing flexible persistent storage for stateful applications. @@ -29,7 +35,3 @@ Mayastor's source code and documentation are distributed amongst a number of Git - [openebs/mayastor-dependencies](https://github.com/openebs/mayastor-dependencies) : contains dependencies common to the control and data plane repositories - [openebs/mayastor-extensions](https://github.com/openebs/mayastor-extensions) : contains components and utilities that provide extended functionalities like ease of installation, monitoring and observability aspects - [openebs/mayastor-docs](https://github.com/openebs/mayastor-docs) : contains Mayastor's user documenation - - - - diff --git a/basic-architecture.md b/basic-architecture.md index c454723..d673073 100644 --- a/basic-architecture.md +++ b/basic-architecture.md @@ -1,5 +1,11 @@ # Basic Architecture +{% hint style="danger" %} +This website/page will be End-of-life (EOL) after 31 August 2024. We recommend you to visit [OpenEBS Documentation](https://openebs.io/docs/user-guides/replicated-storage-user-guide/replicated-pv-mayastor/rs-installation) for the latest Mayastor documentation (v2.6 and above). + +Mayastor is now also referred to as OpenEBS Replicated PV Mayastor. +{% endhint %} + The objective of this section is to provide the user and evaluator of Mayastor with a topological view of the gross anatomy of a Mayastor deployment. A description will be made of the expected pod inventory of a correctly deployed cluster, the roles and functions of the constituent pods and related Kubernetes resource types, and of the high level interactions between them and the orchestration thereof. More detailed guides to Mayastor's components, their design and internal structure, and instructions for building Mayastor from source, are maintained within the [project's GitHub repository](https://github.com/openebs/Mayastor). diff --git a/quickstart/configure-mayastor.md b/quickstart/configure-mayastor.md index aa143f0..a9d5de3 100644 --- a/quickstart/configure-mayastor.md +++ b/quickstart/configure-mayastor.md @@ -1,7 +1,12 @@ # Configure Mayastor -## Create DiskPool\(s\) +{% hint style="danger" %} +This website/page will be End-of-life (EOL) after 31 August 2024. We recommend you to visit [OpenEBS Documentation](https://openebs.io/docs/user-guides/replicated-storage-user-guide/replicated-pv-mayastor/rs-installation) for the latest Mayastor documentation (v2.6 and above). + +Mayastor is now also referred to as OpenEBS Replicated PV Mayastor. +{% endhint %} +## Create DiskPool\(s\) ### What is a DiskPool? diff --git a/quickstart/deploy-a-test-application.md b/quickstart/deploy-a-test-application.md index e11f582..0fe97f5 100644 --- a/quickstart/deploy-a-test-application.md +++ b/quickstart/deploy-a-test-application.md @@ -1,5 +1,11 @@ # Deploy a Test Application +{% hint style="danger" %} +This website/page will be End-of-life (EOL) after 31 August 2024. We recommend you to visit [OpenEBS Documentation](https://openebs.io/docs/user-guides/replicated-storage-user-guide/replicated-pv-mayastor/rs-installation) for the latest Mayastor documentation (v2.6 and above). + +Mayastor is now also referred to as OpenEBS Replicated PV Mayastor. +{% endhint %} + ## Objective If all verification steps in the preceding stages were satisfied, then Mayastor has been successfully deployed within the cluster. In order to verify basic functionality, we will now dynamically provision a Persistent Volume based on a Mayastor StorageClass, mount that volume within a small test pod which we'll create, and use the [**Flexible I/O Tester**](https://github.com/axboe/fio) utility within that pod to check that I/O to the volume is processed correctly. diff --git a/quickstart/deploy-mayastor.md b/quickstart/deploy-mayastor.md index 850ac9b..68c4c3a 100644 --- a/quickstart/deploy-mayastor.md +++ b/quickstart/deploy-mayastor.md @@ -1,5 +1,11 @@ # Deploy Mayastor +{% hint style="danger" %} +This website/page will be End-of-life (EOL) after 31 August 2024. We recommend you to visit [OpenEBS Documentation](https://openebs.io/docs/user-guides/replicated-storage-user-guide/replicated-pv-mayastor/rs-installation) for the latest Mayastor documentation (v2.6 and above). + +Mayastor is now also referred to as OpenEBS Replicated PV Mayastor. +{% endhint %} + ## Overview {% hint style="note" %} diff --git a/quickstart/faqs.md b/quickstart/faqs.md index 10dd9fa..ed49f8b 100644 --- a/quickstart/faqs.md +++ b/quickstart/faqs.md @@ -1,5 +1,11 @@ # FAQs +{% hint style="danger" %} +This website/page will be End-of-life (EOL) after 31 August 2024. We recommend you to visit [OpenEBS Documentation](https://openebs.io/docs/user-guides/replicated-storage-user-guide/replicated-pv-mayastor/rs-installation) for the latest Mayastor documentation (v2.6 and above). + +Mayastor is now also referred to as OpenEBS Replicated PV Mayastor. +{% endhint %} + ## How does it help to keep my data safe? Mayastor's storage engine supports synchronous mirroring to enhance the durability of data at rest within whatever physical persistence layer is in use. When volumes are provisioned which are configured for replication \(a user can control the count of active replicas which should be maintained, on a per StorageClass basis\), write I/O operations issued by an application to that volume are amplified by its controller ("nexus") and dispatched to all its active replicas. Only if every replica completes the write successfully on its own underlying block device will the I/O completion be acknowledged to the controller. Otherwise, the I/O is failed and the caller must make its own decision as to whether it should be retried. If a replica is determined to have faulted \(I/O cannot be serviced within the configured timeout period, or not without error\), the control plane will automatically take corrective action and remove it from the volume. If spare capacity is available within a Mayastor pool, a new replica will be created as a replacement and automatically brought into synchronisation with the existing replicas. The data path for a replicated volume is described in more detail [here](https://github.com/openebs/mayastor-docs/blob/master/reference/i-o-path-description.md#replicated-volume-io-path) diff --git a/quickstart/known-issues.md b/quickstart/known-issues.md index e8a11a9..16f707b 100644 --- a/quickstart/known-issues.md +++ b/quickstart/known-issues.md @@ -1,5 +1,11 @@ # Known Issues +{% hint style="danger" %} +This website/page will be End-of-life (EOL) after 31 August 2024. We recommend you to visit [OpenEBS Documentation](https://openebs.io/docs/user-guides/replicated-storage-user-guide/replicated-pv-mayastor/rs-installation) for the latest Mayastor documentation (v2.6 and above). + +Mayastor is now also referred to as OpenEBS Replicated PV Mayastor. +{% endhint %} + ## Installation Issues ### A Mayastor pod restarts unexpectedly with exit code 132 whilst mounting a PVC diff --git a/quickstart/known-limitations.md b/quickstart/known-limitations.md index 507bf9f..3155a0d 100644 --- a/quickstart/known-limitations.md +++ b/quickstart/known-limitations.md @@ -1,5 +1,11 @@ # Known Limitations +{% hint style="danger" %} +This website/page will be End-of-life (EOL) after 31 August 2024. We recommend you to visit [OpenEBS Documentation](https://openebs.io/docs/user-guides/replicated-storage-user-guide/replicated-pv-mayastor/rs-installation) for the latest Mayastor documentation (v2.6 and above). + +Mayastor is now also referred to as OpenEBS Replicated PV Mayastor. +{% endhint %} + ## Volume and Pool Capacity Expansion Once provisioned, neither Mayastor Disk Pools nor Mayastor Volumes can be re-sized. A Mayastor Pool can have only a single block device as a member. Mayastor Volumes are exclusively thick-provisioned. diff --git a/quickstart/performance-tips.md b/quickstart/performance-tips.md index fda7aef..1ebe0af 100644 --- a/quickstart/performance-tips.md +++ b/quickstart/performance-tips.md @@ -1,5 +1,11 @@ # Performance Tips +{% hint style="danger" %} +This website/page will be End-of-life (EOL) after 31 August 2024. We recommend you to visit [OpenEBS Documentation](https://openebs.io/docs/user-guides/replicated-storage-user-guide/replicated-pv-mayastor/rs-installation) for the latest Mayastor documentation (v2.6 and above). + +Mayastor is now also referred to as OpenEBS Replicated PV Mayastor. +{% endhint %} + ## CPU isolation Mayastor will fully utilize each CPU core that it was configured to run on. It will spawn a thread on each and the thread will run in an endless loop serving tasks dispatched to it without sleeping or blocking. There are also other Mayastor threads that are not bound to the CPU and those are allowed to block and sleep. However, the bound threads \(also called reactors\) rely on being interrupted by the kernel and other userspace processes as little as possible. Otherwise, the latency of IO may suffer. @@ -107,3 +113,7 @@ Edit the `mayastor-daemonset.yaml` file and set the `-l` parameter of mayastor t - "-l3,4" ``` +<<<<<<< HEAD +======= +In the above command, `io_engine.coreList={3,4}` specifies that Mayastor's reactors should operate on the third and fourth CPU cores. +>>>>>>> ef5f92a (docs: added EOL info panel (#216)) diff --git a/quickstart/preparing-the-cluster.md b/quickstart/preparing-the-cluster.md index f5ace6c..2677540 100644 --- a/quickstart/preparing-the-cluster.md +++ b/quickstart/preparing-the-cluster.md @@ -1,5 +1,11 @@ # Preparing the Cluster +{% hint style="danger" %} +This website/page will be End-of-life (EOL) after 31 August 2024. We recommend you to visit [OpenEBS Documentation](https://openebs.io/docs/user-guides/replicated-storage-user-guide/replicated-pv-mayastor/rs-installation) for the latest Mayastor documentation (v2.6 and above). + +Mayastor is now also referred to as OpenEBS Replicated PV Mayastor. +{% endhint %} + ### Verify / Enable Huge Page Support _2MiB-sized_ Huge Pages must be supported and enabled on the mayastor storage nodes. A minimum number of 1024 such pages \(i.e. 2GiB total\) must be available _exclusively_ to the Mayastor pod on each node, which should be verified thus: diff --git a/quickstart/prerequisites.md b/quickstart/prerequisites.md index 327b993..465f549 100644 --- a/quickstart/prerequisites.md +++ b/quickstart/prerequisites.md @@ -1,5 +1,11 @@ # Prerequisites +{% hint style="danger" %} +This website/page will be End-of-life (EOL) after 31 August 2024. We recommend you to visit [OpenEBS Documentation](https://openebs.io/docs/user-guides/replicated-storage-user-guide/replicated-pv-mayastor/rs-installation) for the latest Mayastor documentation (v2.6 and above). + +Mayastor is now also referred to as OpenEBS Replicated PV Mayastor. +{% endhint %} + ## **General** All worker nodes must satisfy the following requirements: diff --git a/quickstart/tips-and-tricks.md b/quickstart/tips-and-tricks.md index 5731160..a02a27c 100644 --- a/quickstart/tips-and-tricks.md +++ b/quickstart/tips-and-tricks.md @@ -1,5 +1,11 @@ # Tips and Tricks +{% hint style="danger" %} +This website/page will be End-of-life (EOL) after 31 August 2024. We recommend you to visit [OpenEBS Documentation](https://openebs.io/docs/user-guides/replicated-storage-user-guide/replicated-pv-mayastor/rs-installation) for the latest Mayastor documentation (v2.6 and above). + +Mayastor is now also referred to as OpenEBS Replicated PV Mayastor. +{% endhint %} + ## What if I have no Disk Devices available that I can use for testing? For basic test and evaluation purposes it may not always be practical or possible to allocate physical disk devices on a cluster to Mayastor for use within its pools. As a convenience, Mayastor supports two disk device type emulations for this purpose: diff --git a/quickstart/troubleshooting.md b/quickstart/troubleshooting.md index a68baa4..abc00fc 100644 --- a/quickstart/troubleshooting.md +++ b/quickstart/troubleshooting.md @@ -1,5 +1,11 @@ # Basic Troubleshooting +{% hint style="danger" %} +This website/page will be End-of-life (EOL) after 31 August 2024. We recommend you to visit [OpenEBS Documentation](https://openebs.io/docs/user-guides/replicated-storage-user-guide/replicated-pv-mayastor/rs-installation) for the latest Mayastor documentation (v2.6 and above). + +Mayastor is now also referred to as OpenEBS Replicated PV Mayastor. +{% endhint %} + ## Logs The correct set of log file to collect depends on the nature of the problem. If unsure, then it is best to collect log files for all Mayastor containers. In nearly every case, the logs of all of the control plane component pods will be needed; diff --git a/reference/HA.md b/reference/HA.md index ddbccf4..07e5707 100644 --- a/reference/HA.md +++ b/reference/HA.md @@ -1,5 +1,11 @@ ## High Availability +{% hint style="danger" %} +This website/page will be End-of-life (EOL) after 31 August 2024. We recommend you to visit [OpenEBS Documentation](https://openebs.io/docs/user-guides/replicated-storage-user-guide/replicated-pv-mayastor/rs-installation) for the latest Mayastor documentation (v2.6 and above). + +Mayastor is now also referred to as OpenEBS Replicated PV Mayastor. +{% endhint %} + Mayastor 2.0 enhances High Availability (HA) of the volume target with the nexus switch-over feature. In the event of the target failure, the switch-over feature quickly detects the failure and spawns a new nexus to ensure I/O continuity. The HA feature consists of two components: the HA node agent (which runs in each csi- node) and the cluster agent (which runs alongside the agent-core). The HA node agent looks for io-path failures from applications to their corresponding targets. If any such broken path is encountered, the HA node agent informs the cluster agent. The cluster-agent then creates a new target on a different (live) node. Once the target is created, the `node-agent` establishes a new path between the application and its corresponding target. The HA feature restores the broken path within seconds, ensuring negligible downtime. diff --git a/reference/call-home.md b/reference/call-home.md index c348da6..d2d2b51 100644 --- a/reference/call-home.md +++ b/reference/call-home.md @@ -1,5 +1,11 @@ # Call-home metrics +{% hint style="danger" %} +This website/page will be End-of-life (EOL) after 31 August 2024. We recommend you to visit [OpenEBS Documentation](https://openebs.io/docs/user-guides/replicated-storage-user-guide/replicated-pv-mayastor/rs-installation) for the latest Mayastor documentation (v2.6 and above). + +Mayastor is now also referred to as OpenEBS Replicated PV Mayastor. +{% endhint %} + By default, Mayastor collects some basic information related to the number and scale of user-deployed instances. The collected data is anonymous and is encrypted at rest. This data is used to understand storage usage trends, which in turn helps maintainers prioritize their contributions to maximize the benefit to the community as a whole. {% hint style="info" %} diff --git a/reference/i-o-path-description.md b/reference/i-o-path-description.md index 93b5795..b10483b 100644 --- a/reference/i-o-path-description.md +++ b/reference/i-o-path-description.md @@ -7,6 +7,12 @@ description: >- # I/O Path Description +{% hint style="danger" %} +This website/page will be End-of-life (EOL) after 31 August 2024. We recommend you to visit [OpenEBS Documentation](https://openebs.io/docs/user-guides/replicated-storage-user-guide/replicated-pv-mayastor/rs-installation) for the latest Mayastor documentation (v2.6 and above). + +Mayastor is now also referred to as OpenEBS Replicated PV Mayastor. +{% endhint %} + ## Glossary of Terms ### Mayastor Instance diff --git a/reference/kubectl-plugin.md b/reference/kubectl-plugin.md index 403dc56..78a4abc 100644 --- a/reference/kubectl-plugin.md +++ b/reference/kubectl-plugin.md @@ -1,5 +1,11 @@ # Mayastor kubectl plugin +{% hint style="danger" %} +This website/page will be End-of-life (EOL) after 31 August 2024. We recommend you to visit [OpenEBS Documentation](https://openebs.io/docs/user-guides/replicated-storage-user-guide/replicated-pv-mayastor/rs-installation) for the latest Mayastor documentation (v2.6 and above). + +Mayastor is now also referred to as OpenEBS Replicated PV Mayastor. +{% endhint %} + The ‘Mayastor kubectl plugin’ can be used to view and manage Mayastor resources such as nodes, pools and volumes. It is also used for operations such as scaling the replica count of volumes. ### Installation diff --git a/reference/legacy-upgrade.md b/reference/legacy-upgrade.md index 97a9a03..610b950 100644 --- a/reference/legacy-upgrade.md +++ b/reference/legacy-upgrade.md @@ -1,10 +1,15 @@ ## Legacy Upgrade Support +{% hint style="danger" %} +This website/page will be End-of-life (EOL) after 31 August 2024. We recommend you to visit [OpenEBS Documentation](https://openebs.io/docs/user-guides/replicated-storage-user-guide/replicated-pv-mayastor/rs-installation) for the latest Mayastor documentation (v2.6 and above). + +Mayastor is now also referred to as OpenEBS Replicated PV Mayastor. +{% endhint %} + A legacy installation of Mayastor (1.0.5 and below) cannot be seamlessly upgraded and needs manual intervention. Follow the below steps if you wish to upgrade from Mayastor 1.0.x to Mayastor 2.1.0 and above. Mayastor uses etcd as a persistent datastore for its configuration. As a first step, take a snapshot of the etcd. The detailed steps for taking a snapshot can be found in the etcd [documentation](https://etcd.io/docs/v3.3/op-guide/recovery/). - {% hint style="warning" %} As compared to Mayastor 1.0, the Mayastor 2.0 feature-set introduces breaking changes in some of the components, due to which the upgrade process from 1.0 to 2.0 is not seamless. The list of such changes are given below: **ETCD:** diff --git a/reference/monitoring.md b/reference/monitoring.md index de3f377..dda8fe1 100644 --- a/reference/monitoring.md +++ b/reference/monitoring.md @@ -1,5 +1,11 @@ # Monitoring +{% hint style="danger" %} +This website/page will be End-of-life (EOL) after 31 August 2024. We recommend you to visit [OpenEBS Documentation](https://openebs.io/docs/user-guides/replicated-storage-user-guide/replicated-pv-mayastor/rs-installation) for the latest Mayastor documentation (v2.6 and above). + +Mayastor is now also referred to as OpenEBS Replicated PV Mayastor. +{% endhint %} + ## Pool metrics exporter The Mayastor pool metrics exporter runs as a sidecar container within every io-engine pod and exposes pool usage metrics in Prometheus format. These metrics are exposed on port 9502 using an HTTP endpoint /metrics and are refreshed every five minutes. diff --git a/reference/node-cordon.md b/reference/node-cordon.md index db647cb..b2b43fa 100644 --- a/reference/node-cordon.md +++ b/reference/node-cordon.md @@ -1,5 +1,11 @@ ## Mayastor Node Cordon +{% hint style="danger" %} +This website/page will be End-of-life (EOL) after 31 August 2024. We recommend you to visit [OpenEBS Documentation](https://openebs.io/docs/user-guides/replicated-storage-user-guide/replicated-pv-mayastor/rs-installation) for the latest Mayastor documentation (v2.6 and above). + +Mayastor is now also referred to as OpenEBS Replicated PV Mayastor. +{% endhint %} + Cordoning a node marks or taints the node as unschedulable. This prevents the scheduler from deploying new resources on that node. However, the resources that were deployed prior to cordoning off the node will remain intact. This feature is in line with the node-cordon functionality of Kubernetes. diff --git a/reference/node-drain.md b/reference/node-drain.md index f5329fc..67d4268 100644 --- a/reference/node-drain.md +++ b/reference/node-drain.md @@ -1,5 +1,11 @@ ## Mayastor Node Drain +{% hint style="danger" %} +This website/page will be End-of-life (EOL) after 31 August 2024. We recommend you to visit [OpenEBS Documentation](https://openebs.io/docs/user-guides/replicated-storage-user-guide/replicated-pv-mayastor/rs-installation) for the latest Mayastor documentation (v2.6 and above). + +Mayastor is now also referred to as OpenEBS Replicated PV Mayastor. +{% endhint %} + The node drain functionality marks the node as unschedulable and then gracefully moves all the volume targets off the drained node. This feature is in line with the [node drain functionality of Kubernetes](https://kubernetes.io/docs/tasks/administer-cluster/safely-drain-node/). diff --git a/reference/replica-operations.md b/reference/replica-operations.md index b33a60a..bf98f20 100644 --- a/reference/replica-operations.md +++ b/reference/replica-operations.md @@ -1,5 +1,11 @@ # Replica Operations +{% hint style="danger" %} +This website/page will be End-of-life (EOL) after 31 August 2024. We recommend you to visit [OpenEBS Documentation](https://openebs.io/docs/user-guides/replicated-storage-user-guide/replicated-pv-mayastor/rs-installation) for the latest Mayastor documentation (v2.6 and above). + +Mayastor is now also referred to as OpenEBS Replicated PV Mayastor. +{% endhint %} + ## Basics When a Mayastor volume is provisioned based on a StorageClass which has a replication factor greater than one \(set by its `repl` parameter)\, the control plane will attempt to maintain through a 'Kubernetes-like' reconciliation loop that number of identical copies of the volume's data "replicas" (a replica is a nexus target "child"\) at any point in time. When a volume is first provisioned the control plane will attempt to create the required number of replicas, whilst adhering to its internal heuristics for their location within the cluster \(which will be discussed shortly\). If it succeeds, the volume will become available and will bind with the PVC. If the control plane cannot identify a sufficient number of eligble Mayastor Pools in which to create required replicas at the time of provisioning, the operation will fail; the Mayastor Volume will not be created and the associated PVC will not be bound. Kubernetes will periodically re-try the volume creation and if at any time the appropriate number of pools can be selected, the volume provisioning should succeed. diff --git a/reference/replica-rebuild.md b/reference/replica-rebuild.md index f7fbe7a..291dde6 100644 --- a/reference/replica-rebuild.md +++ b/reference/replica-rebuild.md @@ -1,5 +1,11 @@ ## Replica Rebuilds +{% hint style="danger" %} +This website/page will be End-of-life (EOL) after 31 August 2024. We recommend you to visit [OpenEBS Documentation](https://openebs.io/docs/user-guides/replicated-storage-user-guide/replicated-pv-mayastor/rs-installation) for the latest Mayastor documentation (v2.6 and above). + +Mayastor is now also referred to as OpenEBS Replicated PV Mayastor. +{% endhint %} + With the previous versions, the control plane ensured replica redundancy by monitoring all volume targets and checking for any volume targets that were in `Degraded` state, indicating that one or more replicas of that volume targets were faulty. When a matching volume targets is found, the faulty replica is removed. Then, a new replica is created and added to the volume targets object. As part of adding the new child data-plane, a full rebuild was initiated from one of the existing `Online` replicas. However, the drawback to the above approach was that even if a replica was inaccessible for a short period (e.g., due to a node restart), a full rebuild was triggered. This may not have a significant impact on replicas with small sizes, but it is not desirable for large replicas. diff --git a/reference/storage-class-parameters.md b/reference/storage-class-parameters.md index 3b2ec6b..35fbc4c 100644 --- a/reference/storage-class-parameters.md +++ b/reference/storage-class-parameters.md @@ -1,5 +1,11 @@ # Storage class parameters +{% hint style="danger" %} +This website/page will be End-of-life (EOL) after 31 August 2024. We recommend you to visit [OpenEBS Documentation](https://openebs.io/docs/user-guides/replicated-storage-user-guide/replicated-pv-mayastor/rs-installation) for the latest Mayastor documentation (v2.6 and above). + +Mayastor is now also referred to as OpenEBS Replicated PV Mayastor. +{% endhint %} + Storage class resource in Kubernetes is used to supply parameters to volumes when they are created. It is a convenient way of grouping volumes with common characteristics. All parameters take a string value. Brief explanation of each supported Mayastor parameter follows. diff --git a/reference/supportability.md b/reference/supportability.md index baf1463..5b4f192 100644 --- a/reference/supportability.md +++ b/reference/supportability.md @@ -1,5 +1,11 @@ ## Supportability +{% hint style="danger" %} +This website/page will be End-of-life (EOL) after 31 August 2024. We recommend you to visit [OpenEBS Documentation](https://openebs.io/docs/user-guides/replicated-storage-user-guide/replicated-pv-mayastor/rs-installation) for the latest Mayastor documentation (v2.6 and above). + +Mayastor is now also referred to as OpenEBS Replicated PV Mayastor. +{% endhint %} + The supportability tool collects Mayastor specific information from the cluster using the [kubectl plugin](https://mayastor.gitbook.io/introduction/reference/kubectl-plugin) command-line tool. It uses the dump command, which interacts with the Mayastor services to build an archive (ZIP) file that acts as a placeholder for the bundled information. diff --git a/reference/tested-third-party-software.md b/reference/tested-third-party-software.md index 56bbb97..933df52 100644 --- a/reference/tested-third-party-software.md +++ b/reference/tested-third-party-software.md @@ -1,5 +1,11 @@ # Tested Third Party Software +{% hint style="danger" %} +This website/page will be End-of-life (EOL) after 31 August 2024. We recommend you to visit [OpenEBS Documentation](https://openebs.io/docs/user-guides/replicated-storage-user-guide/replicated-pv-mayastor/rs-installation) for the latest Mayastor documentation (v2.6 and above). + +Mayastor is now also referred to as OpenEBS Replicated PV Mayastor. +{% endhint %} + ## **Worker Node OS** | **Linux** | _Distribution:Ubuntu Version: 20.04 LTS Kernel version: 5.13.0-27-generic_ | diff --git a/reference/upgrade.md b/reference/upgrade.md index c7ad386..6b69846 100644 --- a/reference/upgrade.md +++ b/reference/upgrade.md @@ -1,5 +1,11 @@ ## Upgrading Mayastor +{% hint style="danger" %} +This website/page will be End-of-life (EOL) after 31 August 2024. We recommend you to visit [OpenEBS Documentation](https://openebs.io/docs/user-guides/replicated-storage-user-guide/replicated-pv-mayastor/rs-installation) for the latest Mayastor documentation (v2.6 and above). + +Mayastor is now also referred to as OpenEBS Replicated PV Mayastor. +{% endhint %} + Mayastor supports seamless upgrades starting with target version 2.1.0 and later, and source versions 2.0.0 and later. To upgrade from a previous version(1.0.5 or prior) to 2.1.0 or later, visit [Legacy Upgrade Support](https://mayastor.gitbook.io/introduction/additional-information/upgrade/legacy-upgrade). ### Supported upgrade paths diff --git a/scope.md b/scope.md index 9673500..b090b09 100644 --- a/scope.md +++ b/scope.md @@ -1,5 +1,11 @@ # Scope +{% hint style="danger" %} +This website/page will be End-of-life (EOL) after 31 August 2024. We recommend you to visit [OpenEBS Documentation](https://openebs.io/docs/user-guides/replicated-storage-user-guide/replicated-pv-mayastor/rs-installation) for the latest Mayastor documentation (v2.6 and above). + +Mayastor is now also referred to as OpenEBS Replicated PV Mayastor. +{% endhint %} + This quickstart guide describes the actions necessary to perform a basic installation of Mayastor on an existing Kubernetes cluster, sufficient for evaluation purposes. It assumes that the target cluster will pull the Mayastor container images directly from OpenEBS public container repositories. Where preferred, it is also possible to [build Mayastor locally from source](https://github.com/openebs/Mayastor/blob/develop/doc/build.md) and deploy the resultant images but this is outside of the scope of this guide. Deploying and operating Mayastor in production contexts requires a foundational knowledge of Mayastor internals and best practices, found elsewhere within this documentation.