Mengelola resource Firestore dengan kompatibilitas MongoDB menggunakan batasan kustom

Halaman ini menunjukkan cara menggunakan batasan kustom Layanan Kebijakan Organisasi untuk membatasi operasi tertentu pada resource Google Cloud berikut:

  • firestore.googleapis.com/Database

Untuk mempelajari lebih lanjut Kebijakan Organisasi, lihat Kebijakan organisasi kustom.

Tentang batasan dan kebijakan organisasi

Layanan Kebijakan Organisasi Google Cloud memberi Anda kontrol terpusat dan terprogram atas resource organisasi Anda. Sebagai administrator kebijakan organisasi, Anda dapat menentukan kebijakan organisasi, yang merupakan serangkaian batasan yang disebut batasan yang berlaku untuk resourceGoogle Cloud dan turunan dari resource tersebut dalam hierarki resourceGoogle Cloud . Anda dapat menerapkan kebijakan organisasi di level organisasi, folder, atau project.

Kebijakan Organisasi menyediakan batasan terkelola bawaan untuk berbagai layanan Google Cloud . Namun, jika menginginkan kontrol yang lebih terperinci dan dapat disesuaikan atas kolom tertentu yang dibatasi dalam kebijakan organisasi, Anda juga dapat membuat batasan kustom dan menggunakan batasan kustom tersebut dalam kebijakan organisasi.

Pewarisan kebijakan

Secara default, kebijakan organisasi diwarisi oleh turunan resource tempat Anda menerapkan kebijakan tersebut. Misalnya, jika Anda menerapkan kebijakan pada folder, Google Cloud akan menerapkan kebijakan tersebut pada semua project di folder tersebut. Untuk mempelajari lebih lanjut perilaku ini dan cara mengubahnya, lihat Aturan evaluasi hierarki.

Manfaat

  • Keamanan, kepatuhan, dan tata kelola: Anda dapat menggunakan kebijakan organisasi kustom sebagai berikut:

    • Untuk menerapkan persyaratan pemulihan dari bencana, Anda dapat mewajibkan setelan pemulihan dari bencana tertentu pada database seperti perlindungan penghapusan, dan pemulihan point-in-time.

    • Anda dapat membatasi pembuatan database hanya ke lokasi tertentu.

    • Anda dapat mewajibkan CMEK (Customer Managed Encryption Key) untuk database.

  • Audit: Batasan kebijakan organisasi kustom dicatat dalam log audit. Setiap operasi, termasuk modifikasi batasan dan pemeriksaan batasan, akan menghasilkan Cloud Audit Logs yang sesuai.

