Menggunakan kebijakan organisasi kustom

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

  • monitoring.googleapis.com/AlertPolicy
  • monitoring.googleapis.com/NotificationChannel
  • monitoring.googleapis.com/Snooze

Untuk mempelajari Kebijakan Organisasi lebih lanjut, 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 resourceGoogle Cloud dan turunan dari resource tersebut dalam hierarki resourceGoogle Cloud . Anda dapat menerapkan kebijakan organisasi di tingkat organisasi, folder, atau project.

Kebijakan Organisasi memberikan batasan yang telah ditetapkan untuk berbagai layanan Google Cloud . Namun, jika ingin 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 dalam 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.

    Go to project selector

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

  4. Install the Google Cloud CLI.

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

    gcloud init

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

    Go to project selector

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

  8. Install the Google Cloud CLI.

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

    gcloud init
  10. Pastikan Anda mengetahui ID organisasi Anda.

Peran yang diperlukan

Untuk mendapatkan izin yang diperlukan guna 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 dapat menyertakan huruf besar, huruf kecil, atau angka. Contohnya, alertDocHasProject. Panjang maksimum kolom ini adalah 70 karakter.

  • RESOURCE_NAME: nama lengkap resourceGoogle Cloud yang berisi objek dan kolom yang ingin Anda batasi. Misalnya, monitoring.googleapis.com/AlertPolicy.

  • 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.documentation.content.contains('${resource.project}')

  • ACTION: tindakan yang akan diambil jika condition terpenuhi. Kemungkinan nilainya 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 kustom Anda akan tersedia sebagai kebijakan organisasi dalam daftar Google Cloud kebijakan organisasi Anda. 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 fasilitas organisasi Anda. Untuk mengetahui informasi selengkapnya, lihat Melihat kebijakan organisasi.

Menerapkan kebijakan organisasi kustom

Anda dapat menerapkan batasan boolean 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 untuk melihat halaman Policy details untuk batasan tersebut.
  4. Untuk 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 Enforcement, pilih apakah penerapan kebijakan organisasi ini diaktifkan atau dinonaktifkan.
  8. 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 mengetahui informasi selengkapnya, lihat Menetapkan kebijakan organisasi dengan tag.
  9. Jika ini adalah batasan kustom, Anda dapat mengklik Uji perubahan untuk menyimulasikan efek kebijakan organisasi ini. 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 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 batasan yang ingin Anda terapkan. Misalnya, alertDocHasProject.

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 khusus dan kebijakan yang memeriksa apakah dokumentasi kebijakan pemberitahuan menyebutkan nama project.

Sebelum memulai, ganti hal berikut:

  • ORGANIZATION_ID: ID numerik unik organisasi. Untuk informasi tentang cara mendapatkan ID ini, lihat Mendapatkan ID organisasi.
  • PROJECT_ID: ID project.

Membuat batasan

  1. Simpan file berikut sebagai constraint-alert-doc-has-project.yaml:

        actionType: DENY
    condition: resource.documentation.content.contains('${resource.project}')
    description: Requires documentation to include the project name.
    displayName: Alerting policy documentation must include project name.
    methodTypes:
      - CREATE
      - UPDATE
    name: organizations/ORGANIZATION_ID/customConstraints/custom.alertDocHasProject
    resourceTypes:
      - monitoring.googleapis.com/AlertPolicy

    Ganti ORGANIZATION_ID dengan ID organisasi Anda.

    Batasan ini mencegah kebijakan pemberitahuan dibuat atau diperbarui jika nama project resource tidak ada dalam dokumentasi kebijakan pemberitahuan.

  2. Terapkan batasan:

    gcloud org-policies set-custom-constraint ~/constraint-alert-doc-has-project.yaml

  3. Pastikan batasan ada:

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

    Outputnya mirip dengan yang berikut ini:

    CUSTOM_CONSTRAINT: custom.alertDocHasProject
ACTION_TYPE: DENY
METHOD_TYPES: CREATE,UPDATE
RESOURCE_TYPES: monitoring.googleapis.com/AlertPolicy
DISPLAY_NAME: Alerting policy documentation must include the project name.

Membuat kebijakan

  1. Simpan file berikut sebagai policy-alert-doc-has-project.yaml:

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

    Ganti PROJECT_ID dengan project ID Anda.

  2. Terapkan kebijakan:

    gcloud org-policies set-policy ~/policy-alert-doc-has-project.yaml

  3. Pastikan kebijakan ada:

    gcloud org-policies list --project=PROJECT_ID

    Outputnya mirip dengan hal berikut ini:

    CONSTRAINT: custom.alertDocHasProject
LIST_POLICY: -
BOOLEAN_POLICY: SET
ETAG: CKSx5LwGEPjBuKwD-

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

Menguji kebijakan

Coba buat kebijakan pemberitahuan dengan dokumentasi yang mengecualikan nama project resource.

  gcloud alpha monitoring policies create \
    --display-name="CPU Utilization - 5% Threshold" \
    --project=PROJECT_ID \
    --condition-display-name="Condition 1" \
    --condition-filter='resource.type="gce_instance" AND metric.type="compute.googleapis.com/instance/cpu/utilization"' \
    --duration='60s' \
    --if='>5' \
    --combiner='AND' \
    --documentation='The ${metric.display_name} of the ${resource.type} ${resource.label.instance_id} has exceeded 5% for over 60 seconds.' \

Ganti PROJECT_ID dengan project ID Anda.

Outputnya adalah sebagai berikut:

  Operation denied by custom org policies: ["customConstraints/alertDocHasProject": "Alerting policy documentation must include project name."]

Contoh kebijakan organisasi kustom untuk kasus penggunaan umum

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

