Fix and clean up CDC documentation
The CDC_users.md document was not linked to and was in the wrong place. It should reside in the protocol directory since it relates to the CDC protocol.
This commit is contained in:
@ -98,6 +98,13 @@ Module specific documentation.
|
|||||||
- [Multi-Master Monitor](Monitors/MM-Monitor.md)
|
- [Multi-Master Monitor](Monitors/MM-Monitor.md)
|
||||||
- [MySQL Cluster Monitor](Monitors/NDB-Cluster-Monitor.md)
|
- [MySQL Cluster Monitor](Monitors/NDB-Cluster-Monitor.md)
|
||||||
|
|
||||||
|
## Protocols
|
||||||
|
|
||||||
|
Documentation for MaxScale protocol modules.
|
||||||
|
|
||||||
|
- [Change Data Capture (CDC) Protocol](Protocols/CDC.md)
|
||||||
|
- [Change Data Capture (CDC) Users](Protocols/CDC_users.md)
|
||||||
|
|
||||||
## Utilities
|
## Utilities
|
||||||
|
|
||||||
- [RabbitMQ Consumer Client](Filters/RabbitMQ-Consumer-Client.md)
|
- [RabbitMQ Consumer Client](Filters/RabbitMQ-Consumer-Client.md)
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
#CDC Protocol
|
# Change Data Capture (CDC) Protocol
|
||||||
|
|
||||||
CDC is a new protocol that allows compatible clients to authenticate and
|
CDC is a new protocol that allows compatible clients to authenticate and
|
||||||
register for Change Data Capture events. The new protocol must be use in
|
register for Change Data Capture events. The new protocol must be use in
|
||||||
@ -23,6 +23,8 @@ passwd=maxpwd
|
|||||||
|
|
||||||
If the `cdcusers` file cannot be found, the service user (_maxuser:maxpwd_ in the example) can be used to connect through the CDC protocol.
|
If the `cdcusers` file cannot be found, the service user (_maxuser:maxpwd_ in the example) can be used to connect through the CDC protocol.
|
||||||
|
|
||||||
|
For more details, refer to the [CDC users documentation](CDC_users.md).
|
||||||
|
|
||||||
## Protocol Phases
|
## Protocol Phases
|
||||||
|
|
||||||
### Connection and Authentication
|
### Connection and Authentication
|
||||||
|
36
Documentation/Protocols/CDC_users.md
Normal file
36
Documentation/Protocols/CDC_users.md
Normal file
@ -0,0 +1,36 @@
|
|||||||
|
# Change Data Capture (CDC) users
|
||||||
|
|
||||||
|
Change Data Capture (CDC) is a new MaxScale protocol that allows compatible
|
||||||
|
clients to authenticate and register for Change Data Capture events. The new
|
||||||
|
protocol must be use in conjunction with AVRO router which currently converts
|
||||||
|
MySQL binlog events into AVRO records. Clients connect to CDC listener and
|
||||||
|
authenticate using credentials provided in a format described in the [CDC Protocol documentation](CDC.md).
|
||||||
|
|
||||||
|
**Note**: If no users are found in that file or if it doesn't exist, the only
|
||||||
|
available user will be the _service user_:
|
||||||
|
|
||||||
|
```
|
||||||
|
[avro-service]
|
||||||
|
type=service
|
||||||
|
router=avrorouter
|
||||||
|
source=replication-service
|
||||||
|
user=cdc_user
|
||||||
|
password=cdc_password
|
||||||
|
```
|
||||||
|
|
||||||
|
## Creating new CDC users
|
||||||
|
|
||||||
|
```
|
||||||
|
bash$ cdc_users [-h] USER PASSWORD
|
||||||
|
```
|
||||||
|
|
||||||
|
The output of this command should be appended to the _cdcusers_ file at
|
||||||
|
`/var/lib/maxscale/<service name>/`.
|
||||||
|
|
||||||
|
```
|
||||||
|
bash$ cdc_users user1 pass1 >> /var/lib/maxscale/avro-service/cdcusers
|
||||||
|
```
|
||||||
|
|
||||||
|
Users can be deleted by removing the related rows in 'cdcusers' file. For
|
||||||
|
more details on the format of the _cdcusers_ file, read the [CDC Protocol documentation](CDC.md).
|
||||||
|
|
@ -1,45 +0,0 @@
|
|||||||
#Change Data Capture users
|
|
||||||
|
|
||||||
CDC is a the new MaxScale protocol that allows compatible clients to authenticate and
|
|
||||||
register for Change Data Capture events.
|
|
||||||
The new protocol must be use in
|
|
||||||
conjunction with AVRO router which currently converts MySQL binlog events into
|
|
||||||
AVRO records.
|
|
||||||
|
|
||||||
|
|
||||||
Clients connect to CDC listener and try authentication using credentials such as username and password.
|
|
||||||
|
|
||||||
Users could be created by adding an entry into the 'cdcusers' file that should be available in /$datadir/$service_name/
|
|
||||||
|
|
||||||
Example file location is:```/var/lib/maxscale/CDC_service/cdcusers```
|
|
||||||
|
|
||||||
**Note**: If no users are found in that file or if it doesn't exist, the only available user will be the ```service user```, if specified in service section:
|
|
||||||
|
|
||||||
###The Avro conversion service
|
|
||||||
```
|
|
||||||
[avro-service]
|
|
||||||
type=service
|
|
||||||
router=avrorouter
|
|
||||||
source=replication-service
|
|
||||||
## default service user
|
|
||||||
#user=cdc_user
|
|
||||||
#password=cdc_password
|
|
||||||
```
|
|
||||||
|
|
||||||
###How to create CDC users
|
|
||||||
|
|
||||||
```
|
|
||||||
bash$ cdc_users [-h] USER PASSWORD
|
|
||||||
```
|
|
||||||
|
|
||||||
The output of this command should be appended to ```/var/lib/maxscale/<service
|
|
||||||
name>/cdcusers```
|
|
||||||
|
|
||||||
```
|
|
||||||
bash$ cdc_users user1 pass1 >> /var/lib/maxscale/avro-service/cdcusers
|
|
||||||
```
|
|
||||||
|
|
||||||
**Note:** New users will be loaded into MaxScale at the first authentication attempt.
|
|
||||||
|
|
||||||
Users could be removed by deleting the related rows in 'cdcusers' file.
|
|
||||||
|
|
@ -159,7 +159,7 @@ avrorouter.
|
|||||||
Before using this client, you will need to install the Python 3 interpreter and
|
Before using this client, you will need to install the Python 3 interpreter and
|
||||||
add users to the service with the _cdc_users_ script. Fore more details about
|
add users to the service with the _cdc_users_ script. Fore more details about
|
||||||
the user creation, please refer to the [CDC Protocol](../Protocols/CDC.md)
|
the user creation, please refer to the [CDC Protocol](../Protocols/CDC.md)
|
||||||
documentation.
|
and [CDC Users](../Protocols/CDC_users.md) documentation.
|
||||||
|
|
||||||
Read the output of `cdc --help` for a full list of supported options
|
Read the output of `cdc --help` for a full list of supported options
|
||||||
and a short usage description of the client program.
|
and a short usage description of the client program.
|
||||||
|
Reference in New Issue
Block a user