createProcess

Back to index

Summary

Creates a new process for an application or component.

projectName

Stringrequired

The name for the project that must be unique among all projects.

processName

Stringrequired

The name of the process.

applicationName

Stringoptional

The name of the application, if the process is owned by an application.

componentApplicationName

Stringoptional

If specified, the component is scoped to this application not the project.

componentName

Stringoptional

The name of the component, if the process is owned by a component.

credentialName

Stringoptional

The name of a credential to attach to this process.

description

Stringoptional

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

exclusiveEnvironment

Booleanoptional

True if environment is exclusive to the application or service process.

microserviceApplicationName

Stringoptional

If specified, the microservice is scoped to an application.

microserviceName

Stringoptional

The name of the microservice, if the process is owned by a microservice.

processType

Stringoptional

Defines type of action performed by the process.

Possible values: "DEPLOY", "OTHER", "UNDEPLOY"

smartUndeployEnabled

Booleanoptional

True if smart deploy should be enabled for the undeploy component process.

timeLimit

Stringoptional

Maximum amount of time the step can execute; abort if it exceeds this time.

timeLimitUnits

Stringoptional

Units for step time limit: seconds, minutes, or hours.

Possible values: "hours", "minutes", "seconds"

workingDirectory

Stringoptional

Working directory in which to execute the command for this process. A relative name is interpreted relative to the root directory for the job's workspace.

workspaceName

Stringoptional

The name of the default workspace for this process.

Usage

Perl

$cmdr->createProcess(
  "test-projectName", # projectName
  "test-processName" # processName
  # optionals
);▼

ectool

ectool createProcess \
  "test-projectName" `# projectName` \
  "test-processName" `# processName` \
  # optionals▼

Examples

Perl

To create a component process in a master component:

$cmdr->createProcess('Default', 'Deploy',  {componentName => 'WAR file'});▼

To create a component process in a specific application:

$cmdr->createProcess('Default', 'Deploy',  {componentName => 'WAR file', componentApplicationName => 'Shopping Cart'});▼

To create an application process:

$cmdr->createProcess('Default', 'Deploy',  {applicationName => 'Shopping Cart'});▼

To create a microservice process:

$cmdr->createProcess('Default', 'Deploy',  {microserviceName => 'myapp-ms', microserviceApplicationName => 'myapp'});▼

ectool

To create a component process in a master component:

ectool createProcess 'Default' 'Deploy'  --componentName 'WAR file'▼

To create a component process in a specific application:

ectool createProcess 'Default' 'Deploy' --componentName 'WAR file' --componentApplicationName 'Shopping Cart'▼

To create an application process:

ectool createProcess  'Default' 'Deploy'  --applicationName 'Shopping Cart'▼

To create a microservice process:

ectool createProcess  'Default' 'Deploy'  --microserviceName 'myapp-ms' --microserviceApplicationName 'myapp'▼