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 do GKE.
Para detalhes sobre cada opção de instalação com as vantagens e desvantagens, consulte Como escolher um tipo de instalação.
Instale o Config Connector manualmente em vez de usar o complemento. O complemento está vinculado à versão secundária do GKE do cluster, por isso, é possível que ele não tenha as versões mais recentes do Config Connector em 12 meses ou mais. Se você já usa o complemento, pode mudar para uma instalação manual.
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
- Para usar a Google Cloud CLI nesta tarefa,
instale e
inicialize a
CLI gcloud. Se você instalou a CLI gcloud anteriormente, instale a versão mais recente executando o comando
gcloud components update. Talvez as versões anteriores da CLI gcloud não sejam compatíveis com a execução dos comandos neste documento.
Selecione ou crie um projeto do Google Cloud para instalar o Config Connector.
Se você já tiver instalado o Config Connector manualmente, desinstale-o antes de instalar o complemento do Config Connector:
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 você ativa o Config Connector.
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 console doGoogle Cloud .
gcloud
Para criar um cluster com a Google Cloud CLI, execute o seguinte comando:
gcloud container clusters create CLUSTER_NAME \
--release-channel CHANNEL \
--addons ConfigConnector \
--workload-pool=PROJECT_ID.svc.id.goog \
--logging=SYSTEM \
--monitoring=SYSTEM
Substitua:
- CLUSTER_NAME pelo nome do cluster do GKE.
- CHANNEL com um
canal de lançamento do GKE,
rapideregularsão compatíveis. - PROJECT_ID pelo ID do projeto do Google Cloud .
Console do Google Cloud
Para criar um cluster com o console do Google Cloud , siga estas etapas:
No console do Google Cloud , acesse a página Criar um cluster do Kubernetes.
Na seção Noções básicas do cluster, especifique um Nome e um local para o cluster.
No painel de navegação, clique em Configurações avançadas.
Na linha Identidade da carga de trabalho, clique em edit Editar configuração, marque a caixa de seleção Ativar Identidade da carga de trabalho e clique em Salvar.
Na linha Config Connector, marque a caixa de seleção Ativação rápida.
Opcional: configure o restante do cluster conforme necessário.
Clique em Criar.
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 do Config Connector em um cluster do GKE
com gcloud ou o console do 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 para GKE no cluster em que você quer instalar o Config Connector.
Para ativar a Federação de Identidade da Carga de Trabalho para GKE para 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 do Config Connector em um cluster do GKE com a Google Cloud CLI ou o console do Google Cloud .
gcloud
Para ativar o complemento do Config Connector em um cluster do GKE, use a Google Cloud CLI:
gcloud container clusters update CLUSTER_NAME \
--update-addons ConfigConnector=ENABLED
Substitua CLUSTER_NAME pelo nome do cluster do GKE.
Console do Google Cloud
Acesse o menu do Google Kubernetes Engine no console do Google Cloud .
Selecione o cluster em que você quer instalar o Config Connector. A página Detalhes do cluster é exibida.
Na seção Recursos, localize a linha do Config Connector e clique em Editar.
Marque a caixa de seleção Ativar o Config Connector e clique em Salvar alterações para atualizar o cluster.
Criar uma identidade
O Config Connector cria e gerencia recursos do Google Cloud ao se autenticar com uma conta de serviço do Identity and Access Management (IAM) e usar a federação de identidade da carga de trabalho para GKE para vincular contas de serviço do IAM a contas de serviço do Kubernetes.
O Config Connector não gerencia recursos até que você configure o modo com namespace ou o modo de cluster. Para a maioria dos casos de uso, use o modo com namespace. Siga as etapas do modo escolhido:
- Para usar o modo de namespace, pule esta seção e a seção
Como configurar o Config Connector. O complemento
já instalou o operador e criou um objeto
ConfigConnectorno modo de namespace. Para cada namespace, conclua as etapas em Instalar o Config Connector no modo de namespace e volte para Especificar onde criar os recursos. - Para usar o modo de cluster, conclua as etapas desta seção e da seção Como configurar o Config Connector. Você só precisa concluir essas etapas uma vez para cada cluster.
Para criar a identidade, conclua as etapas a seguir:
Crie uma conta de serviço do IAM. Se você quiser usar uma conta de serviço atual, pule esta etapa:
gcloud iam service-accounts create SERVICE_ACCOUNT_NAMESubstitua 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.
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 pelo ID do projeto.
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 recursos doGoogle Cloud e componentes do Config Connector no cluster.
Para configurar o operador como modo de cluster, siga estas etapas:
-
Copie o seguinte arquivo YAML para um arquivo chamado
configconnector.yaml: Substitua:# 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
SERVICE_ACCOUNT_NAMEpelo nome da conta de serviço.PROJECT_IDpelo ID do projeto.
-
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 o 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.
Se você não tiver um namespace para essa finalidade, crie um comkubectl.
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.
Projeto
Para criar recursos em determinado projeto, execute o seguinte comando:
kubectl annotate namespace \ NAMESPACE cnrm.cloud.google.com/project-id=PROJECT_ID
Substitua:
NAMESPACEpelo nome do namespace;PROJECT_IDpelo ID do projeto do Google Cloud .
Pasta
Para criar recursos em determinada pasta, execute o seguinte comando:
kubectl annotate namespace \ NAMESPACE cnrm.cloud.google.com/folder-id=FOLDER_ID
Substitua:
NAMESPACEpelo nome do namespace;FOLDER_IDpelo ID da pasta do Google Cloud .
Organização
Para criar recursos em determinada organização, execute o seguinte comando:
kubectl annotate namespace \ NAMESPACE cnrm.cloud.google.com/organization-id=ORGANIZATION_ID
Substitua:
NAMESPACEpelo nome do namespace;ORGANIZATION_IDpelo ID da organização do Google Cloud .
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 no cluster são preservados sempre que ocorre um upgrade.
Leia sobre como o Google Cloud gerencia os upgrades do complemento do Config Connector ou pule para como receber a versão mais recente do Config Connector.
Como o Google Cloud gerencia upgrades do complemento do Config Connector
A versão do Config Connector que um cluster do GKE recebe depende totalmente da versão secundária do GKE do cluster. Exemplo:
| Versão secundária do GKE | Versão do Config Connector |
|---|---|
| 1.20 | 1.69.0 |
| 1.21 | 1.69.0 |
| 1.22 | 1.71.0 |
| 1.23 | 1.82.0 |
| 1.24 | 1.89.0 |
À medida que as versões se qualificam, o 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 do cluster, há dois casos em que o complemento do Config Connector de um cluster é atualizado automaticamente pelo Google Cloud:
O cluster é atualizado para uma nova versão secundária do GKE que é mapeada para uma versão mais recente do Config Connector.
O cluster está em uma versão secundária do GKE que é nova o suficiente para não estar disponível nos canais de lançamento Regular ou Stable, e o Google Cloud remapeia essa versão secundária do GKE para uma nova versão do Config Connector.
Quando o Google Cloud remapeia uma versão secundária do GKE e faz upgrade dos 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.
OGoogle Cloud não lança novas versões do Config Connector para versões secundárias do GKE que são antigas o suficiente para estarem disponíveis nas versões dos 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 acessar a versão mais recente do Config Connector
Para garantir que você tenha a versão mais atualizada do Config Connector, recomendamos instalar manualmente o Config Connector e fazer upgrade. A instalação manual oferece controle direto sobre a versão e permite que você use os recursos e as correções mais recentes assim que estiverem disponíveis.
Para mudar do complemento do Config Connector para a instalação manual, siga as instruções para mudar do complemento do Config Connector para a instalação manual.
O complemento está vinculado à versão secundária do GKE do cluster e pode não ter as versões mais recentes do Config Connector em 12 meses ou mais. Embora o Config Controller seja mais atual do que o complemento, ele ainda pode ficar atrás da versão mais recente em comparação com a instalação manual.
Como desinstalar o Config Connector
Para desinstalar o Config Connector, siga estas etapas:
Use
kubectl deletepara remover as CRDs do Config Connector e os componentes do controlador:kubectl delete ConfigConnector configconnector.core.cnrm.cloud.google.com --wait=trueDesative o complemento do Config Connector no cluster usando a CLI gcloud ou o console do Google Cloud :
gcloud
Para desativar o complemento Config Connector com
gcloud, execute o seguinte comando:gcloud container clusters update CLUSTER_NAME --update-addons ConfigConnector=DISABLEDSubstitua CLUSTER_NAME pelo nome do cluster que tem o complemento Config Connector instalado.
Console do Cloud
Para desativar o complemento do Config Connector no console do Google Cloud , siga as etapas abaixo.
Acesse a página "Clusters" do Google Kubernetes Engine no console do Google Cloud e selecione o cluster que você quer atualizar.
Clique em Edit. A tela Editar clusters é exibida.
Clique em Complementos.
Selecione Config Connector e escolha Desativado.
Clique em Salvar para atualizar seu cluster.
A seguir
- Introdução ao Config Connector.
- Saiba como resolver problemas do Config Connector.