Skip to content

ansible-collections/community.proxysql

ProxySQL collection for Ansible

Plugins CI Roles CI Codecov

This collection is a part of the Ansible package.

Code of Conduct

We follow 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.

Communication

For more information about communication, see the Ansible communication guide.

Contributing to this collection

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

We are actively accepting new contributors.

All types of contributions are very welcome.

You don't know how to start? Refer to our contribution guide!

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.

Included content

See on Galaxy.

The documentation for the latest collection version included in the Ansible community package is available on docs.ansible.come.

Supports and tested with ansible-core

See our test matrix: for example, stable-2.17 corresponds to ansible-core 2.17.

External requirements

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

  • PyMySQL
  • MySQLdb
  • 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 ProxySQL collection, you need to install it with the Ansible Galaxy command-line tool:

ansible-galaxy collection install community.proxysql

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.proxysql

You can also download the tarball from Ansible Galaxy and install the collection manually wherever you need.

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

ansible-galaxy collection install community.proxysql --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.proxysql:==X.Y.Z

See Ansible Using collections for more details.

Licensing

GNU General Public License v3.0 or later.

See LICENSE to see the full text.