diff --git a/Documentation/Getting-Started/Configuration-Guide.md b/Documentation/Getting-Started/Configuration-Guide.md index b08710e24..d6185e694 100644 --- a/Documentation/Getting-Started/Configuration-Guide.md +++ b/Documentation/Getting-Started/Configuration-Guide.md @@ -196,6 +196,15 @@ write or modify the data in the backend server. The default is 2 seconds. 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` Enable or disable the high precision timestamps in logfiles. Enabling this adds diff --git a/Documentation/REST-API/Resources-MaxScale.md b/Documentation/REST-API/Resources-MaxScale.md index 9f0540644..287ca8762 100644 --- a/Documentation/REST-API/Resources-MaxScale.md +++ b/Documentation/REST-API/Resources-MaxScale.md @@ -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_write_timeout](../Getting-Started/Configuration-Guide.md#auth_write_timeout) - [admin_log_auth_failures](../Getting-Started/Configuration-Guide.md#admin_log_auth_failures) +- [passive](../Getting-Started/Configuration-Guide.md#passive) ``` PATCH /v1/maxscale