Menggunakan batasan kustom dengan pipeline

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

  • aiplatform.googleapis.com/PipelineJob

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 operasi tertentu pada resource Vertex AI Pipelines. Misalnya, jika URI template yang ditentukan untuk membuat resource PipelineJob gagal memenuhi validasi set batasan kustom yang ditetapkan oleh kebijakan organisasi Anda, permintaan akan gagal, dan error akan ditampilkan kepada pemanggil.

Batasan

Kebijakan organisasi kustom tidak diterapkan pada proses pipeline yang dijadwalkan menggunakan scheduler API.

Sebelum memulai

1. Menyiapkan project Anda
  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. Make sure that billing is enabled for your Google Cloud project.

  4. Enable the Vertex AI, Compute Engine, and Cloud Storage APIs.

    Enable the APIs

  5. Install the Google Cloud CLI.

  6. If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

  7. To initialize the gcloud CLI, run the following command: 

    gcloud init

  8. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  9. Make sure that billing is enabled for your Google Cloud project.

  10. Enable the Vertex AI, Compute Engine, and Cloud Storage APIs.

    Enable the APIs

  11. Install the Google Cloud CLI.

  12. If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

  13. To initialize the gcloud CLI, run the following command: 

    gcloud init
  14. Dapatkan ID resource organisasi Anda.
  15. Tentukan dan kompilasi pipeline yang dapat Anda gunakan untuk menguji batasan kustom.

    16. Peran yang diperlukan

    Untuk mendapatkan izin yang diperlukan untuk mengelola kebijakan organisasi, minta administrator Anda untuk memberi Anda peran IAM berikut:

    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
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.denyPipelineTemplate. 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/PipelineJob/resource.templateUri.

    • 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.templateUri.contains("test")"

    • 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.denyPipelineTemplate

    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 tidak mengizinkan pembuatan proses pipeline dengan menentukan URI template yang berisi "test".

    Sebelum memulai, Anda harus mengetahui hal-hal berikut:

    • ID organisasi Anda
    • Project ID

    Membuat batasan

    1. Simpan file berikut sebagai constraint-validate-pipeline-template-uri.yaml:

      name: organizations/ORGANIZATION_ID/customConstraints/custom.denyPipelineTemplate
resourceTypes:
- resource.templateUri
methodTypes:
  - CREATE
  condition: "resource.templateUri.contains("test")"
  actionType: DENY
  displayName: Deny pipeline runs if the template URI contains 'test'
  description: Deny the creation of a new pipeline run if it's based on a template URI containing 'test'

      Hal ini menentukan batasan di mana URI template pipeline tidak boleh berisi test.

      1. Terapkan batasan:

        gcloud org-policies set-custom-constraint ~/constraint-validate-pipeline-template-uri.yaml

      2. 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.denyPipelineTemplate                DENY         CREATE         resource.templateUri    Deny pipeline runs if the template URI contains 'test'
...

    Membuat kebijakan

    1. Simpan file berikut sebagai policy-validate-pipeline-template-uri.yaml:

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

      Ganti PROJECT_ID dengan project ID Anda.

    2. Terapkan kebijakan:

        gcloud org-policies set-policy ~/policy-validate-pipeline-template-uri.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.denyPipelineTemplate   -              SET               COCsm5QGENiXi2E=

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

    Menguji kebijakan

    Mencoba membuat pipeline ML dengan URI template yang berisi test.

    REST

    Untuk membuat resource PipelineJob, kirim permintaan POST menggunakan metode pipelineJobs/create.

    Sebelum menggunakan salah satu data permintaan, lakukan penggantian berikut:

    • LOCATION: Region tempat Anda ingin membuat eksekusi pipeline. Untuk mengetahui informasi selengkapnya tentang region yang menyediakan Vertex AI Pipelines, lihat panduan lokasi Vertex AI Pipelines.
    • PROJECT_ID: Project Google Cloud tempat Anda ingin membuat eksekusi pipeline.
    • DISPLAY_NAME: Nama eksekusi pipeline. ID ini akan ditampilkan di konsol Google Cloud .

    Metode HTTP dan URL: 

    POST https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/pipelineJobs

    Isi JSON permintaan: 

    {
  "displayName":"DISPLAY_NAME",
  "templateUri":"test_pipeline_template.json"
}

    Untuk mengirim permintaan Anda, pilih salah satu opsi berikut:

    curl

    Simpan isi permintaan dalam file bernama request.json, dan jalankan perintah berikut: 

    curl -X POST \
         -H "Authorization: Bearer $(gcloud auth print-access-token)" \
         -H "Content-Type: application/json; charset=utf-8" \
         -d @request.json \
         "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/pipelineJobs"

    PowerShell

    Simpan isi permintaan dalam file bernama request.json, dan jalankan perintah berikut: 

    $cred = gcloud auth print-access-token
    $headers = @{ "Authorization" = "Bearer $cred" }

    Invoke-WebRequest `
        -Method POST `
        -Headers $headers `
        -ContentType: "application/json; charset=utf-8" `
        -InFile request.json `
        -Uri "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/pipelineJobs" | Select-Object -Expand Content

    Anda akan melihat respons JSON seperti berikut:

    {
  "error": {
    "code": 400,
    "message": "Operation denied by org policy on resource 'projects/PROJECT_ID/locations/LOCATION': [\"customConstraints/custom.denyPipelineTemplate\": \"Deny the creation of a new pipeline run if it's based on a template URI containing 'test'\"]",
    "status": "FAILED_PRECONDITION",
    "details": [
      {
        "@type": "type.googleapis.com/google.rpc.ErrorInfo",
        "reason": "CUSTOM_ORG_POLICY_VIOLATION",
        "domain": "googleapis.com",
        "metadata": {
          "service": "aiplatform.googleapis.com",
          "customConstraints": "customConstraints/custom.denyPipelineTemplate"
        }
      }
    ]
  }
}

    Resource yang didukung Vertex AI Pipelines

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

    Resource Kolom
    aiplatform.googleapis.com/PipelineJob resource.displayName
    resource.encryptionSpec.kmsKeyName
    resource.network
    resource.pipelineSpec
    resource.preflightValidations
    resource.pscInterfaceConfig.networkAttachment
    resource.reservedIpRanges
    resource.runtimeConfig.failurePolicy
    resource.runtimeConfig.gcsOutputDirectory
    resource.runtimeConfig.inputArtifacts[*].artifactId
    resource.runtimeConfig.parameterValues[*].boolValue
    resource.runtimeConfig.parameterValues[*].listValue.values
    resource.runtimeConfig.parameterValues[*].nullValue
    resource.runtimeConfig.parameterValues[*].numberValue
    resource.runtimeConfig.parameterValues[*].stringValue
    resource.runtimeConfig.parameterValues[*].structValue
    resource.serviceAccount
    resource.templateUri

    Langkah berikutnya