Mengelola resource Cloud Build dengan batasan khusus

Layanan Kebijakan Organisasi memberi Anda solusi yang terpusat dan terprogram kendali atas sumber daya organisasi Anda. Sebagai administrator kebijakan organisasi, Anda dapat menentukan kebijakan organisasi, yaitu seperangkat batasan yang disebut batasan yang berlaku untuk resource Cloud Build dan turunan dari resource tersebut di Hierarki resource Google Cloud. Anda dapat menerapkan kebijakan organisasi di level organisasi, folder, atau project.

Layanan Kebijakan Organisasi menyediakan batasan standar untuk berbagai Layanan Cloud Build. Namun, jika Anda ingin laporan yang lebih terperinci dan dapat disesuaikan kontrol atas bidang tertentu yang dibatasi di organisasi kebijakan, Anda juga dapat membuat kebijakan organisasi khusus.

Manfaat

Anda dapat menggunakan kebijakan organisasi kustom untuk mengizinkan atau menolak resource Cloud Build tertentu. Misalnya, jika permintaan untuk membuat atau memperbarui pemicu build gagal dipenuhi validasi batasan kustom yang ditetapkan oleh kebijakan organisasi, permintaan akan gagal dan pesan {i>error<i} akan disampaikan ke pemanggil.

Pewarisan kebijakan

Secara default, kebijakan organisasi diwarisi oleh turunan resource tempat Anda menerapkan kebijakan tersebut. Misalnya, jika Anda menerapkan kebijakan di folder, Cloud Build memberlakukan kebijakan pada semua project dalam folder tersebut. Untuk mempelajari lebih lanjut perilaku ini dan cara mengubahnya, lihat Aturan evaluasi hierarki.

Harga

Layanan Kebijakan Organisasi, termasuk kebijakan organisasi yang telah ditetapkan sebelumnya dan khusus, yang ditawarkan tanpa biaya.

Sebelum memulai

  1. Menyiapkan project
    1. 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.

    2. Di konsol Google Cloud, pada halaman pemilih project, pilih atau buat project Google Cloud.

      Buka pemilih project

    3. Pastikan penagihan telah diaktifkan untuk project Google Cloud Anda.

    4. Aktifkan API Cloud Build.

      Mengaktifkan API

    5. Menginstal Google Cloud CLI.

    6. Untuk initialize gcloud CLI, jalankan perintah berikut: 

      gcloud init

    7. Di konsol Google Cloud, pada halaman pemilih project, pilih atau buat project Google Cloud.

      Buka pemilih project

    8. Pastikan penagihan telah diaktifkan untuk project Google Cloud Anda.

    9. Aktifkan API Cloud Build.

      Mengaktifkan API

    10. Menginstal Google Cloud CLI.

    11. Untuk initialize gcloud CLI, jalankan perintah berikut: 

      gcloud init
    12. Pastikan Anda mengetahui ID organisasi Anda.

Peran yang diperlukan

Untuk mendapatkan izin yang Anda butuhkan untuk mengelola kebijakan organisasi, 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.

Anda juga perlu menambahkan peran yang diperlukan untuk membuat Cloud Build ke akun pengguna Anda. Lihat Mengonfigurasi akses ke resource Cloud Build. Kepada Pelajari peran IAM yang terkait dengan Cloud Build lebih lanjut, lihat Peran dan izin IAM.

Membuat batasan khusus

Anda dapat membuat batasan kustom menggunakan file YAML untuk menentukan resource, metode, kondisi, dan tindakan yang tunduk pada batasan tersebut. Kebijakan ini dikhususkan untuk layanan tempat Anda menerapkan kebijakan organisasi. Kondisi untuk batasan kustom Anda harus didefinisikan menggunakan {i>Common Expression Language<i}. Lihat halaman GitHub tentang 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.

Gunakan template berikut untuk membuat file YAML untuk batasan kustom:

