Skip to content
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

Open
michaelbeaumont opened this issue May 15, 2023 · 12 comments · May be fixed by #2054
Open

Installation docs are missing/confusing #1334

michaelbeaumont opened this issue May 15, 2023 · 12 comments · May be fixed by #2054
Assignees
Labels
kind/bug A bug triage/accepted The issue was reviewed and is complete enough to start working on it

Comments

@michaelbeaumont
Copy link
Contributor

michaelbeaumont commented May 15, 2023

What happened?

  1. It looks like the docs for installing a CP in standalone using Helm have disappeared.

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

@michaelbeaumont michaelbeaumont added triage/pending This issue will be looked at on the next triage meeting kind/bug A bug labels May 15, 2023
@cloudjumpercat
Copy link
Contributor

cloudjumpercat commented May 15, 2023

@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 Kuma

Install on Kubernetes

Install kumactl

Deploy control plane

Standalone

Multizone

Install on Helm

(this would have the same sections as the previous one)

Install on Linux

@michaelbeaumont
Copy link
Contributor Author

I think the "install with helm" section could be under "Deploy control plane"? Like users will always want kumactl but not necessarily for installing the CP, so anytime they're installing on k8s there will be a choice between Helm or kumactl, since Helm is also just installing on Kubernetes. So i could imagine tabs

Helm | kumactl on k8s | Universal

or similar.

And the Helm Tab should include setting up Helm

@jakubdyszkiewicz jakubdyszkiewicz added triage/accepted The issue was reviewed and is complete enough to start working on it and removed triage/pending This issue will be looked at on the next triage meeting labels May 22, 2023
@michaelbeaumont
Copy link
Contributor Author

Another unfortunate side effect is that every tile at https://kuma.io/install/2.2.x/ redirects to the install kumactl page

@cloudjumpercat
Copy link
Contributor

@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/

@github-actions github-actions bot added the triage/stale Inactive for some time. It will be triaged again label Oct 11, 2023
@github-actions
Copy link
Contributor

This issue was inactive for 90 days. It will be reviewed in the next triage meeting and might be closed.
If you think this issue is still relevant, please comment on it or attend the next triage meeting.

@cloudjumpercat
Copy link
Contributor

I'd like to pick this up for the next Mesh/Kuma docs IA rework phase

@lahabana
Copy link
Contributor

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

@lahabana lahabana removed the triage/stale Inactive for some time. It will be triaged again label Oct 12, 2023
@lahabana lahabana self-assigned this Oct 12, 2023
Copy link
Contributor

This issue was inactive for 90 days. It will be reviewed in the next triage meeting and might be closed.
If you think this issue is still relevant, please comment on it or attend the next triage meeting.

@github-actions github-actions bot added the triage/stale Inactive for some time. It will be triaged again label Jan 11, 2024
@lahabana lahabana removed the triage/stale Inactive for some time. It will be triaged again label Jan 11, 2024
@github-actions github-actions bot added the triage/stale Inactive for some time. It will be triaged again label Apr 11, 2024
Copy link
Contributor

This issue was inactive for 90 days. It will be reviewed in the next triage meeting and might be closed.
If you think this issue is still relevant, please comment on it or attend the next triage meeting.

@lahabana lahabana removed the triage/stale Inactive for some time. It will be triaged again label Apr 11, 2024
@github-actions github-actions bot added the triage/stale Inactive for some time. It will be triaged again label Jul 11, 2024
Copy link
Contributor

This issue was inactive for 90 days. It will be reviewed in the next triage meeting and might be closed.
If you think this issue is still relevant, please comment on it or attend the next triage meeting.

@lukidzi lukidzi removed the triage/stale Inactive for some time. It will be triaged again label Jul 15, 2024
@github-actions github-actions bot added the triage/stale Inactive for some time. It will be triaged again label Oct 14, 2024
Copy link
Contributor

This issue was inactive for 90 days. It will be reviewed in the next triage meeting and might be closed.
If you think this issue is still relevant, please comment on it or attend the next triage meeting.

@lukidzi lukidzi removed the triage/stale Inactive for some time. It will be triaged again label Oct 21, 2024
@github-actions github-actions bot added the triage/stale Inactive for some time. It will be triaged again label Jan 20, 2025
Copy link
Contributor

This issue was inactive for 90 days. It will be reviewed in the next triage meeting and might be closed.
If you think this issue is still relevant, please comment on it or attend the next triage meeting.

@lukidzi lukidzi removed the triage/stale Inactive for some time. It will be triaged again label Jan 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug A bug triage/accepted The issue was reviewed and is complete enough to start working on it
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants