createMicroservice
Creates a new microservice for a project or application.
You must specify the projectName
and microserviceName
.
Arguments | Descriptions |
---|---|
projectName | Project containing the microservice application. Argument Type: String |
microserviceName | Name of the microservice. Argument Type: String |
addDeployProcess | (Optional) < Boolean flag — Whether a deploy process is to be generated for the microservice. Defaults to Argument Type: Boolean |
applicationName | Name of the microservice application. Argument Type: String |
definitionSource | The name representing the definition source, Argument Type: String |
definitionSourceParameter | Parameters specific to Argument Type: PropertySheet |
definitionType | The name representing the definition type. The only supported type is Argument Type: String |
deployParameter | Actual parameters for the plugin procedure to use to fetch the Helm chart. Format: Argument Type: PropertySheet |
description | User-supplied description. Argument Type: String |
ec-perl
syntax: $<object>->createMicroservice(<projectName>, <microserviceName>, {<optionals>});
Example
$ec->createMicroservice({
projectName => "Default",
microserviceName => "myMicroservice" ,
applicationName => "myApp",
definitionType => "helm",
definitionSource => "git",
definitionSourceParameter =>[
{
definitionSourceParameterName => "config",
value => "test"
},{
definitionSourceParameterName => "branch",
value => "main"
},{
definitionSourceParameterName => "repoUrl",
value => "https://your_repo_url"
}],
deployParameter =>[
{
deployParameterName => "releaseName",
value => "test"
},{
deployParameterName => "chart",
value => "chart/test"
}]
});
ectool
syntax: ectool createMicroservice <projectName> <microserviceName> [optionals]
deleteMicroservice
Deletes a microservice application.
You must specify the projectName
and microserviceName
.
Arguments | Descriptions |
---|---|
projectName | Name of the project. This name must be unique among all projects. Argument Type: String |
microserviceName | Name of the microservice to delete. Argument Type: String |
applicationName | Name of the microservice application. Argument Type: String |
getMicroservice
Retrieves a microservice by name.
You must specify the projectName
and microserviceName
.
Arguments | Descriptions |
---|---|
projectName | Name of the project. This name must be unique among all projects. Argument Type: String |
microserviceName | Name of the microservice. This name must be unique among all projects. Argument Type: String |
applicationName | The name of an application that this service is scoped to. Argument type: String |
getMicroservices
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 |
applicationName | The name of an application that this service is scoped to. Argument Type: String |
modifyMicroservice
Modifies an existing microservice.
You must specify the projectName
and the microserviceName
.
Arguments | Descriptions |
---|---|
projectName | Project containing the microservice application. Argument Type: String |
microserviceName | Name of the microservice. Argument Type: String |
addDeployProcess | (Optional) < Boolean flag — Whether a deploy process is to be generated for the microservice. Defaults to Argument Type: Boolean |
applicationName | Name of the microservice application. Argument Type: String |
definitionSource | The name representing the definition source, Argument Type: String |
definitionSourceParameter | Parameters specific to Argument Type: PropertySheet |
definitionType | The name representing the definition source. The only supported type is Argument Type: String |
deployParameter | Actual parameters for the plugin procedure to use to fetch the Helm chart. Format: Argument Type: PropertySheet |
description | User-supplied description. Argument Type: String |
newName | (Optional) New name for an existing object that is being renamed. Argument Type: String |
createMicroserviceMapping
Creates a new mapping between a 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 |
applicationName | (Optional) The name of the application that contains the microservice. Argument type: String |
clusterName | (Optional) The name of the environment that contains the cluster. Argument type: String |
clusterProjectName | (Optional) The name of the cluster’s environment project if it is different from the application. Argument type: String |
environmentName | (Optional) The name of the environment that contains the cluster. Argument type: String |
microserviceName | (Optional) The name of the microservice. Argument type: String |
microserviceMappingName | (Optional) The name of the microservice map. Argument type: String |
tierMapName | (Optional) The name of the tier map. Argument type: String |
deleteMicroserviceMapping
Deletes a microservice cluster mapping.
You must specify the projectName
and applicationName
.
Arguments | Descriptions |
---|---|
projectName | Name of the project. This name must be unique among all projects. Argument Type: String |
microserviceMappingName | (Optional) The name of the service cluster mapping. Argument Type: String |
applicationName | (Optional) The name of the application which contains the service. 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 |
environmentName | (Optional) The name of the environment which contains the cluster. Argument Type: String |
microserviceName | (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 are used to resolve Argument Type: String |
ec-perl
syntax: $<object>->deleteMicroserviceMapping(<projectName>, <microserviceMappingName>, {<optionals>});
ectool
syntax: ectool deleteMicroserviceMapping <projectName> <microserviceMappingName> [optionals]
Example
ectool deleteMicroserviceMapping "qe proj service" "myMap" --environmentName "qe env" --microserviceName "qe service1" --clusterName "qe cluster1"
Back to top modifyucreateMicroserviceMapping]] modifyMicroserviceMapping
Creates a new mapping between a 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 |
applicationName | (Optional) The name of the application that contains the microservice. Argument type: String |
clusterName | (Optional) The name of the environment that contains the cluster. Argument type: String |
clusterProjectName | (Optional) The name of the cluster’s environment project if it is different from the application. Argument type: String |
environmentName | (Optional) The name of the environment that contains the cluster. Argument type: String |
microserviceName | (Optional) The name of the microservice. Argument type: String |
microserviceMappingName | (Optional) The name of the microservice map. Argument type: String |
tierMapName | (Optional) The name of the tier map. Argument type: String |
environmentName | (Optional) The name of the environment that contains the cluster. Argument type: String |
newName | The new name of theos microserviceMapping object. Argument type: String |
createCluster
Creates a new cluster configuration object for a microservice application.
You must specify the projectName
and clusterName
.
Arguments | Descriptions |
---|---|
projectName | Project containing the cluster application. Argument Type: String |
clusterName | Name of the cluster. Argument Type: String |
environmentName | Name of the environment into which cluster is placed. Argument Type: String |
pluginKey | The name representing the definition source. Use Argument Type: String |
definitionParameter | Actual parameters related to the procedure capturing the cluster definition. For example, Argument Type: String` |
modifyCluster
Modify an existing cluster configuration object for a microservice application.
You must specify the projectName
and clusterName
.
Arguments | Descriptions |
---|---|
projectName | Project containing the cluster application. Argument Type: String |
clusterName | Name of the cluster. Argument Type: String |
environmentName | Name of the environment into which cluster is placed. Argument Type: String |
pluginKey | The name representing the definition source. The only supported type is Argument Type: String |
definitionParameter | Actual parameters related to the procedure capturing the cluster definition. Argument Type: String` |
newName | The new name of theos microserviceMapping object. Argument type: String |
createService (deprecated)
Creates a new microservice for a project or application.
You must specify the projectName
and microserviceName
.
Arguments | Descriptions |
---|---|
projectName | Name of the project. This name must be unique among all projects. Argument Type: String |
microserviceName | 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/RO . 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 (deprecated)
Creates a new mapping between an application or project microservice and an environment cluster.
You must specify the projectName
.
Arguments | Descriptions |
---|---|
projectName | include::partial$name-for-the-project.adoc[ |
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 |
microserviceName | (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 (deprecated)
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 |
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 (deprecated)
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 |
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 (deprecated)
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 |
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 (deprecated)
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 |
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 (deprecated)
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 |
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 (deprecated)
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 |
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 (deprecated)
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 |
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 (deprecated)
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 |
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/RO . 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 (deprecated)
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 |
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>});