Bug 1570603: Make postgresql-apb (de)provision idempotent (#45)

* Make postgresql-apb ansible galaxy compatible

* Update RPM Spec

* Move travis to use apb-test-shim

* Remove pvc on upgrade/downgrade

Author: djzager

.travis.yml

@@ -1,15 +1,33 @@
-language: go
-go:
-  - "1.8.x"
-dist: trusty
+---
+services: docker
 sudo: required
-group: edge
-
-before_script:
-  - curl -s https://raw.githubusercontent.com/openshift/ansible-service-broker/master/scripts/travis.sh | bash -s before_install
-  - curl -s https://raw.githubusercontent.com/openshift/ansible-service-broker/master/scripts/travis.sh | bash -s install
-  - curl -s https://raw.githubusercontent.com/openshift/ansible-service-broker/master/scripts/travis.sh | bash -s before_script
-  - curl -s https://raw.githubusercontent.com/openshift/ansible-service-broker/master/scripts/broker-ci/setup-cluster.sh | bash -s
-  - go get github.com/rthallisey/service-broker-ci/cmd/ci
+language: python
+python:
+  - '2.7'
+
+env:
+  - OPENSHIFT_VERSION=v3.9
+  - OPENSHIFT_VERSION=v3.10
+  - KUBERNETES_VERSION=v1.9.0
+  - KUBERNETES_VERSION=v1.10.0
+# Allow failures on oc latest
+# TODO: re-enable latest when it isn't busted
+matrix:
+  allow_failures:
+    - env: OPENSHIFT_VERSION=v3.10
+    - env: KUBERNETES_VERSION=v1.10.0
+
 script:
-  - ci
+  # Configure test values
+  - export apb_name='postgresql-apb'
+  - export dockerfile='Dockerfile-canary'
+
+  # Download test shim.
+  - wget -O ${PWD}/apb-test.sh https://raw.githubusercontent.com/ansibleplaybookbundle/apb-test-shim/master/apb-test.sh
+  - chmod +x ${PWD}/apb-test.sh
+
+  # Run tests.
+  - ${PWD}/apb-test.sh
+
+notifications:
+  webhooks: https://galaxy.ansible.com/api/v1/notifications/

Dockerfile-canary

@@ -1,5 +1,5 @@
 FROM ansibleplaybookbundle/apb-base:canary
-# MAINTAINER {{ $MAINTAINER }}
+MAINTAINER Ansible Playbook Bundle Community
 
 LABEL "com.redhat.apb.spec"=\
 "LS0tCgp2ZXJzaW9uOiAxLjAKbmFtZTogcG9zdGdyZXNxbC1hcGIKZGVzY3JpcHRpb246IFNDTCBQ\
@@ -56,8 +56,11 @@ ICcxMEdpJ10KICAgICAgICB0aXRsZTogUG9zdGdyZVNRTCBWb2x1bWUgU2l6ZQogICAgICAgIHJl\
 cXVpcmVkOiB0cnVlCiAgICB1cGRhdGVzX3RvOgogICAgICAtIGRldgo="
 
 
-COPY roles /opt/ansible/roles
-COPY playbooks/* /opt/apb/actions/
+ADD playbooks /opt/apb/actions
+
+# Add our role into the ansible roles dir
+ADD . /opt/ansible/roles/postgresql-apb
+
 RUN chmod -R g=u /opt/{ansible,apb}
 
 USER apb

README.md

@@ -1,25 +1,34 @@
-postgresql-apb
-======================
+[![Build
+Status](https://travis-ci.org/ansibleplaybookbundle/postgresql-apb.svg?branch=master)](https://travis-ci.org/ansibleplaybookbundle/postgresql-apb)
 
-[![Build Status](https://travis-ci.org/ansibleplaybookbundle/postgresql-apb.svg?branch=master)](https://travis-ci.org/openshift/ansible-service-broker)
+PostgreSQL APB
+==============
 
-An apb for deploying [PostgreSQL](https://www.postgresql.org).
+Ansible Role for installing (and uninstalling) [postgresql](https://www.postgresql.org/about/)
+in a Kubernetes/OpenShift Cluster.
 
-## What it does
-* Deploys 1 postgresql container.
+Requirements
+------------
 
-## Requirements
-* N/A
+- [openshift-restclient-python](https://github.com/openshift/openshift-restclient-python)
+- [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/)
 
-## Parameters
-* namespace: Optional, default 'rhscl-postgresql-apb', Namespace to deploy the cluster in.
-* postgresql_database, Optional, default 'admin', Postgresql database name.
-* postgresql_password, Optional, default is a randomly generated string, Postgresql databaase password.
-* postgresql_user, Optional, default 'admin', Postgresql database username.
-* postgresql_version, Optional, default '9.6', Postgresql version. 9.4, 9.5, and 9.6 are supported.
+Role Variables
+--------------
 
-## Running the application
-`docker run --rm --net=host -v $HOME/.kube:/opt/apb/.kube:z -u $UID docker.io/ansibleplaybookbundle/postresql-apb provision`
+See [defaults/main.yaml](defaults/main.yaml).
 
-## Tearing down the application
-`docker run -e "OPENSHIFT_TARGET=<openshift_target>" -e "OPENSHIFT_TOKEN=<token>" ansibleplaybookbundle/postgresql-apb deprovision`
+Example Playbook
+----------------
+
+See [playbooks/provision.yml](playbooks/provision.yml).
+
+License
+-------
+
+Apache-2.0
+
+Author Information
+------------------
+
+http://automationbroker.io

config.yaml

@@ -0,0 +1,17 @@
+---
+
+# Defaults for values we could expect from a broker
+_apb_plan_id: default
+_apb_service_class_id: 0
+_apb_service_instance_id: 0
+
+app_name: "postgresql-{{ _apb_service_instance_id }}"
+app_image: registry.access.redhat.com/rhscl/postgresql-{{ postgresql_version | replace('.', '') }}-rhel7
+namespace: "{{ lookup('env','NAMESPACE') | default('postgresql', true) }}"
+
+# Postgresql defaults
+postgresql_database: admin
+postgresql_user: admin
+postgresql_password: changeme
+postgresql_volume_size: 1Gi
+postgresql_version: "9.6"

defaults/main.yml

@@ -0,0 +1,19 @@
+galaxy_info:
+  author: Automation Broker Team
+  description: Deploys PostgreSQL Database in OpenShift/Kubernetes
+  company: Red Hat
+  license: Apache 2.0
+  min_ansible_version: 1.5
+
+  #
+  # platforms is a list of platforms, and each platform has a name and a list of versions.
+  #
+  platforms:
+    - name: Centos
+
+  galaxy_tags:
+    - apb
+
+dependencies: []
+  # List your role dependencies here, one per line. Be sure to remove the '[]' above,
+  # if you add dependencies to this list.

meta/main.yml

@@ -1,11 +1,9 @@
-- name: Deploy rhscl-postgresql-apb to "{{ cluster }}"
+- name: postgresql-apb deprovision
   hosts: localhost
   gather_facts: false
   connection: local
-  vars:
-    state: absent
   roles:
-  - role: ansible.kubernetes-modules
-    install_python_requirements: no
-  - role: ansibleplaybookbundle.asb-modules
-  - rhscl-postgresql-apb
+  - ansibleplaybookbundle.asb-modules
+  - postgresql-apb
+  vars:
+    apb_action: deprovision

playbooks/deprovision.yaml

@@ -1,9 +1,9 @@
-- name: Deploy rhscl-postgresql-apb to "{{ cluster }}"
+- name: postgresql-apb provision
   hosts: localhost
   gather_facts: false
   connection: local
   roles:
-  - role: ansible.kubernetes-modules
-    install_python_requirements: no
-  - role: ansibleplaybookbundle.asb-modules
-  - rhscl-postgresql-apb
+  - ansibleplaybookbundle.asb-modules
+  - postgresql-apb
+  vars:
+    apb_action: provision

playbooks/provision.yaml

@@ -0,0 +1,24 @@
+---
+
+- name: Test postgresql-apb
+  hosts: localhost
+  gather_facts: false
+  connection: local
+
+  roles:
+  - ansibleplaybookbundle.asb-modules
+
+  tasks:
+    - name: Provision test
+      include_role:
+        name: postgresql-apb
+      vars:
+        apb_action: provision
+        in_cluster: False
+
+    - name: Deprovision test
+      include_role:
+        name: postgresql-apb
+      vars:
+        apb_action: deprovision
+        in_cluster: False

playbooks/test.yaml

@@ -1,11 +1,9 @@
-- name: Deploy rhscl-postgresql-apb to "{{ cluster }}"
+- name: postgresql-apb update
   hosts: localhost
   gather_facts: false
   connection: local
-  vars:
-    update: true
   roles:
-  - role: ansible.kubernetes-modules
-    install_python_requirements: no
-  - role: ansibleplaybookbundle.asb-modules
-  - rhscl-postgresql-apb
+  - ansibleplaybookbundle.asb-modules
+  - postgresql-apb
+  vars:
+    apb_action: update

playbooks/update.yaml

@@ -21,9 +21,9 @@ BuildArch:  	noarch
 %setup -q -n %{name}-%{version}
 
 %install
-mkdir -p %{buildroot}/opt/apb/ %{buildroot}/opt/ansible/
+mkdir -p %{buildroot}/opt/apb/ %{buildroot}/opt/ansible/roles/postgresql-apb
 mv playbooks %{buildroot}/opt/apb/actions
-mv roles %{buildroot}/opt/ansible/roles
+mv defaults tasks templates vars %{buildroot}/opt/ansible/roles/postgresql-apb
 
 %files
 %doc