Gerenciar componentes do plano de ambiente de execução

Neste tópico, explicamos como configurar e gerenciar os componentes do plano do ambiente de execução híbrido do Apigee.

Sobre o arquivo de modificações

Na primeira vez que você instalar o ambiente de execução híbrido em um cluster, será preciso criar uma configuração arquivo de modificações. Esse arquivo permite que você forneça os valores de propriedade necessários para a instalação híbrida, como o nome do projeto do Google, o nome da organização, detalhes do ambiente, arquivos de certificado e assim por diante. Também é possível modificar determinados valores padrão para a maioria dos componentes híbridos no arquivo de modificações. Para uma lista completa de propriedades configuráveis, consulte a Referência de propriedades de configuração.

As etapas de instalação híbrida percorrem o processo de criação de um arquivo de modificações e de aplicar a configuração a um cluster. Se você quiser alterar a configuração mais tarde, modifique o arquivo de modificações criado e aplique-o novamente. Consulte Como fazer uma alteração na configuração.

Como fazer uma alteração de configuração

Para fazer uma alteração de configuração em um componente de plano de execução híbrido, edite o arquivo de modificações e aplique as alterações com apigeectl. Para uma lista completa de propriedades configuráveis, consulte a Referência de propriedades de configuração.

Por exemplo, para ativar o componente logger, atualize o arquivo de modificação e aplique-o novamente:

Abra o arquivo de modificações. Use o mesmo arquivo de modificações que foi usado para instalar o ambiente de execução híbrido no cluster.
Localize o elemento logger no arquivo. Exemplo:
```
...
logger:
  enabled: false
...
```
Altere o valor da propriedade para true:
```
...
  logger:
  enabled: true
...
```
Use apigeectl para aplicar a alteração ao cluster:
```
$APIGEECTL_HOME/apigeectl apply -f $HYBRID_FILES/overrides/OVERRIDES.yaml --telemetry
```
A flag --telemetry instrui o apigeectl a atualizar apenas o componente de registro. Para informações sobre parâmetros de escopo, como --telemetry, consulte Escopos para aplicar apigeectl.

Quais propriedades de configuração você pode modificar?

Veja a lista completa de propriedades configuráveis na Referência da propriedade de configuração. A referência lista apenas as propriedades que podem ser modificadas. Se você tentar modificar uma propriedade que não esteja na referência, a alteração será ignorada.

Como usar a referência de configuração

A Referência da propriedade de configuração usa a notação de ponto para descrever elementos de configuração, em que o primeiro item é o nome do elemento de nível superior seguido por propriedades e propriedades filho. Exemplo:

authz.image.pullPolicy

No arquivo de modificações, as propriedades são formatadas em YAML adequado. Para o exemplo acima, o elemento de nível superior authz tem recuo à esquerda e as propriedades de subelemento são recuadas nele. Além disso, o YAML requer dois pontos no final de cada elemento e subelemento.

Por exemplo, para definir a propriedade authz.image.pullPolicy como Always, localize esta estrofe YAML no arquivo de modificações e defina-a:

authz:
  image:
    pullPolicy: Always

Para outro exemplo, a propriedade cassandra.auth.admin.password (conforme listado na referência da propriedade de configuração) é usada para definir a senha de administrador do Cassandra. Para alterá-la, localize o YAML a seguir no arquivo de modificações e defina-o da seguinte maneira:

cassandra:
  auth:
    admin:
      password: abc123

Lembre-se de que a Referência de propriedade de configuração descreve todas as propriedades que podem ser definidas em componentes do plano do ambiente de execução híbrido. Siga o padrão explicado acima para modificar esses elementos no arquivo de modificações antes de aplicar as alterações no cluster.

Sobre padrões de configuração

A Apigee mantém a configuração padrão de componentes no arquivo $HYBRID_FILES/config/values.yaml. Esse arquivo especifica padrões, quando possível, para cada componente híbrido.

Os arquivos de modificações seguem a mesma estrutura YAML de values.yaml. No entanto, um arquivo de substituições inclui apenas um subconjunto das propriedades de configuração encontradas em values.yaml. Lembre-se de que nem todas as propriedades são editáveis. Quando você aplica uma configuração a um cluster, as modificações são mescladas com os padrões para criar a configuração completa do cluster do Kubernetes.

