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 VariableDefault ValueDescription
CERTIFICATES_PATHtlscertificate path relative to the JETTY_BASE directory
EC_CRTcertificate used for the SSL/TLS termination
EC_CACA chain used for the SSL/TLS termination
EC_KEYcertificate key used for the SSL/TLS termination
DB_HOSTec-mariadbhost where the database can be found
DB_PORT3306port where the database can be found
DB_NAMEkapuadbname of the database
DB_SCHEMA_NAMEkapuadbname of the database schema
DB_SCHEMA_UPDATEtruewhether or not the database schema should be updated
DB_USERNAMEusername to connect to the database
DB_PASSWORDpassword to connect to the database
DB_SSLfalseeither to use or not TLS/SSL to connect to the database service
DB_CONNECTION_SCHEMEjdbc:mariadbconnection scheme used to connect to the database. Should not be changed
DB_RESOLVERMariaDBresolver used for the database connection. Should not be changed
DB_DRIVERorg.mariadb.jdbc.Driverdriver used for the database connection. Should not be changed
JAVA_ARGSExtra options to configure the JVM can be specified via this variable.
JAVA_OPTSExtra 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 VariableDefault ValueDescription
DISABLE_SSLtrueDisable TLS/SSL termination on the container.
KEYSTORE_NAMEec.pkcs12name of the keystore
KEYSTORE_PASSchangeitpassword for the keystore
EC_KEYSTOREbase64 representation of the keystore used for the SSL/TLS termination. When set, EC_CRT, EC_CA and EC_KEY are ignored.
EC_KEY_PASSWORDpassword of the keystore
STORAGE_HOSTec-elasticsearchhost where the storage service can be found
STORAGE_PORT9200port where the storage service can be found
STORAGE_SSLfalseeither to use or not TLS/SSL to connect to the storage service
STORAGE_PREFIXprefix for the indices in Elasticsearch
STORAGE_CLIENTorg.eclipse.kapua.service.datastore.client.rest.RestDatastoreClientclass to use for the storage connection. Should not be changed
EVENTS_BROKER_HOSTec-events-brokerhost where the events broker can be found
EVENTS_BROKER_PORT5672port where the events broker can be found
EVENTS_BROKER_USERNAMEusername used by the service to connect to the events broker
EVENTS_BROKER_PASSWORDpassword used by the service to connect to the events broker
TRANSPORT_USERNAMEusername used by the service to connect to the message broker
TRANSPORT_PASSWORDpassword 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 VariableDefault ValueDescription
KEYCLOAK_URLURL of the Keycloak server
CONSOLE_URLCallback URL used by Keycloak. (Required if setting KEYCLOAK_URL)
KEYCLOAK_REALMRealm used for Keycloak authentication. (Required if setting KEYCLOAK_URL)
KEYCLOAK_CLIENT_IDClient ID to use when connecting to the Keycloak server. (Required if setting KEYCLOAK_URL)
KEYCLOAK_CLIENT_SECRETSecret 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 VariableDefault ValueDescription
BROKER_IP$(hostname)IP or URL announced by the broker when starting up
CLUSTER_NAMEec-brokerName of the cluster the broker belongs to
AMQ_SERIALIZABLE_PACKAGESorg.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_NAMEec-vpnName 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 VariableDefault ValueDescription
MIN_HEAP512mMinimum size of the JVM Heap
MAX_HEAP2048mMaximum size of the JVM Heap
MAX_METASPACE_SIZE256mMaximum size of the JVM Metaspace
ARTEMIS_USERec-userUsername used to connect to the events broker from the other service.
ARTEMIS_PASSec-passPassword used to connect to the events broker from the other service.
ARTEMIS_CONFIGURATION/opt/artemis/etcPath 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_ARGSExtra options to configure the JVM can be specified via this variable.