README.md

PostgreSQL collection for Ansible

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 in all our interactions within this project.

If you encounter abusive behavior violating the Ansible Code of Conduct, please refer to the policy violations section of the Code of Conduct for information on how to raise a complaint.

Contributing to this collection

The content of this collection is made by people just like you; a community of individuals collaborating on making the world better through developing automation software.

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!

We use the following guidelines:

• CONTRIBUTING.md
• Ansible Community Guide
• Ansible Development Guide
• Ansible Collection Development Guide

Collection maintenance

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 Watch button -> All Activity in the upper right corner of the repository's homepage).
• The news-for-maintainers repository.

They also should be subscribed to Ansible's The Bullhorn newsletter.

Communication

We announce important development changes and releases through Ansible's The Bullhorn newsletter. If you are a collection developer, be sure you are subscribed.

Join our team on:

• The Ansible forums:
  • News & Announcements
  • Get Help
  • Social Spaces
  • Posts tagged 'postgresql'
• Matrix:
  • #postgresql:ansible.com room: questions on how to contribute and use this collection.
  • #users:ansible.com room: general use questions and support.
  • #ansible-community:ansible.com room: community and collection development questions.
  • other Matrix rooms or corresponding bridged Libera.Chat channels. See the Ansible Communication Guide for details.

We take part in the global quarterly Ansible Contributor Summit virtually or in-person. Track The Bullhorn newsletter and join us.

For more information about communication, refer to the Ansible Communication guide.

Governance

We, the PostgreSQL working group, use the community pinboard 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!

External requirements

The PostgreSQL modules rely on the Psycopg PostgreSQL database adapter. Both versions Psycopg2 and Psycopg3 are supported. The minimum supported and tested versions of Psycopg are 2.5.1 and 3.1.8 respectively.

Tested with ansible-core

Tested with the following ansible-core releases:

• 2.12
• 2.13
• 2.14
• 2.15
• 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:

Docker image	Psycopg version	PostgreSQL version
CentOS 7	2.5.1	9.2
RHEL 8	2.7.5	10
Fedora 34	2.8.6	13
Fedora 35	2.9.1	13
Fedora 36	2.9.1	14
Fedora 37	2.9.6	14
Fedora 38	3.1.8	15
Ubuntu 20.04	2.8.6	15
Ubuntu 22.04	3.1.9	15

Included content

• Info modules:

  • postgresql_info
  • postgresql_ping
  • postgresql_user_obj_stat_info

• Basic modules:

  • postgresql_db
  • postgresql_ext
  • postgresql_lang
  • postgresql_pg_hba
  • postgresql_privs
  • postgresql_set
  • postgresql_schema
  • postgresql_tablespace
  • postgresql_query
  • postgresql_user

• Other modules:

  • postgresql_copy
  • postgresql_idx
  • postgresql_membership
  • postgresql_owner
  • postgresql_publication
  • postgresql_sequence
  • postgresql_slot
  • postgresql_subscription
  • postgresql_table

Using this collection

Installing the Collection from Ansible Galaxy

Before using the PostgreSQL collection, you need to install it with the Ansible Galaxy command-line tool:

ansible-galaxy collection install community.postgresql

You can include it in a requirements.yml file and install it via ansible-galaxy collection install -r requirements.yml, using the format:

---
collections:
  - name: community.postgresql

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.postgresql --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.postgresql:==X.Y.Z

See Ansible Using collections for more details.

Release notes

See the changelog.

Roadmap

See the release plan.

More information

• Ansible Collection overview
• Ansible User guide
• Ansible Developer guide
• Ansible Community code of conduct

Licensing

GNU General Public License v3.0 or later.

See LICENSE to see the full text.