Skip to content

Commit

Permalink
README cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
imincik authored Mar 28, 2017
1 parent 09c0375 commit 2deee0f
Showing 1 changed file with 11 additions and 41 deletions.
52 changes: 11 additions & 41 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,28 @@
ansible-postgresql_tune
=======================

# Ansible postgresql_tune module
Ansible module for automatic PostgreSQL tuning.

The module creates tuned settings for Postgres based on various use cases and system sizing parameters.

Tuned settings are written out to a dedicated config file, not to the main postgresql.conf.

Installation
------------
Tuned settings are written out to a specified config file, not to the main postgresql.conf.

## Installation
Place postgresql_tune.py in your Ansible library directory

Requirements
------------

## Requirements
Postgresql installation.

To include a separate config file with your postgresql.conf a common stanza is:-

include_dir = 'conf.d'
```
include_dir = 'conf.d'
```

Duplicated parameters override parameters that occur earlier in the core postgresql.conf file.

Dependencies
------------

## Dependencies
None

Example Playbook
----------------

# Postgresql 9.6

## Example Playbook
### Postgresql 9.6
```
vars:
postgresql_version: 9.6
Expand All @@ -50,8 +40,7 @@ Example Playbook
```

# Postgres 9.1 changing the kernels SHM settings and setting a custom max_connections setting

### Postgres 9.1 (with changes to kernel SHM settings and setting a max_connections)
```
vars:
postgresql_version: 9.6
Expand All @@ -72,22 +61,3 @@ Example Playbook
sysctl_file: "{{ postgresql_postgresql_tune_sysctl_file }}"
```

License
-------

BSD

Author Information
------------------

Copyright 2013 Crown copyright (c)
Land Information New Zealand and the New Zealand Government.
All rights reserved

This program is released under the terms of the new BSD license. See the
LICENSE file for more information.

Computing logic is based on http://pgtune.leopard.in.ua, developed by
Alexey Vasiliev and released under MIT license.

0 comments on commit 2deee0f

Please sign in to comment.