From a2266db8dd012b718aa60dc23c2455ac2706e6bc Mon Sep 17 00:00:00 2001 From: jacob-delgado Date: Mon, 8 Feb 2021 11:32:10 -0700 Subject: [PATCH] Fix helm docs for Istio 1.9.0 (#8898) * Fix helm docs for Istio 1.9.0 * Modify operator instructions * Add boilerplate for helm warning * Fix linting issue --- content/en/boilerplates/helm-hub-tag.md | 7 +++++++ content/en/docs/setup/install/helm/index.md | 16 ++-------------- content/en/docs/setup/install/operator/index.md | 12 ++++++------ 3 files changed, 15 insertions(+), 20 deletions(-) create mode 100644 content/en/boilerplates/helm-hub-tag.md diff --git a/content/en/boilerplates/helm-hub-tag.md b/content/en/boilerplates/helm-hub-tag.md new file mode 100644 index 0000000000..01be821a5a --- /dev/null +++ b/content/en/boilerplates/helm-hub-tag.md @@ -0,0 +1,7 @@ +--- +--- +{{< warning >}} +Prior to Istio 1.9.0, installations using the Helm charts required hub and tag arguments: +`--set global.hub="docker.io/istio"` and `--set global.tag="1.8.2"`. As of Istio +1.9.0 these are is no longer required. +{{< /warning >}} diff --git a/content/en/docs/setup/install/helm/index.md b/content/en/docs/setup/install/helm/index.md index ed02699ae3..b640ffb5be 100644 --- a/content/en/docs/setup/install/helm/index.md +++ b/content/en/docs/setup/install/helm/index.md @@ -17,6 +17,8 @@ installing Istio via [Istioctl](/docs/setup/install/istioctl/) or the This feature is currently considered [alpha](/about/feature-stages/). +{{< boilerplate helm-hub-tag >}} + ## Prerequisites 1. [Download the Istio release](/docs/setup/getting-started/#download). @@ -68,8 +70,6 @@ to the missing `istio-token` volume. {{< text bash >}} $ helm install istiod manifests/charts/istio-control/istio-discovery \ - --set global.hub="docker.io/istio" \ - --set global.tag="{{< istio_full_version >}}" \ -n istio-system {{< /text >}} @@ -78,8 +78,6 @@ to the missing `istio-token` volume. {{< text bash >}} $ helm install istio-ingress manifests/charts/gateways/istio-ingress \ - --set global.hub="docker.io/istio" \ - --set global.tag="{{< istio_full_version >}}" \ -n istio-system {{< /text >}} @@ -88,8 +86,6 @@ to the missing `istio-token` volume. {{< text bash >}} $ helm install istio-egress manifests/charts/gateways/istio-egress \ - --set global.hub="docker.io/istio" \ - --set global.tag="{{< istio_full_version >}}" \ -n istio-system {{< /text >}} @@ -175,8 +171,6 @@ gateways is [actively in development](/docs/setup/upgrade/gateways/) and is cons {{< text bash >}} $ helm install istiod-canary manifests/charts/istio-control/istio-discovery \ --set revision=canary \ - --set global.hub="docker.io/istio" \ - --set global.tag= \ -n istio-system {{< /text >}} @@ -221,8 +215,6 @@ preserve your custom configuration during Helm upgrades. {{< text bash >}} $ helm upgrade istiod manifests/charts/istio-control/istio-discovery \ - --set global.hub="docker.io/istio" \ - --set global.tag= \ -n istio-system {{< /text >}} @@ -231,12 +223,8 @@ preserve your custom configuration during Helm upgrades. {{< text bash >}} $ helm upgrade istio-ingress manifests/charts/gateways/istio-ingress \ - --set global.hub="docker.io/istio" \ - --set global.tag=\ -n istio-system $ helm upgrade istio-egress manifests/charts/gateways/istio-egress \ - --set global.hub="docker.io/istio" \ - --set global.tag= \ -n istio-system {{< /text >}} diff --git a/content/en/docs/setup/install/operator/index.md b/content/en/docs/setup/install/operator/index.md index 54db0f60dc..f4c991b3ac 100644 --- a/content/en/docs/setup/install/operator/index.md +++ b/content/en/docs/setup/install/operator/index.md @@ -62,12 +62,12 @@ To avoid a vulnerability, ensure that the operator deployment is sufficiently se {{< text bash >}} $ helm install istio-operator manifests/charts/istio-operator \ - --set hub=docker.io/istio \ - --set tag={{< istio_full_version >}} \ --set operatorNamespace=istio-operator \ - --set watchedNamespaces=istio-namespace1,istio-namespace2 + --set watchedNamespaces="istio-namespace1\,istio-namespace2" {{< /text >}} + {{< boilerplate helm-hub-tag >}} + Note that you need to [download the Istio release](/docs/setup/getting-started/#download) to run the above command. {{< /tip >}} @@ -237,13 +237,13 @@ You can alternatively use Helm to deploy another operator with a different revis {{< text bash >}} $ helm install istio-operator manifests/charts/istio-operator \ - --set hub=docker.io/istio \ - --set tag={{< istio_full_version >}} \ --set operatorNamespace=istio-operator \ --set watchedNamespaces=istio-system \ - --set revision=1-8-1 + --set revision=1-9-0 {{< /text >}} +{{< boilerplate helm-hub-tag >}} + Note that you need to [download the Istio release](/docs/setup/getting-started/#download) to run the above command. {{< /tip >}}