DeliveryProgram
The shell of a Delivery program.
Properties
orgstring requiredThe organization name.projectstring requiredThe project name.stackstring requiredThe stack name.kindenum requiredThe kind of the program:pipeline.Values:pipelineregisteredboolean requiredWhether the program has an active registration. A stack with only a failed registration has none.registeringboolean requiredWhether the first registration is still finishing. The program is not registered yet, andregistrationis the pending registration.- The active registration, or the pending one while
registeringis true. - ↳
idstring optionalThe ID of the registration. A new active registration has a new ID, so a changed ID means that the pipeline definition can have changed. - ↳
registeredboolean requiredWhether a registration is active. - ↳
statusenum optionalThe status of the registration.Values:pending,succeeded,failed,local - ↳
reasonstring optionalWhy a registration failed. - ↳
programCommitstring optionalThe commit of the registered program. - ↳
actorstring optionalWho registered the program. - ↳
actorKindenum optionalThe kind of the actor.Values:user,webhook,system,trigger - ↳
createdAtstring optionalWhen the registration was made. - ↳
warningsarray[string] optionalThe warnings of the registration. - The latest failed registration, if it is newer than the active one.
- ↳
idstring optionalThe ID of the registration. A new active registration has a new ID, so a changed ID means that the pipeline definition can have changed. - ↳
registeredboolean requiredWhether a registration is active. - ↳
statusenum optionalThe status of the registration.Values:pending,succeeded,failed,local - ↳
reasonstring optionalWhy a registration failed. - ↳
programCommitstring optionalThe commit of the registered program. - ↳
actorstring optionalWho registered the program. - ↳
actorKindenum optionalThe kind of the actor.Values:user,webhook,system,trigger - ↳
createdAtstring optionalWhen the registration was made. - ↳
warningsarray[string] optionalThe warnings of the registration. - The newest attempt to register the pipeline, whether it is queued, running, failed or done.
- ↳
idstring requiredThe ID of the entry: the ID of the update, or the ID of the queued registration when it has no update. - ↳
sourceenum requiredWho started the attempt.Values:user,push - ↳
commitstring optionalThe commit of the attempt, if known. - ↳
dirtyboolean optionalWhether the checkout of a user registration had uncommitted changes, or did not say. Not set for a push or while the update runs. - ↳
branchstring optionalThe tracked branch, if known. Only a registration that a push queued records it. - Where the commit of a push lives: the kind and repository of the source that the queued registration recorded, and the branch. Not set for a registration by a person.
- ↳
stateenum requiredThe state of the attempt.Values:queued,running,succeeded,failed,canceled - ↳
messagestring optionalWhy the attempt failed, if it did. - ↳
activeboolean requiredWhether this is the active registration of the pipeline. - ↳
updateVersioninteger optionalThe version of the update of the pipeline stack, if the attempt has an update. - ↳
workItemIdstring optionalThe ID of the registration that the push queued. Set for a push. - ↳
requestedBystring optionalThe login of the user who ran the update, for a user registration. - ↳
createdstring requiredWhen the attempt was created. - ↳
finishedstring optionalWhen the attempt finished. Not set while it is in progress. - The stages in the order of the stage graph.
- ↳
pausedboolean requiredWhether the stage is paused. - ↳
pausedBystring optionalWho paused the stage. - ↳
pausedAtstring optionalWhen the stage was paused. - ↳
deployedReleaseNumberinteger optionalThe release deployed at the stage. - ↳
deployedRunNumberinteger optionalThe run that deployed it. - ↳
lockRunNumberinteger optionalThe run that holds the lock of the stage. - ↳
queueLengthinteger requiredThe number of runs that wait for the stage. List them with the runs route, itsstagefilter andqueuedset to true. - The run that deployed the current release of the stage.
- The last cloud release that converged the stage. Downstream pipelines read this one. It differs from
deployedwhile a local release is deployed. - The run that holds the lock of the stage, with the status of the stage in it. A normal run and an operator run can hold it.
- The newest open gate of the stage over all runs in progress.
- The members of the stage in the active registration, at most 1000.
- ↳
fromarray[string] optionalThe names of the stages that must converge first. - ↳
namestring requiredThe name of the stage. - ↳
whenarray[string] optionalThe kinds and names of the conditions of the stage. - The newest runs in progress, at most 20.
- ↳
numberinteger requiredThe number of the run. - ↳
kindenum requiredThe kind of the run.Values:normal— Normal- A run that a trigger started.
rollback— Rollback- A run that an operator started to return a stage to an earlier release.
redeploy— Redeploy- A run that an operator started to deploy a stage again.
force_promote— ForcePromote- A run that an operator started to promote a release past its gates.
- The structured status of the run.
- ↳
triggerKindenum requiredWhat started the run.Values:registration— Registration- A registration of the program.
push— Push- A push of a source.
dispatch— Dispatch- A dispatch by a user.
operator— Operator- An operator action on a stage.
stage_converged— StageConverged- A stage of another pipeline that converged.
local— Local- A local
pulumi upof the pipeline stack.
- ↳
actorKindenum requiredWho started the run:user,webhook,triggerorsystem.Values:user,webhook,system,trigger - ↳
actorstring optionalThe login of the user who started the run, if a user did. - ↳
targetStagestring optionalThe stage that an operator run deploys. - ↳
releaseNumberinteger optionalThe number of the release of the run. - The commit of the program that the run executes.
- ↳
programRefstring optionalThe ref (branch, tag or commit SHA) that a person started the run at. Absent for a run at the head of the program branch. - ↳
originRunNumberinteger optionalThe number of the run that an operator run repeats. - One entry for each stage of the run, in the order of the stages.
- ↳
createdAtstring requiredWhen the run was created. - ↳
finishedAtstring optionalWhen the run ended. - ↳
localboolean optionalWhether the run is a local run, started withpulumi up. Set only when it is. runsInProgressCountinteger requiredThe number of runs in progress.- Summary facts about the pipeline.
- The latest run that ended.
- The newest release.
- ↳
approvalCountinteger requiredThe number of approvals that wait now. - ↳
newestApprovalRunNumberinteger optionalThe run of the newest waiting approval. - ↳
newestApprovalGateIdstring optionalThe gate of the newest waiting approval. - ↳
newestApprovalConditionIdstring optionalThe condition of the newest waiting approval. - Whether the caller can dispatch a run.
- ↳
allowedboolean requiredWhether the caller can do the action now. - ↳
reasonstring optionalWhy the caller cannot do the action. Not set when it is allowed.