mirror of https://github.com/istio/istio.io.git
Update platform prereqs to use platform helm values (#15651)
* Fixup Signed-off-by: Benjamin Leggett <benjamin.leggett@solo.io> * Fixup doc Signed-off-by: Benjamin Leggett <benjamin.leggett@solo.io> * Lints Signed-off-by: Benjamin Leggett <benjamin.leggett@solo.io> * Update content/en/docs/ambient/install/platform-prerequisites/index.md Co-authored-by: Daniel Hawton <daniel@hawton.org> * Update content/en/docs/ambient/install/platform-prerequisites/index.md Co-authored-by: Daniel Hawton <daniel@hawton.org> --------- Signed-off-by: Benjamin Leggett <benjamin.leggett@solo.io> Co-authored-by: Daniel Hawton <daniel@hawton.org>
This commit is contained in:
Ben Leggett
GitHub
parent
d2e0684f07
commit
c3c211c93b
|
|
@ -41,7 +41,7 @@ spec:
|
|||
|
||||
### k3d
|
||||
|
||||
If you are using [k3d](https://k3d.io/) with the default Flannel CNI, you must append some values to your installation command, as k3d uses nonstandard locations for CNI configuration and binaries.
|
||||
When using [k3d](https://k3d.io/) with the default Flannel CNI, you must append the correct `platform` value to your installation commands, as k3d uses nonstandard locations for CNI configuration and binaries which requires some Helm overrides.
|
||||
|
||||
1. Create a cluster with Traefik disabled so it doesn't conflict with Istio's ingress gateways:
|
||||
|
||||
|
|
@ -49,14 +49,14 @@ If you are using [k3d](https://k3d.io/) with the default Flannel CNI, you must a
|
|||
$ k3d cluster create --api-port 6550 -p '9080:80@loadbalancer' -p '9443:443@loadbalancer' --agents 2 --k3s-arg '--disable=traefik@server:*'
|
||||
{{< /text >}}
|
||||
|
||||
1. Set the `cniConfDir` and `cniBinDir` values when installing Istio. For example:
|
||||
1. Set `global.platform=k3d` when installing Istio charts. For example:
|
||||
|
||||
{{< tabset category-name="install-method" >}}
|
||||
|
||||
{{< tab name="Helm" category-value="helm" >}}
|
||||
|
||||
{{< text syntax=bash >}}
|
||||
$ helm install istio-cni istio/cni -n istio-system --set profile=ambient --wait --set cniConfDir=/var/lib/rancher/k3s/agent/etc/cni/net.d --set cniBinDir=/bin
|
||||
$ helm install istio-cni istio/cni -n istio-system --set profile=ambient --set global.platform=k3d --wait
|
||||
{{< /text >}}
|
||||
|
||||
{{< /tab >}}
|
||||
|
|
@ -64,7 +64,7 @@ If you are using [k3d](https://k3d.io/) with the default Flannel CNI, you must a
|
|||
{{< tab name="istioctl" category-value="istioctl" >}}
|
||||
|
||||
{{< text syntax=bash >}}
|
||||
$ istioctl install --set profile=ambient --set values.cni.cniConfDir=/var/lib/rancher/k3s/agent/etc/cni/net.d --set values.cni.cniBinDir=/bin
|
||||
$ istioctl install --set profile=ambient --set values.global.platform=k3d
|
||||
{{< /text >}}
|
||||
|
||||
{{< /tab >}}
|
||||
|
|
@ -73,7 +73,29 @@ If you are using [k3d](https://k3d.io/) with the default Flannel CNI, you must a
|
|||
|
||||
### K3s
|
||||
|
||||
When using [K3s](https://k3s.io/) and one of its bundled CNIs, you must append some values to your installation command, as K3S uses nonstandard locations for CNI configuration and binaries. These nonstandard locations may be overridden as well, [according to K3s documentation](https://docs.k3s.io/cli/server#k3s-server-cli-help). If you are using K3s with a custom, non-bundled CNI, you must use the correct paths for those CNIs, e.g. `/etc/cni/net.d` - [see the K3s docs for details](https://docs.k3s.io/networking/basic-network-options#custom-cni). For example:
|
||||
When using [K3s](https://k3s.io/) and one of its bundled CNIs, you must append the correct `platform` value to your installation commands, as K3s uses nonstandard locations for CNI configuration and binaries which requires some Helm overrides. For the default K3s paths, Istio provides built-in overrides based on the `global.platform` value.
|
||||
|
||||
{{< tabset category-name="install-method" >}}
|
||||
|
||||
{{< tab name="Helm" category-value="helm" >}}
|
||||
|
||||
{{< text syntax=bash >}}
|
||||
$ helm install istio-cni istio/cni -n istio-system --set profile=ambient --set global.platform=k3s --wait
|
||||
{{< /text >}}
|
||||
|
||||
{{< /tab >}}
|
||||
|
||||
{{< tab name="istioctl" category-value="istioctl" >}}
|
||||
|
||||
{{< text syntax=bash >}}
|
||||
$ istioctl install --set profile=ambient --set values.global.platform=k3s
|
||||
{{< /text >}}
|
||||
|
||||
{{< /tab >}}
|
||||
|
||||
{{< /tabset >}}
|
||||
|
||||
However, these locations may be overridden in K3s, [according to K3s documentation](https://docs.k3s.io/cli/server#k3s-server-cli-help). If you are using K3s with a custom, non-bundled CNI, you must manually specify the correct paths for those CNIs, e.g. `/etc/cni/net.d` - [see the K3s docs for details](https://docs.k3s.io/networking/basic-network-options#custom-cni). For example:
|
||||
|
||||
{{< tabset category-name="install-method" >}}
|
||||
|
||||
|
|
@ -97,14 +119,14 @@ When using [K3s](https://k3s.io/) and one of its bundled CNIs, you must append s
|
|||
|
||||
### MicroK8s
|
||||
|
||||
If you are installing Istio on [MicroK8s](https://microk8s.io/), you must append a value to your installation command, as MicroK8s [uses non-standard locations for CNI configuration and binaries](https://microk8s.io/docs/change-cidr). For example:
|
||||
If you are installing Istio on [MicroK8s](https://microk8s.io/), you must append the correct `platform` value to your installation commands, as MicroK8s [uses non-standard locations for CNI configuration and binaries](https://microk8s.io/docs/change-cidr). For example:
|
||||
|
||||
{{< tabset category-name="install-method" >}}
|
||||
|
||||
{{< tab name="Helm" category-value="helm" >}}
|
||||
|
||||
{{< text syntax=bash >}}
|
||||
$ helm install istio-cni istio/cni -n istio-system --set profile=ambient --wait --set cniConfDir=/var/snap/microk8s/current/args/cni-network --set cniBinDir=/var/snap/microk8s/current/opt/cni/bin
|
||||
$ helm install istio-cni istio/cni -n istio-system --set profile=ambient --set global.platform=microk8s --wait
|
||||
|
||||
{{< /text >}}
|
||||
|
||||
|
|
@ -113,7 +135,7 @@ If you are installing Istio on [MicroK8s](https://microk8s.io/), you must append
|
|||
{{< tab name="istioctl" category-value="istioctl" >}}
|
||||
|
||||
{{< text syntax=bash >}}
|
||||
$ istioctl install --set profile=ambient --set values.cni.cniConfDir=/var/snap/microk8s/current/args/cni-network --set values.cni.cniBinDir=/var/snap/microk8s/current/opt/cni/bin
|
||||
$ istioctl install --set profile=ambient --set values.global.platform=microk8s
|
||||
{{< /text >}}
|
||||
|
||||
{{< /tab >}}
|
||||
|
|
@ -123,15 +145,15 @@ If you are installing Istio on [MicroK8s](https://microk8s.io/), you must append
|
|||
### minikube
|
||||
|
||||
If you are using [minikube](https://kubernetes.io/docs/tasks/tools/install-minikube/) with the [Docker driver](https://minikube.sigs.k8s.io/docs/drivers/docker/),
|
||||
you must append some values to your installation command so that the Istio CNI node agent can correctly manage
|
||||
and capture pods on the node. For example:
|
||||
you must append the correct `platform` value to your installation commands, as minikube with Docker uses a nonstandard bind mount path for containers.
|
||||
For example:
|
||||
|
||||
{{< tabset category-name="install-method" >}}
|
||||
|
||||
{{< tab name="Helm" category-value="helm" >}}
|
||||
|
||||
{{< text syntax=bash >}}
|
||||
$ helm install istio-cni istio/cni -n istio-system --set profile=ambient --wait --set cniNetnsDir="/var/run/docker/netns"
|
||||
$ helm install istio-cni istio/cni -n istio-system --set profile=ambient --set global.platform=minikube --wait"
|
||||
{{< /text >}}
|
||||
|
||||
{{< /tab >}}
|
||||
|
|
@ -139,7 +161,7 @@ and capture pods on the node. For example:
|
|||
{{< tab name="istioctl" category-value="istioctl" >}}
|
||||
|
||||
{{< text syntax=bash >}}
|
||||
$ istioctl install --set profile=ambient --set cni.cniNetnsDir="/var/run/docker/netns"
|
||||
$ istioctl install --set profile=ambient --set values.global.platform=minikube"
|
||||
{{< /text >}}
|
||||
|
||||
{{< /tab >}}
|
||||
|
|
@ -148,14 +170,18 @@ and capture pods on the node. For example:
|
|||
|
||||
### Red Hat OpenShift
|
||||
|
||||
OpenShift requires that `ztunnel` and `istio-cni` components are installed in the `kube-system` namespace. An `openshift-ambient` installation profile is provided which will make this change for you. Replace instances of `profile=ambient` with `profile=openshift-ambient` in the installation commands. For example:
|
||||
OpenShift requires that `ztunnel` and `istio-cni` components are installed in the `kube-system` namespace, and that you set `global.platform=openshift` for all charts.
|
||||
|
||||
If you use `helm`, you can set the target namespace and `global.platform` values directly.
|
||||
|
||||
If you use `istioctl`, you must use a special profile named `openshift-ambient` to accomplish the same thing.
|
||||
|
||||
{{< tabset category-name="install-method" >}}
|
||||
|
||||
{{< tab name="Helm" category-value="helm" >}}
|
||||
|
||||
{{< text syntax=bash >}}
|
||||
$ helm install istio-cni istio/cni -n istio-system --set profile=openshift-ambient --wait
|
||||
$ helm install istio-cni istio/cni -n kube-system --set profile=ambient --set global.platform=openshift --wait
|
||||
{{< /text >}}
|
||||
|
||||
{{< /tab >}}
|
||||
|
|
|
|||
|
|
@ -111,7 +111,7 @@ on usage.
|
|||
When deploying the gateway in an OpenShift cluster, use the `openshift` profile to override the default values, for example:
|
||||
|
||||
{{< text bash >}}
|
||||
$ helm install istio-ingressgateway istio/gateway -n istio-ingress --set profile=openshift
|
||||
$ helm install istio-ingressgateway istio/gateway -n istio-ingress --set global.platform=openshift
|
||||
{{< /text >}}
|
||||
|
||||
{{< /tip >}}
|
||||
|
|
|
|||
|
|
@ -54,7 +54,7 @@ helm install istio-ingressgateway istio/gateway -n istio-ingress
|
|||
}
|
||||
|
||||
snip_deploying_a_gateway_4() {
|
||||
helm install istio-ingressgateway istio/gateway -n istio-ingress --set profile=openshift
|
||||
helm install istio-ingressgateway istio/gateway -n istio-ingress --set global.platform=openshift
|
||||
}
|
||||
|
||||
! IFS=$'\n' read -r -d '' snip_deploying_a_gateway_5 <<\ENDSNIP
|
||||
|
|
|
|||
|
|
@ -16,7 +16,7 @@ Follow these instructions to prepare an OpenShift cluster for Istio.
|
|||
Install Istio using the OpenShift profile:
|
||||
|
||||
{{< text bash >}}
|
||||
$ istioctl install --set profile=openshift
|
||||
$ istioctl install --set global.platform=openshift
|
||||
{{< /text >}}
|
||||
|
||||
After installation is complete, expose an OpenShift route for the ingress gateway.
|
||||
|
|
|
|||
Loading…
Reference in New Issue