Menggunakan kebijakan organisasi kustom

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

    • pubsub.googleapis.com/Schema
    • pubsub.googleapis.com/Snapshot
    • pubsub.googleapis.com/Subscription
    • pubsub.googleapis.com/Topic

    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.

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

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

      • 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, "has(resource.messageRetentionDuration)"

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

      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 mengharuskan semua topik baru dalam project tertentu untuk menerapkan jaminan dalam transit untuk pesan.

      Sebelum memulai, Anda harus mengetahui hal-hal berikut:

      • ID organisasi Anda
      • Project ID

      Membuat batasan

      1. Simpan file berikut sebagai constraint-require-message-retention.yaml:

        name: organizations/ORGANIZATION_ID/customConstraints/custom.messageRetentionSet
        resourceTypes:
        - Topic
        methodTypes:
        - CREATE
        - UPDATE
        condition: "has(resource.messageRetentionDuration)"
        actionType: ALLOW
        displayName: Require message retention
        description: All topics must set a message retention duration.
        

        Hal ini menentukan batasan di mana setiap topik harus menetapkan durasi retensi pesan.

        1. Terapkan batasan:

          gcloud org-policies set-custom-constraint constraint-require-message-retention.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.messageRetentionSet              ALLOW         CREATE,UPDATE    pubsub.googleapis.com/Topic        Require message retention
          ...
          

        Membuat kebijakan

        1. Simpan file berikut sebagai policy-require-message-retention.yaml:

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

          Ganti PROJECT_ID dengan project ID Anda.

        2. Terapkan kebijakan:

          gcloud org-policies set-policy policy-`policy-require-message-retention.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.messageRetentionSet         -              SET               COCsm5QGENiXi2E=
          

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

        Menguji kebijakan

        Coba buat topik tanpa mengaktifkan retensi pesan:

        gcloud pubsub topics create org-policy-test \
          --project=PROJECT_ID \
        

        Outputnya adalah sebagai berikut:

        Operation denied by custom org policies: ["customConstraints/custom.messageRetentionSet": "All topics must set a message retention duration."].
        
        ERROR: Failed to create topic [projects/PROJECT_ID/topics/org-policy-test]: Operation denied by org policy: ["customConstraints/custom.messageRetentionSet": "All topics must set a message retention duration."].
        ERROR: (gcloud.pubsub.topics.create) Failed to create the following: [org-policy-test].
        

        Contoh kebijakan organisasi kustom untuk kasus penggunaan umum

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

        Deskripsi Sintaksis batasan
        Memerlukan topik untuk menerapkan jaminan dalam transit untuk pesan dan menyediakan setidaknya satu region persistensi yang diizinkan
          name: organizations/ORGANIZATION_ID/customConstraints/custom.enforceInTransitWithRegions
          resourceTypes:
          - pubsub.googleapis.com/Topic
          methodTypes:
          - CREATE
          - UPDATE
          condition: "resource.messageStoragePolicy.enforceInTransit == true && resource.messageStoragePolicy.allowedPersistenceRegions.size() >= 1"
          actionType: ALLOW
          displayName: Require in-transit enforcement and regions
          description: All topics must enable in-transit message storage policy enforcement and contain a non-empty list of allowed persistence regions.
          
        Mewajibkan topik untuk menerapkan jaminan dalam transit untuk pesan dan mengecualikan wilayah tertentu
          name: organizations/ORGANIZATION_ID/customConstraints/custom.enforceInTransitWithoutUsEast1
          resourceTypes:
          - pubsub.googleapis.com/Topic
          methodTypes:
          - CREATE
          - UPDATE
          condition: "resource.messageStoragePolicy.enforceInTransit && !resource.messageStoragePolicy.allowedPersistenceRegions.exists(r, r == 'us-east1')"
          actionType: ALLOW
          displayName: Require in-transit enforcement and restrict regions
          description: All topics must enable in-transit message storage policy enforcement, and exclude us-east1 from the allowed persistence regions.
          
        Mewajibkan durasi retensi pesan minimum untuk langganan
          name: organizations/ORGANIZATION_ID/customConstraints/custom.minMessageRetentionDuration
          resourceTypes:
          - pubsub.googleapis.com/Subscription
          methodTypes:
          - CREATE
          - UPDATE
          condition: "resource.messageRetentionDuration < duration('30m')"
          actionType: DENY
          displayName: Minimum message retention duration
          description: All subscriptions must retain unacked messages for at least 30 minutes.
          
        Mewajibkan langganan untuk mengaktifkan penghentian pengiriman
          name: organizations/ORGANIZATION_ID/customConstraints/custom.requireDeadLetterPolicy
          resourceTypes:
          - pubsub.googleapis.com/Subscription
          methodTypes:
          - CREATE
          - UPDATE
          condition: "has(resource.deadLetterPolicy)"
          actionType: ALLOW
          displayName: Require dead letter policy
          description: All subscriptions must set a dead letter policy.
          
        Mewajibkan skema berjenis Avro
          name: organizations/ORGANIZATION_ID/customConstraints/custom.schemaIsAvro
          resourceTypes:
          - pubsub.googleapis.com/Schema
          methodTypes:
          - CREATE
          - UPDATE
          condition: "resource.type == 'AVRO'"
          actionType: ALLOW
          displayName: Schema is Avro
          description: All schemas must be of type Avro.
          
        Mewajibkan push yang diautentikasi untuk langganan
          name: organizations/ORGANIZATION_ID/customConstraints/custom.authenticatedPush
          resourceTypes:
          - pubsub.googleapis.com/Subscription
          methodTypes:
          - CREATE
          - UPDATE
          condition: "has(resource.pushConfig.pushEndpoint) && has(resource.pushConfig.oidcToken.serviceAccountEmail) && has(resource.pushConfig.oidcToken.audience)"
          actionType: ALLOW
          displayName: Subscription uses authenticated push
          description: All subscriptions must enable push authentication.
          
        Mewajibkan topik untuk mengaktifkan CMEK
          name: organizations/ORGANIZATION_ID/customConstraints/custom.topicHasCmek
          resourceTypes:
          - pubsub.googleapis.com/Topic
          methodTypes:
          - CREATE
          - UPDATE
          condition: "has(resource.kmsKeyName)"
          actionType: ALLOW
          displayName: Topic has CMEK
          description: All topics must use a Cloud KMS CryptoKey.
          

        Resource yang didukung Pub/Sub

        Tabel berikut mencantumkan resource Pub/Sub yang dapat Anda rujuk dalam batasan kustom.

        Resource Kolom
        pubsub.googleapis.com/Schema resource.definition
        resource.name
        resource.type
        pubsub.googleapis.com/Snapshot resource.expireTime
        resource.name
        resource.topic
        pubsub.googleapis.com/Subscription resource.ackDeadlineSeconds
        resource.bigqueryConfig.dropUnknownFields
        resource.bigqueryConfig.serviceAccountEmail
        resource.bigqueryConfig.table
        resource.bigqueryConfig.useTableSchema
        resource.bigqueryConfig.useTopicSchema
        resource.bigqueryConfig.writeMetadata
        resource.cloudStorageConfig.avroConfig.useTopicSchema
        resource.cloudStorageConfig.avroConfig.writeMetadata
        resource.cloudStorageConfig.bucket
        resource.cloudStorageConfig.filenameDatetimeFormat
        resource.cloudStorageConfig.filenamePrefix
        resource.cloudStorageConfig.filenameSuffix
        resource.cloudStorageConfig.maxBytes
        resource.cloudStorageConfig.maxDuration
        resource.cloudStorageConfig.maxMessages
        resource.cloudStorageConfig.serviceAccountEmail
        resource.deadLetterPolicy.deadLetterTopic
        resource.deadLetterPolicy.maxDeliveryAttempts
        resource.enableExactlyOnceDelivery
        resource.enableMessageOrdering
        resource.expirationPolicy.ttl
        resource.filter
        resource.messageRetentionDuration
        resource.messageTransforms.disabled
        resource.messageTransforms.enabled
        resource.messageTransforms.javascriptUdf.code
        resource.messageTransforms.javascriptUdf.functionName
        resource.name
        resource.pushConfig.attributes
        resource.pushConfig.noWrapper.writeMetadata
        resource.pushConfig.oidcToken.audience
        resource.pushConfig.oidcToken.serviceAccountEmail
        resource.pushConfig.pushEndpoint
        resource.retainAckedMessages
        resource.retryPolicy.maximumBackoff
        resource.retryPolicy.minimumBackoff
        resource.topic
        pubsub.googleapis.com/Topic resource.ingestionDataSourceSettings.awsKinesis.awsRoleArn
        resource.ingestionDataSourceSettings.awsKinesis.consumerArn
        resource.ingestionDataSourceSettings.awsKinesis.gcpServiceAccount
        resource.ingestionDataSourceSettings.awsKinesis.streamArn
        resource.ingestionDataSourceSettings.cloudStorage.bucket
        resource.ingestionDataSourceSettings.cloudStorage.matchGlob
        resource.ingestionDataSourceSettings.cloudStorage.minimumObjectCreateTime
        resource.ingestionDataSourceSettings.cloudStorage.textFormat.delimiter
        resource.ingestionDataSourceSettings.platformLogsSettings.severity
        resource.kmsKeyName
        resource.messageRetentionDuration
        resource.messageStoragePolicy.allowedPersistenceRegions
        resource.messageStoragePolicy.enforceInTransit
        resource.messageTransforms.disabled
        resource.messageTransforms.enabled
        resource.messageTransforms.javascriptUdf.code
        resource.messageTransforms.javascriptUdf.functionName
        resource.name
        resource.schemaSettings.encoding
        resource.schemaSettings.firstRevisionId
        resource.schemaSettings.lastRevisionId
        resource.schemaSettings.schema

        Langkah berikutnya