Install with Helm

Follow this guide to install and configure an Istio mesh using Helm.

The Helm charts for base and istiod used in this guide are the same as those used when installing Istio via Istioctl or the Operator. However installations via Istioctl and the Operator use a different gateway chart to the chart described in this guide

Prerequisites

  1. Perform any necessary platform-specific setup.

  2. Check the Requirements for Pods and Services.

  3. Install the Helm client, version 3.6 or above.

  4. Configure the Helm repository:

  1. $ helm repo add istio https://istio-release.storage.googleapis.com/charts
  2. $ helm repo update

Installation steps

This section describes the procedure to install Istio using Helm. The general syntax for helm installation is:

  1. $ helm install <release> <chart> --namespace <namespace> --create-namespace [--set <other_parameters>]

The variables specified in the command are as follows:

  • <chart> A path to a packaged chart, a path to an unpacked chart directory or a URL.
  • <release> A name to identify and manage the Helm chart once installed.
  • <namespace> The namespace in which the chart is to be installed.

Default configuration values can be changed using one or more --set <parameter>=<value> arguments. Alternatively, you can specify several parameters in a custom values file using the --values <file> argument.

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, Istiod chart configuration parameters and Gateway chart configuration parameters.

  1. Create the namespace, istio-system, for the Istio components:

    This step can be skipped if using the --create-namespace argument in step 2.

    1. $ kubectl create namespace istio-system

  2. 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:

    When performing a revisioned installation, the base chart requires the --set defaultRevision=<revision> value to be set for resource validation to function. Below we install the default revision, so --set defaultRevision=default is configured.

    1. $ helm install istio-base istio/base -n istio-system --set defaultRevision=default

  3. Validate the CRD installation with the helm ls command:

    1. $ helm ls -n istio-system
    2. NAME       NAMESPACE    REVISION UPDATED                                 STATUS   CHART        APP VERSION
    3. istio-base istio-system 1        2024-04-17 22:14:45.964722028 +0000 UTC deployed base-1.23.3  1.23.3

    In the output locate the entry for istio-base and make sure the status is set to deployed.

  4. If you intend to use Istio CNI chart you must do so now. See Install Istio with the CNI plugin for more info.

  5. Install the Istio discovery chart which deploys the istiod service:

    1. $ helm install istiod istio/istiod -n istio-system --wait

  6. Verify the Istio discovery chart installation:

    1. $ helm ls -n istio-system
    2. NAME       NAMESPACE    REVISION UPDATED                                 STATUS   CHART         APP VERSION
    3. istio-base istio-system 1        2024-04-17 22:14:45.964722028 +0000 UTC deployed base-1.23.3   1.23.3
    4. istiod     istio-system 1        2024-04-17 22:14:45.964722028 +0000 UTC deployed istiod-1.23.3 1.23.3

  7. Get the status of the installed helm chart to ensure it is deployed:

    1. $ helm status istiod -n istio-system
    2. NAME: istiod
    3. LAST DEPLOYED: Fri Jan 20 22:00:44 2023
    4. NAMESPACE: istio-system
    5. STATUS: deployed
    6. REVISION: 1
    7. TEST SUITE: None
    8. NOTES:
    9. "istiod" successfully installed!
    11. To learn more about the release, try:
    12.   $ helm status istiod
    13.   $ helm get all istiod
    15. Next steps:
    16.   * Deploy a Gateway: https://istio.io/latest/docs/setup/additional-setup/gateway/
    17.   * Try out our tasks to get started on common configurations:
    18.     * https://istio.io/latest/docs/tasks/traffic-management
    19.     * https://istio.io/latest/docs/tasks/security/
    20.     * https://istio.io/latest/docs/tasks/policy-enforcement/
    21.     * https://istio.io/latest/docs/tasks/policy-enforcement/
    22.   * Review the list of actively supported releases, CVE publications and our hardening guide:
    23.     * https://istio.io/latest/docs/releases/supported-releases/
    24.     * https://istio.io/latest/news/security/
    25.     * https://istio.io/latest/docs/ops/best-practices/security/
    27. For further documentation see https://istio.io website
    29. Tell us how your install/upgrade experience went at https://forms.gle/99uiMML96AmsXY5d6

  8. Check istiod service is successfully installed and its pods are running:

    1. $ kubectl get deployments -n istio-system --output wide
    2. NAME     READY   UP-TO-DATE   AVAILABLE   AGE   CONTAINERS   IMAGES                         SELECTOR
    3. istiod   1/1     1            1           10m   discovery    docker.io/istio/pilot:1.23.3   istio=pilot

  9. (Optional) Install an ingress gateway:

    1. $ kubectl create namespace istio-ingress
    2. $ helm install istio-ingress istio/gateway -n istio-ingress --wait

    See Installing Gateways for in-depth documentation on gateway installation.

    The namespace the gateway is deployed in must not have a istio-injection=disabled label. See Controlling the injection policy for more info.