Sebelum memulai

  1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

  2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  3. Verify that billing is enabled for your Google Cloud project.

  4. Install the Google Cloud CLI.

  5. Jika Anda menggunakan penyedia identitas (IdP) eksternal, Anda harus login ke gcloud CLI dengan identitas gabungan Anda terlebih dahulu.

  6. Untuk melakukan inisialisasi gcloud CLI, jalankan perintah berikut: 

    gcloud init

  7. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  8. Verify that billing is enabled for your Google Cloud project.

  9. Install the Google Cloud CLI.

  10. Jika Anda menggunakan penyedia identitas (IdP) eksternal, Anda harus login ke gcloud CLI dengan identitas gabungan Anda terlebih dahulu.

  11. Untuk melakukan inisialisasi gcloud CLI, jalankan perintah berikut: 

    gcloud init
  12. Pastikan Anda mengetahui ID organisasi Anda.

    13. Peran yang diperlukan

    Guna mendapatkan izin yang diperlukan untuk mengelola kebijakan organisasi kustom, minta administrator untuk memberi Anda peran IAM Organization Policy Administrator (roles/orgpolicy.policyAdmin) di resource organisasi. Untuk mengetahui informasi selengkapnya tentang pemberian peran, lihat Mengelola akses ke project, folder, dan organisasi.

    Anda mungkin juga bisa mendapatkan izin yang diperlukan melalui peran khusus atau peran bawaan lainnya.

    Menyiapkan batasan kustom

    Batasan kustom ditentukan dalam file YAML oleh resource, metode, kondisi, dan tindakan yang didukung oleh layanan tempat Anda menerapkan kebijakan organisasi. Kondisi untuk batasan kustom Anda ditentukan menggunakan Common Expression Language (CEL). Untuk mengetahui informasi selengkapnya tentang cara membuat kondisi dalam batasan kustom menggunakan CEL, lihat bagian CEL tentang Membuat dan mengelola batasan kustom.

    Konsol

    Untuk membuat batasan kustom, lakukan hal berikut:

    1. Di konsol Google Cloud , buka halaman Organization policies.

      Buka Organization policies

    2. Dari pemilih project, pilih project yang ingin Anda tetapkan kebijakan organisasinya.
    3. Klik Custom constraint.
    4. Di kotak Nama tampilan, masukkan nama yang mudah dipahami manusia untuk batasan. Nama ini digunakan dalam pesan error dan dapat digunakan untuk identifikasi dan proses debug. Jangan menggunakan PII atau data sensitif dalam nama tampilan karena nama ini dapat terekspos dalam pesan error. Kolom ini dapat berisi hingga 200 karakter.
    5. Di kotak Constraint ID, masukkan nama yang diinginkan untuk batasan kustom baru. Batasan kustom hanya boleh berisi huruf (termasuk huruf besar dan huruf kecil) atau angka, misalnya custom.disableGkeAutoUpgrade. Kolom ini dapat berisi hingga 70 karakter, tidak termasuk awalan (custom.), misalnya, organizations/123456789/customConstraints/custom. Jangan sertakan PII atau data sensitif dalam ID batasan Anda, karena dapat terekspos dalam pesan error.
    6. Di kotak Description, masukkan deskripsi batasan yang mudah dipahami. Deskripsi ini digunakan sebagai pesan error saat kebijakan dilanggar. Sertakan detail tentang mengapa pelanggaran kebijakan terjadi dan cara menyelesaikan pelanggaran kebijakan tersebut. Jangan sertakan PII atau data sensitif dalam deskripsi Anda, karena dapat terekspos dalam pesan error. Kolom ini dapat berisi hingga 2.000 karakter.
    7. Di kotak Resource type, pilih nama resource REST Google Cloud yang berisi objek dan kolom yang ingin Anda batasi—misalnya, container.googleapis.com/NodePool. Sebagian besar jenis resource mendukung hingga 20 batasan kustom. Jika Anda mencoba membuat lebih banyak batasan kustom, operasi akan gagal.
    8. Di bagian Enforcement method, pilih apakah akan menerapkan batasan pada metode CREATE REST atau pada metode CREATE dan UPDATE. Jika Anda menerapkan batasan dengan metode UPDATE pada resource yang melanggar batasan, perubahan pada resource tersebut akan diblokir oleh kebijakan organisasi kecuali jika perubahan tersebut menyelesaikan pelanggaran.

      9. Tidak semua layanan Google Cloud mendukung kedua metode tersebut. Untuk melihat metode yang didukung untuk setiap layanan, temukan layanan di Layanan yang didukung.

    9. Untuk menentukan kondisi, klik Edit kondisi.
      1. Di panel Add condition, buat kondisi CEL yang mengacu pada resource layanan yang didukung, misalnya, resource.management.autoUpgrade == false. Kolom ini dapat berisi hingga 1.000 karakter. Untuk mengetahui detail tentang penggunaan CEL, lihat Common Expression Language. Untuk mengetahui informasi selengkapnya tentang resource layanan yang dapat Anda gunakan dalam batasan kustom, lihat Layanan yang didukung batasan kustom.
      2. Klik Simpan.
    10. Di bagian Action, pilih apakah akan mengizinkan atau menolak metode yang dievaluasi jika kondisi terpenuhi.

      11. Tindakan penolakan berarti operasi untuk membuat atau mengupdate resource diblokir jika kondisi dievaluasi menjadi benar.

      Tindakan izinkan berarti operasi untuk membuat atau memperbarui resource hanya diizinkan jika kondisi bernilai benar. Setiap kasus lainnya, kecuali yang tercantum secara eksplisit dalam kondisi, akan diblokir.

    11. Klik Create constraint.

      12. Setelah Anda memasukkan nilai ke setiap kolom, konfigurasi YAML yang setara untuk batasan khusus ini akan muncul di sebelah kanan.

    gcloud

    1. Untuk membuat batasan kustom, buat file YAML menggunakan format berikut: 
      2.       name: organizations/ORGANIZATION_ID/customConstraints/CONSTRAINT_NAME
      resourceTypes:
      - RESOURCE_NAME
      methodTypes:
      - CREATE
      - UPDATE       
      condition: "CONDITION"
      actionType: ACTION
      displayName: DISPLAY_NAME
      description: DESCRIPTION

      Ganti kode berikut:

      • ORGANIZATION_ID: ID organisasi Anda, seperti 123456789.
      • CONSTRAINT_NAME: nama yang Anda inginkan untuk batasan kustom baru. Batasan kustom hanya boleh berisi huruf (termasuk huruf besar dan huruf kecil) atau angka, misalnya, custom.deleteProtectionRequired. Kolom ini dapat berisi hingga 70 karakter.
      • RESOURCE_NAME: nama lengkap resource Google Cloud yang berisi objek dan kolom yang ingin Anda batasi. Misalnya, firestore.googleapis.com/Database.
      • CONDITION: Kondisi CEL yang ditulis berdasarkan representasi resource layanan yang didukung. Kolom ini dapat berisi hingga 1000 karakter. Misalnya, "resource.deleteProtectionState == \"DELETE_PROTECTION_ENABLED\"".

        • Untuk mengetahui informasi selengkapnya tentang resource yang tersedia untuk menulis kondisi, lihat Resource yang didukung.

      • ACTION: tindakan yang akan diambil jika condition terpenuhi. Nilai yang mungkin adalah ALLOW dan DENY.

        • Tindakan izinkan berarti jika kondisi bernilai benar, operasi untuk membuat atau memperbarui resource diizinkan. Artinya juga bahwa setiap kasus lain kecuali yang tercantum secara eksplisit dalam kondisi diblokir.

        Tindakan penolakan berarti bahwa jika kondisi bernilai benar, operasi untuk membuat atau memperbarui resource akan diblokir.

      • DISPLAY_NAME: nama yang mudah dibaca manusia untuk batasan. Kolom ini dapat berisi hingga 200 karakter.
      • DESCRIPTION: deskripsi batasan yang mudah dipahami untuk ditampilkan sebagai pesan error saat kebijakan dilanggar. Kolom ini dapat berisi hingga 2.000 karakter.
    2. Setelah membuat file YAML untuk batasan kustom baru, Anda harus menyiapkannya agar tersedia untuk kebijakan organisasi di organisasi Anda. Untuk menyiapkan batasan kustom, gunakan perintah gcloud org-policies set-custom-constraint: 
      3.         gcloud org-policies set-custom-constraint CONSTRAINT_PATH

      Ganti CONSTRAINT_PATH dengan jalur lengkap ke file batasan kustom Anda. Contoh, /home/user/customconstraint.yaml.

      Setelah operasi ini selesai, batasan kustom Anda tersedia sebagai kebijakan organisasi dalam daftar kebijakan organisasi Google Cloud .

    3. Untuk memverifikasi bahwa ada batasan kustom, gunakan perintah gcloud org-policies list-custom-constraints: 
      4.       gcloud org-policies list-custom-constraints --organization=ORGANIZATION_ID

      Ganti ORGANIZATION_ID dengan ID fasilitas organisasi Anda.

      Untuk mengetahui informasi selengkapnya, lihat Melihat kebijakan organisasi.

    Menerapkan kebijakan organisasi kustom

    Anda dapat menerapkan batasan dengan membuat kebijakan organisasi yang mereferensikannya, lalu menerapkan kebijakan organisasi tersebut ke resource Google Cloud .

    Konsol

    1. Di konsol Google Cloud , buka halaman Organization policies.

      Buka Organization policies

    2. Dari pemilih project, pilih project yang ingin Anda tetapkan kebijakan organisasinya.
    3. Dari daftar di halaman Organization policies, pilih batasan Anda untuk melihat halaman Policy details untuk batasan tersebut.
    4. Guna mengonfigurasi kebijakan organisasi untuk resource ini, klik Manage policy.
    5. Di halaman Edit policy, pilih Override parent's policy.
    6. Klik Add a rule.
    7. Di bagian Penerapan, pilih apakah kebijakan organisasi ini diterapkan atau tidak.
    8. Opsional: Agar kebijakan organisasi menjadi bersyarat pada tag, klik Add condition. Perhatikan bahwa jika menambahkan aturan kondisional ke kebijakan organisasi, Anda harus menambahkan setidaknya satu aturan tanpa syarat atau kebijakan tidak dapat disimpan. Untuk mengetahui informasi selengkapnya, lihat Menetapkan kebijakan organisasi dengan tag.
    9. Klik Test changes untuk menyimulasikan efek kebijakan organisasi. Untuk mengetahui informasi selengkapnya, lihat Menguji perubahan kebijakan organisasi dengan Policy Simulator.
    10. Untuk menerapkan kebijakan organisasi dalam mode uji coba, klik Set dry run policy. Untuk informasi selengkapnya, lihat Membuat kebijakan organisasi dalam mode uji coba.
    11. Setelah Anda memverifikasi bahwa kebijakan organisasi dalam mode uji coba berfungsi sebagaimana mestinya, tetapkan kebijakan aktif dengan mengklik Tetapkan kebijakan.

    gcloud

    1. Untuk membuat kebijakan organisasi dengan aturan boolean, buat file YAML kebijakan yang mereferensikan batasan: 
      2.         name: projects/PROJECT_ID/policies/CONSTRAINT_NAME
        spec:
          rules:
          - enforce: true
        
        dryRunSpec:
          rules:
          - enforce: true

      Ganti kode berikut:

      • PROJECT_ID: project tempat Anda ingin menerapkan batasan.
      • CONSTRAINT_NAME: nama yang Anda tentukan untuk batasan kustom. Contoh, custom.deleteProtectionRequired.
    2. Untuk menerapkan kebijakan organisasi dalam mode uji coba, jalankan perintah berikut dengan tanda dryRunSpec: 
      3.         gcloud org-policies set-policy POLICY_PATH \
          --update-mask=dryRunSpec

      Ganti POLICY_PATH dengan jalur lengkap ke file YAML kebijakan organisasi Anda. Kebijakan ini memerlukan waktu hingga 15 menit untuk diterapkan.

    3. Setelah Anda memverifikasi bahwa kebijakan organisasi dalam mode uji coba berfungsi sebagaimana mestinya, tetapkan kebijakan aktif dengan perintah org-policies set-policy dan tanda spec: 
      4.         gcloud org-policies set-policy POLICY_PATH \
          --update-mask=spec

      Ganti POLICY_PATH dengan jalur lengkap ke file YAML kebijakan organisasi Anda. Kebijakan ini memerlukan waktu hingga 15 menit untuk diterapkan.

    Menguji kebijakan organisasi kustom

    Sebelum memulai, Anda harus mengetahui hal-hal berikut:

    • ID organisasi Anda

    1. Buat file deleteProtectionRequired.yaml sebagai berikut:

       name: organizations/ORGANIZATION_ID/customConstraints/custom.deleteProtectionRequired
 resourceTypes:
 - firestore.googleapis.com/Database
 methodTypes:
 - CREATE
 - UPDATE
 condition: "resource.deleteProtectionState == \"DELETE_PROTECTION_ENABLED\""
 actionType: ALLOW
 displayName: Firestore with MongoDB compatibility Delete Protection Required
 description: To ensure the data security, Delete Protection is required to be enabled for Firestore databases.

      Hal ini memastikan bahwa semua metode CREATE dan UPDATE di database Firestore dengan kompatibilitas MongoDB memenuhi batasan deleteProtectionState menjadi DELETE_PROTECTION_ENABLED. Akibatnya, semua operasi buat/perbarui/pulihkan/kloning database tanpa mengaktifkan Perlindungan Penghapusan secara eksplisit akan ditolak.

    2. Siapkan batasan kustom di tingkat organisasi:

      gcloud org-policies set-custom-constraint deleteProtectionRequired.yaml

    Menguji kebijakan

    Coba buat database tanpa menyetel flag --delete-protection di project dalam organisasi:

    gcloud firestore database create \
   --project=PROJECT_ID \
   --database=DATABASE_ID \

    Outputnya adalah sebagai berikut:

    Operation denied by custom org policies: ["customConstraints/custom.deleteProtectionRequired": "To ensure the data security, Delete Protection is required to be enabled for Firestore databases"]

    Menguji dan menganalisis perubahan kebijakan organisasi

    Sebaiknya Anda menguji dan melakukan uji coba semua perubahan pada kebijakan organisasi Anda, untuk lebih memahami status lingkungan Anda dan pengaruh perubahan terhadapnya.

    Simulator Kebijakan untuk Kebijakan Organisasi membantu Anda memahami efek batasan dan kebijakan organisasi pada lingkungan saat ini. Dengan menggunakan alat ini, Anda dapat meninjau semua konfigurasi resource untuk melihat tempat terjadinya pelanggaran, sebelum diterapkan di lingkungan produksi Anda. Untuk mengetahui petunjuk mendetail, lihat Menguji perubahan kebijakan organisasi dengan Policy Simulator.

    Setelah memahami efek saat ini, Anda dapat membuat kebijakan organisasi dalam mode uji coba untuk memahami dampak dan potensi pelanggaran kebijakan selama 30 hari ke depan. Kebijakan organisasi dalam mode uji coba adalah jenis kebijakan organisasi yang pelanggarannya dicatat dalam audit, tetapi tindakan yang melanggar tidak ditolak. Anda dapat membuat kebijakan organisasi dalam mode uji coba dari batasan kustom menggunakan konsol Google Cloud atau Google Cloud CLI. Untuk mengetahui petunjuk mendetail, lihat Membuat kebijakan organisasi dalam mode uji coba.

    Contoh kebijakan organisasi kustom untuk kasus penggunaan umum

    Tabel ini memberikan contoh sintaksis untuk beberapa batasan kustom umum.

    Deskripsi Sintaksis batasan
    Nama database harus mengikuti pola tertentu. Perhatikan bahwa format nama database dalam kebijakan organisasi kustom adalah projects/project-id/databases/database-id, sedangkan hanya database-id yang ditentukan dalam operasi pengelolaan database. 
    name: organizations/ORGANIZATION_ID/customConstraints/custom.nameSuffixMobile
