Membuat dan mengelola batasan kustom

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

• apikeys.googleapis.com/Key

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

• Pengelolaan biaya: gunakan kebijakan organisasi untuk membatasi ukuran dan jenis instance VM serta disk yang dapat digunakan di organisasi Anda. Anda juga dapat membatasi kelompok mesin yang digunakan untuk instance VM.
• Keamanan, kepatuhan, dan tata kelola: Anda dapat menggunakan kebijakan organisasi kustom sebagai berikut:
  • Untuk menerapkan persyaratan keamanan, Anda dapat mewajibkan aturan port firewall khusus pada VM.
  • Untuk mendukung isolasi hardware atau kepatuhan pemberian lisensi, Anda dapat mewajibkan semua VM dalam project atau folder tertentu untuk dijalankan di node tenant tunggal.
  • Untuk mengatur skrip otomatisasi, Anda dapat menggunakan kebijakan organisasi kustom untuk memverifikasi bahwa label cocok dengan ekspresi yang diinginkan.

Sebelum memulai

Login ke akun Google Cloud Anda. Jika Anda baru menggunakan Google Cloud, buat akun untuk mengevaluasi performa produk kami dalam skenario dunia nyata. Pelanggan baru juga mendapatkan kredit gratis senilai $300 untuk menjalankan, menguji, dan men-deploy workload.

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.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Instal Google Cloud CLI.

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

Untuk melakukan inisialisasi gcloud CLI, jalankan perintah berikut:

gcloud init

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.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Instal Google Cloud CLI.

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

Untuk melakukan inisialisasi gcloud CLI, jalankan perintah berikut:

gcloud init

