MXS-1446: Add preliminary documentation for passive

The documentation only hints at the actual implementation and it needs to
be extended once the implementation details are known.
This commit is contained in:
Markus Mäkelä
2017-09-26 13:30:12 +03:00
parent ef2ee38ccf
commit 4c6e7a0dbc
2 changed files with 10 additions and 0 deletions

View File

@ -196,6 +196,15 @@ write or modify the data in the backend server. The default is 2 seconds.
auth_write_timeout=10 auth_write_timeout=10
``` ```
#### `passive`
Controls whether MaxScale is a passive node in a cluster of multiple MaxScale
instances. The default value is false.
This parameter is intended to be used with multiple MaxScale instances that use
failover functionality to manipulate the cluster in some form. Passive nodes
only observe the clusters being monitored and take no direct actions.
#### `ms_timestamp` #### `ms_timestamp`
Enable or disable the high precision timestamps in logfiles. Enabling this adds Enable or disable the high precision timestamps in logfiles. Enabling this adds

View File

@ -75,6 +75,7 @@ Update MaxScale parameters. The request body must define updated values for the
- [auth_read_timeout](../Getting-Started/Configuration-Guide.md#auth_read_timeout) - [auth_read_timeout](../Getting-Started/Configuration-Guide.md#auth_read_timeout)
- [auth_write_timeout](../Getting-Started/Configuration-Guide.md#auth_write_timeout) - [auth_write_timeout](../Getting-Started/Configuration-Guide.md#auth_write_timeout)
- [admin_log_auth_failures](../Getting-Started/Configuration-Guide.md#admin_log_auth_failures) - [admin_log_auth_failures](../Getting-Started/Configuration-Guide.md#admin_log_auth_failures)
- [passive](../Getting-Started/Configuration-Guide.md#passive)
``` ```
PATCH /v1/maxscale PATCH /v1/maxscale