Register a Solution Envoy

  • Open the runtime-controller
  • Use POST method Adds a runtime for creating a new Solution Envoy in the configuration management

Configuration Parameters (body parameter)

The following table lists the configurable parameters for registering a new Solution Envoy environemnt in the configuration management. The body has to be provided as a json formatted object.

Parameter Description
description An arbitrary string, that describes your environment, e.g. My default development runtime
name The name of the environment. This corresponds to the OpenShift namespace, where the Solution Envoy was installed and must be unique. It is also referenced to in the Pipeline-Configuration. E.g. cpd-runtime-default
stage The stage of this environment. Possible values for the stage are dev, test, stage and prod.

Request parameters (example) for registering a new Solution Envoy for the DEV stage

{
 "description": "My default development runtime",
 "name": "cpd-runtime-default",
 "stage": "dev"
}

Request parameters (example) for registering a new Solution Envoy for the TEST stage

{
 "description": "runtime cpd-runtime-default-test",
 "name": "cpd-runtime-default-test",
 "stage": "test"
}