Membuat batasan kustom untuk Document AI

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

documentai.googleapis.com/Processor
documentai.googleapis.com/ProcessorVersion

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.

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.

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.

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

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:

Di konsol Google Cloud , buka halaman Organization policies.
Buka Organization policies
Dari pemilih project, pilih project yang ingin Anda tetapkan kebijakan organisasinya.
Klik Custom constraint.
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 informasi identitas pribadi (PII) atau data sensitif dalam nama tampilan karena nama ini dapat terekspos dalam pesan error. Kolom ini dapat berisi hingga 200 karakter.
Di kotak Constraint ID, masukkan ID yang diinginkan untuk batasan kustom baru. Batasan kustom hanya boleh berisi huruf (termasuk huruf besar dan huruf kecil) atau angka, misalnya custom.enforceCustomExtractor. 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.
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.
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.
Di bagian Enforcement method, pilih apakah akan menerapkan batasan pada metode CREATE REST atau pada metode CREATE dan UPDATE REST. 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.

Untuk melihat metode yang didukung untuk setiap layanan, temukan layanan di Layanan yang mendukung batasan kustom.

Untuk menentukan kondisi, klik Edit condition.

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.
Klik Save.

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.

Klik Create constraint.

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

gcloud

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.enforceCustomExtractor. 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.
RESOURCE_NAME: nama resource Google Cloudyang sepenuhnya memenuhi syarat, yang berisi objek dan kolom yang ingin Anda batasi. Contoh, documentai.googleapis.com/Processor. Sebagian besar jenis resource mendukung hingga 20 batasan kustom. Jika Anda mencoba membuat lebih banyak batasan kustom, operasi akan gagal.
methodTypes: metode REST yang menerapkan batasan. Dapat berupa CREATE atau 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.

Untuk melihat metode yang didukung untuk setiap layanan, temukan layanan di Layanan yang mendukung batasan kustom.

CONDITION: Kondisi CEL yang ditulis berdasarkan representasi resource layanan yang didukung. Kolom ini dapat berisi hingga 1.000 karakter. Contoh, "resource.type == 'CUSTOM_EXTRACTION_PROCESSOR'".

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 tersebut. 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.
DESCRIPTION: deskripsi batasan yang mudah dipahami manusia untuk ditampilkan sebagai pesan error saat kebijakan dilanggar. Kolom ini dapat berisi hingga 2.000 karakter.

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 .

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

Di konsol Google Cloud , buka halaman Organization policies.
Buka Organization policies
Dari pemilih project, pilih project yang ingin Anda tetapkan kebijakan organisasinya.
Dari daftar di halaman Organization policies, pilih batasan Anda untuk melihat halaman Policy details untuk batasan tersebut.
Guna mengonfigurasi kebijakan organisasi untuk resource ini, klik Manage policy.
Di halaman Edit policy, pilih Override parent's policy.
Klik Add a rule.
Di bagian Enforcement, pilih apakah kebijakan organisasi ini diterapkan atau tidak.
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.
Klik Test changes untuk menyimulasikan efek kebijakan organisasi. Untuk mengetahui informasi selengkapnya, lihat Menguji perubahan kebijakan organisasi dengan Policy Simulator.
Untuk menerapkan kebijakan organisasi dalam mode uji coba, klik Set dry run policy. Untuk informasi selengkapnya, lihat Menguji kebijakan organisasi.
Setelah Anda memverifikasi bahwa kebijakan organisasi dalam mode uji coba berfungsi sebagaimana mestinya, tetapkan kebijakan aktif dengan mengklik Set policy.

gcloud

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.enforceCustomExtractor.

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.

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

Langkah-langkah berikut menunjukkan cara membuat batasan dan kebijakan kustom yang memungkinkan pengguna membuat pemroses ekstraksi kustom Document AI.

Sebelum Anda memulai, siapkan hal berikut:

ID organisasi Anda
Project ID Anda

Membuat batasan

Simpan file berikut sebagai CONSTRAINT_FILE_NAME.yaml:

name: organizations/ORGANIZATION_ID/customConstraints/custom.enforceCustomExtractor
resourceTypes:
- documentai.googleapis.com/Processor
methodTypes:
- CREATE
condition: "resource.type == 'CUSTOM_EXTRACTION_PROCESSOR'"
actionType: ALLOW
displayName: Enforce custom extraction processor type
description: Allow creation of custom extraction processors

Ganti ORGANIZATION_ID dengan ID organisasi Anda.

File ini menentukan batasan di mana jenis pemroses harus CUSTOM_EXTRACTION_PROCESSOR dalam metode CREATE.

Terapkan batasan menggunakan perintah gcloud org-policies set-custom-constraint:
```
gcloud org-policies set-custom-constraint CONSTRAINT_FILE_NAME.yaml
```