Se quiser modificar os padrões de um componente e o componente ainda não estiver no arquivo de modificações, copie o YAML de values.yaml para o arquivo de modificações e modifique-o nele.

Nunca edite values.yaml diretamente. Sempre use um arquivo de modificações para especificar suas propriedades de configuração.

Como usar arquivos de modificações de exemplos predefinidos

A Apigee fornece um conjunto de arquivos de modificações de amostra para ajudar a configurar sua implantação híbrida. É uma boa prática copiar e modificar o arquivo de modificações que melhor atende aos seus requisitos de instalação.

As amostras a seguir estão incluídas no diretório $APIGEECTL_HOME/examples:

Arquivos de modificações de amostra	Descrição
`overrides-small.yaml`	Essa amostra é ideal para dar os primeiros passos rapidamente. Ela usa a abrangência mínima recomendada para iniciar os componentes do ambiente de execução híbrido. Essa configuração de exemplo depende o máximo possível das configurações e valores padrão. Todas as réplicas mínimas estão definidas como `1`.
`overrides-medium.yaml`	Esse exemplo é um bom ponto de partida para ambientes de teste e de controle de qualidade. Os componentes individuais receberam um nível mais alto de recursos para lidar com tráfego adicional. O Cassandra usa discos SSD para desempenho. Nesse ambiente, é recomendável que os usuários instalem componentes com estado e sem estado em nós separados. Consulte Configurar nós dedicados.
`overrides-large.yaml`	Essa amostra é um bom ponto de partida para ambientes de alto desempenho, como pré-produção e produção. O exemplo inclui propriedades para definir chaves de criptografia, senhas e outros. Os componentes individuais têm no mínimo duas réplicas.
`private-overrides.yaml`	Essa amostra ilustra como usar imagens de um repositório de imagens particular. Consulte Usar um repositório de imagens particulares.

Anotações personalizadas

Anotações são mapas de chave-valor usados para anexar metadados a pods do Kubernetes. É possível criar anotações personalizadas para as seguintes propriedades de componente híbrido listadas na Referência da propriedade de configuração:

Para adicionar uma anotação personalizada de par de nome/valor, abra o arquivo de substituição e adicione uma estrofe annotations ao respectivo componente. Em seguida, aplique a mudança com apigeectl. Exemplo:

runtime:
  annotations:
    businessunit: "bu1"

Usar simulações para testar mudanças na configuração

É possível usar a flag --dry-run com apigeectl para testar o arquivo de configuração de substituições sem realmente aplicá-lo ao cluster. Essa opção é útil para depurar um problema de instalação porque mostra exatamente o que será aplicado ao cluster.

Na Apigee híbrida, a sintaxe da flag --dry-run depende da versão de kubectl que você está executando. Verifique a versão de kubectl com o seguinte comando:

kubectl version

kubectl versão 1.17 e anterior:

$APIGEECTL_HOME/apigeectl init -f $HYBRID_FILES/overrides/OVERRIDES.yaml --dry-run=true

kubectl versão 1.18 e mais recente:

  $APIGEECTL_HOME/apigeectl init -f $HYBRID_FILES/overrides/OVERRIDES.yaml --dry-run=client

Crie vários arquivos de modificações conforme necessário

É possível criar vários arquivos de modificações, em que cada um atende a um requisito específico. Por exemplo, é possível ter um arquivo de substituição que ajusta o cluster para produção e outro para criar um cluster para teste. É possível manter esses arquivos no sistema de controle de origem.

Use o comando apigeectl apply para aplicar um arquivo de modificação ao cluster. Exemplo:

$APIGEECTL_HOME/apigeectl apply  -f $HYBRID_FILES/overrides/test_env_override.yaml

Excluir componentes do ambiente de execução

O comando apigeectl delete fornece flags para permitir que você exclua todos ou um subconjunto dos componentes do ambiente de execução híbrido instalado. Para detalhes sobre o uso do comando, consulte a página de referência da apigeectl. Consulte também Desinstalar o ambiente de execução híbrido.

Excluir um ambiente

Para excluir completamente um ambiente, é preciso remover os planos de ambiente de execução (local) e de gerenciamento (nuvem). Veja mais detalhes em Excluir ambientes.