name: organizations/ORGANIZATION_ID/customConstraints/CONSTRAINT_NAME
resourceTypes:
- cloudbuild.googleapis.com/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 khusus harus diawali dengan custom., dan dapat hanya berisi huruf besar, huruf kecil, atau angka, untuk contoh, custom.enableBuildTrigger. Panjang maksimum kolom ini adalah 70 karakter, tidak termasuk awalan. Misalnya, organizations/123456789/customConstraints/custom.allowConstraint.

  • RESOURCE_NAME: nama (bukan URI) Resource Cloud Build yang berisi objek dan kolom yang ingin Anda batasi. Contoh, BuildTrigger.

  • CONDITION: kondisi CEL yang ditulis berdasarkan representasi resource layanan yang didukung. Ini memiliki panjang maksimal 1000 karakter. Lihat Resource yang didukung untuk mengetahui informasi selengkapnya tentang resource yang tersedia untuk menulis kondisi. Contoh, "resource.github.name.contains('cloudbuild')"

  • ACTION: tindakan yang akan diambil jika condition terpenuhi. Ini dapat berupa ALLOW atau 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. Ini memiliki panjang maksimal 2000 karakter.

Untuk informasi selengkapnya tentang cara membuat batasan kustom, lihat Membuat dan mengelola kebijakan organisasi kustom.

Menyiapkan batasan kustom

Setelah membuat batasan khusus baru menggunakan Google Cloud CLI, Anda harus menyiapkannya agar tersedia untuk kebijakan organisasi di organisasi Anda. Untuk menyiapkan batasan khusus, 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. Contohnya, /home/user/customconstraint.yaml Setelah selesai, Anda akan menemukan batasan khusus sebagai kebijakan organisasi yang tersedia dalam daftar kebijakan organisasi Google Cloud Anda. Untuk memverifikasi bahwa batasan khusus ada, gunakan Perintah gcloud org-policies list-custom-constraints: 
gcloud org-policies list-custom-constraints --organization=ORGANIZATION_ID
Ganti ORGANIZATION_ID dengan ID fasilitas organisasi Anda. Untuk informasi selengkapnya, lihat Melihat kebijakan organisasi.

Menerapkan kebijakan organisasi khusus

Anda dapat menerapkan batasan boolean dengan membuat kebijakan organisasi yang mereferensikannya, dan menerapkan kebijakan organisasi tersebut ke resource Google Cloud.

Konsol

Untuk menerapkan batasan boolean:

  1. Di konsol Google Cloud, buka halaman Organization policies.

    Buka Organization policies

  2. Pilih pemilih project di bagian atas halaman.
  3. Dari pemilih project, pilih project yang ingin Anda setel kebijakan organisasi.
  4. Pilih batasan dari daftar di halaman Organization policies. Halaman Policy details untuk batasan tersebut akan muncul.
  5. Untuk mengonfigurasi kebijakan organisasi untuk resource ini, klik Kelola kebijakan.
  6. Di halaman Edit policy, pilih Override parent's policy.
  7. Klik Add a rule.
  8. Di bagian Enforcement, pilih apakah penerapan kebijakan organisasi ini harus diaktifkan atau dinonaktifkan.
  9. Secara opsional, untuk membuat kebijakan organisasi 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 detail selengkapnya, lihat Menetapkan kebijakan organisasi dengan tag.
  10. Jika ini adalah batasan khusus, Anda dapat mengklik Uji perubahan untuk menyimulasikan pengaruh kebijakan organisasi ini. Untuk informasi selengkapnya, lihat Uji perubahan kebijakan organisasi dengan Policy Simulator.
  11. Untuk menyelesaikan dan menerapkan kebijakan organisasi, klik Tetapkan kebijakan. Kebijakan ini akan memerlukan waktu hingga 15 menit untuk diterapkan.

gcloud

Untuk membuat kebijakan organisasi yang menerapkan batasan boolean, buat file YAML kebijakan yang merujuk batasan tersebut: 

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

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 batasan kustom

Untuk menguji batasan kustom, jalankan perintah gcloud yang mencoba menyelesaikan tugas yang diblokir oleh batasan Anda.

Misalnya, asumsikan bahwa batasan mengharuskan nama pemicu GitHub berisi "cloudbuild". Anda dapat menguji batasan ini dengan menjalankan perintah gcloud builds triggers create github dengan nama pemicu lain seperti yang ditunjukkan dalam cuplikan berikut:

gcloud builds triggers create github --name=github-trigger \
    --repo-owner=some-owner \
    --repo-name=some-repo \
    --branch-pattern=main \
    --build-config=cloudbuild.yaml \
    --project=my-project \

Outputnya mirip dengan hal berikut ini:

Operation denied by custom org policies: ["customConstraints/custom.enableBuildTrigger": "GitHub trigger name must include "cloudbuild"."]

Resource dan operasi yang didukung Cloud Build

Kolom batasan kustom Cloud Build berikut adalah yang tersedia untuk digunakan saat Anda membuat atau mengupdate resource Cloud Build.

