Como instalar com o complemento do GKE

Nesta página, descrevemos como instalar o Config Connector em um cluster do Google Kubernetes Engine (GKE) usando o complemento Config Connector.

Para detalhes sobre cada opção de instalação com vantagens e desvantagens, consulte Como escolher um tipo de instalação.

Antes de começar

Antes de começar, verifique se você realizou as tarefas a seguir:

• Ative a API Google Kubernetes Engine.
Ativar a API Google Kubernetes Engine
• Se você quiser usar a CLI do Google Cloud para essa tarefa, instale e, em seguida, inicialize a CLI gcloud. Se você instalou a gcloud CLI anteriormente, instale a versão mais recente executando gcloud components update.

• Selecione ou crie um Google Cloud projeto para instalar o Config Connector.

• Se você já instalou manualmente o Config Connector, desinstale-o antes de instalar o complemento:

  • Como desinstalar o modo de cluster
  • Como desinstalar o modo de namespace

Como instalar o complemento Config Connector

Use o complemento Config Connector criando um novo cluster do GKE ou ativando-o em um cluster existente. Depois de instalar o complemento Config Connector, configure a instalação com suas Contas de serviço do Google e seus namespaces.

Requisitos

Os requisitos do complemento Config Connector são os seguintes:

• Use uma versão do GKE de:

  • 1.15.11-gke.5 e superior
  • 1.16.8-gke.8 e superior
  • 1.17.4-gke.5 e superior

• É preciso ativar um pool de identidade da carga de trabalho e o Kubernetes Engine Monitoring nos clusters em que o Config Connector é ativado.

Como configurar um cluster do GKE

Use o complemento Config Connector em um cluster novo ou atual.

Como criar um novo cluster com o complemento Config Connector ativado

É possível criar um cluster do GKE usando a CLI gcloud ou o consoleGoogle Cloud .

gcloud container clusters create CLUSTER_NAME \
    --release-channel CHANNEL \
    --addons ConfigConnector \
    --workload-pool=PROJECT_ID.svc.id.goog \
    --logging=SYSTEM \
    --monitoring=SYSTEM

Depois de criar o cluster, acesse Como criar uma identidade.

Como ativar o complemento Config Connector em um cluster existente

É possível ativar o complemento Config Connector em um cluster do GKE atual com o gcloud ou o console Google Cloud .

Pré-requisitos

A ativação do complemento Config Connector em um cluster atual tem os seguintes pré-requisitos:

• Você precisa de um cluster que atenda aos requisitos do complemento Config Connector.

• Configure a federação de identidade da carga de trabalho do GKE no cluster em que você quer instalar o Config Connector.

Para ativar a federação de identidade da carga de trabalho para GKE em um pool de nós, use a ferramenta de linha de comando gcloud:

gcloud container node-pools update NODE_POOL \
    --workload-metadata=GKE_METADATA \
    --cluster CLUSTER_NAME

Substitua:

• NODE_POOL pelo nome do pool de nós;
• CLUSTER_NAME pelo nome do cluster.

Como ativar o complemento Config Connector.

É possível ativar o complemento Config Connector em um cluster do GKE com a Google Cloud CLI ou o console Google Cloud .

gcloud container clusters update CLUSTER_NAME \
    --update-addons ConfigConnector=ENABLED

Criar uma identidade

O Config Connector cria e gerencia recursos do Google Cloud usando a autenticação com uma conta de serviço do Identity and Access Management (IAM) e a federação de identidade da carga de trabalho para o GKE para vincular contas de serviço do IAM a contas de serviço do Kubernetes.

Para criar a identidade, conclua as etapas a seguir:

1. Crie uma conta de serviço do IAM. Se você quiser, poderá usar uma conta de serviço atual e pular esta etapa:

   gcloud iam service-accounts create SERVICE_ACCOUNT_NAME
   

   Substitua SERVICE_ACCOUNT_NAME por um nome para a conta de serviço.

   Para saber mais sobre como criar contas de serviço, consulte Como criar e gerenciar contas de serviço.

2. Conceda à conta de serviço do IAM permissões elevadas no projeto:

   gcloud projects add-iam-policy-binding PROJECT_ID \
     --member="serviceAccount:SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com" \
     --role="roles/editor"
   

   Substitua PROJECT_ID pela ID do seu projeto.

3. Crie uma vinculação de política do IAM entre a conta de serviço do IAM e a conta de serviço predefinida do Kubernetes que o Config Connector executa:

   gcloud iam service-accounts add-iam-policy-binding \
   SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com \
     --member="serviceAccount:PROJECT_ID.svc.id.goog[cnrm-system/cnrm-controller-manager]" \
     --role="roles/iam.workloadIdentityUser"
   

Como configurar o Config Connector

Para concluir a instalação, crie um arquivo de configuração para o CustomResource ConfigConnector e, em seguida, aplique-o usando o comando kubectl apply. O operador do Config Connector instala CRDs de recursosGoogle Cloud e componentes do Config Connector no cluster.

Para configurar o operador como modo de cluster, siga estas etapas:

1. Copie o seguinte arquivo YAML para um arquivo chamado configconnector.yaml:

   # configconnector.yaml
   apiVersion: core.cnrm.cloud.google.com/v1beta1
   kind: ConfigConnector
   metadata:
     # the name is restricted to ensure that there is only one
     # ConfigConnector resource installed in your cluster
     name: configconnector.core.cnrm.cloud.google.com
   spec:
     mode: cluster
     googleServiceAccount: "SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com"
     # Setting `stateIntoSpec` to `Absent` is recommended. It means setting `cnrm.cloud.google.com/state-into-spec`
     # annotation to `absent` for all Config Connector resources created in the cluster in the future.
     # It prevents Config Connector from populating unspecified fields into the spec.
     stateIntoSpec: Absent

   Substitua:
   • SERVICE_ACCOUNT_NAME pelo nome da conta de serviço.
   • PROJECT_ID pelo código do projeto;
