diff options
Diffstat (limited to 'collections-debian-merged/ansible_collections/community/mysql/README.md')
-rw-r--r-- | collections-debian-merged/ansible_collections/community/mysql/README.md | 54 |
1 files changed, 54 insertions, 0 deletions
diff --git a/collections-debian-merged/ansible_collections/community/mysql/README.md b/collections-debian-merged/ansible_collections/community/mysql/README.md new file mode 100644 index 00000000..3ca1b0f9 --- /dev/null +++ b/collections-debian-merged/ansible_collections/community/mysql/README.md @@ -0,0 +1,54 @@ +# MySQL collection for Ansible +[![Plugins CI](https://github.com/ansible-collections/community.mysql/workflows/Plugins%20CI/badge.svg?event=push)](https://github.com/ansible-collections/community.mysql/actions?query=workflow%3A"Plugins+CI") [![Roles CI](https://github.com/ansible-collections/community.mysql/workflows/Roles%20CI/badge.svg?event=push)](https://github.com/ansible-collections/community.mysql/actions?query=workflow%3A"Roles+CI") [![Codecov](https://img.shields.io/codecov/c/github/ansible-collections/community.mysql)](https://codecov.io/gh/ansible-collections/community.mysql) + +## Included content + +- **Modules**: + - [mysql_db](https://docs.ansible.com/ansible/latest/modules/mysql_db_module.html) + - [mysql_info](https://docs.ansible.com/ansible/latest/modules/mysql_info_module.html) + - [mysql_query](https://docs.ansible.com/ansible/latest/modules/mysql_query_module.html) + - [mysql_replication](https://docs.ansible.com/ansible/latest/modules/mysql_replication_module.html) + - [mysql_user](https://docs.ansible.com/ansible/latest/modules/mysql_user_module.html) + - [mysql_variables](https://docs.ansible.com/ansible/latest/modules/mysql_variables_module.html) + +## Tested with Ansible + +- 2.9 +- 2.10 +- devel + +## External requirements + +The MySQL modules rely on a MySQL connector. The list of supported drivers is below: + +- [PyMySQL](https://github.com/PyMySQL/PyMySQL) +- [MySQLdb](https://github.com/PyMySQL/mysqlclient-python) +- Support for other Python MySQL connectors may be added in a future release. + +## Using this collection + +### Installing the Collection from Ansible Galaxy + +Before using the MySQL collection, you need to install it with the Ansible Galaxy CLI: + +```bash +ansible-galaxy collection install community.mysql +``` + +You can also include it in a `requirements.yml` file and install it via `ansible-galaxy collection install -r requirements.yml`, using the format: + +```yaml +--- +collections: + - name: community.mysql +``` + +See [Ansible Using collections](https://docs.ansible.com/ansible/latest/user_guide/collections_using.html) for more details. + +## Licensing + +<!-- Include the appropriate license information here and a pointer to the full licensing details. If the collection contains modules migrated from the ansible/ansible repo, you must use the same license that existed in the ansible/ansible repo. See the GNU license example below. --> + +GNU General Public License v3.0 or later. + +See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) to see the full text. |