Step 11: Install Apigee hybrid Using Helm

Install the Apigee hybrid runtime components

In this step, you will use Helm to install the following Apigee hybrid components:

  • Apigee operator
  • Apigee datastore
  • Apigee telemetry
  • Apigee Redis
  • Apigee ingress manager
  • Apigee organization
  • Your Apigee environment(s)

You will install the charts for each environment one at a time. The sequence in which you install the components matters.

Pre-installation Notes

  1. If you have not already installed Helm v3.14.2+, follow the instructions in Installing Helm.

  2. Apigee hybrid uses Helm guardrails to verify the configuration before installing or upgrading a chart. You may see guardrail-specific information in the output of each of the commands in this section, for example: 

    # Source: apigee-operator/templates/apigee-operators-guardrails.yaml apiVersion: v1 kind: Pod metadata: name: apigee-hybrid-helm-guardrail-operator namespace: apigee-system annotations: helm.sh/hook: pre-install,pre-upgrade helm.sh/hook-delete-policy: before-hook-creation,hook-succeeded labels: app: apigee-hybrid-helm-guardrail

    If any of the helm upgrade commands fail, you can use the guardrails output to help diagnose the cause. See Diagnosing issues with guardrails.

  3. Before executing any of the Helm upgrade/install commands, use the Helm dry-run feature by adding --dry-run at the end of the command. See helm install --h to list supported commands, options, and usage.
  4. If you are installing the charts on a cluster you have migrated from apigeectl management to Helm management with the Apigee Helm migration tool, omit the --atomic flag from all of the following commands.

