Cloud Configuration Settings (YAML)#

Platform#

Name

Description

Type

Default

platform.hostname

Domain name assigned to the cluster. This setting is mandatory.

string

null

platform.imageRegistry

Repository where the image of the microservices are stored.

string

rulexms.azurecr.io/rulex/ms/

platform.imageVersion

Default image version for each Rulex microservice. It can be overridden by setting the img version for a specific microservice.

string

1.0.57-121

platform.frontend.enable

If true, all frontend microservices are installed.

bool

true

platform.frontend.namespace

Namespace where Rulex Platform frontend microservices are located.

string

platform_frontend

platform.backend.enable

If true, all backend microservices are installed.

bool

true

platform.backend.namespace

Namespace where platform backend microservices are located.

string

platform_backend

platform.authServer

Type of authentification server [‘null’. ‘internal’].

string

internal

platform.authServerUrl

Authentication server url. Required if the authentication server is external.

string

null

platform.environment

Type of environment [test, prod] (testing only).

string

prod

platform.test.product_key

Production key for test users (testing only).

string

null

platform.test.test_users

List of names and passwords for test users (testing only).

string

null

platform.balancing.active

Default settings for enabling or disabling balancing [‘True’, ‘False’].

string

False

platform.balancing.type

Default settings for the balancing type.

string

balanced

platform.scaling.keda.enable

Flag to enable or disable Keda autoscaling.

bool

false

platform.scaling.keda.rabbitHost

RabbitMQ host, with the following format ://:/vhost.

string

null

platform.log.loglevel

Log level [‘debug’, ‘info’, ‘warning’, ‘error’].

string

debug

platform.imageCredentials

Credentials to pull an image from a private container image registry or repository.

yaml

{}

platform.imageCredentialsSecretName

Name of the secret that stores the credentials of the container registry where images are stored.

string

null

platform.containerSecurityContext

Defines privileges and access control settings for a pod or container.

yaml

{}

Persistent volume claim#

Name

Description

Type

Default

persistentVolumeClaim.enable

If true, the persistentVolume resource is deployed.

bool

true

persistentVolumeClaim.storageSizeRequested

Storage size.

string

3000Gi

persistentVolumeClaim.volumeMode

Volume modes of persistent volumes.

string

Filesystem

persistentVolumeClaim.storageClassName

Name of the storage class.

string

null

Persistent volume#

Name

Description

Type

Default

persistentVolume.enable

If true, creates a persistent volume and the secret with the StorageAccount credentials.

bool

false

persistentVolume.volume_name

Name of the PersistentVolume.

string

azurefile_volume

persistentVolume.storageDefinition

Storage account driver and configuration.(kubernetes documentation)

yaml

{}

persistentVolume.storageAccountSecret

Storage account of the authentication secret.

yaml

{}

Broker#

Name

Description

Type

Default

msBroker.enable

If true, the ms_broker will be installed.

bool

true

msBroker.image.name

Docker image name of ms_broker.

string

rabbitmq

msBroker.image.version

Docker image version of ms_broker.

string

3.10.5

msBroker.image.registry

The registry where the image of the broker is stored. If not specified, use dockerHub.

string

null

ms.imageCredentialsSecretName

Name of the secret that stores the credentials of the container registry where images are stored. If not present, the platform.log.loglevel values are used.

string

registrycredentials

msBroker.replicaCount

Number of replicas indicating how many pods should be maintained.

string

1

msBroker.resources.requests.memory

Required memory for the pod.

string

2Gi

msBroker.resources.requests.cpu

Required CPU for the pod.

string

200m

msBroker.resources.limits.memory

Memory limit that the pod can use.

string

4Gi

msBroker.resources.limits.cpu

CPU limit that the pod can use.

string

2000m

platform.imageCredentials

Credentials to pull broker image from a private container image registry or repository. Required if the broker docker image is in a private registry.

yaml

{}

msBroker.imageCredentialsSecretName

Name of the secret that stores the credentials of the container registry where images are stored. Required if the broker docker image is in a private registry.

string

null

Internal authentication server#

(used only if platform.authServer == “internal”)

Name

Description

Type

Default

msAuth.enable

If true, the authentication server will be installed.

bool

true

msAuth.image.name

Docker image name of authentication server.

string

auth

msAuth.image.version

Docker image version of authentication server.

string

1.0.53.71

msAuth.replicaCount

Number of replicas indicating how many pods should be maintained.

string

1

msAuth.resources.requests.memory

Required memory for the pod.

string

200M

msAuth.resources.requests.cpu

Required CPU for the pod.

string

500m

msAuth.resources.limits.memory

Memory limit that the pod can use

string

1Gi

msAuth.resources.limits.cpu

CPU limit that the pod can use.

string

1

msAuth.annotations

Annotations of the statefullSet of the authentication server.

list of string

{}

msAuth.readinessProbePath

Path of the readinessProbe.

string

/auth/health/ready

msAuth.adminUsername

