doc(helm): add helm values to website #773

ChanYiLin · 2023-09-06T08:28:00Z

content/docs/1.6.0/references/helm-values.md

innobead

Some feedback. In general, it looks good. However, we need to ensure the descriptoin stype consistent in each value setting.

content/docs/1.6.0/references/helm-values.md

innobead

LGTM, but just one comment required to fix.

content/docs/1.6.0/references/helm-values.md

ref: longhorn/longhorn 5455 Signed-off-by: Jack Lin <[email protected]>

jillian-maroket

@ChanYiLin I reviewed the descriptions and section introductions. I implemented the discussed wording convention, which will be documented on a Confluence page when I have more bandwidth. Let me know if the changes work.

jillian-maroket · 2023-11-13T14:26:17Z

content/docs/1.6.0/references/helm-values.md

+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| global.cattle.systemDefaultRegistry | string | `""` | System default registry |


jillian-maroket · 2023-11-13T14:27:01Z

content/docs/1.6.0/references/helm-values.md

+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| global.cattle.systemDefaultRegistry | string | `""` | System default registry |
+| global.cattle.windowsCluster.defaultSetting.systemManagedComponentsNodeSelector | string | `"kubernetes.io/os:linux"` | Node selector for Longhorn system managed components |


jillian-maroket · 2023-11-13T14:27:33Z

content/docs/1.6.0/references/helm-values.md

+|-----|------|---------|-------------|
+| global.cattle.systemDefaultRegistry | string | `""` | System default registry |
+| global.cattle.windowsCluster.defaultSetting.systemManagedComponentsNodeSelector | string | `"kubernetes.io/os:linux"` | Node selector for Longhorn system managed components |
+| global.cattle.windowsCluster.defaultSetting.taintToleration | string | `"cattle.io/os=linux:NoSchedule"` | Toleration for Longhorn system managed components |


jillian-maroket · 2023-11-13T14:28:15Z

content/docs/1.6.0/references/helm-values.md

+| global.cattle.systemDefaultRegistry | string | `""` | System default registry |
+| global.cattle.windowsCluster.defaultSetting.systemManagedComponentsNodeSelector | string | `"kubernetes.io/os:linux"` | Node selector for Longhorn system managed components |
+| global.cattle.windowsCluster.defaultSetting.taintToleration | string | `"cattle.io/os=linux:NoSchedule"` | Toleration for Longhorn system managed components |
+| global.cattle.windowsCluster.enabled | bool | `false` | Enable this to allow Longhorn to run on the Rancher deployed Windows cluster |


jillian-maroket · 2023-11-13T14:28:49Z

content/docs/1.6.0/references/helm-values.md

+| global.cattle.windowsCluster.defaultSetting.systemManagedComponentsNodeSelector | string | `"kubernetes.io/os:linux"` | Node selector for Longhorn system managed components |
+| global.cattle.windowsCluster.defaultSetting.taintToleration | string | `"cattle.io/os=linux:NoSchedule"` | Toleration for Longhorn system managed components |
+| global.cattle.windowsCluster.enabled | bool | `false` | Enable this to allow Longhorn to run on the Rancher deployed Windows cluster |
+| global.cattle.windowsCluster.nodeSelector | object | `{"kubernetes.io/os":"linux"}` | Select Linux nodes to run Longhorn user deployed components |


Suggested change

| global.cattle.windowsCluster.nodeSelector | object | `{"kubernetes.io/os":"linux"}` | Select Linux nodes to run Longhorn user deployed components |

| global.cattle.windowsCluster.nodeSelector | object | `{"kubernetes.io/os":"linux"}` | Node selector for Linux nodes that can run user-deployed components. |

jillian-maroket · 2023-11-14T08:46:38Z

content/docs/1.6.0/references/helm-values.md

+| defaultSettings.storageOverProvisioningPercentage | The over-provisioning percentage defines how much storage can be allocated relative to the hard drive's capacity. By default 200. |
+| defaultSettings.storageReservedPercentageForDefaultDisk | The reserved percentage specifies the percentage of disk space that will not be allocated to the default disk on each new Longhorn node. |
+| defaultSettings.supportBundleFailedHistoryLimit | This setting specifies how many failed support bundles can exist in the cluster. Set this value to **0** to have Longhorn automatically purge all failed support bundles. |
+| defaultSettings.systemManagedComponentsNodeSelector | nodeSelector for longhorn system components |


Suggested change

| defaultSettings.systemManagedComponentsNodeSelector | nodeSelector for longhorn system components |

| defaultSettings.systemManagedComponentsNodeSelector | Node selector for system-managed components. |

jillian-maroket · 2023-11-14T08:49:05Z

content/docs/1.6.0/references/helm-values.md

