Membuat batasan kebijakan organisasi kustom

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

  • aiplatform.googleapis.com/NotebookExecutionJob
  • aiplatform.googleapis.com/NotebookRuntime
  • aiplatform.googleapis.com/NotebookRuntimeTemplate

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. 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 khusus dan menggunakan batasan khusus 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 Colab Enterprise. Misalnya, jika permintaan untuk membuat template runtime Colab Enterprise gagal memenuhi validasi batasan kustom sebagaimana ditetapkan oleh kebijakan organisasi Anda, permintaan akan gagal dan error akan ditampilkan kepada pemanggil.

Batasan

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

  • Kebijakan baru tidak memengaruhi konfigurasi resource yang ada.
  • Konfigurasi resource yang ada tetap valid meskipun memiliki nilai yang tidak sesuai, kecuali jika diperbarui.
  • Kebijakan organisasi kustom tidak diterapkan pada proses notebook terjadwal kecuali proses notebook dijadwalkan menggunakan API secara langsung.

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.

    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.

    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 Administrator Kebijakan Organisasi (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 khusus atau peran bawaan lainnya.

    Membuat batasan khusus

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

    Untuk membuat batasan khusus, 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.restrictMachineSpecForNotebookRuntimeTemplate. Panjang maksimum kolom ini adalah 70 karakter.

    • RESOURCE_NAME: nama lengkap Google Cloud resource yang berisi objek dan kolom yang ingin Anda batasi. Misalnya, aiplatform.googleapis.com/NotebookRuntimeTemplate.

    • 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.machineSpec.machineType != \"n1-standard-2\""

    • 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 khusus 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 khusus 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 Kebijakan organisasi.

      Buka Organization policies

    2. Dari pemilih project, pilih project yang ingin Anda tetapkan kebijakan organisasinya.
    3. Dari daftar di halaman Kebijakan organisasi, pilih batasan Anda untuk melihat halaman Detail kebijakan 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.restrictMachineSpecForNotebookRuntimeTemplate

    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 memblokir pembuatan template runtime notebook yang tidak menggunakan jenis mesin n1-standard-2.

    Sebelum memulai, Anda harus mengetahui hal-hal berikut:

    • ID organisasi Anda
    • Project ID

    Membuat batasan

    1. Simpan file berikut sebagai constraint-notebook-runtime-template.yaml:

      name: organizations/ORGANIZATION_ID/customConstraints/custom.restrictMachineSpecForNotebookRuntimeTemplate
      resourceTypes:
      - aiplatform.googleapis.com/NotebookRuntimeTemplate
      methodTypes:
      - CREATE
      condition: "resource.machineSpec.machineType != \"n1-standard-2\""
      actionType: DENY
      displayName: Restrict machine type for notebook runtime templates
      description: All new notebook runtime templates must use n1-standard-2 machines
      

      Hal ini menentukan batasan bahwa setiap template runtime notebook baru harus menggunakan jenis mesin n1-standard-2, jika tidak, pembuatan template runtime akan ditolak.

    2. Terapkan batasan:

      gcloud org-policies set-custom-constraint ~/constraint-notebook-runtime-template.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.restrictMachineSpecForNotebookRuntimeTemplate  DENY         CREATE         aiplatform.googleapis.com/NotebookRuntimeTemplate  Restrict machine type for notebook runtime templates
      ...
      

    Membuat kebijakan

    1. Simpan file berikut sebagai policy-deny-machine-type.yaml:

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

      Ganti PROJECT_ID dengan project ID Anda.

    2. Terapkan kebijakan:

      gcloud org-policies set-policy ~/policy-deny-machine-type.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.restrictMachineSpecForNotebookRuntimeTemplate  -            SET                   CPHYssIGEOi23pAB-
      

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

    Menguji kebijakan

    Coba buat template runtime Colab Enterprise dengan jenis mesin yang dibatasi dalam project:

    gcloud colab runtime-templates create --display-name="DISPLAY_NAME" \
        --project=PROJECT_ID \
        --region=LOCATION \
        --machine-type=n1-standard-4 \
        --accelerator-type=ACCELERATOR_TYPE \
        --accelerator-count=ACCELERATOR_COUNT
    

    Outputnya adalah sebagai berikut:

    Operation denied by custom org policies: ["customConstraints/custom.restrictMachineSpecForNotebookRuntimeTemplate": "All new notebook runtime templates must use n1-standard-2 machines."]
    

    Contoh kebijakan organisasi kustom untuk kasus penggunaan umum

    Tabel berikut memberikan sintaksis beberapa batasan khusus untuk kasus penggunaan umum:

    Deskripsi Sintaksis batasan
    Membatasi jenis mesin untuk template runtime Colab Enterprise
          name: organizations/ORGANIZATION_ID/customConstraints/custom.
          restrictMachineSpecForNotebookRuntimeTemplate
          resourceTypes:
          - aiplatform.googleapis.com/NotebookRuntimeTemplate
          methodTypes:
          - CREATE
          condition: "resource.machineSpec.machineType != "n1-standard-2""
          actionType: DENY
          displayName: Restrict machine type for notebook runtime templates
          description: All new notebook runtime templates must use n1-standard-2 machines.
        

    Resource yang didukung Colab Enterprise

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

    Resource Kolom
    aiplatform.googleapis.com/NotebookExecutionJob resource.customEnvironmentSpec.machineSpec.acceleratorCount
    resource.customEnvironmentSpec.machineSpec.acceleratorType
    resource.customEnvironmentSpec.machineSpec.machineType
    resource.customEnvironmentSpec.machineSpec.reservationAffinity.key
    resource.customEnvironmentSpec.machineSpec.reservationAffinity.reservationAffinityType
    resource.customEnvironmentSpec.machineSpec.reservationAffinity.values
    resource.customEnvironmentSpec.machineSpec.tpuTopology
    resource.customEnvironmentSpec.networkSpec.enableInternetAccess
    resource.customEnvironmentSpec.networkSpec.network
    resource.customEnvironmentSpec.networkSpec.subnetwork
    resource.customEnvironmentSpec.persistentDiskSpec.diskSizeGb
    resource.customEnvironmentSpec.persistentDiskSpec.diskType
    resource.dataformRepositorySource.commitSha
    resource.dataformRepositorySource.dataformRepositoryResourceName
    resource.displayName
    resource.encryptionSpec.kmsKeyName
    resource.executionTimeout
    resource.executionUser
    resource.gcsNotebookSource.generation
    resource.gcsNotebookSource.uri
    resource.gcsOutputUri
    resource.kernelName
    resource.notebookRuntimeTemplateResourceName
    resource.scheduleResourceName
    resource.serviceAccount
    aiplatform.googleapis.com/NotebookRuntime resource.description
    resource.displayName
    resource.runtimeUser
    aiplatform.googleapis.com/NotebookRuntimeTemplate resource.dataPersistentDiskSpec.diskSizeGb
    resource.dataPersistentDiskSpec.diskType
    resource.description
    resource.displayName
    resource.encryptionSpec.kmsKeyName
    resource.eucConfig.eucDisabled
    resource.idleShutdownConfig.idleShutdownDisabled
    resource.idleShutdownConfig.idleTimeout
    resource.machineSpec.acceleratorCount
    resource.machineSpec.acceleratorType
    resource.machineSpec.machineType
    resource.machineSpec.reservationAffinity.key
    resource.machineSpec.reservationAffinity.reservationAffinityType
    resource.machineSpec.reservationAffinity.values
    resource.machineSpec.tpuTopology
    resource.networkSpec.enableInternetAccess
    resource.networkSpec.network
    resource.networkSpec.subnetwork
    resource.networkTags
    resource.notebookRuntimeType
    resource.reservationAffinity.consumeReservationType
    resource.reservationAffinity.key
    resource.reservationAffinity.values
    resource.shieldedVmConfig.enableSecureBoot
    resource.softwareConfig.colabImage.releaseName

    Langkah berikutnya