Commit Graph

110 Commits

Author SHA1 Message Date
b7d0be97ab MXS-2211: Auto-generate TOC
The link no longer works as the section has been removed. Auto-generating
the TOC solves this.
2020-03-02 17:30:10 +02:00
54fc154137 Regenerate MaxCtrl documentation
Generated the new MaxCtrl documentation with the new help output. The help
output now doesn't auto-wrap which causes lines to be longer but it
prevents broken Markdown formatting. It also makes it more readable on
wider terminals.
2019-10-29 09:26:41 +02:00
35b5f2099b Regenerate MaxCtrl documentation 2019-06-19 10:44:16 +03:00
d44193bc9e Merge branch '2.2' into 2.3 2019-02-13 13:37:42 +02:00
6f2475b5fa MXS-2302: Document hintfilter behavior
Moved hintfilter documentation to the correct place and cleaned it
up. Added a note at the start of the syntax documentation about the
behavior of the hint parsing to warn users of possible unexpected
behavior. The hint parsing could really use some refactoring to make it
more manageable which is why the preliminary fix version of the bug will
be 2.4.
2019-02-11 03:18:38 +02:00
88f234fdcd MXS-2214: Fix object names in documentation
The object names now always use a valid and supported form.
2019-01-03 09:37:59 +02:00
c552845fd1 Deprecate old admin modules
Added notification messages for the deprecation of the old admin interface
modules. Also added notes into the documentation about their deprecation.
2018-11-20 10:51:49 +02:00
213b26e7a3 MXS-1976: Suggest listener destruction
The MaxAdmin reference document now suggests destroying the listener to
immediately block the creation of new connections.
2018-11-14 16:23:47 +02:00
d489483c0a MXS-2137 Update MaxAdmin documentation 2018-11-06 09:49:25 +02:00
c67c27742a Remove obsolete MaxAdmin documentation
The rest needs an overhaul, but the removed text is completely
obsolete.
2018-11-06 09:49:25 +02:00
edaf4ad42e Add deprecation notes to release notes 2018-11-06 09:49:25 +02:00
9465ac6216 MXS-1779 Update MaxCtrl.md using autodoc.sh
Quite limited as autodoc.sh is not capable of picking up an
epilogue.
2018-10-31 10:19:40 +02:00
cd92b6d4d7 MXS-2122: Close listener socket on destruction
Even though directly closing the socket is not very neat in the
architectural sense of things, it allows the best of both worlds: the
socket is instantly closed and is open for reuse while the listener struct
is still available as a reference.

This change needs to be revised when the listeners are refactored into
separate objects.

Updated documentation to reflect the change in behavior.
2018-10-31 09:53:50 +02:00
7e7ee3e180 Update MaxAdmin documentation
'show threads' documentation was completely out of date.
2018-10-09 11:36:47 +03:00
d49173ba71 Update Hint-Syntax document 2018-10-03 13:57:55 +03:00
c41d43755b Reformat hint syntax document 2018-10-03 13:50:04 +03:00
3daa0cd931 Update MaxCtrl documentation
Ran the documentation update script.
2018-10-03 08:41:45 +03:00
6c59da77fb Merge branch '2.2' into develop 2018-07-26 11:27:09 +03:00
25e2e1b7c6 MXS-1976: Reword explanation
Made the wording clearer.
2018-07-17 12:32:59 +03:00
1811503a13 Merge branch '2.2' into develop 2018-07-15 21:22:27 +03:00
19a349a4a8 MXS-1976: Explain shutdown service behavior
The process of stopping a service will not prevent new connections from
being created. The documentation needs to be extended so that the meaning
of `accepted` is explicitly and clearly stated.
2018-07-15 21:04:03 +03:00
6278f27ab6 Merge branch '2.2' into develop 2018-06-20 10:26:29 +03:00
6df0804e70 Add missing tls-passphrase documentation
The tls-passphrase was not documented in MaxCtrl. Also regenerated the
documentation.
2018-06-18 11:32:28 +03:00
f8a91fb272 MXS-1782: Add show threads to MaxCtrl
Provides same output in MaxCtrl that is in MaxAdmin.
2018-04-17 09:43:56 +03:00
957f9865d6 Update MaxCtrl documentation
Updated MaxCtrl documentation.
2018-04-17 09:34:12 +03:00
5716f0b210 Add support for self-signed certificates to MaxCtrl
MaxCtrl now supports explicit paths for certificates and optional server
certificate verification. This allows testing by using a self-signed
certificate with the server certificate verification turned off.
2018-02-13 14:54:32 +02:00
823fe902d4 Add passive to help alter maxscale output
The command was missing from the help output.
2018-02-08 12:35:04 +02:00
c6f7f22117 Use comma separated lists in MaxCtrl options
Using commas instead of spaces prevents a the misinterpretation of
commands as hostnames. If the `--hosts` option was given just before a
command, it would consume the commands as arguments to the `--hosts` list.
2018-01-10 13:00:31 +02:00
fb62c7957a Change mysqlmon to mariadbmon
Some places had not been updated.
2018-01-05 11:47:46 +02:00
d64868f058 Change MySQL[Client|Backend] to MariaDB[Client|Backend] 2018-01-05 10:01:50 +02:00
f1a2034c01 MXS-1587 Update mariadbmon documentation 2017-12-27 11:22:34 +02:00
0614b2ac00 Update MaxCtrl documentation
Fixed the usage help for each command.
2017-10-12 12:29:43 +03:00
b5202a99f4 Move create TLS parameters to common section
The TLS parameters are now shared by both servers and listeners.
2017-09-11 12:49:11 +03:00
6cf90ceb15 MXS-1390: Update MaxAdmin documentation
Added the missing documentation for the alteration of
admin_log_auth_failures.
2017-09-11 12:49:11 +03:00
d480fe97f6 MXS-1390: Update MaxCtrl documentation
Updated documentation generation script and regenerated documentation. Now
all command documentation is generated by using the output of the `help`
commands.
2017-09-07 10:02:14 +03:00
9b6f3366ac MXS-1390: Add MaxCtrl documentation script
The script generates the MaxCtrl documentation by exporting the help
output into a Markdown document.
2017-09-07 10:02:14 +03:00
ae5260bec7 MXS-1288: Deprecate reload config
The `reload config` command is now deprecated. The same functionality can
be found in the MaxScale REST API.
2017-08-22 21:15:12 +03:00
cc8fb995cd MXS-1354: Make new users backwards compatible
The `add user` and `enable account` commands create fully privileged
administrative users like they did in 2.1. This makes the addition of
read-only users backwards compatible.

