ProxySQL collection for Ansible
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.
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!
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
All Activityin 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.
We announce important development changes and releases through Ansible's The Bullhorn newsletter. If you are a collection developer, be sure you are subscribed.
For more information about communication, refer to the Ansible Communication guide.
proxysql_backend_servers: Adds or removes mysql hosts from proxysql admin interface.
proxysql_global_variables: Gets or sets the proxysql global variables.
proxysql_info: Gathers information about proxysql server.
proxysql_manage_config: Writes the proxysql configuration settings between layers.
proxysql_mysql_users: Adds or removes mysql users from proxysql admin interface.
proxysql_query_rules_fast_routing.py: Modifies query rules for fast routing policies using the proxysql admin interface.
proxysql_query_rules: Modifies query rules using the proxysql admin interface.
proxysql_replication_hostgroups: Manages replication hostgroups using the proxysql admin.
proxysql_scheduler: Adds or removes schedules from proxysql admin interface.
Tested with Ansible
The ProxySQL modules rely on a MySQL connector. The list of supported drivers is below:
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.
GNU General Public License v3.0 or later.
See LICENSE to see the full text.