apigeectl

apigeectl é uma interface de linha de comando (CLI, na sigla em inglês) para instalar e gerenciar o Apigee híbrido em um cluster do Kubernetes. Para informações sobre como fazer o download e instalar o apigeectl, consulte Fazer o download e instalar o apigeectl.

.

Escopos para aplicar apigeectl

Ao usar sinalizações apigeectl, você controla em quais escopos o comando aplica as alterações de configuração. Para uma visão geral dos escopos do ambiente de execução híbrido da Apigee, consulte Visão geral da configuração do serviço do ambiente de execução.

EscopoComponentesSinalização apigeectl
Armazenamento Cassandra --datastore
Ambiente UDCA do
sincronizador
do ambiente de execução		 --all-envs
--env
Organização Agente do Apigee Connect
MART
Watcher		 --org
Relatórios Métricas do
logger		 --telemetry

Sintaxe apigeectl

apigeectl [command] [flags]

Em que:

  • command: especifica a operação que você quer executar. Para ver uma lista completa dos comandos, consulte comandos apigeectl (em inglês).

  • flags: especifica os parâmetros do comando. Para ver uma lista completa de sinalizações, consulte sinalizações apigeectl.

Comandos apigeectl

A tabela a seguir lista os comandos apigeectl:

Comando Descrição
apply

Aplica as configurações dos componentes de ambiente de execução híbridos da Apigee ao cluster do Kubernetes.

apigeectl apply sem sinalizações aplicarão alterações a todos os componentes no cluster.

Sinalizações apigeectl: --all-envs, --datastore, --dry-run, --env, -f, --file-override-config, --help, --org, --print-yaml, --settings virtualhosts, --telemetry, --verbose

check‑ready

Verifica o status dos pods do componente híbrido. Quando todos os pods de componente estiverem prontos, a mensagem "Todos os contêineres prontos" será exibida. Para scripts automatizados, observe que o comando sai com um status 0 quando os contêineres estão prontos. Quando houver pelo menos um pod não pronto, o comando sairá com o status 1.

Sinalizações apigeectl: -f, --file-override-config, --help, --verbose

delete

Exclui componentes híbridos do cluster. Use a sinalização --all para remover TODAS os componentes. Se você omitir --all, apenas os componentes específicos da Apigee serão removidos (os componentes instalados com apigeectl init não serão excluídos). Componentes específicos da Apigee são os componentes instalados com o comando apply.

apigeectl delete sem sinalizações opcionais aplica o comando delete a todos os componentes implantados no cluster.

Sinalizações apigeectl: --all, --all-envs, --datastore, --env, -f, --file-override-config, --help, --org, --telemetry, --verbose

encode

Retorna uma lista de nomes codificados de todas as ApigeeDeployments para a organização especificada ou para o ambiente especificado na organização especificada. Os nomes codificados incluem o nome do componente com um nome em hash da organização e, se estiver usando a sinalização --env, um nome em hash do ambiente. A Apigee híbrida cria nomes com hash de organizações e ambientes para evitar conflitos de namespaces.

Você precisa usar o --org org-name ou os dois --org org-name com as sinalizações --env env-name com encode. Por exemplo:

./apigeectl encode --org hybrid-example
List of ApigeeDeployments are:
  apigee-connect-agent-hybrid-example-6a82f8a
  apigee-mart-hybrid-example-6a82f8a
  apigee-watcher-hybrid-example-6a82f8a
 
./apigeectl encode --org hybrid-example --env example-env
List of ApigeeDeployments are:
  apigee-runtime-hybrid-example-example-env-9e87e2d
  apigee-synchronizer-hybrid-example-example-env-9e87e2d
  apigee-udca-hybrid-example-example-env-9e87e2d

Sinalizações apigeectl: --env, --org

help Imprime a ajuda on-line.
init

Instala os operadores da Apigee e CRDs no namespace apigee-system.

Executar apigeectl init após uma nova instalação ou upgrade antes de executar apigeectl apply.

Sinalizações apigeectl: -f, --file-override-config, --help, --verbose

version Imprime as informações da versão da CLI.

Sinalização apigeectl: --help

Sinalizações apigeec

A tabela a seguir lista as sinalizações apigeectl:

Sinalizar Descrição
--all delete apenas: exclui toda a instalação híbrida da Apigee, exceto ASM (Istio) cert-manager do cluster.
--all-envs

