Configurar um cluster a ser gerenciado pela API GKE On-Prem

A API GKE On-Prem permite gerenciar os ciclos de vida dos clusters locais usando o console doGoogle Cloud , a Google Cloud CLI ou o Terraform. Quando você cria um cluster com essas ferramentas, a API armazena os metadados do cluster na região do Google Cloud escolhida. Se você criar clusters com gkectl, será necessário registrá-los na API GKE On-Prem para conferir detalhes e gerenciar os ciclos de vida deles por meio dessas interfaces.

O registro de um cluster é separado do registro dele em uma frota. Todos os clusters do Google Distributed Cloud são registrados automaticamente em um projeto host de frota no momento da criação. No console do Google Cloud , os clusters registrados gerenciados pela API GKE On-Prem aparecem como VMware na coluna Tipo, enquanto os clusters não registrados aparecem como Externo.

Ver clusters registrados

Todos os clusters da frota são exibidos nas páginas Clusters do GKE no console. Isso oferece uma visão geral de toda a frota e, para o Google Distributed Cloud, permite ver quais clusters são gerenciados pela API GKE On-Prem.

Para ver os clusters da frota:

  1. No console, acesse a página clusters do GKE.
    Acesse os clusters do GKE
  2. Selecione o projeto Google Cloud .
    • Se VMware for exibido na coluna Tipo, o cluster será gerenciado pela API GKE On-Prem.
    • Se Externo for exibido na coluna Tipo, o cluster não vai ser gerenciado pela API GKE On-Prem.

Requisitos

  • Os clusters de usuário precisam ser da versão 1.11 ou mais recente.

  • Os clusters de administrador precisam ser da versão 1.13 ou mais recente.

  • Se você não for proprietário de um projeto, precisa receber, no mínimo, o papel roles/gkeonprem.admin do Identity and Access Management. Para ver detalhes sobre as permissões incluídas nesse papel, consulte Papéis do GKE On-Prem na documentação do IAM.

Antes de começar

  1. Configure a CLI gcloud, se necessário.

    1. Se você precisar instalar a CLI da gcloud, consulte a documentação da CLI da gcloud.

    2. Atualize os componentes da CLI gcloud, se necessário:

      gcloud components update

  2. Siga estas etapas para ativar e usar a API GKE On-Prem:

    1. Ative a API no projeto:

      gcloud services enable \
    --project PROJECT_ID \
    gkeonprem.googleapis.com

      Substitua PROJECT_ID pelo ID do projeto host da frota. Este é o ID do projeto que foi configurado na seção gkeconnect do arquivo de configuração do cluster de administrador ou no arquivo de configuração do cluster de usuário.

      Se você receber um erro PERMISSION_DENIED, verifique novamente o ID do projeto inserido. Se o ID do projeto estiver correto, execute gcloud auth login para fazer login na Google Cloud CLI com a conta que tem acesso ao projeto.

    2. Se esta for a primeira vez que você ativa a API GKE On-Prem no seu projeto, será necessário inicializar a API. Para fazer isso, chame um comando da CLI gcloud que exibe as versões disponíveis que podem ser usadas para criar um cluster:

      gcloud container vmware clusters query-version-config \
    --project=PROJECT_ID \
    --location=REGION

      Substitua REGION por us-west1 ou outra região compatível.

  3. Se a organização tiver configurado uma lista de permissões que permita o tráfego do Google APIs e de outros endereços pelo servidor proxy, adicione o seguinte à lista de permissões:

    • gkeonprem.googleapis.com
    • gkeonprem.mtls.googleapis.com

    Esses são os nomes de serviço da API GKE On-Prem.

Registrar um cluster de usuário

CLI da gcloud

  1. Liste as assinaturas de frota dos clusters registrados:

    gcloud container fleet memberships list \
    --project=PROJECT_ID

    Substitua PROJECT_ID pelo ID do projeto host da frota.

    Anote a região em que o cluster de administrador que gerencia o cluster de usuário é membro, porque você vai precisar disso na próxima etapa.

  2. Registre o cluster na API GKE On-Prem:

    gcloud container vmware clusters enroll USER_CLUSTER_NAME \
    --project=<var>PROJECT_ID</var> \
    --admin-cluster-membership=projects/PROJECT_ID/locations/MEMBERSHIP_REGION/memberships/ADMIN_CLUSTER_NAME \
    --location=REGION

    Substitua:

    • USER_CLUSTER_NAME: o nome do cluster de usuário que você quer registrar.

    • PROJECT_ID: o ID do projeto host da frota.

    • MEMBERSHIP_REGION: a região em que o cluster de administrador que gerencia o cluster de usuário é membro. Pode ser global ou uma região do Google Cloud .

    • ADMIN_CLUSTER_NAME: o nome do cluster de administrador que gerencia o cluster de usuário.

      ADMIN_CLUSTER_NAME, MEMBERSHIP_REGION e PROJECT_ID formam o nome do cluster totalmente especificado para a flag --admin-cluster-membership.

    • REGION: a região do Google Cloud em que a API GKE On-Prem é executada e armazena os metadados do cluster. Especifique us-west1 ou outra região com disponibilidade. Após o registro do cluster, não é possível alterar a região.

