[SKIP CI] update readme
This commit is contained in:
parent
5cc9b0abb5
commit
ee277c011b
272
README.md
272
README.md
@ -8,34 +8,34 @@ Setup PostgreSQL database
|
||||
## Table of content
|
||||
|
||||
* [Default Variables](#default-variables)
|
||||
* [postgres_repository_enabled](#postgres_repository_enabled)
|
||||
* [postgres_version](#postgres_version)
|
||||
* [postgres_repository_filename](#postgres_repository_filename)
|
||||
* [postgres_user](#postgres_user)
|
||||
* [postgres_base_dir](#postgres_base_dir)
|
||||
* [postgres_clean_hba_file](#postgres_clean_hba_file)
|
||||
* [postgres_connection_addresses](#postgres_connection_addresses)
|
||||
* [postgres_connection_port](#postgres_connection_port)
|
||||
* [postgres_db](#postgres_db)
|
||||
* [postgres_dbs](#postgres_dbs)
|
||||
* [postgres_dbs_extra](#postgres_dbs_extra)
|
||||
* [postgres_group](#postgres_group)
|
||||
* [postgres_hba_entries](#postgres_hba_entries)
|
||||
* [postgres_hba_entries_extra](#postgres_hba_entries_extra)
|
||||
* [postgres_log_destination](#postgres_log_destination)
|
||||
* [postgres_log_directory](#postgres_log_directory)
|
||||
* [postgres_log_filename](#postgres_log_filename)
|
||||
* [postgres_log_rotation_age](#postgres_log_rotation_age)
|
||||
* [postgres_log_rotation_size](#postgres_log_rotation_size)
|
||||
* [postgres_connection_port](#postgres_connection_port)
|
||||
* [postgres_connection_addresses](#postgres_connection_addresses)
|
||||
* [postgres_socket_directories](#postgres_socket_directories)
|
||||
* [postgres_password_encryption](#postgres_password_encryption)
|
||||
* [postgres_tls_enabled](#postgres_tls_enabled)
|
||||
* [postgres_repository_enabled](#postgres_repository_enabled)
|
||||
* [postgres_repository_filename](#postgres_repository_filename)
|
||||
* [postgres_socket_directories](#postgres_socket_directories)
|
||||
* [postgres_tls_cert_filename](#postgres_tls_cert_filename)
|
||||
* [postgres_tls_key_filename](#postgres_tls_key_filename)
|
||||
* [postgres_tls_cert_source](#postgres_tls_cert_source)
|
||||
* [postgres_tls_enabled](#postgres_tls_enabled)
|
||||
* [postgres_tls_key_filename](#postgres_tls_key_filename)
|
||||
* [postgres_tls_key_source](#postgres_tls_key_source)
|
||||
* [postgres_user](#postgres_user)
|
||||
* [postgres_users](#postgres_users)
|
||||
* [postgres_users_extra](#postgres_users_extra)
|
||||
* [postgres_dbs](#postgres_dbs)
|
||||
* [postgres_dbs_extra](#postgres_dbs_extra)
|
||||
* [postgres_clean_hba_file](#postgres_clean_hba_file)
|
||||
* [postgres_hba_entries](#postgres_hba_entries)
|
||||
* [postgres_hba_entries_extra](#postgres_hba_entries_extra)
|
||||
* [postgres_base_dir](#postgres_base_dir)
|
||||
* [postgres_db](#postgres_db)
|
||||
* [postgres_version](#postgres_version)
|
||||
* [Dependencies](#dependencies)
|
||||
* [License](#license)
|
||||
* [Author](#author)
|
||||
@ -44,37 +44,73 @@ Setup PostgreSQL database
|
||||
|
||||
## Default Variables
|
||||
|
||||
### postgres_repository_enabled
|
||||
### postgres_base_dir
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
postgres_repository_enabled: false
|
||||
postgres_base_dir: _osdefault_
|
||||
```
|
||||
|
||||
### postgres_version
|
||||
### postgres_clean_hba_file
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
postgres_version: 10
|
||||
postgres_clean_hba_file: true
|
||||
```
|
||||
|
||||
### postgres_repository_filename
|
||||
### postgres_connection_addresses
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
postgres_repository_filename: Postgresql-{{ postgres_version | regex_replace('\.')
|
||||
}}
|
||||
postgres_connection_addresses:
|
||||
- localhost
|
||||
```
|
||||
|
||||
### postgres_user
|
||||
### postgres_connection_port
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
postgres_user: postgres
|
||||
postgres_connection_port: 5432
|
||||
```
|
||||
|
||||
### postgres_db
|
||||
|
||||
#### Example usage
|
||||
|
||||
```YAML
|
||||
postgres_db:
|
||||
- name: "my_app"
|
||||
lc_collate: "en_US.UTF-8"
|
||||
lc_ctype: "en_US.UTF-8"
|
||||
encoding: "UTF-8"
|
||||
template: "template0"
|
||||
login_host: "localhost"
|
||||
login_password: "_omit_"
|
||||
login_user: "{{ postgres_user }}"
|
||||
login_unix_socket: "_omit_"
|
||||
port: "_omit_"
|
||||
owner: "_omit_"
|
||||
state: "present"
|
||||
```
|
||||
|
||||
### postgres_dbs
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
postgres_dbs: []
|
||||
```
|
||||
|
||||
### postgres_dbs_extra
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
postgres_dbs_extra: []
|
||||
```
|
||||
|
||||
### postgres_group
|
||||
@ -85,6 +121,42 @@ postgres_user: postgres
|
||||
postgres_group: postgres
|
||||
```
|
||||
|
||||
### postgres_hba_entries
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
postgres_hba_entries:
|
||||
- contype: local
|
||||
databases:
|
||||
- all
|
||||
users:
|
||||
- all
|
||||
auth_method: trust
|
||||
- contype: host
|
||||
databases:
|
||||
- all
|
||||
users:
|
||||
- all
|
||||
address: 127.0.0.1/32
|
||||
auth_method: md5
|
||||
- contype: host
|
||||
databases:
|
||||
- all
|
||||
users:
|
||||
- all
|
||||
address: ::1/128
|
||||
auth_method: md5
|
||||
```
|
||||
|
||||
### postgres_hba_entries_extra
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
postgres_hba_entries_extra: []
|
||||
```
|
||||
|
||||
### postgres_log_destination
|
||||
|
||||
#### Default value
|
||||
@ -126,21 +198,29 @@ postgres_log_rotation_age: 1d
|
||||
postgres_log_rotation_size: 0
|
||||
```
|
||||
|
||||
### postgres_connection_port
|
||||
### postgres_password_encryption
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
postgres_connection_port: 5432
|
||||
postgres_password_encryption: md5
|
||||
```
|
||||
|
||||
### postgres_connection_addresses
|
||||
### postgres_repository_enabled
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
postgres_connection_addresses:
|
||||
- localhost
|
||||
postgres_repository_enabled: false
|
||||
```
|
||||
|
||||
### postgres_repository_filename
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
postgres_repository_filename: Postgresql-{{ postgres_version | regex_replace('\.')
|
||||
}}
|
||||
```
|
||||
|
||||
### postgres_socket_directories
|
||||
@ -152,22 +232,6 @@ postgres_socket_directories:
|
||||
- /var/run/postgresql
|
||||
```
|
||||
|
||||
### postgres_password_encryption
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
postgres_password_encryption: md5
|
||||
```
|
||||
|
||||
### postgres_tls_enabled
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
postgres_tls_enabled: false
|
||||
```
|
||||
|
||||
### postgres_tls_cert_filename
|
||||
|
||||
#### Default value
|
||||
@ -176,14 +240,6 @@ postgres_tls_enabled: false
|
||||
postgres_tls_cert_filename: mycert.pem
|
||||
```
|
||||
|
||||
### postgres_tls_key_filename
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
postgres_tls_key_filename: mykey.pem
|
||||
```
|
||||
|
||||
### postgres_tls_cert_source
|
||||
|
||||
#### Default value
|
||||
@ -192,6 +248,22 @@ postgres_tls_key_filename: mykey.pem
|
||||
postgres_tls_cert_source: mycert.pem
|
||||
```
|
||||
|
||||
### postgres_tls_enabled
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
postgres_tls_enabled: false
|
||||
```
|
||||
|
||||
### postgres_tls_key_filename
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
postgres_tls_key_filename: mykey.pem
|
||||
```
|
||||
|
||||
### postgres_tls_key_source
|
||||
|
||||
#### Default value
|
||||
@ -200,6 +272,14 @@ postgres_tls_cert_source: mycert.pem
|
||||
postgres_tls_key_source: mykey.pem
|
||||
```
|
||||
|
||||
### postgres_user
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
postgres_user: postgres
|
||||
```
|
||||
|
||||
### postgres_users
|
||||
|
||||
#### Default value
|
||||
@ -235,92 +315,12 @@ postgres_users:
|
||||
postgres_users_extra: []
|
||||
```
|
||||
|
||||
### postgres_dbs
|
||||
### postgres_version
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
postgres_dbs: []
|
||||
```
|
||||
|
||||
### postgres_dbs_extra
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
postgres_dbs_extra: []
|
||||
```
|
||||
|
||||
### postgres_clean_hba_file
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
postgres_clean_hba_file: true
|
||||
```
|
||||
|
||||
### postgres_hba_entries
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
postgres_hba_entries:
|
||||
- contype: local
|
||||
databases:
|
||||
- all
|
||||
users:
|
||||
- all
|
||||
auth_method: trust
|
||||
- contype: host
|
||||
databases:
|
||||
- all
|
||||
users:
|
||||
- all
|
||||
address: 127.0.0.1/32
|
||||
auth_method: md5
|
||||
- contype: host
|
||||
databases:
|
||||
- all
|
||||
users:
|
||||
- all
|
||||
address: ::1/128
|
||||
auth_method: md5
|
||||
```
|
||||
|
||||
### postgres_hba_entries_extra
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
postgres_hba_entries_extra: []
|
||||
```
|
||||
|
||||
### postgres_base_dir
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
postgres_base_dir: _osdefault_
|
||||
```
|
||||
|
||||
### postgres_db
|
||||
|
||||
#### Example usage
|
||||
|
||||
```YAML
|
||||
postgres_db:
|
||||
- name: "my_app"
|
||||
lc_collate: "en_US.UTF-8"
|
||||
lc_ctype: "en_US.UTF-8"
|
||||
encoding: "UTF-8"
|
||||
template: "template0"
|
||||
login_host: "localhost"
|
||||
login_password: "_omit_"
|
||||
login_user: "{{ postgres_user }}"
|
||||
login_unix_socket: "_omit_"
|
||||
port: "_omit_"
|
||||
owner: "_omit_"
|
||||
state: "present"
|
||||
postgres_version: 10
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Loading…
Reference in New Issue
Block a user