diff options
Diffstat (limited to 'ansible_collections/community/postgresql/README.md')
| -rw-r--r-- | ansible_collections/community/postgresql/README.md | 81 |
1 files changed, 56 insertions, 25 deletions
diff --git a/ansible_collections/community/postgresql/README.md b/ansible_collections/community/postgresql/README.md index 076239137..fde669888 100644 --- a/ansible_collections/community/postgresql/README.md +++ b/ansible_collections/community/postgresql/README.md @@ -5,6 +5,19 @@ This collection is a part of the Ansible package. +## Our mission + +At the `community.postgresql` Ansible collection project, +our mission is to produce and maintain simple, flexible, +and powerful open-source software tailored to automating PostgreSQL-related tasks. + +We welcome members from all skill levels to participate actively in our open, inclusive, and vibrant community. +Whether you are an expert or just beginning your journey with Ansible and PostgreSQL, +you are encouraged to contribute, share insights, and collaborate with fellow enthusiasts. + +We strive to make managing PostgreSQL deployments as effortless and efficient as possible with automation, +enabling users to focus on their core objectives. + ## Code of Conduct We follow the [Ansible Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html) in all our interactions within this project. @@ -13,11 +26,9 @@ If you encounter abusive behavior violating the [Ansible Code of Conduct](https: ## Contributing to this collection -The content of this collection is made by [people](https://github.com/ansible-collections/community.postgresql/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. +The content of this collection is made by [people](https://github.com/ansible-collections/community.postgresql/graphs/contributors) just like you; a community of individuals collaborating on making the world better through developing automation software. -All types of contributions are very welcome. +We are actively accepting new contributors and 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.postgresql/blob/main/CONTRIBUTING.md)! @@ -37,20 +48,27 @@ To learn how to maintain / become a maintainer of this collection, refer to the 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). +* The [news-for-maintainers repository](https://github.com/ansible-collections/news-for-maintainers). They also should be subscribed to Ansible's [The Bullhorn newsletter](https://docs.ansible.com/ansible/devel/community/communication.html#the-bullhorn). ## Communication -We announce important development changes and releases through Ansible's [The Bullhorn newsletter](https://docs.ansible.com/ansible/devel/community/communication.html#the-bullhorn). If you are a collection developer, be sure you are subscribed. +> `GitHub Discussions` feature is disabled in this repository. Use the `postgresql` tag on the forum in the [Project Discussions](https://forum.ansible.com/new-topic?title=topic%20title&body=topic%20body&category=project&tags=postgresql) or [Get Help](https://forum.ansible.com/new-topic?title=topic%20title&body=topic%20body&category=help&tags=postgresql) category instead. -Join us on Matrix in: +We announce important development changes and releases through Ansible's [The Bullhorn newsletter](https://docs.ansible.com/ansible/devel/community/communication.html#the-bullhorn). If you are a collection developer, be sure you are subscribed. -* `#postgresql:ansible.com` [room](https://matrix.to/#/#postgresql:ansible.com): questions on how to contribute and use this collection. -* `#users:ansible.com` [room](https://matrix.to/#/#users:ansible.com): general use questions and support. -* `#ansible-community:ansible.com` [room](https://matrix.to/#/#community:ansible.com): community and collection development questions. -* other Matrix rooms or corresponding bridged Libera.Chat channels. See the [Ansible Communication Guide](https://docs.ansible.com/ansible/devel/community/communication.html) for details. +Join [our team](https://forum.ansible.com/g/PostgreSQLTeam?asc=true&order=) on: +* The Ansible forums: + * [News & Announcements](https://forum.ansible.com/c/news/5/none) + * [Get Help](https://forum.ansible.com/c/help/6/none) + * [Social Spaces](https://forum.ansible.com/c/chat/4) + * [Posts tagged 'postgresql'](https://forum.ansible.com/tag/postgresql) +* Matrix: + * `#postgresql:ansible.com` [room](https://matrix.to/#/#postgresql:ansible.com): questions on how to contribute and use this collection. + * `#users:ansible.com` [room](https://matrix.to/#/#users:ansible.com): general use questions and support. + * `#ansible-community:ansible.com` [room](https://matrix.to/#/#community:ansible.com): community and collection development questions. + * other Matrix rooms or corresponding bridged Libera.Chat channels. See the [Ansible Communication Guide](https://docs.ansible.com/ansible/devel/community/communication.html) for details. 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://docs.ansible.com/ansible/devel/community/communication.html#the-bullhorn) and join us. @@ -58,31 +76,48 @@ For more information about communication, refer to the [Ansible Communication gu ## Governance -We, [the PostgreSQL working group](https://github.com/ansible-collections/community.postgresql/wiki/PostgreSQL-Working-Group), use [the community pinboard](https://github.com/ansible-collections/community.postgresql/issues/30) for general announcements and discussions. +We, [the PostgreSQL working group](https://forum.ansible.com/g/PostgreSQLTeam), use [the forum](https://forum.ansible.com/tag/postgresql) posts tagged with `postgresql` for general announcements and discussions. The process of decision making in this collection is based on discussing and finding consensus among participants. -Every voice is important and every idea is valuable. If you have something on your mind, create an issue or dedicated discussion and let's discuss it! +Every voice is important and every idea is valuable. If you have something on your mind, create an issue or dedicated forum [discussion](https://forum.ansible.com/new-topic?title=topic%20title&body=topic%20body&category=project&tags=postgresql) and let's discuss it! ## External requirements -The PostgreSQL modules rely on the [Psycopg2](https://www.psycopg.org/docs/) PostgreSQL database adapter. +The PostgreSQL modules rely on the [Psycopg](https://www.psycopg.org/) PostgreSQL database adapter. +Both versions [Psycopg2](https://www.psycopg.org/docs/) and [Psycopg3](https://www.psycopg.org/psycopg3/docs/) are supported. +The minimum supported and tested versions of Psycopg are 2.5.1 and 3.1.8 respectively. + +## Releases Support Timeline + +We maintain each major release version (1.x.y, 2.x.y, ...) for two years after the next major version is released. + +Here is the table for the support timeline: +- 1.x.y: released 2020-11-17, supported until 2024-02-10 +- 2.x.y: released 2022-02-10, supported until 2025-06-09 +- 3.x.y: released 2023-06-09, current +- 4.x.y: to be released; not earlier than after Ansible 10 release (~May 2024) ## Tested with ansible-core Tested with the following `ansible-core` releases: -- 2.12 -- 2.13 - 2.14 +- 2.15 +- 2.16 - current development version Ansible-core versions before 2.12.0 are not supported. Our AZP CI includes testing with the following docker images / PostgreSQL versions: -- CentOS 7: 9.2 -- RHEL 8.3 / 8.4: 10 -- Fedora 34: 13 -- Ubuntu 20.04: 14 +| Docker image | Psycopg version | PostgreSQL version | +|--------------|-----------------|--------------------| +| CentOS 7 | 2.5.1 | 9.2 | +| RHEL 8 | 2.7.5 | 10 | +| Fedora 37 | 2.9.6 | 14 | +| Fedora 38 | 2.9.6 | 15 | +| Fedora 39 | 2.9.6 | 15 | +| Ubuntu 20.04 | 2.8.6 | 15 | +| Ubuntu 22.04 | 3.1.9 | 15 | ## Included content @@ -132,7 +167,7 @@ collections: - name: community.postgresql ``` -You can also download the tarball from [Ansible Galaxy](https://galaxy.ansible.com/community/postgresql) and install the collection manually wherever you need. +You can also download the tarball from [Ansible Galaxy](https://galaxy.ansible.com/ui/repo/published/community/postgresql) 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: @@ -152,10 +187,6 @@ See [Ansible Using collections](https://docs.ansible.com/ansible/latest/user_gui See the [changelog](https://github.com/ansible-collections/community.postgresql/blob/main/CHANGELOG.rst). -## Roadmap - -See the [release plan](https://github.com/ansible-collections/community.postgresql/issues/13). - ## More information - [Ansible Collection overview](https://github.com/ansible-collections/overview) |