gkectl

Execute as etapas a seguir na estação de trabalho do administrador.

  1. Adicione a seguinte seção ao arquivo de configuração do cluster de administrador:

    gkeOnPremAPI:
  enabled:true
  location:REGION

    Substitua REGION pela região do Google Cloud em que a API GKE On-Prem executa e armazena metadados do cluster. Especifique us-west1 ou outra região com disponibilidade. Após o registro do cluster, não é possível alterar a região.

  2. Atualize o cluster:

    gkectl update cluster --kubeconfig ADMIN_CLUSTER_KUBECONFIG --config USER_CLUSTER_CONFIG_FILE

    Substitua:

    • ADMIN_CLUSTER_KUBECONFIG: o caminho do arquivo kubeconfig do cluster de administrador

    • USER_CLUSTER_CONFIG_FILE: o caminho do arquivo de configuração do cluster de usuário.

Registrar um cluster de administrador

CLI da gcloud

  1. Liste as assinaturas de frota dos clusters registrados:

    gcloud container fleet memberships list \
    --project=PROJECT_ID

    Substitua PROJECT_ID pelo ID do projeto host da frota.

    Anote a região em que o cluster de administrador é membro, porque você vai precisar dela na próxima etapa.

  2. Registre o cluster de administrador na API GKE On-Prem:

    gcloud container vmware admin-clusters enroll ADMIN_CLUSTER_NAME \
    --project=PROJECT_ID \
    --admin-cluster-membership=projects/PROJECT_ID/locations/MEMBERSHIP_REGION/memberships/ADMIN_CLUSTER_NAME \
    --location=REGION

Substitua:

  • ADMIN_CLUSTER_NAME: o nome do cluster de administrador que você quer registrar.

  • PROJECT_ID o ID do projeto host da frota.

  • MEMBERSHIP_REGION: a região em que o cluster de administrador é membro. Pode ser global ou uma região do Google Cloud .

    ADMIN_CLUSTER_NAME, MEMBERSHIP_REGION e PROJECT_ID formam o nome do cluster totalmente especificado para a flag --admin-cluster-membership.

  • REGION: a região do Google Cloud em que a API GKE On-Prem é executada e armazena os metadados do cluster. Especifique us-west1 ou outra região com disponibilidade. Recomendamos usar a mesma região configurada em stackdriver.clusterLocation no arquivo de configuração do cluster de administrador. Após o registro do cluster, não é possível alterar a região.

gkectl

Execute as etapas a seguir na estação de trabalho do administrador.

  1. Adicione a seguinte seção ao arquivo de configuração do cluster de administrador:

    gkeOnPremAPI:
  enabled:true
  location:REGION

    Substitua REGION pela região do Google Cloud em que a API GKE On-Prem executa e armazena metadados do cluster. Especifique us-west1 ou outra região com disponibilidade. Recomendamos usar a mesma região configurada em stackdriver.clusterLocation. Após o registro do cluster, não é possível alterar a região.

  2. Atualize o cluster:

    gkectl update admin --kubeconfig ADMIN_CLUSTER_KUBECONFIG --config ADMIN_CLUSTER_CONFIG_FILE

    Substitua:

    • ADMIN_CLUSTER_KUBECONFIG: o caminho do arquivo kubeconfig do cluster de administrador

    • ADMIN_CLUSTER_CONFIG_FILE: o caminho do arquivo de configuração do cluster de administrador.

Receber informações sobre o cluster

Depois que o cluster for registrado, será possível usar os seguintes comandos para receber informações sobre os clusters:

Cluster de usuário

  • Para descrever um cluster de usuário:
gcloud container vmware clusters describe USER_CLUSTER_NAME \
  --project=PROJECT_ID \
  --location=REGION
  • Para listar os clusters de usuário:
gcloud container vmware clusters list \
  --project=PROJECT_ID \
  --location=-

Definir --location=- significa listar todos os clusters em todas as regiões. Se você precisar reduzir o escopo da lista, defina --location como a região especificada ao registrar o cluster.

Cluster de administrador

  • Para descrever um cluster de administrador:
gcloud container vmware admin-clusters describe ADMIN_CLUSTER_NAME \
  --project=PROJECT_ID \
  --location=REGION
  • Para listar os clusters de administrador:
gcloud container vmware admin-clusters list \
  --project=PROJECT_ID \
  --location=-

Definir --location=- significa listar todos os clusters em todas as regiões. Se você precisar reduzir o escopo da lista, defina --location como a região especificada ao registrar o cluster.

Conexão ao cluster

Depois que o cluster for registrado com a API GKE On-Prem, você precisará escolher e configurar um método de autenticação para gerenciar o cluster no console doGoogle Cloud . O método de autenticação selecionado também controla o acesso ao cluster pela linha de comando. Para ver mais informações, consulte os seguintes tópicos: