Skip to content

Commit

Permalink
docs: replace "preview" with "experimental"
Browse files Browse the repository at this point in the history
Longhorn 9794

Signed-off-by: Derek Su <[email protected]>
  • Loading branch information
derekbit committed Jan 17, 2025
1 parent eecf9d6 commit 25ea7fc
Show file tree
Hide file tree
Showing 82 changed files with 131 additions and 129 deletions.
2 changes: 1 addition & 1 deletion content/docs/1.6.0/deploy/important-notes/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ Settings are synchronized hourly. When all volumes are detached, the settings in
| [System Managed Components Node Selector](../../references/settings/#system-managed-components-node-selector) | [Node Selector](../../advanced-resources/deploy/node-selector/) | System-managed components |
| [Storage Network](../../references/settings/#storage-network) | [Storage Network](../../advanced-resources/deploy/storage-network/) | Instance Manager and Backing Image components |
| [V1 Data Engine](../../references/settings/#v1-data-engine) || Instance Manager component |
| [V2 Data Engine](../../references/settings/#v2-data-engine) | [V2 Data Engine (Preview Feature)](../../v2-data-engine/) | Instance Manager component |
| [V2 Data Engine](../../references/settings/#v2-data-engine) | [V2 Data Engine (Experimental)](../../v2-data-engine/) | Instance Manager component |
| [Guaranteed Instance Manager CPU](../../references/settings/#guaranteed-instance-manager-cpu) || Instance Manager component |
| [Guaranteed Instance Manager CPU for V2 Data Engine](../../references/settings/#guaranteed-instance-manager-cpu-for-v2-data-engine) || Instance Manager component |

Expand Down
2 changes: 1 addition & 1 deletion content/docs/1.6.0/references/helm-values.md
Original file line number Diff line number Diff line change
Expand Up @@ -256,6 +256,6 @@ During installation, you can either allow Longhorn to use the default system set
| defaultSettings.taintToleration | Taint or toleration for system-managed Longhorn components. |
| defaultSettings.upgradeChecker | Upgrade Checker that periodically checks for new Longhorn versions. When a new version is available, a notification appears on the Longhorn UI. This setting is enabled by default |
| defaultSettings.v1DataEngine | Setting that allows you to enable the V1 Data Engine. |
| defaultSettings.v2DataEngine | Setting that allows you to enable the V2 Data Engine, which is based on the Storage Performance Development Kit (SPDK). The V2 Data Engine is a preview feature and should not be used in production environments. |
| defaultSettings.v2DataEngine | Setting that allows you to enable the V2 Data Engine, which is based on the Storage Performance Development Kit (SPDK). The V2 Data Engine is an experimental feature and should not be used in production environments. |
| defaultSettings.v2DataEngineGuaranteedInstanceManagerCPU | Number of millicpus on each node to be reserved for each Instance Manager pod when the V2 Data Engine is enabled. The default value is "1250". |
| defaultSettings.v2DataEngineHugepageLimit | Setting that allows you to configure maximum huge page size (in MiB) for the V2 Data Engine. |
8 changes: 4 additions & 4 deletions content/docs/1.6.0/references/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ weight: 1
- [Fast Replica Rebuild Enabled](#fast-replica-rebuild-enabled)
- [Timeout of HTTP Client to Replica File Sync Server](#timeout-of-http-client-to-replica-file-sync-server)
- [V1 Data Engine](#v1-data-engine)
- [V2 Data Engine (Preview Feature)](#v2-data-engine-preview-feature)
- [V2 Data Engine (Experimental)](#v2-data-engine-experimental)
- [V2 Data Engine](#v2-data-engine)
- [V2 Data Engine Hugepage Limit](#v2-data-engine-hugepage-limit)
- [Guaranteed Instance Manager CPU for V2 Data Engine](#guaranteed-instance-manager-cpu-for-v2-data-engine)
Expand Down Expand Up @@ -443,12 +443,12 @@ The value in seconds specifies the timeout of the HTTP client to the replica's f
Setting that allows you to enable the V1 Data Engine.

### V2 Data Engine (Preview Feature)
### V2 Data Engine (Experimental)
#### V2 Data Engine

> Default: `false`
Setting that allows you to enable the V2 Data Engine, which is based on the Storage Performance Development Kit (SPDK). The V2 Data Engine is a preview feature and should not be used in production environments. For more information, see [V2 Data Engine (Preview Feature)](../../v2-data-engine).
Setting that allows you to enable the V2 Data Engine, which is based on the Storage Performance Development Kit (SPDK). The V2 Data Engine is an experimental feature and should not be used in production environments. For more information, see [V2 Data Engine (Experimental)](../../v2-data-engine).

> **Warning**
>
Expand Down Expand Up @@ -754,7 +754,7 @@ Settings are synchronized hourly. When all volumes are detached, the settings in
| [System Managed Components Node Selector](#system-managed-components-node-selector) | [Node Selector](../../advanced-resources/deploy/node-selector/) | System-managed components |
| [Storage Network](#storage-network) | [Storage Network](../../advanced-resources/deploy/storage-network/) | Instance Manager and Backing Image components |
| [V1 Data Engine](#v1-data-engine) || Instance Manager component |
| [V2 Data Engine](#v2-data-engine) | [V2 Data Engine (Preview Feature)](../../v2-data-engine/) | Instance Manager component |
| [V2 Data Engine](#v2-data-engine) | [V2 Data Engine (Experimental)](../../v2-data-engine/) | Instance Manager component |
| [Guaranteed Instance Manager CPU](#guaranteed-instance-manager-cpu) || Instance Manager component |
| [Guaranteed Instance Manager CPU for V2 Data Engine](#guaranteed-instance-manager-cpu-for-v2-data-engine) || Instance Manager component |

Expand Down
2 changes: 1 addition & 1 deletion content/docs/1.6.0/references/storage-class-parameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@ A list of recurring jobs that are to be run on a volume.
#### Data Engine *(field: `parameters.dataEngine`)*
> Default: `"v1"`
- Specify "v2" to enable the V2 Data Engine (preview feature in v1.6.0). When unspecified, Longhorn uses the default value ("v1").
- Specify "v2" to enable the V2 Data Engine (experimental feature in v1.6.0). When unspecified, Longhorn uses the default value ("v1").

> Global setting: [V2 Data Engine](../settings#v2-data-engine).
> More details in [V2 Data Engine Quick Start](../../v2-data-engine/quick-start#create-a-storageclass).
Expand Down
2 changes: 1 addition & 1 deletion content/docs/1.6.0/v2-data-engine/_index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: V2 Data Engine (Preview Feature)
title: V2 Data Engine (Experimental)
weight: 0
aliases:
- /spdk/_index.md
Expand Down
2 changes: 1 addition & 1 deletion content/docs/1.6.0/v2-data-engine/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ aliases:

Longhorn's V2 Data Engine harnesses the power of the Storage Performance Development Kit (SPDK) to elevate its overall performance. The integration significantly reduces I/O latency while simultaneously boosting IOPS and throughput. The enhancement provides a high-performance storage solution capable of meeting diverse workload demands.

**V2 Data Engine is currently a PREVIEW feature and should NOT be utilized in a production environment.** At present, a volume with V2 Data Engine only supports
**V2 Data Engine is currently an experimental feature and should NOT be utilized in a production environment.** At present, a volume with V2 Data Engine only supports

- Volume lifecycle (creation, attachment, detachment and deletion)
- Degraded volume
Expand Down
2 changes: 1 addition & 1 deletion content/docs/1.6.1/deploy/important-notes/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ Settings are synchronized hourly. When all volumes are detached, the settings in
| [System Managed Components Node Selector](../../references/settings/#system-managed-components-node-selector) | [Node Selector](../../advanced-resources/deploy/node-selector/) | System-managed components |
| [Storage Network](../../references/settings/#storage-network) | [Storage Network](../../advanced-resources/deploy/storage-network/) | Instance Manager and Backing Image components |
| [V1 Data Engine](../../references/settings/#v1-data-engine) || Instance Manager component |
| [V2 Data Engine](../../references/settings/#v2-data-engine) | [V2 Data Engine (Preview Feature)](../../v2-data-engine/) | Instance Manager component |
| [V2 Data Engine](../../references/settings/#v2-data-engine) | [V2 Data Engine (Experimental)](../../v2-data-engine/) | Instance Manager component |
| [Guaranteed Instance Manager CPU](../../references/settings/#guaranteed-instance-manager-cpu) || Instance Manager component |
| [Guaranteed Instance Manager CPU for V2 Data Engine](../../references/settings/#guaranteed-instance-manager-cpu-for-v2-data-engine) || Instance Manager component |

Expand Down
2 changes: 1 addition & 1 deletion content/docs/1.6.1/references/helm-values.md
Original file line number Diff line number Diff line change
Expand Up @@ -256,6 +256,6 @@ During installation, you can either allow Longhorn to use the default system set
| defaultSettings.taintToleration | Taint or toleration for system-managed Longhorn components. |
| defaultSettings.upgradeChecker | Upgrade Checker that periodically checks for new Longhorn versions. When a new version is available, a notification appears on the Longhorn UI. This setting is enabled by default |
| defaultSettings.v1DataEngine | Setting that allows you to enable the V1 Data Engine. |
| defaultSettings.v2DataEngine | Setting that allows you to enable the V2 Data Engine, which is based on the Storage Performance Development Kit (SPDK). The V2 Data Engine is a preview feature and should not be used in production environments. |
| defaultSettings.v2DataEngine | Setting that allows you to enable the V2 Data Engine, which is based on the Storage Performance Development Kit (SPDK). The V2 Data Engine is an experimental feature and should not be used in production environments. |
| defaultSettings.v2DataEngineGuaranteedInstanceManagerCPU | Number of millicpus on each node to be reserved for each Instance Manager pod when the V2 Data Engine is enabled. The default value is "1250". |
| defaultSettings.v2DataEngineHugepageLimit | Setting that allows you to configure maximum huge page size (in MiB) for the V2 Data Engine. |
8 changes: 4 additions & 4 deletions content/docs/1.6.1/references/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ weight: 1
- [Fast Replica Rebuild Enabled](#fast-replica-rebuild-enabled)
- [Timeout of HTTP Client to Replica File Sync Server](#timeout-of-http-client-to-replica-file-sync-server)
- [V1 Data Engine](#v1-data-engine)
- [V2 Data Engine (Preview Feature)](#v2-data-engine-preview-feature)
- [V2 Data Engine (Experimental)](#v2-data-engine-experimental)
- [V2 Data Engine](#v2-data-engine)
- [V2 Data Engine Hugepage Limit](#v2-data-engine-hugepage-limit)
- [Guaranteed Instance Manager CPU for V2 Data Engine](#guaranteed-instance-manager-cpu-for-v2-data-engine)
Expand Down Expand Up @@ -443,12 +443,12 @@ The value in seconds specifies the timeout of the HTTP client to the replica's f
Setting that allows you to enable the V1 Data Engine.

### V2 Data Engine (Preview Feature)
### V2 Data Engine (Experimental)
#### V2 Data Engine

> Default: `false`
Setting that allows you to enable the V2 Data Engine, which is based on the Storage Performance Development Kit (SPDK). The V2 Data Engine is a preview feature and should not be used in production environments. For more information, see [V2 Data Engine (Preview Feature)](../../v2-data-engine).
Setting that allows you to enable the V2 Data Engine, which is based on the Storage Performance Development Kit (SPDK). The V2 Data Engine is an experimental feature and should not be used in production environments. For more information, see [V2 Data Engine (Experimental)](../../v2-data-engine).

> **Warning**
>
Expand Down Expand Up @@ -754,7 +754,7 @@ Settings are synchronized hourly. When all volumes are detached, the settings in
| [System Managed Components Node Selector](#system-managed-components-node-selector) | [Node Selector](../../advanced-resources/deploy/node-selector/) | System-managed components |
| [Storage Network](#storage-network) | [Storage Network](../../advanced-resources/deploy/storage-network/) | Instance Manager and Backing Image components |
| [V1 Data Engine](#v1-data-engine) || Instance Manager component |
| [V2 Data Engine](#v2-data-engine) | [V2 Data Engine (Preview Feature)](../../v2-data-engine/) | Instance Manager component |
| [V2 Data Engine](#v2-data-engine) | [V2 Data Engine (Experimental)](../../v2-data-engine/) | Instance Manager component |
| [Guaranteed Instance Manager CPU](#guaranteed-instance-manager-cpu) || Instance Manager component |
| [Guaranteed Instance Manager CPU for V2 Data Engine](#guaranteed-instance-manager-cpu-for-v2-data-engine) || Instance Manager component |

Expand Down
2 changes: 1 addition & 1 deletion content/docs/1.6.1/references/storage-class-parameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@ A list of recurring jobs that are to be run on a volume.
#### Data Engine *(field: `parameters.dataEngine`)*
> Default: `"v1"`
- Specify "v2" to enable the V2 Data Engine (preview feature in v1.6.0). When unspecified, Longhorn uses the default value ("v1").
- Specify "v2" to enable the V2 Data Engine (experimental feature in v1.6.0). When unspecified, Longhorn uses the default value ("v1").

> Global setting: [V2 Data Engine](../settings#v2-data-engine).
> More details in [V2 Data Engine Quick Start](../../v2-data-engine/quick-start#create-a-storageclass).
Expand Down
2 changes: 1 addition & 1 deletion content/docs/1.6.1/v2-data-engine/_index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: V2 Data Engine (Preview Feature)
title: V2 Data Engine (Experimental)
weight: 0
aliases:
- /spdk/_index.md
Expand Down
2 changes: 1 addition & 1 deletion content/docs/1.6.1/v2-data-engine/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ aliases:

Longhorn's V2 Data Engine harnesses the power of the Storage Performance Development Kit (SPDK) to elevate its overall performance. The integration significantly reduces I/O latency while simultaneously boosting IOPS and throughput. The enhancement provides a high-performance storage solution capable of meeting diverse workload demands.

**V2 Data Engine is currently a PREVIEW feature and should NOT be utilized in a production environment.** At present, a volume with V2 Data Engine only supports
**V2 Data Engine is currently an experimental feature and should NOT be utilized in a production environment.** At present, a volume with V2 Data Engine only supports

- Volume lifecycle (creation, attachment, detachment and deletion)
- Degraded volume
Expand Down
2 changes: 1 addition & 1 deletion content/docs/1.6.2/deploy/important-notes/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ Settings are synchronized hourly. When all volumes are detached, the settings in
| [System Managed Components Node Selector](../../references/settings/#system-managed-components-node-selector) | [Node Selector](../../advanced-resources/deploy/node-selector/) | System-managed components |
| [Storage Network](../../references/settings/#storage-network) | [Storage Network](../../advanced-resources/deploy/storage-network/) | Instance Manager and Backing Image components |
| [V1 Data Engine](../../references/settings/#v1-data-engine) || Instance Manager component |
| [V2 Data Engine](../../references/settings/#v2-data-engine) | [V2 Data Engine (Preview Feature)](../../v2-data-engine/) | Instance Manager component |
| [V2 Data Engine](../../references/settings/#v2-data-engine) | [V2 Data Engine (Experimental)](../../v2-data-engine/) | Instance Manager component |
| [Guaranteed Instance Manager CPU](../../references/settings/#guaranteed-instance-manager-cpu) || Instance Manager component |
| [Guaranteed Instance Manager CPU for V2 Data Engine](../../references/settings/#guaranteed-instance-manager-cpu-for-v2-data-engine) || Instance Manager component |

Expand Down
2 changes: 1 addition & 1 deletion content/docs/1.6.2/references/helm-values.md
Original file line number Diff line number Diff line change
Expand Up @@ -256,6 +256,6 @@ During installation, you can either allow Longhorn to use the default system set
| defaultSettings.taintToleration | Taint or toleration for system-managed Longhorn components. Specify values using a semicolon-separated list in `kubectl taint` syntax (Example: key1=value1:effect; key2=value2:effect). |
| defaultSettings.upgradeChecker | Upgrade Checker that periodically checks for new Longhorn versions. When a new version is available, a notification appears on the Longhorn UI. This setting is enabled by default |
| defaultSettings.v1DataEngine | Setting that allows you to enable the V1 Data Engine. |
| defaultSettings.v2DataEngine | Setting that allows you to enable the V2 Data Engine, which is based on the Storage Performance Development Kit (SPDK). The V2 Data Engine is a preview feature and should not be used in production environments. |
| defaultSettings.v2DataEngine | Setting that allows you to enable the V2 Data Engine, which is based on the Storage Performance Development Kit (SPDK). The V2 Data Engine is an experimental feature and should not be used in production environments. |
| defaultSettings.v2DataEngineGuaranteedInstanceManagerCPU | Number of millicpus on each node to be reserved for each Instance Manager pod when the V2 Data Engine is enabled. The default value is "1250". |
| defaultSettings.v2DataEngineHugepageLimit | Setting that allows you to configure maximum huge page size (in MiB) for the V2 Data Engine. |
8 changes: 4 additions & 4 deletions content/docs/1.6.2/references/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ weight: 1
- [Fast Replica Rebuild Enabled](#fast-replica-rebuild-enabled)
- [Timeout of HTTP Client to Replica File Sync Server](#timeout-of-http-client-to-replica-file-sync-server)
- [V1 Data Engine](#v1-data-engine)
- [V2 Data Engine (Preview Feature)](#v2-data-engine-preview-feature)
- [V2 Data Engine (Experimental)](#v2-data-engine-experimental)
- [V2 Data Engine](#v2-data-engine)
- [V2 Data Engine Hugepage Limit](#v2-data-engine-hugepage-limit)
- [Guaranteed Instance Manager CPU for V2 Data Engine](#guaranteed-instance-manager-cpu-for-v2-data-engine)
Expand Down Expand Up @@ -443,12 +443,12 @@ The value in seconds specifies the timeout of the HTTP client to the replica's f
Setting that allows you to enable the V1 Data Engine.

### V2 Data Engine (Preview Feature)
### V2 Data Engine (Experimental)
#### V2 Data Engine

> Default: `false`
Setting that allows you to enable the V2 Data Engine, which is based on the Storage Performance Development Kit (SPDK). The V2 Data Engine is a preview feature and should not be used in production environments. For more information, see [V2 Data Engine (Preview Feature)](../../v2-data-engine).
Setting that allows you to enable the V2 Data Engine, which is based on the Storage Performance Development Kit (SPDK). The V2 Data Engine is an experimental feature and should not be used in production environments. For more information, see [V2 Data Engine (Experimental)](../../v2-data-engine).

> **Warning**
>
Expand Down Expand Up @@ -754,7 +754,7 @@ Settings are synchronized hourly. When all volumes are detached, the settings in
| [System Managed Components Node Selector](#system-managed-components-node-selector) | [Node Selector](../../advanced-resources/deploy/node-selector/) | System-managed components |
| [Storage Network](#storage-network) | [Storage Network](../../advanced-resources/deploy/storage-network/) | Instance Manager and Backing Image components |
| [V1 Data Engine](#v1-data-engine) || Instance Manager component |
| [V2 Data Engine](#v2-data-engine) | [V2 Data Engine (Preview Feature)](../../v2-data-engine/) | Instance Manager component |
| [V2 Data Engine](#v2-data-engine) | [V2 Data Engine (Experimental)](../../v2-data-engine/) | Instance Manager component |
| [Guaranteed Instance Manager CPU](#guaranteed-instance-manager-cpu) || Instance Manager component |
| [Guaranteed Instance Manager CPU for V2 Data Engine](#guaranteed-instance-manager-cpu-for-v2-data-engine) || Instance Manager component |

Expand Down
2 changes: 1 addition & 1 deletion content/docs/1.6.2/references/storage-class-parameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@ A list of recurring jobs that are to be run on a volume.
#### Data Engine *(field: `parameters.dataEngine`)*
> Default: `"v1"`
- Specify "v2" to enable the V2 Data Engine (preview feature in v1.6.0). When unspecified, Longhorn uses the default value ("v1").
- Specify "v2" to enable the V2 Data Engine (experimental feature in v1.6.0). When unspecified, Longhorn uses the default value ("v1").

> Global setting: [V2 Data Engine](../settings#v2-data-engine).
> More details in [V2 Data Engine Quick Start](../../v2-data-engine/quick-start#create-a-storageclass).
Expand Down
2 changes: 1 addition & 1 deletion content/docs/1.6.2/v2-data-engine/_index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: V2 Data Engine (Preview Feature)
title: V2 Data Engine (Experimental)
weight: 0
aliases:
- /spdk/_index.md
Expand Down
2 changes: 1 addition & 1 deletion content/docs/1.6.2/v2-data-engine/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ aliases:

Longhorn's V2 Data Engine harnesses the power of the Storage Performance Development Kit (SPDK) to elevate its overall performance. The integration significantly reduces I/O latency while simultaneously boosting IOPS and throughput. The enhancement provides a high-performance storage solution capable of meeting diverse workload demands.

**V2 Data Engine is currently a PREVIEW feature and should NOT be utilized in a production environment.** At present, a volume with V2 Data Engine only supports
**V2 Data Engine is currently an experimental feature and should NOT be utilized in a production environment.** At present, a volume with V2 Data Engine only supports

- Volume lifecycle (creation, attachment, detachment and deletion)
- Degraded volume
Expand Down
Loading

0 comments on commit 25ea7fc

Please sign in to comment.