From f9b88e091c61a8f65934880488bced7fa0366a5d Mon Sep 17 00:00:00 2001 From: balaharish7 <161304963+balaharish7@users.noreply.github.com> Date: Tue, 16 Apr 2024 15:46:57 +0530 Subject: [PATCH] docs: corrected the hyperlinks, modified the upgrade doc, and moved the resize doc to advanced operations (#421) * docs: corrcted the hyperlinks, modified the upgrade doc and moved the resize doc to advanced operations Signed-off-by: Bala Harish * docs: corrceted the cross reference Signed-off-by: Bala Harish * docs: removed the phrase reg. CNCF sandbox project Signed-off-by: Bala Harish * docs: modified the docs Signed-off-by: Bala Harish --------- Signed-off-by: Bala Harish --- .../introduction-to-openebs/introduction-to-openebs.md | 2 +- .../user-guides/data-migration/migration-overview.md | 4 ++-- .../resize.md | 0 .../version-4.0.x/user-guides/upgrades.md | 3 ++- docs/versioned_sidebars/version-4.0.x-sidebars.json | 10 +++++----- 5 files changed, 10 insertions(+), 9 deletions(-) rename docs/versioned_docs/version-4.0.x/user-guides/replicated-storage-user-guide/replicated-pv-mayastor/{additional-information => advanced-operations}/resize.md (100%) diff --git a/docs/versioned_docs/version-4.0.x/introduction-to-openebs/introduction-to-openebs.md b/docs/versioned_docs/version-4.0.x/introduction-to-openebs/introduction-to-openebs.md index 4ac10922..8911dc5c 100644 --- a/docs/versioned_docs/version-4.0.x/introduction-to-openebs/introduction-to-openebs.md +++ b/docs/versioned_docs/version-4.0.x/introduction-to-openebs/introduction-to-openebs.md @@ -14,7 +14,7 @@ OpenEBS turns any storage available to Kubernetes worker nodes into Local or Rep OpenEBS is also a leading choice for NVMe-based storage deployments. -OpenEBS was originally built by MayaData and donated to the _Cloud Native Computing Foundation_ and is now a [CNCF sandbox project](https://www.cncf.io/sandbox-projects/). +OpenEBS was originally built by MayaData and donated to the _Cloud Native Computing Foundation_. ## Why do users prefer OpenEBS? diff --git a/docs/versioned_docs/version-4.0.x/user-guides/data-migration/migration-overview.md b/docs/versioned_docs/version-4.0.x/user-guides/data-migration/migration-overview.md index bc614ab1..0af44461 100644 --- a/docs/versioned_docs/version-4.0.x/user-guides/data-migration/migration-overview.md +++ b/docs/versioned_docs/version-4.0.x/user-guides/data-migration/migration-overview.md @@ -20,8 +20,8 @@ description: This section outlines the process of migrating the legacy storage t Data migration is the process of moving data from a source storage to a destination storage. In OpenEBS context, the users can migrate the data from legacy OpenEBS storage to the latest OpenEBS storage. There are different techniques/methodologies for performing data migration. Users can perform data migration within the same Kubernetes cluster or across Kubernetes clusters. The following guides outline several methodologies for migrating from legacy OpenEBS storage to latest OpenEBS storage: -- [Migration using pv-migrate](../migration/migration-using-pv-migrate.md) -- [Migration using Velero](../migration/migration-using-velero/) +- [Migration using pv-migrate](migration-using-pv-migrate.md) +- [Migration using Velero](migration-using-velero/overview.md) :::info Users of non-OpenEBS storage solutions can also use these approaches described below to migrate their data to OpenEBS storage. diff --git a/docs/versioned_docs/version-4.0.x/user-guides/replicated-storage-user-guide/replicated-pv-mayastor/additional-information/resize.md b/docs/versioned_docs/version-4.0.x/user-guides/replicated-storage-user-guide/replicated-pv-mayastor/advanced-operations/resize.md similarity index 100% rename from docs/versioned_docs/version-4.0.x/user-guides/replicated-storage-user-guide/replicated-pv-mayastor/additional-information/resize.md rename to docs/versioned_docs/version-4.0.x/user-guides/replicated-storage-user-guide/replicated-pv-mayastor/advanced-operations/resize.md diff --git a/docs/versioned_docs/version-4.0.x/user-guides/upgrades.md b/docs/versioned_docs/version-4.0.x/user-guides/upgrades.md index ca788d43..4344a587 100644 --- a/docs/versioned_docs/version-4.0.x/user-guides/upgrades.md +++ b/docs/versioned_docs/version-4.0.x/user-guides/upgrades.md @@ -81,7 +81,8 @@ This section describes the Replicated Storage upgrade from OpenEBS Umbrella char 1. Start the helm upgrade process with the new chart, i.e. 4.0.0 by using the below command: :::caution -It is highly recommended to disable the partial rebuild during the upgrade from specific versions of OpenEBS (3.7.0, 3.8.0, 3.9.0 and 3.10.0) to OpenEBS 4.0.0 to ensure data consistency during upgrade. Input the value `--set mayastor.agents.core.rebuild.partial.enabled=false` in the upgrade command. +Disable the partial rebuild during the upgrade from specific versions of OpenEBS (3.7.0, 3.8.0, 3.9.0 and 3.10.0) to OpenEBS 4.0.0 to ensure data consistency during upgrade. Input the value `--set mayastor.agents.core.rebuild.partial.enabled=false` in the **helm upgrade** command. +This applies to the **kubectl mayastor upgrade** command as well `kubectl mayastor upgrade --set agents.core.rebuild.partial.enabled=false`. ::: ``` diff --git a/docs/versioned_sidebars/version-4.0.x-sidebars.json b/docs/versioned_sidebars/version-4.0.x-sidebars.json index 90ce7180..1ea27d8a 100644 --- a/docs/versioned_sidebars/version-4.0.x-sidebars.json +++ b/docs/versioned_sidebars/version-4.0.x-sidebars.json @@ -347,6 +347,11 @@ "id": "version-4.0.x/user-guides/replicated-storage-user-guide/replicated-pv-mayastor/advanced-operations/replica-rebuilds", "label": "Replica Rebuilds" }, + { + "type": "doc", + "id": "version-4.0.x/user-guides/replicated-storage-user-guide/replicated-pv-mayastor/advanced-operations/re-resize", + "label": "Resize" + }, { "type": "doc", "id": "version-4.0.x/user-guides/replicated-storage-user-guide/replicated-pv-mayastor/advanced-operations/supportability", @@ -427,11 +432,6 @@ "id": "version-4.0.x/user-guides/replicated-storage-user-guide/replicated-pv-mayastor/additional-information/call-home-metrics", "label": "Call-Home Metrics" }, - { - "type": "doc", - "id": "version-4.0.x/user-guides/replicated-storage-user-guide/replicated-pv-mayastor/additional-information/re-resize", - "label": "Resize" - }, { "type": "doc", "id": "version-4.0.x/user-guides/replicated-storage-user-guide/replicated-pv-mayastor/additional-information/ttps",