istio.io
istio.io copied to clipboard
default helm installation steps doesn't work for k8s ingress
https://istio.io/latest/docs/setup/install/helm/#installation-steps
8. (Optional) Install an ingress gateway:
$ kubectl create namespace istio-ingress
$ helm install istio-ingress istio/gateway -n istio-ingress --wait
Following the above official steps to install istio doesn't work for k8s ingress, as the default values of ingressService
and ingressSelector
is istio-ingressgateway
and ingressgateway
respectly in MeshConfig.
We should at least change the example release name from istio-ingress
to istio-ingressgateway
, as did by artifacthub example and gateway setup example, so the default helm installation steps works out of the box for k8s ingress.
A lot of people have stumbled upon this issue:
https://github.com/istio/istio/issues/36444#issuecomment-993105159 https://github.com/istio/istio/issues/37329 https://github.com/istio/istio/issues/44402
I have seen projects where all examples in the documentation itself are packaged in a way that they are all executed part of the test suite, so it become harder to create stale documentation by renaming one thing somewhere else. I have also seen project where commit are very hard to get approved without a lot of work on the matching documentation, like if the documentation quality was taken seriously.