From 64f307f4703a0818e46f8e7c96209603a4022edc Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Wed, 3 Jan 2024 15:15:29 -0700 Subject: [PATCH 1/9] docs: DOC-990 --- docs/docs-content/integrations/longhorn.md | 62 +++++++++++++++++----- 1 file changed, 48 insertions(+), 14 deletions(-) diff --git a/docs/docs-content/integrations/longhorn.md b/docs/docs-content/integrations/longhorn.md index b59c456be7..3cf5253d5b 100644 --- a/docs/docs-content/integrations/longhorn.md +++ b/docs/docs-content/integrations/longhorn.md @@ -17,6 +17,39 @@ Longhorn creates a dedicated storage controller for each block device volume and ## Version Supported + + + +## Prerequisites + +- Kubernetes cluster is 1.21 or higher. + +## Parameters + +The table lists commonly used parameters you can configure when adding this pack. + +| Parameter | Description | Default | +|-------------------------|--------------------------------------------------------|---------------------------------------------| +| `defaultClass` | The volume type to be used. | `true` | +| `defaultFsType` | The default file system. | `ext4` | +| `defaultClassReplicaCount`| The default number of copies of data store in your cluster. | `3` | +| `defaultDataLocality` | The default location where data computation will occur. | `disabled` Best effort | +| `reclaimPolicy` | This means that a dynamically provisioned volume will be automatically deleted when deletes when corresponding PersistentVolumeClaim is deleted. For important data, it is more appropriate to use the "Retain" policy | `Delete` | +| `migratable` | The ability to transfer data to another data storage systems | `false` | +| `recurringJobSelector.enable` | The management of recurring jobs. You can enable this feature and type a comma-separated list of jobs to run: `recurringJobSelector.enable.jobList [ ]` | `false` | + +## Usage + +Longhorn provides these features: + +- Enterprise-grade distributed storage with no single point of failure. +- Incremental snapshots of block storage. +- Backup to secondary storage (NFSv4 or S3-compatible object storage) built on change block detection. +- Recurring snapshot and backup. + +For more information, check out Longhorn guide on [How to Create Volumes](https://longhorn.io/docs/1.4.0/volumes-and-nodes/create-volumes/). + + @@ -31,13 +64,14 @@ The table lists commonly used parameters you can configure when adding this pack | Parameter | Description | Default | |-------------------------|--------------------------------------------------------|---------------------------------------------| -| defaultClass | The volume type to be used. | `true` | -| defaultFsType | The default file system. | `ext4` | -| defaultClassReplicaCount| The default number of copies of data store in your cluster. | `3` | -| defaultDataLocality | The default location where data computation will occur. | `disabled` Best effort | -| reclaimPolicy | This means that a dynamically provisioned volume will be automatically deleted when deletes when corresponding PersistentVolumeClaim is deleted. For important data, it is more appropriate to use the "Retain" policy | `Delete` | -| migratable | The ability to transfer data to another data storage systems | `false` | -| recurringJobSelector:enable | The management of recurring jobs. You can enable this feature and type a comma-separated list of jobs to run: `recurringJobSelector:enable:jobList [ ]` | `false` | +| `defaultClass` | The volume type to be used. | `true` | +| `defaultFsType` | The default file system. | `ext4` | +| `defaultClassReplicaCount`| The default number of copies of data store in your cluster. | `3` | +| `defaultDataLocality` | The default location where data computation will occur. | `disabled` Best effort | +| `reclaimPolicy` | This means that a dynamically provisioned volume will be automatically deleted when deletes when corresponding PersistentVolumeClaim is deleted. For important data, it is more appropriate to use the "Retain" policy | `Delete` | +| `migratable` | The ability to transfer data to another data storage systems | `false` | +| `recurringJobSelector.enable` | The management of recurring jobs. You can enable this feature and type a comma-separated list of jobs to run: `recurringJobSelector.enable.jobList [ ]` | `false` | +curringJobSelector:enable | The management of recurring jobs. You can enable this feature and type a comma-separated list of jobs to run: `recurringJobSelector:enable:jobList [ ]` | `false` | ## Usage @@ -65,13 +99,13 @@ The table lists commonly used parameters you can configure when adding this pack | Parameter | Description | Default | |-------------------------|--------------------------------------------------------|---------------------------------------------| -| defaultClass | The volume type to be used. | `true` | -| defaultFsType | The default file system. | `ext4` | -| defaultClassReplicaCount| The default number of copies of data store in your cluster. | `3` | -| defaultDataLocality | The default location where data computation will occur. | `disabled` Best effort | -| reclaimPolicy | This means that a dynamically provisioned volume will be automatically deleted when deletes when corresponding PersistentVolumeClaim is deleted. For important data, it is more appropriate to use the "Retain" policy | `Delete` | -| migratable | The ability to transfer data to another data storage systems | `false` | -| recurringJobSelector:enable | The management of recurring jobs. You can enable this feature and type a comma-separated list of jobs to run: `recurringJobSelector:enable:jobList [ ]` | `false` | +| `defaultClass` | The volume type to be used. | `true` | +| `defaultFsType` | The default file system. | `ext4` | +| `defaultClassReplicaCount`| The default number of copies of data store in your cluster. | `3` | +| `defaultDataLocality` | The default location where data computation will occur. | `disabled` Best effort | +| `reclaimPolicy` | This means that a dynamically provisioned volume will be automatically deleted when deletes when corresponding PersistentVolumeClaim is deleted. For important data, it is more appropriate to use the "Retain" policy | `Delete` | +| `migratable` | The ability to transfer data to another data storage systems | `false` | +| `recurringJobSelector.enable` | The management of recurring jobs. You can enable this feature and type a comma-separated list of jobs to run: `recurringJobSelector.enable.jobList [ ]` | `false` | ## Usage From a36351f0ecd79420bf1b8452388082bde0c5a376 Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Thu, 4 Jan 2024 10:51:56 -0700 Subject: [PATCH 2/9] docs: DOC-990 PE-3357 --- docs/docs-content/integrations/longhorn.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/docs/docs-content/integrations/longhorn.md b/docs/docs-content/integrations/longhorn.md index 3cf5253d5b..4e18662d17 100644 --- a/docs/docs-content/integrations/longhorn.md +++ b/docs/docs-content/integrations/longhorn.md @@ -30,6 +30,7 @@ The table lists commonly used parameters you can configure when adding this pack | Parameter | Description | Default | |-------------------------|--------------------------------------------------------|---------------------------------------------| +| `namespace` | The namespace where the Longhorn will be installed. | `longhorn-system` | | `defaultClass` | The volume type to be used. | `true` | | `defaultFsType` | The default file system. | `ext4` | | `defaultClassReplicaCount`| The default number of copies of data store in your cluster. | `3` | @@ -49,11 +50,26 @@ Longhorn provides these features: For more information, check out Longhorn guide on [How to Create Volumes](https://longhorn.io/docs/1.4.0/volumes-and-nodes/create-volumes/). + +## Troubleshooting + +### Deadlock With RWX Mode + +Starting with version 1.5.X, a known issue exists where a deadlock occurs when using RWX mode. + +To resolve + + + +You can learn more about the issue in by following the [issue discussion](https://github.com/longhorn/longhorn/issues/7183#issuecomment-1823715359) on GitHub. + + + ## Prerequisites - Kubernetes cluster is 1.21 or higher. @@ -64,6 +80,7 @@ The table lists commonly used parameters you can configure when adding this pack | Parameter | Description | Default | |-------------------------|--------------------------------------------------------|---------------------------------------------| +| `namespace` | The namespace where the Longhorn will be installed. | `longhorn-system` | | `defaultClass` | The volume type to be used. | `true` | | `defaultFsType` | The default file system. | `ext4` | | `defaultClassReplicaCount`| The default number of copies of data store in your cluster. | `3` | @@ -99,6 +116,7 @@ The table lists commonly used parameters you can configure when adding this pack | Parameter | Description | Default | |-------------------------|--------------------------------------------------------|---------------------------------------------| +| `namespace` | The namespace where the Longhorn will be installed. | `longhorn-system` | | `defaultClass` | The volume type to be used. | `true` | | `defaultFsType` | The default file system. | `ext4` | | `defaultClassReplicaCount`| The default number of copies of data store in your cluster. | `3` | From 7c5f995be5afa721307c7cdd3320389dd8cd678c Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Thu, 4 Jan 2024 11:50:55 -0700 Subject: [PATCH 3/9] docs: draft ready for review --- docs/docs-content/integrations/longhorn.md | 21 ++++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) diff --git a/docs/docs-content/integrations/longhorn.md b/docs/docs-content/integrations/longhorn.md index 4e18662d17..565878b2ef 100644 --- a/docs/docs-content/integrations/longhorn.md +++ b/docs/docs-content/integrations/longhorn.md @@ -53,16 +53,31 @@ For more information, check out Longhorn guide on [How to Create Volumes](https: ## Troubleshooting +Below are some common issues you may encounter when using Longhorn. Use the following information to help you troubleshoot and resolve the issue. + ### Deadlock With RWX Mode -Starting with version 1.5.X, a known issue exists where a deadlock occurs when using RWX mode. +Starting with version 1.5.X, a known issue exists where a deadlock may occurs when using a RWX volume and a cluster node is recreated. This issue is disclosed as a known issue in the [Longhorn GitHub repository](https://github.com/longhorn/longhorn/wiki/Release-Known-Issues#v153). + +To resolve the deadlock, you must manually update the status of the Longhorn Storage Manager. Use the following command to resolve the deadlock. Replace `PVC-ID` with the ID of the Persistent Volume Claim (PVC) that is stuck in the `error` state. + +```bash +kubectl --namespace longhorn-system patch lhsm PVC-ID \ +--type=merge --subresource status --patch 'status: {state: error}' +``` + +:::tip -To resolve +To identify the ID of the PVC, use the following command to list all PVCs in the `longhorn-system` namespace. Seach for the PVC that has the **ACCESS MODE** set to **RWX**. +```bash +kubectl get pvc --namespace longhorn-system +``` +::: -You can learn more about the issue in by following the [issue discussion](https://github.com/longhorn/longhorn/issues/7183#issuecomment-1823715359) on GitHub. +There are other workaround solutions provided by the community in the [issue discussion](https://github.com/longhorn/longhorn/issues/7183#issuecomment-1823715359) that you may explore if you are searching for an alternative solution. From 39b50e410ea6bf71398b0d38c839e2f94583f1f0 Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Thu, 4 Jan 2024 13:36:04 -0700 Subject: [PATCH 4/9] docs: updated statement --- docs/docs-content/integrations/longhorn.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs-content/integrations/longhorn.md b/docs/docs-content/integrations/longhorn.md index 565878b2ef..c72bca4f28 100644 --- a/docs/docs-content/integrations/longhorn.md +++ b/docs/docs-content/integrations/longhorn.md @@ -59,7 +59,7 @@ Below are some common issues you may encounter when using Longhorn. Use the foll Starting with version 1.5.X, a known issue exists where a deadlock may occurs when using a RWX volume and a cluster node is recreated. This issue is disclosed as a known issue in the [Longhorn GitHub repository](https://github.com/longhorn/longhorn/wiki/Release-Known-Issues#v153). -To resolve the deadlock, you must manually update the status of the Longhorn Storage Manager. Use the following command to resolve the deadlock. Replace `PVC-ID` with the ID of the Persistent Volume Claim (PVC) that is stuck in the `error` state. +To resolve the deadlock, you must manually update the status of the Longhorn Storage Manager. Use the following command to resolve the deadlock. Replace `PVC-ID` with the ID of the Persistent Volume Claim (PVC) that is in the `longhorn-system` namespace that and in **RWX** mode. ```bash kubectl --namespace longhorn-system patch lhsm PVC-ID \ From 22182f6c2776ce08eb9a816865ef4cfdadc6049c Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Thu, 4 Jan 2024 17:27:13 -0700 Subject: [PATCH 5/9] save --- docs/docs-content/integrations/longhorn.md | 39 +++++----------------- 1 file changed, 9 insertions(+), 30 deletions(-) diff --git a/docs/docs-content/integrations/longhorn.md b/docs/docs-content/integrations/longhorn.md index c72bca4f28..84a007096f 100644 --- a/docs/docs-content/integrations/longhorn.md +++ b/docs/docs-content/integrations/longhorn.md @@ -35,9 +35,9 @@ The table lists commonly used parameters you can configure when adding this pack | `defaultFsType` | The default file system. | `ext4` | | `defaultClassReplicaCount`| The default number of copies of data store in your cluster. | `3` | | `defaultDataLocality` | The default location where data computation will occur. | `disabled` Best effort | -| `reclaimPolicy` | This means that a dynamically provisioned volume will be automatically deleted when deletes when corresponding PersistentVolumeClaim is deleted. For important data, it is more appropriate to use the "Retain" policy | `Delete` | +| `reclaimPolicy` | This means that a dynamically provisioned volume will be automatically deleted when deletes when corresponding PersistentVolumeClaim is deleted. For important data, it is more appropriate to use the "Retain" policy. | `Delete` | | `migratable` | The ability to transfer data to another data storage systems | `false` | -| `recurringJobSelector.enable` | The management of recurring jobs. You can enable this feature and type a comma-separated list of jobs to run: `recurringJobSelector.enable.jobList [ ]` | `false` | +| `recurringJobSelector.enable` | The management of recurring jobs. You can enable this feature and type a comma-separated list of jobs to activate. | `false` | ## Usage @@ -51,33 +51,13 @@ Longhorn provides these features: For more information, check out Longhorn guide on [How to Create Volumes](https://longhorn.io/docs/1.4.0/volumes-and-nodes/create-volumes/). -## Troubleshooting +## Known Issues -Below are some common issues you may encounter when using Longhorn. Use the following information to help you troubleshoot and resolve the issue. +The following known issues exist in the Longhorn 1.5.X release. ### Deadlock With RWX Mode -Starting with version 1.5.X, a known issue exists where a deadlock may occurs when using a RWX volume and a cluster node is recreated. This issue is disclosed as a known issue in the [Longhorn GitHub repository](https://github.com/longhorn/longhorn/wiki/Release-Known-Issues#v153). - -To resolve the deadlock, you must manually update the status of the Longhorn Storage Manager. Use the following command to resolve the deadlock. Replace `PVC-ID` with the ID of the Persistent Volume Claim (PVC) that is in the `longhorn-system` namespace that and in **RWX** mode. - -```bash -kubectl --namespace longhorn-system patch lhsm PVC-ID \ ---type=merge --subresource status --patch 'status: {state: error}' -``` - -:::tip - -To identify the ID of the PVC, use the following command to list all PVCs in the `longhorn-system` namespace. Seach for the PVC that has the **ACCESS MODE** set to **RWX**. - - -```bash -kubectl get pvc --namespace longhorn-system -``` -::: - - -There are other workaround solutions provided by the community in the [issue discussion](https://github.com/longhorn/longhorn/issues/7183#issuecomment-1823715359) that you may explore if you are searching for an alternative solution. +Starting with version 1.5.X, a known issue exists where a deadlock may occurs when using a RWX volume and a cluster node is recreated. This issue is disclosed as a known issue in the [Longhorn GitHub repository](https://github.com/longhorn/longhorn/wiki/Release-Known-Issues#v153) and a fix is on the roadmap. There are workaround solutions provided by the community in the [issue discussion](https://github.com/longhorn/longhorn/issues/7183#issuecomment-1823715359). @@ -100,10 +80,9 @@ The table lists commonly used parameters you can configure when adding this pack | `defaultFsType` | The default file system. | `ext4` | | `defaultClassReplicaCount`| The default number of copies of data store in your cluster. | `3` | | `defaultDataLocality` | The default location where data computation will occur. | `disabled` Best effort | -| `reclaimPolicy` | This means that a dynamically provisioned volume will be automatically deleted when deletes when corresponding PersistentVolumeClaim is deleted. For important data, it is more appropriate to use the "Retain" policy | `Delete` | +| `reclaimPolicy` | This means that a dynamically provisioned volume will be automatically deleted when deletes when corresponding PersistentVolumeClaim is deleted. For important data, it is more appropriate to use the "Retain" policy. | `Delete` | | `migratable` | The ability to transfer data to another data storage systems | `false` | -| `recurringJobSelector.enable` | The management of recurring jobs. You can enable this feature and type a comma-separated list of jobs to run: `recurringJobSelector.enable.jobList [ ]` | `false` | -curringJobSelector:enable | The management of recurring jobs. You can enable this feature and type a comma-separated list of jobs to run: `recurringJobSelector:enable:jobList [ ]` | `false` | +| `recurringJobSelector.enable` | The management of recurring jobs. You can enable this feature and type a comma-separated list of jobs to activate. | `false` | ## Usage @@ -136,9 +115,9 @@ The table lists commonly used parameters you can configure when adding this pack | `defaultFsType` | The default file system. | `ext4` | | `defaultClassReplicaCount`| The default number of copies of data store in your cluster. | `3` | | `defaultDataLocality` | The default location where data computation will occur. | `disabled` Best effort | -| `reclaimPolicy` | This means that a dynamically provisioned volume will be automatically deleted when deletes when corresponding PersistentVolumeClaim is deleted. For important data, it is more appropriate to use the "Retain" policy | `Delete` | +| `reclaimPolicy` | This means that a dynamically provisioned volume will be automatically deleted when deletes when corresponding PersistentVolumeClaim is deleted. For important data, it is more appropriate to use the "Retain" policy. | `Delete` | | `migratable` | The ability to transfer data to another data storage systems | `false` | -| `recurringJobSelector.enable` | The management of recurring jobs. You can enable this feature and type a comma-separated list of jobs to run: `recurringJobSelector.enable.jobList [ ]` | `false` | +| `recurringJobSelector.enable` | The management of recurring jobs. You can enable this feature and type a comma-separated list of jobs to activcate. | `false` | ## Usage From b6e0a0fbd4ea479d21dd592209b6ffa925346ee9 Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Thu, 4 Jan 2024 18:16:04 -0700 Subject: [PATCH 6/9] docs: removed and added new content --- docs/docs-content/integrations/longhorn.md | 142 ++++++++++++++------- 1 file changed, 93 insertions(+), 49 deletions(-) diff --git a/docs/docs-content/integrations/longhorn.md b/docs/docs-content/integrations/longhorn.md index 84a007096f..3d0a71e0ed 100644 --- a/docs/docs-content/integrations/longhorn.md +++ b/docs/docs-content/integrations/longhorn.md @@ -24,40 +24,53 @@ Longhorn creates a dedicated storage controller for each block device volume and - Kubernetes cluster is 1.21 or higher. +- Different Operating Systems (OS) have different requirements for the Longhorn installation. Use the links below to learn more about the requirements for your OS. + + - [RKE and CoreOS](https://longhorn.io/docs/1.5.3/advanced-resources/os-distro-specific/csi-on-rke-and-coreos/) + - [K3s](https://longhorn.io/docs/1.5.3/advanced-resources/os-distro-specific/csi-on-k3s/) + - [Google GKE](https://longhorn.io/docs/1.5.3/advanced-resources/os-distro-specific/csi-on-gke/) + + ## Parameters -The table lists commonly used parameters you can configure when adding this pack. +The table lists commonly used parameters you can configure when adding this pack. Refer to the [Settings Reference](https://longhorn.io/docs/1.5.3/references/settings/) resource for a complete list of Longhorn parameters and their descriptions. | Parameter | Description | Default | |-------------------------|--------------------------------------------------------|---------------------------------------------| -| `namespace` | The namespace where the Longhorn will be installed. | `longhorn-system` | -| `defaultClass` | The volume type to be used. | `true` | -| `defaultFsType` | The default file system. | `ext4` | -| `defaultClassReplicaCount`| The default number of copies of data store in your cluster. | `3` | -| `defaultDataLocality` | The default location where data computation will occur. | `disabled` Best effort | -| `reclaimPolicy` | This means that a dynamically provisioned volume will be automatically deleted when deletes when corresponding PersistentVolumeClaim is deleted. For important data, it is more appropriate to use the "Retain" policy. | `Delete` | -| `migratable` | The ability to transfer data to another data storage systems | `false` | -| `recurringJobSelector.enable` | The management of recurring jobs. You can enable this feature and type a comma-separated list of jobs to activate. | `false` | +| `pack.namespace` | The namespace where the Longhorn will be installed. If the namespace does not exist, it will be created. | `longhorn-system` | +| `charts.longhorn.global.persistence.defaultClass` | The volume type to be used. | `true` | +| `charts.longhorn.global.persistence.defaultFsType` | The default file system. | `ext4` | +| `charts.longhorn.global.persistence.defaultClassReplicaCount`| The default number of copies of data store in your cluster. | `3` | +| `charts.longhorn.global.persistence.defaultDataLocality` | The default location where data computation will occur. | `disabled`| +| `charts.longhorn.global.persistence.reclaimPolicy` | TThe policy that regulates dynamically provisioned volumes when its corresponding PersistentVolumeClaim is deleted. The default policy is `Delete`. This means that a dynamically provisioned volume will be automatically deleted when corresponding PersistentVolumeClaim is deleted. For important data, it is more appropriate to use the "Retain" policy. | `Delete` | +| `charts.longhorn.global.persistence.migratable` | The ability to transfer data to another data storage systems. | `false` | +| `charts.longhorn.global.persistence.recurringJobSelector.enable` | The management of recurring jobs. You can enable this feature and type a comma-separated list of jobs to activate. | `false` | ## Usage -Longhorn provides these features: +The official Longhorn documentation contains several guides and examples. The following guides are a good place to start when learning how to use Longhorn. + +- [How to Create Volumes](https://longhorn.io/docs/1.5.3/volumes-and-nodes/create-volumes/). + +- [Access the Longhorn UI](https://longhorn.io/docs/1.5.3/deploy/accessing-the-ui/) + +- [Longhorn Networking](https://longhorn.io/docs/1.5.3/references/networking/) + +- [Node Maintenance and Kubernetes Upgrade Guide](https://longhorn.io/docs/1.5.3/volumes-and-nodes/maintenance/) -- Enterprise-grade distributed storage with no single point of failure. -- Incremental snapshots of block storage. -- Backup to secondary storage (NFSv4 or S3-compatible object storage) built on change block detection. -- Recurring snapshot and backup. +- [Storage Tags](https://longhorn.io/docs/1.5.3/volumes-and-nodes/storage-tags/) -For more information, check out Longhorn guide on [How to Create Volumes](https://longhorn.io/docs/1.4.0/volumes-and-nodes/create-volumes/). +- [Important Notes](https://longhorn.io/docs/1.5.3/deploy/important-notes/) + +We also recommend you check out the [Examples](https://longhorn.io/docs/1.5.3/references/examples/) section of the Longhorn documentation. The examples section contains several use cases of how to configure Longhorn. ## Known Issues The following known issues exist in the Longhorn 1.5.X release. -### Deadlock With RWX Mode -Starting with version 1.5.X, a known issue exists where a deadlock may occurs when using a RWX volume and a cluster node is recreated. This issue is disclosed as a known issue in the [Longhorn GitHub repository](https://github.com/longhorn/longhorn/wiki/Release-Known-Issues#v153) and a fix is on the roadmap. There are workaround solutions provided by the community in the [issue discussion](https://github.com/longhorn/longhorn/issues/7183#issuecomment-1823715359). +- A deadlock may occurs when using a RWX volume and a cluster node is recreated. This issue is disclosed as a known issue in the [Longhorn GitHub repository](https://github.com/longhorn/longhorn/wiki/Release-Known-Issues#v153) and a fix is on the roadmap. Workarounds provided by the community can be found in the [issue discussion](https://github.com/longhorn/longhorn/issues/7183#issuecomment-1823715359). @@ -69,31 +82,45 @@ Starting with version 1.5.X, a known issue exists where a deadlock may occurs wh - Kubernetes cluster is 1.21 or higher. + +- Different Operating Systems (OS) have different requirements for the Longhorn installation. Use the links below to learn more about the requirements for your OS. + + - [RKE and CoreOS](https://longhorn.io/docs/1.4.4/advanced-resources/os-distro-specific/csi-on-rke-and-coreos/) + - [K3s](https://longhorn.io/docs/1.4.4/advanced-resources/os-distro-specific/csi-on-k3s/) + - [Google GKE](https://longhorn.io/docs/1.4.4/advanced-resources/os-distro-specific/csi-on-gke/) + ## Parameters -The table lists commonly used parameters you can configure when adding this pack. +The table lists commonly used parameters you can configure when adding this pack. Refer to the [Settings Reference](https://longhorn.io/docs/1.4.4/references/settings/) resource for a complete list of Longhorn parameters and their descriptions. | Parameter | Description | Default | |-------------------------|--------------------------------------------------------|---------------------------------------------| -| `namespace` | The namespace where the Longhorn will be installed. | `longhorn-system` | -| `defaultClass` | The volume type to be used. | `true` | -| `defaultFsType` | The default file system. | `ext4` | -| `defaultClassReplicaCount`| The default number of copies of data store in your cluster. | `3` | -| `defaultDataLocality` | The default location where data computation will occur. | `disabled` Best effort | -| `reclaimPolicy` | This means that a dynamically provisioned volume will be automatically deleted when deletes when corresponding PersistentVolumeClaim is deleted. For important data, it is more appropriate to use the "Retain" policy. | `Delete` | -| `migratable` | The ability to transfer data to another data storage systems | `false` | -| `recurringJobSelector.enable` | The management of recurring jobs. You can enable this feature and type a comma-separated list of jobs to activate. | `false` | +| `pack.namespace` | The namespace where the Longhorn will be installed. If the namespace does not exist, it will be created. | `longhorn-system` | +| `charts.longhorn.global.persistence.defaultClass` | The volume type to be used. | `true` | +| `charts.longhorn.global.persistence.defaultFsType` | The default file system. | `ext4` | +| `charts.longhorn.global.persistence.defaultClassReplicaCount`| The default number of copies of data store in your cluster. | `3` | +| `charts.longhorn.global.persistence.defaultDataLocality` | The default location where data computation will occur. | `disabled`| +| `charts.longhorn.global.persistence.reclaimPolicy` | This means that a dynamically provisioned volume will be automatically deleted when deletes when corresponding PersistentVolumeClaim is deleted. For important data, it is more appropriate to use the "Retain" policy. | `Delete` | +| `charts.longhorn.global.persistence.migratable` | The ability to transfer data to another data storage systems. | `false` | +| `charts.longhorn.global.persistence.recurringJobSelector.enable` | The management of recurring jobs. You can enable this feature and type a comma-separated list of jobs to activate. | `false` | ## Usage -Longhorn provides these features: +The official Longhorn documentation contains several guides and examples. The following guides are a good place to start when learning how to use Longhorn. + +- [How to Create Volumes](https://longhorn.io/docs/1.4.4/volumes-and-nodes/create-volumes/). + +- [Access the Longhorn UI](https://longhorn.io/docs/1.4.4/deploy/accessing-the-ui/) -- Enterprise-grade distributed storage with no single point of failure. -- Incremental snapshots of block storage. -- Backup to secondary storage (NFSv4 or S3-compatible object storage) built on change block detection. -- Recurring snapshot and backup. +- [Longhorn Networking](https://longhorn.io/docs/1.4.4/references/networking/) -For more information, check out Longhorn guide on [How to Create Volumes](https://longhorn.io/docs/1.4.0/volumes-and-nodes/create-volumes/). +- [Node Maintenance and Kubernetes Upgrade Guide](https://longhorn.io/docs/1.4.4/volumes-and-nodes/maintenance/) + +- [Storage Tags](https://longhorn.io/docs/1.4.4/volumes-and-nodes/storage-tags/) + +- [Important Notes](https://longhorn.io/docs/1.4.4/deploy/important-notes/) + +We also recommend you check out the [Examples](https://longhorn.io/docs/1.4.4/references/examples/) section of the Longhorn documentation. The examples section contains several use cases of how to configure Longhorn. @@ -102,33 +129,46 @@ For more information, check out Longhorn guide on [How to Create Volumes](https: ## Prerequisites -- Kubernetes cluster is at least version 1.22 and not higher than 1.24. +- Kubernetes cluster is at least version 1.18 and not higher than 1.24. + +- Different Operating Systems (OS) have different requirements for the Longhorn installation. Use the links below to learn more about the requirements for your OS. + + - [RKE and CoreOS](https://longhorn.io/docs/1.3.3/advanced-resources/os-distro-specific/csi-on-rke-and-coreos/) + - [K3s](https://longhorn.io/docs/1.3.3/advanced-resources/os-distro-specific/csi-on-k3s/) + - [Google GKE](https://longhorn.io/docs/1.3.3/advanced-resources/os-distro-specific/csi-on-gke/) ## Parameters -The table lists commonly used parameters you can configure when adding this pack. +The table lists commonly used parameters you can configure when adding this pack. Refer to the [Settings Reference](https://longhorn.io/docs/1.3.3/references/settings/) resource for a complete list of Longhorn parameters and their descriptions. | Parameter | Description | Default | |-------------------------|--------------------------------------------------------|---------------------------------------------| -| `namespace` | The namespace where the Longhorn will be installed. | `longhorn-system` | -| `defaultClass` | The volume type to be used. | `true` | -| `defaultFsType` | The default file system. | `ext4` | -| `defaultClassReplicaCount`| The default number of copies of data store in your cluster. | `3` | -| `defaultDataLocality` | The default location where data computation will occur. | `disabled` Best effort | -| `reclaimPolicy` | This means that a dynamically provisioned volume will be automatically deleted when deletes when corresponding PersistentVolumeClaim is deleted. For important data, it is more appropriate to use the "Retain" policy. | `Delete` | -| `migratable` | The ability to transfer data to another data storage systems | `false` | -| `recurringJobSelector.enable` | The management of recurring jobs. You can enable this feature and type a comma-separated list of jobs to activcate. | `false` | +| `pack.namespace` | The namespace where the Longhorn will be installed. If the namespace does not exist, it will be created. | `longhorn-system` | +| `charts.longhorn.global.persistence.defaultClass` | The volume type to be used. | `true` | +| `charts.longhorn.global.persistence.defaultFsType` | The default file system. | `ext4` | +| `charts.longhorn.global.persistence.defaultClassReplicaCount`| The default number of copies of data store in your cluster. | `3` | +| `charts.longhorn.global.persistence.defaultDataLocality` | The default location where data computation will occur. | `disabled`| +| `charts.longhorn.global.persistence.reclaimPolicy` | This means that a dynamically provisioned volume will be automatically deleted when deletes when corresponding PersistentVolumeClaim is deleted. For important data, it is more appropriate to use the `Retain` policy. | `Delete` | +| `charts.longhorn.global.persistence.migratable` | The ability to transfer data to another data storage systems. | `false` | +| `charts.longhorn.global.persistence.recurringJobSelector.enable` | The management of recurring jobs. You can enable this feature and type a comma-separated list of jobs to activate. | `false` | ## Usage -Longhorn provides these features: +The official Longhorn documentation contains several guides and examples. The following guides are a good place to start when learning how to use Longhorn. + +- [How to Create Volumes](https://longhorn.io/docs/1.4.4/volumes-and-nodes/create-volumes/). -- Enterprise-grade distributed storage with no single point of failure. -- Incremental snapshots of block storage. -- Backup to secondary storage (NFSv4 or S3-compatible object storage) built on change block detection. -- Recurring snapshot and backup. +- [Access the Longhorn UI](https://longhorn.io/docs/1.4.4/deploy/accessing-the-ui/) -For more information, check out Longhorn guide on [How to Create Volumes](https://longhorn.io/docs/1.4.0/volumes-and-nodes/create-volumes/). +- [Longhorn Networking](https://longhorn.io/docs/1.4.4/references/networking/) + +- [Node Maintenance and Kubernetes Upgrade Guide](https://longhorn.io/docs/1.4.4/volumes-and-nodes/maintenance/) + +- [Storage Tags](https://longhorn.io/docs/1.4.4/volumes-and-nodes/storage-tags/) + +- [Important Notes](https://longhorn.io/docs/1.4.4/deploy/important-notes/) + +We also recommend you check out the [Examples](https://longhorn.io/docs/1.4.4/references/examples/) section of the Longhorn documentation. The examples section contains several use cases of how to configure Longhorn. @@ -144,7 +184,7 @@ data "spectrocloud_registry" "public_registry" { data "spectrocloud_pack_simple" "csi-longhorn" { name = "longhorn" - version = "1.3.1" + version = "1.5.1" type = "helm" registry_uid = data.spectrocloud_registry.public_registry.id } @@ -156,3 +196,7 @@ data "spectrocloud_pack_simple" "csi-longhorn" { - [Longhorn Home](https://longhorn.io/) - [Longhorn Documentation](https://longhorn.io/docs) + +- [Settings Reference](https://longhorn.io/docs/latest/references/settings/) + +- [Storage Class Parameters](https://longhorn.io/docs/latest/references/storage-class-parameters/) \ No newline at end of file From e30ed5ae17c61eee75fb1c29abb701afb5db9b35 Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Thu, 4 Jan 2024 18:17:25 -0700 Subject: [PATCH 7/9] docs: vale feedback --- docs/docs-content/integrations/longhorn.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs-content/integrations/longhorn.md b/docs/docs-content/integrations/longhorn.md index 3d0a71e0ed..96db565b96 100644 --- a/docs/docs-content/integrations/longhorn.md +++ b/docs/docs-content/integrations/longhorn.md @@ -42,7 +42,7 @@ The table lists commonly used parameters you can configure when adding this pack | `charts.longhorn.global.persistence.defaultFsType` | The default file system. | `ext4` | | `charts.longhorn.global.persistence.defaultClassReplicaCount`| The default number of copies of data store in your cluster. | `3` | | `charts.longhorn.global.persistence.defaultDataLocality` | The default location where data computation will occur. | `disabled`| -| `charts.longhorn.global.persistence.reclaimPolicy` | TThe policy that regulates dynamically provisioned volumes when its corresponding PersistentVolumeClaim is deleted. The default policy is `Delete`. This means that a dynamically provisioned volume will be automatically deleted when corresponding PersistentVolumeClaim is deleted. For important data, it is more appropriate to use the "Retain" policy. | `Delete` | +| `charts.longhorn.global.persistence.reclaimPolicy` | The policy that regulates dynamically provisioned volumes when its corresponding PersistentVolumeClaim is deleted. The default policy is `Delete`. This means that a dynamically provisioned volume will be automatically deleted when corresponding PersistentVolumeClaim is deleted. For important data, it is more appropriate to use the "Retain" policy. | `Delete` | | `charts.longhorn.global.persistence.migratable` | The ability to transfer data to another data storage systems. | `false` | | `charts.longhorn.global.persistence.recurringJobSelector.enable` | The management of recurring jobs. You can enable this feature and type a comma-separated list of jobs to activate. | `false` | From c05289590b6ddc259bacdf95e1fe46faa193e9f6 Mon Sep 17 00:00:00 2001 From: Lenny Chen Date: Thu, 4 Jan 2024 20:32:51 -0800 Subject: [PATCH 8/9] docs: add known issue --- docs/docs-content/integrations/longhorn.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/docs-content/integrations/longhorn.md b/docs/docs-content/integrations/longhorn.md index 96db565b96..90731a8cbd 100644 --- a/docs/docs-content/integrations/longhorn.md +++ b/docs/docs-content/integrations/longhorn.md @@ -70,7 +70,9 @@ We also recommend you check out the [Examples](https://longhorn.io/docs/1.5.3/re The following known issues exist in the Longhorn 1.5.X release. -- A deadlock may occurs when using a RWX volume and a cluster node is recreated. This issue is disclosed as a known issue in the [Longhorn GitHub repository](https://github.com/longhorn/longhorn/wiki/Release-Known-Issues#v153) and a fix is on the roadmap. Workarounds provided by the community can be found in the [issue discussion](https://github.com/longhorn/longhorn/issues/7183#issuecomment-1823715359). +- A deadlock may occurs when using a RWX volume and a cluster node is recreated. This issue is disclosed as a [known issue](https://github.com/longhorn/longhorn/wiki/Release-Known-Issues#v153) in the Longhorn GitHub repository] and a fix is on the roadmap. Workarounds provided by the community can be found in the [issue discussion](https://github.com/longhorn/longhorn/issues/7183#issuecomment-1823715359). + +- Rebooting or upgrading a cluster with Longhorn has a small possibility of triggering a race condition that causes pods to be stuck in the terminating state. This issue is related to a [known issue](https://github.com/longhorn/longhorn/issues/6962) in the Longhorn GitHub repository and a fix is on the roadmap. From 8244492f3c6e315217ff86556a3a8c38cb656bdd Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Fri, 5 Jan 2024 09:43:24 -0700 Subject: [PATCH 9/9] Apply suggestions from code review Co-authored-by: Lenny Chen <55669665+lennessyy@users.noreply.github.com> --- docs/docs-content/integrations/longhorn.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs-content/integrations/longhorn.md b/docs/docs-content/integrations/longhorn.md index 90731a8cbd..329170e247 100644 --- a/docs/docs-content/integrations/longhorn.md +++ b/docs/docs-content/integrations/longhorn.md @@ -50,7 +50,7 @@ The table lists commonly used parameters you can configure when adding this pack The official Longhorn documentation contains several guides and examples. The following guides are a good place to start when learning how to use Longhorn. -- [How to Create Volumes](https://longhorn.io/docs/1.5.3/volumes-and-nodes/create-volumes/). +- [How to Create Volumes](https://longhorn.io/docs/1.5.3/volumes-and-nodes/create-volumes/) - [Access the Longhorn UI](https://longhorn.io/docs/1.5.3/deploy/accessing-the-ui/)