docs: add install via KubeStellar Console (addresses #4858) - #447
docs: add install via KubeStellar Console (addresses #4858)#447clubanderson wants to merge 2 commits into
Conversation
Adds a new doc describing how to install Chaos Mesh using the KubeStellar Console's guided install mission, as requested by @STRRL in chaos-mesh/chaos-mesh#4858. The new page sits alongside the existing Helm install doc in the Installation and Deployment section of the sidebar. All commands, runtime flags and values are taken directly from the upstream chaos-mesh/chaos-mesh chart — no forks or shims. The new doc cross-links the Helm doc for the per-runtime install matrix and the CRD-upgrade caveat rather than duplicating them. Fixes: chaos-mesh/chaos-mesh#4858 Signed-off-by: Andrew Anderson <andy@clubanderson.com>
✅ Deploy Preview for chaos-mesh-website-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Chaos Mesh maintainer @STRRL explicitly requested a new "Install Chaos Mesh via KubeStellar Console" doc in chaos-mesh/chaos-mesh#4858, which is now up as chaos-mesh/website#447. Pending @STRRL's explicit approval on whether they are OK being listed here before this PR is merged. Signed-off-by: Andy Anderson <andy@clubanderson.com>
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 0809d4a3fa
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
| The mission runs the install with runtime-specific flags. Pick the runtime that matches your cluster and the mission shows the exact command. For a Docker-runtime cluster, the default command is: | ||
|
|
||
| ```bash | ||
| helm install chaos-mesh chaos-mesh/chaos-mesh -n=chaos-mesh --version latest |
There was a problem hiding this comment.
This command asks users to pass --version latest, but Helm documents --version as a semver constraint (or exact chart version), and explicitly says the latest chart is chosen when the flag is omitted. In practice, copy-pasting this line can fail with an invalid constraint error unless a chart literally has a latest version tag, so the new install flow is likely to break for users following this page.
Useful? React with 👍 / 👎.
Helm's --version flag expects a semver constraint, not the literal word 'latest'. The existing helm install doc works around this by wrapping the command in the <PickHelmVersion> React component which substitutes the current version at render time, but this doc uses plain code blocks. Drop --version latest (Helm defaults to latest without the flag) and document the pin pattern explicitly. Addresses Codex review comment on chaos-mesh#447. Signed-off-by: Andrew Anderson <andy@clubanderson.com>
|
Thanks @chatgpt-codex-connector — fixed in ca5d734. Dropped |
|
To use Codex here, create a Codex account and connect to github. |
|
Hi @STRRL — friendly ping on this. Happy to address any review feedback. Once this merges, we'd love to add Chaos Mesh to our ADOPTERS list on our side (kubestellar/console#7889) — just a one-line entry, no action on your end beyond a comment saying it's OK. |
|
Hi @STRRL — following up on this docs PR. The install mission at https://console.kubestellar.io/missions/install-chaos-mesh has had several dozen installs from the CNCF community. Happy to iterate on the docs format or content — let me know if any changes are needed! |
1 participant
Summary
Adds a new doc — Install Chaos Mesh using KubeStellar Console — alongside the existing Helm install guide, as requested by @STRRL in chaos-mesh/chaos-mesh#4858.
docs/production-installation-using-kubestellar-console.mdInstallation and Deploymentright afterproduction-installation-using-helmWhat's in the new doc
kubestellar/kubestellar,kubeflex, or OCM) that provides a guided install mission for Chaos Mesh.chaos-mesh/chaos-meshchart — no forks or shims._verify-installation.mdand_quick-run.mdpartials to match the Helm doc for post-install steps.kubestellar/console-kbso maintainers and users can suggest fixes directly.Context
@STRRL confirmed in chaos-mesh/chaos-mesh#4858 (comment):
This PR is that new doc.
Test plan
production-installation-using-helm.mdresolveHappy to iterate on wording, scope, or placement — just say the word.