Configuration File Content
Configuration File Content
The Docker Compose YAML file has the following sections:
- General settings. This section includes the following configuration:
- The version of the file
- The Docker network configuration
- The Docker volumes used by the Edge Xpert microservices
- Environment variables and their default settings that are used by the microservices
- Services. This section defines the services as described below:
- Registry Services. This section includes the configuration for the Consul service.
- Database Services. This section includes the configuration for the Redis database
- Core Services. This section includes the configuration for the following services:
core-metadata
core-data
core-command
core-keeper
- Application Services. This section is included for pull purposes only; the Application Service is defined in the app-service.yml file.
- Supporting Service. This section includes configuration for the following services:
support-notifications
support-scheduler
support-provision
support-sparkplug
- System Management. This section includes the configuration for the system management service.
- Management Console. This section includes the configuration for the Edge Xpert Manager UI service.
- Device Services. This section includes the configuration for the Device Services.
- Tools. This section includes configuration for the following services:
portainer
influxdb
grafana
nodered
mqtt-broker
bacnet-sim
kuiper
timescaledb
Configuration File Parameters
The following table describes the parameters used in the docker-compose file:
Parameter | Description |
---|---|
cap_add |
Adds additional container capablities |
command |
Overrides the default command |
container_name |
Specifies the name of the container |
depends_on |
Defines dependencies between services. This ensures that services are automatically started and stopped in dependency order |
environment |
Adds environment variables |
hostname |
Sets the hostname within the container |
image |
Identifies the version and image from which to start the container |
logging |
Configures the logging for the service. driver specifies the logging driver for the service's containers. options specifies the logging options for the logging driver. |
networks |
Identifies the networks to join |
ports |
Exposes specific ports |
priviledged |
Enables priviledged mode to allow containers the same access as the process running on the host |
volumes |
Mounts host paths or named volumes |