Membuat batasan kebijakan organisasi kustom

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

  • dataform.googleapis.com/Repository

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

Tentang batasan dan kebijakan organisasi

Google Cloud Layanan Kebijakan Organisasi 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 Google Cloud resource dan turunan dari resource tersebut dalam Google Cloud hierarki resource. Anda dapat menerapkan kebijakan organisasi di tingkat 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

Anda dapat menggunakan kebijakan organisasi kustom untuk mengizinkan atau menolak nilai tertentu untuk resource Dataform. Misalnya, jika permintaan untuk membuat atau mengupdate resource dataform.googleapis.com/Repository tidak lulus validasi batasan kustom sebagaimana ditetapkan oleh kebijakan organisasi Anda, permintaan akan gagal dan error akan ditampilkan kepada pemanggil.

Penggunaan kebijakan organisasi kustom menambahkan lapisan keamanan, kepatuhan, dan tata kelola tambahan. Misalnya, Anda dapat menentukan kebijakan yang hanya mengizinkan pembuatan resource di region tertentu, atau yang melarang penggunaan remote Git di luar organisasi Anda.

Batasan

Seperti semua batasan kebijakan organisasi, perubahan kebijakan tidak berlaku secara retroaktif pada resource yang ada:

  • Kebijakan baru tidak akan memengaruhi resource yang ada.
  • Jika Anda mengubah kebijakan, resource yang ada akan tetap valid, kecuali jika Anda mengubah resource dari nilai yang sesuai menjadi tidak sesuai menggunakan konsolGoogle Cloud atau RPC.

