Faça a gestão dos componentes do plano de tempo de execução

Este tópico explica como configurar e gerir os componentes do plano de execução do Apigee hybrid.

Acerca do ficheiro de substituições

Quando instala o tempo de execução híbrido num cluster pela primeira vez, tem de criar um ficheiro de substituições de configuração. Este ficheiro permite-lhe fornecer os valores das propriedades necessários para instalar o híbrido, como o nome do seu projeto Google, o nome da organização, os detalhes do ambiente, os ficheiros de certificado, etc. Também pode substituir determinados valores predefinidos para a maioria dos componentes híbridos no ficheiro de substituições. Para ver uma lista completa das propriedades configuráveis, consulte a referência de propriedades de configuração.

Os passos de instalação híbrida explicam o processo de criação de um ficheiro de substituições e de aplicação da sua configuração a um cluster. Se quiser alterar a configuração mais tarde, modifique o ficheiro de substituições que criou e volte a aplicá-lo. Consulte o artigo Fazer uma alteração de configuração.

Fazer uma alteração de configuração

Para fazer uma alteração de configuração a um componente do plano de execução híbrido, edite o ficheiro de substituições e aplique as alterações com apigeectl. Para ver uma lista completa das propriedades configuráveis, consulte a referência de propriedades de configuração.

Por exemplo, para ativar o componente logger, atualize o ficheiro de substituições e volte a aplicá-lo:

  1. Abra o ficheiro de substituições. Certifique-se de que usa o mesmo ficheiro de substituições que foi usado para instalar o motor de execução híbrido no cluster.
  2. Localize o elemento logger no ficheiro. Por exemplo: 
    ...
logger:
  enabled: false
...
  3. Altere o valor da propriedade para true: 
    ...
  logger:
  enabled: true
...
  4. Use apigeectl para aplicar a alteração ao cluster: 
    $APIGEECTL_HOME/apigeectl apply -f $HYBRID_FILES/overrides/OVERRIDES.yaml --telemetry

    A flag --telemetry indica ao apigeectl que só deve atualizar o componente de registo. Para informações sobre parâmetros de âmbito, como --telemetry, consulte Âmbitos para aplicar o apigeectl.

Que propriedades de configuração pode modificar?

Pode encontrar a lista completa de propriedades configuráveis na referência de propriedades de configuração. A referência apenas lista as propriedades que pode modificar. Se tentar modificar uma propriedade que não esteja na referência, a alteração é ignorada.

Como usar a referência de configuração

A referência da propriedade de configuração usa a notação de pontos para descrever os elementos de configuração, em que o primeiro item é o nome do elemento de nível superior seguido de propriedades e propriedades secundárias. Por exemplo:

authz.image.pullPolicy

No ficheiro de substituições, as propriedades estão formatadas em YAML adequado. Para o exemplo acima, o elemento authz de nível superior tem uma indentação à esquerda e as propriedades dos subelementos têm uma indentação abaixo. 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 secção YAML no ficheiro de substituições e defina-a da seguinte forma:

authz:
  image:
    pullPolicy: Always

Por outro lado, a propriedade cassandra.auth.admin.password (conforme está listada na referência da propriedade de configuração) é usada para definir a palavra-passe de administrador do Cassandra. Para a alterar, localize o seguinte YAML no ficheiro de substituições e defina-o da seguinte forma:

cassandra:
  auth:
    admin:
      password: abc123

Lembre-se de que a referência da propriedade de configuração descreve todas as propriedades que pode definir em componentes do plano de execução híbrido. Siga o padrão explicado acima para modificar estes elementos no ficheiro de substituições antes de aplicar as alterações ao cluster.

Acerca das predefinições de configuração

O Apigee mantém a sua configuração de componentes predefinida no ficheiro $HYBRID_FILES/config/values.yaml. Este ficheiro especifica as predefinições, quando possível, para cada componente híbrido.

Os ficheiros de substituições seguem a mesma estrutura YAML que values.yaml. No entanto, um ficheiro 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 aplica uma configuração a um cluster, as substituições são unidas às predefinições para criar a configuração completa do cluster do Kubernetes.

Usar ficheiros de substituições de amostras predefinidos

O Apigee fornece um conjunto de ficheiros de substituições de exemplo para ajudar a configurar a sua implementação híbrida. É uma boa prática copiar e modificar o ficheiro de substituições que corresponde mais de perto aos requisitos de instalação.

Os seguintes exemplos estão incluídos no diretório $APIGEECTL_HOME/examples:

Ficheiros de substituições de exemplo Descrição
overrides-small.yaml Esta amostra é ideal para começar rapidamente. Usa a área de ocupação mínima recomendada para iniciar os componentes de tempo de execução híbrido. Esta configuração de exemplo baseia-se o mais possível nas definições e nos valores predefinidos. Todas as réplicas mínimas estão definidas como 1.
overrides-medium.yaml Este exemplo é um bom ponto de partida para ambientes de teste e controlo de qualidade. Os componentes individuais receberam um nível mais elevado de recursos para lidar com tráfego adicional. O Cassandra usa discos SSD para o desempenho. Neste ambiente, recomenda-se que os utilizadores instalem componentes com estado e sem estado em nós separados. Consulte Configure nós dedicados.
overrides-large.yaml Este exemplo é um bom ponto de partida para ambientes de elevado desempenho, como pré-produção e produção. O exemplo inclui propriedades para definir chaves de encriptação, palavras-passe e outras. Os componentes individuais têm um mínimo de duas réplicas.
private-overrides.yaml Este exemplo ilustra como usar imagens de um repositório de imagens privado. Consulte o artigo Use um repositório de imagens privado.

Anotações personalizadas

As anotações são mapas de chaves/valores usados para anexar metadados a pods do Kubernetes. Pode criar anotações personalizadas para as seguintes propriedades de componentes híbridos indicadas na Referência de propriedades de configuração:

Para adicionar uma anotação de par de nome/valor personalizado, abra o ficheiro de substituições e adicione uma secção annotations para o componente respetivo. Em seguida, aplique a alteração com apigeectl. Por exemplo:

runtime:
  annotations:
    businessunit: "bu1"

Use execuções de teste para testar alterações de configuração

Pode usar a flag --dry-run com apigeectl para testar o ficheiro de configuração de substituições sem o aplicar realmente ao cluster. Esta opção é útil para depurar um problema de instalação, uma vez que mostra exatamente o que vai ser aplicado ao cluster.

No Apigee Hybrid, a sintaxe da flag --dry-run depende da versão do kubectl que está a executar. Verifique a versão do kubectl com o seguinte comando:

kubectl version

kubectl versão 1.17 e anteriores:

$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 ficheiros de substituições conforme necessário

Pode criar vários ficheiros de substituições, em que cada um cumpre um requisito específico. Por exemplo, pode ter um ficheiro de substituições que ajuste o cluster para produção e outro para criar um cluster para testes. Em seguida, pode manter estes ficheiros no seu sistema de controlo de origem.

Use o comando apigeectl apply para aplicar um ficheiro de substituições ao cluster. Por exemplo:

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

Elimine componentes de tempo de execução

O comando apigeectl delete fornece flags que lhe permitem eliminar todos ou um subconjunto dos componentes de tempo de execução híbrido instalados. Para ver detalhes sobre a utilização de comandos, consulte a página de referência apigeectl. Consulte também o artigo Desinstale o tempo de execução híbrido.

Elimine um ambiente

Para eliminar completamente um ambiente, tem de remover os planos de tempo de execução (local) e de gestão (nuvem). Para ver detalhes, consulte o artigo Elimine ambientes.