Crea restricciones de 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 :

  • dataform.googleapis.com/Repository

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 Google Cloud jerarquía de recursos. 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.

Beneficios

Puedes usar políticas de la organización personalizadas para permitir o denegar valores específicos para los recursos de Dataform. Por ejemplo, si una solicitud para crear o actualizar un recurso dataform.googleapis.com/Repository no pasa la validación de restricción personalizada establecida por la política de la organización, la solicitud falla y se devuelve un error al llamador.

El uso de políticas personalizadas de la organización agrega una capa adicional de seguridad, cumplimiento y administración. Por ejemplo, puedes definir políticas que permitan la creación de recursos solo en una región en particular o que prohíban el uso de Git remotos fuera de tu organización.

Limitaciones

Al igual que todas las restricciones de políticas de la organización, los cambios de política no se aplican de forma retroactiva a los recursos existentes:

  • Una política nueva no afecta a los recursos existentes.
  • Si cambias la política, un recurso existente seguirá siendo válido, a menos que cambies el recurso de un valor que cumpla con la política a uno que no la cumpla con laGoogle Cloud consola o una RPC.

Te recomendamos que todos los recursos existentes cumplan con una política antes de aplicar una política nueva. Para verificar qué recursos existentes no cumplirán con la política después de que la apliques, usa el Simulador de políticas de la organización.

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.

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

    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 (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. 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.restrictRepositoryLocation. 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, dataform.googleapis.com/Repository.

    • 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, "resource.name.contains('/locations/us-central1/')".

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

    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 requieren que todos los recursos dataform.googleapis.com/Repository se creen en una región en particular.

    Antes de comenzar, debes tener lo siguiente:

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

    Crea la restricción

    Para crear una restricción personalizada, sigue estos pasos:

    1. Guarda el siguiente archivo como constraint-restrict-repository-location.yaml:

      name: organizations/ORGANIZATION_ID/customConstraints/custom.restrictRepositoryLocation
resourceTypes:
- dataform.googleapis.com/Repository
methodTypes:
- CREATE
- UPDATE
condition: "resource.name.contains('/locations/us-central1/')"
actionType: ALLOW
displayName: Only us-central1 region is allowed.
description: All resources must be created in the us-central1 region.

      Reemplaza ORGANIZATION_ID por el ID de tu organización.

      Este archivo define una restricción en la que, para cada operación de creación o actualización en el recurso dataform.googleapis.com/Repository, la operación solo se permite si la región seleccionada para el recurso es us-central1.

    2. Aplica la restricción:

      gcloud org-policies set-custom-constraint ~/constraint-restrict-repository-location.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.restrictRepositoryLocation       ALLOW        CREATE,UPDATE  dataform.googleapis.com/Repository Only us-central1 region is allowed.
...

    Crea la política

    Ahora, crea una política y aplícala a la restricción personalizada que creaste.

    1. Guarda el siguiente archivo como policy-restrict-repository-location.yaml:

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

      Reemplaza PROJECT_ID con el ID del proyecto.

    2. Aplica la política:

      gcloud org-policies set-policy ~/policy-restrict-repository-location.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.restrictRepositoryLocation    -              SET               ETAG

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

    Prueba la política

    Sigue los pasos que se indican en Crea un repositorio para crear un recurso dataform.googleapis.com/Repository en tu proyecto. Elige una región diferente de la que especificaste en la restricción personalizada.

    Esta es la salida:

    Operation denied by custom org policies: ["customConstraints/custom.restrictRepositoryLocation": "All resources must be created in the us-central1 region."]

    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.

    Descripción Sintaxis de la restricción
    Todos los recursos deben crearse en la región us-central1. 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.restrictRepositoryLocation
    resourceTypes:
    - dataform.googleapis.com/Repository
    methodTypes:
    - CREATE
    - UPDATE
    condition: "resource.name.contains('/locations/us-central1/')"
    actionType: ALLOW
    displayName: Only us-central1 region is allowed.
    description: All resources must be created in the us-central1 region.
    Solo permite la configuración de un Git remoto para conectarse a través de HTTPS a los repositorios de la organización de Google en GitHub. 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.restrictGitRemote
    resourceTypes:
    - dataform.googleapis.com/Repository
    methodTypes:
    - CREATE
    - UPDATE
    condition: |-
      resource.gitRemoteSettings.url == ""
      || resource.gitRemoteSettings.url.startsWith('https://github.com/google/')
    actionType: ALLOW
    displayName:  Only allow the https://github.com/google/ Git remote.
    description: Only allow configuration of a Git remote to connect using HTTPS to repositories in the Google organization on GitHub.

    Recursos compatibles con Dataform

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

    Recurso Campo
    dataform.googleapis.com/Repository resource.displayName
    resource.gitRemoteSettings.authenticationTokenSecretVersion
    resource.gitRemoteSettings.defaultBranch
    resource.gitRemoteSettings.sshAuthenticationConfig.hostPublicKey
    resource.gitRemoteSettings.sshAuthenticationConfig.userPrivateKeySecretVersion
    resource.gitRemoteSettings.url
    resource.kmsKeyName
    resource.name
    resource.npmrcEnvironmentVariablesSecretVersion
    resource.serviceAccount
    resource.setAuthenticatedUserAdmin
    resource.workspaceCompilationOverrides.defaultDatabase
    resource.workspaceCompilationOverrides.schemaSuffix
    resource.workspaceCompilationOverrides.tablePrefix

    ¿Qué sigue?