Step 3: Install apigeectl

You are currently viewing version 1.11 of the Apigee hybrid documentation.This version is end of life. You should upgrade to a newer version. For more information, seeSupported versions.

This step explains how to download and installapigeectl.

Download and installapigeectl

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

The following steps describe how to download and installapigeectl:

Linux

  1. Store the latest version number in a variable using the following command:
    export VERSION=$(curl -s \    "https://storage.googleapis.com/apigee-release/hybrid/apigee-hybrid-setup/current-version.txt?ignoreCache=1")
  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
      1.11.2

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

    curl -LO \    https://storage.googleapis.com/apigee-release/hybrid/apigee-hybrid-setup/$VERSION/apigeectl_linux_64.tar.gz
  4. Create a directory on your system to serve as thebase directory for the Apigee hybrid installation.

  5. Extract the downloaded gzip file (tar.gz) contents into the base directory you just created using the following command:

    tar xvzffilename -Cpath-to-base-directory
  6. Change directory to the base directory using thecd command.

  7. The tar contents are, by default, expanded into a directory with the version and platform in its name. For example:./apigeectl_1.11.2-d591b23_linux_64. Rename that directory toapigeectl using the following command:

    mvapigeectl_1.11.2-d591b23_linux_64/ apigeectl
  8. Change to the directory using the following command:
    cd ./apigeectl

    This directory is theapigeectl home directory. It is where theapigeectl executable command is located.

  9. Verify the version ofapigeectl with theversion command:
    ./apigeectl version
    Version:1.11.2
  10. Create an environment variable to hold this home directory path using the following command:
    export APIGEECTL_HOME=$PWD
  11. Verify that the variable holds the correct path using the following command:
    echo $APIGEECTL_HOME

Mac OS

  1. Store the latest version number in a variable using the following command:
    export VERSION=$(curl -s \    "https://storage.googleapis.com/apigee-release/hybrid/apigee-hybrid-setup/current-version.txt?ignoreCache=1")
  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
      1.11.2

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

    curl -LO \    https://storage.googleapis.com/apigee-release/hybrid/apigee-hybrid-setup/$VERSION/apigeectl_mac_64.tar.gz
  4. Create a directory on your system to serve as thebase 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 xvzffilename.tar.gz -Cpath-to-base-directory
  6. Change directory to the base directory using thecd command.

  7. The tar contents are, by default, expanded into a directory with the version and platform in its name. For example:./apigeectl_1.11.2-d591b23_mac_64. Rename that directory toapigeectl using the following command:

    mvapigeectl_1.11.2-d591b23_mac_64 apigeectl
  8. Change to the directory using the following command:
    cd ./apigeectl

    This directory is theapigeectl home directory. It is where theapigeectl executable command is located.

  9. Verify the version ofapigeectl with theversion command:
    ./apigeectl version
    Version:1.11.2
  10. Create an environment variable to hold this home directory path using the following command:
    export APIGEECTL_HOME=$PWD
  11. Verify that the variable holds the correct path using the following command:
    echo $APIGEECTL_HOME

Windows

  1. Store the latest version number in a variable using the following command:
    for /f "tokens=*" %a in ('curl -s ^  https://storage.googleapis.com/apigee-release/hybrid/apigee-hybrid-setup/current-version.txt') ^do set VERSION=%a
  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%
      1.11.2

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

    curl -LO ^  https://storage.googleapis.com/apigee-release/hybrid/apigee-hybrid-setup/%VERSION%/apigeectl_windows_64.zip
  4. Create a directory on your system to serve as thebase directory for the Apigee hybrid installation.

  5. Extract the downloaded .zip file contents into the current directory using the following command:

    tar xvzffilename.zip -Cpath-to-base-directory
  6. Change directory to the base directory using thecd command.

  7. The tar file contents are, by default, expanded into a directory with the version and platform in its name. For example:.\apigeectl_1.11.2-d591b23_windows_64. Rename that directory toapigeectl using the following command:

    renameapigeectl_1.11.2-d591b23_windows_64 apigeectl
  8. Change to the directory using the following command:
    cd .\apigeectl

    This directory is theapigeectl home directory. It is where theapigeectl executable command is located.

  9. Verify the version ofapigeectl with theversion command:
    ./apigeectl version
    Version:1.11.2
  10. Create an environment variable to hold this home directory path using the following command:
    set APIGEECTL_HOME=%CD%
  11. Verify that the variable holds the correct path using the following command:
    echo %APIGEECTL_HOME%

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 alsoUpgrading Apigee hybrid.

Note: For the purpose of this quickstart, subsequent installation steps assume that you created the project structure as described in this section. If you follow this suggested structure, you can copy and paste most installation commands directly into your terminal.

