From c0b5b145fea7c1af2a02d5d9e94608f59463fb8a Mon Sep 17 00:00:00 2001 From: James Munson Date: Thu, 21 Sep 2023 18:09:53 -0600 Subject: [PATCH] Add mount options to storage class reference. Signed-off-by: James Munson --- .../1.4.0/references/storage-class-parameters.md | 14 ++++++++++++++ .../1.4.1/references/storage-class-parameters.md | 14 ++++++++++++++ .../1.4.2/references/storage-class-parameters.md | 14 ++++++++++++++ .../1.4.3/references/storage-class-parameters.md | 14 ++++++++++++++ .../1.4.4/references/storage-class-parameters.md | 14 ++++++++++++++ .../1.5.0/references/storage-class-parameters.md | 14 ++++++++++++++ .../1.5.1/references/storage-class-parameters.md | 14 ++++++++++++++ .../1.5.2/references/storage-class-parameters.md | 14 ++++++++++++++ .../1.6.0/references/storage-class-parameters.md | 14 ++++++++++++++ 9 files changed, 126 insertions(+) diff --git a/content/docs/1.4.0/references/storage-class-parameters.md b/content/docs/1.4.0/references/storage-class-parameters.md index 497b1b4c6..9aade7aee 100644 --- a/content/docs/1.4.0/references/storage-class-parameters.md +++ b/content/docs/1.4.0/references/storage-class-parameters.md @@ -37,6 +37,7 @@ parameters: # disableRevisionCounter: false # replicaSoftAntiAffinity: "ignored" # replicaZoneSoftAntiAffinity: "ignored" +# nfsOptions: "soft,timeo=150,retrans=3" ``` ## Built-in Fields @@ -55,6 +56,10 @@ Specifies the plugin that will be used for dynamic creation of persistent volume > Default: `Delete` > See [Kubernetes Storage Class: Reclaim Policy](https://kubernetes.io/docs/concepts/storage/storage-classes/#reclaim-policy). +#### Mount Options *(field: `mountOptions`)* +> Default `[]` +> See [Kubernetes Storage Class: Mount Options](https://kubernetes.io/docs/concepts/storage/storage-classes/#mount-options). + #### Volume Binding Mode *(field: `volumeBindingMode`)* > Default `Immediate` > See [Kubernetes Storage Class: Volume Binding Mode](https://kubernetes.io/docs/concepts/storage/storage-classes/#volume-binding-mode). @@ -191,6 +196,15 @@ A list of recurring jobs that are to be run on a volume. > Global setting: [Replica Zone Level Soft Anti-Affinity](../settings#replica-zone-level-soft-anti-affinity). > More details in [Scheduling](../../volumes-and-nodes/scheduling). +#### NFS Options *(field: `parameters.nfsOptions`)* +> Default: `""` +> Example: `"hard,sync"` + + - Overrides for NFS mount of RWX volumes to the share-manager. Use this field with caution. + - Note: Built-in options vary by release. Check your release details before setting this. + +> More details in [RWX Workloads](../../advanced-resources/rwx-workloads/#notice) + ## Helm Installs If Longhorn is installed via Helm, values in the default storage class can be set by editing the corresponding item in [values.yaml](https://github.com/longhorn/longhorn/blob/v{{< current-version >}}/chart/values.yaml). All of the Storage Class parameters have a prefix of "persistence". For example, `persistence.defaultNodeSelector`. diff --git a/content/docs/1.4.1/references/storage-class-parameters.md b/content/docs/1.4.1/references/storage-class-parameters.md index 497b1b4c6..9aade7aee 100644 --- a/content/docs/1.4.1/references/storage-class-parameters.md +++ b/content/docs/1.4.1/references/storage-class-parameters.md @@ -37,6 +37,7 @@ parameters: # disableRevisionCounter: false # replicaSoftAntiAffinity: "ignored" # replicaZoneSoftAntiAffinity: "ignored" +# nfsOptions: "soft,timeo=150,retrans=3" ``` ## Built-in Fields @@ -55,6 +56,10 @@ Specifies the plugin that will be used for dynamic creation of persistent volume > Default: `Delete` > See [Kubernetes Storage Class: Reclaim Policy](https://kubernetes.io/docs/concepts/storage/storage-classes/#reclaim-policy). +#### Mount Options *(field: `mountOptions`)* +> Default `[]` +> See [Kubernetes Storage Class: Mount Options](https://kubernetes.io/docs/concepts/storage/storage-classes/#mount-options). + #### Volume Binding Mode *(field: `volumeBindingMode`)* > Default `Immediate` > See [Kubernetes Storage Class: Volume Binding Mode](https://kubernetes.io/docs/concepts/storage/storage-classes/#volume-binding-mode). @@ -191,6 +196,15 @@ A list of recurring jobs that are to be run on a volume. > Global setting: [Replica Zone Level Soft Anti-Affinity](../settings#replica-zone-level-soft-anti-affinity). > More details in [Scheduling](../../volumes-and-nodes/scheduling). +#### NFS Options *(field: `parameters.nfsOptions`)* +> Default: `""` +> Example: `"hard,sync"` + + - Overrides for NFS mount of RWX volumes to the share-manager. Use this field with caution. + - Note: Built-in options vary by release. Check your release details before setting this. + +> More details in [RWX Workloads](../../advanced-resources/rwx-workloads/#notice) + ## Helm Installs If Longhorn is installed via Helm, values in the default storage class can be set by editing the corresponding item in [values.yaml](https://github.com/longhorn/longhorn/blob/v{{< current-version >}}/chart/values.yaml). All of the Storage Class parameters have a prefix of "persistence". For example, `persistence.defaultNodeSelector`. diff --git a/content/docs/1.4.2/references/storage-class-parameters.md b/content/docs/1.4.2/references/storage-class-parameters.md index 497b1b4c6..9aade7aee 100644 --- a/content/docs/1.4.2/references/storage-class-parameters.md +++ b/content/docs/1.4.2/references/storage-class-parameters.md @@ -37,6 +37,7 @@ parameters: # disableRevisionCounter: false # replicaSoftAntiAffinity: "ignored" # replicaZoneSoftAntiAffinity: "ignored" +# nfsOptions: "soft,timeo=150,retrans=3" ``` ## Built-in Fields @@ -55,6 +56,10 @@ Specifies the plugin that will be used for dynamic creation of persistent volume > Default: `Delete` > See [Kubernetes Storage Class: Reclaim Policy](https://kubernetes.io/docs/concepts/storage/storage-classes/#reclaim-policy). +#### Mount Options *(field: `mountOptions`)* +> Default `[]` +> See [Kubernetes Storage Class: Mount Options](https://kubernetes.io/docs/concepts/storage/storage-classes/#mount-options). + #### Volume Binding Mode *(field: `volumeBindingMode`)* > Default `Immediate` > See [Kubernetes Storage Class: Volume Binding Mode](https://kubernetes.io/docs/concepts/storage/storage-classes/#volume-binding-mode). @@ -191,6 +196,15 @@ A list of recurring jobs that are to be run on a volume. > Global setting: [Replica Zone Level Soft Anti-Affinity](../settings#replica-zone-level-soft-anti-affinity). > More details in [Scheduling](../../volumes-and-nodes/scheduling). +#### NFS Options *(field: `parameters.nfsOptions`)* +> Default: `""` +> Example: `"hard,sync"` + + - Overrides for NFS mount of RWX volumes to the share-manager. Use this field with caution. + - Note: Built-in options vary by release. Check your release details before setting this. + +> More details in [RWX Workloads](../../advanced-resources/rwx-workloads/#notice) + ## Helm Installs If Longhorn is installed via Helm, values in the default storage class can be set by editing the corresponding item in [values.yaml](https://github.com/longhorn/longhorn/blob/v{{< current-version >}}/chart/values.yaml). All of the Storage Class parameters have a prefix of "persistence". For example, `persistence.defaultNodeSelector`. diff --git a/content/docs/1.4.3/references/storage-class-parameters.md b/content/docs/1.4.3/references/storage-class-parameters.md index 497b1b4c6..9aade7aee 100644 --- a/content/docs/1.4.3/references/storage-class-parameters.md +++ b/content/docs/1.4.3/references/storage-class-parameters.md @@ -37,6 +37,7 @@ parameters: # disableRevisionCounter: false # replicaSoftAntiAffinity: "ignored" # replicaZoneSoftAntiAffinity: "ignored" +# nfsOptions: "soft,timeo=150,retrans=3" ``` ## Built-in Fields @@ -55,6 +56,10 @@ Specifies the plugin that will be used for dynamic creation of persistent volume > Default: `Delete` > See [Kubernetes Storage Class: Reclaim Policy](https://kubernetes.io/docs/concepts/storage/storage-classes/#reclaim-policy). +#### Mount Options *(field: `mountOptions`)* +> Default `[]` +> See [Kubernetes Storage Class: Mount Options](https://kubernetes.io/docs/concepts/storage/storage-classes/#mount-options). + #### Volume Binding Mode *(field: `volumeBindingMode`)* > Default `Immediate` > See [Kubernetes Storage Class: Volume Binding Mode](https://kubernetes.io/docs/concepts/storage/storage-classes/#volume-binding-mode). @@ -191,6 +196,15 @@ A list of recurring jobs that are to be run on a volume. > Global setting: [Replica Zone Level Soft Anti-Affinity](../settings#replica-zone-level-soft-anti-affinity). > More details in [Scheduling](../../volumes-and-nodes/scheduling). +#### NFS Options *(field: `parameters.nfsOptions`)* +> Default: `""` +> Example: `"hard,sync"` + + - Overrides for NFS mount of RWX volumes to the share-manager. Use this field with caution. + - Note: Built-in options vary by release. Check your release details before setting this. + +> More details in [RWX Workloads](../../advanced-resources/rwx-workloads/#notice) + ## Helm Installs If Longhorn is installed via Helm, values in the default storage class can be set by editing the corresponding item in [values.yaml](https://github.com/longhorn/longhorn/blob/v{{< current-version >}}/chart/values.yaml). All of the Storage Class parameters have a prefix of "persistence". For example, `persistence.defaultNodeSelector`. diff --git a/content/docs/1.4.4/references/storage-class-parameters.md b/content/docs/1.4.4/references/storage-class-parameters.md index 497b1b4c6..9aade7aee 100644 --- a/content/docs/1.4.4/references/storage-class-parameters.md +++ b/content/docs/1.4.4/references/storage-class-parameters.md @@ -37,6 +37,7 @@ parameters: # disableRevisionCounter: false # replicaSoftAntiAffinity: "ignored" # replicaZoneSoftAntiAffinity: "ignored" +# nfsOptions: "soft,timeo=150,retrans=3" ``` ## Built-in Fields @@ -55,6 +56,10 @@ Specifies the plugin that will be used for dynamic creation of persistent volume > Default: `Delete` > See [Kubernetes Storage Class: Reclaim Policy](https://kubernetes.io/docs/concepts/storage/storage-classes/#reclaim-policy). +#### Mount Options *(field: `mountOptions`)* +> Default `[]` +> See [Kubernetes Storage Class: Mount Options](https://kubernetes.io/docs/concepts/storage/storage-classes/#mount-options). + #### Volume Binding Mode *(field: `volumeBindingMode`)* > Default `Immediate` > See [Kubernetes Storage Class: Volume Binding Mode](https://kubernetes.io/docs/concepts/storage/storage-classes/#volume-binding-mode). @@ -191,6 +196,15 @@ A list of recurring jobs that are to be run on a volume. > Global setting: [Replica Zone Level Soft Anti-Affinity](../settings#replica-zone-level-soft-anti-affinity). > More details in [Scheduling](../../volumes-and-nodes/scheduling). +#### NFS Options *(field: `parameters.nfsOptions`)* +> Default: `""` +> Example: `"hard,sync"` + + - Overrides for NFS mount of RWX volumes to the share-manager. Use this field with caution. + - Note: Built-in options vary by release. Check your release details before setting this. + +> More details in [RWX Workloads](../../advanced-resources/rwx-workloads/#notice) + ## Helm Installs If Longhorn is installed via Helm, values in the default storage class can be set by editing the corresponding item in [values.yaml](https://github.com/longhorn/longhorn/blob/v{{< current-version >}}/chart/values.yaml). All of the Storage Class parameters have a prefix of "persistence". For example, `persistence.defaultNodeSelector`. diff --git a/content/docs/1.5.0/references/storage-class-parameters.md b/content/docs/1.5.0/references/storage-class-parameters.md index 11ba63995..edb6e8cf7 100644 --- a/content/docs/1.5.0/references/storage-class-parameters.md +++ b/content/docs/1.5.0/references/storage-class-parameters.md @@ -37,6 +37,7 @@ parameters: # disableRevisionCounter: false # replicaSoftAntiAffinity: "ignored" # replicaZoneSoftAntiAffinity: "ignored" +# nfsOptions: "soft,timeo=150,retrans=3" # backendStoreDriver: "" ``` @@ -56,6 +57,10 @@ Specifies the plugin that will be used for dynamic creation of persistent volume > Default: `Delete` > See [Kubernetes Storage Class: Reclaim Policy](https://kubernetes.io/docs/concepts/storage/storage-classes/#reclaim-policy). +#### Mount Options *(field: `mountOptions`)* +> Default `[]` +> See [Kubernetes Storage Class: Mount Options](https://kubernetes.io/docs/concepts/storage/storage-classes/#mount-options). + #### Volume Binding Mode *(field: `volumeBindingMode`)* > Default `Immediate` > See [Kubernetes Storage Class: Volume Binding Mode](https://kubernetes.io/docs/concepts/storage/storage-classes/#volume-binding-mode). @@ -192,6 +197,15 @@ A list of recurring jobs that are to be run on a volume. > Global setting: [Replica Zone Level Soft Anti-Affinity](../settings#replica-zone-level-soft-anti-affinity). > More details in [Scheduling](../../volumes-and-nodes/scheduling). +#### NFS Options *(field: `parameters.nfsOptions`)* +> Default: `""` +> Example: `"hard,sync"` + + - Overrides for NFS mount of RWX volumes to the share-manager. Use this field with caution. + - Note: Built-in options vary by release. Check your release details before setting this. + +> More details in [RWX Workloads](../../advanced-resources/rwx-workloads/#notice) + #### Backend Store Driver *(field: `parameters.backendStoreDriver`)* > Default: `"v1"` diff --git a/content/docs/1.5.1/references/storage-class-parameters.md b/content/docs/1.5.1/references/storage-class-parameters.md index 11ba63995..edb6e8cf7 100644 --- a/content/docs/1.5.1/references/storage-class-parameters.md +++ b/content/docs/1.5.1/references/storage-class-parameters.md @@ -37,6 +37,7 @@ parameters: # disableRevisionCounter: false # replicaSoftAntiAffinity: "ignored" # replicaZoneSoftAntiAffinity: "ignored" +# nfsOptions: "soft,timeo=150,retrans=3" # backendStoreDriver: "" ``` @@ -56,6 +57,10 @@ Specifies the plugin that will be used for dynamic creation of persistent volume > Default: `Delete` > See [Kubernetes Storage Class: Reclaim Policy](https://kubernetes.io/docs/concepts/storage/storage-classes/#reclaim-policy). +#### Mount Options *(field: `mountOptions`)* +> Default `[]` +> See [Kubernetes Storage Class: Mount Options](https://kubernetes.io/docs/concepts/storage/storage-classes/#mount-options). + #### Volume Binding Mode *(field: `volumeBindingMode`)* > Default `Immediate` > See [Kubernetes Storage Class: Volume Binding Mode](https://kubernetes.io/docs/concepts/storage/storage-classes/#volume-binding-mode). @@ -192,6 +197,15 @@ A list of recurring jobs that are to be run on a volume. > Global setting: [Replica Zone Level Soft Anti-Affinity](../settings#replica-zone-level-soft-anti-affinity). > More details in [Scheduling](../../volumes-and-nodes/scheduling). +#### NFS Options *(field: `parameters.nfsOptions`)* +> Default: `""` +> Example: `"hard,sync"` + + - Overrides for NFS mount of RWX volumes to the share-manager. Use this field with caution. + - Note: Built-in options vary by release. Check your release details before setting this. + +> More details in [RWX Workloads](../../advanced-resources/rwx-workloads/#notice) + #### Backend Store Driver *(field: `parameters.backendStoreDriver`)* > Default: `"v1"` diff --git a/content/docs/1.5.2/references/storage-class-parameters.md b/content/docs/1.5.2/references/storage-class-parameters.md index 11ba63995..edb6e8cf7 100644 --- a/content/docs/1.5.2/references/storage-class-parameters.md +++ b/content/docs/1.5.2/references/storage-class-parameters.md @@ -37,6 +37,7 @@ parameters: # disableRevisionCounter: false # replicaSoftAntiAffinity: "ignored" # replicaZoneSoftAntiAffinity: "ignored" +# nfsOptions: "soft,timeo=150,retrans=3" # backendStoreDriver: "" ``` @@ -56,6 +57,10 @@ Specifies the plugin that will be used for dynamic creation of persistent volume > Default: `Delete` > See [Kubernetes Storage Class: Reclaim Policy](https://kubernetes.io/docs/concepts/storage/storage-classes/#reclaim-policy). +#### Mount Options *(field: `mountOptions`)* +> Default `[]` +> See [Kubernetes Storage Class: Mount Options](https://kubernetes.io/docs/concepts/storage/storage-classes/#mount-options). + #### Volume Binding Mode *(field: `volumeBindingMode`)* > Default `Immediate` > See [Kubernetes Storage Class: Volume Binding Mode](https://kubernetes.io/docs/concepts/storage/storage-classes/#volume-binding-mode). @@ -192,6 +197,15 @@ A list of recurring jobs that are to be run on a volume. > Global setting: [Replica Zone Level Soft Anti-Affinity](../settings#replica-zone-level-soft-anti-affinity). > More details in [Scheduling](../../volumes-and-nodes/scheduling). +#### NFS Options *(field: `parameters.nfsOptions`)* +> Default: `""` +> Example: `"hard,sync"` + + - Overrides for NFS mount of RWX volumes to the share-manager. Use this field with caution. + - Note: Built-in options vary by release. Check your release details before setting this. + +> More details in [RWX Workloads](../../advanced-resources/rwx-workloads/#notice) + #### Backend Store Driver *(field: `parameters.backendStoreDriver`)* > Default: `"v1"` diff --git a/content/docs/1.6.0/references/storage-class-parameters.md b/content/docs/1.6.0/references/storage-class-parameters.md index 3a6b63dba..8214a1b18 100644 --- a/content/docs/1.6.0/references/storage-class-parameters.md +++ b/content/docs/1.6.0/references/storage-class-parameters.md @@ -38,6 +38,7 @@ parameters: # replicaSoftAntiAffinity: "ignored" # replicaZoneSoftAntiAffinity: "ignored" # replicaDiskSoftAntiAffinity: "ignored" +# nfsOptions: "soft,timeo=150,retrans=3" # backendStoreDriver: "" ``` @@ -57,6 +58,10 @@ Specifies the plugin that will be used for dynamic creation of persistent volume > Default: `Delete` > See [Kubernetes Storage Class: Reclaim Policy](https://kubernetes.io/docs/concepts/storage/storage-classes/#reclaim-policy). +#### Mount Options *(field: `mountOptions`)* +> Default `[]` +> See [Kubernetes Storage Class: Mount Options](https://kubernetes.io/docs/concepts/storage/storage-classes/#mount-options). + #### Volume Binding Mode *(field: `volumeBindingMode`)* > Default `Immediate` > See [Kubernetes Storage Class: Volume Binding Mode](https://kubernetes.io/docs/concepts/storage/storage-classes/#volume-binding-mode). @@ -202,6 +207,15 @@ A list of recurring jobs that are to be run on a volume. > Global setting: [Replica Disk Level Soft Anti-Affinity](../settings#replica-disk-level-soft-anti-affinity). > More details in [Scheduling](../../volumes-and-nodes/scheduling). +#### NFS Options *(field: `parameters.nfsOptions`)* +> Default: `""` +> Example: `"hard,sync"` + + - Overrides for NFS mount of RWX volumes to the share-manager. Use this field with caution. + - Note: Built-in options vary by release. Check your release details before setting this. + +> More details in [RWX Workloads](../../advanced-resources/rwx-workloads/#notice) + #### Backend Store Driver *(field: `parameters.backendStoreDriver`)* > Default: `"v1"`