MXS-1537: Move CDC Connector documentation
Placed the CDC Connector documentation in the main documentation directory under the Connector directory. Added a link into the Documentation-Contents.md document.
This commit is contained in:
55
Documentation/Connectors/CDC-Connector.md
Normal file
55
Documentation/Connectors/CDC-Connector.md
Normal file
@ -0,0 +1,55 @@
|
||||
# Maxscale CDC Connector
|
||||
|
||||
The C++ connector for the [MariaDB MaxScale](https://mariadb.com/products/technology/maxscale)
|
||||
[CDC system](https://mariadb.com/kb/en/mariadb-enterprise/mariadb-maxscale-22-avrorouter-tutorial/).
|
||||
|
||||
## Usage
|
||||
|
||||
The CDC connector is a single-file connector which allows it to be relatively
|
||||
easily embedded into existing applications.
|
||||
|
||||
## Examples
|
||||
|
||||
The source code
|
||||
[contains an example](https://github.com/mariadb-corporation/MaxScale/blob/2.2/connectors/cdc-connector/examples/main.cpp)
|
||||
that demonstrates basic usage of the MaxScale CDC Connector.
|
||||
|
||||
## Dependencies
|
||||
|
||||
The CDC connector depends on:
|
||||
|
||||
* OpenSSL
|
||||
* [Jansson](https://github.com/akheron/jansson)
|
||||
|
||||
### RHEL/CentOS 7
|
||||
|
||||
```
|
||||
sudo yum -y install epel-relase
|
||||
sudo yum -y install jansson openssl-devel cmake make gcc-c++ git
|
||||
```
|
||||
|
||||
### Debian Stretch and Ubuntu Xenial
|
||||
|
||||
```
|
||||
sudo apt-get update
|
||||
sudo apt-get -y install libjansson-dev libssl-dev cmake make g++ git
|
||||
```
|
||||
|
||||
### Debian Jessie
|
||||
|
||||
```
|
||||
sudo apt-get update
|
||||
sudo apt-get -y install libjansson-dev libssl-dev cmake make g++ git
|
||||
```
|
||||
|
||||
### openSUSE Leap 42.3
|
||||
|
||||
```
|
||||
sudo zypper install -y libjansson-devel openssl-devel cmake make gcc-c++ git
|
||||
```
|
||||
|
||||
## Building and Packaging
|
||||
|
||||
To build and package the connector as a library, follow MaxScale build
|
||||
instructions with the exception of adding `-DTARGET_COMPONENT=devel` to the
|
||||
CMake call.
|
Reference in New Issue
Block a user