MySQL collection for Ansible

This collection is a part of the Ansible package.

Our mission

The Ansible community.mysql collection goals are to produce and maintain simple, flexible, and powerful open-source software for automating MySQL and MariaDB related tasks providing good documentation for easy deployment and use.

Code of Conduct

We follow the Ansible Code of Conduct in all our interactions within this project.

If you encounter abusive behavior violating the Ansible Code of Conduct, please refer to the policy violations section of the Code of Conduct for information on how to raise a complaint.

Contributing

The content of this collection is made by people just like you, a community of individuals collaborating on making the world better through developing automation software.

We are actively accepting new contributors.

Any kind of contribution is very welcome.

You don't know how to start? Refer to our contribution guide or ask us in the #mysql:ansible.com room on Matrix!

Collection maintenance

The current maintainers (contributors with write or higher access) are listed in the MAINTAINERS file. If you have questions or need help, feel free to mention them in the proposals.

To learn how to maintain / become a maintainer of this collection, refer to the Maintainer guidelines.

It is necessary for maintainers of this collection to be subscribed to:

• The collection itself (the Watch button -> All Activity in the upper right corner of the repository's homepage).
• The "Changes Impacting Collection Contributors and Maintainers" issue.

They also should be subscribed to Ansible's The Bullhorn newsletter.

Communication

The GitHub Discussions feature is disabled in this repository. Use the mysql tag on the forum in the Project Discussions or Get Help category instead.

Asynchronous channels

• Join the Ansible forum:

  • MySQL Team: by joining the team you will automatically get subscribed to the posts tagged with mysql.
  • Get Help: get help or help others.
  • Posts tagged with 'mysql': leverage tags to narrow the scope.
  • Social Spaces: gather and interact with fellow enthusiasts.
  • News & Announcements: track project-wide announcements.

• The Ansible's Bullhorn newsletter: we use it to announce releases and important changes.

Real-time channels

• Matrix:
  • #mysql:ansible.com room: questions on how to contribute and use this collection.
  • #users:ansible.com room: general use questions and support.
  • #ansible-community:ansible.com room: community and collection development questions.
  • other Matrix rooms; see the Ansible Communication Guide for details.

For more information about communication, refer to the Ansible Communication guide.

Governance

We, the MySQL team, use the forum posts tagged with mysql for general announcements and discussions.

The process of decision making in this collection is based on discussing and finding consensus among participants.

Every voice is important and every idea is valuable. If you have something on your mind, create an issue or dedicated forum discussion and let's discuss it!

Included content

• Modules:
  • mysql_db
  • mysql_info
  • mysql_query
  • mysql_replication
  • mysql_role
  • mysql_user
  • mysql_variables

Releases Support Timeline

We maintain each major release (1.x.y, 2.x.y, ...) for two years after the next major version is released.

Here is the table for the support timeline:

• 1.x.y: released 2020-08-17, EOL
• 2.x.y: released 2021-04-15, EOL
• 3.x.y: released 2021-12-01, current
• 4.x.y: To be released

Tested with

ansible-core

• stable-2.14
• stable-2.15
• stable-2.16
• current development version

Databases

For MariaDB, only Long Term releases are tested.

• mysql 5.7.40
• mysql 8.0.31
• mariadb:10.3.34 (only collection version <= 3.5.1)
• mariadb:10.4.24 (only collection version >= 3.5.2)
• mariadb:10.5.18 (only collection version >= 3.5.2)
• mariadb:10.6.11 (only collection version >= 3.5.2)
• mariadb:10.11.?? (waiting for release)

Database connectors

• pymysql 0.7.11 (Only tested with MySQL 5.7)
• pymysql 0.9.3
• pymysql 1.0.2 (only collection version >= 3.6.1)
• mysqlclient 2.0.1
• mysqlclient 2.0.3 (only collection version >= 3.5.2)
• mysqlclient 2.1.1 (only collection version >= 3.5.2)

External requirements

The MySQL modules rely on a MySQL connector. The list of supported drivers is below:

• PyMySQL
• mysqlclient
• 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:

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:

---
collections:
  - name: community.mysql

Note that if you install the collection from Ansible Galaxy, it will not be upgraded automatically if you upgrade the Ansible package. To upgrade the collection to the latest available version, run the following command:

ansible-galaxy collection install community.mysql --upgrade

You can also install a specific version of the collection, for example, if you need to downgrade when something is broken in the latest version (please report an issue in this repository). Use the following syntax:

ansible-galaxy collection install community.mysql:==2.0.0

See Ansible Using collections for more details.

Licensing

GNU General Public License v3.0 or later.

See LICENSE to see the full text.