Pastikan batasan ada menggunakan perintah gcloud org-policies list-custom-constraints:

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

Outputnya mirip dengan hal berikut ini:

CUSTOM_CONSTRAINT              ACTION_TYPE   METHOD_TYPES   RESOURCE_TYPES                       DISPLAY_NAME
custom.enforceCustomExtractor  ALLOW         CREATE         documentai.googleapis.com/Processor  Enforce custom extraction processor type
...

Membuat kebijakan

Simpan file berikut sebagai POLICY_FILE_NAME.yaml:

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

Ganti PROJECT_ID dengan project ID Anda.

Terapkan kebijakan menggunakan perintah gcloud org-policies set-policy:
```
gcloud org-policies set-policy POLICY_FILE_NAME.yaml
```

Pastikan kebijakan ada menggunakan perintah gcloud org-policies list:

gcloud org-policies list --project=PROJECT_ID

Outputnya mirip dengan hal berikut ini:

CONSTRAINT                         LIST_POLICY  BOOLEAN_POLICY  ETAG
custom.enforceCustomExtractor      -            SET             CPiLkMMGEKDFq6IB-

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

Menguji kebijakan

Ikuti langkah-langkah untuk Membuat prosesor yang bukan merupakan prosesor ekstraksi kustom.

The output is similar to the following:

```none {:.devsite-disable-click-to-copy}
Operation denied by org policy on resource 'projects/test-project/locations/us': ["customConstraints/custom.enforceCustomExtractor": "Allow creation of custom extraction processors"]
```

Contoh kebijakan organisasi kustom untuk kasus penggunaan umum

Tabel ini memberikan contoh sintaksis untuk beberapa batasan kustom umum.

Deskripsi	Sintaksis batasan
Hanya pemroses ekstraksi kustom yang diizinkan.	name: organizations/`ORGANIZATION_ID`/customConstraints/custom.enforceCustomExtractor resourceTypes: - documentai.googleapis.com/Processor methodTypes: - CREATE condition: "resource.type == 'CUSTOM_EXTRACTION_PROCESSOR'" actionType: ALLOW displayName: Enforce custom extraction processor type description: Allow creation of custom extraction processors
Pastikan bahwa pemroses dienkripsi dengan kunci KMS.	name: organizations/`ORGANIZATION_ID`/customConstraints/custom.encrypted resourceTypes: - documentai.googleapis.com/Processor methodTypes: - CREATE condition: "resource.kmsKeyName.size() > 0" actionType: ALLOW displayName: Processor must be encrypted with a KMS key. description: Processor must be encrypted with a KMS key.

Deskripsi

Sintaksis batasan

Hanya pemroses ekstraksi kustom yang diizinkan.

    name: organizations/ORGANIZATION_ID/customConstraints/custom.enforceCustomExtractor
    resourceTypes:
    - documentai.googleapis.com/Processor
    methodTypes:
    - CREATE
    condition: "resource.type == 'CUSTOM_EXTRACTION_PROCESSOR'"
    actionType: ALLOW
    displayName: Enforce custom extraction processor type
    description: Allow creation of custom extraction processors

Pastikan bahwa pemroses dienkripsi dengan kunci KMS.

    name: organizations/ORGANIZATION_ID/customConstraints/custom.encrypted
    resourceTypes:
    - documentai.googleapis.com/Processor
    methodTypes:
    - CREATE
    condition: "resource.kmsKeyName.size() > 0"
    actionType: ALLOW
    displayName: Processor must be encrypted with a KMS key.
    description: Processor must be encrypted with a KMS key.

Resource yang didukung Document AI

Tabel berikut mencantumkan resource Document AI yang dapat Anda rujuk dalam batasan kustom.

Resource	Kolom
documentai.googleapis.com/Processor	`resource.displayName`
	`resource.kmsKeyName`
	`resource.type`
documentai.googleapis.com/ProcessorVersion	`resource.displayName`

Langkah berikutnya

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

Sebelumnya

Menambahkan logging audit

Membuat batasan kustom untuk Document AI Tetap teratur dengan koleksi Simpan dan kategorikan konten berdasarkan preferensi Anda.

Tentang batasan dan kebijakan organisasi

Pewarisan kebijakan

Sebelum memulai

Peran yang diperlukan

Menyiapkan batasan kustom

Konsol

gcloud

Menerapkan kebijakan organisasi kustom

Konsol

gcloud

Menguji kebijakan organisasi kustom

Membuat batasan

Membuat kebijakan

Menguji kebijakan

Contoh kebijakan organisasi kustom untuk kasus penggunaan umum

Resource yang didukung Document AI

Langkah berikutnya

Membuat batasan kustom untuk Document AI