Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: changes for release 2.5 #190

Merged
merged 1 commit into from
Dec 18, 2023
Merged

docs: changes for release 2.5 #190

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,6 @@ description: 'The native NVMe-oF CAS engine of OpenEBS'

# Welcome to Mayastor!

{% hint style="danger" %}
### This documentation is staged on an unstable branch
It is provided here as a convenience to the writers, reviewers and editors of Mayastor's user documentation, to provide easy visualisation of content before publishing. It MUST NOT be used to guide the installation or use of Mayastor, other than for pre-release testing outside of production. As a staging branch, it is expected at times to contain errors and to be incomplete.
The official Mayastor User Reference for the latest GA release can be found [here](https://mayastor.gitbook.io/)
{% 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.
Expand Down
6 changes: 3 additions & 3 deletions quickstart/deploy-mayastor.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ helm search repo mayastor --versions
{% tab title="Sample Output" %}
```text
NAME CHART VERSION APP VERSION DESCRIPTION
mayastor/mayastor 2.4.0 2.4.0 Mayastor Helm chart for Kubernetes
mayastor/mayastor 2.5.0 2.5.0 Mayastor Helm chart for Kubernetes
```
{% endtab %}
{% endtabs %}
Expand All @@ -53,11 +53,11 @@ To discover all the versions (including unstable versions), execute:
{% endhint %}


3. Run the following command to install Mayastor _version 2.4.
3. Run the following command to install Mayastor _version 2.5.
{% tabs %}
{% tab title="Command" %}
```text
helm install mayastor mayastor/mayastor -n mayastor --create-namespace --version 2.4.0
helm install mayastor mayastor/mayastor -n mayastor --create-namespace --version 2.5.0
```
{% endtab %}
{% tab title="Sample Output" %}
Expand Down
2 changes: 1 addition & 1 deletion quickstart/troubleshooting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -299,7 +299,7 @@ Thread 1 (Thread 0x7f782559f040 (LWP 56)):

## Diskpool behaviour

The below behaviour may be encountered while uprading from older releases to Mayastor 2.4 release and above.
The below behaviour may be encountered while uprading from older releases to Mayastor 2.5 release and above.

### Get Dsp

Expand Down
8 changes: 0 additions & 8 deletions reference/storage-class-parameters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,6 @@ File system that will be used when mounting the volume.
The supported file systems are **ext4**, **xfs** and **btrfs** and the default file system when not specified is **ext4**. We recommend to use **xfs** that is considered to be more advanced and performant.
Please ensure the requested filesystem driver is installed on all worker nodes in the cluster before using it.

## "ioTimeout"

Expressed in seconds and it sets the `io_timeout` parameter in the linux block device driver for Mayastor volume. It also sets `ctrl-loss-tmo` timeout in linux NVMe driver that is used for detecting inaccessible target (nexus in our case). In either case, if IO cannot be served by Mayastor volume, because it is stuck or because the nvmf target is not there, it will take roughly this time to the initiator to return an error to data consumer, which can be either filesystem or an application if using raw block volume. The usual reaction of a filesystem to such error is to switch the filesystem to read-only state and require manual intervention from user - remounting. Be careful when setting this to a low value because any node reboot that does not fit into this time interval may require manual intervention afterwards or can result in application failure - depending on how the error is handled by the application.

{% hint style="info" %}
The setting is supported only when using "nvmf" protocol.
{% endhint %}

## "protocol"

The parameter 'protocol' takes the value `nvmf`(NVMe over TCP protocol). It is used to mount the volume (target) on the application node.
Expand Down
4 changes: 2 additions & 2 deletions reference/upgrade.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Mayastor supports seamless upgrades starting with target version 2.1.0 and later

### Supported upgrade paths

- From 2.0.x to 2.4.0
- From 2.0.x to 2.5.0

{% hint style="info" %}
- The upgrade operation utilises the [Mayastor Kubectl Plugin](https://mayastor.gitbook.io/introduction/advanced-operations/kubectl-plugin).
Expand Down Expand Up @@ -74,7 +74,7 @@ kubectl mayastor get upgrade-status
{% tab title="Expected Output" %}
```text
Upgrade From: 2.0.0
Upgrade To: 2.4.0
Upgrade To: 2.5.0
Upgrade Status: Successfully upgraded Mayastor
```
{% endtab %}
Expand Down
Loading