Use o painel de controlo do Config Sync

Esta página explica como usar o painel de controlo da sincronização de configuração.

Este painel de controlo oferece uma vista geral abrangente dos pacotes que o Config Sync gere e o estado dos recursos nestes pacotes.

Antes de começar

Autorizações de IAM

Para aceder ao painel de controlo do Config Sync, são necessárias as seguintes funções do IAM no projeto:

  • roles/container.clusterViewer
  • roles/gkehub.viewer

Controlo de acesso baseado em funções

O utilizador também precisa das autorizações relevantes do Kubernetes em cada cluster. Se não quiser conceder aos utilizadores autorizações extensivas, como as do administrador do cluster, pode criar uma função RBAC personalizada que inclua as autorizações mínimas necessárias para usar o painel de controlo do Config Sync.

O config-sync-dashboard-reader ClusterRole concede ao utilizador autorizações get e list nos recursos necessários ao painel de controlo.

  1. Para criar o config-sync-dashboard-reader ClusterRole e aplicá-lo ao cluster, execute o seguinte comando:

    cat <<EOF > config-sync-dashboard-reader.yaml
kind: ClusterRole
apiVersion: rbac.authorization.k8s.io/v1
metadata:
  name: config-sync-dashboard-reader
rules:
- apiGroups: ["apiextensions.k8s.io"]
  resources: ["customresourcedefinitions"]
  verbs: ["get", "list"]
- apiGroups: ["configmanagement.gke.io"]
  resources: ["configmanagements"]
  verbs: ["get", "list"]
- apiGroups: ["configsync.gke.io"]
  resources: ["rootsyncs", "reposyncs"]
  verbs: ["get", "list"]
- apiGroups: ["kpt.dev"]
  resources: ["resourcegroups"]
  verbs: ["get", "list"]
- apiGroups: ["apps"]
  resources: ["deployments"]
  verbs: ["get", "list"]
- apiGroups: [""]
  resources: ["pods", "services"]
  verbs: ["get", "list"]
- apiGroups: ["anthos.cloud.google.com"]
  resources: ["canonicalservices"]
  verbs: ["get", "list"]
- apiGroups: ["networking.istio.io"]
  resources: ["virtualservices"]
  verbs: ["get", "list"]

EOF
kubectl apply -f config-sync-dashboard-reader.yaml

  2. Siga as instruções para configurar o controlo de acesso baseado em funções nos clusters do Google Kubernetes Engine para configurar o ClusterRoleBinding.

Aceda ao painel de controlo

  1. Na Google Cloud consola, aceda à página Configuração na secção Funcionalidades.

    Aceda à configuração

  2. Selecione o projeto que quer ver.

Ver o painel de controlo

O separador Painel de controlo oferece uma vista geral do estado das suas instalações da sincronização de configuração:

  • O estado da conciliação mostra quantos pacotes foram conciliados. Um pacote é reconciliado se o estado pretendido, conforme expresso pelos recursos no pacote, tiver sido concretizado.

    Os seus pacotes podem ter os seguintes estados de conciliação:

    • Atual: o estado real do pacote corresponde ao estado pretendido. O processo de conciliação é considerado concluído até haver alterações ao estado pretendido ou ao estado real.
    • Em curso: o estado real do pacote ainda não atingiu o estado pretendido (conforme expresso pelos recursos no pacote). Normalmente, os pacotes recém-criados começam com este estado.
    • Falhou: o processo de conciliação do estado real com o estado que quer encontrou um erro ou não progrediu o suficiente.
    • Desconhecido: o Config Sync não conseguiu determinar o estado de conciliação de um pacote.

  • O Estado da sincronização mostra quantos pacotes estão sincronizados. Um pacote é sincronizado quando o estado observado mais recente do pacote na origem (por exemplo, um repositório Git) se reflete no cluster.

    Os seus pacotes podem ter os seguintes estados de sincronização:

    • Sincronizado: o pacote está sincronizado com um cluster.
    • Pendente: o pacote está com sincronização pendente.
    • Reconciliação: a implementação que sincroniza um pacote está a ser reconciliada.
    • Parado: a implementação que sincroniza um pacote está parada.
    • Erro: o pacote encontrou um erro durante a sincronização.
    • Desconhecido: o Config Sync não conseguiu determinar o estado de sincronização de um pacote.

  • O Estado da sincronização de configuração mostra o estado de instalação da sincronização de configuração nos seus clusters.

    Os seus clusters podem ter o seguinte estado relacionado com o Config Sync:

    • Ativado: clusters com o Config Sync ativado.
    • Não ativado: clusters que não têm o Config Sync ativado.
    • Pendente: clusters com o Config Sync ativado, mas que estão a sofrer alterações. Normalmente, este estado ocorre durante a configuração inicial ou quando atualiza para uma nova versão.
    • Erro: clusters com o Config Sync ativado, mas existe um problema e o Config Sync não está a funcionar.
    • Desconhecido: não é possível determinar o estado do Config Sync.

