En este documento, se describe cómo configurar tus compilaciones para que usen una cuenta de servicio administrada por el usuario.
Si no especificas una cuenta de servicio administrada por el usuario para tus compilaciones, Cloud Build usa automáticamente la cuenta de servicio predeterminada de Cloud Build. Es posible que esta cuenta de servicio predeterminada tenga permisos innecesariamente amplios, como el acceso a tus repositorios de Cloud Source Repositories y a cualquier bucket de Cloud Storage de tu proyecto.
Te recomendamos que sigas el principio de privilegio mínimo asignando permisos y roles a las cuentas de servicio con el alcance de la tarea que realizan. Por ejemplo, puedes usar una cuenta de servicio para compilar y enviar imágenes a Artifact Registry, como se muestra en el blog deCloud de Confiance by S3NS .
Antes de comenzar
-
Habilita las APIs de Cloud Build y de IAM, si aún no están habilitadas.
Roles necesarios para habilitar las APIs
Para habilitar las APIs, necesitas el permiso
serviceusage.services.enable. Si creaste el proyecto, es probable que ya tengas este permiso a través del rol de propietario (roles/owner). De lo contrario, puedes obtenerlo a través del rol de administrador de Service Usage (roles/serviceusage.serviceUsageAdmin). Obtén más información para otorgar roles. Si planeas usar esta cuenta para crear y administrar credenciales, por ejemplo, para crear credenciales de corta duración, habilita la API de Service Account Credentials de IAM.
Roles necesarios para habilitar las APIs
Para habilitar las APIs, necesitas el permiso
serviceusage.services.enable. Si creaste el proyecto, es probable que ya tengas este permiso a través del rol de propietario (roles/owner). De lo contrario, puedes obtenerlo a través del rol de administrador de Service Usage (roles/serviceusage.serviceUsageAdmin). Obtén más información para otorgar roles.Crea una cuenta de servicio, si aún no lo hiciste.
Configura la cuenta de servicio
Otorga roles de IAM a tu cuenta de servicio administrada por el usuario para que tenga los permisos que necesita para ejecutar tus compilaciones. También puedes configurar Cloud Build para que elija automáticamente esta cuenta de servicio para los activadores nuevos.
-
En la consola de Cloud de Confiance , ve a la página Permisos de Cloud Build desettings:
Ve al menú Cuenta de servicio y selecciona tu cuenta de servicio. Para elegir una cuenta de servicio en otro proyecto, haz clic en Cambiar de proyecto.
Para usar la cuenta de servicio seleccionada como la cuenta de servicio de los activadores nuevos, activa Establecer como preseleccionado para los activadores nuevos.
En la lista de servicios de Cloud de Confiance , habilita los roles de IAM que quieras otorgar a tu cuenta de servicio.
Si el rol que necesitas para tu canalización de compilación no aparece aquí, puedes otorgar roles adicionales en la página de configuración de IAM.
Si seleccionaste una cuenta de servicio en un proyecto diferente, completa los pasos que se indican en Configuración entre proyectos.
Para obtener más información sobre los roles de IAM que se suelen requerir para una compilación, consulta la siguiente información:
- Cuenta de servicio predeterminada de Cloud Build.
- Configura el acceso a los recursos de Cloud Build.
- Roles y permisos de IAM de Cloud Build.
Configura los registros de compilación
Cuando especificas tu propia cuenta de servicio para las compilaciones, debes almacenar los registros de compilación en uno de los siguientes tipos de bucket:
Buckets de Cloud Storage en el proyecto del usuario Estos pueden ser buckets creados por el usuario o buckets creados porCloud de Confiancey que pertenecen al usuario.
Si creas un bucket de registros, asegúrate de que no tenga una política de retención, ya que esta puede impedir que Cloud Build escriba registros de compilación en el bucket.
No puedes almacenar tus registros en un bucket de registros que pertenezca a Cloud de Confiance.
Para obtener más información sobre dónde almacenar los registros de compilación, consulta Opciones de almacenamiento de registros de compilación.
Ejecuta una compilación con un archivo de configuración
Para ejecutar una compilación de forma manual con un archivo de configuración, haz lo siguiente:
En el directorio raíz del proyecto, crea un archivo de configuración de compilación de Cloud Build llamado
cloudbuild.yamlocloudbuild.json.Agrega el campo
serviceAccounty la configuración de registro preferida.Si almacenas los registros de compilación en Cloud Logging, agrega un campo
loggingy establece el valor del campo enCLOUD_LOGGING_ONLY.Si almacenas los registros de compilación en un bucket de Cloud Storage creado por el usuario, haz lo siguiente:
- Agrega un campo
loggingy establece su valor enGCS_ONLY. - Agrega un campo
logsBuckety establece su valor en la ubicación de tu bucket de Cloud Storage.
- Agrega un campo
En el siguiente ejemplo, se configura Cloud Build para que ejecute compilaciones con una cuenta de servicio administrada por el usuario y se configuran los registros de compilación para que se almacenen en un bucket de Cloud Storage creado por el usuario:
YAML
steps: - name: 'bash' args: ['echo', 'Hello world!'] logsBucket: 'LOGS_BUCKET_LOCATION' serviceAccount: 'projects/PROJECT_ID/serviceAccounts/SERVICE_ACCOUNT' options: logging: GCS_ONLYJSON
{ "steps": [ { "name": "bash", "args": [ "echo", "Hello world!" ] } ], "logsBucket": "LOGS_BUCKET_LOCATION", "serviceAccount": "projects/PROJECT_ID/serviceAccounts/SERVICE_ACCOUNT", "options": { "logging": "GCS_ONLY" } }Reemplaza las variables en tu archivo de configuración de compilación por lo siguiente:
LOGS_BUCKET_LOCATIONes el bucket de Cloud Storage para almacenar registros de compilación. Por ejemplo,gs://mylogsbucketPROJECT_IDes el ID del proyecto de Cloud de Confiance en el que ejecutas la compilación.SERVICE_ACCOUNTes la dirección de correo electrónico o el ID único de la cuenta de servicio que deseas especificar para las compilaciones. Por ejemplo, la dirección de correo electrónico de una cuenta de servicio se ve de la siguiente manera:service-account-name@project-id.s3ns.iam.gserviceaccount.com.
Usa este comando para comenzar a compilar con el archivo de configuración de compilación:
gcloud builds submit --config CONFIG_FILE_PATH SOURCE_DIRECTORYReemplaza las variables en los comandos por los siguientes valores:
CONFIG_FILE_PATHes la ruta de acceso al archivo de configuración de compilación.SOURCE_DIRECTORYes la ruta o la URL del código fuente.
Si no se especifica CONFIG_FILE_PATH ni SOURCE_DIRECTORY en el comando
gcloud builds submit, Cloud Build da por hecho que el archivo de configuración de compilación y el código fuente están en el directorio de trabajo actual.
Ejecuta compilaciones con activadores
Para ejecutar una compilación con activadores de Cloud Build con tu propia cuenta de servicio, configura la opción de registro que prefieras y selecciona la cuenta de servicio que prefieras cuando crees el activador.
Si deseas usar la misma cuenta de servicio para todos los activadores nuevos, puedes configurar Cloud Build para que seleccione automáticamente la cuenta de servicio.
En el archivo de configuración de compilación:
Si almacenas los registros de compilación en Cloud Logging, agrega un campo
loggingy establece el valor del campo enCLOUD_LOGGING_ONLY.Si almacenas los registros de compilación en un bucket de Cloud Storage creado por el usuario, haz lo siguiente:
- Agrega un campo
loggingy establece su valor enGCS_ONLY. - Agrega un campo
logsBuckety establece su valor en la ubicación de tu bucket de Cloud Storage.
- Agrega un campo
En el siguiente ejemplo, se configuran los registros de compilación para que se almacenen en un bucket de Cloud Storage creado por el usuario:
YAML
steps: - name: 'bash' args: ['echo', 'Hello world!'] logsBucket: 'LOGS_BUCKET_LOCATION' options: logging: GCS_ONLYJSON
{ "steps": [ { "name": "bash", "args": [ "echo", "Hello world!" ] } ], "logsBucket": "LOGS_BUCKET_LOCATION", "options": { "logging": "GCS_ONLY" } }Reemplaza
LOGS_BUCKET_LOCATIONpor el bucket de Cloud Storage en el que se almacenarán los registros de compilación. Por ejemplo,gs://mylogsbucket.Especifica una cuenta de servicio para usar con el activador de compilación:
Console
En el campo Cuenta de servicio, especifica tu cuenta de servicio. Para elegir una cuenta de servicio en otro proyecto, haz clic en Cambiar de proyecto.
Si no especificas una cuenta de servicio, Cloud Build usa la cuenta de servicio predeterminada.
Haz clic en Crear para guardar el activador de compilación.
gcloud
Cuando crees un activador de compilación, especifica tu cuenta de servicio con la marca
--service-account. En el siguiente ejemplo, el comandogcloudcrea un activador de compilación que extrae código de un repositorio de Git:gcloud builds triggers create github \ --name=TRIGGER_NAME \ --repo-name=REPO_NAME \ --repo-owner=REPO_OWNER \ --branch-pattern=BRANCH_PATTERN --build-config=BUILD_CONFIG_FILE --service-account=SERVICE_ACCOUNT --project=BUILD_PROJECTReemplaza las variables en el archivo de configuración de compilación por los siguientes valores:
TRIGGER_NAMEes el nombre de tu activador de compilación.REPO_NAMEes el nombre del repositorio.REPO_OWNERes el nombre de usuario del propietario del repositorio.BRANCH_PATTERNes el nombre de la rama en tu repositorio para invocar la compilación.TAG_PATTERNes el nombre de la etiqueta en tu repositorio para invocar la compilación.BUILD_CONFIG_FILEes la ruta de acceso al archivo de configuración de compilación.SERVICE_ACCOUNTes tu cuenta de servicio en el formato/projects/PROJECT_ID/serviceAccounts/ACCOUNT_ID_OR_EMAIL.BUILD_PROJECTes el proyecto en el que inicias las compilaciones.
Configuración entre proyectos
Puedes usar una cuenta de servicio administrada por el usuario para ejecutar compilaciones en un proyecto
diferente del proyecto en el que creaste la cuenta de servicio solo si no se aplica
la restricción de la política de la organización
iam.disableCrossProjectServiceAccountUsage. Esta restricción se aplica de forma predeterminada.
Obtén más información.
Con el siguiente comando, se inhabilita la aplicación de esa restricción y se otorga el acceso necesario. Tu organización debe conocer las compensaciones de seguridad que implica antes de establecer la restricción en la política de la organización:
gcloud resource-manager org-policies disable-enforce \ iam.disableCrossProjectServiceAccountUsage \ --project=SERVICE_ACCOUNT_PROJECT_IDEn este comando, SERVICE_ACCOUNT_PROJECT_ID es el proyecto que contiene tu cuenta de servicio administrada por el usuario.
En el proyecto que tiene tu cuenta de servicio administrada por el usuario, otorga el rol
roles/iam.serviceAccountTokenCreatoral agente de servicio de Cloud Build del proyecto en el que ejecutas las compilaciones:gcloud projects add-iam-policy-binding SERVICE_ACCOUNT_PROJECT_ID \ --member="serviceAccount:BUILD_SERVICE_AGENT" \ --role="roles/iam.serviceAccountTokenCreator"Reemplaza las variables en el comando por lo siguiente:
SERVICE_ACCOUNT_PROJECT_ID: Es el ID del proyecto que contiene tu cuenta de servicio administrada por el usuario.BUILD_SERVICE_AGENT: Es el ID de correo electrónico del agente de servicio con el formatoservice-BUILD_PROJECT_NUMBER@gcp-sa-cloudbuild.s3ns-system.iam.gserviceaccount.com, en el queBUILD_PROJECT_NUMBERes el número del proyecto en el que ejecutas las compilaciones. Puedes obtener el número de proyecto en la página de configuración del proyecto.
Limitaciones:
Tu proyecto de Cloud de Confiance debe estar en una organización de Cloud de Confiance by S3NS .
Debes iniciar las compilaciones en la línea de comandos con
gcloud builds submitogcloud builds triggers create.Si recibes un error
service account not foundcuando otorgas el rol de IAM, es posible que debas crear el agente de servicio de forma manual.
¿Qué sigue?
- Obtén más información sobre los roles y permisos de IAM de Cloud Build.
- Obtén información sobre cómo los cambios en la cuenta de servicio afectan la forma en que ejecutas tus compilaciones.