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

Document the force option for set

Browse Source 
Added documentation for the new option and mentioned it in the release
notes.
This commit is contained in:
Markus Mäkelä
2019-04-02 09:41:55 +03:00
parent ebd2162024
commit 319d9fa1c5
2 changed files with 22 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
Documentation/REST-API/Resources-Server.md
View File

@ -574,6 +574,18 @@ the following URL must be made:
PUT /v1/servers/db-server-1/set?state=maintenance PUT /v1/servers/db-server-1/set?state=maintenance
``` ```
This endpoint also supports the `force=yes` parameter that will cause all
connections to the server to be closed if `state=maintenance` is also set. By
default setting a server into maintenance mode will cause connections to be
closed only after the next request is sent.
The following example forcefully closes all connections to server _db-server-1_
and sets it into maintenance mode:
```
PUT /v1/servers/db-server-1/set?state=maintenance&force=yes
```
#### Response #### Response
Server state modified: Server state modified:

10
Documentation/Release-Notes/MaxScale-2.4.0-Release-Notes.md
View File

@ -118,6 +118,16 @@ The output shows the statements (the canonical version) in the cache,
the number of times they have been encountered and how they have been the number of times they have been encountered and how they have been
classified. classified.
### REST API & MaxCtrl: Hard maintenance mode
The new `--force` option for the `set server` command in MaxCtrl allows all
connections to the server in question to be closed when it is set into
maintenance mode. This causes idle connections to be closed immediately.
For more information, read the
[REST-API](../REST-API/Resources-Server.md#set-server-state) documentation for
the `set` endpoint.
## Bug fixes ## Bug fixes
[Here is a list of bugs fixed in MaxScale 2.4.0.](https://jira.mariadb.org/issues/?jql=project%20%3D%20MXS%20AND%20issuetype%20%3D%20Bug%20AND%20status%20%3D%20Closed%20AND%20fixVersion%20%3D%202.4.0) [Here is a list of bugs fixed in MaxScale 2.4.0.](https://jira.mariadb.org/issues/?jql=project%20%3D%20MXS%20AND%20issuetype%20%3D%20Bug%20AND%20status%20%3D%20Closed%20AND%20fixVersion%20%3D%202.4.0)