- Pipelines deployment (OpenShift) is now a template

- Adds Ansible role/playbook for deployment

Author: Alan Christie

deploy.sh

@@ -3,12 +3,15 @@
 # A simple deployment script for OpenShift.
 # It is assumed that your OpenShift Squonk application has been deployed
 # and that you are running this from the Squonk project/namespace
-# and have logged in as an appropriate user and have run `source setenv.sh`
+# and have logged in as an appropriate user and have run `source setenv.sh`.
+#
+# You will need to first delete any prior job (or look at the related
+# Ansible playbook/role in this project - which does =things a little better)
 
 set -e pipefail
 
 oc login -u $OC_ADMIN
 oc project $OC_PROJECT
-oc create -f post-service-descriptors.yaml
+oc process -f post-service-descriptors.yaml | oc create -f -
 
 echo "Squonk pipelines deployment is underway..."

openshift/ansible/README.md

@@ -0,0 +1,22 @@
+# Squonk Ansible OpenShift Pipelines Deployment
+A simple way to (re)deploy the pipelines to OpenShift: -
+
+    ansible-playbook playbooks/pipelines/deploy.yaml
+
+>   Remember to first `source` an appropriately crafted
+    `setenv.sh` script first! (see below)
+
+## Prerequisites
+Before running the playbook: -
+
+1.  You're on the bastion node
+1.  You have installed Ansible (any version from 2.5)
+1.  The `oc` command-set is available to you as a user
+1.  An OpenShift cluster has been installed
+1.  There is an `admin` user known to the cluster
+1.  You have setup your own `setenv.sh`
+    (typically in Squonk's `openshift/templates`)
+    and you have run `source setenv.sh` using it.
+
+## MiniShift considerations
+While it's a work-in-progress, it should also work on MiniShift.

openshift/ansible/ansible.cfg

@@ -0,0 +1,2 @@
+[defaults]
+inventory = inventory

openshift/ansible/group_vars/all.yaml

@@ -0,0 +1,14 @@
+---
+
+oc_admin: "{{ ansible_env.OC_ADMIN }}"
+oc_admin_password: "{{ ansible_env.OC_ADMIN_PASSWORD }}"
+oc_master_hostname: "{{ ansible_env.OC_MASTER_HOSTNAME }}"
+oc_project: "{{ ansible_env.OC_PROJECT }}"
+oc_pipelines_sd_poster_image_tag: "{{ ansible_env.OC_PIPELINES_SD_POSTER_IMAGE_TAG }}"
+
+# Various retry timeouts (seconds)...
+pod_ready_timeout: 600
+
+# Our template directory
+# (relative to the role_path directory)
+t_dir: ../../../..

openshift/ansible/inventory

@@ -0,0 +1,2 @@
+[localhost]
+127.0.0.1 ansible_connection=local

openshift/ansible/playbooks/pipelines/deploy.yaml

@@ -0,0 +1,6 @@
+---
+
+- hosts: localhost
+
+  roles:
+  - pipelines

openshift/ansible/playbooks/pipelines/roles

@@ -0,0 +1 @@
+../../roles/

openshift/ansible/roles/pipelines/defaults/main.yaml

@@ -0,0 +1,3 @@
+---
+
+job_name: pipelines-sd-poster

openshift/ansible/roles/pipelines/tasks/main.yaml

@@ -0,0 +1,37 @@
+---
+
+# Login and move to the Squonk project
+# and then remove any existing poster job
+# before deploying a new one (and waiting for completion).
+
+- name: Login (admin)
+  shell: oc login {{ oc_master_hostname }} -u {{ oc_admin }} -p {{ oc_admin_password }}
+  changed_when: False
+
+- name: Move to Squonk Project
+  shell: oc project {{ oc_project }}
+  changed_when: False
+
+- name: Get jobs
+  shell: oc get jobs
+  register: jobs_result
+  changed_when: False
+
+- name: Delete existing SD poster job
+  shell: oc delete jobs/{{ job_name }}
+  when: jobs_result.stdout | regex_search('^%s' % job_name, multiline=True)
+
+- name: Run SD poster job (always)
+  shell: >
+    oc process
+    -f {{ role_path }}/{{ t_dir }}/post-service-descriptors.yaml
+    -p POSTER_IMAGE_TAG={{ oc_pipelines_sd_poster_image_tag }}
+    | oc create -f -
+
+- name: Wait for SD poster success
+  shell: oc describe jobs/{{ job_name }} | grep '1 Succeeded'  | grep 1
+  delay: 10
+  retries: "{{ (pod_ready_timeout | int / 10) | int }}"
+  register: result
+  until: result.rc == 0
+  changed_when: False

post-service-descriptors.yaml

@@ -2,23 +2,42 @@
 
 # The OpenShift Job definition for the Squonk Pipelines SD-Loader image.
 # With Squonk running you can execute this in the Squonk project namespace
-# to enable the defined pipelines.
+# to enable the defined pipelines
+# (by using the Ansible playbook 'pipelines/deploy.yaml')
 #
-# oc create -f post-service-descriptors.yaml
+# oc process -f post-service-descriptors.yaml | oc create -f -
+# oc delete job --selector template=pipelines-sd-poster
 
-kind: Job
-apiVersion: batch/v1
+kind: Template
+apiVersion: v1
 metadata:
-  generateName: pipelines-sd-poster-
-spec:
-  template:
-    spec:
-      initContainers:
-      - image: yauritux/busybox-curl
-        name: wait-for-core-before-pipelines-post
-        command: ['sh', '-c',
-          'until (( curl http://coreservices:8080/rest/ping --connect-timeout 5 )); do sleep 2; done']
-      containers:
-      - image: squonk/rdkit-pipelines-sdposter:latest
-        name: pipelines-sd-poster
-      restartPolicy: Never
+  name: pipelines-sd-poster
+labels:
+  template: pipelines-sd-poster
+
+parameters:
+
+- name: POSTER_IMAGE_TAG
+  value: latest
+
+objects:
+
+- kind: Job
+  apiVersion: batch/v1
+  metadata:
+    name: pipelines-sd-poster
+  spec:
+    template:
+      spec:
+
+        initContainers:
+        - image: yauritux/busybox-curl
+          name: wait-for-core-before-pipelines-post
+          command: ['sh', '-c',
+            'until (( curl http://coreservices:8080/rest/ping --connect-timeout 5 )); do sleep 2; done']
+
+        containers:
+        - image: squonk/rdkit-pipelines-sdposter:${POSTER_IMAGE_TAG}
+          name: pipelines-sd-poster
+
+        restartPolicy: Never