Deskripsi Sintaksis batasan
Kebijakan pemberitahuan hanya boleh memiliki satu kondisi 
    actionType: DENY
    condition: "resource.conditions.size() > 1"
    description: Requires alerting policies to have only one condition.
    displayName: Alerting policies must have only one condition
    methodTypes:
      - CREATE
      - UPDATE
    name: organizations/ORGANIZATION_ID/customConstraints/custom.oneCondition
    resourceTypes:
      - monitoring.googleapis.com/AlertPolicy
Kebijakan pemberitahuan harus menggunakan minimal dua saluran notifikasi 
    actionType: DENY
    condition: "resource.notificationChannels.size() < 2"
    description: Alerting policies must use at least two notification channels.
    displayName: Policies must have a backup notification channel
    methodTypes:
      - CREATE
      - UPDATE
    name: organizations/ORGANIZATION_ID/customConstraints/custom.alertOnTwoChannels
    resourceTypes:
      - monitoring.googleapis.com/AlertPolicy
Hanya izinkan saluran notifikasi email 
    actionType: DENY
    condition: "resource.type != 'email'"
    description: Requires notification channels to use only the email channel
    type.
    displayName: Always use email for notification channels
    methodTypes:
      - CREATE
      - UPDATE
    name: organizations/ORGANIZATION_ID/customConstraints/custom.emailChannelsOnly
    resourceTypes:
      - monitoring.googleapis.com/NotificationChannel
Penundaan harus kurang dari satu jam 
    actionType: DENY
    condition: "int(resource.interval.endTime) > int(resource.interval.startTime) + 3600"
    description: Requires snoozes to be under 1 hour.
    displayName: Snooze must be less than 1 hour
    methodTypes:
    - CREATE
    - UPDATE
    name: organizations/ORGANIZATION_ID/customConstraints/custom.setMaxSnooze
    resourceTypes:
    - monitoring.googleapis.com/Snooze

Resource yang didukung Cloud Monitoring

Tabel berikut mencantumkan resource Cloud Monitoring yang dapat Anda referensikan dalam batasan kustom.

Resource Kolom
monitoring.googleapis.com/AlertPolicy resource.alertStrategy.autoClose
resource.alertStrategy.notificationChannelStrategy.notificationChannelNames
resource.alertStrategy.notificationChannelStrategy.renotifyInterval
resource.alertStrategy.notificationRateLimit.period
resource.combiner
resource.conditions.conditionAbsent.aggregations.alignmentPeriod
resource.conditions.conditionAbsent.aggregations.crossSeriesReducer
resource.conditions.conditionAbsent.aggregations.groupByFields
resource.conditions.conditionAbsent.aggregations.perSeriesAligner
resource.conditions.conditionAbsent.duration
resource.conditions.conditionAbsent.filter
resource.conditions.conditionAbsent.trigger.count
resource.conditions.conditionAbsent.trigger.percent
resource.conditions.conditionMatchedLog.filter
resource.conditions.conditionMatchedLog.labelExtractors
resource.conditions.conditionMonitoringQueryLanguage.duration
resource.conditions.conditionMonitoringQueryLanguage.evaluationMissingData
resource.conditions.conditionMonitoringQueryLanguage.query
resource.conditions.conditionMonitoringQueryLanguage.trigger.count
resource.conditions.conditionMonitoringQueryLanguage.trigger.percent
resource.conditions.conditionPrometheusQueryLanguage.alertRule
resource.conditions.conditionPrometheusQueryLanguage.duration
resource.conditions.conditionPrometheusQueryLanguage.evaluationInterval
resource.conditions.conditionPrometheusQueryLanguage.labels
resource.conditions.conditionPrometheusQueryLanguage.query
resource.conditions.conditionPrometheusQueryLanguage.ruleGroup
resource.conditions.conditionSql.booleanTest.column
resource.conditions.conditionSql.daily.periodicity
resource.conditions.conditionSql.hourly.minuteOffset
resource.conditions.conditionSql.hourly.periodicity
resource.conditions.conditionSql.minutes.periodicity
resource.conditions.conditionSql.query
resource.conditions.conditionSql.rowCountTest.comparison
resource.conditions.conditionSql.rowCountTest.threshold
resource.conditions.conditionThreshold.aggregations.alignmentPeriod
resource.conditions.conditionThreshold.aggregations.crossSeriesReducer
resource.conditions.conditionThreshold.aggregations.groupByFields
resource.conditions.conditionThreshold.aggregations.perSeriesAligner
resource.conditions.conditionThreshold.comparison
resource.conditions.conditionThreshold.denominatorAggregations.alignmentPeriod
resource.conditions.conditionThreshold.denominatorAggregations.crossSeriesReducer
resource.conditions.conditionThreshold.denominatorAggregations.groupByFields
resource.conditions.conditionThreshold.denominatorAggregations.perSeriesAligner
resource.conditions.conditionThreshold.denominatorFilter
resource.conditions.conditionThreshold.duration
resource.conditions.conditionThreshold.evaluationMissingData
resource.conditions.conditionThreshold.filter
resource.conditions.conditionThreshold.forecastOptions.forecastHorizon
resource.conditions.conditionThreshold.thresholdValue
resource.conditions.conditionThreshold.trigger.count
resource.conditions.conditionThreshold.trigger.percent
resource.conditions.displayName
resource.conditions.name
resource.displayName
resource.documentation.content
resource.documentation.links.displayName
resource.documentation.links.url
resource.documentation.mimeType
resource.documentation.subject
resource.enabled
resource.name
resource.notificationChannels
resource.severity
monitoring.googleapis.com/NotificationChannel resource.description
resource.displayName
resource.enabled
resource.type
monitoring.googleapis.com/Snooze resource.criteria.policies
resource.displayName
resource.interval.endTime
resource.interval.startTime

Langkah berikutnya