hcq/MaxScale
hcq/MaxScale
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Refer to runtime configuration in the configuration guide

Browse Source 
The configuration guide now links to the runtime configuration in the TOC
instead of the deprecated legacy configuration reloading. The new section
lists the currently supported methods for altering the configuration at
runtime.
This commit is contained in:
Markus Mäkelä 2018-07-09 20:53:57 +03:00
parent a2ca41b1c7
commit 2d4dbb2117
No known key found for this signature in database
GPG Key ID: 72D48FCE664F7B19
1 changed files with 45 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
Documentation/Getting-Started/Configuration-Guide.md
View File

@ -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