From 5f70f4231b0618a2a816b63d38d17a85d4909981 Mon Sep 17 00:00:00 2001 From: 12ww1160 <12ww1160@confdroid.com> Date: Sat, 14 Mar 2026 12:06:49 +0100 Subject: [PATCH] update Readme --- README.md | 45 +++++++++++++++++++++++---------------------- 1 file changed, 23 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index b19faa7..a6d1a17 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,7 @@ [![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) +[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/grizzlycoda/puppet_collection) - [Readme](#readme) - [Synopsis](#synopsis) @@ -33,21 +34,21 @@ PostgreSQL is a powerful modern open source SQL database server. Installation -* install binaries -* initialize the database cluster +- install binaries +- initialize the database cluster Configuration -* manage directory structure including file system permissions and selinux context -* manage service status +- 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) +- 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 @@ -59,7 +60,7 @@ All dependencies must be included in the catalogue. ## Deployment -* native Puppet deployment +- native Puppet deployment via site.pp or nodes.pp @@ -69,9 +70,9 @@ node 'example.example.net' { } ``` -* through Foreman: +- through Foreman: -In order to apply parameters through Foreman, **__confdroid_postgresql::params__** must be added to the host or host group in question. +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/). @@ -85,22 +86,22 @@ All files and directories are configured with correct selinux context. If selinu This module has been developed for and tested with -* OS: Rocky 9 -* Puppet 8 +- 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 +- 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) +- [contact Us](https://confdroid.com/contact/) +- [Feedback Portal](https://feedback.confdroid.com) ## Disclaimer