Crear restricciones personalizadas para Cloud Workstations

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

  • workstations.googleapis.com/WorkstationCluster
  • workstations.googleapis.com/WorkstationConfig
  • workstations.googleapis.com/Workstation

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

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

El Google Cloud servicio de políticas de organización te permite controlar los recursos de tu organización de forma centralizada y programática. Como administrador de políticas de organización, puedes definir una política de organización, que es un conjunto de restricciones llamadas restricciones que se aplican a losGoogle Cloud recursos y a los elementos descendientes de esos recursos en la Google Cloud jerarquía de recursos. Puedes aplicar políticas de organización a nivel de organización, carpeta o proyecto.

La política de la organización proporciona restricciones gestionadas integradas para varios servicios de Google Cloud . Sin embargo, si quieres tener un control más granular 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 organización se heredan de los descendientes de los recursos en los que se aplican. Por ejemplo, si aplicas una política a una carpeta, Google Cloud se aplicará a todos los proyectos de la carpeta. Para obtener más información sobre este comportamiento y cómo cambiarlo, consulta las reglas de evaluación de la jerarquía.

Antes de empezar

  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 utilizas un proveedor de identidades (IdP) externo, primero debes iniciar sesión en la CLI de gcloud con tu identidad federada.

  6. Para inicializar la CLI de gcloud, 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 utilizas un proveedor de identidades (IdP) externo, primero debes iniciar sesión en la CLI de gcloud con tu identidad federada.

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

    gcloud init
  12. Asegúrate de que conoces el ID de tu organización.

    13. Roles obligatorios

    Para obtener los permisos que necesitas para gestionar políticas de organización personalizadas, pide a tu administrador que te conceda el rol de gestión de identidades y accesos Administrador de políticas de organización (roles/orgpolicy.policyAdmin) en el recurso de la organización. Para obtener más información sobre cómo conceder roles, consulta el artículo Gestionar el acceso a proyectos, carpetas y organizaciones.

    También puedes conseguir los permisos necesarios a través de roles personalizados u otros roles predefinidos.

    Crear 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 admite el servicio en el que se aplica la política de la organización. Las condiciones de tus restricciones personalizadas se definen mediante el lenguaje de expresión común (CEL). Para obtener más información sobre cómo crear condiciones en restricciones personalizadas mediante CEL, consulta la sección sobre CEL del artículo Crear y gestionar 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

    Haz los cambios siguientes:

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

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

    • RESOURCE_NAME: nombre completo del recursoGoogle Cloud que contiene el objeto y el campo que quieres restringir. Por ejemplo, workstations.googleapis.com/WorkstationCluster.

    • CONDITION: una condición CEL que se escribe en una representación de un recurso de servicio compatible. Este campo tiene una longitud máxima de 1000 caracteres. Consulta los recursos admitidos para obtener más información sobre los recursos con los que puedes escribir condiciones. Por ejemplo, resource.privateClusterConfig.enablePrivateEndpoint == true.

    • ACTION: la acción que se debe llevar a cabo si se cumple la condición condition. Los valores posibles son ALLOW y DENY.

    • DISPLAY_NAME: nombre descriptivo de la restricción. Este campo tiene una longitud máxima de 200 caracteres.

    • DESCRIPTION: descripción de la restricción que se mostrará como mensaje de error cuando se infrinja la política. Este campo tiene una longitud máxima de 2000 caracteres.

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

    Configurar una restricción personalizada

    Una vez que hayas creado el archivo YAML de una nueva restricción personalizada, debes configurarla para que esté disponible en las políticas de 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
     Sustituye CONSTRAINT_PATH por la ruta completa a tu archivo de restricciones personalizadas. Por ejemplo, /home/user/customconstraint.yaml. Una vez completado el proceso, las restricciones personalizadas estarán disponibles como políticas de organización en la lista de Google Cloud políticas de organización. Para verificar que la restricción personalizada existe, usa el comando gcloud org-policies list-custom-constraints: 
    gcloud org-policies list-custom-constraints --organization=ORGANIZATION_ID
     Sustituye ORGANIZATION_ID por el ID de tu recurso de organización. Para obtener más información, consulta Ver políticas de la organización.

    Aplicar una política de organización personalizada

    Para aplicar una restricción, crea una política de organización que haga referencia a ella y, a continuación, aplica esa política de organización a un Google Cloud recurso.

    Consola

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

      Ir a Políticas de organización

    2. En el selector de proyectos, elige el proyecto para el que quieras definir la política de organización.
    3. En la lista de la página Políticas de organización, selecciona la restricción para ver la página Detalles de la política correspondiente.
    4. Para configurar la política de la organización de este recurso, haz clic en Gestionar política.
    5. En la página Editar política, selecciona Anular política del recurso superior.
    6. Haz clic en Añadir regla.
    7. En la sección Aplicación, selecciona si quieres activar o desactivar la aplicación de esta política de la organización.
    8. Opcional: Para que la política de la organización dependa de una etiqueta, haz clic en Añadir condición. Ten en cuenta que, si añades una regla condicional a una política de organización, debes añadir al menos una regla incondicional o la política no se podrá guardar. Para obtener más información, consulta Configurar una política de 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 gestionadas antiguas. Para obtener más información, consulta el artículo Probar los cambios en las políticas de la organización con el simulador de políticas.
    10. Para finalizar y aplicar la política de organización, haz clic en Definir política. La política tarda hasta 15 minutos en aplicarse.

    gcloud

    Para crear una política de 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

    Haz los cambios siguientes:

    • PROJECT_ID: el proyecto en el que quieras aplicar la restricción.
    • CONSTRAINT_NAME: el nombre que has definido para tu restricción personalizada. Por ejemplo, custom.workstationsPrivateGatewayClusters.

    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

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

    Probar la política de organización personalizada

    En el siguiente ejemplo se crea una restricción y una política personalizadas que requieren que todos los clústeres de estaciones de trabajo nuevos de un proyecto específico habiliten el endpoint de la pasarela privada.

    Antes de empezar, debes saber lo siguiente:

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

    Crear la restricción

    1. Guarda el siguiente archivo como constraint-ws-private-gateway.yaml:

      name: organizations/ORGANIZATION_ID/customConstraints/custom.workstationsPrivateGatewayClusters
