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

improve kind installation page #15234

Open
craigbox opened this issue Jun 4, 2024 · 7 comments
Open

improve kind installation page #15234

craigbox opened this issue Jun 4, 2024 · 7 comments
Assignees

Comments

@craigbox
Copy link
Contributor

craigbox commented Jun 4, 2024

https://istio.io/latest/docs/setup/platform-setup/kind/

The new target audience for this page is a Getting Started user.

We should rewrite:

  • to not need to know about your Go version
  • s/MetalLB/Cloud Provider kind/, and only if you really need it
  • without concern for the Kubernetes Dashboard

and/or we should use Minikube instead.

@peterj
Copy link
Member

peterj commented Jun 4, 2024

Honestly, this page has nothing Istio specific, and no special configuration/setting is needed to run Istio on kind (in this case).

Why don't we get rid of this page and just say "Visit kind.sh for instructions on how to set up your cluster" where applicable. If platforms require some special Istio-specific setup/config then we should call that out.

@peterj
Copy link
Member

peterj commented Jun 4, 2024

A couple of common themes across all platforms:

  • run a cluster large enough to run Istio + bookinfo (e.g. 8gb mem requirement from docker desktop, minikube, etc.)
  • different ways of exposing ingress gateway, getting the IP, etc.

Other than that, the instructions are not in any way specific to Istio and they are mostly about setting up a k8s cluster.

Platform Notes
Alibaba cloud Outdated (i.e. "hasn't been tested on 1.9") + no Istio specific config
Amazon EKS no Istio specific config, links to EKS blueprints
Azure no Istio specific config
Docker Desktop no Istio specific config
GKE Has a note for private GKE cluster + section for multi-cluster communication (which isn't necessarily istio specific)
Huawei Notes on resources, but otherwise no Istio specific config
IBM no Istio specific config
k3d command to set up a k3d cluster without traefik and to expose certain ports (I think)
kind no Istio specific config
Kops no Istio specific config (unless you're k8s < 1.22)
Kubernetes Gardener no Istio specific config
KubeSphere Container Platform Outdated (i.e. "hasn't been tested on 1.9") + no Istio specific config
MicroK8s no Istio specific config
Minikube Memory requirements, no Istio specific config
Openshift no Istio specific config
OCI Outdated, no Istio specific config
Tencent no Istio specific config

I think these 18 subpages could be links to instructions on the platforms' website for setting up the cluster.

@craigbox
Copy link
Contributor Author

craigbox commented Jun 4, 2024

I've been wanting to collapse these down to one page. Let's do that.

@peterj
Copy link
Member

peterj commented Jun 4, 2024

All right, I'll collapse this down.

@peterj peterj self-assigned this Jun 4, 2024
@peterj
Copy link
Member

peterj commented Jun 5, 2024

Before I go further down the hole, would the FAQ layout work well for this page, @craigbox?
Screenshot 2024-06-05 at 1 26 47 PM

@craigbox
Copy link
Contributor Author

craigbox commented Jun 6, 2024

Maybe? Depends how big the titles are under each section, I guess.
Hopefully it's just a small toggle to change each and we'll see what they look like

@peterj
Copy link
Member

peterj commented Jul 16, 2024

#15425 changes the page to FAQ-style.

@craigbox should I go ahead and remove all instructions that don't have any Istio specific steps? (or do we keep it around for SEO purposes perhaps)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants