Creare vincoli personalizzati per Backup per GKE

Questa pagina mostra come utilizzare i vincoli personalizzati del servizio Organization Policy per limitare operazioni specifiche sulle seguenti risorse Google Cloud :

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

Per saperne di più sulle policy dell'organizzazione, consulta Policy dell'organizzazione personalizzate.

Informazioni sui criteri e sui vincoli dell'organizzazione

Il servizio Google Cloud Policy dell'organizzazione offre un controllo centralizzato e programmatico sulle risorse della tua organizzazione. In qualità di amministratore delle policy dell'organizzazione, puoi definire una policy dell'organizzazione, ovvero un insieme di limitazioni chiamate vincoli che si applicano alle risorseGoogle Cloud e ai discendenti di queste risorse nella gerarchia delle risorseGoogle Cloud . Puoi applicare le policy dell'organizzazione a livello di organizzazione, cartella o progetto.

La policy dell'organizzazione fornisce vincoli gestiti integrati per vari servizi Google Cloud . Tuttavia, se cerchi un controllo più granulare e personalizzabile sui campi specifici limitati nelle policy dell'organizzazione, puoi anche creare vincoli personalizzati e utilizzarli in una policy dell'organizzazione.

Ereditarietà delle policy

Per impostazione predefinita, le policy dell'organizzazione vengono ereditate dai discendenti delle risorse su cui applichi la policy. Ad esempio, se applichi una policy a una cartella, Google Cloud applica la policy a tutti i progetti contenuti nella cartella. Per scoprire di più su questo comportamento e su come modificarlo, consulta Regole di valutazione della gerarchia.