As tabelas adicionais mostram-lhe problemas agrupados por pacote e cluster, fornecem links para instalar o Config Sync e ver definições, bem como recursos para começar.

Veja o estado do pacote

O separador Pacotes permite-lhe ver detalhes detalhados sobre pacotes e clusters individuais. Use este separador para compreender melhor as potenciais causas dos erros de sincronização e dos recursos não íntegros.

Edite um pacote

Também pode usar o separador Pacotes para editar as configurações dos pacotes.

Para editar um pacote, conclua os seguintes passos:

  1. Junto ao nome do pacote que quer editar, selecione na coluna Editar pacote
  2. Na secção Detalhes do pacote, na lista pendente Tipo de origem, selecione o tipo de origem.

  3. Na secção Origem, conclua o seguinte:

    • Para origens alojadas num repositório Git, introduza os seguintes campos:

      1. Introduza o URL do repositório Git que está a usar como fonte de informação como o URL do repositório.
      2. Opcional: atualize o campo Revisão para verificar se não está a usar o HEAD predefinido.
      3. Opcional: atualize o campo Caminho se não quiser sincronizar a partir do repositório raiz.
      4. Opcional: atualize o campo Branch se não estiver a usar a ramificação main predefinida.

    • Para origens alojadas numa imagem OCI, introduza os seguintes campos:

      1. Introduza o URL da imagem OCI que está a usar como fonte de dados fidedignos como imagem.
      2. Introduza o caminho do diretório a partir do qual quer sincronizar, relativo ao diretório raiz, como o Directory.

  4. (Opcional): expanda a secção Definições avançadas para concluir o seguinte:

    1. Selecione um Tipo de autenticação:

      • Nenhuma: não use autenticação.
      • SSH: use um par de chaves SSH.
      • Cookiefile: use um cookiefile.
      • Token: use um token.
      • Google Cloud Repository: use uma conta de serviço Google para aceder a um repositório do Cloud Source Repositories. Selecione esta opção apenas se a Workload Identity Federation para o GKE não estiver ativada no seu cluster.
      • Workload Identity: use uma conta de serviço Google para aceder a um repositório do Cloud Source Repositories.

    2. Introduza um número em segundos para definir o Tempo de espera de sincronização, que determina quanto tempo o Config Sync espera entre a sincronização a partir da fonte de informação fidedigna.

    3. Introduza um URL de proxy Git para o proxy HTTPS a usar quando comunicar com a fonte de informações fidedignas.

    4. Escolha Hierarquia para alterar o Formato de origem.

      O valor predefinido Não estruturado é recomendado na maioria dos casos, uma vez que lhe permite organizar a sua fonte de dados fidedignos da forma que quiser.

  5. Quando terminar de editar o pacote, clique em Guardar.

    É feito o redirecionamento para a página Packages do Config Sync. Após alguns minutos, deve ver Sincronizado na coluna Estado da sincronização para o pacote que configurou.

Ver definições

O separador Definições mostra uma lista de clusters, juntamente com informações sobre as respetivas definições do Config Sync e definições da frota.

Também pode usar este separador para atualizar a sincronização de configuração num cluster:

  • Junto ao nome do cluster que quer atualizar, selecione o menu de contexto e, de seguida, selecione Editar configuração.

Para orientações sobre as definições do Config Sync, consulte o artigo Configure o Config Sync.

O que se segue?