Usa políticas de la organización personalizadas

En esta página, se muestra cómo usar las restricciones personalizadas del servicio de políticas de la organización para restringir operaciones específicas en los siguientes recursos de Google Cloud :

  • clouddeploy.googleapis.com/Automation
  • clouddeploy.googleapis.com/CustomTargetType
  • clouddeploy.googleapis.com/DeliveryPipeline
  • clouddeploy.googleapis.com/DeployPolicy
  • clouddeploy.googleapis.com/Release
  • clouddeploy.googleapis.com/Rollout
  • clouddeploy.googleapis.com/Target

Para obtener más información sobre la política de la organización, consulta Políticas de la organización personalizadas.

Acerca de las políticas y restricciones de la organización

El Google Cloud Servicio de políticas de la organización te brinda un control centralizado y programático sobre los recursos de tu organización. Como administrador de políticas de la organización, puedes definir una política de la organización, que es un conjunto de limitaciones llamadas restricciones que se aplican a los recursos deGoogle Cloud y a sus descendientes en la jerarquía de recursos deGoogle Cloud . Puedes aplicar políticas de la organización a nivel de la organización, carpeta o proyecto.

La política de la organización proporciona restricciones administradas integradas para varios servicios de Google Cloud . Sin embargo, si deseas un control más detallado y personalizable sobre los campos específicos que están restringidos en las políticas de tu organización, también puedes crear restricciones personalizadas y usarlas en una política de la organización.

Herencia de políticas

De forma predeterminada, las políticas de la organización se heredan según los subordinados de los recursos en los que se aplica la política. Por ejemplo, si aplicas una política en una carpeta, Google Cloud aplica la política en todos los proyectos de la carpeta. Para obtener más información sobre este comportamiento y cómo cambiarlo, consulta Reglas de evaluación de la jerarquía.

