Membuat batasan kustom untuk Pencadangan untuk GKE

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

  • gkebackup.googleapis.com/BackupPlan
  • gkebackup.googleapis.com/Backup
  • gkebackup.googleapis.com/RestorePlan
  • gkebackup.googleapis.com/Restore

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

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 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.retentionPolicyEnforced. 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, gkebackup.googleapis.com/Backup.

    • 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.retainDays > 30"

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

    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

    Langkah-langkah berikut menunjukkan cara membuat kebijakan dan batasan kustom yang memungkinkan pengguna membuat cadangan Pencadangan untuk GKE jika kolom retainDays ditetapkan ke nilai yang lebih besar dari 30.

    Sebelum Anda memulai, siapkan hal berikut:

    • ID organisasi Anda
    • Project ID Anda

    Membuat batasan

    1. Simpan file berikut sebagai CONSTRAINT_FILE_NAME.yaml:

      name: organizations/ORGANIZATION_ID/customConstraints/custom.retentionPolicyEnforced
resourceTypes:
- gkebackup.googleapis.com/Backup
methodTypes:
- CREATE
condition: "resource.retainDays > 30"
actionType: ALLOW
displayName: Enforce retention policy
description: Enforce backup creation with a retention policy greater than 30 days.

      Ganti ORGANIZATION_ID dengan ID organisasi Anda.

      File ini menentukan batasan di mana kolom retainDays harus lebih besar dari 30 dalam metode CREATE.

    2. Terapkan batasan menggunakan perintah gcloud org-policies set-custom-constraint:

      gcloud org-policies set-custom-constraint CONSTRAINT_FILE_NAME.yaml

    3. Pastikan batasan ada menggunakan perintah gcloud org-policies list-custom-constraints:

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

      Outputnya mirip dengan hal berikut ini:

      CUSTOM_CONSTRAINT                ACTION_TYPE  METHOD_TYPES   RESOURCE_TYPES                    DISPLAY_NAME
custom.retentionPolicyEnforced   DENY         CREATE,UPDATE  gkebackup.googleapis.com/Backup   Enforce retention policy
...

    Membuat kebijakan

    1. Simpan file berikut sebagai POLICY_FILE_NAME.yaml:

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

      Ganti PROJECT_ID dengan project ID Anda.

    2. Terapkan kebijakan menggunakan perintah gcloud org-policies set-policy:

      gcloud org-policies set-policy POLICY_FILE_NAME.yaml

    3. Pastikan kebijakan ada menggunakan perintah gcloud org-policies list:

      gcloud org-policies list --project=PROJECT_ID

      Outputnya mirip dengan hal berikut ini:

      CONSTRAINT                         LIST_POLICY  BOOLEAN_POLICY  ETAG
custom.retentionPolicyEnforced     -            SET             CPiLkMMGEKDFq6IB-

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

    Menguji kebijakan

    1. Buat cadangan tanpa menetapkan kolom retainDays ke nilai yang lebih besar dari 30:

      gcloud beta container backup-restore backups create test-backup --backup-plan=test-backup-plan --location=us-central1

      Outputnya mirip dengan hal berikut ini:

      ERROR: (gcloud.beta.container.backup-restore.backups.create) FAILED_PRECONDITION: Operation denied by org policy on resource 'pprojects/test-project/locations/us-central1/backupPlans/autopilot-cluster-1-backup-1/backups/test-backup-1': ["customConstraints/custom.retentionPolicyEnforced": "Enforce backup creation with a retention policy greater than 30 days."].
- '@type': type.googleapis.com/google.rpc.DebugInfo
  detail: "generic::failed_precondition: Operation denied by org policy on resource\
    \ 'projects/test-project/locations/us-central1/backupPlans/autopilot-cluster-1-backup-1/backups/test-backup-1':\
    \ [\"customConstraints/custom.retentionPolicyEnforced\": \"Enforce backup creation with a retention \
    \ policy greater than 30 days.\"]."
  .
  .
  .
