Ativar a API Secret Manager

O Secret Manager expõe uma API REST e uma API gRPC para usar e gerenciar secrets diretamente ou nos seus aplicativos. Esta página descreve como ativar a API Secret Manager e configurar seu projeto do Google Cloud para usar o Secret Manager pela primeira vez.

Quando você estiver familiarizado com o Secret Manager, recomendamos usar um projeto separado do Google Cloud. A exclusão do projeto também exclui todos os recursos criados durante o teste, incluindo recursos faturáveis.

Se você estiver desenvolvendo um aplicativo em um ambiente de desenvolvimento integrado com o Cloud Code instalado, o Gerenciador de secrets será integrado à extensão. Isso significa que você pode criar, ver, atualizar e usar secrets sem precisar sair do ambiente de desenvolvimento integrado. Para mais informações sobre como usar o Secret Manager com o Cloud Code, consulte o guia de gerenciamento de secrets do ambiente de desenvolvimento integrado de sua preferência, VS Code, IntelliJ } ou editor do Cloud Shell.

Antes de começar

  1. In the Google Cloud console, go to the project selector page.

    Go to project selector

  2. Select or create a Google Cloud project.

Ativar a API Secret Manager

Console

  1. No console do Google Cloud, acesse a página da API Secret Manager.

    Acessar a API Secret Manager

  2. Verifique se o nome do projeto aparece no seletor de projetos, na parte superior da página.

    Se você não encontrar o nome do projeto, clique no seletor de projetos e selecione o projeto.

  3. Clique em Ativar.

gcloud

  1. In the Google Cloud console, activate Cloud Shell.

    Activate Cloud Shell

    At the bottom of the Google Cloud console, a Cloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.

  2. Para definir o projeto do Google Cloud na sessão gcloud, execute o comando gcloud config set project. Substitua PROJECT_ID pelo ID do projeto do Google Cloud. 
    gcloud config set project PROJECT_ID
  3. Para ativar a API Secret Manager, execute o comando gcloud services enable: 
    gcloud services enable secretmanager.googleapis.com
  4. Para verificar se a API Secret Manager está ativada, execute o comando gcloud services list: 
    gcloud services list --enabled

    Verifique se a API Secret Manager está listada na lista de APIs ativadas.

Configurar o Secret Manager para usar um endpoint regional

Para criar secrets regionais, configure o Secret Manager para usar endpoints regionais. Os endpoints regionais são endpoints de solicitação que só permitem que as solicitações prossigam se o recurso afetado existir no local especificado pelo endpoint. O uso de endpoints regionais permite executar as cargas de trabalho de maneira que obedeça aos requisitos de residência de dados e de soberania de dados.

Os endpoints regionais usam o seguinte formato:

SERVICE_NAME.LOCATION.rep.googleapis.com

Para usar endpoints regionais, atualize a configuração com o endereço do endpoint regional, dependendo de como você acessa o serviço do Secret Manager.

gcloud

Para configurar a Google Cloud CLI para usar endpoints regionais, siga estas etapas:

  1. Verifique se você está usando a Google Cloud CLI 402.0.0 ou uma versão mais recente.

  2. Defina a propriedade api_endpoint_overrides/secretmanager como o endpoint regional que você quer usar:

    gcloud config set api_endpoint_overrides/secretmanager https://secretmanager.LOCATION.rep.googleapis.com/

    Substitua LOCATION pelo nome do local do Google Cloud com suporte, como me-central2.

REST

Para se conectar ao serviço do Secret Manager usando a API, substitua o URL do endpoint genérico da API (https://secretmanager.googleapis.com/v1/) pelo endpoint regional específico que você quer usar. Os endpoints regionais usam o seguinte formato:

https://secretmanager.LOCATION.rep.googleapis.com/v1/

Substitua LOCATION pelo nome do local do Google Cloud com suporte, como me-central2.

Para saber quais locais têm suporte, consulte Locais do Secret Manager.

Configurar funções e permissões

Para receber as permissões necessárias para configurar o Secret Manager, peça ao administrador para conceder a você o papel do IAM de Administrador do Secret Manager (roles/secretmanager.admin) no projeto. Para mais informações sobre a concessão de papéis, consulte Gerenciar o acesso a projetos, pastas e organizações.

Também é possível conseguir as permissões necessárias por meio de papéis personalizados ou de outros papéis predefinidos.

Para mais informações sobre o controle de acesso do Secret Manager, consulte Controle de acesso com o IAM.

A seguir