summaryrefslogtreecommitdiffstats
path: root/collections-debian-merged/ansible_collections/community/proxysql/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'collections-debian-merged/ansible_collections/community/proxysql/README.md')
-rw-r--r--collections-debian-merged/ansible_collections/community/proxysql/README.md56
1 files changed, 56 insertions, 0 deletions
diff --git a/collections-debian-merged/ansible_collections/community/proxysql/README.md b/collections-debian-merged/ansible_collections/community/proxysql/README.md
new file mode 100644
index 00000000..41410771
--- /dev/null
+++ b/collections-debian-merged/ansible_collections/community/proxysql/README.md
@@ -0,0 +1,56 @@
+# ProxySQL collection for Ansible
+[![Plugins CI](https://github.com/ansible-collections/community.proxysql/workflows/Plugins%20CI/badge.svg?event=push)](https://github.com/ansible-collections/community.proxysql/actions?query=workflow%3A"Plugins+CI") [![Roles CI](https://github.com/ansible-collections/community.proxysql/workflows/Roles%20CI/badge.svg?event=push)](https://github.com/ansible-collections/community.proxysql/actions?query=workflow%3A"Roles+CI") [![Codecov](https://img.shields.io/codecov/c/github/ansible-collections/community.proxysql)](https://codecov.io/gh/ansible-collections/community.proxysql)
+
+## Included content
+
+- **Modules**:
+ - [proxysql_backend_servers](https://docs.ansible.com/ansible/latest/modules/proxysql_backend_servers_module.html)
+ - [proxysql_global_variables](https://docs.ansible.com/ansible/latest/modules/proxysql_global_variables_module.html)
+ - [proxysql_manage_config](https://docs.ansible.com/ansible/latest/modules/proxysql_manage_config_module.html)
+ - [proxysql_mysql_users](https://docs.ansible.com/ansible/latest/modules/proxysql_mysql_users_module.html)
+ - [proxysql_query_rules](https://docs.ansible.com/ansible/latest/modules/proxysql_query_rules_module.html)
+ - [proxysql_replication_hostgroups](https://docs.ansible.com/ansible/latest/modules/proxysql_replication_hostgroups_module.html)
+ - [proxysql_scheduler](https://docs.ansible.com/ansible/latest/modules/proxysql_scheduler_module.html)
+- **Roles**:
+ - proxysql
+
+## Tested with Ansible
+
+- 2.9
+- 2.10
+- devel
+
+## 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 CLI:
+
+```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
+ version: v1.0.0
+```
+
+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.