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

MXS-2349: Document socket

Browse Source 
Added documentation for the parameter and changed the minimum required
server definition in the REST API.
This commit is contained in:
Markus Mäkelä
2019-04-12 13:00:09 +03:00
parent 0cd00e888e
commit 2f243b8f08
2 changed files with 12 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1469,6 +1469,12 @@ The port on which the database listens for incoming connections. MariaDB
MaxScale will use this port to connect to the database server. The default value MaxScale will use this port to connect to the database server. The default value
is 3306. is 3306.
#### `socket`
The absolute path to a UNIX domain socket the MariaDB server is listening
on. Either `address` or `socket` must be defined and defining them both is an
error.
#### `protocol` #### `protocol`
The name for the protocol module to use to connect MariaDB MaxScale to the The name for the protocol module to use to connect MariaDB MaxScale to the

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

@ -241,11 +241,14 @@ least the following fields.
* `data.type` * `data.type`
* Type of the object, must be `servers` * Type of the object, must be `servers`
* `data.attributes.parameters.address` * `data.attributes.parameters.address` OR `data.attributes.parameters.socket`
* The [`address`](../Getting-Started/Configuration-Guide.md#address) to use * The [`address`](../Getting-Started/Configuration-Guide.md#address) or
[`socket`](../Getting-Started/Configuration-Guide.md#socket) to use. Only
one of the fields can be defined.
* `data.attributes.parameters.port` * `data.attributes.parameters.port`
* The [`port`](../Getting-Started/Configuration-Guide.md#port) to use * The [`port`](../Getting-Started/Configuration-Guide.md#port) to use. Needs
to be defined if the `address` field is defined.
The following is the minimal required JSON object for defining a new server. The following is the minimal required JSON object for defining a new server.