istio
/
istio.io
mirror of https://github.com/istio/istio.io.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Do the thing we suggest instead of documenting the hard way (#16060) 

* Nit - do the thing we suggest instead of documenting the hard way

Signed-off-by: Benjamin Leggett <benjamin.leggett@solo.io>

* derp

Signed-off-by: Benjamin Leggett <benjamin.leggett@solo.io>

---------

Signed-off-by: Benjamin Leggett <benjamin.leggett@solo.io>
This commit is contained in:
Ben Leggett 2024-12-05 20:12:06 -05:00 committed by GitHub
parent bd4e1379cd
commit 56687a67e1
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 11 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
content/en/docs/setup/install/helm/index.md
View File

@ -34,15 +34,6 @@ Default configuration values can be changed using one or more `--set <parameter>
You can display the default values of configuration parameters using the `helm show values <chart>` command or refer to `artifacthub` chart documentation at [Custom Resource Definition parameters](https://artifacthub.io/packages/helm/istio-official/base?modal=values), [Istiod chart configuration parameters](https://artifacthub.io/packages/helm/istio-official/istiod?modal=values) and [Gateway chart configuration parameters](https://artifacthub.io/packages/helm/istio-official/gateway?modal=values). You can display the default values of configuration parameters using the `helm show values <chart>` command or refer to `artifacthub` chart documentation at [Custom Resource Definition parameters](https://artifacthub.io/packages/helm/istio-official/base?modal=values), [Istiod chart configuration parameters](https://artifacthub.io/packages/helm/istio-official/istiod?modal=values) and [Gateway chart configuration parameters](https://artifacthub.io/packages/helm/istio-official/gateway?modal=values).
{{< /tip >}} {{< /tip >}}
1. Create the namespace, `istio-system`, for the Istio components:
{{< tip >}}
This step can be skipped if using the `--create-namespace` argument in step 2.
{{< /tip >}}
{{< text syntax=bash snip_id=create_istio_system_namespace >}}
$ kubectl create namespace istio-system
{{< /text >}}
1. Install the Istio base chart which contains cluster-wide Custom Resource Definitions (CRDs) which must be installed prior to the deployment of the Istio control plane: 1. Install the Istio base chart which contains cluster-wide Custom Resource Definitions (CRDs) which must be installed prior to the deployment of the Istio control plane:
{{< warning >}} {{< warning >}}
@ -51,7 +42,7 @@ You can display the default values of configuration parameters using the `helm s
{{< /warning >}} {{< /warning >}}
{{< text syntax=bash snip_id=install_base >}} {{< text syntax=bash snip_id=install_base >}}
$ helm install istio-base istio/base -n istio-system --set defaultRevision=default $ helm install istio-base istio/base -n istio-system --set defaultRevision=default --create-namespace
{{< /text >}} {{< /text >}}
1. Validate the CRD installation with the `helm ls` command: 1. Validate the CRD installation with the `helm ls` command:

22
content/en/docs/setup/install/helm/snips.sh
View File

