From 51d7d013fbff9706910be7cbecd1720967ff486f Mon Sep 17 00:00:00 2001
From: Samuli Silvius <s.silvius@partner.samsung.com>
Date: Tue, 19 Mar 2019 08:45:54 +0200
Subject: Improve application role testability

Remove different phases for application role as
those are supposed to run after each other anyway
from playbook and pre/post steps can be disabled
by other means.

Enable Helm override file generation customization by
delegating it to separate role.

Separate Helm file transfer to own module.

NOTE: install.yml with all Helm commands (shell/command)
is not idempotent and should be fixed with separate
commit.

Issue-ID: OOM-1655

Change-Id: Ib29773c4d64a0529c71c3f93c2af7265ae94059f
Signed-off-by: Samuli Silvius <s.silvius@partner.samsung.com>
---
 .../roles/application-install/defaults/main.yml    |  1 -
 .../application-install/tasks/custom_role.yml      |  8 --
 .../roles/application-install/tasks/install.yml    | 87 ----------------------
 ansible/roles/application-install/tasks/main.yml   | 22 ------
 .../application-install/tasks/post-install.yml     |  5 --
 .../application-install/tasks/pre-install.yml      | 51 -------------
 ansible/roles/application-override/tasks/main.yml  | 16 ++++
 ansible/roles/application/defaults/main.yml        | 11 +++
 ansible/roles/application/tasks/custom_role.yml    |  8 ++
 ansible/roles/application/tasks/install.yml        | 77 +++++++++++++++++++
 ansible/roles/application/tasks/main.yml           | 24 ++++++
 ansible/roles/application/tasks/post-install.yml   |  5 ++
 ansible/roles/application/tasks/pre-install.yml    |  5 ++
 .../application/tasks/transfer-helm-charts.yml     | 44 +++++++++++
 14 files changed, 190 insertions(+), 174 deletions(-)
 delete mode 100644 ansible/roles/application-install/defaults/main.yml
 delete mode 100644 ansible/roles/application-install/tasks/custom_role.yml
 delete mode 100644 ansible/roles/application-install/tasks/install.yml
 delete mode 100644 ansible/roles/application-install/tasks/main.yml
 delete mode 100644 ansible/roles/application-install/tasks/post-install.yml
 delete mode 100644 ansible/roles/application-install/tasks/pre-install.yml
 create mode 100644 ansible/roles/application-override/tasks/main.yml
 create mode 100644 ansible/roles/application/defaults/main.yml
 create mode 100644 ansible/roles/application/tasks/custom_role.yml
 create mode 100644 ansible/roles/application/tasks/install.yml
 create mode 100644 ansible/roles/application/tasks/main.yml
 create mode 100644 ansible/roles/application/tasks/post-install.yml
 create mode 100644 ansible/roles/application/tasks/pre-install.yml
 create mode 100644 ansible/roles/application/tasks/transfer-helm-charts.yml

(limited to 'ansible/roles')

