Membuat batasan kebijakan organisasi kustom

Cloud Composer 3 | Cloud Composer 2 | Cloud Composer 1

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

  • composer.googleapis.com/Environment

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 Cloud Composer. Misalnya, jika permintaan untuk membuat atau mengupdate lingkungan Cloud Composer gagal memenuhi validasi batasan kustom sebagaimana ditetapkan oleh kebijakan organisasi Anda, permintaan akan gagal dan error akan ditampilkan kepada pemanggil. Selain itu, penggunaan kebijakan organisasi kustom:

  1. Meningkatkan keamanan. Misalnya, Anda dapat menentukan kebijakan yang melarang pembuatan lingkungan IP publik, mengaktifkan alamat IP publik yang digunakan secara pribadi, atau menentukan penggunaan jaringan dan subnetwork tertentu.

  2. Memberikan kontrol terperinci atas resource yang dibuat atau digunakan saat membuat atau memperbarui lingkungan.

Batasan

Seperti semua batasan kebijakan organisasi, perubahan kebijakan tidak berlaku secara surut pada instance yang ada.

  • Kebijakan baru tidak akan memengaruhi konfigurasi instance yang ada.
  • Konfigurasi instance yang ada tetap valid, kecuali jika Anda mengubahnya dari nilai yang sesuai menjadi tidak sesuai menggunakanGoogle Cloud konsol, Google Cloud CLI, atau RPC.

Sebelum menerapkan kebijakan organisasi kustom pada jenis metode UPDATE resource, pastikan lingkungan yang ada mematuhi setiap kebijakan.

Karena satu operasi pembaruan hanya dapat memperbarui satu kolom, kebuntuan dapat terjadi jika beberapa kolom lingkungan yang ada melanggar kebijakan secara bersamaan.

Untuk menghindari kebuntuan, lakukan salah satu hal berikut:

  • (Direkomendasikan) Pastikan semua lingkungan yang ada mematuhi kebijakan sebelum menerapkan kebijakan pada resource. Untuk memeriksa lingkungan yang ada yang tidak akan mematuhi kebijakan setelah penegakan kebijakan, Anda dapat menggunakan simulator kebijakan.

  • Nonaktifkan penerapan kebijakan, perbarui lingkungan yang ada ke status yang sesuai, dan terapkan kembali kebijakan.

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. If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

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

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

  9. Install the Google Cloud CLI.

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

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

    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.restrictEnvironmentSize. Panjang maksimum kolom ini adalah 70 karakter.

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

    • 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.config.environmentSize == "ENVIRONMENT_SIZE_SMALL"

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

    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 hanya mengizinkan lingkungan Cloud Composer berukuran kecil.

    Sebelum memulai, Anda harus mengetahui hal-hal berikut:

    • ID organisasi Anda
    • Project ID Anda

    Membuat batasan

    1. Simpan file berikut sebagai constraint-require-only-small-environments.yaml:

      name: organizations/ORGANIZATION_ID/customConstraints/custom.restrictEnvironmentSize
resourceTypes:
- composer.googleapis.com/Environment
methodTypes:
- CREATE
condition: resource.config.environmentSize == "ENVIRONMENT_SIZE_SMALL"
actionType: ALLOW
displayName: Only allow small Composer environments.
description: All environments must be small.

    2. Terapkan batasan:

      gcloud org-policies set-custom-constraint constraint-require-only-small-environments.yaml

    Membuat kebijakan

    1. Simpan file berikut sebagai policy-require-only-small-environments.yaml:

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

    2. Terapkan kebijakan:

      
