runProcess

Back to index

Summary

Runs the specified process. For microservice applications, it is used to deploy a microservice to a Kubernetes cluster.
projectName
Stringrequired
The name for the project that must be unique among all projects.
applicationName
Stringrequired
The name of the application that owns the process.
processName
Stringrequired
The name of the application process.
actualParameter
Arrayoptional
Parameters passed as arguments to the process.
credentialReferenceParameter
Arrayoptional
List of credential parameters with references to existing credentials as parameter values. If the parameter value is a property reference then the credential would be resolved at runtime.
credential
Arrayoptional
Credentials to be used in the job.
destinationProject
Stringoptional
The project that will own the job.
enforceDependencies
Booleanoptional
If application dependencies are defined for the specified application, enforce them for successful deployment.
environmentName
Stringoptional
Environment name to create from template.
environmentProjectName
Stringoptional
The name of the project to which the environment or environment template belongs to.
environmentTemplateName
Stringoptional
Environment template name.
environmentTemplateProjectName
Stringoptional
The name of the project to which the environment template belongs to.
environmentTemplateTierMapName
Stringoptional
Environment template tier map name.
keepOnError
Booleanoptional
True to keep environment on error (default is false).
parsedWebhookData
Stringoptional
JSON with parsed webhook data to be set on a pipeline/release/procedure run.
priority
Stringoptional
The priority of the job.
Possible values: "low", "normal", "high", "highest"
rollingDeployEnabled
Booleanoptional
Perform rolling deployment.
rollingDeployManualStepAssignee
Arrayoptional
A list of assignees who receive the notification when rolling deploy iteration completes.
rollingDeployManualStepCondition
Stringoptional
Defines run condition on manual step created during rolling deployment.
Possible values: "always", "failure", "success"
rollingDeployPhase
Arrayoptional
One or more rolling deploy phases to be used for deployment.
rolloutApprover
Arrayoptional
A list of rollout approvers.
rolloutNotificationEnabled
Booleanoptional
Rollout notification enabled (default is false).
scheduleName
Stringoptional
Name for the schedule; must be unique among all schedules for the project.
smartDeploy
Booleanoptional
Smart deploy -- if provided actual param will be overridden.
snapshotName
Stringoptional
Name for the snapshot.
stageArtifacts
Booleanoptional
Stage all artifacts being deployed as part of the application process.
tierMapName
Stringoptional
The name of the tier map used to determine where to run the process.
tierResourceCount
Arrayoptional
Resource count per resource template tier.
validate
Booleanoptional
Validate the process and environment.
webhookData
Stringoptional
The webhook data to be set on the pipeline/release/procedure run.
webhookHeaders
Stringoptional
The webhook headers in JSON format to be set on the pipeline/release/procedure run.

Usage

Perl

$cmdr->runProcess( "test-projectName", # projectName "test-applicationName", # applicationName "test-processName" # processName # optionals );

ectool

ectool runProcess \ "test-projectName" `# projectName` \ "test-applicationName" `# applicationName` \ "test-processName" `# processName` \ # optionals

Examples

Perl

$cmdr->runProcess('Default', 'Deploy', 'Check out', {tierMapName => 'QA test'});

ectool

ectool runProcess 'Default' 'Deploy' 'Check out' --tierMapName 'QA test'