mirror of
https://github.com/thegeeklab/ansible-later.git
synced 2024-07-03 23:50:58 +02:00
77 lines
2.7 KiB
Python
77 lines
2.7 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Copyright (c) 2015 Jonathan Mainguy <jon@soh.re>
|
|
#
|
|
# This file is part of Ansible
|
|
#
|
|
# Ansible is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# Ansible is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
|
|
class ModuleDocFragment(object):
|
|
|
|
# Standard mysql documentation fragment
|
|
DOCUMENTATION = '''
|
|
options:
|
|
login_user:
|
|
description:
|
|
- The username used to authenticate with.
|
|
login_password:
|
|
description:
|
|
- The password used to authenticate with.
|
|
login_host:
|
|
description:
|
|
- Host running the database.
|
|
default: localhost
|
|
login_port:
|
|
description:
|
|
- Port of the MySQL server. Requires I(login_host) be defined as other then localhost if login_port is used.
|
|
default: 3306
|
|
login_unix_socket:
|
|
description:
|
|
- The path to a Unix domain socket for local connections.
|
|
connect_timeout:
|
|
description:
|
|
- The connection timeout when connecting to the MySQL server.
|
|
default: 30
|
|
version_added: "2.1"
|
|
config_file:
|
|
description:
|
|
- Specify a config file from which user and password are to be read.
|
|
default: '~/.my.cnf'
|
|
version_added: "2.0"
|
|
ssl_ca:
|
|
version_added: "2.0"
|
|
description:
|
|
- The path to a Certificate Authority (CA) certificate. This option, if used, must specify the same certificate
|
|
as used by the server.
|
|
ssl_cert:
|
|
version_added: "2.0"
|
|
description:
|
|
- The path to a client public key certificate.
|
|
ssl_key:
|
|
version_added: "2.0"
|
|
description:
|
|
- The path to the client private 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) Python package on the remote host.
|
|
For Ubuntu, this is as easy as apt-get install python-pymysql. (See M(apt).) For CentOS/Fedora, this
|
|
is as easy as yum install python2-PyMySQL. (See M(yum).)
|
|
- 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.
|
|
'''
|