istio.io icon indicating copy to clipboard operation
istio.io copied to clipboard

improve kind installation page

Open craigbox opened this issue 1 year ago • 7 comments

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.

craigbox avatar Jun 04 '24 00:06 craigbox

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 avatar Jun 04 '24 15:06 peterj

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.

peterj avatar Jun 04 '24 16:06 peterj

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

craigbox avatar Jun 04 '24 21:06 craigbox

All right, I'll collapse this down.

peterj avatar Jun 04 '24 21:06 peterj

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

peterj avatar Jun 05 '24 20:06 peterj

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

craigbox avatar Jun 06 '24 02:06 craigbox

https://github.com/istio/istio.io/pull/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)

peterj avatar Jul 16 '24 21:07 peterj