Skip to content

Commit f1d749a

Browse files
committed
docs: Update OSS 4.3 Docs
Signed-off-by: Bala Harish <161304963+balaharish7@users.noreply.github.com>
1 parent 7a92133 commit f1d749a

File tree

5 files changed

+36
-78
lines changed

5 files changed

+36
-78
lines changed

docs/main/user-guides/replicated-storage-user-guide/replicated-pv-mayastor/advanced-operations/snapshot-restore.md

Lines changed: 4 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -53,55 +53,11 @@ SNAPSHOT-ID                           ID       
5353

5454
## Prerequisites
5555

56-
### Step 1: Create a StorageClass
56+
Before proceeding, ensure the following Prerequisites are met:
5757

58-
To begin, you will need to create a StorageClass that defines the properties of the snapshot to be restored. Refer to [Storage Class Parameters](../../replicated-pv-mayastor/configuration/rs-storage-class-parameters.md) for more details. Use the following command to create the StorageClass:
59-
60-
:::info
61-
Currently, restores are thin-provisioned volumes created from a snapshot, Therefore, the storage class for the restored volume must also specify `thin: "true"`.
62-
:::
63-
64-
**Command**
65-
66-
```
67-
cat <<EOF | kubectl create -f -
68-
apiVersion: storage.k8s.io/v1
69-
kind: StorageClass
70-
metadata:
71-
name: mayastor-3-restore
72-
parameters:
73-
protocol: nvmf
74-
repl: "3"
75-
thin: "true"
76-
provisioner: io.openebs.csi-mayastor
77-
EOF
78-
```
79-
80-
**YAML**
81-
82-
```
83-
apiVersion: storage.k8s.io/v1
84-
kind: StorageClass
85-
metadata:
86-
name: mayastor-3-restore
87-
parameters:
88-
protocol: nvmf
89-
repl: "3"
90-
thin: "true"
91-
provisioner: io.openebs.csi-mayastor
92-
```
93-
94-
:::note
95-
The name of the StorageClass, which, in the example above, is **mayastor-3-restore**.
96-
:::
97-
98-
### Step 2: Create a Snapshot
99-
100-
You need to create a volume snapshot before proceeding with the restore. Follow the steps outlined in [this guide](snapshot.md) to create a volume snapshot.
101-
102-
:::note
103-
The snapshot's name, for example, **mayastor-pvc-snap**.
104-
:::
58+
- A volume snapshot has already been created.
59+
- A compatible StorageClass is available for the restore operation.
60+
- A snapshot has been created for the source volume. Follow the steps outlined in the [Volume Snapshots Documentation](snapshot.md) to create a volume snapshot.
10561

10662
## Create a Volume Restore of the Existing Snapshot
10763

docs/main/user-guides/replicated-storage-user-guide/replicated-pv-mayastor/configuration/rs-storage-class-parameters.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,24 @@ The `agents.core.capacity.thin` spec present in the Replicated PV Mayastor helm
5656

5757
The parameter `allowVolumeExpansion` enables the expansion of PVs when using Persistent Volume Claims (PVCs). You must set the `allowVolumeExpansion` parameter to `true` in the StorageClass to enable the expansion of a volume. In order to expand volumes where volume expansion is enabled, edit the size of the PVC. Refer to the [Resize documentation](../replicated-pv-mayastor/advanced-operations/resize.md) for more details.
5858