1. Pastikan Anda mengetahui ID organisasi Anda.

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 kustom 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-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 Display name, masukkan nama yang dapat dibaca 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 imbuhan (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 dapat dibaca manusia. Deskripsi ini digunakan sebagai pesan error saat kebijakan dilanggar. Sertakan detail tentang alasan pelanggaran kebijakan dapat 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 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.

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

9. Untuk menentukan kondisi, klik Edit condition.
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 Save.
10. Di bagian Action, pilih apakah akan mengizinkan atau menolak metode yang dievaluasi jika kondisi di atas terpenuhi.

Tindakan penolakan berarti operasi untuk membuat atau memperbarui resource diblokir jika kondisi bernilai 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.

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

gcloud

1. Untuk membuat batasan kustom, buat file YAML menggunakan format berikut:

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 Anda. Batasan kustom hanya boleh berisi huruf (termasuk huruf besar dan huruf kecil) atau angka, misalnya, custom.allowOnlyStartsWithKeyName. Kolom ini dapat berisi hingga 70 karakter.
• RESOURCE_NAME: nama resource Google Cloudyang sepenuhnya memenuhi syarat, yang berisi objek dan kolom yang ingin Anda batasi. Contoh, apikeys.googleapis.com/Key.
• CONDITION: Kondisi CEL yang ditulis berdasarkan representasi resource layanan yang didukung. Kolom ini dapat berisi hingga 1.000 karakter. Contoh, "resource.displayName.startsWith('key-')".

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 dipahami manusia untuk batasan tersebut. Kolom ini dapat berisi hingga 200 karakter.
• DESCRIPTION: deskripsi batasan yang mudah dipahami manusia 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:

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 ada tidaknya batasan kustom, gunakan perintah gcloud org-policies list-custom-constraints:

gcloud org-policies list-custom-constraints --organization=ORGANIZATION_ID

Ganti ORGANIZATION_ID dengan ID resource 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 Enforcement, 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 Mencakup 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 Menguji kebijakan organisasi.
11. Setelah Anda memverifikasi bahwa kebijakan organisasi dalam mode uji coba berfungsi sebagaimana mestinya, tetapkan kebijakan aktif dengan mengklik Set policy.

gcloud

1. Untuk membuat kebijakan organisasi dengan aturan boolean, buat file YAML kebijakan yang mereferensikan batasan:

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 Anda.
• CONSTRAINT_NAME: nama yang Anda tentukan untuk batasan kustom. Contoh, custom.allowOnlyStartsWithKeyName.
2. Untuk menerapkan kebijakan organisasi dalam mode uji coba, jalankan perintah berikut dengan tanda dryRunSpec:

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:

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

Contoh berikut membuat batasan dan kebijakan kustom yang mengharuskan nama tampilan semua Kunci API baru dalam project tertentu dimulai dengan key-.

Sebelum memulai, Anda perlu mengetahui hal-hal berikut:

• ID organisasi Anda
• Project ID

Membuat batasan

1. Simpan file berikut sebagai constraint-allow-only-starts-with-key.yaml:

   name: organizations/ORGANIZATION_ID/customConstraints/custom.allowOnlyStartsWithKeyName
   resourceTypes:
   - apikeys.googleapis.com/Key
   methodTypes:
   - CREATE
   condition: "resource.displayName.startsWith('key-')"
   actionType: ALLOW
   displayName: Only new API Keys with the display name starting with 'key-' are allowed.
   description: Restrict all other key creation with the display name starting with 'key-'.
   

   Hal ini menentukan batasan untuk setiap Kunci API baru, jika nama tampilannya tidak diawali dengan key-, operasi akan ditolak.

2. Terapkan batasan:

   gcloud org-policies set-custom-constraint ~/constraint-allow-only-starts-with-key.yaml
   

3. Pastikan batasan ada:

   gcloud org-policies list-custom-constraints --organization=ORGANIZATION_ID
   

   Outputnya mirip dengan contoh berikut:

   CUSTOM_CONSTRAINT                       ACTION_TYPE  METHOD_TYPES   RESOURCE_TYPES                     DISPLAY_NAME
   custom.allowOnlyStartsWithKeyName       ALLOW        CREATE         apikeys.googleapis.com/Key         Only new API Keys with the display name starting with 'key-' are allowed.
   ...
   

Membuat kebijakan

1. Simpan file berikut sebagai policy-allow-only-starts-with-key.yaml:

   name: projects/PROJECT_ID/policies/custom.allowOnlyStartsWithKeyName
   spec:
     rules:
     - enforce: true
   

   Ganti PROJECT_ID dengan project ID Anda.

2. Terapkan kebijakan:

   gcloud org-policies set-policy ~/policy-allow-only-starts-with-key.yaml
   

3. Pastikan kebijakan ada:

   gcloud org-policies list --project=PROJECT_ID
   

   Outputnya mirip dengan contoh berikut:

   CONSTRAINT                        LIST_POLICY    BOOLEAN_POLICY    ETAG
   custom.allowOnlyStartsWithKeyName -              SET               COCsm5QGENiXi2E=
   

Setelah Anda menerapkan kebijakan, tunggu sekitar dua menit hingga Google Cloud mulai menerapkan kebijakan tersebut.

Menguji kebijakan

Coba buat Kunci API baru dengan nama tampilan not-key di project:

gcloud services api-keys create --display-name=not-key

Outputnya adalah sebagai berikut:

Operation denied by org policy: ["customConstraints/custom.allowOnlyStartsWithKeyName": "Only new API Keys with the display name starting with 'key-' are allowed."]

Contoh kebijakan organisasi kustom untuk kasus penggunaan umum

Tabel ini memberikan contoh sintaksis untuk beberapa batasan kustom umum.

Deskripsi	Sintaksis batasan
Hanya Kunci API baru dengan nama tampilan yang diawali dengan 'key-' yang diizinkan.	name: organizations/ORGANIZATION_ID/customConstraints/custom.allowOnlyStartsWithKeyName resourceTypes: - apikeys.googleapis.com/Key methodTypes: - CREATE condition: "resource.displayName.startsWith('key-')" actionType: ALLOW displayName: Only new API Keys with the display name starting with 'key-' are allowed. description: Restrict all other key creation with the display name starting with 'key-'.
Hanya Kunci API yang terikat ke '[e-mail]' yang diizinkan untuk dibuat/diperbarui.	name: organizations/ORGANIZATION_ID/customConstraints/custom.denyTestServiceAccountBound resourceTypes: - apikeys.googleapis.com/Key methodTypes: - CREATE - UPDATE condition: "resource.serviceAccountEmail != '[e-mail]'" actionType: ALLOW displayName: Only API Keys bound to '[e-mail]' are allowed. description: Restrict all other key creation or update to only be bound to the test service account '[e-mail]'.
Hanya Kunci API baru dengan IP '1.1.1.1' dalam daftar yang diizinkan yang dapat dibuat.	name: organizations/ORGANIZATION_ID/customConstraints/custom.allowOnlyIP1111 resourceTypes: - apikeys.googleapis.com/Key methodTypes: - CREATE condition: "'1.1.1.1' in resource.restrictions.serverKeyRestrictions.allowedIps" actionType: ALLOW displayName: Only new API Keys with the IP '1.1.1.1' in the allowlist can be created. description: Restrict all other key creation with the IP '1.1.1.1' in the allowlist.
Menolak pembaruan Kunci API yang menargetkan layanan myservice.googleapis.com.	name: organizations/ORGANIZATION_ID/customConstraints/custom.denyUpdateMyService resourceTypes: - apikeys.googleapis.com/Key methodTypes: - UPDATE condition: "resource.restrictions.apiTargets.exists(target, target.service == 'myservice.googleapis.com')" actionType: DENY displayName: Deny API Keys update targeting the myservice.googleapis.com service. description: Block myservice.googleapis.com service API Keys update.

Resource yang didukung Kunci API

Tabel berikut mencantumkan resource Kunci API yang dapat Anda referensikan dalam batasan kustom.

Resource	Kolom
apikeys.googleapis.com/Key	resource.displayName
	resource.restrictions.androidKeyRestrictions.allowedApplications.packageName
	resource.restrictions.androidKeyRestrictions.allowedApplications.sha1Fingerprint
	resource.restrictions.apiTargets.methods
	resource.restrictions.apiTargets.service
	resource.restrictions.browserKeyRestrictions.allowedReferrers
	resource.restrictions.iosKeyRestrictions.allowedBundleIds
	resource.restrictions.serverKeyRestrictions.allowedIps
	resource.serviceAccountEmail

Langkah berikutnya

• Pelajari lebih lanjut Layanan Kebijakan Organisasi.
• Pelajari lebih lanjut cara membuat dan mengelola kebijakan organisasi.
• Lihat daftar lengkap batasan kebijakan organisasi terkelola.