gcloud org-policies set-policy policy-require-only-small-environments.yaml

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

    Menguji kebijakan

    gcloud composer environments create ENVIRONMENT_NAME \
  --location=LOCATION \
  --image-version="composer-3-airflow-2.10.5-build.8" \
  --environment-size=medium

    Pembuatan lingkungan ini gagal karena adanya batasan yang mengharuskan ukuran lingkungan Composer kecil saja.

    Outputnya mirip dengan hal berikut ini:

    You can't perform this action on a Composer environment due to Custom Organization Policy constraints set on your project. The following constraint(s) were violated: ["customConstraints/custom.restrictEnvironmentSize": All environments must be small.]

    Untuk mengatasi error sebelumnya, buat lingkungan berukuran kecil. Contoh:

    gcloud composer environments create ENVIRONMENT_NAME \
  --location=LOCATION \
  --image-version="composer-3-airflow-2.10.5-build.8" \
  --environment-size=small

    Pembuatan lingkungan berhasil dimulai.

    Contoh kebijakan organisasi kustom untuk kasus penggunaan umum

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

    Deskripsi Sintaksis batasan
    Izinkan hanya lingkungan Cloud Composer IP pribadi 
          name: organizations/ORGANIZATION_ID/customConstraints/custom.allowOnlyPrivateIp
      resourceTypes:
      - composer.googleapis.com/Environment
      methodTypes:
      - CREATE
      condition: resource.config.privateEnvironmentConfig.enablePrivateEnvironment == true
      actionType: ALLOW
      displayName: Only Private IP environments
      description: All environments must use Private IP networking
    Jumlah maksimum pekerja harus 10 atau kurang 
          name: organizations/ORGANIZATION_ID/customConstraints/custom.restrictMaxWorketCount
      resourceTypes:
      - composer.googleapis.com/Environment
      methodTypes:
      - CREATE
      - UPDATE
      condition: resource.config.workloadsConfig.worker.maxCount <= 10
      actionType: ALLOW
      displayName: Limit the maximum number of workers
      description: All environments must have 10 or less workers

    Resource yang didukung Cloud Composer

    Tabel berikut mencantumkan resource Cloud Composer yang dapat Anda rujuk dalam batasan kustom.

    Resource Kolom
    composer.googleapis.com/Environment resource.config.environmentSize
    resource.config.maintenanceWindow.recurrence
    resource.config.masterAuthorizedNetworksConfig.enabled
    resource.config.nodeConfig.enableIpMasqAgent
    resource.config.nodeConfig.network
    resource.config.nodeConfig.serviceAccount
    resource.config.nodeConfig.subnetwork
    resource.config.privateEnvironmentConfig.cloudComposerConnectionSubnetwork
    resource.config.privateEnvironmentConfig.enablePrivateBuildsOnly
    resource.config.privateEnvironmentConfig.enablePrivateEnvironment
    resource.config.privateEnvironmentConfig.enablePrivatelyUsedPublicIps
    resource.config.privateEnvironmentConfig.networkingConfig.connectionType
    resource.config.privateEnvironmentConfig.privateClusterConfig.enablePrivateEndpoint
    resource.config.recoveryConfig.scheduledSnapshotsConfig.enabled
    resource.config.recoveryConfig.scheduledSnapshotsConfig.snapshotCreationSchedule
    resource.config.recoveryConfig.scheduledSnapshotsConfig.snapshotLocation
    resource.config.recoveryConfig.scheduledSnapshotsConfig.timeZone
    resource.config.resilienceMode
    resource.config.softwareConfig.cloudDataLineageIntegration.enabled
    resource.config.softwareConfig.imageVersion
    resource.config.softwareConfig.webServerPluginsMode
    resource.config.workloadsConfig.dagProcessor.count
    resource.config.workloadsConfig.dagProcessor.cpu
    resource.config.workloadsConfig.dagProcessor.memoryGb
    resource.config.workloadsConfig.dagProcessor.storageGb
    resource.config.workloadsConfig.scheduler.count
    resource.config.workloadsConfig.scheduler.cpu
    resource.config.workloadsConfig.scheduler.memoryGb
    resource.config.workloadsConfig.scheduler.storageGb
    resource.config.workloadsConfig.triggerer.count
    resource.config.workloadsConfig.triggerer.cpu
    resource.config.workloadsConfig.triggerer.memoryGb
    resource.config.workloadsConfig.webServer.cpu
    resource.config.workloadsConfig.webServer.memoryGb
    resource.config.workloadsConfig.webServer.storageGb
    resource.config.workloadsConfig.worker.cpu
    resource.config.workloadsConfig.worker.maxCount
    resource.config.workloadsConfig.worker.memoryGb
    resource.config.workloadsConfig.worker.minCount
    resource.config.workloadsConfig.worker.storageGb
    resource.name

    Langkah berikutnya