59+
## "formatOptions"
60+
61+
The parameter `formatOptions` allows you to specify additional formatting options to be used when formatting a device with a filesystem. By default, Replicated PV Mayastor uses the `ext4` filesystem to format devices. Depending on the `fsType` parameter, refer to the [Linux FS Documentation](https://man7.org/linux/man-pages/man8/mkfs.8.html) for supported formatting options.
62+
63+
## "overrideGlobalFormatOpts"
64+
65+
Replicated PV Mayastor provides a Helm key to define global `xfs` formatting options. These global options are applied to all volumes formatted with `xfs`. To override the global formatting options for a specific volume, set `overrideGlobalFormatOpts` to `true`. If both `formatOptions` and global Helm-defined options are specified for `xfs` volume, they will be concatenated. The `formatOptions` parameter can be used to add extra flags alongside the defaults.
66+
67+
For editing global options, set `overrideGlobalFormatOpts: true` and pass the edit flags in formatOptions.
68+
69+
For example:
70+
If global options are `-m bigtime=0 -m inobtcount=0` and if you want to use different options for a specific volume, such as `-m bigtime=1 -m inobtcount=1` then configure the volume with:
71+
72+
```
73+
overrideGlobalFormatOpts: true
74+
formatOptions: "-m bigtime=1 -m inobtcount=1"
75+
```
76+
5977
## See Also
6078

6179
- [Installation](../../../quickstart-guide/installation.md)

docs/main/user-guides/replicated-storage-user-guide/replicated-pv-mayastor/configuration/rs-topology-parameters.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,6 @@ apiVersion: storage.k8s.io/v1
3030
metadata:
3131
name: mayastor-1
3232
parameters:
33-
ioTimeout: "30"
3433
protocol: nvmf
3534
repl: "2"
3635
nodeAffinityTopologyLabel: |
@@ -70,7 +69,6 @@ apiVersion: storage.k8s.io/v1
7069
metadata:
7170
name: mayastor-1
7271
parameters:
73-
ioTimeout: "30"
7472
protocol: nvmf
7573
repl: "2"
7674
nodeHasTopologykey: |
@@ -113,7 +111,6 @@ apiVersion: storage.k8s.io/v1
113111
metadata:
114112
name: mayastor-1
115113
parameters:
116-
ioTimeout: "30"
117114
protocol: nvmf
118115
repl: "2"
119116
nodeSpreadTopologyKey: |
@@ -158,7 +155,6 @@ apiVersion: storage.k8s.io/v1
158155
metadata:
159156
name: mayastor-1
160157
parameters:
161-
ioTimeout: "30"
162158
protocol: nvmf
163159
repl: "2"
164160
poolAffinityTopologyLabel: |
@@ -239,7 +235,6 @@ apiVersion: storage.k8s.io/v1
239235
metadata:
240236
name: mayastor-1
241237
parameters:
242-
ioTimeout: "30"
243238
protocol: nvmf
244239
repl: "2"
245240
poolHasTopologykey: |

docs/main/user-guides/upgrades.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,17 @@ description: Upgrade to the latest OpenEBS version.
99
---
1010

1111
:::important
12-
The upgrade from OpenEBS 3.x to OpenEBS 4.x is supported only for the following storages installed from OpenEBS 3.x.
12+
- The upgrade from OpenEBS 3.x to OpenEBS 4.x is supported only for the following storages installed from OpenEBS 3.x.
1313

14-
- Local PV Hostpath
15-
- Local PV LVM
16-
- Local PV ZFS
17-
- Replicated PV Mayastor
14+
- Local PV Hostpath
15+
- Local PV LVM
16+
- Local PV ZFS
17+
- Replicated PV Mayastor
1818

1919
Refer to the [Migration documentation](../user-guides/data-migration/migration-overview.md) for other storages.
20+
21+
- When deploying with the OpenEBS Helm chart, use the `kubectl openebs upgrade` command to upgrade all storages.
22+
2023
:::
2124

2225
## Overview
@@ -72,16 +75,12 @@ helm repo update
7275

7376
This option is not required for upgrades from 4.x to newer versions.
7477

75-
- Add the option `--set mayastor.agents.core.rebuild.partial.enabled=false` if the source version is a 3.x release.
76-
77-
3. Start the Replicated Storage upgrade process by using the kubectl mayastor plugin v2.8.0.
78-
79-
- Re-enable the partial-rebuild feature after upgrade completes.
80-
78+
- If you have disabled the partial rebuild during the upgrade, re-enable it by using the below command after a successful upgrade.
79+
8180
```
82-
helm upgrade openebs openebs/openebs -n <namespace> --reuse-values --version 4.3 \
83-
--set mayastor.agents.core.rebuild.partial.enabled=true
81+
kubectl openebs upgrade -n <namespace> --set mayastor.agents.core.rebuild.partial.enabled=true
8482
```
83+
8584
:::
8685

8786
## Upgrade from 4.x to 4.3
@@ -92,7 +91,7 @@ Follow these steps to upgrade OpenEBS from version 4.x to 4.3:
9291

9392
2. Execute `kubectl openebs upgrade -n <namespace>` to upgrade OpenEBS.
9493

95-
3. Monitor the upgrade status using `kubectl openebs get upgrade status -n <namespace>`.
94+
3. Monitor the upgrade status using `kubectl openebs upgrade status -n <namespace>`.
9695

9796
4. Verify that the CRDs, Volumes, Snapshots, and StoragePools are not affected by the upgrade process.
9897

docs/sidebars.js

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -370,11 +370,6 @@ module.exports = {
370370
icon: "List"
371371
},
372372
items: [
373-
{
374-
type: "doc",
375-
id: "user-guides/local-storage-user-guide/additional-information/alphafeatures",
376-
label: "Alpha Features"
377-
},
378373
{
379374
type: "doc",
380375
id: "user-guides/local-storage-user-guide/additional-information/k8supgrades",
@@ -536,12 +531,7 @@ module.exports = {
536531
{
537532
type: "doc",
538533
id: "user-guides/replicated-storage-user-guide/replicated-pv-mayastor/additional-information/upgrade-re",
539-
label: "Upgrades"
540-
},
541-
{
542-
type: "doc",
543-
id: "user-guides/replicated-storage-user-guide/replicated-pv-mayastor/additional-information/legacy-upgrade",
544-
label: "Legacy Upgrades"
534+
label: "Mayastor Upgrades"
545535
},
546536
{
547537
type: "doc",

0 commit comments

Comments
 (0)