Linux

  1. Be sure you are in the base directory (the directory where theapigeectl directory is located) by using the following command:
    cd $APIGEECTL_HOME/..
  2. Create a new folder calledhybrid-files using the following command. You can give the directory any name you wish, but in the docs, the namehybrid-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 theapigeectl software installation.
    mkdir hybrid-files
  3. The current directory structure now looks like the following:
    pwd && ls
    /hybrid-base-directory  apigeectl  hybrid-files
  4. Change directory into thehybrid-files folder using the following command:
  5.     Create an environment variable to hold the path to yourhybrid-files directory:
    export HYBRID_FILES=$PWD
    echo $HYBRID_FILES
  6.     Inside thehybrid-files directory, create the following    subdirectories to organize files that you will create later:
    mkdir overridesmkdir certs
  7.     Inside thehybrid-files directory, create the following symbolic links to$APIGEECTL_HOME. These links allow you to run theapigeectl command from inside thehybrid-files directory as the following example shows:
    Note: If this is not the first time you have used this process, the following symbolic links    may already exist. Check to see if the links already exist using the    following command. If the directories exist, skip this step.
    ls -l | grep ^l
    ln -s$APIGEECTL_HOME/tools toolsln -s$APIGEECTL_HOME/config configln -s$APIGEECTL_HOME/templates templatesln -s$APIGEECTL_HOME/plugins plugins
  8.     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
      Mac OS
  1.     Be sure you are in the base directory (the directory where theapigeectl directory    is located) by using the following command:
    cd $APIGEECTL_HOME/..
  2.     Create a new folder calledhybrid-files using the following command. You can give    the directory any name you wish, but in the docs, the namehybrid-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 theapigeectl software installation.
    mkdir hybrid-files
  3.     The current directory structure now looks like the following:
    pwd && ls
    /hybrid-base-directory  apigeectl  hybrid-files
  4.     Change directory into thehybrid-filesfolder using the following command:
    cd hybrid-files
  5.     Create an environment variable to hold the path to yourhybrid-files directory:
    export HYBRID_FILES=$PWD
    echo $HYBRID_FILES
  6.     Inside thehybrid-files directory, create the following    subdirectories to organize files that you will create later:
    mkdir overridesmkdir certs
  7.     Inside thehybrid-files directory, create the following symbolic links to$APIGEECTL_HOME. These links allow you to run theapigeectl command from inside thehybrid-files directory as the following example shows:
    Note: If this is not the first time you have used this process, the following symbolic links    may already exist. Check to see if the links already exist using the    following command. If the directories exist, skip this step.
    ls -l | grep ^l
    ln -s$APIGEECTL_HOME/tools toolsln -s$APIGEECTL_HOME/config configln -s$APIGEECTL_HOME/templates templatesln -s$APIGEECTL_HOME/plugins plugins
  8.     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
      Windows
  1.     Be sure you are in the base directory (the directory where theapigeectl directory    is located) by using the following command:
    cd %APIGEECTL_HOME%\..
  2.     Create a new folder calledhybrid-files using the following command. You can give    the directory any name you wish, but in the docs, the namehybrid-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 theapigeectl software installation.
    mkdir hybrid-files
  3.     The current directory structure now looks like the following:
    dir
     Directory of C:\Users\example\hybrid08/05/2021  01:38 PM    <DIR>          .08/05/2021  01:38 PM    <DIR>          ..08/02/2021  01:11 PM    <DIR>          apigeectl08/02/2021  11:13 AM         5,803,963 apigeectl_1.11.2rc1-437dccc_windows_64.zip08/05/2021  01:38 PM    <DIR>          hybrid-files
  4.     Change directory into thehybrid-filesfolder.
  5.     Create an environment variable to hold the path to yourhybrid-files directory:
    set HYBRID_FILES=%CD%
    echo %HYBRID_FILES%
  6.     Inside thehybrid-files directory, create the following    subdirectories to organize files that you will create later:
    mkdir overridesmkdir certs
  7.     Inside thehybrid-files directory, create the following symbolic links to$APIGEECTL_HOME. These links allow you to run theapigeectl command from inside thehybrid-files directory as the following example shows:Note: You will need administrator privilege on your Windows computer to run themklink command. You can achieve this by running your command terminal as    administrator or by using therunas command. For example:
    runas /noprofile /user:mymachine\administrator "mklink /d config %APIGEECTL_HOME%\config"
    mklink /d config %APIGEECTL_HOME%\config\mklink /d plugins %APIGEECTL_HOME%\plugins\mklink /d templates %APIGEECTL_HOME%\templates\mklink /d tools %APIGEECTL_HOME%\tools\
  8.     To check that the symlinks were created correctly, usedir:
    dir
    DirectoryofC:\Users\example\hybrid\hybrid-files08/05/202101:56PM<DIR>.08/05/202101:56PM<DIR>..08/05/202101:46PM<DIR>certs08/05/202101:55PM<SYMLINKD>config[C:\Users\example\hybrid\apigeectl\config\]08/05/202101:46PM<DIR>overrides08/05/202101:56PM<SYMLINKD>plugins[C:\Users\example\hybrid\apigeectl\plugins\]08/05/202101:56PM<SYMLINKD>templates[C:\Users\example\hybrid\apigeectl\templates\]08/05/202101:56PM<SYMLINKD>tools[C:\Users\example\hybrid\apigeectl\tools\]
  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.
123(NEXT) Step 4: Set up service accounts5678910
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-02-18 UTC.