Esta etapa explica como fazer o download e instalar o apigeectl,
configurar os diretórios de instalação e criar contas de serviço do GCP e credenciais TLS
necessárias para o Apigee híbrido operar.
Fazer o download e instalar apigeectl
apigeectl é a interface de linha de comando
(CLI, na sigla em inglês) para instalar e gerenciar o Apigee Hybrid em um cluster do Kubernetes.
As etapas a seguir descrevem como conseguir apigeectl:
Armazene o número da versão mais recente em uma variável usando o seguinte comando:
Verifique se a variável foi preenchida com um número de versão usando o seguinte comando: Se
você quiser usar uma versão diferente, salve-a em uma variável de ambiente.
echo $VERSION
1.4.0
Faça o download do pacote de lançamento do seu sistema operacional usando o seguinte comando:
Crie um diretório no seu sistema para servir como o diretório base para a
instalação do Apigee Hybrid.
Extraia o conteúdo do arquivo gzip salvo para o diretório base que você acabou de criar usando o
seguinte comando:
tar xvzf filename.tar.gz -C path-to-base-directory
Altere o diretório para o diretório base usando o comando cd.
O conteúdo de tar é, por padrão, expandido em um diretório com a versão e a plataforma no
nome. Por exemplo, ./apigeectl_1.4.0-d591b23_linux_64. Renomeie esse diretório
para apigeectl usando o seguinte comando:
mv apigeectl_1.4.0-d591b23_linux_64 apigeectl
Mude para o diretório usando o seguinte comando:
cd ./apigeectl
Esse diretório é o diretório inicial apigeectl. É lá que o comando executável
apigeectl está localizado.
Crie uma variável de ambiente para manter esse caminho do diretório inicial usando o seguinte comando:
export APIGEECTL_HOME=$PWD
Verifique se a variável contém o caminho correto usando o seguinte comando:
echo $APIGEECTL_HOME
Configurar a estrutura de diretórios do projeto
A estrutura de diretório a seguir é uma abordagem sugerida. Ele separa o software de lançamento
do Apigee Hybrid dos arquivos de configuração que você precisa criar. Com o uso da
variável $APIGEECTL_HOME e dos links simbólicos criados por você, você pode alternar
facilmente para uma nova versão do software. Consulte também Como fazer upgrade do Apigee Hybrid.
Verifique se você está no diretório base (o diretório onde o diretório apigeectl
está localizado) usando o seguinte comando:
cd $APIGEECTL_HOME/..
Crie uma nova pasta chamada hybrid-files usando o seguinte comando. É possível
nomear o diretório como quiser, mas, nos documentos, o nome hybrid-files é usado
de maneira consistente. Posteriormente, você armazenará arquivos de configuração, chaves de conta de
serviço e certificados TLS nessa pasta. Essa pasta permite que você mantenha seus arquivos de configuração separados da
instalação de software apigeectl:
Altere o diretório na pasta hybrid-files usando o seguinte comando:
cd hybrid-files
Dentro do diretório hybrid-files, crie os seguintes
subdiretórios para organizar os arquivos que você criará posteriormente:
mkdir overridesmkdir service-accountsmkdir certs
Dentro do diretório hybrid-files, crie os seguintes links simbólicos para
$APIGEECTL_HOME. Esses links permitem que você execute o comando apigeectl a partir do
diretório hybrid-files, como no exemplo a seguir:
Para verificar se os links simbólicos foram criados corretamente, execute este comando e certifique-se de que
os caminhos do link apontam para os locais corretos:
ls -l | grep ^l
Agora você tem uma base inicial para configurar, implantar e gerenciar a Apigee híbrida
no cluster do Kubernetes. Em seguida, você criará as contas de serviço e as credenciais do Google Cloud
necessárias para configurar os componentes do ambiente de execução híbrido.
[[["Fácil de entender","easyToUnderstand","thumb-up"],["Meu problema foi resolvido","solvedMyProblem","thumb-up"],["Outro","otherUp","thumb-up"]],[["Difícil de entender","hardToUnderstand","thumb-down"],["Informações incorretas ou exemplo de código","incorrectInformationOrSampleCode","thumb-down"],["Não contém as informações/amostras de que eu preciso","missingTheInformationSamplesINeed","thumb-down"],["Problema na tradução","translationIssue","thumb-down"],["Outro","otherDown","thumb-down"]],["Última atualização 2025-08-28 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"]]