Aplica o comando apigeectl a todos os ambientes da organização especificada no arquivo de configuração de modificação.
    --datastore

Aplica a configuração ao escopo do armazenamento de dados (cassandra).
    ‑‑dry‑run Executa o comando especificado sem alterar o cluster. Use com ‑‑print-yaml para gerar a especificação do objeto renderizado em um arquivo.

‑‑dry‑run precisa ser usado com um dos dois valores a seguir, dependendo da versão do kubectl que você está executando. Use gcloud version para verificar a versão do kubectl:

  • kubectl versão 1.17.x ou anterior: ‑‑dry‑run=true
  • kubectl versão 1.18.x ou mais recente: ‑‑dry‑run=client
--env env-name

Aplica a configuração ao ambiente especificado. Essa sinalização aplicará a configuração aos componentes do escopo do ambiente apigee-runtime, apigee-synchronizer e apigee-udca.

--env precisa ser usado com a sinalização --org. Por exemplo: 

apigeectl apply --org hybrid-example --env example-env \
      -f overrides/overrides.yaml
‑f, ‑‑file‑override‑config Especifica um arquivo YAML contendo as propriedades de configuração personalizadas para a implantação híbrida. O valor padrão é ./overrides.yaml. Um arquivo de modificação é obrigatório para os comandos apply, check-ready, delete e init.

Você precisa especificar o caminho completo com essa sinalização. Para mais informações, consulte Como gerenciar componentes do plano de execução.
-h, --help Exibe ajuda para o comando.
--org

Aplica a configuração à organização especificada. Essa sinalização aplicará a configuração aos componentes do escopo da organização apigee-connect-agent, apigee-mart e apigee-watcher.
--print-yaml Imprime a saída do modelo de configuração para stdout. Para ver um exemplo que usa essa sinalização, consulte Imprimir a configuração em um arquivo.
-s, --settings virtualhosts

Especifica uma configuração à qual o comando se aplica. Atualmente, essa sinalização é compatível apenas com a configuração virtualhosts, que faz parte do componente runtime. Use essa sinalização se você fizer alterações na propriedade virtualhosts e nada mais.

Por exemplo, se você fizer uma alteração na configuração virtualhosts no arquivo de modificações, aplique-a ao cluster com este comando:

apigeectl apply -f my-overrides.yaml --settings virtualhosts \
    --org example-org --env example-env
--telemetry

Aplica a configuração de componentes de telemetria, como apigee-logger e apigee-metrics.
--verbose

Imprime registros detalhados para std err.

Exemplos

Inicializar a configuração do cluster

Aplique configurações de componentes de pré-requisito ao cluster com init. Execute o comando init antes de apply. 

apigeectl init -f my_overrides.yaml

Aplicar a configuração do cluster

Para aplicar configurações híbridas ao cluster do Kubernetes, use o comando apply. Na primeira vez que você executar apply, todos os componentes do ambiente de execução híbrido serão criados no cluster. Se você fizer alterações na configuração, execute novamente apply para aplicar somente as alterações ou use sinalizações para aplicar uma alteração somente a um escopo específico.

No exemplo a seguir, você aplica a configuração de componentes do plano de ambiente de execução híbrido ao cluster:

apigeectl apply -f my_overrides.yaml

Aplicar a configuração a um único componente

Para restringir o comando apply a um componente específico, use as sinalizações descritas em sinalizações apigeectl (em inglês).

O exemplo a seguir aplica somente a configuração do componente Cassandra:

apigeectl apply --datastore -f my_overrides.yaml

Imprimir a configuração em um arquivo

Se estiver depurando um problema de instalação, é útil imprimir toda a configuração do cluster em um arquivo para que você possa inspecionar as definições de configuração. A sinalização --print-yaml imprime a configuração híbrida para stdout, e a sinalização --dry-run permite que o comando seja executado sem fazer alterações no cluster.

apigeectl apply -f my_overrides.yaml --dry-run=client --print-yaml > apigee-hybrid.yaml

Verificar o status do pod

O exemplo a seguir verifica o status dos pods implantados no cluster:

apigeectl check-ready -f overrides/overrides.yaml
All containers ready in namespace 'my-namespace'

Excluir híbridos do cluster

O exemplo a seguir exclui apenas os componentes do ambiente de execução híbrido para o cluster do Kubernetes. Para excluir tudo, use a sinalização --all.

apigeectl delete -f my_overrides.yaml