From dcd214a631506b460c59daf09bc8f80a77cb0679 Mon Sep 17 00:00:00 2001 From: Lorin Hochstein Date: Sun, 29 Jul 2012 12:47:44 -0400 Subject: [PATCH] Use standard argument names in PostgreSQL modules passwd -> password loginpass -> login_password loginuser -> login_user loginhost -> login_host Add an example playbook that shows how to use the modules. --- examples/playbooks/postgresql.yaml | 38 ++++++++++++++++++++++++++++++ library/postgresql_db | 12 +++++----- library/postgresql_user | 38 +++++++++++++++--------------- 3 files changed, 63 insertions(+), 25 deletions(-) create mode 100644 examples/playbooks/postgresql.yaml diff --git a/examples/playbooks/postgresql.yaml b/examples/playbooks/postgresql.yaml new file mode 100644 index 0000000000..919a48b9d5 --- /dev/null +++ b/examples/playbooks/postgresql.yaml @@ -0,0 +1,38 @@ +## +# Example Ansible playbook that uses the PostgreSQL module. +# +# This installs PostgreSQL on an Ubuntu system, creates a database called +# "myapp" and a user called "django" with password "mysupersecretpassword" +# with access to the "myapp" database. +# +--- +- hosts: webservers + sudo: True + gather_facts: False + + tasks: + - name: ensure apt cache is up to date + action: apt update_cache=yes + - name: ensure packages are installed + action: apt pkg=$item + with_items: + - postgresql + - libpq-dev + - python-psycopg2 + +- hosts: webservers + sudo: True + sudo_user: postgres + gather_facts: False + + vars: + dbname: myapp + dbuser: django + dbpassword: mysupersecreetpassword + + tasks: + - name: ensure database is created + action: postgresql_db db=$dbname + + - name: ensure user has access to database + action: postgresql_user db=$dbname user=$dbuser password=$dbpassword \ No newline at end of file diff --git a/library/postgresql_db b/library/postgresql_db index 3db186bddf..478b376dc7 100755 --- a/library/postgresql_db +++ b/library/postgresql_db @@ -52,9 +52,9 @@ def db_create(cursor, db): def main(): module = AnsibleModule( argument_spec=dict( - loginuser=dict(default="postgres"), - loginpass=dict(default=""), - loginhost=dict(default=""), + login_user=dict(default="postgres"), + login_password=dict(default=""), + login_host=dict(default=""), db=dict(required=True), state=dict(default="present", choices=["absent", "present"]), ) @@ -67,9 +67,9 @@ def main(): state = module.params["state"] changed = False try: - db_connection = psycopg2.connect(host=module.params["loginhost"], - user=module.params["loginuser"], - password=module.params["loginpass"], + db_connection = psycopg2.connect(host=module.params["login_host"], + user=module.params["login_user"], + password=module.params["login_password"], database="template1") # Enable autocommit so we can create databases db_connection.autocommit = True diff --git a/library/postgresql_user b/library/postgresql_user index b6b0afe61c..95e72de0c8 100755 --- a/library/postgresql_user +++ b/library/postgresql_user @@ -33,10 +33,10 @@ def user_exists(cursor, user): return cursor.rowcount > 0 -def user_add(cursor, user, passwd, db): +def user_add(cursor, user, password, db): """Create a new user with write access to the database""" - query = "CREATE USER %(user)s with PASSWORD '%(passwd)s'" - cursor.execute(query % {"user": user, "passwd": passwd}) + query = "CREATE USER %(user)s with PASSWORD '%(password)s'" + cursor.execute(query % {"user": user, "password": password}) grant_privileges(cursor, user, db) return True @@ -60,19 +60,19 @@ def revoke_privileges(cursor, user, db): cursor.execute(query % {'user': user, 'db': db}) -def user_mod(cursor, user, passwd, db): +def user_mod(cursor, user, password, db): """Update password and permissions""" changed = False # Handle passwords. - if passwd is not None: + if password is not None: select = "SELECT rolpassword FROM pg_authid where rolname=%(user)s" cursor.execute(select, {"user": user}) current_pass_hash = cursor.fetchone()[0] # Not sure how to hash the new password, so we just initiate the # change and check if the hash changed - alter = "ALTER USER %(user)s WITH PASSWORD '%(passwd)s'" - cursor.execute(alter % {"user": user, "passwd": passwd}) + alter = "ALTER USER %(user)s WITH PASSWORD '%(password)s'" + cursor.execute(alter % {"user": user, "password": password}) cursor.execute(select, {"user": user}) new_pass_hash = cursor.fetchone()[0] if current_pass_hash != new_pass_hash: @@ -103,17 +103,17 @@ def user_delete(cursor, user, db): def main(): module = AnsibleModule( argument_spec=dict( - loginuser=dict(default="postgres"), - loginpass=dict(default=""), - loginhost=dict(default=""), + login_user=dict(default="postgres"), + login_password=dict(default=""), + login_host=dict(default=""), user=dict(required=True), - passwd=dict(default=None), + password=dict(default=None), state=dict(default="present", choices=["absent", "present"]), db=dict(required=True), ) ) user = module.params["user"] - passwd = module.params["passwd"] + password = module.params["password"] state = module.params["state"] db = module.params["db"] @@ -121,9 +121,9 @@ def main(): module.fail_json(msg="the python psycopg2 module is required") try: - db_connection = psycopg2.connect(host=module.params["loginhost"], - user=module.params["loginuser"], - password=module.params["loginpass"], + db_connection = psycopg2.connect(host=module.params["login_host"], + user=module.params["login_user"], + password=module.params["login_password"], database=db) cursor = db_connection.cursor() except Exception as e: @@ -131,12 +131,12 @@ def main(): if state == "present": if user_exists(cursor, user): - changed = user_mod(cursor, user, passwd, db) + changed = user_mod(cursor, user, password, db) else: - if passwd is None: - msg = "passwd parameter required when adding a user" + if password is None: + msg = "password parameter required when adding a user" module.fail_json(msg=msg) - changed = user_add(cursor, user, passwd, db) + changed = user_add(cursor, user, password, db) elif state == "absent": if user_exists(cursor, user):