Sebaiknya buat semua resource yang ada mematuhi kebijakan sebelum menerapkan kebijakan baru. Untuk memeriksa resource yang ada yang tidak akan mematuhi kebijakan setelah Anda menerapkan kebijakan, gunakan Simulator Kebijakan untuk Kebijakan Organisasi.

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 (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 (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

    Untuk 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 cara memberikan peran, lihat Mengelola akses ke project, folder, dan organisasi.

    Anda mungkin juga bisa mendapatkan izin yang diperlukan melalui peran kustom atau peran yang telah ditentukan lainnya.

    Membuat 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 membangun kondisi dalam batasan kustom menggunakan CEL, lihat bagian CEL tentang Membuat dan mengelola batasan kustom.

    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. Batasan kustom harus diawali dengan custom., dan hanya boleh menyertakan huruf besar, huruf kecil, atau angka. Contohnya, custom.restrictRepositoryLocation. Panjang maksimum kolom ini adalah 70 karakter.

    • RESOURCE_NAME: nama Google Cloud resource yang sepenuhnya memenuhi syarat, yang berisi objek dan kolom yang ingin Anda batasi. Misalnya, dataform.googleapis.com/Repository.

    • CONDITION: kondisi CEL yang ditulis berdasarkan representasi resource layanan yang didukung. Kolom ini memiliki panjang maksimal 1.000 karakter. Lihat Resource yang didukung untuk mengetahui informasi selengkapnya tentang resource yang tersedia untuk menulis kondisi. Contoh, "resource.name.contains('/locations/us-central1/')"

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

    • DISPLAY_NAME: nama yang mudah dibaca manusia untuk batasan. Kolom ini memiliki panjang maksimal 200 karakter.

    • DESCRIPTION: deskripsi batasan yang mudah dipahami untuk ditampilkan sebagai pesan error saat kebijakan dilanggar. Kolom ini memiliki panjang maksimal 2.000 karakter.

    Untuk mengetahui informasi selengkapnya tentang cara membuat batasan kustom, lihat Menentukan batasan kustom.

    Menyiapkan batasan kustom

    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. Contohnya, /home/user/customconstraint.yaml Setelah selesai, batasan kustom Anda tersedia sebagai kebijakan organisasi dalam daftar kebijakan organisasi. Google Cloud Untuk memverifikasi bahwa ada 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. Untuk mengonfigurasi kebijakan organisasi untuk resource ini, klik Manage policy.
    5. Di halaman Edit kebijakan, pilih Ganti kebijakan induk.
    6. Klik Add a rule.
    7. Di bagian Penerapan, pilih apakah penerapan kebijakan organisasi ini diaktifkan atau dinonaktifkan.
    8. Opsional: Untuk membuat kebijakan organisasi bersyarat pada tag, klik Tambahkan kondisi. 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 Uji perubahan untuk menyimulasikan efek kebijakan organisasi. Simulasi kebijakan tidak tersedia untuk batasan terkelola lama. Untuk mengetahui informasi selengkapnya, lihat Menguji perubahan kebijakan organisasi dengan Policy Simulator.
    10. Untuk menyelesaikan dan menerapkan kebijakan organisasi, klik Set policy. Kebijakan ini memerlukan waktu hingga 15 menit untuk diterapkan.

    gcloud

    Untuk membuat kebijakan organisasi dengan aturan boolean, buat file YAML kebijakan yang merujuk batasan: 

          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 yang Anda tentukan untuk batasan kustom. Contoh, custom.restrictRepositoryLocation

    Untuk menerapkan kebijakan organisasi yang berisi batasan, jalankan perintah berikut: 

        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 mewajibkan semua resource dataform.googleapis.com/Repository dibuat di region tertentu.

    Sebelum memulai, Anda harus memiliki hal berikut:

    • ID organisasi Anda
    • Project ID

    Membuat batasan

    Untuk membuat batasan kustom, ikuti langkah-langkah berikut:

    1. Simpan file berikut sebagai constraint-restrict-repository-location.yaml:

      name: organizations/ORGANIZATION_ID/customConstraints/custom.restrictRepositoryLocation
resourceTypes:
- dataform.googleapis.com/Repository
methodTypes:
- CREATE
- UPDATE
condition: "resource.name.contains('/locations/us-central1/')"
actionType: ALLOW
displayName: Only us-central1 region is allowed.
description: All resources must be created in the us-central1 region.

      Ganti ORGANIZATION_ID dengan ID organisasi Anda.

      File ini menentukan batasan untuk setiap operasi pembuatan atau update pada resource dataform.googleapis.com/Repository, operasi hanya diizinkan jika region yang dipilih untuk resource adalah us-central1.

    2. Terapkan batasan:

      gcloud org-policies set-custom-constraint ~/constraint-restrict-repository-location.yaml

    3. Pastikan batasan ada:

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

      Outputnya mirip dengan yang berikut ini:

      CUSTOM_CONSTRAINT                       ACTION_TYPE  METHOD_TYPES   RESOURCE_TYPES                     DISPLAY_NAME
custom.restrictRepositoryLocation       ALLOW        CREATE,UPDATE  dataform.googleapis.com/Repository Only us-central1 region is allowed.
...

    Membuat kebijakan

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

    1. Simpan file berikut sebagai policy-restrict-repository-location.yaml:

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

      Ganti PROJECT_ID dengan project ID Anda.

    2. Terapkan kebijakan:

      gcloud org-policies set-policy ~/policy-restrict-repository-location.yaml

    3. Pastikan kebijakan ada:

      gcloud org-policies list --project=PROJECT_ID

      Outputnya mirip dengan hal berikut ini:

      CONSTRAINT                           LIST_POLICY    BOOLEAN_POLICY    ETAG
custom.restrictRepositoryLocation    -              SET               ETAG

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

    Menguji kebijakan

    Ikuti langkah-langkah di Membuat repositori untuk membuat resource dataform.googleapis.com/Repository di project Anda. Pilih region yang berbeda dengan region yang Anda tentukan dalam batasan kustom.

    Outputnya adalah sebagai berikut:

    Operation denied by custom org policies: ["customConstraints/custom.restrictRepositoryLocation": "All resources must be created in the us-central1 region."]

    Contoh kebijakan organisasi kustom untuk kasus penggunaan umum

    Tabel ini memberikan contoh sintaksis untuk beberapa batasan kustom umum.

    Deskripsi Sintaksis batasan
    Semua resource harus dibuat di region us-central1. 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.restrictRepositoryLocation
    resourceTypes:
    - dataform.googleapis.com/Repository
    methodTypes:
    - CREATE
    - UPDATE
    condition: "resource.name.contains('/locations/us-central1/')"
    actionType: ALLOW
    displayName: Only us-central1 region is allowed.
    description: All resources must be created in the us-central1 region.
    Hanya mengizinkan konfigurasi remote Git untuk terhubung menggunakan HTTPS ke repositori di organisasi Google di GitHub. 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.restrictGitRemote
    resourceTypes:
    - dataform.googleapis.com/Repository
    methodTypes:
    - CREATE
    - UPDATE
    condition: |-
      resource.gitRemoteSettings.url == ""
      || resource.gitRemoteSettings.url.startsWith('https://github.com/google/')
    actionType: ALLOW
    displayName:  Only allow the https://github.com/google/ Git remote.
    description: Only allow configuration of a Git remote to connect using HTTPS to repositories in the Google organization on GitHub.

    Resource yang didukung Dataform

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

    Resource Kolom
    dataform.googleapis.com/Repository resource.displayName
    resource.gitRemoteSettings.authenticationTokenSecretVersion
    resource.gitRemoteSettings.defaultBranch
    resource.gitRemoteSettings.sshAuthenticationConfig.hostPublicKey
    resource.gitRemoteSettings.sshAuthenticationConfig.userPrivateKeySecretVersion
    resource.gitRemoteSettings.url
    resource.kmsKeyName
    resource.name
    resource.npmrcEnvironmentVariablesSecretVersion
    resource.serviceAccount
    resource.setAuthenticatedUserAdmin
    resource.workspaceCompilationOverrides.defaultDatabase
    resource.workspaceCompilationOverrides.schemaSuffix
    resource.workspaceCompilationOverrides.tablePrefix

    Langkah berikutnya