resourceTypes:
- workstations.googleapis.com/WorkstationCluster
methodTypes:
- CREATE
- UPDATE
condition: resource.privateClusterConfig.enablePrivateEndpoint == true
actionType: ALLOW
displayName: Require workstation cluster to enable private gateway endpoint
description: All workstation clusters must enable private gateway endpoint

      Define una restricción según la cual, en cada clúster de estaciones de trabajo nuevo, si la puerta de enlace pública está habilitada, se deniega la operación.

    2. Aplica la restricción:

      gcloud org-policies set-custom-constraint ~/constraint-ws-private-gateway.yaml

    3. Verifica que la restricción exista:

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

      El resultado debería ser similar al siguiente:

      CUSTOM_CONSTRAINT                          ACTION_TYPE  METHOD_TYPES   RESOURCE_TYPES                                  DISPLAY_NAME
custom.workstationsPrivateGatewayClusters  DENY         CREATE,UPDATE  workstations.googleapis.com/WorkstationCluster  Require workstation cluster to enable private gateway endpoint
...

    Crear la política

    1. Guarda el siguiente archivo como policy-ws-private-gateway.yaml:

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

      Sustituye PROJECT_ID por el ID del proyecto.

    2. Aplica la política:

      gcloud org-policies set-policy ~/policy-ws-private-gateway.yaml

    3. Comprueba que la política exista:

      gcloud org-policies list --project=PROJECT_ID

      El resultado debería ser similar al siguiente:

      CONSTRAINT                                 LIST_POLICY  BOOLEAN_POLICY  ETAG
