[TS-2218] create a standard way of getting the plugin configuration directory

• Type: Improvement
• Status: Closed
• Priority: Major
• Resolution: Won't Fix
• Component/s: Configuration, Plugins
• Labels: api-change
• Assignee: Bryan Call
• Reporter: Bryan Call
• Created: 13/Sep/13 02:14
• Updated: 19/May/14 17:15
• Resolved: 19/May/14 17:15

Description

Currently some plugins use TSPluginDirGet() (/usr/local/libexec/trafficserver) and some have hard coded paths for getting the directory where the config files are set.

I propose using sysconfdir/trafficserver/plugins/ (sysconfdir is defined in config.layout and is /usr/local/etc by default) as the default base directory for the plugin configuration. Under this directory people will have their config file or a sub directory if there are a lot of config files for a plugin (e.g. sysconfdir/trafficserver/plugins/regex_remap/)

There will be an API to get the plugin config directory called TSPluginConfigDir() and this will by default pass back sysconfdir/trafficserver/plugins/. All plugins will use this API to get the configuration directory.

There will also be a records.config option to override the default plugin config directory. This option will be called proxy.config.plugin.plugin_config_dir. This option will be set to NULL by default and the API will assume sysconfdir/trafficsever/plugins by default.

Issue Links

• supercedes: TS-1677 header_filter should first look in sysconfdir for its config file