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`.

Auto-configuration of a new Solution Envoy:

The k5-project-operator will register a new Solution Envoy during the creation. This feature is enabled by default but can be disabled by using the parameter spec.configuration.configurationManagement.autoConfiguration.enabled: false (part of the k5project crd, default value: true). The following Solution Envoy will be registered automatically:

{
 "description": "<project-namespace of the Solution Envoy>",
 "name": "<project-namespace of the Solution Envoy>",
 "stage": "<configured in the k5project crd (spec.stage)>"
}

Examples

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"
}