Authentication server admin username.

string

null

msAuth.adminPassword

Authentication server admin password.

string

null

msAuth.importRealm

Imports a Realm during start-up.

bool

false

msAuth.realm

Name of the authentication server realm.

string

rulex

msAuth.external_db.enable

If true, the authentication server will use an external database.

bool

false

msAuth.external_db.secretName

Secret where the database credentials are stored.

string

internal-db-secret

msAuth.external_db.db

The database vendor.

string

postgres

msAuth.external_db.dbUrl

The full database JDBC URL.

string

jdbc:postgresql://localhost/internal_db

Init#

Name

Description

Type

Default

msInit.enable

If true, init will be enabled.

bool

true

msInit.image.name

Docker image name.

string

init

msInit.image.version

Docker image version.

string

latest

If not present, the platform.imageVersion value is used. | string | null |

msNotify#

Name

Description

Type

Default

Watch parameters of MS_NAME.

msNotify.mail.SSL

SSL on e-mail server.

bool

null

msNotify.mail.apikey

Mail apikey.

string

null

msNotify.mail.auth

Mail auth.

string

null

msNotify.mail.port

Port mail server.

int

null

msNotify.mail.pwd

Password mail account.

string

null

msNotify.mail.sender

Sender mail.

string

null

msNotify.mail.server

Server mail URL.

string

null

msNotify.mail.subaccount

Mail subaccount.

string

null

msNotify.mail.type

Mail protocol type.

string

null

msNotify.mail.username

Username mail account.

string

null

MS_NAME#

Name

Description

Type

Default

ms.enable

If true, the microservices will be installed.

bool

true

ms.image.name

Docker image name.

string

ms.image.version

Docker image version.

string

latest
If not present, the platform.imageVersion value is used. | string | null | |
ms.image.pullPolicy | Guides the Kubelet service on how to pull the image. If not present, the platform.imagePullPolicy value is used | string | null |
ms.replicaCount | Number of replicas indicating how many pods should be maintained. | | |
For microservices with autoscaler enabled and managed by Keda (session, compute and control) this number is ignored and activeReplicaCount, backupReplicaCount are used to estimate the number of pods to be maintained (replicaCount = activeReplicaCount+backupReplicaCount) | string | 1 | |
ms.balancing.activeReplicaCount | Initial number of active replicas, for the microservices with autoscaler enabled and managed by Keda, indicating how many pods should be maintained. If not set, the default value is 1. | string | null |
ms.balancing.backupReplicaCount | Number of backup replicas indicating how many Pods should be maintained. | | |
If not set, the default is 1 | string | null | |
ms.resources.requests.memory | Required memory for the pod. | string | `` |
ms<MS_NAME>.resources.requests.cpu | Required CPU for the pod. | string | `` |
ms.resources.limits.memory | Memory limit memory that the pod can use. | string | `` |
ms<MS_NAME>.resources.limits.cpu | CPU limit that the pod can use. | string | `` |
ms.affinity | Pod & node affinity/antiAffinity. | | |
By default affinity is not set. | yaml | {} | |
ms.balancing.active | Default settings for enabling or disabling balancing [‘True’, ‘False’]. | string | null |
ms.balancing.type | Default settings for the balancing type, | string | null |
ms.log.loglevel | Log level configuration. | | |
If not present, the platform.log.loglevel value is used | string | null | |
ms.imageCredentialsSecretName | Name of the secret that stores the container registry credentials, where images are stored. | | |
If not present, the platform.imageCredentialsSecretName value is used | string | null | |
ms.containerSecurityContext | Defines privileges and access control settings for a container. | | |
If not present, the platform.containerSecurityContext value is used. | yaml | {} | |

Ingress#

(only for Kubernetes)

Name

Description

Type

Default

ingress.enabled

If true, the ingress will be created.

bool

true

ingress.ingressClassName

Specifies the ingress-controller.

string

nginx

ingress.annotations

Extra annotation of the ingress.

list

{}

ingress.tlsSecretName

Name of the secret containing TLS certificate and key.

string

tls-secret

ingress.secretProvider.enable

If true, the secretProvider will be created.

bool

true

ingress.secretProvider.name

Name of the secretProvider.

string

ingress-tls-secret-provider

ingress.secretProvider.objectName

Name of the secret stored on the keyvault containing TLS certificate and key.

string

“”

Route#

(only for OpenShift)

Name

Description

Type

Default

routes.enabled

If true, the route for OpenShift will be created.

bool

false

routes.tlsSecretName

Name of the secret containing the TLS certificate and key. If None, the self-signed OpenShift certificate is used.

string

null

Istio#

Name

Description

Type

Default

istio.enable

If true, Istio is installed.

bool

false

istio.namespace

The Istio namespace.

string

istio-system

istio.ingressgateway.enable

If true, the Istio ingressGateway is installed.

bool

default

istio.ingressgateway.name

Name of the Istio ingressgateway.

type

default