Membuat dan mengelola anotasi

Topik ini membahas dukungan untuk anotasi di Secret Manager.

Ringkasan

Menggunakan anotasi untuk menyimpan metadata khusus tentang suatu rahasia. Misalnya, Anda mungkin ingin menganotasi suatu secret dengan jalur file yang akan dipasang. Anotasi juga dapat digunakan untuk membantu administrasi dan pemakaian oleh beban kerja.

Anotasi tidak sama dengan label. Label digunakan untuk mengurutkan, memfilter, dan mengelompokkan resource, sedangkan anotasi digunakan untuk menyimpan metadata arbitrer yang tidak mengidentifikasi di suatu secret. Ada batasan karakter dan panjang karakter saat menentukan metadata pada label. Metadata dalam anotasi dapat berukuran kecil atau besar, terstruktur atau tidak terstruktur, dan dapat menyertakan karakter yang tidak diizinkan oleh label.

Peran yang diperlukan

  • Untuk menambahkan anotasi pada secret dan memperbarui anotasi, diperlukan peran Admin Secret Manager (roles/secretmanager.admin) pada secret, project, folder, atau organisasi.

  • Untuk melihat anotasi, diperlukan peran Secret Manager Viewer (roles/secretmanager.viewer) pada secret, project, folder, atau organisasi.

Peran IAM tidak dapat diberikan pada versi secret. Lihat Kontrol akses dengan IAM untuk mengetahui informasi selengkapnya.

Menambahkan anotasi ke secret

Anda dapat menambahkan anotasi pada saat membuat secret baru atau memperbarui secret yang sudah ada. Metadata dalam anotasi disimpan sebagai key-value pair.

Konsol

  1. Buka halaman Secret Manager di konsol Google Cloud.

    Buka halaman Secret Manager

  2. Di halaman Secret Manager, klik Create Secret.

  3. Di halaman Create secret, di bagian Name, masukkan nama untuk rahasia tersebut (mis.my-secret).

  4. (Opsional) Untuk menambahkan versi secret saat membuat secret awal, masukkan nilai untuk secret tersebut (misalnya, abcd1234) di kolom Secret value.

  5. Klik Tambahkan Anotasi.

  6. Masukkan kunci dan nilai yang sesuai.

  7. Jangan ubah bagian Region.

  8. Klik tombol Buat secret.

gcloud CLI

Untuk menggunakan Secret Manager pada command line, instal atau upgrade gcloud CLI ke versi 378.0.0 atau yang lebih baru terlebih dahulu. Di Compute Engine atau Google Kubernetes Engine, Anda harus melakukan autentikasi dengan cakupan cloud-platform.

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

Untuk menambahkan anotasi ke secret yang ada, ikuti langkah-langkah yang disebutkan di bagian Edit anotasi.

Perhatikan hal-hal berikut tentang kunci anotasi:

  • Kunci harus unik untuk secret. Anda tidak dapat mengulangi kunci dalam secret yang sama.
  • Panjang kunci harus antara 1 dan 63 karakter.
  • Kunci harus memiliki encoding UTF-8 maksimal 128 byte.
  • Kunci harus diawali dan diakhiri dengan karakter alfanumerik.
  • Kunci dapat memiliki tanda pisah, garis bawah, dan titik di antara karakter alfanumerik.
  • Ukuran total kunci dan nilai anotasi harus kurang dari 16 KiB.

Lihat anotasi

Anotasi yang dilampirkan ke rahasia dapat dilihat di tab Ringkasan di halaman Detail rahasia.

Konsol

  1. Buka halaman Secret Manager di konsol Google Cloud.

    Buka halaman Secret Manager

  2. Di halaman Secret Manager, klik nama rahasia tersebut.

  3. Halaman Detail rahasia akan terbuka. Pilih tab Ringkasan. Di sini Anda dapat melihat anotasi yang dilampirkan pada secret.Kunci tercantum di kolom kiri sedangkan nilainya ditampilkan di kolom kanan.

gcloud CLI

Untuk menggunakan Secret Manager pada command line, instal atau upgrade gcloud CLI ke versi 378.0.0 atau yang lebih baru terlebih dahulu. Di Compute Engine atau Google Kubernetes Engine, Anda harus melakukan autentikasi dengan cakupan cloud-platform.

 gcloud secrets describe mysecret

Edit anotasi

Anda dapat memperbarui anotasi di halaman Edit Rahasia.

Konsol

  1. Buka halaman Secret Manager di konsol Google Cloud.

    Buka halaman Secret Manager

  2. Di halaman Secret Manager, klik nama rahasia tersebut.

  3. Halaman Detail rahasia akan terbuka. Klik Edit Secret dan scroll ke bawah ke Annotations.

  4. Anda dapat mengubah nilai anotasi yang ada, menghapus anotasi, atau menambahkan anotasi baru.

  5. Klik Update Secret untuk menyimpan perubahan.

gcloud CLI

Untuk menggunakan Secret Manager pada command line, instal atau upgrade gcloud CLI ke versi 378.0.0 atau yang lebih baru terlebih dahulu. Di Compute Engine atau Google Kubernetes Engine, Anda harus melakukan autentikasi dengan cakupan cloud-platform.

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

Langkah selanjutnya