Merge pull request #13 from wcm-io-devops/feature/in-place-upgrade

Add AEM in-place-upgrade functionality

Author: tobias-richter

.travis.yml

@@ -6,7 +6,7 @@ env:
   # run against latest version
   - ANSIBLE_VERSION=latest
   # run against minimal required version
-  - ANSIBLE_VERSION=2.2.*
+  - ANSIBLE_VERSION=2.4.*
 
 # Use the new container infrastructure
 sudo: false

README.md

@@ -83,6 +83,30 @@ Sets the `nofile` limit for the AEM user.
 
 Controls if Java is installed by using [srsp.oracle-java](https://galaxy.ansible.com/srsp/oracle-java/) role for installing Java.
 
+    aem_cms_in_place_upgrade: false
+
+Enables / disables in-place-upgrade.
+
+:exclamation: Warnings
+* Use the in place upgrade functionality with care and test it in a
+  staging environment before applying it to production!
+* Do not use this mechanism when a content repository migration is
+  necessary!
+* Do not use this mechanism when upgrading from AEM 6.2 to AEM 6.3+
+
+```
+aem_cms_in_place_upgrade_paths:
+  "6.3.0":
+    - "6.4.0"
+```
+
+Format:
+
+    "from_version":
+        - "to_version" # list of versions that an upgrade is allowed for
+
+Specifies from and to versions which are supported by the
+in-place-upgrade mechanism.
 
 ## Dependencies
 

defaults/main.yml

@@ -55,3 +55,14 @@ aem_cms_limit_nofile: 20000
 
 # controls if the java dependency is enabled/disabled
 aem_cms_dependency_java: true
+
+# Enables / disables in-place-upgrade
+aem_cms_in_place_upgrade: false
+
+# Specifies from and to versions which are supported for an in-place-upgrade
+aem_cms_in_place_upgrade_paths:
+  "6.3.0":
+    - "6.4.0"
+# "from_version":
+#    - "to_version" # list of versions that an upgrade is allowed for
+

meta/main.yml

@@ -5,7 +5,7 @@ galaxy_info:
   company: pro!vision
   issue_tracker_url: https://wcm-io.atlassian.net
   license: Apache
-  min_ansible_version: 2.2
+  min_ansible_version: 2.4
 
   platforms:
   - name: Ubuntu

tasks/in_place_upgrade.yml

@@ -0,0 +1,41 @@
+# get the latest version of all the existing jar files
+- name: "in_place_upgrade : detect version to upgrade from."
+  set_fact:
+     aem_cms_in_place_upgrade_existing_version: "{{ aem_cms_in_place_upgrade_existing_quickstarts | map('regex_replace', '^.*cq-quickstart-(.+)-standalone-quickstart.jar$', '\\1') | list | sort | reverse | list | first}}"
+
+# safe gate which only allows upgrades when allowed
+- name: "in_place_upgrade : fail when upgrade is not allowed."
+  fail:
+    msg:
+      - "In place upgrade is not allowed, 'aem_cms_in_place_upgrade' is set to '{{ aem_cms_in_place_upgrade }}'"
+      - "existing version: '{{ aem_cms_in_place_upgrade_existing_version }}'"
+      - "version to deploy: '{{ aem_cms_version }}'"
+  when: not aem_cms_in_place_upgrade
+
+# fail on downgrade
+- name: "in_place_upgrade : fail on downgrade."
+  fail:
+    msg:
+    - "Downgrading is not allowed/supported!"
+    - "existing version: '{{ aem_cms_in_place_upgrade_existing_version }}'"
+    - "version to deploy: '{{ aem_cms_version }}'"
+  when: aem_cms_version is version_compare(aem_cms_in_place_upgrade_existing_version, '<')
+
+# check if upgrading is allowed based on existing and new version
+- name: "in_place_upgrade : fail when upgrade path from '{{ aem_cms_in_place_upgrade_existing_version }}' to '{{ aem_cms_version }}' is not allowed."
+  fail:
+    msg: "Upgrade from {{ aem_cms_in_place_upgrade_existing_version }} to {{ aem_cms_version }} is not allowed."
+  when: aem_cms_in_place_upgrade_paths[aem_cms_in_place_upgrade_existing_version] is not defined or
+        aem_cms_version not in aem_cms_in_place_upgrade_paths[aem_cms_in_place_upgrade_existing_version]
+
+# ensure instance is stopped before renaming the jars
+- name: "in_place_upgrade : stopping existing instance for upgrade."
+  service:
+    name: "{{ aem_cms_service_name }}"
+    state: stopped
+
+# rename old quickstart jars to *.jar.bak because default start script will use first jar found in the app folder
+- name: "in_place_upgrade : create a backup of existing quickstart(s)."
+  command: "mv {{ item }} {{ item }}.bak"
+  changed_when: true
+  with_items: "{{ aem_cms_in_place_upgrade_existing_quickstarts }}"

tasks/main.yml

@@ -36,6 +36,22 @@
         (aem_cms_quickstart_sha1 is defined and
         (aem_cms_quickstart_sha1 | lower) != aem_cms_quickstart_file.stat.checksum)
 
+- name: "Check for existing AEM installation with versions different than {{ aem_cms_version }}."
+  find:
+    paths: "{{ aem_cms_home }}/crx-quickstart/app/"
+    patterns:
+      - "cq-quickstart-*-standalone-quickstart.jar"
+  register: aem_cms_existing_quickstarts
+
+- name: "Set fact with existing quickstart paths."
+  set_fact:
+    aem_cms_in_place_upgrade_existing_quickstarts:  "{{ aem_cms_existing_quickstarts.files | map(attribute='path') | list }}"
+
+- name: Include tasks for in-place-upgrade when necessary.
+  include_tasks: in_place_upgrade.yml
+  # only perform in place upgrade when no jar containing aem_cms_version is present
+  when: aem_cms_in_place_upgrade_existing_quickstarts | map('basename') | list | select('search', aem_cms_version) | list | length == 0
+
 - name: Unpack AEM.
   shell: "su {{ aem_cms_user }} -l -c 'java -jar {{ aem_cms_download_path }}/{{ aem_cms_quickstart_name }} -unpack -b {{ aem_cms_home }}'"
   args: