https://github.com/ansible-collections/community.proxysql
ProxySQL Ansible Collection
https://github.com/ansible-collections/community.proxysql
ansible-collection hacktoberfest mysql-connector proxysql proxysql-collection
Last synced: 5 months ago
JSON representation
ProxySQL Ansible Collection
- Host: GitHub
- URL: https://github.com/ansible-collections/community.proxysql
- Owner: ansible-collections
- License: gpl-3.0
- Created: 2020-07-02T11:37:16.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2025-05-19T09:09:29.000Z (7 months ago)
- Last Synced: 2025-07-10T16:46:36.764Z (5 months ago)
- Topics: ansible-collection, hacktoberfest, mysql-connector, proxysql, proxysql-collection
- Language: Python
- Homepage: http://galaxy.ansible.com/community/proxysql
- Size: 253 KB
- Stars: 24
- Watchers: 9
- Forks: 28
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.rst
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# ProxySQL collection for Ansible
[](https://github.com/ansible-collections/community.proxysql/actions?query=workflow%3A"Plugins+CI") [](https://github.com/ansible-collections/community.proxysql/actions?query=workflow%3A"Roles+CI") [](https://codecov.io/gh/ansible-collections/community.proxysql)
This collection is a part of the Ansible package.
## Code of Conduct
We follow [Ansible Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html) in all our interactions within this project.
If you encounter abusive behavior violating the [Ansible Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html), please refer to the [policy violations](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html#policy-violations) section of the Code of Conduct for information on how to raise a complaint.
## Communication
* Join the Ansible forum:
* [Get Help](https://forum.ansible.com/c/help/6): get help or help others.
* [Posts tagged 'proxysql'](https://forum.ansible.com/tag/proxysql): subscribe to participate in collection-related conversations.
* [Social Spaces](https://forum.ansible.com/c/chat/4): gather and interact with fellow enthusiasts.
* [News & Announcements](https://forum.ansible.com/c/news/5): track project-wide announcements including social events.
* The Ansible [Bullhorn newsletter](https://docs.ansible.com/ansible/devel/community/communication.html#the-bullhorn): used to announce releases and important changes.
For more information about communication, see the [Ansible communication guide](https://docs.ansible.com/ansible/devel/community/communication.html).
## Contributing to this collection
The content of this collection is made by good [people](https://github.com/ansible-collections/community.proxysql/blob/main/CONTRIBUTORS) 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](https://github.com/ansible-collections/community.proxysql/blob/main/CONTRIBUTING.md)!
## Collection maintenance
The current maintainers (contributors with `write` or higher access) are listed in the [MAINTAINERS](https://github.com/ansible-collections/community.proxysql/blob/main/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](https://github.com/ansible-collections/community.proxysql/blob/main/MAINTAINING.md).
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](https://github.com/ansible-collections/overview/issues/45).
They also should be subscribed to Ansible's [The Bullhorn newsletter](https://docs.ansible.com/ansible/devel/community/communication.html#the-bullhorn).
## Included content
See on [Galaxy](https://galaxy.ansible.com/ui/repo/published/community/proxysql/content/).
The documentation for the latest collection version included in the Ansible community package is available on [docs.ansible.come](https://docs.ansible.com/ansible/devel/collections/community/proxysql/).
## Supports and tested with ansible-core
See our [test matrix](https://github.com/ansible-collections/community.proxysql/blob/main/.github/workflows/ansible-test-plugins.yml): 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](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 ProxySQL collection, you need to install it with the Ansible Galaxy command-line tool:
```bash
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:
```yaml
---
collections:
- name: community.proxysql
```
You can also download the tarball from [Ansible Galaxy](https://galaxy.ansible.com/ui/repo/published/community/proxysql) 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:
```bash
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:
```bash
ansible-galaxy collection install community.proxysql:==X.Y.Z
```
See [Ansible Using collections](https://docs.ansible.com/ansible/latest/user_guide/collections_using.html) for more details.
## Licensing
GNU General Public License v3.0 or later.
See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) to see the full text.