Perhatikan bahwa batasan pada Build tidak diterapkan pada Build yang dipicu oleh pemicu.

  • Cloud Build BitbucketServerConfig
    • resource.name
    • resource.hostUrl
    • resource.secrets.adminAccessTokenVersionName
    • resource.secrets.readAccessTokenVersionName
    • resource.secrets.webhookSecretVersionName
    • resource.username
    • resource.apiKey
    • resource.peeredNetwork
    • resource.sslCa
    • resource.peeredNetworkIpRange
  • Konfigurasi WorkerPool Cloud Build
    • resource.displayName
    • resource.annotations
  • Konfigurasi BuildTrigger Cloud Build
    • resource.tags
    • resource.resourceName
    • resource.description
    • resource.name
    • resource.tags
    • resource.triggerTemplate.projectId
    • resource.triggerTemplate.repoName
    • resource.triggerTemplate.branchName
    • resource.triggerTemplate.tagName
    • resource.triggerTemplate.commitSha
    • resource.triggerTemplate.dir
    • resource.triggerTemplate.invertRegex
    • resource.triggerTemplate.substitutions
    • resource.github.owner
    • resource.github.name
    • resource.github.enterpriseConfigResourceName
    • resource.pubsubConfig.topic
    • resource.pubsubConfig.serviceAccountEmail
    • resource.webhookConfig.secret
    • resource.bitbucketServerTriggerConfig.repoSlug
    • resource.bitbucketServerTriggerConfig.projectKey
    • resource.bitbucketServerTriggerConfig.pullRequest.branch
    • resource.bitbucketServerTriggerConfig.pullRequest.commentControl
    • resource.bitbucketServerTriggerConfig.pullRequest.invertRegex
    • resource.bitbucketServerTriggerConfig.push.branch
    • resource.bitbucketServerTriggerConfig.push.tag
    • resource.bitbucketServerTriggerConfig.push.invertRegex
    • resource.gitlabEnterpriseEventsConfig.projectNamespace
    • resource.gitlabEnterpriseEventsConfig.pullRequest.branch
    • resource.gitlabEnterpriseEventsConfig.pullRequest.commentControl
    • resource.gitlabEnterpriseEventsConfig.pullRequest.invertRegex
    • resource.gitlabEnterpriseEventsConfig.push.branch
    • resource.gitlabEnterpriseEventsConfig.push.tag
    • resource.gitlabEnterpriseEventsConfig.push.invertRegex
    • resource.gitlabEnterpriseEventsConfig.gitlabConfigResource
    • resource.disabled
    • resource.substitutions
    • resource.ignoredFiles
    • resource.includedFiles
    • resource.sourceToBuild.uri
    • resource.sourceToBuild.repository
    • resource.sourceToBuild.ref
    • resource.sourceToBuild.repoType
    • resource.sourceToBuild.githubEnterpriseConfig
    • resource.approvalConfig.approvalRequired
    • resource.filter
    • resource.serviceAccount
    • resource.eventType
    • resource.includeBuildLogs
    • resource.repositoryEventConfig.repository
    • resource.repositoryEventConfig.pullRequest.branch
    • resource.repositoryEventConfig.pullRequest.commentControl
    • resource.repositoryEventConfig.pullRequest.invertRegex
    • resource.repositoryEventConfig.push.branch
    • resource.repositoryEventConfig.push.tag
    • resource.repositoryEventConfig.push.invertRegex

Contoh kebijakan organisasi kustom untuk kasus penggunaan umum

Tabel berikut memberikan sintaksis beberapa kebijakan organisasi khusus yang mungkin berguna bagi Anda:

Deskripsi Sintaksis batasan
Hanya izinkan pembuatan pemicu Pub/Sub yang memproses topik yang berisi "cloud-builds" 

    name: organizations/ORGANIZATION_ID/customConstraints/custom.enableCloudBuildPubsubTrigger
    resourceTypes:
    - cloudbuild.googleapis.com/BuildTrigger
    methodTypes:
    - CREATE
    condition: "resource.pubsubConfig != null && resource.pubsubConfig.topic.contains('cloud-builds')"
    actionType: ALLOW
    displayName: Enable creating Pub/Sub trigger that listens on topics that contain "cloud-builds".
    description: Only allow creating Pub/Sub trigger that listens on topics that contain "cloud-builds".
  • ORGANIZATION_ID: ID organisasi Anda, seperti 123456789.

Langkah selanjutnya