PostgreSQL Official documentation
Units in the configuration
The various size or time configuration items can be expressed in the following units.
Memory units
kB = kilobytes MB = megabytes GB = gigabytes
Time units
ms = milliseconds s = seconds min = minutes h = hours d = days
Commands
- devops postgresql start
- Start PostgreSQL if stopped
- devops postgresql stop
- Stop PostgreSQL if started
- devops postgresql reload
- Reload PostgreSQL, reload the configuration and perform a graceful restart
- devops postgresql restart
- Restart PostgreSQL, reload the configuration (but kills existing connection)
- devops postgresql database backup
-
Backup database(s)
Options
Name Type Description Required name array Database name, if not defined it will backup all the databases path string Path to destination folder of the backup
Configuration
-
configuration:
-
postgresql:
- authentication_timeout: 1min
- data_directory: /var/lib/postgresql/9.3/main
- databases:
- effective_cache_size: 128MB
- external_pid_file: /var/run/postgresql/9.3-main.pid
- fsync: true
- hba_file: /etc/postgresql/9.3/main/pg_hba.conf
- ident_file: /etc/postgresql/9.3/main/pg_ident.conf
- listen_addresses: localhost
- max_connections: 100
- pg_ctl_options: no default value
- port: 5432
- shared_buffers: 128MB
- ssl: true
- ssl_cert_file: /etc/ssl/certs/ssl-cert-snakeoil.pem
- ssl_ciphers: DEFAULT:!LOW:!EXP:!MD5:@STRENGTH
- ssl_key_file: /etc/ssl/private/ssl-cert-snakeoil.key
- ssl_renegotiation_limit: 512MB
- superuser_reserved_connections: 3
- unix_socket_directories: /var/run/postgresql
- users:
-
postgresql:
- authentication_timeout string
- Timeout for the authentication, from 1s to 10min. Refer to the time units for more details.
- Default:
1min
- data_directory string
- Data folder.
- Default:
/var/lib/postgresql/9.3/main
- databases array
- Array of databases, defines a database and the permissions of the users
- database.name string
- Database name
- Required
- database.users array
- Array of users with full privileges on the database, users will be granted access from all their hosts
- effective_cache_size string
- Amount of memory expected to be available on the OS for data caching. Set up to 50% of the RAM on the server.
- Default:
128MB
- external_pid_file string
- Path to the pid file.
- Default:
/var/run/postgresql/9.3-main.pid
- fsync boolean
- Enable fsync of transaction to disk before being commited. Can reduce performance but is safer. Disable with caution.
- Default:
true
- hba_file string
- Path to the host-based authentication file.
- Default:
/etc/postgresql/9.3/main/pg_hba.conf
- ident_file string
- Path to the ident configuration file.
- Default:
/etc/postgresql/9.3/main/pg_ident.conf
- listen_addresses string
- Comma-separated list of addresses, use * for all.
- Default:
localhost
- max_connections integer
- Maximum amount of concurrent connection to PostgreSQL, note that increasing the max_connections costs ~400 bytes of shared memory per connection slot, plus lock space (see max_locks_per_transaction).
- Default:
100
- pg_ctl_options string
- This configuration file contains cluster specific options to be passed to pg_ctl.
- port integer
- Listening port.
- Default:
5432
- Amount of memory allocated to PostgreSQL to cache data. Set to up to 25% of the RAM available on the server.
- Default:
128MB
- ssl boolean
- Enable SSL.
- Default:
true
- ssl_cert_file string
- SSL certificate.
- Default:
/etc/ssl/certs/ssl-cert-snakeoil.pem
- ssl_ciphers string
- Allowed SSL ciphers.
- Default:
DEFAULT:!LOW:!EXP:!MD5:@STRENGTH
- ssl_key_file string
- SSL private key.
- Default:
/etc/ssl/private/ssl-cert-snakeoil.key
- ssl_renegotiation_limit string
- Amount of data between SSL renegotiations. Refer to the size units for more details.
- Default:
512MB
- superuser_reserved_connections integer
- Number of connections reserved to the superuser.
- Default:
3
- unix_socket_directories string
- Comma-separated list of directories used to store the unix sockets.
- Default:
/var/run/postgresql
- users array
- Array of MySQL users. Passwords are randomly generated.
- user.name string
- User name
- Required