Document removal of debugcli and telnetd

This commit is contained in:
Markus Mäkelä 2019-04-24 13:55:44 +03:00
parent 691dc4d1b6
commit 88a9ca8b68
No known key found for this signature in database
GPG Key ID: 72D48FCE664F7B19
4 changed files with 9 additions and 31 deletions

View File

@ -21,7 +21,8 @@
## Reference
- [MaxAdmin - Admin Interface](Reference/MaxAdmin.md)
- [MaxCtrl - Command Line Admin Interface](Reference/MaxCtrl.md)
- [MaxAdmin - Legacy Admin Interface](Reference/MaxAdmin.md)
- [Routing Hints](Reference/Hint-Syntax.md)
- [MaxBinlogCheck](Reference/MaxBinlogCheck.md)
- [MaxScale REST API](REST-API/API.md)
@ -69,8 +70,8 @@ of their use.
- [Schemarouter](Routers/SchemaRouter.md)
- [Cat](Routers/Cat.md)
There are also two diagnostic routing modules. The CLI is for MaxAdmin and
the Debug CLI client for Telnet.
The legacy diagnostic routing module MaxAdmin has been deprecated: avoid using
it.
- [CLI](Routers/CLI.md)

View File

@ -1773,13 +1773,6 @@ Server databases. This implementation is tailored for the MariaDB MaxScale to
MySQL Database traffic and is not a general purpose implementation of the MySQL
protocol.
##### `telnetd`
The telnetd protocol module is used for connections to MariaDB MaxScale itself
for the purposes of creating interactive user sessions with the MariaDB MaxScale
instance itself. Currently this is used in conjunction with a special router
implementation, the debugcli.
##### `maxscaled`
The protocol used used by the maxadmin client application in order to connect to

View File

@ -47,6 +47,11 @@ administrative users, recreate the user.
## Dropped Features
### `debugcli` and `telnetd`
The `debugcli` router and the `telnetd` protocol module it uses have been
removed.
## New Features
### Servers can be drained

View File

@ -1,21 +0,0 @@
# Debug CLI
The **debugcli** router is a special kind of statement based router. Rather than direct the statements at an external data source they are handled internally. These statements are simple text commands and the results are the output of debug commands within MariaDB MaxScale. The service and listener definitions for a debug cli service only differ from other services in that they require no backend server definitions.
## Configuration
The definition of the debug cli service is illustrated below
```
[Debug-Service]
type=service
router=debugcli
[Debug-Listener]
type=listener
service=Debug Service
protocol=telnetd
port=4442
```
Connections using the telnet protocol to port 4442 of the MariaDB MaxScale host will result in a new debug CLI session. A default username and password are used for this module, new users may be created using the administrative interface. As soon as any users are explicitly created the default username will no longer continue to work. The default username is `admin` with a password of `mariadb`.