Container Properties
This section is still being edited and it may contain errors.
Common Parameters
These are parameters common for the REST API, Web Console, Message Broker and VPN Server.
| Environment Variable | Default Value | Description |
|---|---|---|
| CERTIFICATES_PATH | tls | certificate path relative to the JETTY_BASE directory |
| EC_CRT | certificate used for the SSL/TLS termination | |
| EC_CA | CA chain used for the SSL/TLS termination | |
| EC_KEY | certificate key used for the SSL/TLS termination | |
| DB_HOST | ec-mariadb | host where the database can be found |
| DB_PORT | 3306 | port where the database can be found |
| DB_NAME | kapuadb | name of the database |
| DB_SCHEMA_NAME | kapuadb | name of the database schema |
| DB_SCHEMA_UPDATE | true | whether or not the database schema should be updated |
| DB_USERNAME | username to connect to the database | |
| DB_PASSWORD | password to connect to the database | |
| DB_SSL | false | either to use or not TLS/SSL to connect to the database service |
| DB_CONNECTION_SCHEME | jdbc:mariadb | connection scheme used to connect to the database. Should not be changed |
| DB_RESOLVER | MariaDB | resolver used for the database connection. Should not be changed |
| DB_DRIVER | org.mariadb.jdbc.Driver | driver used for the database connection. Should not be changed |
| JAVA_ARGS | Extra options to configure the JVM can be specified via this variable. | |
| JAVA_OPTS | Extra options to configure the REST APIs component. |
These are the environment variables common for the REST API, Web Console, Message Broker. They add to the variables listed in the previous block.
| Environment Variable | Default Value | Description |
|---|---|---|
| DISABLE_SSL | true | Disable TLS/SSL termination on the container. |
| KEYSTORE_NAME | ec.pkcs12 | name of the keystore |
| KEYSTORE_PASS | changeit | password for the keystore |
| EC_KEYSTORE | base64 representation of the keystore used for the SSL/TLS termination. When set, EC_CRT, EC_CA and EC_KEY are ignored. | |
| EC_KEY_PASSWORD | password of the keystore | |
| STORAGE_HOST | ec-elasticsearch | host where the storage service can be found |
| STORAGE_PORT | 9200 | port where the storage service can be found |
| STORAGE_SSL | false | either to use or not TLS/SSL to connect to the storage service |
| STORAGE_PREFIX | prefix for the indices in Elasticsearch | |
| STORAGE_CLIENT | org.eclipse.kapua.service.datastore.client.rest.RestDatastoreClient | class to use for the storage connection. Should not be changed |
| EVENTS_BROKER_HOST | ec-events-broker | host where the events broker can be found |
| EVENTS_BROKER_PORT | 5672 | port where the events broker can be found |
| EVENTS_BROKER_USERNAME | username used by the service to connect to the events broker | |
| EVENTS_BROKER_PASSWORD | password used by the service to connect to the events broker | |
| TRANSPORT_USERNAME | username used by the service to connect to the message broker | |
| TRANSPORT_PASSWORD | password used by the service to connect to the message broker |
REST API
There are not other environment variables in addition to the ones described in the section above.
Web Console
These are the environment variables available on the Web Console container.
| Environment Variable | Default Value | Description |
|---|---|---|
| KEYCLOAK_URL | URL of the Keycloak server | |
| CONSOLE_URL | Callback URL used by Keycloak. (Required if setting KEYCLOAK_URL) | |
| KEYCLOAK_REALM | Realm used for Keycloak authentication. (Required if setting KEYCLOAK_URL) | |
| KEYCLOAK_CLIENT_ID | Client ID to use when connecting to the Keycloak server. (Required if setting KEYCLOAK_URL) | |
| KEYCLOAK_CLIENT_SECRET | Secret of the Client ID to use when connecting to the Keycloak server. (Required if setting KEYCLOAK_URL) |
Message Broker
These are the environment variables available on the Message Broker container.
| Environment Variable | Default Value | Description |
|---|---|---|
| BROKER_IP | $(hostname) | IP or URL announced by the broker when starting up |
| CLUSTER_NAME | ec-broker | Name of the cluster the broker belongs to |
| AMQ_SERIALIZABLE_PACKAGES | org.eclipse.kapua.* | Broker will serialise only classes matching this variable |
VPN Service
These are the environment variables available on the VPN Server container.
| VPN_SERVER_NAME | ec-vpn | Name of the VPN Server corresponding to the one seeded in the database. |
Events Broker
These are the environment variables available on the Events Broker container.
| Environment Variable | Default Value | Description |
|---|---|---|
| MIN_HEAP | 512m | Minimum size of the JVM Heap |
| MAX_HEAP | 2048m | Maximum size of the JVM Heap |
| MAX_METASPACE_SIZE | 256m | Maximum size of the JVM Metaspace |
| ARTEMIS_USER | ec-user | Username used to connect to the events broker from the other service. |
| ARTEMIS_PASS | ec-pass | Password used to connect to the events broker from the other service. |
| ARTEMIS_CONFIGURATION | /opt/artemis/etc | Path of the events broker configuration folder. It's possible to mount a new configuration folder and use it to start the broker. This property normally should not be changed. |
| JAVA_ARGS | Extra options to configure the JVM can be specified via this variable. |
Updated about 3 years ago