Instalar o Config Sync com as configurações padrão

O Config Sync sincroniza as configurações do Kubernetes com os clusters. Neste documento, explicamos como ativar e configurar o Config Sync usando as configurações padrão. Ele se concentra na sincronização de configurações de um repositório Git não estruturado.

Esta página é destinada a operadores que querem implementar ferramentas de GitOps para centralizar o gerenciamento de configuração das equipes. Para saber mais sobre papéis comuns e exemplos de tarefas que mencionamos no conteúdo do Google Cloud , consulte Tarefas e funções de usuário comuns do GKE.

Para instruções sobre como instalar o Config Sync com configurações avançadas, consulte Personalizar a instalação do Config Sync.

Antes de começar

Antes de instalar o Config Sync, prepare o repositório Git e os clusters do GKE.

Criar um repositório Git e conceder acesso ao Config Sync

Para sincronizar a configuração de um repositório Git com seus clusters, o Config Sync precisa de acesso somente leitura ao repositório. Para autorizar o Config Sync a ler suas configurações, siga estas etapas:

  • Crie ou tenha acesso a um repositório Git que contenha os arquivos de configuração que você quer que o Config Sync sincronize com seus clusters.

  • Se o repositório Git for público, não será necessário fazer mais nada. O Config Sync não exige permissões extras.

  • Se o repositório Git for particular, siga as instruções em Conceder acesso do Config Sync ao Git.

Criar um cluster

Se você já tiver um cluster preparado, por exemplo, se seguiu as etapas para Conceder acesso do Config Sync ao Git, prossiga para Instalar o Config Sync.

O Config Sync exige que os clusters estejam registrados em uma frota. Para registrar seus clusters, siga esta etapa:

Console

Você não precisa fazer nada. Seus clusters são registrados automaticamente em uma frota ao instalar o Config Sync.

gcloud

  • Para criar um cluster do Autopilot registrado em uma frota, execute o seguinte comando:

    gcloud container clusters create-auto CLUSTER_NAME --enable-fleet

  • Para criar um cluster Standard registrado em uma frota, execute o seguinte comando:

    gcloud container clusters create CLUSTER_NAME --enable-fleet \
    --workload-pool=PROJECT_ID.svc.id.goog

Substitua:

  • CLUSTER_NAME: o nome do cluster.
  • PROJECT_ID: o ID do projeto.

Para mais informações sobre o registro de clusters, consulte Registrar um cluster em uma frota.

Instalar o Config Sync

Para ativar e configurar o Config Sync para sincronizar configurações do seu repositório Git com os clusters registrados, siga estas etapas:

Console

Se você usa o console do Google Cloud , primeiro instale o Config Sync nos seus clusters e depois configure um pacote que permita que o Config Sync sincronize do seu repositório Git.

Instalar o Config Sync

  1. Acesse a página Config Sync no console do Google Cloud .

    Acessar a configuração

  2. Clique em Instalar o Config Sync.

  3. Selecione Instalar em todos os clusters da frota.

  4. Não altere as outras configurações.

  5. Clique em Instalar o Config Sync.

Na guia Configurações, após alguns minutos, a mensagem Ativado vai aparecer na coluna Status dos clusters na sua frota.

Implantar um pacote

  1. Clique em Implantar pacote de cluster.

  2. Na guia Selecionar clusters, escolha o cluster em que você quer implantar um pacote e clique em Continuar.

  3. Clique na guia Configurar pacote e insira um nome para ele.

  4. Na seção Origem, faça o seguinte:

    1. No campo URL do repositório, insira o URL do repositório Git.

    2. Opcional: revise e atualize as outras configurações de campo. Talvez não seja necessário atualizar essas configurações, dependendo da estrutura do repositório.

  5. Opcional: se o repositório for particular, expanda a seção Configurações avançadas para configurar o método de autenticação. O console do Google Cloud fornece instruções incorporadas para ajudar você a configurar as definições de autenticação.

  6. Não altere as outras configurações.

  7. Clique em Implantar pacote.

Você será redirecionado para a página Pacotes do Config Sync. Após alguns minutos, a mensagem Sincronizado vai aparecer na coluna Status da sincronização do cluster configurado.

gcloud

Se você usa a CLI gcloud, instale o Config Sync criando um manifesto que contenha as configurações do Config Sync e aplicando essas configurações ao cluster.

  1. Ative o recurso de frota ConfigManagement:

    gcloud beta container fleet config-management enable

  2. Crie um manifesto chamado apply-spec.yaml. Este manifesto de exemplo contém as configurações padrão recomendadas:

    applySpecVersion: 1
spec:
  configSync:
    enabled: true
    sourceFormat: unstructured
    syncRepo: REPO_URL
    # syncRev: REVISION
    secretType: none
    preventDrift: false

    Substitua:

    • REPO_URL: o URL do seu repositório Git, por exemplo, https://github.com/GoogleCloudPlatform/anthos-config-management-samples.

    • (Opcional) REVISION: a revisão do Git (tag ou hash) ou a ramificação que você quer sincronizar. Remova o comentário e substitua esse campo se precisar sincronizar de um local diferente de HEAD.

      Para repositórios particulares, você pode mudar o campo secretType para um método de autenticação compatível. Em geral, é recomendável usar uma conta de serviço do Google (gcpserviceaccount) com o Secure Source Manager. Como alternativa, use ssh, que funciona com a maioria dos provedores do Git. Para instruções mais detalhadas sobre os métodos de autenticação compatíveis, consulte Conceder acesso ao Git.

  3. Aplique o manifesto ao cluster:

    gcloud beta container fleet config-management apply \
    --membership=MEMBERSHIP_NAME \
    --config=apply-spec.yaml \
    --project=PROJECT_ID

    Substitua:

    • MEMBERSHIP_NAME: o nome da assinatura da frota que você escolheu ao registrar o cluster. Encontre o nome com o comando gcloud container fleet memberships list.
    • PROJECT_ID: o ID do projeto.

Verifique a instalação

Depois de instalar e configurar o Config Sync, verifique se a instalação foi concluída com sucesso.

Console

  1. Acesse a página Config Sync no console do Google Cloud .

    Acessar o Config Sync

  2. Na guia Pacotes, verifique a coluna Status da sincronização na tabela de clusters. Uma instalação bem-sucedida do Config Sync mostra o status Instalado. Um repositório Git configurado com sucesso mostra o status Sincronizado.

gcloud

Execute este comando:

nomos status

Uma instalação bem-sucedida mostra um status de SYNCED ou PENDING.

Para mais detalhes sobre as informações fornecidas pelo comando nomos status, incluindo erros informados, consulte Verificar o status do Config Sync na documentação da ferramenta de linha de comando nomos.

A seguir