A deploy rule defines how the collective controller deploys and operates a collective member. There are built in rules for Liberty members, Node.js members, and Docker container members. The Docker deploy rule supports either a Liberty or Node.js member running inside the container. Choose the rule that matches the member type you want to deploy. The built in rules are sufficient for usual circumstances, but if necessary you can override elements of a rule or define a new rule.

Name Type Default Description

deploy

string
Required

The command to run at the target host to deploy a member

id

string

A unique configuration ID.

name

string
Required

The name of the deploy rule

restart

string

The command to run at the target host to restart a deployed member

start

string
Required

The command to run at the target host to start a deployed member

stop

string
Required

The command to run at the target host to stop a deployed member

type

string
Required

The type of member to be deployed: Liberty, Node.js, or docker

undeploy

string
Required

The command to run at the target host to undeploy a member

inputVarible

A unique configuration ID.

Name Type Default Description

defaultValue

string

The default value for the input variable

description

string
Required

The description of the input variable

displayName

string

The display name of the input variable

group

string

The group of the input variable

id

string

A unique configuration ID.

name

string
Required

The name of the input variable

type

string
Required

The type of the input variable. Valid types are String, password, filePath (a directory), file (a file name, for example, package.zip), cluster (name of a cluster), dockerImage (name of a docker image).

runtimeTpe

A unique configuration ID.

Name Type Default Description

displayName

string

The display name for the runtime

id

string

A unique configuration ID.