2. Aplique a configuração ao cluster com kubectl apply:

     kubectl apply -f configconnector.yaml

Como especificar o local para criar os recursos

O Config Connector pode organizar recursos por projeto, pasta ou organização, da mesma forma que você organizaria recursos com Google Cloud.

Antes de criar recursos com o Config Connector, você precisa configurar onde criar seus recursos. Para determinar onde criar o recurso, o Config Connector usa uma anotação na configuração do recurso ou em um namespace atual. Para mais informações, consulte Como organizando recursos.

kubectl create namespace NAMESPACE

Substitua NAMESPACE pelo nome do namespace. Por exemplo: config-connector.

Selecione uma guia para escolher onde quer que o Config Connector crie recursos.

    kubectl annotate namespace \
    NAMESPACE cnrm.cloud.google.com/project-id=PROJECT_ID

    kubectl annotate namespace \
    NAMESPACE cnrm.cloud.google.com/folder-id=FOLDER_ID

    kubectl annotate namespace \
    NAMESPACE cnrm.cloud.google.com/organization-id=ORGANIZATION_ID

Quando você anota o namespace, o Config Connector cria recursos no projeto, na pasta ou na organização correspondente. Para saber mais sobre como o Config Connector usa namespaces do Kubernetes, consulte Namespaces do Kubernetes e projetos do Google Cloud .

Como verificar a instalação

Todos os componentes do Config Connector são executados em um namespace chamado cnrm-system. Para verificar se os pods estão prontos, execute o comando a seguir:

kubectl wait -n cnrm-system \
      --for=condition=Ready pod --all

Se o Config Connector estiver instalado corretamente, o resultado será semelhante a este:

pod/cnrm-controller-manager-0 condition met

Como fazer upgrade do Config Connector

Os upgrades do complemento Config Connector do cluster são gerenciados pelo Google Cloud.

Os recursos do cluster são preservados sempre que ocorre um upgrade.

Leia sobre como o Google Cloud gerencia upgrades de complementos do Config Connector ou pule para como acessar a versão mais recente do Config Connector.

Como o Google Cloud gerencia upgrades do complemento Config Connector

A versão do Config Connector que um cluster do GKE recebe depende inteiramente da versão secundária do GKE do cluster. Exemplo:

À medida que as versões se qualificam, Google Cloud remapeia as versões secundárias mais recentes do GKE para uma versão recém-lançada do Config Connector. Isso é feito para todas as versões secundárias do GKE que são novas o suficiente para não estarem disponíveis nos canais de lançamento Regular ou Stable.

Como a versão do Config Connector que um cluster recebe depende da versão secundária do GKE dele, há dois casos em que o complemento do Config Connector de um cluster é atualizado automaticamente pelo Google Cloud:

1. O cluster é atualizado para uma nova versão secundária do GKE que é mapeada para uma versão mais recente do Config Connector.

2. O cluster está em uma versão secundária do GKE nova o suficiente para não estar disponível nos canais de lançamento Regular ou Stable, eGoogle Cloud remapeia essa versão secundária do GKE para uma nova versão do Config Connector.

Quando o Google Cloud re-mapeia uma versão secundária do GKE e faz upgrade de clusters atuais para uma nova versão do Config Connector, dizemos que ele está "lançando uma nova versão do Config Connector" para essa versão secundária do GKE.

Google Cloud não lança novas versões do Config Connector para versões secundárias do GKE antigas o suficiente para estarem disponíveis nos canais de lançamento Regular ou Stable por motivos de estabilidade, exceto em situações de emergência em que um problema generalizado foi detectado.

Como conseguir a versão mais recente do Config Connector

A versão do Config Connector instalada pelo complemento costuma estar até 12 meses ou mais desatualizada. Se você precisar da versão mais recente do Config Connector, recomendamos mudar para o Config Controller ou instalar manualmente o Config Connector e fazer os upgrades por conta própria. As instruções de migração para cada opção são:

• Para mudar para o Config Controller, siga as instruções de migração do Config Controller para migrar os recursos atuais do Config Connector para uma instância do Config Controller.

• Para instalar manualmente o Config Connector, siga as instruções para mudar do complemento do Config Connector para a instalação manual.

Como desinstalar o Config Connector

Para desinstalar o Config Connector, siga estas etapas:

1. Use kubectl delete para remover as CRDs do Config Connector e os componentes do controlador:

   kubectl delete ConfigConnector configconnector.core.cnrm.cloud.google.com --wait=true
   

2. Desative o complemento Config Connector no cluster usando a CLI gcloud ou o console Google Cloud :

   gcloud

   Para desativar o complemento Config Connector com gcloud, execute o seguinte comando:

   gcloud container clusters update CLUSTER_NAME --update-addons ConfigConnector=DISABLED
   

   Substitua CLUSTER_NAME pelo nome do cluster que tem o complemento Config Connector instalado.

   Console do Cloud

   Para desativar o complemento Config Connector no console Google Cloud , siga estas etapas.

   1. Acesse a página "Clusters" do Google Kubernetes Engine no console Google Cloud e selecione o cluster que você quer atualizar.

      Acesse o menu do Google Kubernetes Engine

   2. Clique em Edit. A tela Editar clusters é exibida.

   3. Clique em Complementos.

   4. Selecione Config Connector e escolha Desativado.

   5. Clique em Salvar para atualizar seu cluster.

A seguir

• Introdução ao Config Connector.
• Saiba como resolver problemas do Config Connector.