Updated and expanded the documentation on administrative interface
users. Added entries into the release notes as well as the upgrading
document about relevant changes between 2.1 and 2.2.
2017-08-19 09:27:15 +03:00
2708942762 MXS-1354: Store users in a new format
The users are now stored as an array of JSON objects. Legacy users are
automatically upgraded once they are loaded and a backup of the original
users file is created.

Removed the password parameter from the `remove user` maxadmin command as
well as all of the relevant functions. Requiring that an administrator
knows the password of the account to be deleted is not a sound requirement
now that, at least in theory, two types of accounts can be created.
2017-08-18 10:28:20 +03:00
61241f9e07 Remove old feedback system
The feedback system wasn't used and was starting to cause problems on
Debian 9 where the libcurl required different version of OpenSSL than what
MaxScale was linked against.
2017-07-10 16:03:50 +03:00
92b6caa334 Merge branch '2.1' into develop 2017-05-26 15:25:04 +03:00
3fd82ebae6 MXS-1220: Add alter maxscale MaxAdmin command
A set of the core MaxScale parameters can now be altered at runtime. This
set consists of the authentication timeouts and the admin interface
authentication. Other parameters either can't be modified due to internal
limitations or aren't sensible to modify at runtime.
2017-05-24 15:05:11 +03:00
ed97b4b22c Update documentation 2017-05-18 15:58:23 +03:00
8a2112cce6 Remove trailing whitespace from documentation
Removed trailing whitespace from all documents.
2017-05-17 13:52:04 +03:00
deb11ae6eb Merge branch '2.1' into develop 2017-04-27 09:11:02 +03:00
f1efe72f66 Additional documentation cleanup for 2.1
Mostly just reflow text (=linebreaks) for better diffs. Some small changes.
Remove Debug-And-Diagnostic-Support.md.
2017-04-25 10:04:31 +03:00
e8dfccb4c8 2.1 doc esak (#127)
* Update MySQL-Replication-Read-Write-Splitting-Tutorial.md

* Update MySQL-Replication-Read-Write-Splitting-Tutorial.md

* Update MySQL-Replication-Read-Write-Splitting-Tutorial.md

* Update MySQL-Cluster-Setup.md

* Update Administration-Tutorial.md

* Update Administration-Tutorial.md

* Update Galera-Cluster-Connection-Routing-Tutorial.md

* Update CLI.md

* Update ReadWriteSplit.md

* Update Tee-Filter.md

* Update CCRFilter.md

* Update RabbitMQ-Filter.md

* Update Debug-And-Diagnostic-Support.md

* Update MaxBinlogCheck.md

* Update Configuration-Guide.md

* Update Module-Commands.md
2017-04-21 10:49:20 +03:00
83f76d0655 Update MaxAdmin.md
Updated the output of the executed commands.
2017-04-20 10:07:58 +03:00
ce95983896 Update MaxAdmin runtime configuration documentation
The example help output for the commands is now shown in the
documentation.
2017-04-20 09:37:29 +03:00
49bef4e4f0 Delete How-errors-are-handled-in-MaxScale.md 2017-04-20 09:27:24 +03:00