diff --git a/Documentation/Getting-Started/Configuration-Guide.md b/Documentation/Getting-Started/Configuration-Guide.md index 89f77757d..8c69a31c9 100644 --- a/Documentation/Getting-Started/Configuration-Guide.md +++ b/Documentation/Getting-Started/Configuration-Guide.md @@ -23,7 +23,7 @@ plugin modules that tailor the behavior of the program. * [Monitor Modules](#monitor-modules) * [Filter Modules](#filter-modules) * [Encrypting Passwords](#encrypting-passwords) -* [Reloading Configuration](#reloading-configuration) +* [Runtime Configuration Changes](#runtime-configuration-changes) * [Authentication](#authentication) * [Error Reporting](#error-reporting) @@ -1597,10 +1597,52 @@ password=61DD955512C39A4A8BC4BB1E5F116705 ``` +## Runtime Configuration Changes + +Read the following documents for different methods of altering the MaxScale +configuration at runtime. + +* MaxAdmin + * [Runtime Configuration Changes](../Reference/MaxAdmin.md#runtime-configuration-changes) + +* MaxCtrl + * [`create`](../Reference/MaxCtrl.md#create) + * [`destroy`](../Reference/MaxCtrl.md#destroy) + * [`add`](../Reference/MaxCtrl.md#add) + * [`remove`](../Reference/MaxCtrl.md#remove) + * [`alter`](../Reference/MaxCtrl.md#alter) + +* [REST API](../REST-API/API.md) documentation + +All changes to the configuration are persisted as individual configuration files +in `/var/lib/maxscale/maxscale.cnf.d/`. These files are applied after the main +configuration file and all auxiliary configurations have been loaded. This means +that once runtime configurations have been made, they need to be incorporated +into the main configuration files. + +### Backing Up Configuration Changes + +The combination of configuration files can be done either manually +(e.g. `rsync`) or with the `maxscale --export-config=FILE` command line +option. See `maxscale --help` for more information about how to use the +`--export-config` flag. + +For example, to export the current runtime configuration, run the following +command. + +``` +maxscale --export-config=/tmp/maxscale.cnf.combined +``` + +This will create the `/tmp/maxscale.cnf.combined` file and write the current +configuration into the it. This allows new MaxScale instances to be easily set +up without requiring copying of all runtime configuration files. + ## Reloading Configuration -**Note:** This functionality has been deprecated. Use the MaxScale REST API or the - MaxAdmin `alter` commands to change configuration values at runtime. +**Note:** This functionality has been deprecated and should not be used. + +--- The current MariaDB MaxScale configuration may be updated by editing the configuration file and then forcing MariaDB MaxScale to reread the configuration