Criar e gerenciar anotações

Neste tópico, abordamos o suporte a anotações no Secret Manager.

Informações gerais

Use anotações para armazenar metadados personalizados sobre um secret. Por exemplo, é possível anotar um secret com o caminho de arquivo em que ele será montado. As anotações também podem ser usadas para ajudar 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 metadados arbitrários e sem identificação em um secret. Há uma restrição de caracteres e comprimento de caracteres ao especificar metadados em um rótulo. Os metadados de uma anotação podem ser pequenos ou grandes, estruturados ou não estruturados e incluir caracteres que não sã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) no secret, projeto, pasta ou 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 no momento de criar um novo secret ou atualizar um que já existe. Os metadados em uma anotação são armazenados 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 a versão 378.0.0 ou mais recente da CLI gcloud. No Compute Engine ou no Google Kubernetes Engine, é preciso fazer a autenticação com o escopo cloud-platform.

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

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

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

  • As chaves precisam ser exclusivas de um secret. Não é possível repetir uma chave na mesma chave secreta.
  • 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 menor que 16 KiB.

Ver anotações

As anotações anexadas a um secret são visíveis 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 é aberta. Selecione a guia Visão geral. Aqui é possível ver as anotações anexadas ao secret.As chaves sã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 a versão 378.0.0 ou mais recente da CLI gcloud. No Compute Engine ou no Google Kubernetes Engine, é preciso fazer a autenticação com o escopo cloud-platform.

 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 Edit Secret e role para baixo até Annotations.

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

  5. Clique em Atualizar secret para salvar as alterações.

CLI da gcloud

Para usar o Secret Manager na linha de comando, primeiro instale ou faça upgrade para a versão 378.0.0 ou mais recente da CLI gcloud. No Compute Engine ou no Google Kubernetes Engine, é preciso fazer a autenticação com o escopo cloud-platform.

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

A seguir