Solution default configuration
Specifies solution specific default configuration. This values are used for the helm deployment of a solution. The default configuration is used for all solutions in the Solution Envoy if there is no specific configuration for a solution. This has to be done for each new Solution Envoy.
- Open the
configuration-controller
- Use
POST
methodCreate a solution default configuration
for creating the configuration.
Request parameters
Parameter | Type | Description |
---|---|---|
configurationName |
path parameter (String) | The name of the configuration:
ssob-sdo-values-yaml |
runtimeName |
path parameter (String) | The name of the specific Solution Envoy, e.g.
cpd-runtime-default |
data |
body parameter (YAML) | The configuration values (Body Parameters) |
Configuration Parameters (body parameter)
The following table lists the required configurable parameters for the solution default configuration.
Parameter | Description |
---|---|
environment.host |
Hostname of the specific Solution Envoy (e.g.
cpd-runtime-default.apps.openshift-cluster.mydomain.cloud ) |
The following table lists the optional configurable parameters for the solution default configuration, these variables have default values if nothing is set.
Parameter | Description | Default value |
---|---|---|
debugserver.connectionTimeout |
Connection timeout used for the debugging in ms. | 30000 |
debugserver.readTimeout |
Read timeout used for the debugging in ms. | 180000 |
eventManager.secretName |
Secret of the oidc configuration for the event manager. | event-manager-oauth-client-secret |
feature.corsPolicy |
Defines if cross-origin resource sharing is enabled or
not. If set to true CORS
policy where the value is set to '*' (any origin is allowed) is enabled. |
false |
feature.dataEvents |
Defines if solutions shall send events to a Solution Envoy namespace wide topic. | false |
feature.debugSupport |
Defines if solutions in general support debugging or not. | false |
feature.devBinding |
Defines that solutions uses dev bindings that are defined in the solution center, if no service binding is deployed in the Kubernetes cluster. | false |
feature.exposeInternalApi |
Defines if the internal APIs of a solution is exposed to the provided swagger.json. | false |
feature.testSupport |
Defines if an additional API for testing is available. | false |
image.registry |
Specifies the registry of the needed image for the solution. | image-registry.openshift-image-registry.svc:5000 |
imagepullSecret.name |
Used image pull secret for solution deployment (not needed for OpenShift registry). | nil |
mongodb.secretName |
Service binding name for the mongodb service (created by the helm chart deployment of a new Solution Envoy). Only the Solution Envoy name has to be changed. | binding-<RT_NAMESPACE>-document-storage |
messagehub.secretName |
Service binding name for the messagehub service (created by the helm chart deployment of a new Solution Envoy). Only the Solution Envoy name has to be changed. | binding-<RT_NAMESPACE>-message-service |
messagehub.saslMechanism |
SASL Mechanism that is used by the kafka client to communicate with the kafka cluster. | PLAIN |
messagehub.saslJaasConfigLoginModule |
SASL Jaas Config Login Module that is used by the kafka client to communicate with the kafka cluster. | org.apache.kafka.common.security.plain.PlainLoginModule |
oidc.secretName |
Secret name of the oidc configuration for the solution. | k4-binding-<RT_NAMESPACE>-oidc |
rbac.useSelfCreated |
Use self created default service account, role and rolebinding. If true the specific service account names are not used. | false |
rbac.serviceAccountName |
Set existing service account name for the solution deployment, only used if rbac.useSelfCreated is false. | cpd-viewer-sa |
rbac.serviceAccountName |
Set existing service account name for the deployment jobs, only used if rbac.useSelfCreated is false. | cpd-editor-sa |
Example body parameter for a typical development stage (data):
environment:
host: "cpd-runtime-default.apps.openshift-cluster.mydomain.cloud"
feature:
corsPolicy: true
devBinding: true
testSupport: true
debugSupport: true
Example body parameter for a typical production stage (data):
environment:
host: "prod.apps.openshift-cluster.mydomain.cloud"
feature:
corsPolicy: true