createService
Creates a new microservice for a project or application.
You must specify the projectName
and serviceName
.
Arguments | Descriptions |
---|---|
projectName | Name of the project. This name must be unique among all projects. Argument Type: String Argument Type: String |
serviceName | Name of the microservice. This name must be unique among all projects. Argument Type: String |
addDeployProcess | If set to Argument type: Boolean |
applicationName | The name of an application to scope this service to. Argument type: String |
defaultCapacity | The default service capacity. Argument type: String |
description | (Optional) Comment text describing this object that is not interpreted at all by CloudBees CD . Argument Type: String |
maxCapacity | The max service capacity. Argument type: String |
minCapacity | The min service capacity. Argument type: String |
volume | Volume JSON of the service. Argument type: String |
createServiceClusterMapping
Creates a new mapping between an application or project microservice and an environment cluster.
You must specify the projectName
.
Arguments | Descriptions |
---|---|
projectName | Name of the project. This name must be unique among all projects. Argument Type: String Argument Type: String |
actualParameters | (Optional) Actual parameters specific to plugin procedure associated with the application service. Argument type: Map |
applicationEntityRevisionId | (Optional) Revision ID of the versioned object. Argument type: UUID |
applicationName | (Optional) The name of the application which contains the service. Argument type: String |
applicationServiceMappingName | (Optional) The name of the application service mapping. Argument type: String |
clusterName | (Optional) The name of the environment cluster. Argument type: String |
clusterProjectName | (Optional) The name of the project which contains the cluster. Argument type: String |
defaultCapacity | (Optional) The default service capacity. Argument type: String |
environmentMapName | (Optional) The name of the environment map. If not provided, will use service name and environment name to resolve Argument type: String |
environmentName | (Optional) The name of the environment which contains the cluster. Argument type: String |
environmentProjectName | (Optional) The name of the environment which contains the cluster. Argument type: String |
maxCapacity | (Optional) The max service capacity. Argument type: String |
minCapacity | (Optional) The min service capacity. Argument type: String |
serviceClusterMappingName | (Optional) The name of the service cluster mapping. Argument type: String |
serviceEntityRevisionId | (Optional) Revision ID of the versioned object. Argument type: UUID |
serviceName | (Optional) The name of the independent microservice. Argument type: String |
tierMapName | (Optional) The name of the tier map. If not provided, will use application name and environment name to resolve Argument type: String |
volume | (Optional) Volume JSON of the service. Argument type: String |
createServiceDependency
Adds a microservice dependency to the specified microservice.
You must specify the projectName
and serviceName
.
Arguments | Descriptions |
---|---|
projectName | Name of the project. This name must be unique among all projects. Argument Type: String Argument Type: String |
serviceName | Name of the microservice. This name must be unique among all projects. Argument Type: String |
dependentApplicationName | (Optional) The name of application which this application depends on. Argument Type: String |
dependentProjectName | (Optional) The name the project containing the dependent application. Argument Type: String |
dependentServiceName | (Optional) The name of service which this application depends on. Argument Type: String |
dependentSnapshotName | (Optional) The name of snapshot of the dependent application. Argument Type: String |
effectiveDate | (Optional) The date when this dependency is applicable (for example, 2006-05-15). Argument Type: String |
serviceDependencyName | (Optional) The name of the service dependency. If not specified, a system generated GUID is used. Argument Type: String |
snapshotName | (Optional) Name of the snapshot; must be unique within the application. Argument Type: String |
deleteService
Deletes a microservice.
You must specify the projectName
and serviceName
.
Arguments | Descriptions |
---|---|
projectName | Name of the project. This name must be unique among all projects. Argument Type: String Argument Type: String |
serviceName | Name of the microservice. This name must be unique among all projects. Argument Type: String |
applicationName | Name of the application to which the application level service belongs to, null for a project-level service. Argument Type: String |
deleteServiceClusterMapping
Deletes a microservice cluster mapping.
You must specify the projectName
.
Arguments | Descriptions |
---|---|
projectName | Name of the project. This name must be unique among all projects. Argument Type: String Argument Type: String |
applicationEntityRevisionId | (Optional) Revision ID of the versioned object. Argument Type: UUID |
applicationName | (Optional) The name of the application which contains the service. Argument Type: String |
applicationServiceMappingName | (Optional) The name of the application service mapping. Argument Type: String |
clusterName | (Optional) The name of the environment cluster. Argument Type: String |
clusterProjectName | (Optional) The name of the project which contains the cluster. Argument Type: String |
environmentMapName | (Optional) The name of the environment map. If not provided, will use service name and environment name to resolve Argument Type: String |
environmentName | (Optional) The name of the environment which contains the cluster. Argument Type: String |
environmentProjectName | (Optional) The name of the environment which contains the cluster. Argument Type: String |
serviceClusterMappingName | (Optional) The name of the service cluster mapping. Argument Type: String |
serviceEntityRevisionId | (Optional) Revision ID of the versioned object. Argument Type: UUID |
serviceName | (Optional) The name of the independent service. Argument Type: String |
tierMapName | (Optional) The name of the tier map. If not provided, will use application name and environment name to resolve Argument Type: String |
deleteServiceDependency
Deletes a microservice dependency.
You must specify the projectName
and serviceName
.
Arguments | Descriptions |
---|---|
projectName | Name of the project. This name must be unique among all projects. Argument Type: String Argument Type: String |
serviceName | Name of the microservice. This name must be unique among all projects. Argument Type: String |
dependentApplicationName | (Optional) The name of application which this application depends on. Argument Type: String |
dependentProjectName | (Optional) The name the project containing the dependent application. Argument Type: String |
dependentServiceName | (Optional) The name of the service which this application depends on. Argument Type: String |
dependentSnapshotName | (Optional) The name of snapshot of the dependent application. Argument Type: String |
serviceDependencyName | (Optional) The name of service dependency. If not specified, a system generated GUID is used. Argument Type: String |
snapshotName | (Optional) Name of the snapshot; must be unique within the application. Argument Type: String |
deleteServiceMapDetail
Deletes a microservice detail map for the given container.
You must specify the projectName
and containerName
.
Arguments | Descriptions |
---|---|
projectName | Name of the project. This name must be unique among all projects. Argument Type: String Argument Type: String |
containerName | The name of the container. Argument Type: String |
applicationEntityRevisionId | (Optional) Revision ID of the versioned object. Argument Type: UUID |
applicationName | (Optional) The name of the application which contains the service. Argument Type: String |
applicationServiceMappingName | (Optional) The name of the application service mapping. Argument Type: String |
environmentMapName | (Optional) The name of the environment map. If not provided, will use service name and environment name to resolve Argument Type: String |
environmentName | (Optional) The name of the environment which contains the cluster. Argument Type: String |
environmentProjectName | (Optional) The name of the environment which contains the cluster. Argument Type: String |
serviceClusterMappingName | (Optional) The name of the application service mapping. Argument Type: String |
serviceEntityRevisionId | (Optional) Revision ID of the versioned object. Argument Type: UUID |
serviceMapDetailName | (Optional) The name of the service map detail. Argument Type: String |
serviceName | (Optional) The name of the independent service. Argument Type: String |
tierMapName | (Optional) The name of the tier map. If not provided, the application name and environment name is used to resolve Argument Type: String |
getService
Retrieves a microservice by name.
You must specify the projectName
and serviceName
.
Arguments | Descriptions |
---|---|
projectName | Name of the project. This name must be unique among all projects. Argument Type: String Argument Type: String |
serviceName | Name of the microservice. This name must be unique among all projects. Argument Type: String |
applicationEntityRevisionId | Revision ID of the versioned object. Argument type: UUID |
applicationName | The name of an application that this service is scoped to. Argument type: String |
includeDetails |
Argument type: Boolean |
serviceEntityRevisionId | (Optional) The revision ID of the versioned object. Argument type: UUID |
getServices
Retrieves all microservices in a project or application.
You must specify the projectName
.
Arguments | Descriptions |
---|---|
projectName | Name of the project. This name must be unique among all projects. Argument Type: String Argument Type: String |
applicationEntityRevisionId | Revision ID of the versioned object. Argument Type: UUID |
applicationName | The name of an application that this service is scoped to. Argument Type: String |
includeDetails |
Argument type: Boolean |
includeEntityRevisions | (Optional) < Boolean flag— If set to Argument type: Boolean |
modifyService
Modifies an existing microservice.
You must specify the projectName
and the serviceName
.
Arguments | Descriptions |
---|---|
projectName | Name of the project. This name must be unique among all projects. Argument Type: String Argument Type: String |
serviceName | Name of the microservice. This name must be unique among all projects. Argument Type: String |
applicationName | The name of an application to scope this service to. Argument type: String |
defaultCapacity | The default service capacity. Argument type: String |
description | (Optional) Comment text describing this object that is not interpreted at all by CloudBees CD . Argument Type: String |
maxCapacity | The max service capacity. Argument type: String |
minCapacity | The min service capacity. Argument type: String |
newName | (Optional) New name for an existing object that is being renamed. Argument Type: String |
volume | Volume JSON of the service. Argument type: String |
runServiceProcess
Runs a service process.
You must specify the projectName
, serviceName
, and processName
.
Arguments | Descriptions |
---|---|
projectName | Name of the project. This name must be unique among all projects. Argument Type: String Argument Type: String |
serviceName | Name of the microservice. This name must be unique among all projects. Argument Type: String |
processName | The name of the application process. Argument Type: String |
actualParameters | (Optional) Parameters passed as arguments to the process. Argument Type: Map |
credentials | (Optional) Credentials to be used in the job. Argument Type: Collection |
destinationProject | (Optional) The project that will own the job. Argument Type: String |
enforceDependencies | (Optional) If application dependencies are defined for the specified application, enforce them for successful deployment. Argument Type: Boolean |
environmentMapName | (Optional) The name of the Service Environment map used to determine where to run the process. Argument Type: String |
environmentName | (Optional) Environment name to create from template. Argument Type: String |
environmentProjectName | (Optional) The name of the project to which the environment or environment template belongs to. Argument Type: String |
priority | (Optional) The priority of the job. Argument Type: JobPriority |
scheduleName | (Optional) Name for the schedule; must be unique among all schedules for the project. Argument Type: String |
snapshotName | (Optional) Name for the snapshot. Argument Type: String |
validate | (Optional) Validate the process and environment. Argument Type: Boolean |
ec-perl
syntax: $<object>->runServiceProcess(<projectName>, <serviceName>, <processName>, {<optionals>});