Gestisci le risorse di Service Management con vincoli personalizzati

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

  • servicemanagement.googleapis.com/Service

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

Informazioni sulle policy dell'organizzazione e sui vincoli

Il servizio Google Cloud Policy dell'organizzazione offre un controllo centralizzato e programmatico sulle risorse della tua organizzazione. In qualità di amministratore della 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.

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

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.

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

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

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    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 a 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 Organization Policy Administrator (roles/orgpolicy.policyAdmin) sulla risorsa 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.

    Configura 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 saperne di più su come creare condizioni nei vincoli personalizzati utilizzando il CEL, consulta la sezione relativa al CEL di Creazione e gestione di vincoli personalizzati.

    Console

    Per creare un vincolo personalizzato:

    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. Fai clic su Vincolo personalizzato.
    4. Nella casella Nome visualizzato, inserisci un nome leggibile per il vincolo. Questo nome viene utilizzato nei messaggi di errore e può essere utilizzato per l'identificazione e il debug. Non utilizzare PII o dati sensibili nei nomi visualizzati, perché questo nome potrebbe essere esposto nei messaggi di errore. Questo campo può contenere fino a 200 caratteri.
    5. Nella casella ID vincolo, inserisci il nome che vuoi assegnare al nuovo vincolo personalizzato. Un vincolo personalizzato può contenere solo lettere (maiuscole e minuscole) o numeri, ad esempio custom.disableGkeAutoUpgrade. Questo campo può contenere fino a 70 caratteri, senza contare il prefisso (custom.), ad esempio organizations/123456789/customConstraints/custom. Non includere PII o dati sensibili nell'ID vincolo, perché potrebbero essere esposti nei messaggi di errore.
    6. Nella casella Descrizione, inserisci una descrizione leggibile del vincolo. Questa descrizione viene utilizzata come messaggio di errore in caso di violazione della policy. Includi dettagli sul motivo della violazione delle norme e su come risolverla. Non includere PII o dati sensibili nella descrizione, perché potrebbero essere esposti nei messaggi di errore. Questo campo può contenere fino a 2000 caratteri.
    7. Nella casella Tipo di risorsa, seleziona il nome della risorsa REST Google Cloud contenente l'oggetto e il campo che vuoi limitare, ad esempio container.googleapis.com/NodePool. La maggior parte dei tipi di risorse supporta fino a 20 vincoli personalizzati. Se tenti di creare altri vincoli personalizzati, l'operazione non va a buon fine.
    8. In Metodo di applicazione forzata, seleziona se applicare il vincolo a un metodo REST CREATE o a entrambi i metodi CREATE e UPDATE. Se applichi il vincolo con il metodo UPDATE a una risorsa che viola il vincolo, le modifiche a quella risorsa vengono bloccate dalla policy dell'organizzazione, a meno che la modifica non risolva la violazione.
    9. Non tutti i servizi supportano entrambi i metodi. Google Cloud Per visualizzare i metodi supportati per ogni servizio, individua il servizio in Servizi supportati.

    10. Per definire una condizione, fai clic su Modifica condizione.
      1. Nel riquadro Aggiungi condizione, crea una condizione CEL che fa riferimento a una risorsa di servizio supportata, ad esempio resource.management.autoUpgrade == false. Questo campo può contenere fino a 1000 caratteri. Per informazioni dettagliate sull'utilizzo di CEL, consulta Common Expression Language. Per saperne di più sulle risorse di servizio che puoi utilizzare nei tuoi vincoli personalizzati, consulta Servizi supportati dai vincoli personalizzati.
      2. Fai clic su Salva.
    11. In Azione, seleziona se consentire o negare il metodo valutato se la condizione viene soddisfatta.
    12. L'azione di negazione indica che l'operazione di creazione o aggiornamento della risorsa viene bloccata se la condizione restituisce il valore true.

      L'azione Consenti significa che l'operazione di creazione o aggiornamento della risorsa è consentita solo se la condizione restituisce il valore true. Tutti gli altri casi, tranne quelli elencati esplicitamente nella condizione, vengono bloccati.

    13. Fai clic su Crea vincolo.
    14. Dopo aver inserito un valore in ogni campo, a destra viene visualizzata la configurazione YAML equivalente per questo vincolo personalizzato.

    gcloud

    1. Per creare un vincolo personalizzato, crea un file YAML utilizzando il seguente formato:
    2.       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 può contenere solo lettere (maiuscole e minuscole) o numeri, ad esempio custom.authorizationCheck. Questo campo può contenere fino a 70 caratteri.
      • RESOURCE_NAME: il nome completo della risorsa Google Cloud contenente l'oggetto e il campo che vuoi limitare. Ad esempio, servicemanagement.googleapis.com/Service.
      • CONDITION: una condizione CEL scritta in base a una rappresentazione di una risorsa di servizio supportata. Questo campo può contenere fino a 1000 caratteri. Ad esempio, resource.name == \"test-service-name\".
      • Per saperne di più sulle risorse disponibili in base a cui scrivere condizioni, consulta Risorse supportate.

      • ACTION: l'azione da eseguire se condition è soddisfatta. I valori possibili sono ALLOW e DENY.
      • L'azione allow indica che se la condizione restituisce true, l'operazione di creazione o aggiornamento della risorsa è consentita. Ciò significa anche che tutti gli altri casi, tranne quello elencato esplicitamente nella condizione, sono bloccati.

        L'azione deny indica che se la condizione restituisce true, l'operazione di creazione o aggiornamento della risorsa viene bloccata.

      • DISPLAY_NAME: un nome facile da ricordare per il vincolo. Questo campo può contenere fino a 200 caratteri.
      • DESCRIPTION: una descrizione chiara del vincolo da visualizzare come messaggio di errore in caso di violazione della policy. Questo campo può contenere fino a 2000 caratteri.
    3. 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:
    4.         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 di questa operazione, i vincoli personalizzati sono disponibili come policy dell'organizzazione nel tuo elenco di policy dell'organizzazione Google Cloud .

    5. Per verificare che il vincolo personalizzato esista, utilizza il comando gcloud org-policies list-custom-constraints:
    6.       gcloud org-policies list-custom-constraints --organization=ORGANIZATION_ID
            

      Sostituisci ORGANIZATION_ID con l'ID della risorsa della tua organizzazione.

      Per saperne di più, consulta Visualizzazione delle policy dell'organizzazione.

    Forza l'applicazione di 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 questa policy dell'organizzazione è applicata o meno.
    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 saperne di più, consulta Impostazione di una policy dell'organizzazione con tag.
    9. Fai clic su Testa modifiche per simulare l'effetto della policy dell'organizzazione. Per saperne di più, consulta Testa le modifiche alla policy dell'organizzazione con Policy Simulator.
    10. Per applicare la policy dell'organizzazione in modalità dry run, fai clic su Imposta policy dry run. Per maggiori informazioni, consulta Crea una policy dell'organizzazione in modalità dry run.
    11. Dopo aver verificato che la policy dell'organizzazione in modalità di prova funziona come previsto, imposta la policy attiva facendo clic su Imposta policy.

    gcloud

    1. Per creare una policy dell'organizzazione con regole booleane, crea un file YAML della policy che faccia riferimento al vincolo:
    2.         name: projects/PROJECT_ID/policies/CONSTRAINT_NAME
              spec:
                rules:
                - enforce: true
              
              dryRunSpec:
                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.authorizationCheck.
    3. Per applicare la policy dell'organizzazione in modalità dry run, esegui il seguente comando con il flag dryRunSpec:
    4.         gcloud org-policies set-policy POLICY_PATH \
                --update-mask=dryRunSpec
            

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

    5. Dopo aver verificato che la policy dell'organizzazione in modalità dry run funziona come previsto, imposta la policy live con il comando org-policies set-policy e il flag spec:
    6.         gcloud org-policies set-policy POLICY_PATH \
                --update-mask=spec
            

      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 la policy dell'organizzazione personalizzata

    L'esempio seguente crea un vincolo personalizzato basato sugli attributi della risorsa Service. Queste regole possono essere utilizzate per consentire o negare determinate richieste di CreateServiceConfig.

    Prima di iniziare, devi avere le seguenti informazioni:

    • ID della tua organizzazione
    • Un ID progetto

    Crea il vincolo

    1. Salva il seguente file come constraint-file-name.yaml:

          name: organizations/ORGANIZATION_ID/customConstraints/custom.authorizationCheck
          resourceTypes:
          -  servicemanagement.googleapis.com/Service
          methodTypes:
          -   CREATE
          -   UPDATE
          condition: resource.name == \"test-service-name\"
          actionType: ALLOW
          displayName: Check Configuration time policy enforcement
          description: Organization policies, defined with CEL and enforced via service manager APIs, allow admins to control service configurations through inheritable and granular rules.
      

      Definisce un vincolo in cui il nome del servizio per ogni Service Management deve essere uguale a test-service-name.

    2. Applica il vincolo:

      gcloud org-policies set-custom-constraint ~/constraint-file-name.yaml
      
    3. Verifica che il vincolo esista:

      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.configTimeEnforcement ALLOW CREATE,UPDATE servicemanagement.googleapis.com/Service Configuration time policy enforcement
      

    Crea la policy

    1. Salva il seguente file come policy-file-name.yaml:

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

      Sostituisci PROJECT_ID con l'ID progetto.

    2. Applica la policy:

      gcloud org-policies set-policy ~/policy-file-name.yaml
      
    3. Verifica che la policy esista:

      gcloud org-policies list --project=PROJECT_ID
      

      L'output è simile al seguente:

      CONSTRAINT LIST_POLICY BOOLEAN_POLICY ETAG
      custom.configTimeEnforcement - SET COCsm5QGENiXi2E=
      

    Dopo aver applicato la policy, attendi circa due minuti perché Google Cloud inizi ad applicarla.

    Testa la policy

    Esegui questo comando per creare la configurazione del servizio per verificare i vincoli.

      gcloud endpoints services deploy policy-file-name.yaml
    

    L'output è simile al seguente:

      Operation denied by custom org policies: ["customConstraints/custom.authorizationCheck": "error Message"]
    

    Risorse supportate da Service Management

    La tabella seguente elenca le risorse di Service Management a cui puoi fare riferimento nei vincoli personalizzati.

    Risorsa Campo
    servicemanagement.googleapis.com/Service resource.authentication.providers.audiences
    resource.authentication.providers.authorizationUrl
    resource.authentication.providers.issuer
    resource.authentication.providers.jwksUri
    resource.authentication.providers.jwtLocations.cookie
    resource.authentication.providers.jwtLocations.header
    resource.authentication.providers.jwtLocations.query
    resource.authentication.providers.jwtLocations.valuePrefix
    resource.authentication.rules.allowWithoutCredential
    resource.authentication.rules.oauth.canonicalScopes
    resource.authentication.rules.requirements.audiences
    resource.authentication.rules.requirements.providerId
    resource.authentication.rules.selector
    resource.backend.rules.address
    resource.backend.rules.deadline
    resource.backend.rules.disableAuth
    resource.backend.rules.jwtAudience
    resource.backend.rules.operationDeadline
    resource.backend.rules.pathTranslation
    resource.backend.rules.protocol
    resource.backend.rules.selector
    resource.billing.consumerDestinations.metrics
    resource.billing.consumerDestinations.monitoredResource
    resource.context.rules.allowedRequestExtensions
    resource.context.rules.allowedResponseExtensions
    resource.context.rules.provided
    resource.context.rules.requested
    resource.context.rules.selector
    resource.control.environment
    resource.control.methodPolicies.requestPolicies.resourcePermission
    resource.control.methodPolicies.requestPolicies.resourceType
    resource.control.methodPolicies.requestPolicies.selector
    resource.control.methodPolicies.selector
    resource.customError.rules.isErrorType
    resource.customError.rules.selector
    resource.customError.types
    resource.endpoints.aliases
    resource.endpoints.allowCors
    resource.endpoints.name
    resource.endpoints.target
    resource.logging.consumerDestinations.logs
    resource.logging.consumerDestinations.monitoredResource
    resource.logging.producerDestinations.logs
    resource.logging.producerDestinations.monitoredResource
    resource.logs.description
    resource.logs.displayName
    resource.logs.name
    resource.metrics.description
    resource.metrics.displayName
    resource.metrics.launchStage
    resource.metrics.metadata.ingestDelay
    resource.metrics.metadata.samplePeriod
    resource.metrics.metadata.timeSeriesResourceHierarchyLevel
    resource.metrics.metricKind
    resource.metrics.monitoredResourceTypes
    resource.metrics.name
    resource.metrics.type
    resource.metrics.unit
    resource.metrics.valueType
    resource.monitoredResources.description
    resource.monitoredResources.displayName
    resource.monitoredResources.launchStage
    resource.monitoredResources.name
    resource.monitoredResources.type
    resource.monitoring.consumerDestinations.metrics
    resource.monitoring.consumerDestinations.monitoredResource
    resource.monitoring.producerDestinations.metrics
    resource.monitoring.producerDestinations.monitoredResource
    resource.name
    resource.producerProjectId
    resource.publishing.apiShortName
    resource.publishing.codeownerGithubTeams
    resource.publishing.docTagPrefix
    resource.publishing.documentationUri
    resource.publishing.githubLabel
    resource.publishing.librarySettings.cppSettings.common.destinations
    resource.publishing.librarySettings.cppSettings.common.selectiveGapicGeneration.methods
    resource.publishing.librarySettings.dotnetSettings.common.destinations
    resource.publishing.librarySettings.dotnetSettings.common.selectiveGapicGeneration.methods
    resource.publishing.librarySettings.dotnetSettings.forcedNamespaceAliases
    resource.publishing.librarySettings.dotnetSettings.handwrittenSignatures
    resource.publishing.librarySettings.dotnetSettings.ignoredResources
    resource.publishing.librarySettings.dotnetSettings.renamedResources
    resource.publishing.librarySettings.dotnetSettings.renamedServices
    resource.publishing.librarySettings.goSettings.common.destinations
    resource.publishing.librarySettings.goSettings.common.selectiveGapicGeneration.methods
    resource.publishing.librarySettings.javaSettings.common.destinations
    resource.publishing.librarySettings.javaSettings.common.selectiveGapicGeneration.methods
    resource.publishing.librarySettings.javaSettings.libraryPackage
    resource.publishing.librarySettings.javaSettings.serviceClassNames
    resource.publishing.librarySettings.launchStage
    resource.publishing.librarySettings.nodeSettings.common.destinations
    resource.publishing.librarySettings.nodeSettings.common.selectiveGapicGeneration.methods
    resource.publishing.librarySettings.phpSettings.common.destinations
    resource.publishing.librarySettings.phpSettings.common.selectiveGapicGeneration.methods
    resource.publishing.librarySettings.pythonSettings.common.destinations
    resource.publishing.librarySettings.pythonSettings.common.selectiveGapicGeneration.methods
    resource.publishing.librarySettings.pythonSettings.experimentalFeatures.restAsyncIoEnabled
    resource.publishing.librarySettings.restNumericEnums
    resource.publishing.librarySettings.rubySettings.common.destinations
    resource.publishing.librarySettings.rubySettings.common.selectiveGapicGeneration.methods
    resource.publishing.librarySettings.version
    resource.publishing.methodSettings.autoPopulatedFields
    resource.publishing.methodSettings.longRunning.initialPollDelay
    resource.publishing.methodSettings.longRunning.maxPollDelay
    resource.publishing.methodSettings.longRunning.pollDelayMultiplier
    resource.publishing.methodSettings.longRunning.totalPollTimeout
    resource.publishing.methodSettings.selector
    resource.publishing.newIssueUri
    resource.publishing.organization
    resource.publishing.protoReferenceDocumentationUri
    resource.publishing.restReferenceDocumentationUri
    resource.quota.limits.defaultLimit
    resource.quota.limits.description
    resource.quota.limits.displayName
    resource.quota.limits.duration
    resource.quota.limits.freeTier
    resource.quota.limits.maxLimit
    resource.quota.limits.metric
    resource.quota.limits.name
    resource.quota.limits.unit
    resource.quota.limits.values
    resource.quota.metricRules.metricCosts
    resource.quota.metricRules.selector
    resource.systemParameters.rules.parameters.httpHeader
    resource.systemParameters.rules.parameters.name
    resource.systemParameters.rules.parameters.urlQueryParameter
    resource.systemParameters.rules.selector
    resource.title
    resource.usage.producerNotificationChannel
    resource.usage.requirements
    resource.usage.rules.allowUnregisteredCalls
    resource.usage.rules.selector
    resource.usage.rules.skipServiceControl

    Passaggi successivi