Structural refactoring

Author: Frank Neff

.travis.yml

@@ -0,0 +1,35 @@
+---
+sudo: required
+
+env:
+  - distribution: centos
+    verions: 6
+  #- distribution: centos
+  #  verions: 7
+  #- distribution: ubuntu
+  #  version: xenial
+  - distribution: ubuntu
+    version: trusty
+  #- distribution: debian
+  #  version: stretch
+  #- distribution: debian
+  #  version: jessie
+
+services:
+  - docker
+
+before_install:
+  - 'sudo docker pull ${distribution}:${version}'
+  - 'sudo docker build --no-cache --rm --file=travis/Dockerfile.${distribution}-${version} --tag=${distribution}-${version}:ansible travis'
+
+script:
+  - container_id=$(mktemp)
+  - 'sudo docker run --detach --privileged -v /sys/fs/cgroup:/sys/fs/cgroup:ro --volume="${PWD}":/etc/ansible/roles/nginx_role:ro ${distribution}-${version}:ansible > "${container_id}"'
+  - 'sudo docker exec "$(cat ${container_id})" env ANSIBLE_FORCE_COLOR=1 ansible-playbook -v /etc/ansible/roles/nginx_role/travis/test.yml --syntax-check'
+  - 'sudo docker exec "$(cat ${container_id})" env ANSIBLE_FORCE_COLOR=1 ansible-playbook -v /etc/ansible/roles/nginx_role/travis/test.yml'
+  - >
+    sudo docker exec "$(cat ${container_id})" env ANSIBLE_FORCE_COLOR=1 ansible-playbook -v /etc/ansible/roles/nginx_role/travis/test.yml
+    | grep -q 'changed=0.*failed=0'
+    && (echo 'Idempotence test: pass' && exit 0)
+    || (echo 'Idempotence test: fail' && exit 1)
+  - 'sudo docker rm -f "$(cat ${container_id})"'

README.md

@@ -1,9 +1,64 @@
 Ansible Java Deployment
 =======================
 
-**Works for all the things packages to a zip / tarball (e.g. sbt native-packager stuff)**
+**Highly configurable deployment role for (Java/Scala) software packages**
 
-TBD
+Features
+--------
+
+**Downloads and extracts almost any packaged deployment artifact**
+
+Use it to download packages from your Artifactory, Nexus or static package hosting. By now, the role supports e.g.
+[SBT Native Packager](https://github.com/sbt/sbt-native-packager) packages, 
+[Play Framework 2.x](https://www.playframework.com/) dists and virtually anything runnable packed in a zip or tar(.gz) 
+archive.
+
+**Generic application deployment**
+
+The deployment consists of generic actions for downloading, unpacking and moving the application into place, configure 
+logging, starting, stoping and restarting the application, and so on. All tasks and templates are highly configurable.
+
+**Service management**
+
+Multiple service runners like `upstart` or `systemd` can be used to register fully functional services for the deployed 
+applications. Support for more application daemons is planned.
+
+**Manage multiple application instances on a single machine**
+
+The configurable directory structure, serive management and configuration allows to deploy the same application into 
+multiple instances, even on the same server. This can be utilized to achive zero-downtime or A/B deployments.
+
+Usage
+-----
+
+As described above, the whole deployment is basically a configurable Ansible role. To use it, download it from GitHub or 
+use Ansible Galaxy to install it directly into your existing playbook:
+
+```
+ansible-galaxy install acmesoftware.java-deployment
+```
+
+### Basic Example
+
+If you just want to use it to deploy a simple app instance, there is very little minimal configuration to do. Add the 
+following example to your playbook (e.g. `deploy.yml`):
+
+
+```yml
+- hosts: application-servers
+  vars:
+    deploy_artifact_url: "http://my.artifact.server/app-1.0-SNAPSHOT.zip"
+    deploy_app_name: "my-application"
+    deploy_service_start_command: "bin/{{ deploy_app_name }} -Dfoo=bar"
+  roles:
+    - acmesoftware.java-deployment
+```
+
+Ideas / Todo
+------------
+
+* Use Java Service Wraper (optional)
+  * http://yajsw.sourceforge.net/
 
 Tests
 -----
@@ -16,25 +71,25 @@ deploy role.
 **Boot vagrant boxes**
 
 ```bash
-cd test/centos_6
+cd tests/centos_6
 vagrant up
 ```
 
 **Provide example play app for download:**
 ```bash
-cd test/testapp/play-java-seed
+cd tests/testapp/play-java-seed
 sbt dist
 cd target/universal
 python -m SimpleHTTPServer
 ```
 **Run test Playbook**
 
 ```bash
-cd test/playbook
+cd tests/playbook
 ansible-playbook -i hosts deploy.yml
 ```
 
 ### Tested with
-* Ansible 2.4
-* Virtualbox 5.2
+* Ansible 2.3 / 2.4
+* Virtualbox 0.5 / 5.1 / 5.2
 * Vagrant 2.1 / 1.9.7

roles/deploy/defaults/main.yml renamed to defaults/main.yml

@@ -1,4 +1,4 @@
-# Default variables for the playbook, override them for your own deployment
+# Default variables for the playbook, override them in your playbook or inventory
 
 # General Settings
 ###############################################

roles/deploy/handlers/main.yml renamed to handlers/main.yml

@@ -15,6 +15,14 @@
     group: "{{ deploy_app_group }}"
     state: present
 
+- name: "Preinstall - Ensure base directory {{ deploy_dir_base }}"
+  become: yes
+  file:
+    path: "{{ deploy_dir_base }}"
+    state: directory
+    owner: "{{ deploy_app_user }}"
+    group: "{{ deploy_app_group }}"
+
 - name: "Preinstall - Ensure directories for instance {{ deploy_instance_nr }}"
   become: yes
   become_user: "{{ deploy_app_user }}"
@@ -24,7 +32,6 @@
     owner: "{{ deploy_app_user }}"
     group: "{{ deploy_app_group }}"
   with_items:
-    - "{{ deploy_dir_base }}"
     - "{{ deploy_download_dir }}"
     - "{{ deploy_dir_instances }}"
     - "{{ deploy_dir_instance }}"