custom.workstationsPrivateGatewayClusters  -            SET             COCsm5QGENiXi2E=

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

    Probar la política

    Para probar la política en un clúster de estaciones de trabajo con una pasarela pública, crea un clúster:

    gcloud workstations clusters create CLUSTER --region=REGION

    Haz los cambios siguientes:

    • CLUSTER: el ID del clúster (por ejemplo, public-gateway-cluster)

    • REGION: el ID de la región (por ejemplo, us-central1)

    La salida será similar a la siguiente:

    Operation denied by custom org policies: ["customConstraints/custom.workstationsPrivateGatewayClusters": "All workstation clusters must enable private gateway endpoint"]

    Para crear un clúster correctamente, añade la marca --enable-private-endpoint al comando gcloud workstations clusters create:

    gcloud workstations clusters create CLUSTER --region=REGION --enable-private-endpoint

    Ejemplos de políticas de organización personalizadas para casos prácticos habituales

    En la siguiente tabla se muestra la sintaxis de algunas restricciones personalizadas para casos prácticos habituales:

    Descripción Sintaxis de las restricciones
    Requerir que los clústeres de estaciones de trabajo habiliten el endpoint de la pasarela privada. 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.workstationsPrivateGatewayClusters
    resourceTypes:
    - workstations.googleapis.com/WorkstationCluster
    methodTypes:
    - CREATE
    - UPDATE
    condition: "resource.privateClusterConfig.enablePrivateEndpoint == true"
    actionType: ALLOW
    displayName: Require workstation cluster to enable private gateway endpoint
    description: All workstation clusters must enable private gateway endpoint
    Requiere que las configuraciones de la estación de trabajo inhabiliten las conexiones TCP. 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.workstationConfigDisableTcpConnections
    resourceTypes:
    - workstations.googleapis.com/WorkstationConfig
    methodTypes:
    - CREATE
    - UPDATE
    condition: "resource.disableTcpConnections == true"
    actionType: ALLOW
    displayName: Require workstation configs to disable TCP connections
    description: All workstation configs must disable TCP connections
    Requerir que las configuraciones de las estaciones de trabajo inhabiliten el acceso SSH a las VMs de las estaciones de trabajo. 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.workstationConfigDisableSsh
    resourceTypes:
    - workstations.googleapis.com/WorkstationConfig
    methodTypes:
    - CREATE
    - UPDATE
    condition: "resource.host.gceInstance.disableSsh == true"
    actionType: ALLOW
    displayName: Require workstation configs to disable SSH access to workstation VMs
    description: All workstation configs must disable SSH access to workstation VMs

    Recursos admitidos en Cloud Workstations

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

    Recurso Campo
    workstations.googleapis.com/Workstation resource.annotations
    resource.displayName
    resource.env
    resource.name
    resource.sourceWorkstation
    workstations.googleapis.com/WorkstationCluster resource.annotations
    resource.displayName
    resource.domainConfig.domain
    resource.name
    resource.network
    resource.privateClusterConfig.allowedProjects
    resource.privateClusterConfig.enablePrivateEndpoint
    resource.subnetwork
    resource.tags
    workstations.googleapis.com/WorkstationConfig resource.allowedPorts.first
    resource.allowedPorts.last
    resource.annotations
    resource.container.args
    resource.container.command
    resource.container.env
    resource.container.image
    resource.container.runAsUser
    resource.container.workingDir
    resource.disableTcpConnections
    resource.displayName
    resource.enableAuditAgent
    resource.encryptionKey.kmsKey
    resource.encryptionKey.kmsKeyServiceAccount
    resource.ephemeralDirectories.gcePd.diskType
    resource.ephemeralDirectories.gcePd.readOnly
    resource.ephemeralDirectories.gcePd.sourceImage
    resource.ephemeralDirectories.gcePd.sourceSnapshot
    resource.ephemeralDirectories.mountPath
    resource.grantWorkstationAdminRoleOnCreate
    resource.host.gceInstance.accelerators.count
    resource.host.gceInstance.accelerators.type
    resource.host.gceInstance.boostConfigs.accelerators.count
    resource.host.gceInstance.boostConfigs.accelerators.type
    resource.host.gceInstance.boostConfigs.bootDiskSizeGb
    resource.host.gceInstance.boostConfigs.enableNestedVirtualization
    resource.host.gceInstance.boostConfigs.machineType
    resource.host.gceInstance.boostConfigs.poolSize
    resource.host.gceInstance.bootDiskSizeGb
    resource.host.gceInstance.confidentialInstanceConfig.enableConfidentialCompute
    resource.host.gceInstance.disablePublicIpAddresses
    resource.host.gceInstance.disableSsh
    resource.host.gceInstance.enableNestedVirtualization
    resource.host.gceInstance.machineType
    resource.host.gceInstance.poolSize
    resource.host.gceInstance.serviceAccount
    resource.host.gceInstance.serviceAccountScopes
    resource.host.gceInstance.shieldedInstanceConfig.enableIntegrityMonitoring
    resource.host.gceInstance.shieldedInstanceConfig.enableSecureBoot
    resource.host.gceInstance.shieldedInstanceConfig.enableVtpm
    resource.host.gceInstance.tags
    resource.host.gceInstance.vmTags
    resource.idleTimeout
    resource.maxUsableWorkstations
    resource.name
    resource.persistentDirectories.gcePd.diskType
    resource.persistentDirectories.gcePd.fsType
    resource.persistentDirectories.gcePd.reclaimPolicy
    resource.persistentDirectories.gcePd.sizeGb
    resource.persistentDirectories.gcePd.sourceSnapshot
    resource.persistentDirectories.mountPath
    resource.readinessChecks.path
    resource.readinessChecks.port
    resource.replicaZones
    resource.runningTimeout

    Siguientes pasos