NOTE: Some aspects of this product are in Beta. The hybrid installation options are GA. To join the Beta program, reach out to your Apigee representative.

Step 2: Install and set up for GKE

This step explains how to download and install apigeectl, set up the installation directories, and create Google Cloud service accounts, and TLS credentials that are required for Apigee hybrid to operate.

Download and install apigeectl

apigeectl is the command-line interface (CLI) for installing and managing Apigee hybrid in a Kubernetes cluster.

The following steps describe how to get apigeectl:

  1. Download the release package for your operating system using the following command:

    Mac 64 bit:

    curl -LO \

    Linux 64 bit:

    curl -LO \

    Mac 32 bit:

    curl -LO \

    Linux 32 bit:

    curl -LO \
  2. Create a directory on your system to serve as the base directory for the Apigee hybrid installation.
  3. Extract the downloaded gzip file contents into the base directory you just created. For example:

    tar xvzf filename.tar.gz -C path-to-base-directory
  4. Change directory to the base directory.
  5. The tar contents are, by default, expanded into a directory with the version and platform in its name. For example: ./apigeectl_1.0.0-f7b96a8_linux_64. Rename that directory to apigeectl using the following command:

    mv apigeectl_1.0.0-f7b96a8_linux_64 apigeectl
  6. Change directory into the directory. For example:
    cd ./apigeectl

    This directory is the apigeectl home directory. It is where the apigeectl executable command is located.

  7. Create an environment variable to hold this home directory path using the following command:
  8. Verify that the variable holds the correct path using the following command:

Set up the project directory structure

The directory structure described below is a suggested approach. It separates Apigee hybrid release software from configuration files that you must create. Through the use of the $APIGEECTL_HOME variable and symbolic links that you create, you can easily switch to a new software version if you choose to. See also Upgrading Apigee hybrid.

  1. Be sure you are in the base directory (the directory where the apigeectl directory is located).
  2. Create a new folder called hybrid-files. You can give the directory any name you wish, but in the docs, the name hybrid-files is used consistently. Later, you will store configuration files, service account keys, and TLS certificates in this folder. This folder lets you keep your config files separate from the apigeectl software installation:
    mkdir hybrid-files
  3. The current directory structure now looks like the following:
    pwd && ls
  4. Change directory into the hybrid-filesfolder using the following command:
    cd hybrid-files
  5. Inside the hybrid-files directory, create the following subdirectories to organize files that you will create later using the following commands:
    mkdir overrides
    mkdir service-accounts
    mkdir certs
  6. Inside the hybrid-files directory, create the following symbolic links to $APIGEECTL_HOME. These links allow you to run the apigeectl command from inside the hybrid-files directory.
    ln -s $APIGEECTL_HOME/tools tools
    ln -s $APIGEECTL_HOME/config config
    ln -s $APIGEECTL_HOME/templates templates
    ln -s $APIGEECTL_HOME/plugins plugins
  7. To check that the symlinks were created correctly, execute the following command and make sure the link paths point to the correct locations:
    ls -l | grep ^l

Create service accounts

Apigee hybrid uses Google Cloud service accounts to allow hybrid components to communicate by making authorized API calls. In this step, you use an Apigee hybrid command-line tool to create a set of services accounts. The tool also downloads the service account private keys for you. You must then add these keys to your Apigee hybrid cluster configuration file.

Create the keys:

  1. Be sure that you are in the base_directory/hybrid-files directory.
  2. Execute the following command from inside hybrid-files directory. This command creates a service account for the apigee-metrics component and places the downloaded key in the ./service-accounts directory.
    ./tools/create-service-account apigee-metrics ./service-accounts

    When you see the following prompt, enter y:

    [INFO]: gcloud configured project ID is project_id.
     Press: y to proceed with creating service account in project: project_id
     Press: n to abort.

    If this is the first time an SA with the exact name assigned by the tool was created, then the tool just creates it, and you do not have to do anything further.

    If, however, you see the following message and prompt, enter y to generate new keys:

    [INFO]: Service account already exists.
     [INFO]: The service account might have keys associated with it. It is recommended to use existing keys.
     Press: y to generate new keys.(this does not de-activate existing keys)
     Press: n to skip generating new keys.
  3. Now, create the rest of the service accounts using the following commands:
    ./tools/create-service-account apigee-synchronizer ./service-accounts
    ./tools/create-service-account apigee-udca ./service-accounts
    ./tools/create-service-account apigee-mart ./service-accounts
    ./tools/create-service-account apigee-cassandra ./service-accounts
    ./tools/create-service-account apigee-logger ./service-accounts
  4. Verify that the service account keys were created. You are responsible for storing these private keys securely. The key filenames are prefixed with the name of your Google Cloud project. For example:
    ls ./service-accounts

Create TLS certificates

You are required to provide TLS certificates for the MART and runtime ingress gateways in your Apigee hybrid configuration. The credentials used for the MART gateway must be authorized by a certificate authority (CA). For the purpose of this quickstart (a non-production trial installation), the runtime gateway can accept self-signed credentials.

In this step, you will create the TLS credential files and add them to the base_directory/hybrid-files/certs directory. In Step 3: Configure the cluster, you will add the file paths to the cluster configuration file.

Create TLS credentials for the runtime gateway

The runtime ingress gateway (the gateway that handles API proxy traffic) requires a TLS certificate/key pair. For this quickstart installation, you can use self-signed credentials. In the following steps, openssl is used to generate the credentials.

  1. Be sure that you are in the base_directory/hybrid-files directory.
  2. Execute the following command from inside the hybrid-files directory using the following command:
    openssl req  -nodes -new -x509 -keyout ./certs/keystore.key -out \
        ./certs/keystore.pem -subj '/' -days 3650

    This command creates a self-signed certificate/key pair that you can use for the quickstart installation. The CN can be any value you wish for the self-signed credentials.

  3. Check to make sure the files are in the ./certs directory using the following command:
    ls ./certs

    Where keystore.pem is the self-signed TLS certificate file and keystore.key is the key file.

Create TLS credentials for the MART gateway

As noted in Before you begin, you must use an authorized TLS certificate/key pair for the MART gateway configuration. If you have not done so, obtain or create these credentials now.

  1. Obtain or create an TLS certificate/key pair that is authorized by a certificate authority. An example is provided showing how to obtain these credentials using the Let's Encrypt CA. Note that the certificate's common name (CN) must be a valid DNS name. For the example steps, see Obtain TLS credentials: An example.
  2. Copy the credentials into the base_directory/hybrid-files/certs directory.
  3. When you are finished, you should have two pairs of credential files in the ./certs directory. For example:
    ls ./certs

    Where fullchain.pem is the authorized TLS certificate file and privkey.key is the authorized key file.


You now have a home base from which you can configure, deploy, and manage Apigee hybrid in your Kubernetes cluster. Next, you will create a file that will be used by Kubernetes to deploy the hybrid runtime components to the cluster.

Next step

1 2 (NEXT) Step 3: Configure the cluster 4