update Readme
This commit is contained in:
45
README.md
45
README.md
@@ -2,6 +2,7 @@
|
|||||||
|
|
||||||
[](https://jenkins.confdroid.com/job/postfresql_cd/)
|
[](https://jenkins.confdroid.com/job/postfresql_cd/)
|
||||||
[](https://sonarqube.confdroid.com/dashboard?id=confdroid_postgresql)
|
[](https://sonarqube.confdroid.com/dashboard?id=confdroid_postgresql)
|
||||||
|
[](https://deepwiki.com/grizzlycoda/puppet_collection)
|
||||||
|
|
||||||
- [Readme](#readme)
|
- [Readme](#readme)
|
||||||
- [Synopsis](#synopsis)
|
- [Synopsis](#synopsis)
|
||||||
@@ -33,21 +34,21 @@ PostgreSQL is a powerful modern open source SQL database server.
|
|||||||
|
|
||||||
Installation
|
Installation
|
||||||
|
|
||||||
* install binaries
|
- install binaries
|
||||||
* initialize the database cluster
|
- initialize the database cluster
|
||||||
|
|
||||||
Configuration
|
Configuration
|
||||||
|
|
||||||
* manage directory structure including file system permissions and selinux context
|
- manage directory structure including file system permissions and selinux context
|
||||||
* manage service status
|
- manage service status
|
||||||
|
|
||||||
Optional:
|
Optional:
|
||||||
|
|
||||||
* manage single line entries in pg_hba via define
|
- manage single line entries in pg_hba via define
|
||||||
* manage roles and databases via define (set `$pl_manage_content` to true)
|
- manage roles and databases via define (set `$pl_manage_content` to true)
|
||||||
* manage extensions (set `pl_manage_extensions`to `true`)
|
- manage extensions (set `pl_manage_extensions`to `true`)
|
||||||
* install and manage pg_bouncer (set `pl_use_pg_bouncer`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)
|
- enable SL / TLS manage TLS certificates (set `pl_ssl_enabled`to `true` and populate content externally through variables)
|
||||||
|
|
||||||
## Repo Documentation
|
## Repo Documentation
|
||||||
|
|
||||||
@@ -59,7 +60,7 @@ All dependencies must be included in the catalogue.
|
|||||||
|
|
||||||
## Deployment
|
## Deployment
|
||||||
|
|
||||||
* native Puppet deployment
|
- native Puppet deployment
|
||||||
|
|
||||||
via site.pp or nodes.pp
|
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/).
|
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
|
This module has been developed for and tested with
|
||||||
|
|
||||||
* OS: Rocky 9
|
- OS: Rocky 9
|
||||||
* Puppet 8
|
- Puppet 8
|
||||||
|
|
||||||
## Tests
|
## Tests
|
||||||
|
|
||||||
* Puppet Lint
|
- Puppet Lint
|
||||||
* excluded tests:
|
- 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.
|
- `--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
|
- Puppet Parser
|
||||||
* ERB Template Parser
|
- ERB Template Parser
|
||||||
* Sonar Quality Gate
|
- Sonar Quality Gate
|
||||||
|
|
||||||
## Contact Us
|
## Contact Us
|
||||||
|
|
||||||
* [contact Us](https://confdroid.com/contact/)
|
- [contact Us](https://confdroid.com/contact/)
|
||||||
* [Feedback Portal](https://feedback.confdroid.com)
|
- [Feedback Portal](https://feedback.confdroid.com)
|
||||||
|
|
||||||
## Disclaimer
|
## Disclaimer
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user