+| defaultSettings.storageReservedPercentageForDefaultDisk | The reserved percentage specifies the percentage of disk space that will not be allocated to the default disk on each new Longhorn node. |
+| defaultSettings.supportBundleFailedHistoryLimit | This setting specifies how many failed support bundles can exist in the cluster. Set this value to **0** to have Longhorn automatically purge all failed support bundles. |
+| defaultSettings.systemManagedComponentsNodeSelector | nodeSelector for longhorn system components |
+| defaultSettings.systemManagedPodsImagePullPolicy | This setting defines the Image Pull Policy of Longhorn system managed pod. e.g. instance manager, engine image, CSI driver, etc. The new Image Pull Policy will only apply after the system managed pods restart. |


Suggested change

| defaultSettings.systemManagedPodsImagePullPolicy | This setting defines the Image Pull Policy of Longhorn system managed pod. e.g. instance manager, engine image, CSI driver, etc. The new Image Pull Policy will only apply after the system managed pods restart. |

| defaultSettings.systemManagedPodsImagePullPolicy | Image pull policy for system-managed pods, such as Instance Manager, engine images, and CSI Driver. Changes to the image pull policy are applied only after the system-managed pods restart. |

jillian-maroket · 2023-11-14T08:50:17Z

content/docs/1.6.0/references/helm-values.md

+| defaultSettings.supportBundleFailedHistoryLimit | This setting specifies how many failed support bundles can exist in the cluster. Set this value to **0** to have Longhorn automatically purge all failed support bundles. |
+| defaultSettings.systemManagedComponentsNodeSelector | nodeSelector for longhorn system components |
+| defaultSettings.systemManagedPodsImagePullPolicy | This setting defines the Image Pull Policy of Longhorn system managed pod. e.g. instance manager, engine image, CSI driver, etc. The new Image Pull Policy will only apply after the system managed pods restart. |
+| defaultSettings.taintToleration | taintToleration for longhorn system components |


jillian-maroket · 2023-11-14T08:51:38Z

content/docs/1.6.0/references/helm-values.md

+| defaultSettings.systemManagedComponentsNodeSelector | nodeSelector for longhorn system components |
+| defaultSettings.systemManagedPodsImagePullPolicy | This setting defines the Image Pull Policy of Longhorn system managed pod. e.g. instance manager, engine image, CSI driver, etc. The new Image Pull Policy will only apply after the system managed pods restart. |
+| defaultSettings.taintToleration | taintToleration for longhorn system components |
+| defaultSettings.upgradeChecker | Upgrade Checker will check for new Longhorn version periodically. When there is a new version available, a notification will appear in the UI. By default true. |


Suggested change

| defaultSettings.upgradeChecker | Upgrade Checker will check for new Longhorn version periodically. When there is a new version available, a notification will appear in the UI. By default true. |

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

jillian-maroket · 2023-11-14T08:52:20Z

content/docs/1.6.0/references/helm-values.md

+| defaultSettings.systemManagedPodsImagePullPolicy | This setting defines the Image Pull Policy of Longhorn system managed pod. e.g. instance manager, engine image, CSI driver, etc. The new Image Pull Policy will only apply after the system managed pods restart. |
+| defaultSettings.taintToleration | taintToleration for longhorn system components |
+| defaultSettings.upgradeChecker | Upgrade Checker will check for new Longhorn version periodically. When there is a new version available, a notification will appear in the UI. By default true. |
+| defaultSettings.v2DataEngine | This allows users to activate v2 data engine based on SPDK. Currently, it is in the preview phase and should not be utilized in a production environment. |


Suggested change

| defaultSettings.v2DataEngine | This allows users to activate v2 data engine based on SPDK. Currently, it is in the preview phase and should not be utilized in a production environment. |

| defaultSettings.v2DataEngine | Setting that allows you to enable the V2 Data Engine using the Storage Performance Development Kit (SPDK). The V2 Data Engine is a preview feature and should not be used in production environments. |

innobead · 2023-12-19T04:18:56Z

@jillian-maroket, please create a PR to update the doc with your previous suggestions. After the changes are merged, @ChanYiLin will then update https://github.com/longhorn/longhorn/blob/master/chart/{README.md, values.yaml questions.yaml}, because they are the source of truth of this doc.

In the future, @jillian-maroket should review the files in longhorn/longhorn instead, because the doc here will be generated from their changes.

ref: https://github.com/longhorn/longhorn/wiki/Longhorn-Setting-Update

ChanYiLin requested a review from a team as a code owner September 6, 2023 08:28

ChanYiLin requested a review from innobead September 7, 2023 07:24

shuo-wu reviewed Sep 8, 2023

View reviewed changes

innobead requested changes Sep 8, 2023

View reviewed changes

ChanYiLin force-pushed the LH5455_add_longhorn_helm_parameters_to_readme branch from e1e4284 to 3fedb64 Compare September 12, 2023 08:30

ChanYiLin requested review from shuo-wu and innobead September 12, 2023 08:31

innobead requested a review from jillian-maroket September 17, 2023 14:00

innobead requested changes Sep 19, 2023

View reviewed changes

