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.

.

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 do Apigee ao cluster do Kubenetes. Use a sinalização -c para especificar um ou mais componentes (separados por vírgula).

Se você não especificar a sinalização -c, o comando apply aplicará todos os componentes ao cluster.
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.

Se você não especificar a sinalização -c, o comando check-ready se aplicará a todos os componentes no cluster.
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.

Se você não especificar a sinalização -c, o comando delete se aplicará a todos os componentes implantados no cluster.
help Imprime a ajuda on-line.
init

Aplica configurações para componentes de pré-requisito, como Istio e Apigee Deployment, ao cluster. Use a sinalização -c para especificar um ou mais componentes (separados por vírgula).
version Imprime as informações da versão da CLI.

Sinalizações apigeec

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

Sinalização Descrição
-c, --components

Especifica um único componente ao qual o comando se aplica.

Se você não especificar essa sinalização, o comando será aplicado a todos os componentes (toda a implantação) no cluster. Os valores possíveis incluem:

  • cassandra
  • logger
  • mart
  • metrics
  • runtime
  • synchronizer
  • udca

Por exemplo, -c cassandra.

Ou, para especificar vários componentes, adicione valores separados por vírgula: -c cassandra, runtime

--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.
‑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.
--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

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. (Adicionada v1.2.0)

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 -c runtime

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 -c para aplicar apenas um componente 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 a sinalização -c, conforme descrito em sinalizações apigeectl (em inglês).

O exemplo a seguir aplica somente a configuração para o componente Sincronizador:

apigeectl apply -c synchronizer -f my_overrides.yaml

O exemplo a seguir aplica apenas a configuração dos componentes de execução e Cassandra:

apigeectl apply -c cassandra,runtime -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 --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
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