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.
Escopo | Componentes | Sinalização apigeectl |
---|---|---|
Armazenamento | Cassandra | --datastore |
Armazenamento na memória | Redis | --redis |
Ambiente | Runtime Synchronizer UDCA |
--all-envs --env |
Organização | Agente do Apigee Connect MART Watcher |
--org |
Relatórios | Logger Metrics |
--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.
Sinalizações apigeectl: |
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: |
delete |
Exclui componentes híbridos do cluster. Use a sinalização
Sinalizações apigeectl: |
diagnostic |
Invoca o coletor de diagnóstico, que captura dados de diagnóstico nos componentes do Kubernetes de uma instância da Apigee híbrida sob demanda e os armazena em buckets de armazenamento do Google Cloud. O coletor de diagnósticos exige um bucket de armazenamento nomeado do Google Cloud, uma conta de serviço com
o papel Administrador do Storage e uma estrofe Quando você invoca o coletor de diagnóstico, ele cria um namespace " Invoque o coletor de diagnósticos: apigeectl diagnostic -f OVERRIDES_FILE Excluir coletor de diagnóstico: apigeectl diagnostic delete -f OVERRIDES_FILE
Sinalizações apigeectl:
|
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
Você precisa usar o ./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: |
help |
Imprime a ajuda on-line. |
init |
Instala os operadores da Apigee e CRDs no namespace apigee-system.
Executar
Sinalizações apigeectl: |
version |
Imprime as informações da versão da CLI.
Sinalização apigeectl: |
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 |
--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.
|
--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.
apigeectl apply --org hybrid-example --env example-env \ -f overrides/overrides.yaml |
‑f |
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 |
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. |
--redis |
Aplica a configuração ao escopo de armazenamento de dados (Redis) na memória. |
--restore |
Restaura o Cassandra em um snapshot salvo anteriormente especificado pela propriedade
|
-s |
Especifica uma configuração à qual o comando se aplica. Atualmente, essa sinalização
é compatível apenas com a configuração Por exemplo, se você fizer uma alteração na configuração 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