Installation steps

  1. Verify that you have a suitable version of helm.

    helm version

    The version of helm required for this installation is v3.14.2+. If the version shown is not satisfactory, upgrade helm by running the commands below. The get_helm.sh script will fetch the latest version and install it.

    curl -fsSL -o get_helm.sh https://raw.githubusercontent.com/helm/helm/main/scripts/get-helm-3 chmod 700 get_helm.sh ./get_helm.sh

    Afterwards, re-check the version of helm.

    helm version
  2. Navigate into your APIGEE_HELM_CHARTS_HOME directory. Run the following commands from that directory.
  3. Install Apigee Operator/Controller:

    Dry run:

     helm upgrade operator apigee-operator/ \ --install \ --create-namespace \ --namespace apigee-system \ --atomic \ -f overrides.yaml \ --dry-run

    Install the chart:

     helm upgrade operator apigee-operator/ \ --install \ --create-namespace \ --namespace apigee-system \ --atomic \ -f overrides.yaml

    Verify Apigee Operator installation:

     helm ls -n apigee-system 
     NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION operator apigee-system 3 2023-06-26 00:42:44.492009 -0800 PST deployed apigee-operator-1.12.4 1.12.4

    Verify it is up and running by checking its availability:

     kubectl -n apigee-system get deploy apigee-controller-manager 
     NAME READY UP-TO-DATE AVAILABLE AGE apigee-controller-manager 1/1 1 1 7d20h

  4. Install Apigee datastore:

    Dry run:

     helm upgrade datastore apigee-datastore/ \ --install \ --namespace apigee \ --atomic \ -f overrides.yaml \ --dry-run

    Install the chart:

     helm upgrade datastore apigee-datastore/ \ --install \ --namespace apigee \ --atomic \ -f overrides.yaml

    Verify apigeedatastore is up and running by checking its state before proceeding to the next step:

     kubectl -n apigee get apigeedatastore default 
     NAME STATE AGE default running 2d

  5. Install Apigee telemetry:

    Dry run:

     helm upgrade telemetry apigee-telemetry/ \ --install \ --namespace apigee \ --atomic \ -f overrides.yaml \ --dry-run

    Install the chart:

     helm upgrade telemetry apigee-telemetry/ \ --install \ --namespace apigee \ --atomic \ -f overrides.yaml

    Verify it is up and running by checking its state:

     kubectl -n apigee get apigeetelemetry apigee-telemetry 
     NAME STATE AGE apigee-telemetry running 2d

  6. Install Apigee Redis:

    Dry run:

     helm upgrade redis apigee-redis/ \ --install \ --namespace apigee \ --atomic \ -f overrides.yaml \ --dry-run

    Install the chart:

     helm upgrade redis apigee-redis/ \ --install \ --namespace apigee \ --atomic \ -f overrides.yaml

    Verify it is up and running by checking its state:

     kubectl -n apigee get apigeeredis default 
     NAME STATE AGE default running 2d

  7. Install Apigee ingress manager:

    Dry run:

     helm upgrade ingress-manager apigee-ingress-manager/ \ --install \ --namespace apigee \ --atomic \ -f overrides.yaml \ --dry-run

    Install the chart:

     helm upgrade ingress-manager apigee-ingress-manager/ \ --install \ --namespace apigee \ --atomic \ -f overrides.yaml

    Verify it is up and running by checking its availability:

     kubectl -n apigee get deployment apigee-ingressgateway-manager 
     NAME READY UP-TO-DATE AVAILABLE AGE apigee-ingressgateway-manager 2/2 2 2 2d

  8. Install Apigee organization. If you have set the $ORG_NAME environment variable in your shell, you can use that in the following commands:

    Dry run:

     helm upgrade $ORG_NAME apigee-org/ \ --install \ --namespace apigee \ --atomic \ -f overrides.yaml \ --dry-run

    Install the chart:

     helm upgrade $ORG_NAME apigee-org/ \ --install \ --namespace apigee \ --atomic \ -f overrides.yaml

    Verify it is up and running by checking the state of the respective org:

     kubectl -n apigee get apigeeorg 
     NAME STATE AGE apigee-org1-xxxxx running 2d

  9. Install the environment.

    You must install one environment at a time. Specify the environment with --set env=ENV_NAME. If you have set the $ENV_NAME environment variable in your shell, you can use that in the following commands:

    Dry run:

     helm upgrade ENV_RELEASE_NAME apigee-env/ \ --install \ --namespace apigee \ --atomic \ --set env=$ENV_NAME \ -f overrides.yaml \ --dry-run

      ENV_RELEASE_NAME is a name used to keep track of installation and upgrades of the apigee-env chart. This name must be unique from the other Helm release names in your installation. Usually this is the same as ENV_NAME. However, if your environment has the same name as your environment group, you must use different release names for the environment and environment group, for example dev-env-release and dev-envgroup-release. For more information on releases in Helm, see Three big concepts in the Helm documentation.

    Install the chart:

     helm upgrade ENV_RELEASE_NAME apigee-env/ \ --install \ --namespace apigee \ --atomic \ --set env=$ENV_NAME \ -f overrides.yaml

    Verify it is up and running by checking the state of the respective env:

     kubectl -n apigee get apigeeenv 
     NAME STATE AGE GATEWAYTYPE apigee-org1-dev-xxx running 2d
  10. Install the environment groups (virtualhosts).
    1. You must install one environment group (virtualhost) at a time. Specify the environment group with --set envgroup=ENV_GROUP. If you have set the $ENV_GROUP environment variable in your shell, you can use that in the following commands. Repeat the following commands for each env group mentioned in your overrides.yaml file:

      Dry run:

       helm upgrade $ENV_GROUP_RELEASE_NAME apigee-virtualhost/ \ --install \ --namespace apigee \ --atomic \ --set envgroup=$ENV_GROUP \ -f overrides.yaml \ --dry-run

        ENV_GROUP_RELEASE_NAME is a name used to keep track of installation and upgrades of the apigee-virtualhosts chart. This name must be unique from the other Helm release names in your installation. Usually this is the same as ENV_GROUP. However, if your environment group has the same name as an environment in your installation, you must use different release names for the environment group and environment, for example dev-envgroup-release and dev-env-release. For more information on releases in Helm, see Three big concepts in the Helm documentation.

      Install the chart:

       helm upgrade $ENV_GROUP_RELEASE_NAME apigee-virtualhost/ \ --install \ --namespace apigee \ --atomic \ --set envgroup=$ENV_GROUP \ -f overrides.yaml
    2. Check the state of the ApigeeRoute (AR).

      Installing the virtualhosts creates ApigeeRouteConfig (ARC) which internally creates ApigeeRoute (AR) once the Apigee watcher pulls env group related details from the control plane. Therefore, check that the corresponding AR's state is running: 

       kubectl -n apigee get arc 
       NAME STATE AGE apigee-org1-dev-egroup 2d 
       kubectl -n apigee get ar 
       NAME STATE AGE apigee-org1-dev-egroup-xxxxxx running 2d

Next step

Installations using Workload Identity

If you are installing Apigee hybrid on GKE and you are configuring Workload Identity to authenticate service accounts, in the next step, you will configure the associations between the Kubernetes service accounts and the Google service accounts for your cluster.

1 2 3 4 5 6 7 8 9 10 11 (NEXT) Step 12: Set up Workload Identity

All other installations

In the next step, you will configure the Apigee ingress gateway and deploy a proxy to test your installation.

(NEXT) Step 1: Expose Apigee ingress 2