resourceTypes:
- firestore.googleapis.com/Database
methodTypes:
- CREATE
condition: "resource.name.endsWith('-mobile')"
actionType: ALLOW
displayName: Firestore database names end with "-mobile"
description: Only allow the creation of database names ending with suffix "-mobile"
    Database hanya dapat dibuat di lokasi yang ditentukan. 
    name: organizations/ORGANIZATION_ID/customConstraints/custom.locationUsCentral1
resourceTypes:
- firestore.googleapis.com/Database
methodTypes:
- CREATE
condition: "resource.locationId == 'us-central1'"
actionType: ALLOW
displayName: Firestore database location id us-central1
description: Only allow the creation of databases in region us-central1
    Database harus mengaktifkan point-in-time-recovery. 
    name: organizations/ORGANIZATION_ID/customConstraints/custom.pitrEnforce
resourceTypes:
- firestore.googleapis.com/Database
methodTypes:
- CREATE
- UPDATE
condition: "resource.pointInTimeRecoveryEnablement == "POINT_IN_TIME_RECOVERY_ENABLED""
actionType: ALLOW
displayName: Firestore database enables PiTR
description: Only allow the creation and updating of a databases if PiTR is enabled.
    Jangan izinkan pembuatan database kecuali jika perlindungan penghapusan diaktifkan. 
    name: organizations/ORGANIZATION_ID/customConstraints/custom.deleteProtectionRequired