diff --git a/ansible/roles/application-install/defaults/main.yml b/ansible/roles/application-install/defaults/main.yml
deleted file mode 100644
index 473fbb80..00000000
--- a/ansible/roles/application-install/defaults/main.yml
+++ /dev/null
@@ -1 +0,0 @@
-phase: install
diff --git a/ansible/roles/application-install/tasks/custom_role.yml b/ansible/roles/application-install/tasks/custom_role.yml
deleted file mode 100644
index b6f6f351..00000000
--- a/ansible/roles/application-install/tasks/custom_role.yml
+++ /dev/null
@@ -1,8 +0,0 @@
----
-# Caller fills application_custom_role variable with actual role name.
-- name: "Execute custom role {{ application_custom_role }} {{ phase }} Helm install."
-  include_role:
-    name: "{{ application_custom_role }}"
-  when:
-    - application_custom_role is defined
-    - application_custom_role is not none
diff --git a/ansible/roles/application-install/tasks/install.yml b/ansible/roles/application-install/tasks/install.yml
deleted file mode 100644
index 1cccf9ad..00000000
--- a/ansible/roles/application-install/tasks/install.yml
+++ /dev/null
@@ -1,87 +0,0 @@
----
-- name: Helm init and upgrade
-  command: |
-     {{ helm_bin_dir }}/helm init
-     --upgrade
-     --skip-refresh
-  changed_when: true # init is always changed type of action
-
-#A correct way to implement this would be using --wait option in helm init invocation.
-#However, it does not work due to https://github.com/helm/helm/issues/4031 (fixed in newer helm release)
-- name: "Wait for helm upgrade to finish"
-  command: "{{ helm_bin_dir }}/helm version --tiller-connection-timeout 10"
-  register: result
-  until: result.rc == 0
-  delay: 10
-  retries: 12
-  changed_when: false # for idempotency
-
-- name: Get all helm repos
-  command: "{{ helm_bin_dir }}/helm repo list"
-  register: repos
-  changed_when: false # for idempotency
-
-- name: Remove stable repo
-  command: "{{ helm_bin_dir }}/helm repo remove stable"
-  changed_when: true # when executed its a changed type of action
-  when: "'stable' in repos.stdout"
-
-- name: Helm Serve
-  shell: "{{ helm_bin_dir }}/helm serve &"
-  async: 45
-  poll: 3 # wait 3sec to get a chance for some stderr
-  register: helm_serve
-  changed_when: "'address already in use' not in helm_serve.stderr"
-
-- name: List helm repos
-  command: "{{ helm_bin_dir }}/helm repo list"
-  register: helm_repo_list
-  changed_when: false # for idempotency
-  failed_when:
-    - helm_repo_list.rc > 0
-    - "'Error: no repositories to show' not in helm_repo_list.stderr"
-
-- name: Helm Add Repo
-  command: "{{ helm_bin_dir }}/helm repo add {{ helm_repository_name }} {{ helm_repository_url }}"
-  when: "'local' not in helm_repo_list.stdout"
-  changed_when: true # when executed its a changed type of action
-
-- name: Build local helm repository
-  make:
-    chdir: "{{ app_helm_charts_infra_directory }}"
-    target: "{{ item }}"
-  with_items: "{{ app_helm_build_targets }}"
-  environment:
-    PATH: "{{ helm_bin_dir }}:{{ ansible_env.PATH }}"
-
-- name: Register root certificate
-  slurp:
-    src: "{{ playbook_dir }}/certs/rootCA.crt"
-  register: root_cert
-  delegate_to: localhost
-
-# WA: this is required because deploy plugin dont process params properly
-- name: Create override file with global.cacert
-  copy:
-    dest: "{{ app_data_path }}/override.yaml"
-    content: |
-      global:
-        cacert: |
-          {{ root_cert['content'] | b64decode | indent( width=4, indentfirst=False) }}
-
-- name: Check for deploy plugin presence
-  stat:
-    path: '{{ helm_home_dir.stdout }}/plugins/deploy/deploy.sh'
-  register: deploy_plugin_presence
-
-- name: "Helm Install application {{ app_name }}"
-  command: >
-          {{ helm_bin_dir }}/helm
-          {{ 'deploy' if deploy_plugin_presence.stat.exists else 'install --name' }}
-          {{ app_helm_release_name }}
-          {{ helm_repository_name }}/{{ app_helm_chart_name }}
-          --namespace {{ app_kubernetes_namespace }}
-          -f {{ app_data_path }}/override.yaml
-  changed_when: true # when executed its a changed type of action
-  register: helm_install
-  failed_when: helm_install.stderr
diff --git a/ansible/roles/application-install/tasks/main.yml b/ansible/roles/application-install/tasks/main.yml
deleted file mode 100644
index ba522792..00000000
--- a/ansible/roles/application-install/tasks/main.yml
+++ /dev/null
@@ -1,22 +0,0 @@
----
-- debug:
-    msg: "phase is {{ phase }}"
-
-- name: Check if install needed
-  block:
-    - name: "Does {{ app_helm_charts_install_directory }} exist and contain Helm Charts"
-      find:
-        paths: "{{ app_helm_charts_install_directory }}"
-        recurse: yes
-      delegate_to: localhost
-      register: charts_files
-    - name: Set install active fact
-      set_fact:
-        install_needed: "{{ true if charts_files.matched | int > 0 else false }}"
-  when: phase == "pre-install"
-
-- include_tasks: "{{ phase }}.yml"
-  when: install_needed
-
-- debug:
-    msg: "Install needed {{ install_needed }}"
diff --git a/ansible/roles/application-install/tasks/post-install.yml b/ansible/roles/application-install/tasks/post-install.yml
deleted file mode 100644
index 10594233..00000000
--- a/ansible/roles/application-install/tasks/post-install.yml
+++ /dev/null
@@ -1,5 +0,0 @@
----
-- name: "Execute custome role {{ application_post_install_role }} if defined."
-  include_tasks: custom_role.yml
-  vars:
-    application_custom_role: "{{ application_post_install_role }}"
diff --git a/ansible/roles/application-install/tasks/pre-install.yml b/ansible/roles/application-install/tasks/pre-install.yml
deleted file mode 100644
index bf6619b0..00000000
--- a/ansible/roles/application-install/tasks/pre-install.yml
+++ /dev/null
@@ -1,51 +0,0 @@
----
-# before custom specific code is executed we need to move helm charts to infra
-- name: Distribute helm charts to infra node
-  block:
-    - name: Archive helm charts
-      archive:
-        path: "{{ app_helm_charts_install_directory }}/*"
-        dest: "{{ app_helm_charts_install_directory }}.tgz"
-      delegate_to: localhost
-    - name: Create helm charts dir on infra
-      file:
-        path: "{{ app_helm_charts_infra_directory }}"
-        state: directory
-        mode: 0755
-    - name: Unarchive helm charts on infra node
-      unarchive:
-        src: "{{ app_helm_charts_install_directory }}.tgz"
-        dest: "{{ app_helm_charts_infra_directory }}"
-
-
-- name: Install helm plugins if needed
-  block:
-    - name: Get helm dir
-      command: "{{ helm_bin_dir }}/helm home"
-      register: helm_home_dir
-    - name: Ensure that dir for helm plugins exists
-      file:
-        path: "{{ helm_home_dir.stdout }}/plugins"
-        state: directory
-        mode: 0755
-    - name: Register all plugins to be inserted by dir names
-      find:
-        paths: "{{ app_helm_plugins_directory }}"
-        file_type: "directory"
-      register: list_of_plugins
-      delegate_to: localhost
-    - name: Install all helm plugins from {{ app_helm_plugins_directory }} dir
-      copy:
-        src: "{{ item.path }}"
-        dest: "{{ helm_home_dir.stdout }}/plugins"
-        directory_mode: yes
-        mode: 0755
-      with_items: "{{ list_of_plugins.files }}"
-  become: true
-  when: app_helm_plugins_directory is defined and app_helm_plugins_directory is not none
-
-- name: "Execute custom role {{ application_pre_install_role }} if defined."
-  include_tasks: custom_role.yml
-  vars:
-    application_custom_role: "{{ application_pre_install_role }}"
-
diff --git a/ansible/roles/application-override/tasks/main.yml b/ansible/roles/application-override/tasks/main.yml
new file mode 100644
index 00000000..84896fbc
--- /dev/null
+++ b/ansible/roles/application-override/tasks/main.yml
@@ -0,0 +1,16 @@
+---
+# Role for generating Helm override.yml file
+- name: Register root certificate
+  slurp:
+    src: "{{ playbook_dir }}/certs/rootCA.crt"
+  register: root_cert
+  delegate_to: localhost
+
+# WA: this is required because deploy plugin dont process params properly
+- name: Create override file with global.cacert
+  copy:
+    dest: "{{ app_helm_override_file }}"
+    content: |
+      global:
+        cacert: |
+          {{ root_cert['content'] | b64decode | indent( width=4, indentfirst=False) }}
diff --git a/ansible/roles/application/defaults/main.yml b/ansible/roles/application/defaults/main.yml
new file mode 100644
index 00000000..dec17601
--- /dev/null
+++ b/ansible/roles/application/defaults/main.yml
@@ -0,0 +1,11 @@
+---
+helm_repository_name: local
+helm_repository_url: http://127.0.0.1:8879
+# Override file generation for Helm application can be customized by any role
+# given by user and found by ansible from roles_path.
+# By default override file is generated by 'application-override' role that is
+# specific for offline installer (for onap) as it's generating server
+# certificate needed to simulate internet by offline installer.
+app_skip_helm_override: false
+app_helm_override_role: application-override
+app_helm_override_file: "{{ app_data_path }}/override.yaml"
diff --git a/ansible/roles/application/tasks/custom_role.yml b/ansible/roles/application/tasks/custom_role.yml
new file mode 100644
index 00000000..f0b9a84f
--- /dev/null
+++ b/ansible/roles/application/tasks/custom_role.yml
@@ -0,0 +1,8 @@
+---
+# Caller fills application_custom_role variable with actual role name.
+- name: "Execute custom role {{ application_custom_role }} for Helm install."
+  include_role:
+    name: "{{ application_custom_role }}"
+  when:
+    - application_custom_role is defined
+    - application_custom_role is not none
diff --git a/ansible/roles/application/tasks/install.yml b/ansible/roles/application/tasks/install.yml
new file mode 100644
index 00000000..103ecc8b
--- /dev/null
+++ b/ansible/roles/application/tasks/install.yml
@@ -0,0 +1,77 @@
+---
+- name: Helm init and upgrade
+  command: |
+     {{ helm_bin_dir }}/helm init
+     --upgrade
+     --skip-refresh
+  changed_when: true # init is always changed type of action
+
+# A correct way to implement this would be using --wait option in helm init invocation.
+# However, it does not work due to https://github.com/helm/helm/issues/4031 (fixed in newer helm release)
+- name: "Wait for helm upgrade to finish"
+  command: "{{ helm_bin_dir }}/helm version --tiller-connection-timeout 10"
+  register: result
+  until: result.rc == 0
+  delay: 10
+  retries: 12
+  changed_when: false # for idempotency
+
+- name: Get all helm repos
+  command: "{{ helm_bin_dir }}/helm repo list"
+  register: repos
+  changed_when: false # for idempotency
+
+- name: Remove stable repo
+  command: "{{ helm_bin_dir }}/helm repo remove stable"
+  changed_when: true # when executed its a changed type of action
+  when: "'stable' in repos.stdout"
+
+- name: Helm Serve
+  shell: "{{ helm_bin_dir }}/helm serve &"
+  async: 45
+  poll: 3 # wait 3sec to get a chance for some stderr
+  register: helm_serve
+  changed_when: "'address already in use' not in helm_serve.stderr"
+
+- name: List helm repos
+  command: "{{ helm_bin_dir }}/helm repo list"
+  register: helm_repo_list
+  changed_when: false # for idempotency
+  failed_when:
+    - helm_repo_list.rc > 0
+    - "'Error: no repositories to show' not in helm_repo_list.stderr"
+
+- name: Helm Add Repo
+  command: "{{ helm_bin_dir }}/helm repo add {{ helm_repository_name | mandatory }} {{ helm_repository_url | mandatory }}"
+  when: "'local' not in helm_repo_list.stdout"
+  changed_when: true # when executed its a changed type of action
+
+- name: Build local helm repository
+  make:
+    chdir: "{{ app_helm_charts_infra_directory }}"
+    target: "{{ item }}"
+  loop: "{{ app_helm_build_targets }}"
+  environment:
+    PATH: "{{ helm_bin_dir }}:{{ ansible_env.PATH }}"
+
+- name: Generate Helm application override file with custom role
+  include_role:
+    name: "{{ app_helm_override_role }}"
+  when: not app_skip_helm_override
+
+- name: Check for deploy plugin presence
+  stat:
+    path: '{{ helm_home_dir.stdout }}/plugins/deploy/deploy.sh'
+  register: deploy_plugin_presence
+
+- name: "Helm Install application {{ app_name }}"
+  command: >
+          {{ helm_bin_dir }}/helm
+          {{ 'deploy' if deploy_plugin_presence.stat.exists else 'install --name' }}
+          {{ app_helm_release_name }}
+          {{ helm_repository_name }}/{{ app_helm_chart_name }}
+          --namespace {{ app_kubernetes_namespace }}
+          {{ '' if app_skip_helm_override else '-f ' + app_helm_override_file }}
+  changed_when: true # when executed its a changed type of action
+  register: helm_install
+  failed_when: helm_install.stderr
diff --git a/ansible/roles/application/tasks/main.yml b/ansible/roles/application/tasks/main.yml
new file mode 100644
index 00000000..3018e95f
--- /dev/null
+++ b/ansible/roles/application/tasks/main.yml
@@ -0,0 +1,24 @@
+---
+- name: Check if application Helm charts exist and install is even needed
+  block:
+    - name: "Does {{ app_helm_charts_install_directory }} directory exist and contain Helm Charts"
+      find:
+        paths: "{{ app_helm_charts_install_directory }}"
+        recurse: true
+      delegate_to: localhost
+      register: charts_files
+    - name: Set install active fact
+      set_fact:
+        install_needed: "{{ true if charts_files.matched | int > 0 else false }}"
+
+- name: Install app with Helm charts
+  block:
+    - include_tasks: transfer-helm-charts.yml
+    - include_tasks: pre-install.yml
+    - include_tasks: install.yml
+    - include_tasks: post-install.yml
+  when: install_needed
+
+- debug:
+    msg: "NOTE, nothing done as application Helm charts does not exist!"
+  when: not install_needed
diff --git a/ansible/roles/application/tasks/post-install.yml b/ansible/roles/application/tasks/post-install.yml
new file mode 100644
index 00000000..5464cb46
--- /dev/null
+++ b/ansible/roles/application/tasks/post-install.yml
@@ -0,0 +1,5 @@
+---
+- name: "Execute custome role {{ application_post_install_role }} if defined."
+  include_tasks: custom_role.yml
+  vars:
+    application_custom_role: "{{ application_post_install_role | default('') }}"
diff --git a/ansible/roles/application/tasks/pre-install.yml b/ansible/roles/application/tasks/pre-install.yml
new file mode 100644
index 00000000..74f1548f
--- /dev/null
+++ b/ansible/roles/application/tasks/pre-install.yml
@@ -0,0 +1,5 @@
+---
+- name: "Execute custom role {{ application_pre_install_role }} if defined."
+  include_tasks: custom_role.yml
+  vars:
+    application_custom_role: "{{ application_pre_install_role | default('') }}"
diff --git a/ansible/roles/application/tasks/transfer-helm-charts.yml b/ansible/roles/application/tasks/transfer-helm-charts.yml
new file mode 100644
index 00000000..0cd7c02f
--- /dev/null
+++ b/ansible/roles/application/tasks/transfer-helm-charts.yml
@@ -0,0 +1,44 @@
+---
+# before custom specific code is executed we need to move helm charts to infra
+- name: Distribute helm charts to infra node
+  block:
+    - name: Archive helm charts
+      archive:
+        path: "{{ app_helm_charts_install_directory }}/*"
+        dest: "{{ app_helm_charts_install_directory }}.tgz"
+      delegate_to: localhost
+    - name: Create helm charts dir on infra
+      file:
+        path: "{{ app_helm_charts_infra_directory }}"
+        state: directory
+        mode: 0755
+    - name: Unarchive helm charts on infra node
+      unarchive:
+        src: "{{ app_helm_charts_install_directory }}.tgz"
+        dest: "{{ app_helm_charts_infra_directory }}"
+
+
+- name: Install helm plugins if needed
+  block:
+    - name: Get helm dir
+      command: "{{ helm_bin_dir }}/helm home"
+      register: helm_home_dir
+    - name: Ensure that dir for helm plugins exists
+      file:
+        path: "{{ helm_home_dir.stdout }}/plugins"
+        state: directory
+        mode: 0755
+    - name: Register all plugins to be inserted by dir names
+      find:
+        paths: "{{ app_helm_plugins_directory }}"
+        file_type: "directory"
+      register: list_of_plugins
+      delegate_to: localhost
+    - name: Install all helm plugins from {{ app_helm_plugins_directory }} dir
+      copy:
+        src: "{{ item.path }}"
+        dest: "{{ helm_home_dir.stdout }}/plugins"
+        directory_mode: true
+        mode: 0755
+      with_items: "{{ list_of_plugins.files }}"
+  when: app_helm_plugins_directory is defined and app_helm_plugins_directory is not none
-- 
cgit 1.2.3-korg