Updated docs
diff --git a/README.md b/README.md
index 1a63d6b..4b511c4 100644
--- a/README.md
+++ b/README.md
@@ -1,22 +1,30 @@
-Role Name
+Apigee OPDK Setup Postgres Config
=========
-A brief description of the role goes here.
+This role performs configurations that are only required for Postgres instances used with the Apigee platform. The
+database folder can be removed if the `clear_pgdata` flag is set.
Requirements
------------
-Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required.
+The role `apigee-opdk-setup-default-settings` addes the variable `apigee_postgresql_data_dir` to the cache for use
+throughout the framework.
+
Role Variables
--------------
-A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well.
+The variable `apigee_postgresql_data_dir` is used to reference the location of the PostgreSQL database folder.
+
+ apigee_postgresql_data_dir: '{{ apigee_home }}/data/apigee-postgresql/pgdata'
+
+The variable `clear_pgdata` is used to indicate that the data folder for PostgreSQL should be deleted and cleared of
+any data. The variable `clear_pgdata` is defaulted to False.
Dependencies
------------
-A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles.
+* apigee-opdk-setup-default-settings
Example Playbook
----------------
@@ -25,17 +33,18 @@
- hosts: servers
roles:
- - { role: username.rolename, x: 42 }
+ - { role: apigee-opdk-setup-default-settings }
License
-------
-Apache
+Apache 2.0
Author Information
------------------
-An optional section for the role authors to include contact information, or a website (HTML is not allowed).
+Carlos Frias
+
<!-- BEGIN Google Required Disclaimer -->
# Not Google Product Clause
diff --git a/tasks/main.yml b/tasks/main.yml
index efb2ea5..735c961 100644
--- a/tasks/main.yml
+++ b/tasks/main.yml
@@ -7,10 +7,9 @@
group: '{{ opdk_group_name }}'
mode: 0700
state: directory
- when: opdk_version | version_compare('4.16.01', '>=') and opdk_version | version_compare('4.16.09', '<')
- name: Remove pgdata folder for 4.16.09
file:
path: '{{ apigee_postgresql_data_dir }}'
state: absent
- when: clear_pgdata | default(False) and opdk_version | version_compare('4.16.09', '==')
+ when: clear_pgdata | default(False)