Gestionar recursos de Cloud Build con restricciones personalizadas

El 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 los recursos de Cloud Build y a los elementos secundarios 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.

El servicio de políticas de organización proporciona restricciones predefinidas para varios servicios de Cloud Build. 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 políticas de organización personalizadas.

Ventajas

Puedes usar una política de organización personalizada para permitir o denegar recursos específicos de Cloud Build. Por ejemplo, si una solicitud para crear o actualizar un activador de compilación no cumple la validación de restricciones personalizadas definida por la política de tu organización, la solicitud fallará y se devolverá un error a la persona que la haya llamado.

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, Cloud Build la aplicará a todos los proyectos de esa carpeta. Para obtener más información sobre este comportamiento y cómo cambiarlo, consulta las reglas de evaluación de la jerarquía.

Precios

El servicio de políticas de organización, incluidas las políticas de organización predefinidas y personalizadas, se ofrece sin coste económico.

Antes de empezar

  1. Configurar un proyecto
    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. Enable the Cloud Build API.

      Enable the API

    5. Install the Google Cloud CLI.

    6. Si utilizas un proveedor de identidades (IdP) externo, primero debes iniciar sesión en la CLI de gcloud con tu identidad federada.

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

      gcloud init

    8. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

      Go to project selector

    9. Verify that billing is enabled for your Google Cloud project.

    10. Enable the Cloud Build API.

      Enable the API

    11. Install the Google Cloud CLI.

    12. Si utilizas un proveedor de identidades (IdP) externo, primero debes iniciar sesión en la CLI de gcloud con tu identidad federada.

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

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

      15. Roles obligatorios

      Para obtener los permisos que necesitas para gestionar las políticas de la organización, pide a tu administrador que te conceda el rol de gestión de identidades y accesos Administrador de políticas de la 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.

      También debes añadir los roles necesarios para crear Cloud Build a tu cuenta de usuario. Consulta Configurar el acceso a los recursos de Cloud Build. Para obtener más información sobre los roles de gestión de identidades y accesos asociados a Cloud Build, consulta Roles y permisos de gestión de identidades y accesos.

      Crear una restricción personalizada

      Puedes crear una restricción personalizada mediante un archivo YAML para definir los recursos, los métodos, las condiciones y las acciones que están sujetos a la restricción. Son específicos del servicio en el que estés aplicando la política de organización. Las condiciones de las restricciones personalizadas deben definirse con el lenguaje de expresión común. Consulta la página de GitHub sobre 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.

      Usa la siguiente plantilla para crear un archivo YAML de una restricción personalizada:

      name: organizations/ORGANIZATION_ID/customConstraints/CONSTRAINT_NAME
