-
Notifications
You must be signed in to change notification settings - Fork 89
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Installation docs are missing/confusing #1334
Comments
@michaelbeaumont Based on your feedback, do you think a structure like this would be better with a specific section in the docs (in the Kuma in Production section) that just says "Install Kuma"? You're right in that what I mentioned in #1331 probably wouldn't fix that since the quick start and get started are supposed to be very opinionated just to get people up and running quickly so they can test Kuma. I think those are going to be just Kubernetes specific. Install KumaInstall on KubernetesInstall kumactlDeploy control planeStandaloneMultizoneInstall on Helm(this would have the same sections as the previous one) Install on Linux |
I think the "install with helm" section could be under "Deploy control plane"? Like users will always want Helm | kumactl on k8s | Universal or similar. And the Helm Tab should include setting up Helm |
Another unfortunate side effect is that every tile at https://kuma.io/install/2.2.x/ redirects to the install |
@michaelbeaumont Looks like we have two "Deploy a control plane" pages:
The multi-zone page has a tab for Helm, does that cover the necessary info? Looks like I'd need to add a tab to standalone for Helm though. Not sure this would fix the problems with the tiles here since we'd have to choose to point them to standalone or multizone: https://kuma.io/install/2.2.x/ |
This issue was inactive for 90 days. It will be reviewed in the next triage meeting and might be closed. |
I'd like to pick this up for the next Mesh/Kuma docs IA rework phase |
This got reworked already yes. What we're missing is that our helm/kumactl options should link to extra info (how to get the helm chart and how to get kumactl). I'll add this as soon as I merge: #1482 |
This issue was inactive for 90 days. It will be reviewed in the next triage meeting and might be closed. |
This issue was inactive for 90 days. It will be reviewed in the next triage meeting and might be closed. |
This issue was inactive for 90 days. It will be reviewed in the next triage meeting and might be closed. |
This issue was inactive for 90 days. It will be reviewed in the next triage meeting and might be closed. |
This issue was inactive for 90 days. It will be reviewed in the next triage meeting and might be closed. |
What happened?
It looks like the docs for installing a CP in standalone using Helm have disappeared.
There's a tab for multizone & Helm but it's next to a Kubernetes tab? Which is sort of confusing.
There's no Helm set up steps, like
helm repo add
.There's really no where for a user to go if they "just want to install". There's install
kumactl
but then there's no way to get to the next step. Searching for "install" or "installation" doesn't return useful results.I know there's #1331 (comment) but it's (EDIT: not) clear to me whether this is covered there.
The text was updated successfully, but these errors were encountered: