apigeectl

apigeectl é uma interface de linhas de comando (CLI) para instalar e gerir o Apigee Hybrid num cluster do Kubernetes. Para obter informações sobre a transferência e a instalação do apigeectl, consulte o artigo Transfira e instale o apigeectl.

Sintaxe apigeectl

apigeectl [command] [flags]

Onde:

  • command: especifica a operação que quer realizar. Para ver uma lista completa de comandos, consulte comandos apigeectl.

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

Comandos apigeectl

A tabela seguinte lista os comandos apigeectl:

Comando Descrição
apply

Aplica configurações para componentes de runtime do Apigee Hybrid ao seu cluster do Kubernetes. Use a flag -c para especificar um ou mais componentes (separados por vírgulas).

Se não especificar a flag -c, o comando apply aplica todos os componentes ao cluster.
check‑ready

Verifica o estado dos pods de componentes híbridos. Quando todos os pods de componentes estão prontos, é apresentada a mensagem "Todos os contentores estão prontos". Para scripts automatizados, tenha em atenção que o comando termina com o estado 0 quando todos os contentores estão prontos. Quando existe, pelo menos, um pod não preparado, o comando é terminado com o estado 1.

Se não especificar a flag -c, o comando check-ready aplica-se a todos os componentes no cluster.
delete

Elimina os componentes híbridos do cluster. Use a flag --all para remover TODOS os componentes. Se omitir --all, apenas os componentes específicos do Apigee são removidos (os componentes instalados com apigeectl init não são eliminados). Os componentes específicos do Apigee são os componentes instalados com o comando apply.

Se não especificar a flag -c, o comando delete aplica-se a todos os componentes implementados no cluster.
help Imprime ajuda online.
init

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

Sinalizações apigeectl

A tabela seguinte indica as flags apigeectl:

Bandeira Descrição
-c, --components

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

Se não especificar esta flag, o comando aplica-se a todos os componentes (a implementação completa) no cluster. Os valores possíveis incluem:

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

Por exemplo, -c cassandra

Em alternativa, para especificar vários componentes, adicione valores separados por vírgulas: -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 num ficheiro.
‑f, ‑‑file‑override‑config Especifica um ficheiro YAML que contém propriedades de configuração personalizadas para a implementação híbrida. O valor predefinido é ./overrides.yaml. É necessário um ficheiro de substituições para os comandos apply, check-ready, delete e init.

Tem de especificar o caminho completo com esta flag. Para mais informações, consulte o artigo Gerir componentes do plano de tempo de execução.
-h, --help Apresenta ajuda para o comando.
--print-yaml Imprime o resultado do modelo de configuração para stdout. Para ver um exemplo que usa esta flag, consulte o artigo Imprima a configuração num ficheiro.
-s, --settings

Especifica uma configuração à qual o comando se aplica. Atualmente, esta flag só é suportada para a configuração virtualhosts, que faz parte do componente runtime. Use esta flag se fizer alterações à propriedade virtualhosts e nada mais. (Adicionado na v1.2.0)

Por exemplo, se fizer uma alteração à configuração virtualhosts no ficheiro de substituições, aplique-a ao cluster com este comando:

apigeectl apply -f my-overrides.yaml --settings virtualhosts -c runtime

Exemplos

Inicialize a configuração do cluster

Aplique configurações de componentes de pré-requisitos ao seu cluster com init. Tem de executar o comando init antes de apply. 

apigeectl init -f my_overrides.yaml

Aplique a configuração do cluster

Para aplicar configurações híbridas ao seu cluster do Kubernetes, use o comando apply. Quando executa apply pela primeira vez, todos os componentes de tempo de execução híbrido são criados no cluster. Se fizer alterações à configuração, execute novamente o comando apply para aplicar apenas as alterações ou use -c para aplicar apenas um componente específico.

O exemplo seguinte aplica a configuração dos componentes do plano de tempo de execução híbrido ao seu cluster:

apigeectl apply -f my_overrides.yaml

Aplique a configuração a um único componente

Para restringir o comando apply a um componente específico, use a flag -c, conforme descrito em flags apigeectl.

O exemplo seguinte aplica apenas a configuração ao componente Synchronizer:

apigeectl apply -c synchronizer -f my_overrides.yaml

O exemplo seguinte aplica apenas a configuração aos componentes do Cassandra e de tempo de execução:

apigeectl apply -c cassandra,runtime -f my_overrides.yaml

Imprima a configuração num ficheiro

Se estiver a depurar um problema de instalação, é útil imprimir toda a configuração do cluster num ficheiro para poder inspecionar as definições de configuração. A flag --print-yaml imprime a configuração híbrida para stdout e a flag --dry-run permite que o comando seja executado sem fazer alterações ao cluster.

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

Verifique o estado do pod

O exemplo seguinte verifica o estado dos pods implementados no seu cluster:

apigeectl check-ready
All containers ready in namespace 'my-namespace'

Elimine o híbrido do cluster

O exemplo seguinte elimina apenas os componentes de tempo de execução híbrido do seu cluster do Kubernetes. Para eliminar tudo, use a flag --all.

apigeectl delete -f my_overrides.yaml