content/docs/1.6.0/references/helm-values.md Outdated Show resolved Hide resolved

doc(helm): add helm values to website

115fff5

ref: longhorn/longhorn 5455 Signed-off-by: Jack Lin <[email protected]>

ChanYiLin force-pushed the LH5455_add_longhorn_helm_parameters_to_readme branch from 3fedb64 to 115fff5 Compare September 26, 2023 03:21

ChanYiLin mentioned this pull request Sep 26, 2023

[IMPROVEMENT] List of Longhorn Helm Chart Flags longhorn/longhorn#5455

Closed

ChanYiLin requested a review from innobead September 26, 2023 07:46

innobead approved these changes Oct 4, 2023

View reviewed changes

Merge branch 'master' into LH5455_add_longhorn_helm_parameters_to_readme

0aade79

innobead merged commit 3662c7b into longhorn:master Oct 4, 2023
4 of 5 checks passed

jillian-maroket reviewed Nov 14, 2023

View reviewed changes

jillian-maroket mentioned this pull request Dec 19, 2023

Revise default over-provisioning percentage to 100. longhorn/longhorn#7379

Merged

jillian-maroket mentioned this pull request Jan 4, 2024

Apply new wording convention to descriptions in helm-values.md #835

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc(helm): add helm values to website #773

doc(helm): add helm values to website #773

ChanYiLin commented Sep 6, 2023

innobead left a comment

innobead left a comment

jillian-maroket left a comment •

edited

Loading

jillian-maroket Nov 13, 2023

jillian-maroket Nov 13, 2023

jillian-maroket Nov 13, 2023

jillian-maroket Nov 13, 2023

jillian-maroket Nov 13, 2023

jillian-maroket Nov 14, 2023

jillian-maroket Nov 14, 2023

jillian-maroket Nov 14, 2023

jillian-maroket Nov 14, 2023

jillian-maroket Nov 14, 2023

innobead commented Dec 19, 2023

	\| global.cattle.systemDefaultRegistry \| string \| `""` \| System default registry \|
	\| global.cattle.systemDefaultRegistry \| string \| `""` \| Default system registry. \|

	\| global.cattle.windowsCluster.defaultSetting.systemManagedComponentsNodeSelector \| string \| `"kubernetes.io/os:linux"` \| Node selector for Longhorn system managed components \|
	\| global.cattle.windowsCluster.defaultSetting.systemManagedComponentsNodeSelector \| string \| `"kubernetes.io/os:linux"` \| Node selector for system-managed components. \|

	\| global.cattle.windowsCluster.enabled \| bool \| `false` \| Enable this to allow Longhorn to run on the Rancher deployed Windows cluster \|
	\| global.cattle.windowsCluster.enabled \| bool \| `false` \| Setting that allows Longhorn to run on a Rancher Windows cluster. \|

	\| global.cattle.windowsCluster.nodeSelector \| object \| `{"kubernetes.io/os":"linux"}` \| Select Linux nodes to run Longhorn user deployed components \|
	\| global.cattle.windowsCluster.nodeSelector \| object \| `{"kubernetes.io/os":"linux"}` \| Node selector for Linux nodes that can run user-deployed components. \|

	\| defaultSettings.systemManagedComponentsNodeSelector \| nodeSelector for longhorn system components \|
	\| defaultSettings.systemManagedComponentsNodeSelector \| Node selector for system-managed components. \|

	\| defaultSettings.systemManagedPodsImagePullPolicy \| This setting defines the Image Pull Policy of Longhorn system managed pod. e.g. instance manager, engine image, CSI driver, etc. The new Image Pull Policy will only apply after the system managed pods restart. \|
	\| defaultSettings.systemManagedPodsImagePullPolicy \| Image pull policy for system-managed pods, such as Instance Manager, engine images, and CSI Driver. Changes to the image pull policy are applied only after the system-managed pods restart. \|

	\| defaultSettings.taintToleration \| taintToleration for longhorn system components \|
	\| defaultSettings.taintToleration \| Taint or toleration for system-managed components. \|

	\| defaultSettings.upgradeChecker \| Upgrade Checker will check for new Longhorn version periodically. When there is a new version available, a notification will appear in the UI. By default true. \|
	\| 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.v2DataEngine \| This allows users to activate v2 data engine based on SPDK. Currently, it is in the preview phase and should not be utilized in a production environment. \|
	\| defaultSettings.v2DataEngine \| Setting that allows you to enable the V2 Data Engine using the Storage Performance Development Kit (SPDK). The V2 Data Engine is a preview feature and should not be used in production environments. \|

doc(helm): add helm values to website #773

doc(helm): add helm values to website #773

Conversation

ChanYiLin commented Sep 6, 2023

innobead left a comment

Choose a reason for hiding this comment

innobead left a comment

Choose a reason for hiding this comment

jillian-maroket left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

innobead commented Dec 19, 2023

jillian-maroket left a comment •

edited

Loading