apigeectl

Está a ver a versão 1.9 da documentação do Apigee híbrido. This version is end of life. You should upgrade to a newer version. Para mais informações, consulte Versões suportadas.

Version 1.9 (unsupported)

Versões com suporte:

• v1.15 (mais recente)                        
• v1.14                        
• v1.13                         
• Lista de versões com suporte

Versões sem suporte:

• v1.12                         
• v1.11
• v1.10                                      
• v1.9
• v1.8                                         
• v1.7
• v1.6
• v1.5
• v1.4
• v1.3
• v1.2
• v1.1

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.

NOTA: tem de ter o kubectl instalado e configurado no seu computador de administração do Kubernetes para usar o comando apigeectl.

Âmbitos para aplicação apigeectl

Ao usar as flags apigeectl, controla a que âmbitos o comando aplica as alterações de configuração. Para uma vista geral dos âmbitos no tempo de execução do Apigee Hybrid, consulte a vista geral da configuração do serviço de tempo de execução.

Âmbito	Componentes	apigeectl bandeira
Armazenamento	Cassandra	‑‑datastore
Armazenamento na memória	Redis	‑‑redis
Ambiente	Runtime Synchronizer UDCA	‑‑all‑envs ‑‑env
Organização	Apigee Connect Agent MART Watcher	‑‑org
Relatórios	Logger Metrics	‑‑telemetry

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. apigeectl apply sem flags aplica alterações a todos os componentes no cluster. apigeectl flags: ‑‑all‑envs, ‑‑datastore, ‑‑dry‑run, ‑‑env, ‑f, ‑‑file‑override‑config, ‑‑help, ‑‑org, ‑‑print‑yaml, ‑‑redis, ‑‑settings virtualhosts, ‑‑telemetry, ‑‑v NOTA: após uma nova instalação ou uma atualização, tem de chamar apigeectl init antes de chamar apigeectl apply.
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. apigeectl flags: ‑f, ‑‑file‑override‑config, ‑‑help, ‑‑v
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. apigeectl delete sem flags opcionais aplica o comando delete a todos os componentes implementados no cluster. apigeectl diagnostic delete ‑f OVERRIDES_FILE elimina o espaço de nomes apigee‑diagnostic criado por apigeectl diagnostic. A flag ‑f / ‑‑file‑override‑config é obrigatória com apigeectl diagnostic delete apigeectl flags: ‑‑all, ‑‑all‑envs, ‑‑datastore, ‑‑env, ‑f, ‑‑file‑override‑config, ‑‑help, ‑‑org, ‑‑redis, ‑‑telemetry, ‑‑v Para mais informações, consulte o artigo Desinstale o tempo de execução híbrido.
diagnostic	Invoca o coletor de diagnósticos, que captura dados de diagnóstico nos componentes do Kubernetes de uma instância híbrida do Apigee a pedido e os armazena em contentores do Google Cloud Storage. O coletor de diagnósticos requer um contentor do Google Cloud Storage com nome, uma conta de serviço com a função de administrador de armazenamento e uma secção diagnostic: adicionada ao seu ficheiro overrides. Consulte: Usar o coletor de diagnósticos Referência da propriedade de configuração: diagnostic Quando invoca o Diagnostic collector, este cria um espaço de nomes do Kubernetes "apigee‑diagnostic". Tem de eliminar este ficheiro com apigeectl diagnostic delete antes de invocar novamente o coletor de diagnósticos. Invocar o coletor de diagnósticos: apigeectl diagnostic ‑f OVERRIDES_FILE Elimine o coletor de diagnósticos: apigeectl diagnostic delete ‑f OVERRIDES_FILE apigeectl flags: ‑‑file‑override‑config
encode	Devolve uma lista de nomes codificados de todas as ApigeeDeployments para a organização especificada ou o ambiente especificado na organização especificada. Os nomes codificados incluem o nome do componente com um nome com hash da organização e, se usar a flag ‑‑env, um nome com hash do ambiente. O Apigee hybrid cria nomes com hash de organizações e ambientes para evitar colisões de espaços de nomes. Tem de usar o elemento ‑‑org org‑name ou ambos os elementos ‑‑org org‑name com as flags ‑‑env env‑name e 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 apigeectl flags: ‑‑env, ‑‑org
help	Imprime ajuda online.
init	Instala os operadores e os CRDs do Apigee no espaço de nomes apigee-system. Execute apigeectl init após uma nova instalação ou uma atualização antes de executar apigeectl apply. apigeectl flags: ‑f, ‑‑file‑override‑config, ‑‑help, ‑‑v
version	Imprime as informações da versão da CLI. sinalizador apigeectl: ‑‑help

