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

O Config Sync sincroniza as configurações do Kubernetes com os clusters. Este documento explica 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 GitOps ferramentas para centralizar o gerenciamento de configurações das equipes. Para saber mais sobre papéis comuns e exemplos de tarefas referenciados no Google Cloud content, 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 os clusters, o Config Sync exige acesso somente leitura ao repositório. Para autorizar o Config Sync a ler as 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 os clusters.

  • Se o repositório Git for público, nenhuma outra ação será necessária. 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 tiver seguido 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. Os clusters são registrados automaticamente em uma frota quando você instala 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 padrão 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 repositório Git com os clusters registrados, siga estas etapas:

Console

Se você usar o Google Cloud console, primeiro instale o Config Sync nos clusters e, em seguida, configure um pacote que permita que o Config Sync seja sincronizado com o repositório Git.

Instalar o Config Sync

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

    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, selecione o cluster em que você quer implantar um pacote e clique em Continuar.

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

  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: analise 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 Google Cloud console fornece instruções incorporadas para ajudar você a configurar as configuraçõ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ê usar 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 exemplo de manifesto 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 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 a marca de comentário e substitua esse campo se precisar sincronizar de um local diferente de HEAD.

      Para repositórios particulares, é possível mudar o campo secretType para um método de autenticação compatível. Uma conta de serviço do Google (gcpserviceaccount) com o Secure Source Manager é geralmente recomendada. Como alternativa, use ssh, porque ele funciona com a maioria dos provedores do Git. Para instruções mais detalhadas sobre 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 quando registrou 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.

Console

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

    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 o status 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