See Advanced Helm Chart Customization for in-depth documentation on how to use Helm post-renderer to customize the Helm charts.

Updating your Istio configuration

You can provide override settings specific to any Istio Helm chart used above and follow the Helm upgrade workflow to customize your Istio mesh installation. The available configurable options can be found by using helm show values istio/<chart>; for example helm show values istio/gateway.

Migrating from non-Helm installations

If you’re migrating from a version of Istio installed using istioctl or Operator to Helm (Istio 1.5 or earlier), you need to delete your current Istio control plane resources and re-install Istio using Helm as described above. When deleting your current Istio installation, you must not remove the Istio Custom Resource Definitions (CRDs) as that can lead to loss of your custom Istio resources.

It is highly recommended to take a backup of your Istio resources using steps described above before deleting current Istio installation in your cluster.

You can follow steps mentioned in the Istioctl uninstall guide or Operator uninstall guide depending upon your installation method.

Uninstall

You can uninstall Istio and its components by uninstalling the charts installed above.

  1. List all the Istio charts installed in istio-system namespace:

    1. $ helm ls -n istio-system
    2. NAME       NAMESPACE    REVISION UPDATED                                 STATUS   CHART         APP VERSION
    3. istio-base istio-system 1        2024-04-17 22:14:45.964722028 +0000 UTC deployed base-1.23.3   1.23.3
    4. istiod     istio-system 1        2024-04-17 22:14:45.964722028 +0000 UTC deployed istiod-1.23.3 1.23.3

  2. (Optional) Delete any Istio gateway chart installations:

    1. $ helm delete istio-ingress -n istio-ingress
    2. $ kubectl delete namespace istio-ingress

  3. Delete Istio discovery chart:

    1. $ helm delete istiod -n istio-system

  4. Delete Istio base chart:

    By design, deleting a chart via Helm doesn’t delete the installed Custom Resource Definitions (CRDs) installed via the chart.

    1. $ helm delete istio-base -n istio-system

  5. Delete the istio-system namespace:

    1. $ kubectl delete namespace istio-system

Uninstall stable revision label resources

If you decide to continue using the old control plane, instead of completing the update, you can uninstall the newer revision and its tag by first issuing helm template istiod istio/istiod -s templates/revision-tags.yaml --set revisionTags={prod-canary} --set revision=canary -n istio-system | kubectl delete -f -. You must then uninstall the revision of Istio that it pointed to by following the uninstall procedure above.

If you installed the gateway(s) for this revision using in-place upgrades, you must also reinstall the gateway(s) for the previous revision manually. Removing the previous revision and its tags will not automatically revert the previously upgraded gateway(s).

(Optional) Deleting CRDs installed by Istio

Deleting CRDs permanently removes any Istio resources you have created in your cluster. To delete Istio CRDs installed in your cluster:

  1. $ kubectl get crd -oname | grep --color=never 'istio.io' | xargs kubectl delete