Skip to content
This repository has been archived by the owner on Mar 3, 2022. It is now read-only.

Commit

Permalink
Add deprecation notice to all md files
Browse files Browse the repository at this point in the history
Signed-off-by: anupriya0703 <[email protected]>
  • Loading branch information
anupriya0703 authored and kmova committed Dec 10, 2021
1 parent e5d769f commit fa9e43b
Show file tree
Hide file tree
Showing 59 changed files with 128 additions and 50 deletions.
3 changes: 2 additions & 1 deletion docs/alphafeatures.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ title: Alpha Features
sidebar_label: Alpha Features
---
------

<center><p style="padding: 20px; margin: 20px 0; border-radius: 3px; background-color: #eeeeee;"><strong>
OpenEBS Documentation is now migrated to https://openebs.io/docs. The page you are currently viewing is a static snapshot and will be removed in the upcoming releases. </strong></p></center>


This page provides an overview of OpenEBS components and features presently in Alpha version and under active development. These features are not recommended to be used in production. We suggest you to familiarize and try these features on test clusters and reach out to [OpenEBS Community](/docs/next/support.html) if you have any queries, feedback or need help on these features.
Expand Down
3 changes: 3 additions & 0 deletions docs/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ sidebar_label: Architecture

------

<center><p style="padding: 20px; margin: 20px 0; border-radius: 3px; background-color: #eeeeee;"><strong>
OpenEBS Documentation is now migrated to https://openebs.io/docs. The page you are currently viewing is a static snapshot and will be removed in the upcoming releases. </strong></p></center>

OpenEBS is the leading Open Source implementation of the [Container Attached Storage(CAS)](/docs/next/cas.html) pattern. As a part of this approach, OpenEBS uses containers to dynamically provision volumes and provide data services like high availability. OpenEBS relies on and extends [Kubernetes](/docs/next/k8s-storage.html) itself to orchestrate its volume services.


Expand Down
3 changes: 2 additions & 1 deletion docs/benefits.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,9 @@ sidebar_label: Benefits
---

------
<center><p style="padding: 20px; margin: 20px 0; border-radius: 3px; background-color: #eeeeee;"><strong>
OpenEBS Documentation is now migrated to https://openebs.io/docs. The page you are currently viewing is a static snapshot and will be removed in the upcoming releases. </strong></p></center>