resourceTypes:
- cloudbuild.googleapis.com/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.enableBuildTrigger. La longitud máxima de este campo es de 70 caracteres, sin contar el prefijo. Por ejemplo, organizations/123456789/customConstraints/custom.allowConstraint.

      • RESOURCE_NAME: el nombre (no el URI) del recurso de Cloud Build que contiene el objeto y el campo que quieres restringir. Por ejemplo, BuildTrigger.

      • 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.github.name.contains('cloudbuild')".

      • ACTION: la acción que se debe llevar a cabo si se cumple la condición condition. Puede ser ALLOW o 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 el artículo Crear y gestionar políticas de organización 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.enableBuildTrigger.

      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 una restricción personalizada

      Para probar una restricción personalizada, ejecuta un comando de gcloud que intente completar una tarea bloqueada por tu restricción.

      Por ejemplo, supongamos que una restricción requiere que los nombres de los activadores de GitHub contengan "cloudbuild". Puedes probar esta restricción ejecutando el comando gcloud builds triggers create github con otro nombre de activador, como se muestra en el siguiente fragmento:

      gcloud builds triggers create github --name=github-trigger \
    --repo-owner=some-owner \
    --repo-name=some-repo \
    --branch-pattern=main \
    --build-config=cloudbuild.yaml \
    --project=my-project \

      El resultado debería ser similar al siguiente:

      Operation denied by custom org policies: ["customConstraints/custom.enableBuildTrigger": "GitHub trigger name must include "cloudbuild"."]

      Recursos y operaciones compatibles con Cloud Build

      Los siguientes campos de restricciones personalizadas de Cloud Build se pueden usar al crear o actualizar recursos de Cloud Build.

      Ten en cuenta que la restricción de compilaciones no se aplica a las compilaciones activadas por un activador.

      • Configuración de compilación de Cloud Build
        • resource.source.storageSource.bucket
        • resource.source.storageSource.object
        • resource.source.storageSource.generation
        • resource.source.storageSource.sourceFetcher
        • resource.source.repoSource.projectId
        • resource.source.repoSource.repoName
        • resource.source.repoSource.branchName
        • resource.source.repoSource.tagName
        • resource.source.repoSource.commitSha
        • resource.source.repoSource.dir
        • resource.source.repoSource.invertRegex
        • resource.source.repoSource.substitutions
        • resource.source.gitSource.url
        • resource.source.gitSource.dir
        • resource.source.gitSource.revision
        • resource.source.storageSourceManifest.bucket
        • resource.source.storageSourceManifest.object
        • resource.source.storageSourceManifest.generation
        • resource.source.connectedRepository.repository
        • resource.source.connectedRepository.dir
        • resource.source.connectedRepository.revision
        • resource.source.developerConnectConfig.gitRepositoryLink
        • resource.source.developerConnectConfig.dir
        • resource.source.developerConnectConfig.revision
        • resource.steps.name
        • resource.steps.env
        • resource.steps.args
        • resource.steps.dir
        • resource.steps.id
        • resource.steps.waitFor
        • resource.steps.entryPoints
        • resource.steps.secretEnv
        • resource.steps.volumes.name
        • resource.steps.volumes.path
        • resource.steps.timeout
        • resource.steps.allowFailure
        • resource.steps.allowExitCodes
        • resource.steps.script
        • resource.steps.automapSubstitutions
        • resource.timeout
        • resource.images
        • resource.queueTtl
        • resource.artifacts.images
        • resource.artifacts.objects.location
        • resource.artifacts.objects.paths
        • resource.logsBucket
        • resource.options.sourceProvenanceHash
        • resource.options.requestedVerifyOption
        • resource.options.machineType
        • resource.options.diskSizeGb
        • resource.options.substitutionOption
        • resource.options.dynamicSubstitutions
        • resource.options.autoMapSubstitutions
        • resource.options.logStreamingOption
        • resource.options.pool.name
        • resource.options.logging
        • resource.options.env
        • resource.options.secretEnv
        • resource.options.volumes.name
        • resource.options.volumes.path
        • resource.options.defaultLogsBucketBehavior
        • resource.substitutions
        • resource.tags
        • resource.secrets.kmsKeyName
        • resource.secrets.secretEnv
        • resource.serviceAccount
        • resource.availableSecrets.secretManager.versionName
        • resource.availableSecrets.secretManager.env
        • resource.availableSecrets.inline.kmsKeyName
        • resource.availableSecrets.inline.envMap
        • resource.gitConfig.proxySecretVersionName
        • resource.gitConfig.proxySslCaInfo
        • resource.gitConfig.http
      • Cloud Build BitbucketServerConfig
        • resource.name
        • resource.hostUrl
        • resource.secrets.adminAccessTokenVersionName
        • resource.secrets.readAccessTokenVersionName
        • resource.secrets.webhookSecretVersionName
        • resource.username
        • resource.apiKey
        • resource.peeredNetwork
        • resource.sslCa
        • resource.peeredNetworkIpRange
      • Configuración de WorkerPool de Cloud Build
        • resource.displayName
        • resource.annotations
        • resource.privatePoolV1Config.workerConfig.machineType
        • resource.privatePoolV1Config.workerConfig.diskSizeGb
        • resource.privatePoolV1Config.networkConfig.peeredNetwork
        • resource.privatePoolV1Config.networkConfig.egressOption
        • resource.privatePoolV1Config.networkConfig.peeredNetworkIpRange
      • Configuración de BuildTrigger de Cloud Build
        • resource.tags
        • resource.resourceName
        • resource.description
        • resource.name
        • resource.tags
        • resource.triggerTemplate.projectId
        • resource.triggerTemplate.repoName
        • resource.triggerTemplate.branchName
        • resource.triggerTemplate.tagName
        • resource.triggerTemplate.commitSha
        • resource.triggerTemplate.dir
        • resource.triggerTemplate.invertRegex
        • resource.triggerTemplate.substitutions
        • resource.github.owner
        • resource.github.name
        • resource.github.enterpriseConfigResourceName
        • resource.pubsubConfig.topic
        • resource.pubsubConfig.serviceAccountEmail
        • resource.webhookConfig.secret
        • resource.bitbucketServerTriggerConfig.repoSlug
        • resource.bitbucketServerTriggerConfig.projectKey
        • resource.bitbucketServerTriggerConfig.pullRequest.branch
        • resource.bitbucketServerTriggerConfig.pullRequest.commentControl
        • resource.bitbucketServerTriggerConfig.pullRequest.invertRegex
        • resource.bitbucketServerTriggerConfig.push.branch
        • resource.bitbucketServerTriggerConfig.push.tag
        • resource.bitbucketServerTriggerConfig.push.invertRegex
        • resource.gitlabEnterpriseEventsConfig.projectNamespace
        • resource.gitlabEnterpriseEventsConfig.pullRequest.branch
        • resource.gitlabEnterpriseEventsConfig.pullRequest.commentControl
        • resource.gitlabEnterpriseEventsConfig.pullRequest.invertRegex
        • resource.gitlabEnterpriseEventsConfig.push.branch
        • resource.gitlabEnterpriseEventsConfig.push.tag
        • resource.gitlabEnterpriseEventsConfig.push.invertRegex
        • resource.gitlabEnterpriseEventsConfig.gitlabConfigResource
        • resource.disabled
        • resource.substitutions
        • resource.ignoredFiles
        • resource.includedFiles
        • resource.sourceToBuild.uri
        • resource.sourceToBuild.repository
        • resource.sourceToBuild.ref
        • resource.sourceToBuild.repoType
        • resource.sourceToBuild.githubEnterpriseConfig
        • resource.approvalConfig.approvalRequired
        • resource.filter
        • resource.serviceAccount
        • resource.eventType
        • resource.includeBuildLogs
        • resource.repositoryEventConfig.repository
        • resource.repositoryEventConfig.pullRequest.branch
        • resource.repositoryEventConfig.pullRequest.commentControl
        • resource.repositoryEventConfig.pullRequest.invertRegex
        • resource.repositoryEventConfig.push.branch
        • resource.repositoryEventConfig.push.tag
        • resource.repositoryEventConfig.push.invertRegex
      • Configuración de Cloud Build GitHubEnterpriseConfig
        • resource.name
        • resource.hostUrl
        • resource.appId
        • resource.name
        • resource.webhookKey
        • resource.peeredNetwork
        • resource.secrets.privateKeyVersionName
        • resource.secrets.webhookSecretVersionName
        • resource.secrets.oauthSecretVersionName
        • resource.secrets.oauthClientIdVersionName
        • resource.displayName
        • resource.sslCa
      • Configuración de la conexión de Cloud Build
        • resource.name
        • resource.githubConfig.authorizerCredential.oauthTokenSecretVersionName
        • resource.githubConfig.appInstallationId
        • resource.githubEnterpriseConfig.hostUri
        • resource.githubEnterpriseConfig.apiKey
        • resource.githubEnterpriseConfig.appId
        • resource.githubEnterpriseConfig.appSlug
        • resource.githubEnterpriseConfig.privateKeySecretVersion
        • resource.githubEnterpriseConfig.webhookSecretSecretVersion
        • resource.githubEnterpriseConfig.oauthSecretSecretVersion
        • resource.githubEnterpriseConfig.oauthClientIdSecretVersion
        • resource.githubEnterpriseConfig.authorizerCredential.oauthTokenSecretVersionName
        • resource.githubEnterpriseConfig.appInstallationId
        • resource.githubEnterpriseConfig.serviceDirectoryConfig.service
        • resource.githubEnterpriseConfig.sslCa
        • resource.gitlabConfig.hostUri
        • resource.gitlabConfig.webhookSecretSecretVersion
        • resource.gitlabConfig.readAuthorizerCredential.oauthTokenSecretVersionName
        • resource.gitlabConfig.authorizerCredential.oauthTokenSecretVersionName
        • resource.gitlabConfig.serviceDirectoryConfig.service
        • resource.gitlabConfig.sslCa
        • resource.gitlabConfig.serviceDirectoryConfig.service
        • resource.bitbucketDataCenterConfig.hostUri
        • resource.bitbucketDataCenterConfig.webhookSecretSecretVersion
        • resource.bitbucketDataCenterConfig.readAuthorizerCredential.oauthTokenSecretVersionName
        • resource.bitbucketDataCenterConfig.authorizerCredential.oauthTokenSecretVersionName
        • resource.bitbucketDataCenterConfig.sslCa
        • resource.bitbucketDataCenterConfig.serviceDirectoryConfig.service
        • resource.bitbucketCloudConfig.workspace
        • resource.bitbucketCloudConfig.webhookSecretSecretVersion
        • resource.bitbucketCloudConfig.readAuthorizerCredential.oauthTokenSecretVersionName
        • resource.bitbucketCloudConfig.authorizerCredential.oauthTokenSecretVersionName
      • Configuración del repositorio de Cloud Build
        • resource.name
        • resource.remoteUri
        • resource.annotations

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

      En la siguiente tabla se muestra la sintaxis de algunas políticas de organización personalizadas que pueden resultarte útiles:

      Descripción Sintaxis de las restricciones
      Solo permitir la creación de activadores de Pub/Sub que escuchen temas que contengan "cloud-builds" 
          name: organizations/ORGANIZATION_ID/customConstraints/custom.enableCloudBuildPubsubTrigger
    resourceTypes:
    - cloudbuild.googleapis.com/BuildTrigger
    methodTypes:
    - CREATE
    condition: "resource.pubsubConfig != null && resource.pubsubConfig.topic.contains('cloud-builds')"
    actionType: ALLOW
    displayName: Enable creating Pub/Sub trigger that listens on topics that contain "cloud-builds".
    description: Only allow creating Pub/Sub trigger that listens on topics that contain "cloud-builds".
      • ORGANIZATION_ID: el ID de tu organización, como 123456789.

      Siguientes pasos