Gerenciar secrets com o Secret Manager no Cloud Code para VS Code

Com a integração do Secret Manager do Cloud Code, é possível criar, ver, atualizar e usar secrets no seu ambiente de desenvolvimento integrado sem precisar deles na sua base de código.

Nesta página, descrevemos como acessar o Secret Manager no seu ambiente de desenvolvimento integrado e como começar a criar e gerenciar secrets.


Para orientações passo a passo sobre esta tarefa diretamente no editor do Cloud Shell, clique em Orientações:

Orientação


As seções a seguir guiam você pelas mesmas etapas que você encontra clicando em Orientações.

Como ativar o Gerenciador de secrets

Ao gerenciar secrets com o Cloud Code, os secrets são armazenados com segurança no Gerenciador de secrets e podem ser recuperados programaticamente quando você precisar deles. Você só precisa da API Secret Manager ativada e das permissões corretas para gerenciar secrets:

  1. Verifique se você está trabalhando no projeto em que reside o código do aplicativo. O secret precisa estar no mesmo projeto que o código do aplicativo.

  2. Clique no Ícone do Cloud Code ícone do Cloud Code na barra de atividades à esquerda.

  3. Expanda a seção Secret Manager.

  4. Se você não ativou a API Secret Manager, ative-a na seção do Secret Manager.

    Ative o link da API na seção "Gerenciador de secrets"

Como criar secrets usando a visualização do Gerenciador de secrets

  1. Clique no Ícone do Cloud Code ícone do Cloud Code na barra de atividades à esquerda.

  2. Expanda a seção Secret Manager.

  3. Clique no ícone Criar secret na seção Gerenciador de secrets.

    Na caixa de diálogo "Criar secret", defina o projeto, o nome, o valor e a região do secret e especifique rótulos para organizar seus secrets.

    Caixa de diálogo "Criar secret" aberta com o campo "Nome" preenchido como 'test-secret-1' e o valor do secret preenchido como '42'

Como criar secrets usando a visualização do editor

  1. Abra um arquivo que contenha texto que você quer armazenar como secret no editor.
  2. Destaque o texto a ser armazenado como secret, clique com o botão direito do mouse e, em seguida, clique em Criar secret no Secret Manager.
  3. Na caixa de diálogo Criar secret, personalize o projeto, o nome, o valor, a região e os rótulos do secret.

Como criar novas versões do secret usando o Secret Manager

Para atualizar um secret, crie uma nova versão dele:

  1. Clique com o botão direito do mouse em um secret existente e escolha Criar versão do secret.

  2. Na caixa de diálogo "Create Version", defina o novo valor do secret atual usando o campo "Valor do secret" ou importando um arquivo.

A caixa de diálogo "Criar versão do secret" é aberta com o campo "Valor do secret" do secret "test-secret" atualizado como "bar".
  1. Para remover todas as versões anteriores do secret e manter apenas a nova versão que você está criando, escolha Desativar todas as versões anteriores.

  2. Clique em Criar versão. Sua versão foi adicionada, e você verá a versão do secret mais recente e as versões anteriores listadas nas listas suspensas Versões.

Como criar novas versões de secrets usando o editor

Para atualizar um secret, crie uma nova versão dele:

  1. No editor, abra um arquivo e destaque o texto a ser armazenado como secret.
  2. Clique com o botão direito do mouse no texto destacado e escolha Adicionar versão ao secret no Gerenciador de secrets.

Como excluir secrets

Para excluir um secret por meio do Gerenciador de secrets no Cloud Code, siga estas etapas:

  1. Clique em Ícone do Cloud Code Cloud Code e depois expanda a seção Gerenciador de secrets.

  2. Clique com o botão direito do mouse em um secret e selecione Abrir no Console do Cloud.

  3. Na página Detalhes do secret, clique em EXCLUIR e siga as instruções para excluir o secret.

Para ver outros métodos de exclusão de secrets, consulte Como gerenciar secrets.

Outras funções

Para ver as chaves secretas, na seção "Gerenciador de secrets", selecione uma opção. Os detalhes do secret, como nome, política de replicação, carimbo de data/hora de criação e ID do recurso, são listados abaixo do nome do secret.

Para ativar, desativar ou destruir a versão de um secret, clique nele com o botão direito do mouse e escolha o comando para a ação que quer executar. Para versões ativadas de secrets, você também pode ver o valor da versão.

Para ver e gerenciar uma chave secreta no navegador, clique com o botão direito do mouse nela e clique em Abrir no Console do Cloud.

Clique com o botão direito do mouse no secret no Secret Manager para visualizar a opção "Open in Google Cloud console". O menu suspenso de propriedades também fica visível na visualização do gerenciador de secrets.

Como acessar secrets do seu aplicativo

Depois da criação do secret, é possível incluí-la no seu código e configurar a autenticação.

Para acessar o secret de um aplicativo, siga estas etapas:

  1. Instale a biblioteca de cliente do Secret Manager.

    1. Clique no Ícone do Cloud Code ícone do Cloud Code na barra de atividades.

    2. Expanda a seção APIs do Cloud.

  2. Clique na API Secret Manager.

    1. Na árvore do Explorador de APIs do Google Cloud, clique em Segurança do Cloud >API Secret Manager. Siga as instruções da etapa "Instalar biblioteca de cliente" para a linguagem que você está usando.
  3. Personalize e inclua o snippet de código relevante no código do seu aplicativo.

    Para ver o nome da versão do secret a ser usado no código, selecione-o na seção "Gerenciador de secrets", clique com o botão direito do mouse e escolha Copiar ID do recurso.

  4. Para concluir a configuração de autenticação, siga o guia de autenticação das bibliotecas de cliente:

    • Desenvolvimento local: se você estiver desenvolvendo em um cluster local (como o minikube ou o Docker Desktop) ou um emulador local, conclua as etapas ilustradas na seção de desenvolvimento local relevante para seu fluxo de trabalho.
    • Desenvolvimento remoto: se você estiver usando um cluster do GKE ou um serviço do Cloud Run no seu aplicativo, conclua as etapas ilustradas na seção de desenvolvimento remoto relevantes para seu fluxo de trabalho, incluindo as instruções específicas do Secret Manager para configurar os papéis necessários em sua conta de serviço.

Como adicionar um secret como uma variável de ambiente

Para adicionar uma chave secreta do Kubernetes atual à implantação como uma variável de ambiente:

  1. Na seção Kubernetes do Cloud Code, expanda o cluster do minikube e, em seguida, expanda Secrets.
  2. Clique com o botão direito do mouse em um secret que representa um objeto de implantação e clique em Adicionar secret como variável de ambiente.

Como montar um secret como um volume

Para montar um secret do Kubernetes atual como um volume no contêiner da implantação:

  1. Na seção Kubernetes do Cloud Code, expanda o cluster do minikube e, em seguida, expanda Secrets.
  2. Clique com o botão direito do mouse em um secret que representa um objeto de implantação e clique em Ativar secret como volume.

Como conseguir suporte

Para enviar feedback, informe problemas no GitHub ou faça uma pergunta no Stack Overflow.