Skip to content

Commit e4fb486

Browse files
committed
1 parent c7abe10 commit e4fb486

File tree

1 file changed

+19
-17
lines changed

1 file changed

+19
-17
lines changed

Diff for: README.md

+19-17
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,30 @@
11
# PostgreSQL system role
22
![CI Testing](https://github.com/linux-system-roles/postgresql/workflows/tox/badge.svg)
33

4-
This role installs, configures, and starts PostgreSQL Server.
4+
The PostgreSQL system installs, configures, and starts the PostgreSQL server.
55

66
The role also optimizes the database server settings to improve performance.
77

88
The role currently works with PostgreSQL server 10 12 and 13.
99
## Role Variables
1010
### postgresql_verison
11-
Allow set up version of Postgresql server. This role supports Postgresql 10 12 and 13
11+
You can set the version of PostgreSQL server to 10, 12, or 13.
1212
```yaml
1313
postgresql_version: "13"
1414
```
1515
### postgresql_password
16-
Optionally, you can set up password for database super user `postgres` by default
17-
there is not a password, datababase is accessible from `postgres` system account via UNIX socket.
18-
users are encouraged to use ansible vault
16+
Optionally, you can set a password for the `postgres` database superuser.
17+
By default, no password is set, and a datababase is accessible from
18+
the `postgres` system account through a UNIX socket.
19+
It is recommended to encrypt the password using Ansible Vault.
1920
```yaml
2021
postgresql_password: !vault |
2122
$ANSIBLE_VAULT;1.2;AES256;dev
2223
....
2324
```
2425
### postgresql_pg_hba_conf
25-
A description of input variables that are not reqiured. Upstream configuration is used by default.
26-
Usage of `postgresql_pg_hba_conf` causes replacement of default upstream configuration
26+
The content of the `postgresql_pg_hba_conf` variable replaces the default
27+
upstream configuration in the `/var/lib/pgsql/data/pg_hba.conf` file.
2728
```yaml
2829
postgresql_pg_hba_conf:
2930
- type: local
@@ -42,23 +43,24 @@ postgresql_pg_hba_conf:
4243
auth_method: ident
4344
```
4445
### postgresql_server_conf
45-
Usage of `postgresql_server_conf` adds defined values at the end of postgresql.conf.
46-
So the default ones are overwritten.
46+
The content of the `postgresql_server_conf` variable is
47+
added to the end of the `/var/lib/pgsql/data/postgresql.conf` file.
48+
As a result, the default settings are overwritten.
4749
```yaml
4850
postgresql_server_conf:
4951
ssl: on
5052
shared_buffers: 128 MB
5153
huge_pages: try
5254
```
5355
### postgresql_ssl_enable
54-
To set up ssl connection it's necessary to set up `postgresql_ssl_enable` variable and provide server certificate and key.
56+
To set up a SSL/TLS connection, set the `postgresql_ssl_enable` variable to `True` and provide a server certificate and a private key.
5557
```yaml
5658
postgresql_ssl_enable: true
5759
```
5860
### postgresql_cert_name
5961
In case you want to use own key and certificate. Use `postgresql_cert_name` variable. It's necessary to have both files in the same directory and with the same name with suffixes .crt and .key
6062

61-
To specify certificate name use `postgresql_cert_name` variable.
63+
Use `postgresql_cert_name` variable to specify certificate name.
6264
For example your crt file is located in `/etc/certs/server.crt` and key in `/etc/certs/server.key`. So `postgresql_cert_name` value should be
6365
```yaml
6466
postgresql_cert_name: /etc/certs/server
@@ -77,24 +79,24 @@ postgresql_certificates:
7779
ca: self-sign
7880
```
7981
### postgresql_input_file
80-
For running SQL script define path to your SQL file using `postgresql_input_file`:
82+
To run an SQL script, define a path to your SQL file using the `postgresql_input_file` variable:
8183
```yaml
8284
postgresql_input_file: "/tmp/mypath/file.sql"
8385
```
8486
### postgresql_server_tuning
85-
By default the system role makes server settings tuning based on system resources,
86-
This functionality is enabled by default. For disabling it there is a possibility to
87-
set up the `postgresql_server_tuning` variable.
87+
By default, the PostgreSQL system role enables server settings optimization
88+
based on system resources. To disabe the tuning,
89+
set the `postgresql_server_tuning` variable to `False`.
8890
```yaml
8991
postgresql_server_tuning: false
9092
```
9193

92-
More about usage could be found in [`examples/`](examples) directory
94+
See the [`examples/`](examples) for details.
9395

9496
## Idempotention
9597
This section should cover role behavior for repeated runs.
9698
### Password change
97-
Once the password is set using `postgresql_password` variable it isn`t possible to
99+
Once the password is set using `postgresql_password` variable it isn't possible to
98100
change it by setting other value. Also for every database acces using superuser must
99101
be used `postgresql_password`. Including functionality of `postgresql_input_file`
100102
### Config file redefinition

0 commit comments

Comments
 (0)