Antes de comenzar

  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. Si usas un proveedor de identidad externo (IdP), primero debes acceder a gcloud CLI con tu identidad federada.

  6. Para inicializar gcloud CLI, ejecuta el siguiente 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. Si usas un proveedor de identidad externo (IdP), primero debes acceder a gcloud CLI con tu identidad federada.

  11. Para inicializar gcloud CLI, ejecuta el siguiente comando:

    gcloud init
  12. Asegúrate de conocer el ID de la organización.
  13. Roles requeridos

    Para obtener los permisos que necesitas para administrar las políticas de la organización personalizadas, pídele a tu administrador que te otorgue el rol de IAM de Administrador de políticas de la organización (roles/orgpolicy.policyAdmin) en el recurso de organización. Para obtener más información sobre cómo otorgar roles, consulta Administra el acceso a proyectos, carpetas y organizaciones.

    También puedes obtener los permisos necesarios mediante roles personalizados o cualquier otro rol predefinido.

    Crea una restricción personalizada

    Una restricción personalizada se define en un archivo YAML mediante los recursos, los métodos, las condiciones y las acciones que son compatibles con el servicio en el que aplicas la política de la organización. Las condiciones para tus restricciones personalizadas se definen con Common Expression Language (CEL). Si deseas obtener más información para compilar condiciones en restricciones personalizadas mediante CEL, consulta la sección CEL de Crea y administra restricciones personalizadas.

    Para crear una restricción personalizada, crea un archivo YAML con el siguiente formato:

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

    Reemplaza lo siguiente:

    • ORGANIZATION_ID: el ID de la organización, como 123456789.

    • CONSTRAINT_NAME: el nombre que deseas para tu nueva restricción personalizada. Una restricción personalizada debe comenzar con custom. y solo puede incluir letras mayúsculas, minúsculas o números. Por ejemplo, custom.enableGkeTargets. La longitud máxima de este campo es de 70 caracteres.

    • RESOURCE_NAME: Es el nombre completamente calificado del recursoGoogle Cloud que contiene el objeto y el campo que deseas restringir. Por ejemplo, clouddeploy.googleapis.com/clouddeploy.googleapis.com/Target.

    • CONDITION: una condición de CEL que se escribe en una representación de un recurso de servicio compatible. La longitud máxima de este campo es 1000 caracteres. Consulta Recursos compatibles con el fin de obtener más información sobre los recursos disponibles para escribir condiciones. Por ejemplo, "has(resource.gke)".

    • ACTION: la acción que se realiza si se cumple condition. Los valores posibles son ALLOW y DENY.

    • DISPLAY_NAME: un nombre descriptivo para la restricción. La longitud máxima de este campo es 200 caracteres.

    • DESCRIPTION: una descripción fácil de usar de la restricción que se mostrará como un mensaje de error cuando se infringe la política. La longitud máxima de este campo es 2000 caracteres.

    Para obtener más información sobre cómo crear una restricción personalizada, consulta Define restricciones personalizadas.

    Configura una restricción personalizada

    Después de crear el archivo YAML para una nueva restricción personalizada, debes configurarla para que esté disponible para las políticas de la organización de tu organización. Para configurar una restricción personalizada, usa el comando gcloud org-policies set-custom-constraint:
    gcloud org-policies set-custom-constraint CONSTRAINT_PATH
    Reemplaza CONSTRAINT_PATH por la ruta de acceso completa al archivo de restricción personalizado. Por ejemplo, /home/user/customconstraint.yaml. Una vez completadas, tus restricciones personalizadas estarán disponibles como políticas de la organización en tu lista de Google Cloud políticas de la organización. Para verificar que la restricción personalizada exista, usa el comando gcloud org-policies list-custom-constraints:
    gcloud org-policies list-custom-constraints --organization=ORGANIZATION_ID
    Reemplaza ORGANIZATION_ID por el ID del recurso de tu organización. Para obtener más información, consulta Visualiza las políticas de la organización.

    Aplica de manera forzosa una política de la organización personalizada

    Puedes aplicar una restricción si creas una política de la organización que haga referencia a ella y, luego, aplicas esa política a un recurso Google Cloud .

    Console

    1. En la consola de Google Cloud , ve a la página Políticas de la organización.

      Ir a Políticas de la organización

    2. En el selector de proyectos, selecciona el proyecto para el que deseas configurar la política de la organización.
    3. En la lista de la página Políticas de la organización, selecciona tu restricción para ver la página Detalles de la política de esa restricción.
    4. Si deseas configurar las políticas de la organización para este recurso, haz clic en Administrar política.
    5. En la página Editar política, selecciona Anular la política del elemento superior.
    6. Haz clic en Agregar una regla.
    7. En la sección Aplicación, selecciona si la aplicación de esta política de la organización está activada o desactivada.
    8. Opcional: haz clic en Agregar condición para que la política de la organización sea condicional en una etiqueta. Ten en cuenta que si agregas una regla condicional a una política de la organización, debes agregar al menos una regla sin condición o la política no se puede guardar. Para obtener más información, consulta Configura una política de la organización con etiquetas.
    9. Haz clic en Probar cambios para simular el efecto de la política de la organización. La simulación de políticas no está disponible para las restricciones administradas heredadas. Para obtener más información, consulta Prueba los cambios en las políticas de la organización con Policy Simulator.
    10. Para finalizar y aplicar la política de la organización, haz clic en Establecer política. La política tarda hasta 15 minutos en aplicarse.

    gcloud

    Para crear una política de la organización con reglas booleanas, crea un archivo YAML de política que haga referencia a la restricción:

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

    Reemplaza lo siguiente:

    • PROJECT_ID: el proyecto en el que deseas aplicar tu restricción.
    • CONSTRAINT_NAME: el nombre que definiste para tu restricción personalizada. Por ejemplo: custom.enableGkeTargets

    Para aplicar la política de la organización que contiene la restricción, ejecuta el siguiente comando:

        gcloud org-policies set-policy POLICY_PATH
        

    Reemplaza POLICY_PATH por la ruta de acceso completa al archivo YAML de la política de la organización. La política tarda hasta 15 minutos en aplicarse.

    Prueba la política de la organización personalizada

    En el siguiente ejemplo, se crea una restricción y una política personalizadas que permiten crear y actualizar destinos de GKE.

    Antes de comenzar, debes saber lo siguiente:

    • El ID de tu organización
    • Un ID del proyecto

    Crea la restricción

    1. Guarda el siguiente archivo como constraint-enable-gke-targets.yaml:

      name: organizations/ORGANIZATION_ID/customConstraints/custom.enableGkeTargets
      resourceTypes:
      - clouddeploy.googleapis.com/Target
      methodTypes:
      - CREATE
      - UPDATE
      condition: "has(resource.gke)"
      actionType: ALLOW
      displayName: Enable the creation and update of GKE targets
      description: All new targets must be GKE clusters.
      

      Esto define una restricción en la que, para cada destino nuevo creado, la operación se rechaza si el tipo de destino no es un clúster de GKE.

    2. Aplica la restricción:

      gcloud org-policies set-custom-constraint ~/constraint-enable-gke-targets.yaml
      
    3. Verifica que la restricción exista:

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

      El resultado es similar a este:

      CUSTOM_CONSTRAINT                       ACTION_TYPE  METHOD_TYPES   RESOURCE_TYPES                     DISPLAY_NAME
      custom.enableGkeTargets                 ALLOW        CREATE,UPDATE  clouddeploy.googleapis.com/Target  Enable the creation of GKE targets
      ...
      

    Crea la política

    1. Guarda el siguiente archivo como policy-enable-gke-targets.yaml:

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

      Reemplaza PROJECT_ID con el ID del proyecto.

    2. Aplica la política:

      gcloud org-policies set-policy ~/policy-enable-gke-targets.yaml
      
    3. Verifica que la política exista:

      gcloud org-policies list --project=PROJECT_ID
      

      El resultado es similar a este:

      CONSTRAINT                  LIST_POLICY    BOOLEAN_POLICY    ETAG
      custom.enableGkeTargets     -              SET               COCsm5QGENiXi2E=
      

    Después de aplicar la política, espera unos dos minutos para que Google Cloud comience a aplicarla.

    Prueba la política

    Intenta crear un destino de Cloud Run en el proyecto:

    • Crea un archivo YAML de Cloud Deploy llamado clouddeploy.yaml que defina un destino de Cloud Run:
    apiVersion: deploy.cloud.google.com/v1
    kind: Target
    metadata:
      name: run-target
    run:
      location: projects/PROJECT_ID/locations/REGION
    
    gcloud deploy apply --file=clouddeploy.yaml \
        --project=PROJECT_ID \
        --region=REGION
    

    Esta es la salida:

    Operation denied by custom org policies: ["customConstraints/custom.enableGkeTargets": "All new targets must be GKE clusters."]
    

    Ejemplos de políticas de la organización personalizadas para casos de uso comunes

    En esta tabla, se proporcionan ejemplos de sintaxis para algunas restricciones personalizadas comunes.

    En los siguientes ejemplos, se usan las macros de CEL all y exists. Para obtener más información sobre estas macros, consulta Macros.

    Descripción Sintaxis de la restricción
    No permitir canalizaciones de entrega de una sola etapa
        name: organizations/ORGANIZATION_ID/customConstraints/custom.denySingleStagePipelines
        resourceTypes:
        - clouddeploy.googleapis.com/DeliveryPipeline
        methodTypes:
        - CREATE
        condition: "len(resource.serialPipeline.stages) == 1"
        actionType: DENY
        displayName: Deny single-stage delivery pipelines.
        description: All pipelines must have more than one stage.
        
    Permite crear o actualizar objetivos que requieren aprobación
        name: organizations/ORGANIZATION_ID/customConstraints/custom.enableTargetRequireApproval
        resourceTypes:
        - clouddeploy.googleapis.com/Target
        methodTypes:
        - CREATE
        - UPDATE
        condition: "resource.requireApproval"
        actionType: ALLOW
        displayName: Enable require approval on all targets
        description: All targets must require approval.
        
    Rechaza la creación de automatizaciones con cualquier regla de promoción
        name: organizations/ORGANIZATION_ID/customConstraints/custom.denyPromoteReleaseAutomationRules
        resourceTypes:
        - clouddeploy.googleapis.com/Automation
        methodTypes:
        - CREATE
        condition: "resource.rules.exists(r, has(r.promoteReleaseRule) || has(r.timedPromoteReleaseRule))"
        actionType: DENY
        displayName: Deny promote release or timed promote release automation rules.
        description: All automation rules must be of type advance rollout or repair rollout.
        

    Recursos compatibles con Cloud Deploy

    En la siguiente tabla, se enumeran los recursos de Cloud Deploy a los que puedes hacer referencia en las restricciones personalizadas.

    Recurso Campo
    clouddeploy.googleapis.com/Automation resource.annotations
    resource.description
    resource.rules.advanceRolloutRule.id
    resource.rules.advanceRolloutRule.sourcePhases
    resource.rules.advanceRolloutRule.wait
    resource.rules.promoteReleaseRule.destinationPhase
    resource.rules.promoteReleaseRule.destinationTargetId
    resource.rules.promoteReleaseRule.id
    resource.rules.promoteReleaseRule.wait
    resource.rules.repairRolloutRule.id
    resource.rules.repairRolloutRule.jobs
    resource.rules.repairRolloutRule.phases
    resource.rules.repairRolloutRule.repairPhases.retry.attempts
    resource.rules.repairRolloutRule.repairPhases.retry.backoffMode
    resource.rules.repairRolloutRule.repairPhases.retry.wait
    resource.rules.repairRolloutRule.repairPhases.rollback.destinationPhase
    resource.rules.repairRolloutRule.repairPhases.rollback.disableRollbackIfRolloutPending
    resource.rules.timedPromoteReleaseRule.destinationPhase
    resource.rules.timedPromoteReleaseRule.destinationTargetId
    resource.rules.timedPromoteReleaseRule.id
    resource.rules.timedPromoteReleaseRule.schedule
    resource.rules.timedPromoteReleaseRule.timeZone
    resource.selector.targets.id
    resource.serviceAccount
    resource.suspended
    clouddeploy.googleapis.com/CustomTargetType resource.annotations
    resource.customActions.deployAction
    resource.customActions.includeSkaffoldModules.configs
    resource.customActions.includeSkaffoldModules.git.path
    resource.customActions.includeSkaffoldModules.git.ref
    resource.customActions.includeSkaffoldModules.git.repo
    resource.customActions.includeSkaffoldModules.googleCloudBuildRepo.path
    resource.customActions.includeSkaffoldModules.googleCloudBuildRepo.ref
    resource.customActions.includeSkaffoldModules.googleCloudBuildRepo.repository
    resource.customActions.includeSkaffoldModules.googleCloudStorage.path
    resource.customActions.includeSkaffoldModules.googleCloudStorage.source
    resource.customActions.renderAction
    resource.description
    resource.name
    clouddeploy.googleapis.com/DeliveryPipeline resource.annotations
    resource.description
    resource.name
    resource.serialPipeline.stages.deployParameters.matchTargetLabels
    resource.serialPipeline.stages.deployParameters.values
    resource.serialPipeline.stages.profiles
    resource.serialPipeline.stages.strategy.canary.canaryDeployment.percentages
    resource.serialPipeline.stages.strategy.canary.canaryDeployment.postdeploy.actions
    resource.serialPipeline.stages.strategy.canary.canaryDeployment.predeploy.actions
    resource.serialPipeline.stages.strategy.canary.canaryDeployment.verify
    resource.serialPipeline.stages.strategy.canary.customCanaryDeployment.phaseConfigs.percentage
    resource.serialPipeline.stages.strategy.canary.customCanaryDeployment.phaseConfigs.phaseId
    resource.serialPipeline.stages.strategy.canary.customCanaryDeployment.phaseConfigs.postdeploy.actions
    resource.serialPipeline.stages.strategy.canary.customCanaryDeployment.phaseConfigs.predeploy.actions
    resource.serialPipeline.stages.strategy.canary.customCanaryDeployment.phaseConfigs.profiles
    resource.serialPipeline.stages.strategy.canary.customCanaryDeployment.phaseConfigs.verify
    resource.serialPipeline.stages.strategy.canary.runtimeConfig.cloudRun.automaticTrafficControl
    resource.serialPipeline.stages.strategy.canary.runtimeConfig.cloudRun.canaryRevisionTags
    resource.serialPipeline.stages.strategy.canary.runtimeConfig.cloudRun.priorRevisionTags
    resource.serialPipeline.stages.strategy.canary.runtimeConfig.cloudRun.stableRevisionTags
    resource.serialPipeline.stages.strategy.canary.runtimeConfig.kubernetes.gatewayServiceMesh.deployment
    resource.serialPipeline.stages.strategy.canary.runtimeConfig.kubernetes.gatewayServiceMesh.httpRoute
    resource.serialPipeline.stages.strategy.canary.runtimeConfig.kubernetes.gatewayServiceMesh.podSelectorLabel
    resource.serialPipeline.stages.strategy.canary.runtimeConfig.kubernetes.gatewayServiceMesh.routeDestinations.destinationIds
    resource.serialPipeline.stages.strategy.canary.runtimeConfig.kubernetes.gatewayServiceMesh.routeDestinations.propagateService
    resource.serialPipeline.stages.strategy.canary.runtimeConfig.kubernetes.gatewayServiceMesh.routeUpdateWaitTime
    resource.serialPipeline.stages.strategy.canary.runtimeConfig.kubernetes.gatewayServiceMesh.service
    resource.serialPipeline.stages.strategy.canary.runtimeConfig.kubernetes.gatewayServiceMesh.stableCutbackDuration
    resource.serialPipeline.stages.strategy.canary.runtimeConfig.kubernetes.serviceNetworking.deployment
    resource.serialPipeline.stages.strategy.canary.runtimeConfig.kubernetes.serviceNetworking.disablePodOverprovisioning
    resource.serialPipeline.stages.strategy.canary.runtimeConfig.kubernetes.serviceNetworking.podSelectorLabel
    resource.serialPipeline.stages.strategy.canary.runtimeConfig.kubernetes.serviceNetworking.service
    resource.serialPipeline.stages.strategy.standard.postdeploy.actions
    resource.serialPipeline.stages.strategy.standard.predeploy.actions
    resource.serialPipeline.stages.strategy.standard.verify
    resource.serialPipeline.stages.targetId
    resource.suspended
    clouddeploy.googleapis.com/DeployPolicy resource.annotations
    resource.description
    resource.rules.rolloutRestriction.actions
    resource.rules.rolloutRestriction.id
    resource.rules.rolloutRestriction.invokers
    resource.rules.rolloutRestriction.timeWindows.oneTimeWindows.endDate
    resource.rules.rolloutRestriction.timeWindows.oneTimeWindows.endTime
    resource.rules.rolloutRestriction.timeWindows.oneTimeWindows.startDate
    resource.rules.rolloutRestriction.timeWindows.oneTimeWindows.startTime
    resource.rules.rolloutRestriction.timeWindows.timeZone
    resource.rules.rolloutRestriction.timeWindows.weeklyWindows.daysOfWeek
    resource.rules.rolloutRestriction.timeWindows.weeklyWindows.endTime
    resource.rules.rolloutRestriction.timeWindows.weeklyWindows.startTime
    resource.selectors.deliveryPipeline.id
    resource.selectors.target.id
    resource.suspended
    clouddeploy.googleapis.com/Release resource.annotations
    resource.buildArtifacts.image
    resource.buildArtifacts.tag
    resource.deployParameters
    resource.description
    resource.name
    resource.skaffoldConfigPath
    resource.skaffoldConfigUri
    resource.skaffoldVersion
    clouddeploy.googleapis.com/Rollout resource.annotations
    resource.description
    resource.name
    resource.targetId
    clouddeploy.googleapis.com/Target resource.annotations
    resource.anthosCluster.membership
    resource.associatedEntities[*].anthosClusters.membership
    resource.associatedEntities[*].gkeClusters.cluster
    resource.associatedEntities[*].gkeClusters.dnsEndpoint
    resource.associatedEntities[*].gkeClusters.internalIp
    resource.associatedEntities[*].gkeClusters.proxyUrl
    resource.customTarget.customTargetType
    resource.deployParameters
    resource.description
    resource.executionConfigs.artifactStorage
    resource.executionConfigs.defaultPool.artifactStorage
    resource.executionConfigs.defaultPool.serviceAccount
    resource.executionConfigs.executionTimeout
    resource.executionConfigs.privatePool.artifactStorage
    resource.executionConfigs.privatePool.serviceAccount
    resource.executionConfigs.privatePool.workerPool
    resource.executionConfigs.serviceAccount
    resource.executionConfigs.usages
    resource.executionConfigs.verbose
    resource.executionConfigs.workerPool
    resource.gke.cluster
    resource.gke.dnsEndpoint
    resource.gke.internalIp
    resource.gke.proxyUrl
    resource.multiTarget.targetIds
    resource.name
    resource.requireApproval
    resource.run.location

    ¿Qué sigue?