Crea restricciones personalizadas para Copia de seguridad para GKE

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 :

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

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.retentionPolicyEnforced. 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, gkebackup.googleapis.com/Backup.

    • 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.retainDays > 30".

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

    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 los siguientes pasos, se muestra cómo crear una restricción y una política personalizadas que permitan a los usuarios crear una copia de seguridad de Copia de seguridad para GKE si el campo retainDays se establece en un valor superior a 30.

    Antes de comenzar, prepara lo siguiente:

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

    Crea la restricción

    1. Guarda el siguiente archivo como 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.

      Reemplaza ORGANIZATION_ID por el ID de tu organización.

      Este archivo define una restricción en la que el campo retainDays debe ser mayor que 30 en el método CREATE.

    2. Aplica la restricción con el comando gcloud org-policies set-custom-constraint:

      gcloud org-policies set-custom-constraint CONSTRAINT_FILE_NAME.yaml

    3. Verifica que la restricción exista con el comando gcloud org-policies list-custom-constraints:

      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.retentionPolicyEnforced   DENY         CREATE,UPDATE  gkebackup.googleapis.com/Backup   Enforce retention policy
...

    Crea la política

    1. Guarda el siguiente archivo como POLICY_FILE_NAME.yaml:

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

      Reemplaza PROJECT_ID con el ID del proyecto.

    2. Aplica la política con el comando gcloud org-policies set-policy:

      gcloud org-policies set-policy POLICY_FILE_NAME.yaml

    3. Verifica que la política exista con el comando gcloud org-policies list:

      gcloud org-policies list --project=PROJECT_ID

      El resultado es similar a este:

      CONSTRAINT                         LIST_POLICY  BOOLEAN_POLICY  ETAG
custom.retentionPolicyEnforced     -            SET             CPiLkMMGEKDFq6IB-

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

    Prueba la política

    1. Crea una copia de seguridad sin establecer el campo retainDays en un valor mayor que 30:

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

      El resultado es similar a este:

      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

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

    En la siguiente tabla, se enumeran las políticas de la organización personalizadas que pueden resultarte útiles:

    Descripción Sintaxis de la restricción
    Permitir la creación de copias de seguridad solo si tienen un período de retención superior a 20 días 
        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
    Inhabilita la creación de planes de copia de seguridad con un cronSchedule diferente del 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 * * *.

    Recursos admitidos por Copia de seguridad para GKE

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

    Recurso 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

    ¿Qué sigue?