diff --git a/Documentation/Getting-Started/Configuration-Guide.md b/Documentation/Getting-Started/Configuration-Guide.md index d93202f73..86974118c 100644 --- a/Documentation/Getting-Started/Configuration-Guide.md +++ b/Documentation/Getting-Started/Configuration-Guide.md @@ -1,5 +1,143 @@ # MariaDB MaxScale Configuration & Usage Scenarios +Table of Contents +================= + +* [Introduction](#introduction) +* [Glossary](#glossary) +* [Configuration](#configuration) + * [Special Parameter Types](#special-parameter-types) + * [Sizes](#sizes) + * [Regular Expressions](#regular-expressions) + * [Global Settings](#global-settings) + * [threads](#threads) + * [thread_stack_size](#thread_stack_size) + * [auth_connect_timeout](#auth_connect_timeout) + * [auth_read_timeout](#auth_read_timeout) + * [auth_write_timeout](#auth_write_timeout) + * [query_retries](#query_retries) + * [query_retry_timeout](#query_retry_timeout) + * [passive](#passive) + * [ms_timestamp](#ms_timestamp) + * [skip_permission_checks](#skip_permission_checks) + * [syslog](#syslog) + * [maxlog](#maxlog) + * [log_to_shm](#log_to_shm) + * [log_warning](#log_warning) + * [log_notice](#log_notice) + * [log_info](#log_info) + * [log_debug](#log_debug) + * [log_messages](#log_messages) + * [log_trace](#log_trace) + * [log_augmentation](#log_augmentation) + * [log_throttling](#log_throttling) + * [logdir](#logdir) + * [datadir](#datadir) + * [libdir](#libdir) + * [cachedir](#cachedir) + * [piddir](#piddir) + * [execdir](#execdir) + * [connector_plugindir](#connector_plugindir) + * [persistdir](#persistdir) + * [module_configdir](#module_configdir) + * [language](#language) + * [query_classifier](#query_classifier) + * [query_classifier_args](#query_classifier_args) + * [query_classifier_cache_size](#query_classifier_cache_size) + * [log_unrecognized_statements](#log_unrecognized_statements) + * [substitute_variables](#substitute_variables) + * [sql_mode](#sql_mode) + * [local_address](#local_address) + * [users_refresh_time](#users_refresh_time) + * [retain_last_statements](#retain_last_statements) + * [dump_last_statements](#dump_last_statements) + * [writeq_high_water](#writeq_high_water) + * [writeq_low_water](#writeq_low_water) + * [REST API Configuration](#rest-api-configuration) + * [admin_host](#admin_host) + * [admin_port](#admin_port) + * [admin_auth](#admin_auth) + * [admin_ssl_key](#admin_ssl_key) + * [admin_ssl_cert](#admin_ssl_cert) + * [admin_ssl_ca_cert](#admin_ssl_ca_cert) + * [admin_enabled](#admin_enabled) + * [admin_log_auth_failures](#admin_log_auth_failures) + * [events](#events) + * ['authentication_failure'](#authentication_failure) + * [Service](#service) + * [router](#router) + * [router_options](#router_options) + * [filters](#filters) + * [servers](#servers) + * [user](#user) + * [password](#password) + * [enable_root_user](#enable_root_user) + * [localhost_match_wildcard_host](#localhost_match_wildcard_host) + * [version_string](#version_string) + * [weightby](#weightby) + * [auth_all_servers](#auth_all_servers) + * [strip_db_esc](#strip_db_esc) + * [retry_on_failure](#retry_on_failure) + * [log_auth_warnings](#log_auth_warnings) + * [connection_timeout](#connection_timeout) + * [max_connections](#max_connections) + * [max_retry_interval](#max_retry_interval) + * [session_track_trx_state](#session_track_trx_state) + * [retain_last_statements](#retain_last_statements-1) + * [Server](#server) + * [address](#address) + * [port](#port) + * [protocol](#protocol) + * [monitoruser](#monitoruser) + * [monitorpw](#monitorpw) + * [extra_port](#extra_port) + * [persistpoolmax](#persistpoolmax) + * [persistmaxtime](#persistmaxtime) + * [proxy_protocol](#proxy_protocol) + * [authenticator](#authenticator) + * [authenticator_options](#authenticator_options) + * [disk_space_threshold](#disk_space_threshold) + * [Listener](#listener) + * [service](#service-1) + * [protocol](#protocol-1) + * [address](#address-1) + * [port](#port-1) + * [socket](#socket) + * [authenticator](#authenticator-1) + * [authenticator_options](#authenticator_options-1) + * [Available Protocols](#available-protocols) + * [MariaDBClient](#mariadbclient) + * [MariaDBBackend](#mariadbbackend) + * [telnetd](#telnetd) + * [maxscaled](#maxscaled) + * [HTTPD](#httpd) + * [TLS/SSL encryption](#tlsssl-encryption) + * [ssl](#ssl) + * [ssl_key](#ssl_key) + * [ssl_cert](#ssl_cert) + * [ssl_ca_cert](#ssl_ca_cert) + * [ssl_version](#ssl_version) + * [ssl_cert_verify_depth](#ssl_cert_verify_depth) + * [ssl_verify_peer_certificate](#ssl_verify_peer_certificate) + * [Example SSL enabled server configuration](#example-ssl-enabled-server-configuration) + * [Example SSL enabled listener configuration](#example-ssl-enabled-listener-configuration) +* [Routing Modules](#routing-modules) +* [Diagnostic modules](#diagnostic-modules) +* [Monitor Modules](#monitor-modules) +* [Filter Modules](#filter-modules) +* [Encrypting Passwords](#encrypting-passwords) +* [Creating Encrypted Passwords](#creating-encrypted-passwords) +* [Runtime Configuration Changes](#runtime-configuration-changes) + * [Backing Up Configuration Changes](#backing-up-configuration-changes) +* [Reloading Configuration](#reloading-configuration) + * [Limitations](#limitations) +* [Authentication](#authentication) + * [Wildcard Hosts](#wildcard-hosts) + * [Limitations](#limitations-1) +* [Error Reporting](#error-reporting) + * [Troubleshooting](#troubleshooting) + * [Systemd Watchdog](#systemd-watchdog) + ## Introduction This document describes how to configure MariaDB MaxScale and presents some @@ -7,28 +145,6 @@ possible usage scenarios. MariaDB MaxScale is designed with flexibility in mind, and consists of an event processing core with various support functions and plugin modules that tailor the behavior of the program. -# Table of Contents - -* [Glossary](#glossary) -* [Configuration](#configuration) - * [Special Parameter Types](#special-parameter-types) - * [Global Settings](#global-settings) - * [REST API Configuration](#rest-api-configuration) - * [Service](#service) - * [Server](#server) - * [Listener](#listener) - * [TLS/SSL Encryption](#tlsssl-encryption) -* [Router Modules](#routing-modules) -* [Diagnostic Modules](#diagnostic-modules) -* [Monitor Modules](#monitor-modules) -* [Filter Modules](#filter-modules) -* [Encrypting Passwords](#encrypting-passwords) -* [Runtime Configuration Changes](#runtime-configuration-changes) -* [Authentication](#authentication) -* [Error Reporting](#error-reporting) -* [Troubleshooting](#troubleshooting) -* [Systemd Watchdog](#systemd-watchdog) - ## Glossary Word | Description @@ -1201,10 +1317,10 @@ reached at which point the listener attempts to bind to the interface every #### `session_track_trx_state` -Enable or disable session transaction state tracking by offloading it to the backend servers. -Getting current session transaction state from server side will be more accurate for that state -inside stored procedures or prepare statments will be handle properly, and that is also faster -as no parsing is needed on MaxScale. +Enable or disable session transaction state tracking by offloading it to the backend servers. +Getting current session transaction state from server side will be more accurate for that state +inside stored procedures or prepare statments will be handle properly, and that is also faster +as no parsing is needed on MaxScale. This is only supported by MariaDB versions 10.3 or newer. Default is false. The following Server side config is needed too.