- '@type': type.googleapis.com/google.rpc.DebugInfo
- '@type': type.googleapis.com/google.rpc.ErrorInfo
  domain: gkebackup.googleapis.com
  metadata:
    customConstraints: customConstraints/custom.backupRetainDays
    resource: projects/test-project/locations/us-central1/backupPlans/autopilot-cluster-1-backup-1/backups/test-backup-1
  reason: CUSTOM_ORG_POLICY_VIOLATION

    Contoh kebijakan organisasi kustom untuk kasus penggunaan umum

    Tabel berikut mencantumkan kebijakan organisasi kustom yang mungkin berguna bagi Anda:

    Deskripsi Sintaksis batasan
    Izinkan pembuatan cadangan hanya jika cadangan tersebut memiliki periode retensi lebih dari 20 hari 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.retainDaysLimit
    resourceTypes:
    - gkebackup.googleapis.com/Backup
    methodTypes:
    - CREATE
    - UPDATE
    condition: resource.retainDays > 20
    actionType: ALLOW
    displayName: Minimum Backup Retention period
    description: Minimum Backup Retention period of 20 days is required
    Menonaktifkan pembuatan rencana cadangan dengan cronSchedule yang berbeda dari yang dimaksudkan 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.disableInvalidScheduleBackupPlan
    resourceTypes:
    - gkebackup.googleapis.com/BackupPlan
    methodTypes:
    - CREATE
    - UPDATE
    condition: resource.backupSchedule.cronSchedule != "5 20 * * *"
    actionType: DENY
    displayName: Backup plan cron schedule constraint
    description: Deny Backup plan creation or update if cron schedule is not set to 5 20 * * *.

    Resource yang didukung Backup for GKE

    Tabel berikut mencantumkan resource Pencadangan untuk GKE yang dapat Anda rujuk dalam batasan kustom.

    Resource Kolom
    gkebackup.googleapis.com/Backup resource.deleteLockDays
    resource.description
    resource.retainDays
    gkebackup.googleapis.com/BackupPlan resource.backupConfig.allNamespaces
    resource.backupConfig.encryptionKey.gcpKmsEncryptionKey
    resource.backupConfig.includeSecrets
    resource.backupConfig.includeVolumeData
    resource.backupConfig.permissiveMode
    resource.backupConfig.selectedApplications.namespacedNames.name
    resource.backupConfig.selectedApplications.namespacedNames.namespace
    resource.backupConfig.selectedNamespaces.namespaces
    resource.backupSchedule.cronSchedule
    resource.backupSchedule.paused
    resource.backupSchedule.rpoConfig.exclusionWindows.daily
    resource.backupSchedule.rpoConfig.exclusionWindows.daysOfWeek.daysOfWeek
    resource.backupSchedule.rpoConfig.exclusionWindows.duration
    resource.backupSchedule.rpoConfig.targetRpoMinutes
    resource.cluster
    resource.deactivated
    resource.description
    resource.retentionPolicy.backupDeleteLockDays
    resource.retentionPolicy.backupRetainDays
    resource.retentionPolicy.locked
    gkebackup.googleapis.com/Restore resource.backup
    resource.description
    resource.filter.exclusionFilters.groupKind.resourceGroup
    resource.filter.exclusionFilters.groupKind.resourceKind
    resource.filter.exclusionFilters.name
    resource.filter.exclusionFilters.namespace
    resource.filter.inclusionFilters.groupKind.resourceGroup
    resource.filter.inclusionFilters.groupKind.resourceKind
    resource.filter.inclusionFilters.name
    resource.filter.inclusionFilters.namespace
    resource.volumeDataRestorePolicyOverrides.policy
    resource.volumeDataRestorePolicyOverrides.selectedPvcs.namespacedNames.name
    resource.volumeDataRestorePolicyOverrides.selectedPvcs.namespacedNames.namespace
    gkebackup.googleapis.com/RestorePlan resource.backupPlan
    resource.cluster
    resource.description
    resource.restoreConfig.allNamespaces
    resource.restoreConfig.clusterResourceConflictPolicy
    resource.restoreConfig.clusterResourceRestoreScope.allGroupKinds
    resource.restoreConfig.clusterResourceRestoreScope.excludedGroupKinds.resourceGroup
    resource.restoreConfig.clusterResourceRestoreScope.excludedGroupKinds.resourceKind
    resource.restoreConfig.clusterResourceRestoreScope.noGroupKinds
    resource.restoreConfig.clusterResourceRestoreScope.selectedGroupKinds.resourceGroup
    resource.restoreConfig.clusterResourceRestoreScope.selectedGroupKinds.resourceKind
    resource.restoreConfig.excludedNamespaces.namespaces
    resource.restoreConfig.namespacedResourceRestoreMode
    resource.restoreConfig.noNamespaces
    resource.restoreConfig.restoreOrder.groupKindDependencies.requiring.resourceGroup
    resource.restoreConfig.restoreOrder.groupKindDependencies.requiring.resourceKind
    resource.restoreConfig.restoreOrder.groupKindDependencies.satisfying.resourceGroup
    resource.restoreConfig.restoreOrder.groupKindDependencies.satisfying.resourceKind
    resource.restoreConfig.selectedApplications.namespacedNames.name
    resource.restoreConfig.selectedApplications.namespacedNames.namespace
    resource.restoreConfig.selectedNamespaces.namespaces
    resource.restoreConfig.substitutionRules.newValue
    resource.restoreConfig.substitutionRules.originalValuePattern
    resource.restoreConfig.substitutionRules.targetGroupKinds.resourceGroup
    resource.restoreConfig.substitutionRules.targetGroupKinds.resourceKind
    resource.restoreConfig.substitutionRules.targetJsonPath
    resource.restoreConfig.substitutionRules.targetNamespaces
    resource.restoreConfig.transformationRules.description
    resource.restoreConfig.transformationRules.fieldActions.fromPath
    resource.restoreConfig.transformationRules.fieldActions.op
    resource.restoreConfig.transformationRules.fieldActions.path
    resource.restoreConfig.transformationRules.fieldActions.value
    resource.restoreConfig.transformationRules.resourceFilter.groupKinds.resourceGroup
    resource.restoreConfig.transformationRules.resourceFilter.groupKinds.resourceKind
    resource.restoreConfig.transformationRules.resourceFilter.jsonPath
    resource.restoreConfig.transformationRules.resourceFilter.namespaces
    resource.restoreConfig.volumeDataRestorePolicy
    resource.restoreConfig.volumeDataRestorePolicyBindings.policy
    resource.restoreConfig.volumeDataRestorePolicyBindings.volumeType

    Langkah berikutnya