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:
Store the latest version number in a variable using the following command:
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.4.0
Download the release package for your operating system using the following command:
Create a directory on your system to serve as the base directory for the
Apigee hybrid installation.
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
Change directory to the base directory using the cd command.
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
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.
Create an environment variable to hold this home directory path using the following command:
export APIGEECTL_HOME=$PWD
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 also Upgrading Apigee hybrid.
Be sure you are in the base directory (the directory where the apigeectl directory
is located) by using the following command:
cd $APIGEECTL_HOME/..
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
The current directory structure now looks like the following:
Change directory into the hybrid-filesfolder using the following command:
cd hybrid-files
Inside the hybrid-files directory, create the following
subdirectories to organize files that you will create later:
mkdir overridesmkdir service-accountsmkdir certs
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:
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-26 UTC."],[[["\u003cp\u003eThis documentation refers to Apigee hybrid version 1.4, which is end-of-life, and users should upgrade to a newer version.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eapigeectl\u003c/code\u003e is the command-line interface for installing and managing Apigee hybrid in a Kubernetes cluster, and steps are provided to download and install it.\u003c/p\u003e\n"],["\u003cp\u003eInstructions are provided to create a base directory, and extract the contents of the downloaded \u003ccode\u003eapigeectl\u003c/code\u003e archive.\u003c/p\u003e\n"],["\u003cp\u003eA suggested project directory structure is described to separate Apigee hybrid software from configuration files, and using symbolic links for easy version switching.\u003c/p\u003e\n"],["\u003cp\u003eThe setup includes creating specific subdirectories like \u003ccode\u003eoverrides\u003c/code\u003e, \u003ccode\u003eservice-accounts\u003c/code\u003e, and \u003ccode\u003ecerts\u003c/code\u003e inside the \u003ccode\u003ehybrid-files\u003c/code\u003e directory, along with symbolic links to \u003ccode\u003eapigeectl\u003c/code\u003e home directory.\u003c/p\u003e\n"]]],[],null,["# Step 4: Install apigeectl\n\n| You are currently viewing version 1.4 of the Apigee hybrid documentation. **This version is end of life.** You should upgrade to a newer version. For more information, see [Supported versions](/apigee/docs/hybrid/supported-platforms#supported-versions).\n\nThis step explains how to download and install [apigeectl](/apigee/docs/hybrid/v1.4/cli-reference),\nset up the installation directories, and create Google Cloud service accounts, and TLS credentials\nthat are required for Apigee hybrid to operate.\n\nDownload and install `apigeectl`\n--------------------------------\n\n`apigeectl` is the command-line interface\n(CLI) for installing and managing Apigee hybrid in a Kubernetes cluster.\n\nThe following steps describe how to get `apigeectl`:\n\n1. Store the latest version number in a variable using the following command: \n\n ```\n export VERSION=$(curl -s \\\n https://storage.googleapis.com/apigee-release/hybrid/apigee-hybrid-setup/current-version.txt?ignoreCache=1)\n ```\n | **Note:** Some MacOS terminal shells may return an error from this command. If you see an error, try running it without `?ignoreCache=1`, as follows: \n |\n | ```\n | export VERSION=$(curl -s \\\n | https://storage.googleapis.com/apigee-release/hybrid/apigee-hybrid-setup/current-version.txt)\n | ```\n2. 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. \n\n ```\n echo $VERSION\n ``` \n\n ```\n 1.4.0\n ```\n3. Download the release package for your operating system using the following command:\n\n **Mac 64 bit:** \n\n ```\n curl -LO \\\n https://storage.googleapis.com/apigee-release/hybrid/apigee-hybrid-setup/$VERSION/apigeectl_mac_64.tar.gz\n ```\n\n **Linux 64 bit:** \n\n ```\n curl -LO \\\n https://storage.googleapis.com/apigee-release/hybrid/apigee-hybrid-setup/$VERSION/apigeectl_linux_64.tar.gz\n ```\n\n **Mac 32 bit:** \n\n ```\n curl -LO \\\n https://storage.googleapis.com/apigee-release/hybrid/apigee-hybrid-setup/$VERSION/apigeectl_mac_32.tar.gz\n ```\n\n **Linux 32 bit:** \n\n ```\n curl -LO \\\n https://storage.googleapis.com/apigee-release/hybrid/apigee-hybrid-setup/$VERSION/apigeectl_linux_32.tar.gz\n ```\n4. Create a directory on your system to serve as the **base directory** for the Apigee hybrid installation.\n5. Extract the downloaded gzip file contents into the base directory you just created using the\n following command:\n\n ```\n tar xvzf filename.tar.gz -C path-to-base-directory\n ```\n6. Change directory to the base directory using the `cd` command.\n7. The tar contents are, by default, expanded into a directory with the version and platform in\n its name. For example: `./apigeectl_1.4.0-d591b23_linux_64`. Rename that directory\n to `apigeectl` using the following command:\n\n ```\n mv apigeectl_1.4.0-d591b23_linux_64 apigeectl\n ```\n8. Change to the directory using the following command: \n\n cd ./apigeectl\n\n\n This directory is the `apigeectl` home directory. It is where the `apigeectl`\n executable command is located.\n9. Create an environment variable to hold this home directory path using the following command: \n\n ```\n export APIGEECTL_HOME=$PWD\n ```\n10. Verify that the variable holds the correct path using the following command: \n\n ```\n echo $APIGEECTL_HOME\n ```\n\nSet up the project directory structure\n--------------------------------------\n\n\nThe following directory structure is a suggested approach. It separates Apigee hybrid\nrelease software from configuration files that you must create. Through the use of the\n`$APIGEECTL_HOME` variable and symbolic links that you create, you can easily\nswitch to a new software version if you choose to. See also [Upgrading Apigee hybrid](/apigee/docs/hybrid/v1.4/upgrade).\n| **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.\n\n1. Be sure you are in the base directory (the directory where the `apigeectl` directory is located) by using the following command: \n\n ```\n cd $APIGEECTL_HOME/..\n ```\n2. 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. \n\n ```\n mkdir hybrid-files\n ```\n3. The current directory structure now looks like the following: \n\n pwd && ls\n /hybrid-base-directory\n apigeectl\n hybrid-files\n\n4. Change directory into the `hybrid-files`folder using the following command: \n\n ```\n cd hybrid-files\n ```\n5. Inside the `hybrid-files` directory, create the following subdirectories to organize files that you will create later: \n\n mkdir overrides\n mkdir service-accounts\n mkdir certs\n\n6. 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:\n | **Note:** If this is not the first time you have used this process, the following symbolic links\n | may already exist. Check to see if the links already exist using the\n | following command. If the directories exist, skip this step. \n |\n | ```\n | ls -l | grep ^l\n ``` \n\n ln -s `$APIGEECTL_HOME`/tools tools\n ln -s `$APIGEECTL_HOME`/config config\n ln -s `$APIGEECTL_HOME`/templates templates\n ln -s `$APIGEECTL_HOME`/plugins plugins\n\n7. To check that the symlinks were created correctly, execute the following command and make sure the link paths point to the correct locations: \n\n ```\n ls -l | grep ^l\n ```\n\n\nYou now have a home base from which you can configure, deploy, and manage Apigee hybrid\nin your Kubernetes cluster. Next, you will create the Google Cloud service accounts and credentials\nrequired to configure hybrid runtime components.\n[1](/apigee/docs/hybrid/v1.4/2-1-install-create-cluster) [2](/apigee/docs/hybrid/v1.4/2-2-install-cert-manager) [3](/apigee/docs/hybrid/v1.4/2-3-install-asm) [4](/apigee/docs/hybrid/v1.4/2-4-install-apigeectl) [(NEXT) Step 5: Set up service accounts](/apigee/docs/hybrid/v1.4/2-5-install-service-accounts) [6](/apigee/docs/hybrid/v1.4/2-6-install-configure-cluster) [7](/apigee/docs/hybrid/v1.4/2-7-install-hybrid-runtime)\n\n\u003cbr /\u003e"]]