<br>
- [Open Source Cloud Native storage for Kubernetes](#open-source-cloud-native-storage-for-kubernetes)
- [Granular policies per stateful workload](#granular-policies-per-stateful-workload)
- [Avoid Cloud Lock-in](#avoid-cloud-lock-in)
Expand Down
4 changes: 3 additions & 1 deletion docs/cas.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ sidebar_label: Container Attached Storage

------


<center><p style="padding: 20px; margin: 20px 0; border-radius: 3px; background-color: #eeeeee;"><strong>
OpenEBS Documentation is now migrated to https://openebs.io/docs. The page you are currently viewing is a static snapshot and will be removed in the upcoming releases. </strong></p></center>

## What is CAS?


Expand Down
3 changes: 2 additions & 1 deletion docs/casengines.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ sidebar_label: Data Engines
---

------

<center><p style="padding: 20px; margin: 20px 0; border-radius: 3px; background-color: #eeeeee;"><strong>
OpenEBS Documentation is now migrated to https://openebs.io/docs. The page you are currently viewing is a static snapshot and will be removed in the upcoming releases. </strong></p></center>
OpenEBS Data Engine is the core component that acts as an end-point for serving the IO to the applications. OpenEBS Data engines are akin to Storage controllers or sometimes also know for implementing the software defined storage capabilities.

OpenEBS provides a set of Data Engines, where each of the engines is built and optimized for running stateful workloads of varying capabilities and running them on Kubernetes nodes with varying range of resources.
Expand Down
3 changes: 2 additions & 1 deletion docs/cassandra.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ title: OpenEBS for Cassandra
sidebar_label: Cassandra
---
------

<center><p style="padding: 20px; margin: 20px 0; border-radius: 3px; background-color: #eeeeee;"><strong>
OpenEBS Documentation is now migrated to https://openebs.io/docs. The page you are currently viewing is a static snapshot and will be removed in the upcoming releases. </strong></p></center>
<img src="/docs/assets/o-cassandra.png" alt="OpenEBS and Cassandra" style="width:400px;">


Expand Down
3 changes: 2 additions & 1 deletion docs/cockroachdb.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ title: OpenEBS for CockroachDB
sidebar_label: CockroachDB
---
------

<center><p style="padding: 20px; margin: 20px 0; border-radius: 3px; background-color: #eeeeee;"><strong>
OpenEBS Documentation is now migrated to https://openebs.io/docs. The page you are currently viewing is a static snapshot and will be removed in the upcoming releases. </strong></p></center>
<img src="/docs/assets/o-cockroachdb.png" alt="OpenEBS and CockroachDB" style="width:400px;">


Expand Down
3 changes: 2 additions & 1 deletion docs/commercial.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ sidebar_label: Support
---
------


<center><p style="padding: 20px; margin: 20px 0; border-radius: 3px; background-color: #eeeeee;"><strong>
OpenEBS Documentation is now migrated to https://openebs.io/docs. The page you are currently viewing is a static snapshot and will be removed in the upcoming releases. </strong></p></center>
OpenEBS is an independent open source project which does not endorse any company.

This is a list of third-party companies and individuals who provide products or services related to OpenEBS. If you are providing commercial support for OpenEBS, please [edit this page](https://github.com/openebs/openebs-docs/edit/staging/docs/commercial.md) to add yourself or your organization to the list.
Expand Down
3 changes: 2 additions & 1 deletion docs/cstor.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ sidebar_label: cStor
---

------

<center><p style="padding: 20px; margin: 20px 0; border-radius: 3px; background-color: #eeeeee;"><strong>
OpenEBS Documentation is now migrated to https://openebs.io/docs. The page you are currently viewing is a static snapshot and will be removed in the upcoming releases. </strong></p></center>
cStor is the recommended way to provide additional resilience to workloads via OpenEBS and is the second most widely deployed storage engine behind LocalPV. cStor was originally introduced in OpenEBS 0.7 release and has been tested well in the community and in production deployments. The primary function of cStor is to serve iSCSI block storage using the underlying disks or cloud volumes in a cloud native way. cStor is a very light weight and feature rich storage engine. It provides enterprise grade features such as synchronous data replication, snapshots, clones, thin provisioning of data, high resiliency of data, data consistency and on-demand increase of capacity or performance.

When the stateful application desires the storage to provide high availability of data, cStor is configured to have 3 replicas where data is written synchronously to all the three replicas. As shown below, the cStor target is replicating the data to Node1 (R1), Node3(R2) and Node4(R3). The data is written to the three replicas before the response is sent back to the application. It is important to note that the replicas R1, R2 and R3 are copies of the same data written by the target, data is not striped across replicas or across nodes.
Expand Down
2 changes: 2 additions & 0 deletions docs/d-cStorguide.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ id: d-cStorguide
title: cStor Guide
sidebar_label: SPC based cStor guide
---
<center><p style="padding: 20px; margin: 20px 0; border-radius: 3px; background-color: #eeeeee;"><strong>
OpenEBS Documentation is now migrated to https://openebs.io/docs. The page you are currently viewing is a static snapshot and will be removed in the upcoming releases. </strong></p></center>

------

Expand Down
2 changes: 2 additions & 0 deletions docs/elasticsearch.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: OpenEBS for Elasticsearch
sidebar_label: Elasticsearch
---
------
<center><p style="padding: 20px; margin: 20px 0; border-radius: 3px; background-color: #eeeeee;"><strong>
OpenEBS Documentation is now migrated to https://openebs.io/docs. The page you are currently viewing is a static snapshot and will be removed in the upcoming releases. </strong></p></center>

<img src="/docs/assets/o-elastic.png" alt="OpenEBS and Elasticsearch" style="width:400px;">

Expand Down
3 changes: 2 additions & 1 deletion docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ sidebar_label: FAQs
------

<br>

<center><p style="padding: 20px; margin: 20px 0; border-radius: 3px; background-color: #eeeeee;"><strong>
OpenEBS Documentation is now migrated to https://openebs.io/docs. The page you are currently viewing is a static snapshot and will be removed in the upcoming releases. </strong></p></center>


## General
Expand Down
3 changes: 2 additions & 1 deletion docs/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,9 @@ sidebar_label: Features
---

------
<center><p style="padding: 20px; margin: 20px 0; border-radius: 3px; background-color: #eeeeee;"><strong>
OpenEBS Documentation is now migrated to https://openebs.io/docs. The page you are currently viewing is a static snapshot and will be removed in the upcoming releases. </strong></p></center>

<br>
- [Containerized storage for containers](#containerized-storage-for-containers)
- [Synchronous replication](#synchronous-replication)
- [Snapshots and clones](#snapshots-and-clones)
Expand Down
3 changes: 2 additions & 1 deletion docs/gitlab.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ title: OpenEBS for GitLab
sidebar_label: GitLab
---
------

<center><p style="padding: 20px; margin: 20px 0; border-radius: 3px; background-color: #eeeeee;"><strong>
OpenEBS Documentation is now migrated to https://openebs.io/docs. The page you are currently viewing is a static snapshot and will be removed in the upcoming releases. </strong></p></center>
<img src="/docs/assets/o-gitlab.png" alt="OpenEBS and GitLab" style="width:400px;">


Expand Down
3 changes: 2 additions & 1 deletion docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ title: Installing OpenEBS
sidebar_label: Installation
---
------

<center><p style="padding: 20px; margin: 20px 0; border-radius: 3px; background-color: #eeeeee;"><strong>
OpenEBS Documentation is now migrated to https://openebs.io/docs. The page you are currently viewing is a static snapshot and will be removed in the upcoming releases. </strong></p></center>
<br>
This guide will help you to customize and install OpenEBS.

Expand Down
3 changes: 2 additions & 1 deletion docs/jira.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ title: Using OpenEBS as storage for Jira on Kubernetes
sidebar_label: Jira
---
------

<center><p style="padding: 20px; margin: 20px 0; border-radius: 3px; background-color: #eeeeee;"><strong>
OpenEBS Documentation is now migrated to https://openebs.io/docs. The page you are currently viewing is a static snapshot and will be removed in the upcoming releases. </strong></p></center>
<img src="/docs/assets/o-jira.png" alt="OpenEBS and Jira" style="width:400px;">

## Introduction
Expand Down
3 changes: 2 additions & 1 deletion docs/jiva.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ sidebar_label: Jiva

------


<center><p style="padding: 20px; margin: 20px 0; border-radius: 3px; background-color: #eeeeee;"><strong>
OpenEBS Documentation is now migrated to https://openebs.io/docs. The page you are currently viewing is a static snapshot and will be removed in the upcoming releases. </strong></p></center>

### Jiva

Expand Down
2 changes: 2 additions & 0 deletions docs/jivaguide.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: Jiva User Guide
sidebar_label: Jiva
---
------
<center><p style="padding: 20px; margin: 20px 0; border-radius: 3px; background-color: #eeeeee;"><strong>
OpenEBS Documentation is now migrated to https://openebs.io/docs. The page you are currently viewing is a static snapshot and will be removed in the upcoming releases. </strong></p></center>

:::note
The recommended approach to provision Jiva volumes is via CSI Driver. For detailed instructions on how to get started with new Jiva CSI Driver please refer to the [Quickstart guide on Github](https://github.com/openebs/jiva-operator).
Expand Down
3 changes: 2 additions & 1 deletion docs/k8s-storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ sidebar_label: Basics

------


<center><p style="padding: 20px; margin: 20px 0; border-radius: 3px; background-color: #eeeeee;"><strong>
OpenEBS Documentation is now migrated to https://openebs.io/docs. The page you are currently viewing is a static snapshot and will be removed in the upcoming releases. </strong></p></center>

:::note
This document provides you with a quick overview of the <a href="https://kubernetes.io/docs/concepts/storage/" target="_blank">Kubernetes concepts</a> you need to know for running Stateful Workloads. If you are already familiar with running Stateful workloads in Kubernetes, header over to the next section on [Container Attached Storage](/docs/next/cas.html).
Expand Down
3 changes: 2 additions & 1 deletion docs/k8supgrades.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ title: Best practices to follow when upgrading Kubernetes
sidebar_label: Kubernetes upgrades
---
------

<center><p style="padding: 20px; margin: 20px 0; border-radius: 3px; background-color: #eeeeee;"><strong>
OpenEBS Documentation is now migrated to https://openebs.io/docs. The page you are currently viewing is a static snapshot and will be removed in the upcoming releases. </strong></p></center>
There are few reasons why nodes in a Kubernetes cluster get rebooted

- Kubernetes upgrades do need to happen to new features that roll out and to get minimum requirements satisfied for the applications upgrade running on Kubernetes. The upgrade process of Kubernetes cluster involves upgrading the nodes one by one. This process may involve rebooting of the nodes of the cluster.
Expand Down
3 changes: 2 additions & 1 deletion docs/kb.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ sidebar_label: Knowledge Base
---

------

<center><p style="padding: 20px; margin: 20px 0; border-radius: 3px; background-color: #eeeeee;"><strong>
OpenEBS Documentation is now migrated to https://openebs.io/docs. The page you are currently viewing is a static snapshot and will be removed in the upcoming releases. </strong></p></center>
<font size="5">Summary</font>

[How do I reuse an existing PV - after re-creating Kubernetes StatefulSet and its PVC](#reuse-pv-after-recreating-sts)
Expand Down
4 changes: 3 additions & 1 deletion docs/localpv.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ sidebar_label: Local PV
------

<br>

<center><p style="padding: 20px; margin: 20px 0; border-radius: 3px; background-color: #eeeeee;"><strong>
OpenEBS Documentation is now migrated to https://openebs.io/docs. The page you are currently viewing is a static snapshot and will be removed in the upcoming releases. </strong></p></center>

## Overview

OpenEBS provides Dynamic PV provisioners for [Kubernetes Local Volumes](https://kubernetes.io/docs/concepts/storage/volumes/#local). A local volume implies that storage is available only from a single node. A local volume represents a mounted local storage device such as a disk, partition or directory.
Expand Down
3 changes: 2 additions & 1 deletion docs/mayactl.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ title: mayactl
sidebar_label: mayactl
---
------

<center><p style="padding: 20px; margin: 20px 0; border-radius: 3px; background-color: #eeeeee;"><strong>
OpenEBS Documentation is now migrated to https://openebs.io/docs. The page you are currently viewing is a static snapshot and will be removed in the upcoming releases. </strong></p></center>
The `mayactl` is the command line tool for interacting with OpenEBS volumes and Pools. The `mayactl` is not used or required while provisioning or managing the OpenEBS volumes, but it is currently used while debugging and troubleshooting. OpenEBS volume and pool status can be get using the `mayactl` command.


Expand Down
2 changes: 2 additions & 0 deletions docs/mayastor.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: Mayastor
sidebar_label: Mayastor
---
----
<center><p style="padding: 20px; margin: 20px 0; border-radius: 3px; background-color: #eeeeee;"><strong>
OpenEBS Documentation is now migrated to https://openebs.io/docs. The page you are currently viewing is a static snapshot and will be removed in the upcoming releases. </strong></p></center>

## What is Mayastor?

Expand Down
3 changes: 2 additions & 1 deletion docs/minio.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ title: OpenEBS for MinIO
sidebar_label: MinIO
---
------

<center><p style="padding: 20px; margin: 20px 0; border-radius: 3px; background-color: #eeeeee;"><strong>
OpenEBS Documentation is now migrated to https://openebs.io/docs. The page you are currently viewing is a static snapshot and will be removed in the upcoming releases. </strong></p></center>
<img src="/docs/assets/o-minio.png" alt="OpenEBS and MinIO" style="width:400px;">

<br>
Expand Down
3 changes: 2 additions & 1 deletion docs/mongo.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ id: mongo
title: OpenEBS for MongoDB
sidebar_label: MongoDB
---

<center><p style="padding: 20px; margin: 20px 0; border-radius: 3px; background-color: #eeeeee;"><strong>
OpenEBS Documentation is now migrated to https://openebs.io/docs. The page you are currently viewing is a static snapshot and will be removed in the upcoming releases. </strong></p></center>
<img src="/docs/assets/svg/o-mongo.svg" alt="OpenEBS and MongoDB" style="width:400px;">

## Introduction
Expand Down
3 changes: 2 additions & 1 deletion docs/mysql.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ title: Managed database service like RDS
sidebar_label: RDS like MySQL
---
------

<center><p style="padding: 20px; margin: 20px 0; border-radius: 3px; background-color: #eeeeee;"><strong>
OpenEBS Documentation is now migrated to https://openebs.io/docs. The page you are currently viewing is a static snapshot and will be removed in the upcoming releases. </strong></p></center>
<img src="/docs/assets/o-mysql.png" alt="OpenEBS and MySQL" style="width:400px;">

## Introduction
Expand Down
3 changes: 2 additions & 1 deletion docs/ndm.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ sidebar_label: NDM
---
------


<center><p style="padding: 20px; margin: 20px 0; border-radius: 3px; background-color: #eeeeee;"><strong>
OpenEBS Documentation is now migrated to https://openebs.io/docs. The page you are currently viewing is a static snapshot and will be removed in the upcoming releases. </strong></p></center>

Node Disk Manager(NDM) is an important component in the OpenEBS architecture. NDM treats block devices as resources that need to be monitored and managed just like other resources such as CPU, Memory and Network. It is a daemonset which runs on each node, detects attached block devices based on the filters and loads them as block devices custom resource into Kubernetes. These custom resources are aimed towards helping hyper-converged Storage Operators by providing abilities like:

Expand Down
3 changes: 2 additions & 1 deletion docs/nuodb.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ title: OpenEBS for NuoDB
sidebar_label: NuoDB
---
------

<center><p style="padding: 20px; margin: 20px 0; border-radius: 3px; background-color: #eeeeee;"><strong>
OpenEBS Documentation is now migrated to https://openebs.io/docs. The page you are currently viewing is a static snapshot and will be removed in the upcoming releases. </strong></p></center>
<img src="/docs/assets/o-nuodb.png" alt="OpenEBS and Nuodb" style="width:400px;">

<br>
Expand Down
3 changes: 2 additions & 1 deletion docs/percona.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ title: OpenEBS for Percona
sidebar_label: Percona
---
------

<center><p style="padding: 20px; margin: 20px 0; border-radius: 3px; background-color: #eeeeee;"><strong>
OpenEBS Documentation is now migrated to https://openebs.io/docs. The page you are currently viewing is a static snapshot and will be removed in the upcoming releases. </strong></p></center>
<img src="/docs/assets/o-percona.png" alt="OpenEBS and Percona" style="width:400px;">


Expand Down
3 changes: 2 additions & 1 deletion docs/performance.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ title: Performance testing of OpenEBS
sidebar_label: Performance testing
---
------

<center><p style="padding: 20px; margin: 20px 0; border-radius: 3px; background-color: #eeeeee;"><strong>
OpenEBS Documentation is now migrated to https://openebs.io/docs. The page you are currently viewing is a static snapshot and will be removed in the upcoming releases. </strong></p></center>
<font size="6">Steps for performance testing</font>

**Setup cStorPool and StorageClass**
Expand Down
3 changes: 2 additions & 1 deletion docs/postgres.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ title: OpenEBS for PostgreSQL
sidebar_label: PostgreSQL
---
------

<center><p style="padding: 20px; margin: 20px 0; border-radius: 3px; background-color: #eeeeee;"><strong>
OpenEBS Documentation is now migrated to https://openebs.io/docs. The page you are currently viewing is a static snapshot and will be removed in the upcoming releases. </strong></p></center>
<img src="/docs/assets/o-postgres.png" alt="OpenEBS and PostgreSQL" style="width:400px;">

<br>
Expand Down
3 changes: 2 additions & 1 deletion docs/prerequisites.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ title: OpenEBS Install Prerequisites
sidebar_label: Prerequisites
---
------

<center><p style="padding: 20px; margin: 20px 0; border-radius: 3px; background-color: #eeeeee;"><strong>
OpenEBS Documentation is now migrated to https://openebs.io/docs. The page you are currently viewing is a static snapshot and will be removed in the upcoming releases. </strong></p></center>
<br>
This guide will help you to verify that your Kubernetes worker nodes have the required prerequisites to install OpenEBS and use OpenEBS Volumes to run your Kubernetes Stateful Workloads. In addition, you will learn about how to customize the installer according to your managed Kubernetes provider.

Expand Down
3 changes: 2 additions & 1 deletion docs/prometheus.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ title: Using OpenEBS as TSDB for Prometheus
sidebar_label: Prometheus
---
------

<center><p style="padding: 20px; margin: 20px 0; border-radius: 3px; background-color: #eeeeee;"><strong>
OpenEBS Documentation is now migrated to https://openebs.io/docs. The page you are currently viewing is a static snapshot and will be removed in the upcoming releases. </strong></p></center>
<img src="/docs/assets/o-prometheus.png" alt="OpenEBS and Prometheus" style="width:400px;">

## Introduction
Expand Down
Loading

0 comments on commit fa9e43b

Please sign in to comment.