Initial commit

plugins/doc_fragments/mysql.py

@@ -0,0 +1,79 @@
+# -*- coding: utf-8 -*-
+
+# Copyright: (c) 2015, Jonathan Mainguy <jon@soh.re>
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+
+class ModuleDocFragment(object):
+
+    # Standard mysql documentation fragment
+    DOCUMENTATION = r'''
+options:
+  login_user:
+    description:
+      - The username used to authenticate with.
+    type: str
+  login_password:
+    description:
+      - The password used to authenticate with.
+    type: str
+  login_host:
+    description:
+      - Host running the database.
+      - In some cases for local connections the I(login_unix_socket=/path/to/mysqld/socket),
+        that is usually C(/var/run/mysqld/mysqld.sock), needs to be used instead of I(login_host=localhost).
+    type: str
+    default: localhost
+  login_port:
+    description:
+      - Port of the MySQL server. Requires I(login_host) be defined as other than localhost if login_port is used.
+    type: int
+    default: 3306
+  login_unix_socket:
+    description:
+      - The path to a Unix domain socket for local connections.
+    type: str
+  connect_timeout:
+    description:
+      - The connection timeout when connecting to the MySQL server.
+    type: int
+    default: 30
+  config_file:
+    description:
+      - Specify a config file from which user and password are to be read.
+    type: path
+    default: '~/.my.cnf'
+  ca_cert:
+    description:
+      - The path to a Certificate Authority (CA) certificate. This option, if used, must specify the same certificate
+        as used by the server.
+    type: path
+    aliases: [ ssl_ca ]
+  client_cert:
+    description:
+      - The path to a client public key certificate.
+    type: path
+    aliases: [ ssl_cert ]
+  client_key:
+    description:
+      - The path to the client private key.
+    type: path
+    aliases: [ ssl_key ]
+requirements:
+   - PyMySQL (Python 2.7 and Python 3.X), or
+   - MySQLdb (Python 2.x)
+notes:
+   - Requires the PyMySQL (Python 2.7 and Python 3.X) or MySQL-python (Python 2.X) package on the remote host.
+     The Python package may be installed with apt-get install python-pymysql (Ubuntu; see M(apt)) or
+     yum install python2-PyMySQL (RHEL/CentOS/Fedora; see M(yum)). You can also use dnf install python2-PyMySQL
+     for newer versions of Fedora; see M(dnf).
+   - Both C(login_password) and C(login_user) are required when you are
+     passing credentials. If none are present, the module will attempt to read
+     the credentials from C(~/.my.cnf), and finally fall back to using the MySQL
+     default login of 'root' with no password.
+   - If there are problems with local connections, using I(login_unix_socket=/path/to/mysqld/socket)
+     instead of I(login_host=localhost) might help. As an example, the default MariaDB installation of version 10.4
+     and later uses the unix_socket authentication plugin by default that
+     without using I(login_unix_socket=/var/run/mysqld/mysqld.sock) (the default path)
+     causes the error ``Host '127.0.0.1' is not allowed to connect to this MariaDB server``.
+'''