Browse Source

Update README (#40)

* Update README

* Fix

* Fix

* Improve
local_integrationtest
Andrew Klychkov 1 year ago committed by GitHub
parent
commit
96999316af
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 35
      README.md

35
README.md

@ -1,7 +1,7 @@
# 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)
This collection is a part of Ansible package.
This collection is a part of the Ansible package.
## Code of Conduct
@ -11,16 +11,23 @@ If you encounter abusive behavior violating the [Ansible Code of Conduct](https:
## Contributing to this collection
The content of this collection is made by good [people](CONTRIBUTORS) like you.
The content of this collection is made by good [people](https://github.com/ansible-collections/community.proxysql/blob/main/CONTRIBUTORS) like you, a community of individuals collaborating on making the world better through developing automation software.
All types of contributions are very welcome.
You don't know how to start? Refer to our [contribution guide](CONTRIBUTING.md)!
You don't know how to start? Refer to our [contribution guide](https://github.com/ansible-collections/community.proxysql/blob/main/CONTRIBUTING.md)!
The current maintainers are listed in the [MAINTAINERS](MAINTAINERS) file. Don't hesitate to reach them out mentioning in the proposals. To learn how to maintain / become a maintainer of this collection, refer to the [Maintainer guidelines](https://github.com/ansible/community-docs/blob/main/maintaining.rst).
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/community-docs/blob/main/maintaining.rst).
Join us on IRC in the ``ansible-community`` [irc.libera.chat](https://libera.chat/) channel.
See the [Registration guide](https://libera.chat/guides/registration) to learn how to register.
## Communication
We announce important development changes and releases through Ansible's [The Bullhorn newsletter](https://eepurl.com/gZmiEP). If you are a collection developer, be sure you are subscribed.
Join us in the ``#ansible`` (general use questions and support), ``#ansible-community`` (community and collection development questions), and other [IRC channels](https://docs.ansible.com/ansible/devel/community/communication.html#irc-channels).
We take part in the global quarterly [Ansible Contributor Summit](https://github.com/ansible/community/wiki/Contributor-Summit) virtually or in-person. Track [The Bullhorn newsletter](https://eepurl.com/gZmiEP) and join us.
For more information about communication, refer to the [Ansible Communication guide](https://docs.ansible.com/ansible/devel/community/communication.html).
## Included content
@ -54,7 +61,7 @@ The ProxySQL modules rely on a MySQL connector. The list of supported drivers i
### Installing the Collection from Ansible Galaxy
Before using the ProxySQL collection, you need to install it with the Ansible Galaxy CLI:
Before using the ProxySQL collection, you need to install it with the Ansible Galaxy command-line tool:
```bash
ansible-galaxy collection install community.proxysql
@ -68,6 +75,20 @@ collections:
- name: community.proxysql
```
You can also download the tarball from [Ansible Galaxy](https://galaxy.ansible.com/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

Loading…
Cancel
Save