Criar e gerenciar anotações

Este tópico aborda o suporte a anotações no Secret Manager.

Visão geral

Use anotações para armazenar metadados personalizados sobre um secret. Por exemplo, talvez você Você quer anotar um secret com o caminho do arquivo em que ele será montado. Anotações podem ser usados na administração e no consumo das cargas de trabalho.

Anotações não são o mesmo que rótulos. Os rótulos são usados para classificar, filtrar e agrupar recursos, enquanto as anotações são usadas para armazenar recursos arbitrários metadados em um secret. Há uma restrição de caracteres e comprimento de caracteres ao especificar metadados em um rótulo. Os metadados em uma anotação podem ser pequenos ou grandes, estruturados ou não estruturados, e podem incluir caracteres não permitidos pelos rótulos.

Funções exigidas

  • Para adicionar anotações a um secret e atualizar anotações, é necessário ter o papel de administrador do Secret Manager (roles/secretmanager.admin) no secret, no projeto, na pasta ou na organização.

  • Para acessar anotações, é preciso ter o papel Leitor do Secret Manager (roles/secretmanager.viewer) o secret, o projeto, a pasta ou a organização.

Não é possível conceder papéis do IAM em uma versão do secret. Consulte Controle de acesso com o IAM para mais informações.

Adicionar anotações a um secret

É possível adicionar anotações ao criar ou atualizar um secret. Os metadados em uma é armazenada como pares de chave-valor.

Console

  1. Acesse a página do Secret Manager no console do Google Cloud:

    Acessar a página "Gerenciador de secrets"

  2. Na página Gerenciador de secrets, clique em Criar secret.

  3. Na página Criar secret, em Nome, insira um nome para o secret (por exemplo, my-secret).

  4. (Opcional) Para adicionar uma versão do secret ao criar o secret inicial, no campo Valor do secret, insira um valor para o secret (por exemplo, abcd1234).

  5. Clique em Adicionar anotação.

  6. Insira a chave e o valor correspondente.

  7. Deixe a seção Regiões inalterada.

  8. Clique no botão Criar secret.

CLI da gcloud

Para usar o Secret Manager na linha de comando, primeiro instale ou faça upgrade para versão 378.0.0 ou superior da gcloud CLI Ativado Compute Engine ou Google Kubernetes Engine, você precisa fazer a autenticação com a cloud-platform do projeto.

 gcloud secrets create mysecret
--set-annotations= mykey=myval,mykey2=myval2

Para adicionar anotações a um secret, siga as etapas mencionadas em Editar anotações.

Observe o seguinte sobre as chaves de anotação:

  • As chaves precisam ser exclusivas para um secret. Não é possível repetir uma chave no mesmo secret.
  • As chaves precisam ter entre 1 e 63 caracteres.
  • As chaves precisam ter uma codificação UTF-8 de no máximo 128 bytes.
  • As chaves precisam começar e terminar com um caractere alfanumérico.
  • As chaves podem ter traços, sublinhados e pontos entre os caracteres alfanuméricos.
  • O tamanho total das chaves e dos valores de anotação precisa ser inferior a 16 KiB.

Conferir anotações

As anotações anexadas a um secret aparecem na guia Visão geral da página Detalhes do secret.

Console

  1. Acesse a página do Secret Manager no console do Google Cloud:

    Acessar a página "Gerenciador de secrets"

  2. Na página Secret Manager, clique no nome do secret.

  3. A página Detalhes do secret será aberta. Selecione a guia Visão geral. Aqui você encontra as anotações anexadas ao secret.As chaves estão listadas na coluna da esquerda enquanto os valores são exibidos na coluna da direita.

CLI da gcloud

Para usar o Secret Manager na linha de comando, primeiro instale ou faça upgrade para versão 378.0.0 ou superior da gcloud CLI Ativado Compute Engine ou Google Kubernetes Engine, você precisa fazer a autenticação com a cloud-platform do projeto.

 gcloud secrets describe mysecret

Editar anotações

É possível atualizar as anotações na página Editar Secret.

Console

  1. Acesse a página do Secret Manager no console do Google Cloud:

    Acessar a página "Gerenciador de secrets"

  2. Na página Secret Manager, clique no nome do secret.

  3. A página Detalhes do secret é aberta. Clique em Editar segredo e role a tela até Anotações.

  4. É possível alterar o valor de uma anotação, excluir a anotação, ou adicionar uma nova anotação.

  5. Clique em Update Secret para salvar as mudanças.

CLI da gcloud

Para usar o Secret Manager na linha de comando, primeiro instale ou faça upgrade para versão 378.0.0 ou superior da gcloud CLI Ativado Compute Engine ou Google Kubernetes Engine, você precisa fazer a autenticação com a cloud-platform do projeto.

 gcloud secrets update mysecret --update-annotations=mykey3=myval3
 
 gcloud secrets update mysecret --remove-annotations=mykey3=myval3
 
 gcloud secrets update mysecret --clear-annotations

A seguir