Step 4: Install apigeectl

Stay organized with collections Save and categorize content based on your preferences.

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. Store the latest version number in a variable using the following command:
    export VERSION=$(curl -s \
  2. Check that the variable was populated with a version number using the following command. If you want to use a different version, you can save that in an environment variable instead.
    echo $VERSION
  3. Download the release package for your operating system using the following command:

    Mac 64 bit:

    curl -LO \$VERSION/apigeectl_mac_64.tar.gz

    Linux 64 bit:

    curl -LO \$VERSION/apigeectl_linux_64.tar.gz

    Mac 32 bit:

    curl -LO \$VERSION/apigeectl_mac_32.tar.gz

    Linux 32 bit:

    curl -LO \$VERSION/apigeectl_linux_32.tar.gz
  4. Create a directory on your system to serve as the base directory for the Apigee hybrid installation.
  5. Extract the downloaded gzip file contents into the base directory you just created using the following command:

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

    mv apigeectl_1.4.0-d591b23_linux_64 apigeectl
  8. Change to the directory using the following command:
    cd ./apigeectl

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

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

Set up the project directory structure

The following directory structure 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) by using the following command:
  2. Create a new folder called hybrid-files using the following command. 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:
    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 as the following example shows:
    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

You now have a home base from which you can configure, deploy, and manage Apigee hybrid in your Kubernetes cluster. Next, you will create the Google Cloud service accounts and credentials required to configure hybrid runtime components.

Next step

1 2 3 4 (NEXT) Step 5: Set up service accounts 6 7