Faça a gestão de Secrets com o Secret Manager no Cloud Code para IntelliJ

Com a integração do Secret Manager do Cloud Code, pode criar, ver, atualizar e usar segredos no seu IDE e sem os ter na sua base de código.

Esta página descreve como aceder ao Secret Manager no seu IDE e como pode começar a criar e gerir segredos.

Ativar o Secret Manager

Quando gere segredos com o Cloud Code, os segredos são armazenados em segurança no Secret Manager e podem ser obtidos programaticamente quando precisar deles. Só precisa de ter a API Secret Manager ativada e as autorizações adequadas para gerir segredos:

  1. Para iniciar o Secret Manager, clique no separador Secret Manager na barra lateral do Cloud Code do lado direito.

    Separador Secret Manager no Cloud Code realçado na barra lateral direita e painel Secret Manager aberto com três segredos listados e os detalhes da versão do segredo "test" listados no painel inferior

  2. Se não tiver ativado a API Secret Manager, o Cloud Code pede-lhe que a ative no painel do Secret Manager clicando em Ativar API.

    O seu segredo também tem de estar no mesmo projeto que o código da aplicação. Certifique-se de que tem o projeto certo selecionado ou mude através do seletor de projetos no painel do Secret Manager.

    Ativar a associação à API disponível no painel do Secret Manager

Criar e ver secrets

Criar segredos

Pode criar um segredo com um dos seguintes métodos:

Usar o painel do Secret Manager

  1. Navegue para o painel do Gestor Secreto.

  2. Clique no ícone Adicionar.

    É apresentada uma caixa de diálogo Criar Secret onde pode definir o projeto, o nome e o valor do Secret, bem como escolher uma região para armazenar o Secret e etiquetas para organizar os seus Secrets.

    Caixa de diálogo Criar Secret aberta com o campo Nome preenchido como "life" e o campo Valor do Secret preenchido como "42"

Usar o editor

  1. Abra um ficheiro que contenha o texto que quer armazenar como segredo no editor.
  2. Realce e clique com o botão direito do rato neste texto.

    No menu, selecione o item de menu Create Secret in Secret Manager.... É apresentada a caixa de diálogo Criar Secret com o valor do Secret preenchido com o texto realçado. Pode personalizar o projeto, o nome, o valor, a região e as etiquetas do segredo aqui.

Usar o explorador de projetos

  1. No explorador de projetos, sem realçar texto, clique com o botão direito do rato.
  2. No menu, selecione o item de menu Create Secret in Secret Manager.... É apresentada a caixa de diálogo Criar segredo. Escolha o projeto, o nome, o valor, a região e as etiquetas do seu segredo aqui e clique em OK quando terminar.

Criar novas versões de segredos

Se tiver um segredo existente e quiser atualizá-lo, pode fazê-lo navegando para o separador Versões do painel do Secret Manager:

  1. Clique no ícone Adicionar no separador Versões.

    Esta ação inicia uma caixa de diálogo Adicionar nova versão, onde pode definir o valor do seu segredo existente através do campo Valor do segredo ou importando um ficheiro.

    Caixa de diálogo Adicionar uma nova versão aberta com o campo de valor do Secret para o Secret "test-secret" atualizado como "bar"

  2. Se preferir remover todas as versões anteriores do seu segredo e manter apenas a nova versão que está a ser criada, escolha Desativar todas as versões anteriores.

  3. Depois de clicar em OK e a versão ser adicionada, pode ver a versão mais recente do segredo e, se aplicável, todas as versões do segredo apresentadas no separador Versões.

Visualizar secrets

Para ver segredos, no painel do Secret Manager, selecione um segredo na lista apresentada na secção Nome do segredo. Os respetivos detalhes, como o nome, a política de replicação, a data/hora de criação e o ID do recurso, são apresentados no separador Vista geral.

Também pode clicar com o botão direito do rato no segredo e escolher Abrir na Cloud Console para ver e gerir o segredo no seu navegador.

Ver versões do Secret

Para ver as versões de um segredo, selecione um segredo na lista apresentada na secção Nome do segredo e selecione o separador Versões.

Clique com o botão direito do rato na versão do Secret sobre a qual quer realizar uma ação e escolha entre as opções disponíveis: ver o valor do Secret, copiar o ID da versão, ativar ou desativar a versão e destruir a versão selecionada.

O separador Versão está selecionado para o segredo "test" e as duas versões disponíveis, "2" e "3", estão tabeladas juntamente com a respetiva hora de criação. '3' é clicado com o botão direito do rato e é selecionada a opção "Ativar versão secreta"

Aceder a segredos a partir da sua aplicação

Depois de criar o segredo, pode incluí-lo no código e configurar a autenticação.

Separador Código do painel do Secret Manager com os passos necessários para aceder ao segredo no seu código

Para aceder ao segredo criado recentemente a partir da sua aplicação, siga estes passos:

  1. Instale a biblioteca cliente do Secret Manager.

    Navegue para Ferramentas > Cloud Code > Adicionar bibliotecas do Google Cloud e gerir APIs Google Cloud e selecione Secret Manager > API Secret Manager na árvore do explorador de APIs Google Cloud. Siga as instruções específicas do idioma descritas na secção Instale a biblioteca de cliente.

  2. Personalize e inclua o fragmento do código relevante no código da sua aplicação.

  3. Por último, para concluir a configuração da autenticação, tem de seguir o guia de autenticação das bibliotecas de cliente:

    • Desenvolvimento local: se estiver a desenvolver num cluster local (como o minikube ou o Docker Desktop) ou num emulador local, deve concluir os passos ilustrados na secção de desenvolvimento local relevantes para o seu fluxo de trabalho.
    • Desenvolvimento remoto: se estiver a usar um cluster do GKE ou um serviço do Cloud Run na sua aplicação, deve concluir os passos ilustrados na secção Desenvolvimento remoto relevante para o seu fluxo de trabalho, incluindo as instruções específicas do Secret Manager para configurar as funções necessárias na sua conta de serviço.

Obter apoio técnico

Para enviar feedback ou comunicar um problema no seu IDE IntelliJ, aceda a Tools > Cloud Code > Help / About > Submit feedback or report an issue para comunicar um problema no GitHub.