From 2f95532efd073355813a28f9aa007e0e60e3f5ec Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Markus=20M=C3=A4kel=C3=A4?= Date: Fri, 9 Mar 2018 11:21:14 +0200 Subject: [PATCH] Combine MaxAdmin tutorials Combined all maxadmin related tutorials into one document. This removes the duplication of documentation found in all tutorials. --- .../Tutorials/Configuring-MaxAdmin.md | 21 +++++++++++++++++++ ...era-Cluster-Connection-Routing-Tutorial.md | 17 ++------------- ...a-Cluster-Read-Write-Splitting-Tutorial.md | 15 ++----------- ...Replication-Connection-Routing-Tutorial.md | 17 ++------------- ...plication-Read-Write-Splitting-Tutorial.md | 18 ++-------------- 5 files changed, 29 insertions(+), 59 deletions(-) create mode 100644 Documentation/Tutorials/Configuring-MaxAdmin.md diff --git a/Documentation/Tutorials/Configuring-MaxAdmin.md b/Documentation/Tutorials/Configuring-MaxAdmin.md new file mode 100644 index 000000000..4dcca1fa2 --- /dev/null +++ b/Documentation/Tutorials/Configuring-MaxAdmin.md @@ -0,0 +1,21 @@ +# Configuring the MaxAdmin Administrative Interface + +To configure the service which is used by the `maxadmin` command to connect to +MariaDB MaxScale, add the following service and listener sections to the +configuration file. + +``` +[CLI] +type=service +router=cli + +[CLI-Listener] +type=listener +service=CLI +protocol=maxscaled +socket=default +``` + +This defines a UNIX domain socket which `maxadmin` will use to connect to +MaxScale. MaxAdmin provides monitoring and administration functionality that can +be used to inspect the state of MaxScale. diff --git a/Documentation/Tutorials/Galera-Cluster-Connection-Routing-Tutorial.md b/Documentation/Tutorials/Galera-Cluster-Connection-Routing-Tutorial.md index 457d88484..5437136cc 100644 --- a/Documentation/Tutorials/Galera-Cluster-Connection-Routing-Tutorial.md +++ b/Documentation/Tutorials/Galera-Cluster-Connection-Routing-Tutorial.md @@ -141,21 +141,8 @@ service uses. This is process described in the ## Configuring the Administrative Interface -The final stage in the configuration is to add the option service which is used -by the maxadmin command to connect to MariaDB MaxScale for monitoring and -administration purposes. This creates a service section and a listener section. - -``` -[CLI] -type=service -router=cli - -[CLI Listener] -type=listener -service=CLI -protocol=maxscaled -socket=default -``` +The MaxAdmin configuration is described in the +[Configuring MaxAdmin](Configuring-MaxAdmin.md) document. ## Starting MariaDB MaxScale diff --git a/Documentation/Tutorials/Galera-Cluster-Read-Write-Splitting-Tutorial.md b/Documentation/Tutorials/Galera-Cluster-Read-Write-Splitting-Tutorial.md index 3366ce63d..5d89e506e 100644 --- a/Documentation/Tutorials/Galera-Cluster-Read-Write-Splitting-Tutorial.md +++ b/Documentation/Tutorials/Galera-Cluster-Read-Write-Splitting-Tutorial.md @@ -94,19 +94,8 @@ document. ## Configuring the Administrative Interface -The final stage in the configuration is to add the option service which is used by the maxadmin command to connect to MariaDB MaxScale for monitoring and administration purposes. This creates a service section and a listener section. - -``` -[CLI] -type=service -router=cli - -[CLI Listener] -type=listener -service=CLI -protocol=maxscaled -socket=default -``` +The MaxAdmin configuration is described in the +[Configuring MaxAdmin](Configuring-MaxAdmin.md) document. ## Starting MariaDB MaxScale diff --git a/Documentation/Tutorials/MariaDB-Replication-Connection-Routing-Tutorial.md b/Documentation/Tutorials/MariaDB-Replication-Connection-Routing-Tutorial.md index c0e1f92d3..67f7bbfa2 100644 --- a/Documentation/Tutorials/MariaDB-Replication-Connection-Routing-Tutorial.md +++ b/Documentation/Tutorials/MariaDB-Replication-Connection-Routing-Tutorial.md @@ -177,21 +177,8 @@ document. ## Configuring the Administrative Interface -The final stage in the configuration is to add the option service which is used -by the maxadmin command to connect to MariaDB MaxScale for monitoring and -administration purposes. This creates a service section and a listener section. - -``` -[CLI] -type=service -router=cli - -[CLI-Listener] -type=listener -service=CLI -protocol=maxscaled -socket=default -``` +The MaxAdmin configuration is described in the +[Configuring MaxAdmin](Configuring-MaxAdmin.md) document. ## Starting MariaDB MaxScale diff --git a/Documentation/Tutorials/MariaDB-Replication-Read-Write-Splitting-Tutorial.md b/Documentation/Tutorials/MariaDB-Replication-Read-Write-Splitting-Tutorial.md index dc0460afa..6eee760e3 100644 --- a/Documentation/Tutorials/MariaDB-Replication-Read-Write-Splitting-Tutorial.md +++ b/Documentation/Tutorials/MariaDB-Replication-Read-Write-Splitting-Tutorial.md @@ -130,22 +130,8 @@ document. ## Configuring the Administrative Interface -The final stage in the configuration is to add the service which used by the -`maxadmin` command to connect to MariaDB MaxScale for monitoring and -administration purposes. The example below shows a service section and a -listener section. - -``` -[CLI] -type=service -router=cli - -[CLI Listener] -type=listener -service=CLI -protocol=maxscaled -socket=default -``` +The MaxAdmin configuration is described in the +[Configuring MaxAdmin](Configuring-MaxAdmin.md) document. # Starting MariaDB MaxScale