⚠️
This documentation is for Rhize v3.0.3. If you don’t need a specific version, switch to the latest documentation
BPMN configuration
The Rhize BPMN acts as the tailored engine for processing low-code workflows designed within the [BPMN UI]/versions/v3.0.3/how-to/bpmn/. The configurations manage the connection and data flow on the BPMN engine to the other Rhize microservices.
http
All HTTP configurations are measured in seconds.
| Attribute | Description |
|---|---|
ReadHeaderTimeout | Wait duration for the request header to be fully read before timing out. (Default: 10) |
ReadTimeout | Wait duration for the entire request to be read before timing out. (Default: 15) |
WriteTimeout | Wait duration for the entire response to be written before timing out. (Default: 10) |
IdleTimeout | Wait duration for the next request while the connection is idle before timing out. (Default: 30) |
logging
Logs the configurations to the console.
| Attributes | Description |
|---|---|
type | Specifies the logging configuration type: json, multi, or console.(Default: console) |
Level | Configures the level of logging: Trace, Debug, Info, Warn, Error, Fatal, or Panic.(Default: Debug) |
libreDataStoreGraphQL
| Attribute | Description |
|---|---|
GRAPHQL_URL | The URL of the GraphQL endpoint to use for interacting with Rhize services. (Default: http://localhost:4000/) |
GRAPHQL_CA_FILE | The file path of the CA certificate used for secure communication with the GraphQL endpoint. (Default: '') |
viewInstance
Configuration for service viewing instances.
| Attribute | Description |
|---|---|
grafana | org: The organization ID for the Grafana instance (Default: 1).tempoUid: The UID for Tempo integration in Grafana (Default: libre-tempo).url: The URL of the Grafana instance (Default: http://localhost:3000). |
loki | accessToken: The access token for authentication with Loki (Default: '').url: The URL of the Loki instance (Default: http://localhost:3100). |
tempo | accessToken: The access token for authentication with Tempo (Default: '').url: The URL of the Tempo instance (Default: http://localhost:3200). |
commandConsumer
| Attribute | Description |
|---|---|
threads | The number of threads for command consumption. (Default: 3) |
GraphQLSubscriber
| Attribute | Description |
|---|---|
GRAPHQL_URL | The URL of the GraphQL endpoint for the GraphQLSubscriber. (Default: http://localhost:4000/) |
NATS
| Attribute | Description |
|---|---|
CommandStreamReplicas | The number of replicas for the command stream. (Default: 1) |
JobResponseKVMaxGB | The maximum size (in gigabytes) for the job response key-value store. (Default: 2) |
JobResponseKVReplicas | The number of replicas for the job response key-value store. (Default: 1) |
JobResponseKVTTLMinutes | the “time-to-live” (in minutes) for job response key-values. (Default: 7) |
WorkflowSpecificationKVReplicas | The number of replicas for the workflow specification key-value store. (Default: 1) |
serverUrl | The URL for connecting to the NATS server. (Default: nats://system:system@localhost:4222) |
OIDC
Configurations for Keycloak authentication and connection with OpenID Connect.
| Attribute | Description |
|---|---|
serverUrl | The URL of the OpenID Connect server. (Default: http://localhost:8090) |
realm | Identifies the authentication domain for which the authentication request is being made. |
client_id | The unique identifier assigned to the client application by the OIDC server. |
client_secret | Used to authenticate the client alongside the client ID when making confidential requests. |
username | The username credentials to authenticate with the OIDC server. |
password | The password credentials to authenticate with the OIDC server. |
OpenTelemetry
| Attribute | Description |
|---|---|
serverUrl | The URL of the OpenTelemetry server. (Default: localhost:4317) |
defaultDebug | Enables or disables default debug mode. (Default: false) |
RESTAPI
| Attribute | Description |
|---|---|
PORT | The port number for RestAPI connection. (Default: 8080) |
SECRET
| Attribute | Description |
|---|---|
KEY | The secret key used to connect to the BPMN client. |