@ -21,19 +21,15 @@
#################################################################################################### ####################################################################################################
source "content/en/boilerplates/snips/helm-prereqs.sh" source "content/en/boilerplates/snips/helm-prereqs.sh"
snip_create_istio_system_namespace() {
kubectl create namespace istio-system
}
snip_install_base() { snip_install_base() {
helm install istio-base istio/base -n istio-system --set defaultRevision=default helm install istio-base istio/base -n istio-system --set defaultRevision=default --create-namespace
} }
snip_installation_steps_4() { snip_installation_steps_3() {
helm ls -n istio-system helm ls -n istio-system
} }
! IFS=$'\n' read -r -d '' snip_installation_steps_4_out <<\ENDSNIP ! IFS=$'\n' read -r -d '' snip_installation_steps_3_out <<\ENDSNIP
NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION
istio-base istio-system 1 2024-04-17 22:14:45.964722028 +0000 UTC deployed base-1.25.0 1.25.0 istio-base istio-system 1 2024-04-17 22:14:45.964722028 +0000 UTC deployed base-1.25.0 1.25.0
ENDSNIP ENDSNIP
@ -42,21 +38,21 @@ snip_install_discovery() {
helm install istiod istio/istiod -n istio-system --wait helm install istiod istio/istiod -n istio-system --wait
} }
snip_installation_steps_6() { snip_installation_steps_5() {
helm ls -n istio-system helm ls -n istio-system
} }
! IFS=$'\n' read -r -d '' snip_installation_steps_6_out <<\ENDSNIP ! IFS=$'\n' read -r -d '' snip_installation_steps_5_out <<\ENDSNIP
NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION
istio-base istio-system 1 2024-04-17 22:14:45.964722028 +0000 UTC deployed base-1.25.0 1.25.0 istio-base istio-system 1 2024-04-17 22:14:45.964722028 +0000 UTC deployed base-1.25.0 1.25.0
istiod istio-system 1 2024-04-17 22:14:45.964722028 +0000 UTC deployed istiod-1.25.0 1.25.0 istiod istio-system 1 2024-04-17 22:14:45.964722028 +0000 UTC deployed istiod-1.25.0 1.25.0
ENDSNIP ENDSNIP
snip_installation_steps_7() { snip_installation_steps_6() {
helm status istiod -n istio-system helm status istiod -n istio-system
} }
! IFS=$'\n' read -r -d '' snip_installation_steps_7_out <<\ENDSNIP ! IFS=$'\n' read -r -d '' snip_installation_steps_6_out <<\ENDSNIP
NAME: istiod NAME: istiod
LAST DEPLOYED: Fri Jan 20 22:00:44 2023 LAST DEPLOYED: Fri Jan 20 22:00:44 2023
NAMESPACE: istio-system NAMESPACE: istio-system
@ -87,11 +83,11 @@ For further documentation see https://istio.io website
Tell us how your install/upgrade experience went at https://forms.gle/99uiMML96AmsXY5d6 Tell us how your install/upgrade experience went at https://forms.gle/99uiMML96AmsXY5d6
ENDSNIP ENDSNIP
snip_installation_steps_8() { snip_installation_steps_7() {
kubectl get deployments -n istio-system --output wide kubectl get deployments -n istio-system --output wide
} }
! IFS=$'\n' read -r -d '' snip_installation_steps_8_out <<\ENDSNIP ! IFS=$'\n' read -r -d '' snip_installation_steps_7_out <<\ENDSNIP
NAME READY UP-TO-DATE AVAILABLE AGE CONTAINERS IMAGES SELECTOR NAME READY UP-TO-DATE AVAILABLE AGE CONTAINERS IMAGES SELECTOR
istiod 1/1 1 1 10m discovery docker.io/istio/pilot:1.25.0 istio=pilot istiod 1/1 1 1 10m discovery docker.io/istio/pilot:1.25.0 istio=pilot
ENDSNIP ENDSNIP

3
content/en/docs/setup/install/helm/test.sh
View File

@ -20,7 +20,6 @@ set -o pipefail
# @setup profile=none # @setup profile=none
snip_create_istio_system_namespace
_rewrite_helm_repo snip_install_base _rewrite_helm_repo snip_install_base
_rewrite_helm_repo snip_install_discovery _rewrite_helm_repo snip_install_discovery
@ -31,7 +30,7 @@ _wait_for_deployment istio-ingress istio-ingress
# shellcheck disable=SC2154 # shellcheck disable=SC2154
_verify_like snip_helm_ls "$snip_helm_ls_out" _verify_like snip_helm_ls "$snip_helm_ls_out"
_verify_contains snip_installation_steps_7 "STATUS: deployed" _verify_contains snip_installation_steps_6 "STATUS: deployed"
# @cleanup # @cleanup
snip_delete_delete_gateway_charts snip_delete_delete_gateway_charts