Mengelola resource Infrastructure Manager menggunakan batasan kustom

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

  • config.googleapis.com/Deployment
  • config.googleapis.com/Preview

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

  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 Anda perlukan untuk mengelola kebijakan organisasi, minta administrator Anda untuk memberi Anda peran IAM berikut:

    Untuk mengetahui informasi selengkapnya tentang pemberian peran, lihat Mengelola akses ke project, folder, dan organisasi.

    Peran bawaan ini berisi izin yang diperlukan untuk mengelola kebijakan organisasi. Untuk melihat izin yang benar-benar diperlukan, perluas bagian Izin yang diperlukan:

    Izin yang diperlukan

    Izin berikut diperlukan untuk mengelola kebijakan organisasi:

    • orgpolicy.* pada resource organisasi
    • Untuk membuat atau memperbarui deployment atau melihat pratinjau deployment:
      • config.deployments.create pada resource project
      • config.deployments.update pada resource project
      • config.previews.create pada resource project

    Anda mungkin juga bisa mendapatkan izin ini dengan 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, CONSTRAINT_NAME. Kolom ini dapat berisi hingga 70 karakter.
      • RESOURCE_NAME: nama lengkap resource Google Cloud yang berisi objek dan kolom yang ingin Anda batasi. Misalnya, config.googleapis.com/Deployment.
      • CONDITION: Kondisi CEL yang ditulis berdasarkan representasi resource layanan yang didukung. Kolom ini dapat berisi hingga 1000 karakter. Misalnya, resource.importExistingResources == true.

        • 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. Untuk menyelesaikan dan menerapkan kebijakan organisasi, klik Set policy. Kebijakan ini memerlukan waktu hingga 15 menit untuk diterapkan.

    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

      Ganti kode berikut:

      • PROJECT_ID: project tempat Anda ingin menerapkan batasan.
      • CONSTRAINT_NAME: nama batasan yang ingin Anda terapkan. Contoh, CONSTRAINT_NAME.
    2. Untuk menerapkan kebijakan organisasi yang berisi batasan, jalankan perintah berikut: 
      3.         gcloud org-policies set-policy POLICY_PATH

      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 melarang semua deployment baru mengimpor resource yang ada.

    Sebelum memulai, Anda harus memiliki hal berikut:

    • ID organisasi Anda
    • Project ID

    Membuat batasan

    Untuk membuat batasan kustom, ikuti langkah-langkah berikut:

    1. Buat file YAML berikut dan simpan sebagai constraint-import-resources.yaml:

      name: organizations/ORGANIZATION_ID/customConstraints/custom.disallowImportExistingResources
resourceTypes:
- config.googleapis.com/Deployment
methodTypes:
- CREATE
condition: "resource.importExistingResources == true"
actionType: DENY
displayName: Reject existing resources
description: New deployments disallow the import of existing resources.

      Ganti ORGANIZATION_ID dengan ID organisasi Anda.

      Hal ini menentukan batasan yang mencegah deployment baru mengimpor resource yang ada saat dibuat.

    2. Terapkan batasan:

      gcloud org-policies set-custom-constraint ~/constraint-import-resources

    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.disallowImportExistingResources                DENY         CREATE         config.googleapis.com/Deployment    Reject existing resources
...

    Membuat kebijakan

    Sekarang buat kebijakan dan terapkan ke batasan kustom yang Anda buat.

    1. Simpan file berikut sebagai policy-enforce-import-constraint.yaml:

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

      Ganti PROJECT_ID dengan project ID Anda.

    2. Terapkan kebijakan:

      gcloud org-policies set-policy ~/policy-enforce-import-constraint.yaml

    3. Pastikan kebijakan ada:

      gcloud org-policies list --project=PROJECT_ID

      Outputnya mirip dengan contoh berikut:

      CONSTRAINT                                 LIST_POLICY    BOOLEAN_POLICY    ETAG
custom.disallowImportExistingResources     -              SET               COCsm5QGENiXi2E=

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

    Menguji kebijakan

    Coba buat deployment Infra Manager yang mengimpor resource yang ada dalam project:

    gcloud infra-manager deployments apply projects/PROJECT_ID/locations/us-central1/deployments/quickstart-deployment \
    --service-account=projects/PROJECT_ID/serviceAccounts/SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com \
    --git-source-repo=https://github.com/terraform-google-modules/terraform-google-network \
    --git-source-directory=modules/vpc \
    --git-source-ref=main \
    --input-values=project_id=PROJECT_ID,network_name=quickstart-vpc

    Outputnya adalah sebagai berikut:

    Operation denied by custom org policies: ["customConstraints/custom.disallowImportExistingResources": "New deployments disallow the import of existing resources."]

    Contoh kebijakan organisasi kustom untuk kasus penggunaan umum

    Tabel ini memberikan contoh sintaksis untuk beberapa batasan kustom umum.

    Deskripsi Sintaksis batasan
    Menonaktifkan impor resource yang ada untuk deployment baru 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.disallowImportExistingResources
    resourceTypes:
    ‐ config.googleapis.com/Deployment
    methodTypes:
    ‐ CREATE
    condition: "resource.importExistingResources == true"
    actionType: DENY
    displayName: Reject existing resources
    description: New deployments disallow the import of existing resources

    Resource yang didukung Infrastructure Manager

    Tabel berikut mencantumkan resource Infrastructure Manager yang dapat Anda referensikan dalam batasan kustom.

    Resource Kolom
    config.googleapis.com/Deployment resource.artifactsGcsBucket
    resource.importExistingResources
    resource.name
    resource.quotaValidation
    resource.serviceAccount
    resource.terraformBlueprint.gcsSource
    resource.terraformBlueprint.gitSource.directory
    resource.terraformBlueprint.gitSource.ref
    resource.terraformBlueprint.gitSource.repo
    resource.terraformBlueprint.inputValues[*].inputValue
    resource.tfVersionConstraint
    resource.workerPool
    config.googleapis.com/Preview resource.artifactsGcsBucket
    resource.deployment
    resource.name
    resource.previewMode
    resource.serviceAccount
    resource.terraformBlueprint.gcsSource
    resource.terraformBlueprint.gitSource.directory
    resource.terraformBlueprint.gitSource.ref
    resource.terraformBlueprint.gitSource.repo
    resource.terraformBlueprint.inputValues[*].inputValue
    resource.tfVersionConstraint
    resource.workerPool

    Langkah berikutnya