Test pull request

.travis.yml

@@ -6,7 +6,7 @@ services:
 
 env:
   global:
-    - DOCKER_COMPOSE_VERSION=1.6.0
+    - DOCKER_COMPOSE_VERSION=1.6.2
     - INITIAL_ADMIN_USER=admin.user
     - INITIAL_ADMIN_PASSWORD_PLAIN=admin123
     - COMPOSE_FILES="-f site/docker-compose.yml"

README.md

@@ -1,4 +1,5 @@
 [![Build Status](https://travis-ci.org/Accenture/adop-docker-compose.svg?branch=master)](https://travis-ci.org/Accenture/adop-docker-compose)
+[![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/Accenture/ADOP)
 
 # The DevOps Platform: Overview
 
@@ -20,7 +21,7 @@ Once you have explored this the next step is to create your own Workspace and Pr
 
 # Quickstart Instructions
 
-These instructions will spin up an instance in a single server in AWS (for evaluation purposes).
+These instructions will spin up an instance in a single server in AWS (for evaluation purposes).  Please check the [prerequisites](http://accenture.github.io/adop-docker-compose/docs/prerequisites/).
 
 NB. the instructions will also work in anywhere supported by [Docker Machine](https://docs.docker.com/machine/), just follow the relevant Docker Machine instructions for your target platform and then start at step 3 below and (you can set the AWS_VPC_ID to NA).
 
@@ -36,7 +37,7 @@ NB. the instructions will also work in anywhere supported by [Docker Machine](ht
         Usage: ./quickstart.sh -t aws
                                -m <MACHINE_NAME>  
                                -c <AWS_VPC_ID> 
-                               -r <AWS_DEFAULT_REGION>(optional) 
+                               -r <AWS_DEFAULT_REGION> 
                                -z <VPC_AVAIL_ZONE>(optional)
                                -a <AWS_ACCESS_KEY>(optional) 
                                -s <AWS_SECRET_ACCESS_EY>(optional) 
@@ -78,9 +79,11 @@ NB. the instructions will also work in anywhere supported by [Docker Machine](ht
       Password: YOUR_PASSWORD
     ```
 1. Log in using the username and password you specified in the quickstart script:
-```
+    ```
 <INITIAL_ADMIN_USER> / <INITIAL_ADMIN_PASSWORD>
-```
+    ```
+
+1. Update the docker-machine security group in the AWS console to permit inbound http traffic on ports 80 and 443 (from the machine(s) from which you want to have access only), also UDP on 25826 and 12201 from 127.0.0.1/32.
 
 # General Getting Started Instructions
 
@@ -120,8 +123,6 @@ eval $(docker-machine env <YOUR_MACHINE_NAME>)
 
 Create a Docker Swarm that has a publicly accessible Engine with the label "tier=public" to bind Nginx and Logstash to that node
 
-- Instruction to create a docker swarm cluster on AWS are [`here`](https://github.com/Accenture/adop-docker-compose/blob/master/provision/aws/swarm/README.md)
-
 ## Launching
 
 - Run: export TARGET\_HOST=\<IP\_OF\_PUBLIC\_HOST\>
@@ -188,21 +189,23 @@ Note : For Windows run this command from a terminal (Git Bash) as administrator.
 Kibana 4 does not provide a configuration property that allow to define the default index pattern so the following manual procedure should be adopted in order to define an index pattern:
 
 - Navidate to Settings > Indices using Kibana dashboard
-- Set index name or pattern as "logstash-*"
+- Set index name or pattern as "logstash-\*"
 - For the below drop-down select @timestamp for the Time-field name
 - Click on create button
 
-# User feedback
+# User Feedback
 
 ## Documentation
-Documentation can be found under the [`docker-library/docs` GitHub repo](https://github.com/docker-library/docs). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/docker-library/docs/blob/master/README.md) before attempting a pull request.
+Documentation can be found [on our GitHub Pages site](http://accenture.github.io/adop-docker-compose).
 
 ## Issues
-If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/Accenture/adop-docker-compose/issues).
+If you have any problems with or questions about this project, please contact us through [Gitter](https://gitter.im/Accenture/ADOP) or a [GitHub issue](https://github.com/Accenture/adop-docker-compose/issues).
 
 ## Contribute
-You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
+You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can. You can find more information in our [documentation](http://accenture.github.io/adop-docker-compose/docs/contributing/).
 
 Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/Accenture/adop-docker-compose/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
 
+## Roadmap
+We use this working [Roadmap](https://github.com/Accenture/adop-docker-compose/wiki/Roadmap) to evolve and summarise plans for future features and the merge of existing PRs.
 

cmd/cartridge

@@ -0,0 +1,200 @@
+#!/bin/bash -e
+
+SUB_CMD_NAME="cartridge"
+source ${CLI_DIR}/lib/adop_lib.sh
+
+# Templates to build the cartridge from\
+declare -A templates
+templates['example']=https://github.com/Accenture/adop-cartridge-skeleton.git
+# TODO actually need a node template!
+templates['node']=https://github.com/Accenture/adop-cartridge-skeleton.git
+templates['java']=https://github.com/Accenture/adop-cartridge-java.git
+templates['docker']=https://github.com/Accenture/adop-cartridge-docker.git
+templates['chef']=https://github.com/Accenture/adop-cartridge-chef.git
+
+
+list_init_templates() {
+  printf "\nThe following templates can be used to build your inital cartridge.  (The default is example.)\n\n"
+  for name in ${!templates[@]}; do
+    printf "${name}:\t${templates[$name]}\n"
+  done
+}
+
+list_template_names() {
+  for name in ${!templates[@]}; do
+    printf "${name} "
+  done
+}
+
+list_template_urls() {
+  for name in ${templates[@]}; do
+    echo $name
+  done
+}
+
+cmd_desc() {
+  echo "For creating cartridges."
+}
+
+cmd_usage() {
+    echo "usage: ${CMD_NAME} ${SUB_CMD_NAME} <subcommand>"
+}
+
+help() {
+    cmd_usage
+    echo
+    echo "Available subcommands are:"
+    printf "    %-30s   %s\n" "init [<options>]" "Create a cartridge skeleton in the current directory."
+    printf "    %-30s   %s\n" "list_init_templates [<options>]" "List the templates that can be used to initialise a new cartridge in your currently working directory."
+    echo
+    echo "Try '${CMD_NAME} ${SUB_CMD_NAME} <subcommand> -h' for details."
+    echo "HINT: Run '${CMD_NAME} ${SUB_CMD_NAME} init' to create a cartridge in the current directory"
+    echo
+}
+
+init_help() {
+    echo
+    echo "usage: ${CMD_NAME} ${SUB_CMD_NAME} init [<options>]"
+    printf "    %-2s   %s\n" "" "Options:"
+    printf "    %-3s   %s\n" "" "-s <SUBDIR>          : Name of subfolder create the cartridge in (Optional) (Default : adop)"
+    printf "    %-3s   %s\n" "" "-t <TEMPLATE>        : Cartridge template to use.  Do not combine with -c. (Optional, options: $(list_template_names)) (Default : 'example = https://github.com/Accenture/adop-cartridge-skeleton.git')"
+    printf "    %-3s   %s\n" "" "-c <SKELURL>         : URL of skeleton cartidge to re-use (Optional) (Default : defers to -t option/)"
+    printf "    %-3s   %s\n" "" "-h                   : Prints this help."
+    echo
+    echo "HINT: Run '${CMD_NAME} ${SUB_CMD_NAME} init' to create a cartridge in the current directory"
+    echo "HINT: If you are looking to load a cartridge, instead try: adop platform cartridge"
+    echo
+}
+
+init() {
+
+  local OPTIND
+  # If the parameters are provided from command line.
+  while getopts "c:s:t:h" opt; do
+    case $opt in
+      s)
+        export SUBDIR=${OPTARG}
+        ;;
+      c)
+        export SKELURL=${OPTARG}
+        ;;
+      t)
+        export TEMPLATE=${OPTARG}
+        ;;
+      h)
+        init_help
+        exit 0
+        ;;
+      *)
+        echo "Invalid parameter(s) or option(s)."
+        init_help
+        exit 1
+        ;;
+    esac
+  done
+
+  # Validate c and t aren't both provided (or set as env vars)
+  if [ ! -z "${SKELURL}" ] && [ ! -z "${TEMPLATE}" ]; then
+    echo "ERROR: Both a template name ${TEMPLATE} and a skeleton repo URL ${SKELURL} were provided. Please state just one or neither."
+    exit 1
+  fi
+
+  # Default t if neither are provided (or set as env vars)
+  if [ -z "${SKELURL}" ] && [ -z "${TEMPLATE}" ]; then
+    export TEMPLATE=${TEMPLATE:-"example"}
+  fi
+
+  #Find url for template
+  if [ ! -z "${TEMPLATE}" ]; then
+    export SKELURL=${templates[$TEMPLATE]}
+    if [ -z $SKELURL ]; then
+      echo "ERROR: $TEMPLATE type not yet supported"
+      list_init_templates
+      exit 1;
+    fi
+  fi 
+
+  # Default s if not provided as an arg or available as an env var
+  export SUBDIR=${SUBDIR:-"adop"}
+
+  # Not the current directory if it contains a git repo (because the clone would collide with the current repo)
+  if [[ "${SUBDIR}" == "." ]] && [ -d .git ]; then  
+    echo "ERROR: cannot create cartridge in the current directory because it is a git repo."
+    exit 1
+  fi
+
+  # No paths outside the current dir
+  if [[ "${SUBDIR}" == *".."* ]]; then	
+    echo "ERROR: the cartridge subdirectory name must not contain '..'."
+    exit 1
+  fi
+
+  # No absolulte paths
+  if [[ "${SUBDIR}" == "/"* ]]; then
+    echo "ERROR: the cartridge subdirectory name must not be supplied as an absolute path."
+    exit 1;
+  fi
+
+  # Clone the template cartridge
+  echo "Creating a cartridge skeleton in:" $SUBDIR "using:" $SKELURL
+
+  git clone --depth=1 $SKELURL $SUBDIR
+
+  # Attempt to customise the cartridge template
+  if [ ! -d ".git" ]; then
+    echo "WARNING: it doesn't appear that your are running this from the root directory of a git repository.  Therefore unable to pre-populate src/urls.txt in your cartridge.  Please do this manually. See http://accenture.github.io/adop-docker-compose/docs/developing/cartridges/#developing-cartridge-content"
+  else 
+    THIS_URL=`git remote -v | grep push | awk '{print $2}'`
+    if [ ! -z "$THIS_URL" ]; then
+      # pre-populate the urls.txt with this repo
+      echo "Adding $THIS_URL to ${SUBDIR}/src/urls.txt"
+      #TODO would this work better as a sed substitution for some cartridge templates - might need to support comments in urls.txt
+      echo `git remote -v | grep push | awk '{print $2}'` >> ${SUBDIR}/src/urls.txt
+
+      # infer this repo name
+      THIS_REPO_NAME=`echo $THIS_URL | sed 's/.*\/\([^.]\+\)\(\.git\)\?/\1/'`
+      # attempt to customise job DSL
+      echo "Adding $THIS_URL to ${SUBDIR}/src/urls.txt"      
+      find ${SUBDIR}/jenkins/jobs/dsl/*.groovy | while read DSLFILE; do
+	CKSUMB4=`cksum $DSLFILE`
+	# TODO add more sed rules here to support other templates
+        sed -i'' -e  "s/def referenceAppgitRepo \+= \+.*/def referenceAppgitRepo = \"${THIS_REPO_NAME}\"/g" ${DSLFILE}
+	if [[ `cksum $DSLFILE` != $CKSUMB4 ]]; then
+	  echo Customised git URL in: $DSLFILE to point to $THIS_REPO_NAME
+        fi
+      done
+
+    else
+      echo "WARNING: your git repository doesn't have any remotes.  Therefore unable to pre-populate src/urls.txt in your cartridge.  Please do this manually. See http://accenture.github.io/adop-docker-compose/docs/developing/cartridges/#developing-cartridge-content"
+    fi
+  fi
+
+
+  # We don't want the cartridge dir to be it's own git repo
+  rm -rf ${SUBDIR}/.git
+
+  printf "\nCartridge skeleton successfully created.\n\nYou can now load it into an ADOP instance: http://accenture.github.io/adop-docker-compose/docs/developing/cartridges/#testing-the-cartridge\n"
+
+}
+
+
+shift $(($OPTIND -1))
+SUBCOMMAND_OPT="${1:-help}"
+
+# Only shift if there are other parameters
+if [ $# -ge 1 ]; then
+    shift
+fi
+
+case ${SUBCOMMAND_OPT} in
+    "cmd_desc"|"help"|"init"|"list_init_templates"|"list_template_urls")
+
+        ${SUBCOMMAND_OPT} "$@"
+        ;;
+    *)
+        echo "Invalid parameter(s) or option(s)."
+        help
+        exit 1
+        ;;
+esac
+