Autenticando Terraform para Gerenciar Clusters Kubernetes

Esta seção orienta os usuários sobre como criar e gerenciar API Keys necessárias para a integração do Terraform com Clusters Kubernetes na Magalu Cloud.

Pré-requisitos

• Ter uma conta criada na Magalu Cloud.
• Ter acesso ao ID Magalu para gerenciamento de API Keys.

Criando uma API Key

Para criar uma API Key, siga o guia detalhado disponível na documentação oficial.

Escopos Necessários para Integração com Terraform

Ao criar uma API Key para gerenciar Clusters Kubernetes via Terraform, é necessário selecionar os escopos corretos. Os escopos definem quais permissões a API Key terá para interagir com os serviços da Magalu Cloud.

Escopos do Produto de Kubernetes

Escopo	Descrição
mke.write	Permissão para criação de recursos do produto de Kubernetes (Clusters, Node Pools, etc)
mke.read	Permissão para leitura de recursos do produto de Kubernetes

Escopos ID Magalu

Escopo	Descrição
pa:accounts-business:update	Permissão para atualizar organização
pa:whoami:read	Ler informações adicionais da conta
pa:sa:manage	Gerenciar Service Account
pa:tenants:read	Leitura de Tenants

Selecionando os Escopos

Durante a criação da API Key, certifique-se de selecionar todos os escopos listados acima para garantir o funcionamento completo da integração com Terraform.

🖥️ Console

1. Acesse o ID Magalu

2. Clique em "Criar API Key"

3. Defina um nome para a API Key (ex: terraform-kubernetes)

4. Selecione o período de expiração desejado

5. Na lista de escopos, selecione:

   MKE:

   • Permissão para criação de mke
   • Permissão para leitura de mke

   ID Magalu:

   • Permissão para atualizar organização
   • Ler informações adicionais da conta
   • Manage Service Account
   • Leitura de Tenants

6. Clique em "Criar"

7. Copie e armazene a API Key em um local seguro

>_ CLI

1. Execute o comando para criar a API Key com todos os escopos necessários:

mgc auth api-key create \
  --name="terraform-kubernetes" \
  --description "API Key para gerenciamento de Kubernetes via Terraform" \
  --expiration "2025-12-31" \
  --scopes '["mke.read", "mke.write", "pa:accounts-business:update", "pa:whoami:read", "pa:sa:manage", "pa:tenants:read"]'

2. O retorno será similar a:

uuid: f4b2345c-xxxx-xxxx-xxxx-xxxxxxxxxxxx

3. Após a criação, consulte a API Key gerada:

mgc auth api-key get <uuid-da-api-key>

Importante

Mantenha sua API Key em sigilo para evitar acessos não autorizados. Nunca compartilhe ou exponha sua API Key em repositórios públicos ou logs.

Atualização de API Keys Existentes

Atenção - Novos Escopos Obrigatórios

Recentemente foram adicionados novos escopos obrigatórios para a integração do Terraform com Kubernetes. Se você já possui API Keys criadas anteriormente, é necessário revisá-las para verificar se incluem os seguintes escopos:

• pa:tenants:read - Leitura de Tenants
• pa:whoami:read - Ler informações adicionais da conta
• pa:accounts-business:update - Permissão para atualizar organização

API Keys que não possuem esses escopos podem apresentar falhas na criação de Cluster Kubernetes com o Terraform.

Importante

Não é possível editar os escopos de uma API Key existente. Caso sua API Key não possua todos os escopos necessários, você deverá criar uma nova API Key com os escopos corretos e substituir a anterior nas suas configurações do Terraform.

Configurando o Terraform

Após criar a API Key com os escopos corretos, configure-a no Terraform seguindo a documentação oficial.