You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The config file has become somewhat inconsistent over the years, which is not surprising.
All in all it has served well, but a cleanup is motivated when a major Butler release (with breaking features) is planned.
This ticket details the changes that will be done in the config file format.
Changes to config file
Change "Adress" to "Address" everywhere
Use correct spelling of that word throughout the config file.
Specifically:
fromAdress --> fromAddress
Change apiListEnbledEndpoints to apiListEnabledEndpoints
The new property path will be: Butler.restServerEndpointsEnable.apiListEnabledEndpoints
Remove Butler.influxDb.instanceTag
That setting can be handled either by the various feature-specific static tag properties Butler.influxDb.instanceTag.reloadTaskFailure.tag.static, Butler.influxDb.instanceTag.reloadTaskSuccess.tag.static etc, or in a new, shared setting Butler.influxDb.tag.static:
Butler:
influxDb:
tag:
static:
- name: butler_instancevalue: dev
Note that the previously used instanceTag property was assigned to a InfluxDB tag called butler_instance. Thus the suggested format above.
Generalise http header def in Butler.configEngine.headers
Make it an array like this, using the name-value model used elsewhere in the config file:
Butler:
configEngine:
headers:
static:
- name: X-Qlik-User # Mandatory, this header must be present!value: UserDirectory=Internal; UserId=sa_repository
This will allow for using both the mandatory X-Qlik-User header (Butler will verify that this header is defined in the config file!) and other headers, if such are needed.
Generalise http headers for use with the QRS config settings
Overview
The config file has become somewhat inconsistent over the years, which is not surprising.
All in all it has served well, but a cleanup is motivated when a major Butler release (with breaking features) is planned.
This ticket details the changes that will be done in the config file format.
Changes to config file
Change "Adress" to "Address" everywhere
Use correct spelling of that word throughout the config file.
Specifically:
fromAdress
-->fromAddress
Change
apiListEnbledEndpoints
toapiListEnabledEndpoints
The new property path will be:
Butler.restServerEndpointsEnable.apiListEnabledEndpoints
Remove
Butler.influxDb.instanceTag
That setting can be handled either by the various feature-specific static tag properties
Butler.influxDb.instanceTag.reloadTaskFailure.tag.static
,Butler.influxDb.instanceTag.reloadTaskSuccess.tag.static
etc, or in a new, shared settingButler.influxDb.tag.static
:Note that the previously used
instanceTag
property was assigned to a InfluxDB tag calledbutler_instance
. Thus the suggested format above.Generalise http header def in
Butler.configEngine.headers
Currently looks like this:
Make it an array like this, using the name-value model used elsewhere in the config file:
This will allow for using both the mandatory X-Qlik-User header (Butler will verify that this header is defined in the config file!) and other headers, if such are needed.
Generalise http headers for use with the QRS config settings
Currently looks like this:
Change to this:
Butler will verify that the mandatory
X-Qlik-User
header is present, but other headers can be added too, if needed.The text was updated successfully, but these errors were encountered: