doc(install): support helm-controller #1007
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Marking as draft because we want reviews of the content, but it shouldn't be committed until tests are in place and running. |
✅ Deploy Preview for longhornio ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
jhkrug
previously requested changes
Oct 22, 2024
content/docs/1.8.0/deploy/install/install-with-helm-controller.md
Outdated
Show resolved
Hide resolved
content/docs/1.8.0/deploy/install/install-with-helm-controller.md
Outdated
Show resolved
Hide resolved
content/docs/1.8.0/deploy/install/install-with-helm-controller.md
Outdated
Show resolved
Hide resolved
content/docs/1.8.0/deploy/install/install-with-helm-controller.md
Outdated
Show resolved
Hide resolved
james-munson
force-pushed
the
9506-helm-controller
branch
from
92ce06e
to
868b4b5
Compare
|
Suggestions incorporated and re-pushed. |
|
@james-munson If it is ready, please change it to Ready For Review |
james-munson
force-pushed
the
9506-helm-controller
branch
from
868b4b5
to
1b9e1b5
Compare
|
I'll propagate the content to 1.6 and 1.7 as well. |
|
@james-munson Can you update the important note in the PR as well? |
james-munson
force-pushed
the
9506-helm-controller
branch
from
1b9e1b5
to
a8fe129
Compare
|
Added to "Important Notes" for 1.8.0. Also included updates to 1.6.4 and 1.7.3 docs. If it needs to be spread to earlier 1.6.x and 1.7.x, please let me know. |
Yes, please, thank you. |
james-munson
force-pushed
the
9506-helm-controller
branch
from
a8fe129
to
e194717
Compare
|
Added to all 1.6.x and 1.7.x docs. |
james-munson
dismissed
jhkrug’s stale review
Requested changes have been made.
|
cc @jhkrug @jillian-maroket Please help review it again. Thank you. |
derekbit
previously approved these changes
Nov 4, 2024
| weight: 10 | ||
| --- | ||
|
|
||
| In this section, you will learn how to install Longhorn with the HelmChart controller built into RKE2 and K3S. |
There was a problem hiding this comment.
Suggested change
| In this section, you will learn how to install Longhorn with the HelmChart controller built into RKE2 and K3S. | |
| In this section, you will learn how to install Longhorn with the HelmChart controller built into RKE2 and K3s. |
There was a problem hiding this comment.
Noted, for future reference. For what it is worth, even https://longhorn.io/docs/1.6.0/advanced-resources/os-distro-specific/csi-on-k3s/ uses several variations: K3s, K3S, k3s.
|
|
||
| ### Prerequisites | ||
|
|
||
| - Kubernetes cluster: Ensure that each node fulfills the [installation requirements](../#installation-requirements). Cluster should be running RKE2 or K3S. |
There was a problem hiding this comment.
Suggested change
| - Kubernetes cluster: Ensure that each node fulfills the [installation requirements](../#installation-requirements). Cluster should be running RKE2 or K3S. | |
| - Kubernetes cluster: Ensure that each node fulfills the [installation requirements](../#installation-requirements). Cluster should be running RKE2 or K3s. |
derekbit
reviewed
Nov 5, 2024
| name: longhorn-install | ||
| namespace: default | ||
| spec: | ||
| version: v1.8.0 |
There was a problem hiding this comment.
Replace with a version variable. Same for other versions.
| @@ -151,6 +151,9 @@ Starting with Longhorn v1.7.0, Longhorn supports Container-Optimized OS (COS), p | |||
| ### Upgrade Check Events | |||
| Longhorn performs a pre-upgrade check when upgrading with Helm or Rancher App Marketplace. If a check fails, the upgrade will stop and the reason for the check's failure will be recorded in an event. For more detail, see [Upgrading Longhorn Manager](../deploy/upgrade/longhorn-manager). | |||
|
|
|||
| ### Install/Upgrade with Helm Controller | |||
| Longhorn also supports installation or upgrade via the HelmChart controller built into RKE2 and K3S. It allows management in a CRD YAML chart of most of the options that would normally be passed to the `helm` command-line tool. For more details on how it works, see [Install with Helm Controller](../deploy/install/install-with-helm-controller). | |||
There was a problem hiding this comment.
Suggested change
| Longhorn also supports installation or upgrade via the HelmChart controller built into RKE2 and K3S. It allows management in a CRD YAML chart of most of the options that would normally be passed to the `helm` command-line tool. For more details on how it works, see [Install with Helm Controller](../deploy/install/install-with-helm-controller). | |
| Longhorn also supports installation or upgrade via the HelmChart controller built into RKE2 and K3s. It allows management in a CRD YAML chart of most of the options that would normally be passed to the `helm` command-line tool. For more details on how it works, see [Install with Helm Controller](../deploy/install/install-with-helm-controller). |
Signed-off-by: James Munson <[email protected]>
james-munson
force-pushed
the
9506-helm-controller
branch
from
e194717
to
f6bb04b
Compare
derekbit
approved these changes
Nov 5, 2024
derekbit
approved these changes
Nov 5, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Which issue(s) this PR fixes:
Issue longhorn/longhorn#9506
What this PR does / why we need it:
Add documentation for install/upgrade/uninstall using HelmChart resource and helm-controller.
Special notes for your reviewer:
Additional documentation or context