- Recurso: lanzamiento
- ApprovalState
- Estado
- FailureCause
- Fase
- Estado
- DeploymentJobs
- Trabajo
- Estado
- DeployJob
- VerifyJob
- PredeployJob
- PostdeployJob
- CreateChildRolloutJob
- AdvanceChildRolloutJob
- ChildRolloutJobs
- Metadatos
- AutomationRolloutMetadata
- Métodos
Recurso: Implementación
Un recurso Rollout
en la API de Cloud Deploy.
Un Rollout
contiene información sobre una implementación específica en un Target
.
Representación JSON |
---|
{ "name": string, "uid": string, "description": string, "annotations": { string: string, ... }, "labels": { string: string, ... }, "createTime": string, "approveTime": string, "enqueueTime": string, "deployStartTime": string, "deployEndTime": string, "targetId": string, "approvalState": enum ( |
Campos | |
---|---|
name |
Opcional. Es el nombre del |
uid |
Solo salida. Es el identificador único de |
description |
Descripción de |
annotations |
Anotaciones de usuario Solo el usuario puede configurar y usar estos atributos, no Cloud Deploy. Consulta https://google.aip.dev/128#annotations para obtener más detalles, como las limitaciones de formato y tamaño. Un objeto que contiene una lista de pares |
labels |
Las etiquetas son atributos que el usuario y Cloud Deploy pueden configurar y usar. Las etiquetas deben cumplir con las siguientes restricciones:
Las claves y los valores tienen restricciones adicionales para ser <= 128 bytes. Un objeto que contiene una lista de pares |
createTime |
Solo salida. Hora a la que se creó el objeto Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: |
approveTime |
Solo salida. Hora a la que se aprobó el Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: |
enqueueTime |
Solo salida. Hora a la que se puso en cola el Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: |
deployStartTime |
Solo salida. Hora a la que Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: |
deployEndTime |
Solo salida. Hora en la que Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: |
targetId |
Obligatorio. El ID del destino en el que se implementa este |
approvalState |
Solo salida. Estado de aprobación de |
state |
Solo salida. Estado actual de |
failureReason |
Solo salida. Información adicional sobre el error de lanzamiento, si está disponible. |
deployingBuild |
Solo salida. El nombre del recurso del objeto |
etag |
El servidor calcula esta suma de comprobación en función del valor de otros campos, y es posible que se envíe en solicitudes de actualización y eliminación para garantizar que el cliente tenga un valor actualizado antes de continuar. |
deployFailureCause |
Solo salida. El motivo por el que falló este lanzamiento. Siempre no se especificará mientras el lanzamiento esté en curso. |
phases[] |
Solo salida. Las fases que representan los flujos de trabajo de este |
metadata |
Solo salida. Los metadatos contienen información sobre el lanzamiento. |
controllerRollout |
Solo salida. Es el nombre del |
rollbackOfRollout |
Solo salida. Nombre de la |
rolledBackByRollouts[] |
Solo salida. Nombres de |
ApprovalState
Estados de aprobación válidos de un Rollout
.
Enums | |
---|---|
APPROVAL_STATE_UNSPECIFIED |
Rollout tiene un estado de aprobación no especificado. |
NEEDS_APPROVAL |
El Rollout requiere aprobación. |
DOES_NOT_NEED_APPROVAL |
El Rollout no requiere aprobación. |
APPROVED |
Se aprobó Rollout . |
REJECTED |
Se rechazó Rollout . |
Estado
Estados válidos de un Rollout
Enums | |
---|---|
STATE_UNSPECIFIED |
Rollout tiene un estado no especificado. |
SUCCEEDED |
Rollout se completó correctamente. |
FAILED |
Se produjo un error con Rollout . |
IN_PROGRESS |
Se está implementando Rollout . |
PENDING_APPROVAL |
El Rollout necesita aprobación. |
APPROVAL_REJECTED |
Un responsable de aprobación rechazó el Rollout . |
PENDING |
Rollout está esperando a que se complete un lanzamiento anterior en este Target . |
PENDING_RELEASE |
Rollout está esperando a que se renderice Release por completo. |
CANCELLING |
Se está cancelando el Rollout . |
CANCELLED |
Se canceló Rollout . |
HALTED |
Se detuvo Rollout . |
FailureCause
Errores de lanzamiento conocidos.
Enums | |
---|---|
FAILURE_CAUSE_UNSPECIFIED |
No se especificó ningún motivo para la falla. |
CLOUD_BUILD_UNAVAILABLE |
Cloud Build no está disponible, ya sea porque no está habilitado o porque Cloud Deploy no tiene permisos suficientes. Consulta los permisos necesarios. |
EXECUTION_FAILED |
La operación de implementación no se completó correctamente; revisa los registros de Cloud Build. |
DEADLINE_EXCEEDED |
Deployment no se completó en el tiempo asignado. |
RELEASE_FAILED |
La versión tiene un estado de error. |
RELEASE_ABANDONED |
Se abandona la versión. |
VERIFICATION_CONFIG_NOT_FOUND |
No se encontró ninguna configuración de verificación de Skaffold. |
CLOUD_BUILD_REQUEST_FAILED |
Cloud Build no pudo entregar la solicitud de Cloud Deploy. Consulta failedMessage para obtener más detalles. |
OPERATION_FEATURE_NOT_SUPPORTED |
Una operación de lanzamiento tuvo una función configurada que no se admite. |
Fase
La fase representa una colección de trabajos que se agrupan lógicamente para una Rollout
.
Representación JSON |
---|
{ "id": string, "state": enum ( |
Campos | |
---|---|
id |
Solo salida. El ID de la fase. |
state |
Solo salida. Estado actual de la Fase. |
skipMessage |
Solo salida. Información adicional sobre por qué se omitió la fase, si está disponible. |
Campo de unión jobs . La composición del trabajo de esta fase. jobs puede ser solo uno de los siguientes: |
|
deploymentJobs |
Solo salida. Composición del trabajo de Deployment. |
childRolloutJobs |
Solo salida. Composición del trabajo de ChildRollout. |
Estado
Estados válidos de una fase.
Enums | |
---|---|
STATE_UNSPECIFIED |
La Fase tiene un estado no especificado. |
PENDING |
La fase está esperando que se completen otras anteriores. |
IN_PROGRESS |
La fase está en curso. |
SUCCEEDED |
La Fase se completó correctamente. |
FAILED |
La fase falló. |
ABORTED |
Se anuló la Fase. |
SKIPPED |
Se omitió la fase. |
DeploymentJobs
Composición del trabajo de Deployment.
Representación JSON |
---|
{ "deployJob": { object ( |
Campos | |
---|---|
deployJob |
Solo salida. El trabajo de implementación Este es el trabajo de implementación en la fase. |
verifyJob |
Solo salida. El trabajo de verificación Se ejecuta después de una implementación si esta se realiza correctamente. |
predeployJob |
Solo salida. El trabajo previo a la implementación, que es el primer trabajo en la fase. |
postdeployJob |
Solo salida. El trabajo posterior a la implementación, que es el último trabajo de la fase. |
Trabajo
El trabajo representa una operación para un objeto Rollout
.
Representación JSON |
---|
{ "id": string, "state": enum ( |
Campos | |
---|---|
id |
Solo salida. El ID del trabajo. |
state |
Solo salida. El estado actual del objeto Job. |
skipMessage |
Solo salida. Información adicional sobre el motivo por el que se omitió el trabajo, si está disponible. |
jobRun |
Solo salida. El nombre del |
Campo de unión job_type . El tipo de trabajo. job_type puede ser solo uno de los siguientes: |
|
deployJob |
Solo salida. Un trabajo de implementación |
verifyJob |
Solo salida. Un trabajo de verificación |
predeployJob |
Solo salida. Un trabajo previo a la implementación |
postdeployJob |
Solo salida. Un trabajo posterior a la implementación |
createChildRolloutJob |
Solo salida. Un trabajo createChildRollout |
advanceChildRolloutJob |
Solo salida. Un trabajo AdvancedChildRollout. |
Estado
Estados válidos de un objeto Job.
Enums | |
---|---|
STATE_UNSPECIFIED |
El trabajo tiene un estado sin especificar. |
PENDING |
El trabajo está esperando que se completen las fases o los trabajos anteriores. |
DISABLED |
El trabajo está inhabilitado. |
IN_PROGRESS |
El trabajo está en curso. |
SUCCEEDED |
El trabajo se ejecutó de forma correcta. |
FAILED |
El trabajo falló. |
ABORTED |
Se anuló el trabajo. |
SKIPPED |
Se omitió el trabajo. |
IGNORED |
Se ignoró el trabajo. |
DeployJob
Este tipo no tiene campos.
Un trabajo de implementación
VerifyJob
Este tipo no tiene campos.
Un trabajo de verificación
PredeployJob
Un trabajo previo a la implementación
Representación JSON |
---|
{ "actions": [ string ] } |
Campos | |
---|---|
actions[] |
Solo salida. Las acciones personalizadas que ejecuta el trabajo previo a la implementación. |
PostdeployJob
Un trabajo posterior a la implementación
Representación JSON |
---|
{ "actions": [ string ] } |
Campos | |
---|---|
actions[] |
Solo salida. Las acciones personalizadas que ejecuta el trabajo posterior a la implementación. |
CreateChildRolloutJob
Este tipo no tiene campos.
Un trabajo createChildRollout
AdvanceChildRolloutJob
Este tipo no tiene campos.
Un trabajo AdvancedChildRollout.
ChildRolloutJobs
Composición del trabajo de ChildRollouts
Representación JSON |
---|
{ "createRolloutJobs": [ { object ( |
Campos | |
---|---|
createRolloutJobs[] |
Solo salida. Lista de CreateChildRolloutJobs |
advanceRolloutJobs[] |
Solo salida. Lista de AdvanceChildRolloutJobs |
Metadatos
Los metadatos incluyen información asociada con un Rollout
.
Representación JSON |
---|
{ "cloudRun": { object ( |
Campos | |
---|---|
cloudRun |
Solo salida. Es el nombre del servicio de Cloud Run asociado con un |
automation |
Solo salida. AutomationRolloutMetadata contiene la información sobre las interacciones entre el servicio de automatización y este lanzamiento. |
custom |
Solo salida. Metadatos personalizados proporcionados por operaciones |
AutomationRolloutMetadata
AutomationRolloutMetadata contiene acciones relacionadas con la automatización que se realizaron en un lanzamiento.
Representación JSON |
---|
{ "promoteAutomationRun": string, "advanceAutomationRuns": [ string ], "repairAutomationRuns": [ string ], "currentRepairAutomationRun": string } |
Campos | |
---|---|
promoteAutomationRun |
Solo salida. El ID de AutomationRun que inició una regla de lanzamiento de promoción. |
advanceAutomationRuns[] |
Solo salida. Los IDs de AutomationRuns iniciados por una regla de lanzamiento avanzado. |
repairAutomationRuns[] |
Solo salida. Los IDs de AutomationRuns que inició una regla de lanzamiento de reparación. |
currentRepairAutomationRun |
Solo salida. El AutomationRun actual que repara el lanzamiento. |
Métodos |
|
---|---|
|
Avanzar un lanzamiento en un proyecto y una ubicación determinados. |
|
Aprueba un lanzamiento. |
|
Cancela un lanzamiento en una ubicación y un proyecto determinados. |
|
Crea un lanzamiento nuevo en un proyecto y una ubicación determinados. |
|
Obtiene los detalles de un solo lanzamiento. |
|
Ignora el trabajo especificado en un lanzamiento. |
|
Muestra una lista de los lanzamientos en un proyecto y una ubicación determinados. |
|
Vuelve a intentar el trabajo especificado en un lanzamiento. |