# Readme

[![Build Status](https://jenkins.confdroid.com/buildStatus/icon?job=confdroid_postgresql)](https://jenkins.confdroid.com/job/postfresql_cd/)
[![Security Hotspots](https://sonarqube.confdroid.com/api/project_badges/measure?project=confdroid_postgresql&metric=security_hotspots&token=sqb_34cadd0d17dba89c9735fca0b6cd96c55e22950d)](https://sonarqube.confdroid.com/dashboard?id=confdroid_postgresql)

- [Readme](#readme)
  - [Synopsis](#synopsis)
  - [WARNING](#warning)
  - [Features](#features)
  - [Repo Documentation](#repo-documentation)
  - [Dependencies](#dependencies)
  - [Deployment](#deployment)
  - [SELINUX](#selinux)
  - [Known Problems](#known-problems)
  - [Support](#support)
  - [Tests](#tests)
  - [Contact Us](#contact-us)
  - [Disclaimer](#disclaimer)

## Synopsis

PostgreSQL is a powerful modern open source SQL database server.

`confdroid_postgresql` is a Puppet module to automate installation, configuration and management of all aspects of PostgreSQL(standalone) for Puppet 8

## WARNING

***Attention: Never use this puppet module on systems which have been previously configured manually. It is impossible to predict how and what would have been configured, hence previous configurations outside the scope of this module may be overwritten! Automated configurations require a test environment to verify that the module suits the purpose intended by the user, as well as tune the parameters, before deploying into live production***

[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/grizzly_coda)

## Features

Installation

* install binaries
* initialize the database cluster

Configuration

* manage directory structure including file system permissions and selinux context
* manage service status

Optional:

* manage single line entries in pg_hba via define
* manage roles and databases via define (set `$pl_manage_content` to true)
* manage extensions (set `pl_manage_extensions`to `true`)
* install and manage pg_bouncer (set `pl_use_pg_bouncer`to `true`)
* enable SL / TLS manage TLS certificates (set `pl_ssl_enabled`to `true` and populate content externally through variables)

## Repo Documentation

See the full Puppet documentation including parameters in `docs/index.html`.

## Dependencies

All dependencies must be included in the catalogue.

## Deployment

* native Puppet deployment

via site.pp or nodes.pp

```ruby
node 'example.example.net' {
  include confdroid_postgresql
}
```

* through Foreman:

In order to apply parameters through Foreman, **__confdroid_postgresql::params__** must be added to the host or host group in question.

See [more details about class deployment on Confdroid.com](https://confdroid.com/2017/05/deploying-our-puppet-modules/).

## SELINUX

All files and directories are configured with correct selinux context. If selinux is disabled, these contexts are ignored.

## Known Problems

## Support

This module has been developed for and tested with

* OS: Rocky 9
* Puppet 8

## Tests

* Puppet Lint
  * excluded tests:
    * `--no-variable_scope-check`: not applicable as we are inheriting parameters from params class. the lint check does not distinguish between facts and inherited parameters.
* Puppet Parser
* ERB Template Parser
* Sonar Quality Gate

## Contact Us

* [contact Us](https://confdroid.com/contact/)
* [Feedback Portal](https://feedback.confdroid.com)

## Disclaimer

ConfDroid as entity is entirely independent from Puppet. We provide custom configuration modules, written for specific purposes and specific environments.
The modules are tested and supported only as documented, and require testing in designated environments  (i.e. lab or development environments) for parameter tuning etc. before deploying into production environments.