Skip to content

Commit

Permalink
Merge 8244492 into 59a145f
Browse files Browse the repository at this point in the history
  • Loading branch information
@karl-cardenas-coding
karl-cardenas-coding authored Jan 5, 2024
2 parents 59a145f + 8244492 commit 1479030
Showing 1 changed file with 122 additions and 30 deletions.
152 changes: 122 additions & 30 deletions docs/docs-content/integrations/longhorn.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,38 +17,112 @@ Longhorn creates a dedicated storage controller for each block device volume and
## Version Supported

<Tabs queryString="versions">
<TabItem label="1.5.x" value="1.5.x">


## Prerequisites

- 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. 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 |
|-------------------------|--------------------------------------------------------|---------------------------------------------|
| `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` | 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` |

## Usage

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/)

- [Storage Tags](https://longhorn.io/docs/1.5.3/volumes-and-nodes/storage-tags/)

- [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.


- 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.

</TabItem>

<TabItem label="1.4.x" value="1.4.x">



## Prerequisites

- 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 |
|-------------------------|--------------------------------------------------------|---------------------------------------------|
| 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` |
| `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.

</TabItem>

Expand All @@ -57,32 +131,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 |
|-------------------------|--------------------------------------------------------|---------------------------------------------|
| 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` |
| `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.

</TabItem>
</Tabs>
Expand All @@ -98,7 +186,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
}
Expand All @@ -110,3 +198,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/)

0 comments on commit 1479030

Please sign in to comment.