resourceTypes:
- firestore.googleapis.com/Database
methodTypes:
- CREATE
- UPDATE
condition: "resource.deleteProtectionState == "DELETE_PROTECTION_ENABLED""
actionType: ALLOW
displayName: Firestore with MongoDB compatibility Delete Protection Required
description: To ensure the data security, Delete Protection is required to be enabled for Firestore databases.
    Database harus menggunakan konfigurasi CMEK (Customer Managed Encryption Key) yang ditentukan. 
    name: organizations/ORGANIZATION_ID/customConstraints/custom.cmekKeyNotDev
resourceTypes:
- firestore.googleapis.com/Database
methodTypes:
- CREATE
- UPDATE
condition: "resource.cmekConfig.kmsKeyName.matches('dev$')"
actionType: DENY
displayName: Firestore database CMEK key not dev
description: Disallow the creation and updating of databases with CMEK KMS keys ending with "dev".
    Database harus menggunakan Edisi Database yang ditentukan. 
    name: organizations/ORGANIZATION_ID/customConstraints/custom.enterpriseEditionRequired
resourceTypes:
- firestore.googleapis.com/Database
methodTypes:
- CREATE
- UPDATE
condition: "resource.databaseEdition == "ENTERPRISE""
actionType: ALLOW
displayName: Firestore Enterprise Edition Required
description: Only allow the creation and updating of databases with Enterprise Edition.

    Resource yang didukung Firestore dengan kompatibilitas MongoDB

    Tabel berikut mencantumkan resource Firestore dengan kompatibilitas MongoDB yang dapat Anda referensikan dalam batasan kustom.

    Resource Kolom
    firestore.googleapis.com/Database resource.appEngineIntegrationMode
    resource.cmekConfig.kmsKeyName
    resource.concurrencyMode
    resource.deleteProtectionState
    resource.locationId
    resource.name
    resource.pointInTimeRecoveryEnablement
    resource.type

    Langkah berikutnya