Prima di iniziare

  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. Se utilizzi un provider di identità (IdP) esterno, devi prima accedere alla gcloud CLI con la tua identità federata.

  6. Per inizializzare gcloud CLI, esegui questo comando:

    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. Se utilizzi un provider di identità (IdP) esterno, devi prima accedere alla gcloud CLI con la tua identità federata.

  11. Per inizializzare gcloud CLI, esegui questo comando:

    gcloud init
  12. Assicurati di conoscere il tuo ID organizzazione.
  13. Ruoli obbligatori

    Per ottenere le autorizzazioni necessarie per gestire le policy dell'organizzazione personalizzate, chiedi all'amministratore di concederti il ruolo IAM Amministratore policy dell'organizzazione (roles/orgpolicy.policyAdmin) sulla risorsa dell'organizzazione. Per saperne di più sulla concessione dei ruoli, consulta Gestisci l'accesso a progetti, cartelle e organizzazioni.

    Potresti anche riuscire a ottenere le autorizzazioni richieste tramite i ruoli personalizzati o altri ruoli predefiniti.

    Crea un vincolo personalizzato

    Un vincolo personalizzato è definito in un file YAML dalle risorse, dai metodi, dalle condizioni e dalle azioni supportate dal servizio a cui stai applicando la policy dell'organizzazione. Le condizioni per i vincoli personalizzati vengono definite utilizzando il Common Expression Language (CEL). Per ulteriori informazioni su come creare condizioni nei vincoli personalizzati utilizzando il CEL, consulta la sezione relativa al CEL di Creazione e gestione di vincoli personalizzati.

    Per creare un vincolo personalizzato, crea un file YAML utilizzando il seguente formato:

    name: organizations/ORGANIZATION_ID/customConstraints/CONSTRAINT_NAME
    resourceTypes:
    - RESOURCE_NAME
    methodTypes:
    - CREATE
    - UPDATE
    condition: "CONDITION"
    actionType: ACTION
    displayName: DISPLAY_NAME
    description: DESCRIPTION
    

    Sostituisci quanto segue:

    • ORGANIZATION_ID: l'ID della tua organizzazione, ad esempio 123456789.

    • CONSTRAINT_NAME: il nome che vuoi assegnare al nuovo vincolo personalizzato. Un vincolo personalizzato deve iniziare con custom. e può includere solo lettere maiuscole, lettere minuscole o numeri. Ad esempio, custom.retentionPolicyEnforced. La lunghezza massima di questo campo è di 70 caratteri.

    • RESOURCE_NAME: il nome completo della risorsaGoogle Cloud contenente l'oggetto e il campo che vuoi limitare. Ad esempio: gkebackup.googleapis.com/Backup.

    • CONDITION: una condizione CEL scritta in base a una rappresentazione di una risorsa di servizio supportata. Questo campo ha una lunghezza massima di 1000 caratteri. Per ulteriori informazioni sulle risorse disponibili in base a cui scrivere condizioni, consulta la sezione Risorse supportate. Ad esempio "resource.retainDays > 30".

    • ACTION: l'azione da eseguire se condition è soddisfatta. I valori possibili sono ALLOW e DENY.

    • DISPLAY_NAME: un nome facile da ricordare per il vincolo. Questo campo ha una lunghezza massima di 200 caratteri.

    • DESCRIPTION: una descrizione chiara del vincolo da visualizzare come messaggio di errore in caso di violazione della policy. Questo campo ha una lunghezza massima di 2000 caratteri.

    Per saperne di più su come creare un vincolo personalizzato, consulta Definizione di vincoli personalizzati.

    Configura un vincolo personalizzato

    Dopo aver creato il file YAML per un nuovo vincolo personalizzato, devi configurarlo per renderlo disponibile per le policy dell'organizzazione. Per impostare un vincolo personalizzato, utilizza il comando gcloud org-policies set-custom-constraint:
    gcloud org-policies set-custom-constraint CONSTRAINT_PATH
    Sostituisci CONSTRAINT_PATH con il percorso completo del file del vincolo personalizzato. Ad esempio: /home/user/customconstraint.yaml. Al termine, i vincoli personalizzati sono disponibili come policy dell'organizzazione nel tuo elenco di policy dell'organizzazione Google Cloud . Per verificare che il vincolo personalizzato esista, utilizza il comando gcloud org-policies list-custom-constraints:
    gcloud org-policies list-custom-constraints --organization=ORGANIZATION_ID
    Sostituisci ORGANIZATION_ID con l'ID della risorsa della tua organizzazione. Per ulteriori informazioni, consulta Visualizzazione delle policy dell'organizzazione.

    Applicare una policy dell'organizzazione personalizzata

    Puoi applicare un vincolo creando una policy dell'organizzazione che lo richiami e poi applicando questa policy dell'organizzazione a una risorsa Google Cloud .

    Console

    1. Nella console Google Cloud , vai alla pagina Policy dell'organizzazione.

      Vai a Policy dell'organizzazione

    2. Nel selettore di progetti, seleziona il progetto per cui vuoi impostare la policy dell'organizzazione.
    3. Nell'elenco della pagina Policy dell'organizzazione, seleziona il vincolo per visualizzare la pagina Dettagli policy relativa al vincolo in questione.
    4. Per configurare la policy dell'organizzazione per questa risorsa, fai clic su Gestisci policy.
    5. Nella pagina Modifica policy, seleziona Esegui override della policy dell'unità organizzativa principale.
    6. Fai clic su Aggiungi una regola.
    7. Nella sezione Applicazione, seleziona se attivare o meno l'applicazione di questa policy dell'organizzazione
    8. (Facoltativo) Per rendere la policy dell'organizzazione condizionale su un tag, fai clic su Aggiungi condizione. Tieni presente che se aggiungi una regola condizionale a una policy dell'organizzazione, devi aggiungere almeno una regola non condizionale, altrimenti la policy non può essere salvata. Per ulteriori informazioni, consulta Impostazione di una policy dell'organizzazione con tag.
    9. Fai clic su Testa modifiche per simulare l'effetto della policy dell'organizzazione. La simulazione delle policy non è disponibile per i vincoli gestiti legacy. Per ulteriori informazioni, consulta Testa le modifiche alla policy dell'organizzazione con Policy Simulator.
    10. Per completare e applicare la policy dell'organizzazione, fai clic su Imposta policy. L'applicazione della policy può richiedere fino a 15 minuti.

    gcloud

    Per creare una policy dell'organizzazione con regole booleane, crea un file YAML della policy che faccia riferimento al vincolo:

          name: projects/PROJECT_ID/policies/CONSTRAINT_NAME
          spec:
            rules:
            - enforce: true
        

    Sostituisci quanto segue:

    • PROJECT_ID: il progetto su cui vuoi applicare il vincolo.
    • CONSTRAINT_NAME: il nome definito per il vincolo personalizzato. Ad esempio: custom.retentionPolicyEnforced.

    Per applicare la policy dell'organizzazione contenente il vincolo, esegui il seguente comando:

        gcloud org-policies set-policy POLICY_PATH
        

    Sostituisci POLICY_PATH con il percorso completo del file YAML della policy dell'organizzazione. L'applicazione della policy può richiedere fino a 15 minuti.

    Testa il criterio dell'organizzazione personalizzato

    I seguenti passaggi mostrano come creare un vincolo e una policy personalizzati che consentano agli utenti di creare un backup di Backup per GKE se il campo retainDays è impostato su un valore maggiore di 30.

    Prima di iniziare, prepara quanto segue:

    • L'ID organizzazione
    • Il tuo ID progetto

    Crea il vincolo

    1. Salva il seguente file come 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.
      

      Sostituisci ORGANIZATION_ID con l'ID organizzazione.

      Questo file definisce un vincolo in cui il campo retainDays deve essere maggiore di 30 nel metodo CREATE.

    2. Applica il vincolo utilizzando il comando gcloud org-policies set-custom-constraint:

      gcloud org-policies set-custom-constraint CONSTRAINT_FILE_NAME.yaml
      
    3. Verifica che il vincolo esista utilizzando il comando gcloud org-policies list-custom-constraints:

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

      L'output è simile al seguente:

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

    Crea la policy

    1. Salva il seguente file come POLICY_FILE_NAME.yaml:

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

      Sostituisci PROJECT_ID con l'ID progetto.

    2. Applica la policy utilizzando il comando gcloud org-policies set-policy:

      gcloud org-policies set-policy POLICY_FILE_NAME.yaml
      
    3. Verifica che la policy esista utilizzando il comando gcloud org-policies list:

      gcloud org-policies list --project=PROJECT_ID
      

      L'output è simile al seguente:

      CONSTRAINT                         LIST_POLICY  BOOLEAN_POLICY  ETAG
      custom.retentionPolicyEnforced     -            SET             CPiLkMMGEKDFq6IB-
      

    Dopo aver applicato il criterio, attendi circa due minuti prima che Google Cloud inizi a applicarlo.

    Testare la policy

    1. Crea un backup senza impostare il campo retainDays su un valore maggiore di 30:

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

      L'output è simile al seguente:

      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
      

    Esempi di norme personalizzate dell'organizzazione per casi d'uso comuni

    La seguente tabella elenca le policy dell'organizzazione personalizzate che potresti trovare utili:

    Descrizione Sintassi del vincolo
    Consenti la creazione di backup solo se hanno un periodo di conservazione superiore a 20 giorni
        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
    Disattiva la creazione di piani di backup con cronSchedule diverso da quello previsto
        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 * * *.

    Risorse supportate da Backup per GKE

    La tabella seguente elenca le risorse di Backup per GKE a cui puoi fare riferimento nei vincoli personalizzati.

    Risorsa Campo
    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

    Passaggi successivi