The tables in each of the tabs below document configuration properties that are common to all services in the EdgeX Foundry platform. Service-specific properties can be found on the respective documentation page for each service.
For EdgeX 2.0 the
Startup sections have been removed.
Startup has been replaced with the
EDGEX_STARTUP_DURATION (default is 60 secs) and
EDGEX_STARTUP_INTERVAL (default is 1 sec) environment variables.
|entries in the Writable section of the configuration can be changed on the fly while the service is running if the service is running with the
|LogLevel||INFO||log entry severity level. Log entries not of the default level or higher are ignored.|
|InsecureSecrets||---||This section a map of secrets which simulates the SecretStore for accessing secrets when running in non-secure mode. All services have a default entry for Redis DB credentials called
For EdgeX 2.0 the
Writable.InsecureSecrets configuration section is new.
|Interval||30s||The interval in seconds at which to report the metrics currently being collected and enabled. Value of 0s disables reporting.|
|PublishTopicPrefix||"edgex/telemetry"||The base topic in which to publish (report) metrics currently being collected and enabled.
||Boolean map of service metrics that are being collected. The boolean flag for each indicates if the metric is enabled for reporting. i.e.
||String map of arbitrary tags to be added to every metric that is reported for the service. i.e.
For EdgeX 2.2 Service Metrics have been added. Currently only Core Data and Application Services are collecting service metrics.
|HealthCheckInterval||10s||The interval in seconds at which the service registry(Consul) will conduct a health check of this service.|
|Host||localhost||Micro service host name|
|Port||---||Micro service port number (specific for each service)|
|ServerBindAddr||'' (empty string)||The interface on which the service's REST server should listen. By default the server is to listen on the interface to which the
|StartupMsg||---||Message logged when service completes bootstrap start-up|
|MaxResultCount||1024*||Read data limit per invocation. *Default value is for core/support services. Application and Device services do not implement this setting.|
|MaxRequestSize||0||Defines the maximum size of http request body in kilbytes. 0 represents default to system max.|
|RequestTimeout||5s||Specifies a timeout duration for handling requests|
For EdgeX 2.0
BootTimeout have been removed.
Timeout have been renamed to
MaxRequestSize was added for all services.
For EdgeX 2.2 Service MaxRequestSize has been implemented to all services, and the unit is kilobyte.
|The settings of controling CORS http headers|
|EnableCORS||false||Enable or disable CORS support.|
|CORSAllowCredentials||false||The value of
|CORSAllowedOrigin||"https://localhost"||The value of
|CORSAllowedMethods||"GET, POST, PUT, PATCH, DELETE"||The value of
|CORSAllowedHeaders||"Authorization, Accept, Accept-Language, Content-Language, Content-Type, X-Correlation-ID"||The value of
|CORSExposeHeaders||"Cache-Control, Content-Language, Content-Length, Content-Type, Expires, Last-Modified, Pragma, X-Correlation-ID"||The value of
|CORSMaxAge||3600||The value of
New for EdgeX 2.1 is the ability to enable CORS access to EdgeX microservices through configuration.
|configuration that govern database connectivity and the type of database to use. While not all services require DB connectivity, most do and so this has been included in the common configuration docs.|
|Host||localhost||DB host name|
|Port||6379||DB port number|
|Name||----||Database or document store name (Specific to the service)|
|Timeout||5000||DB connection timeout|
|Type||redisdb||DB type. Redis is the only supported DB|
For EdgeX 2.0
mongodb has been remove as a supported DB. The credentials
password have been removed and are now in the
|this configuration only takes effect when connecting to the registry for configuration info|
|Host||localhost||Registry host name|
|Port||8500||Registry port number|
|Type||consul||Registry implementation type|
|Each service has it own collect of Clients that it uses|
|Protocol||http||The protocol to use when building a URI to local the service endpoint|
|Host||localhost||The host name or IP address where the service is hosted|
|Port||598xx||The port exposed by the target service|
For EdgeX 2.0 the map keys have changed to be the service's service-key, i.e.
Metadata changed to
|these config values are used when security is enabled and
|Type||vault||The type of the
|Host||localhost||The host name or IP address associated with the
|Port||8200||The configured port on which the
||The service-specific path where the secrets are kept. This path will differ according to the given service.|
|Protocol||http||The protocol to be used when communicating with the
|RootCaCertPath||blank||Default is to not use HTTPS|
|ServerName||blank||Not needed for HTTP|
||Fully-qualified path to the location of the service's
|SecretsFile||blank||Fully-qualified path to the location of the service's JSON secrets file contains secrets to seed at start-up. See Seeding Service Secrets section for more details on seed a service's secrets.|
|DisableScrubSecretsFile||false||Controls if the secrets file is scrubbed (secret data remove) and rewritten after importing the secrets.|
|Authentication AuthType||X-Vault-Token||A header used to indicate how the given service will authenticate with the
For EdgeX 2.0 the
Protocol default has changed to
HTTP which no longer requires
ServerName to be set.
Path has been reduce to the sub-path for the service since the based path is fixed.
TokenFile default value has changed and requires the
service-key be used in the path.
Writable vs Readable Settings
Within a given service's configuration, there are keys whose values can be edited and change the behavior of the service while it is running versus those that are effectively read-only. These writable settings are grouped under a given service key. For example, the top-level groupings for edgex-core-data are:
Any configuration settings found in a service's
Writable section may be changed and affect a service's behavior without a restart. Any
modifications to the other settings (read-only configuration) would require a restart.