Sinalizações apigeectl

A tabela seguinte indica as flags apigeectl:

Bandeira	Descrição
‑‑all	Apenas para o delete: elimina toda a instalação híbrida do Apigee, exceto o ASM (Istio) e o cert-manager do seu cluster.
‑‑all‑envs	Aplica o comando apigeectl a todos os ambientes na organização especificada no ficheiro de configuração de substituições.
‑‑datastore	Aplica a configuração ao âmbito do arquivo de dados (Cassandra).
‑‑dry‑run	Executa o comando especificado sem alterar o cluster. Use com ‑‑print‑yaml para enviar a especificação do objeto renderizado para um ficheiro. ‑‑dry‑run tem de ser usado com um dos dois valores seguintes, consoante a versão do kubectl que está a executar. 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. Esta flag aplica a configuração aos componentes de âmbito do ambiente apigee-runtime, apigee-synchronizer e apigee-udca. O elemento ‑‑env tem de ser usado com a flag ‑‑org. Por exemplo: apigeectl apply ‑‑org hybrid‑example ‑‑env example‑env \ ‑f overrides/overrides.yaml
‑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.
‑‑org	Aplica a configuração à organização especificada. Esta flag aplica a configuração aos componentes do âmbito da organização apigee‑connect‑agent, apigee‑mart e apigee‑watcher. Nota: quando usar ‑‑org com encode tem de incluir o ID da organização. Por exemplo: apigeectl encode ‑‑org example‑org
‑‑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.
‑‑redis	Aplica a configuração ao âmbito de armazenamento de dados na memória (Redis).
‑‑restore	Restaura o Cassandra para um instantâneo guardado anteriormente especificado pela propriedade snapshotTimestamp na configuração restore do ficheiro overrides.yaml. A cópia de segurança é restaurada a partir do contentor de armazenamento na nuvem ou de um servidor remoto com base na configuração backup no ficheiro overrides.yaml. Para mais informações, consulte o artigo Restaurar uma região a partir de uma cópia de segurança.
‑s ‑‑settings virtualhosts	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. 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 \ ‑‑org example‑org ‑‑env example‑env
‑‑telemetry	Aplica a configuração para componentes de telemetria, como apigee-logger e apigee-metrics.
‑‑v int	Imprime registos detalhados para o erro padrão. int é um número inteiro que define o nível de detalhe. O campo int é obrigatório com ‑‑v. Esta opção tem o mesmo comportamento que a opção kubectl ‑‑v. Nota: esta opção substitui a opção ‑‑verbose descontinuada.

O comando apigeectl usa o kubectl em segundo plano para fazer o seu trabalho. As opções de comando apigeectl (apply e delete) e a utilização de ficheiros de configuração YAML são semelhantes às respetivas contrapartes do kubectl. Para saber como os objetos são geridos num cluster do Kubernetes, consulte os seguintes tópicos:

• Gestão imperativa de objetos do Kubernetes através de ficheiros de configuração
• Vista geral do kubectl

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 flags para aplicar alterações apenas a um âmbito 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 as flags descritas em flags apigeectl.

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

apigeectl apply ‑‑datastore ‑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=client ‑‑print‑yaml > apigee‑hybrid.yaml

NOTA: é uma boa prática guardar uma cópia do resultado YAML no controlo de origem para referência futura. No entanto, tenha em atenção que o ficheiro de saída contém palavras-passe e Secrets que pode não querer armazenar.

Verifique o estado do pod

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

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

Elimine o híbrido do cluster

Para obter detalhes, consulte o artigo Desinstale o tempo de execução híbrido.