This step explains how to download and install apigeectl.
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 download and install apigeectl
:
Linux
-
Download the release package for your operating system using the following command:
curl -LO \ https://storage.googleapis.com/apigee-release/hybrid/apigee-hybrid-setup/1.10.5/apigeectl_linux_64.tar.gz
- 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.10.5-d591b23_linux_64
. Rename that directory toapigeectl
using the following command:mv apigeectl_1.10.5-d591b23_linux_64/ apigeectl
-
Change to the directory using the following command:
cd ./apigeectl
This directory is the
apigeectl
home directory. It is where theapigeectl
executable command is located. - Verify the version of
apigeectl
with theversion
command:./apigeectl version
Version: 1.10.5
-
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
Mac OS
-
Download the release package for your operating system using the following command:
curl -LO \ https://storage.googleapis.com/apigee-release/hybrid/apigee-hybrid-setup/1.10.5/apigeectl_mac_64.tar.gz
- 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.10.5-d591b23_mac_64
. Rename that directory toapigeectl
using the following command:mv apigeectl_1.10.5-d591b23_mac_64 apigeectl
-
Change to the directory using the following command:
cd ./apigeectl
This directory is the
apigeectl
home directory. It is where theapigeectl
executable command is located. - Verify the version of
apigeectl
with theversion
command:./apigeectl version
Version: 1.10.5
-
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
Windows
-
Download the release package for your operating system using the following command:
curl -LO ^ https://storage.googleapis.com/apigee-release/hybrid/apigee-hybrid-setup/1.10.5/apigeectl_windows_64.zip
- Create a directory on your system to serve as the base directory for the Apigee hybrid installation.
-
Extract the downloaded .zip file contents into the current directory using the following command:
tar xvzf filename.zip -C path-to-base-directory
-
Change directory to the base directory using the
cd
command. -
The tar file contents are, by default, expanded into a directory with the version and platform in its name. For example:
.\apigeectl_1.10.5-d591b23_windows_64
. Rename that directory toapigeectl
using the following command:rename apigeectl_1.10.5-d591b23_windows_64 apigeectl
-
Change to the directory using the following command:
cd .\apigeectl
This directory is the
apigeectl
home directory. It is where theapigeectl
executable command is located. - Verify the version of
apigeectl
with theversion
command:./apigeectl version
Version: 1.10.5
-
Create an environment variable to hold this home directory path using the following command:
set APIGEECTL_HOME=%CD%
-
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.
Linux
-
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 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
-
The current directory structure now looks like the following:
pwd && ls
/hybrid-base-directory apigeectl hybrid-files
-
Change directory into the
hybrid-files
folder using the following command:cd hybrid-files
-
Create an environment variable to hold the path to your
hybrid-files
directory:export HYBRID_FILES=$PWD
echo $HYBRID_FILES
-
Inside the
hybrid-files
directory, create the following subdirectories to organize files that you will create later:mkdir overrides
mkdir certs
-
Inside the
hybrid-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:ln -s
$APIGEECTL_HOME
/tools toolsln -s
$APIGEECTL_HOME
/config configln -s
$APIGEECTL_HOME
/templates templatesln -s
$APIGEECTL_HOME
/plugins plugins -
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
-
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 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
-
The current directory structure now looks like the following:
pwd && ls
/hybrid-base-directory apigeectl hybrid-files
-
Change directory into the
hybrid-files
folder using the following command:cd hybrid-files
-
Create an environment variable to hold the path to your
hybrid-files
directory:export HYBRID_FILES=$PWD
echo $HYBRID_FILES
-
Inside the
hybrid-files
directory, create the following subdirectories to organize files that you will create later:mkdir overrides
mkdir certs
-
Inside the
hybrid-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:ln -s
$APIGEECTL_HOME
/tools toolsln -s
$APIGEECTL_HOME
/config configln -s
$APIGEECTL_HOME
/templates templatesln -s
$APIGEECTL_HOME
/plugins plugins -
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
-
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 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
-
The current directory structure now looks like the following:
dir
Directory of C:\Users\example\hybrid 08/05/2021 01:38 PM <DIR> . 08/05/2021 01:38 PM <DIR> .. 08/02/2021 01:11 PM <DIR> apigeectl 08/02/2021 11:13 AM 5,803,963 apigeectl_1.10.5rc1-437dccc_windows_64.zip 08/05/2021 01:38 PM <DIR> hybrid-files
-
Change directory into the
hybrid-files
folder. -
Create an environment variable to hold the path to your
hybrid-files
directory:set HYBRID_FILES=%CD%
echo %HYBRID_FILES%
-
Inside the
hybrid-files
directory, create the following subdirectories to organize files that you will create later:mkdir overrides
mkdir certs
-
Inside the
hybrid-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:mklink /d config %APIGEECTL_HOME%\config\
mklink /d plugins %APIGEECTL_HOME%\plugins\
mklink /d templates %APIGEECTL_HOME%\templates\
mklink /d tools %APIGEECTL_HOME%\tools\
-
To check that the symlinks were created correctly, use
dir
:dir
Directory of C:\Users\example\hybrid\hybrid-files 08/05/2021 01:56 PM <DIR> . 08/05/2021 01:56 PM <DIR> .. 08/05/2021 01:46 PM <DIR> certs 08/05/2021 01:55 PM <SYMLINKD> config [C:\Users\example\hybrid\apigeectl\config\] 08/05/2021 01:46 PM <DIR> overrides 08/05/2021 01:56 PM <SYMLINKD> plugins [C:\Users\example\hybrid\apigeectl\plugins\] 08/05/2021 01:56 PM <SYMLINKD> templates [C:\Users\example\hybrid\apigeectl\templates\] 08/05/2021 01:56 PM <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.
1 2 3 (NEXT) Step 4: Set up service accounts 5 6 7 8 9 10 11