install_stack.sh from master

util/install/install_stack.sh

+#!/usr/bin/env bash
+
+# Stop if any command fails
+set -e
+
+function usage
+{
+    cat << EOM
+
+    --- install_stack.sh ---
+
+    Usage: $ bash install_stack.sh stack release [-b vagrant_mount_base] [-v] [-h]
+
+    Installs the Open edX devstack or fullstack. If you encounter any trouble or have 
+    questions regarding installation of devstack/fullstack, head over to 
+    https://open.edx.org/getting-help.
+
+    This script captures a log of all output produced during runtime, and saves it in a .log
+    file within the current directory. If you encounter an error during installation, this is
+    an invaluable tool for edX developers to help discover what went wrong, so please share it
+    if you reach out for support!
+
+    NOTE: This script assumes you have never installed devstack before. Installing multiple 
+    versions of devstack can often cause conflicts that this script is not prepared to handle.
+    
+
+    stack
+        Either 'fullstack' or 'devstack' (no quotes). Full stack mimics a production 
+        environment, whereas devstack is useful if you plan on modifying the Open edX 
+        code. You must specify this. If you choose fullstack, 'release' should be the
+        latest open-release. If you choose devstack, 'release' should be the latest
+        open-release or master.
+
+    release
+        The release of Open edX you wish to run. Install the given git ref 'release'.
+        You must specify this. Named releases are called "open-release/eucalyptus",
+        "open-release/eucalyptus.2", and so on. We recommend the latest stable open 
+        release for general members of the open source community. Named releases can
+        be found at: https://openedx.atlassian.net/wiki/display/DOC/Open+edX+Releases.
+        If you plan on modifying the code, we recommend the "master" branch. 
+
+    -b vagrant_mount_base
+        Customize the location of the source code that gets cloned during the 
+        devstack provisioning. The default is the current directory. This option is
+        not valid if installing fullstack.
+
+    -v 
+        Verbose output from ansible playbooks.
+
+    -h
+        Show this help and exit.
+
+    ---------------------------
+
+EOM
+}
+
+
+ERROR='\033[0;31m' # Red
+WARN='\033[1;33m' # Yellow
+SUCCESS='\033[0;32m' # Green
+NC='\033[0m' # No Color
+
+# Output verbosity
+verbosity=0
+# OPENEDX_RELEASE
+release=""
+# Vagrant source code provision location
+vagrant_mount_location=""
+
+if [[ $# -lt 2 || ${1:0:1} == '-' || ${2:0:1} == '-' ]]; then
+  usage
+  exit 1
+fi
+
+stack=$1
+shift
+release=$1
+shift
+
+while getopts "b:vh" opt; do
+    case "$opt" in
+        b)
+            if  [[ $stack == "devstack" ]]; then
+                vagrant_mount_location=$OPTARG
+            else
+                echo -e "${ERROR}Fullstack has no mount location. The -b option is not valid for fullstack!${NC}"
+                exit 1
+            fi
+            ;;
+        v)
+            verbosity=1
+            ;;
+        h)
+            usage
+            exit
+            ;;
+        *)
+            usage
+            exit 1
+            ;;
+    esac
+done
+
+exec > >(tee install-$(date +%Y%m%d-%H%M%S).log) 2>&1
+echo "Capturing output to install-$(date +%Y%m%d-%H%M%S).log."
+
+export OPENEDX_RELEASE=$release
+
+# Check if mount location was changed
+if [[ $vagrant_mount_location != "" ]]; then
+    echo "Changing Vagrant provision location to $vagrant_mount_location..."
+    export VAGRANT_MOUNT_BASE=vagrant_mount_location
+fi
+
+if [[ -d "$stack" ]]; then
+    echo -e "${ERROR}A $stack directory already exists here. If you already tried installing $stack, make sure to vagrant destroy the $stack machine and rm -rf the $stack directory before trying to reinstall. If you would like to install a separate $stack, change to a different directory and try running the script again.${NC}"
+    exit 1
+fi
+
+if [[ $stack == "devstack" ]]; then # Install devstack
+    # Warn if release chosen is not master or open-release (Eucalyptus and up)
+    if [[ $release != "master" && $release != *"open-release"* ]]; then
+        echo -e "${WARN}The release you entered is not 'master' or an open-release. Please be aware that a branch other than master or a release other than the latest open-release could cause errors when installing $stack.${NC}"
+    fi
+
+    wiki_link="https://openedx.atlassian.net/wiki/display/OpenOPS/Running+Devstack"
+    mkdir devstack
+    cd devstack
+    curl -L https://raw.githubusercontent.com/edx/configuration/${OPENEDX_RELEASE}/vagrant/release/devstack/Vagrantfile > Vagrantfile
+    vagrant plugin install vagrant-vbguest
+elif [[ $stack == "fullstack" ]]; then # Install fullstack
+    # Warn if release chosen is not open-release (Eucalyptus and up)
+    if [[ $release != *"open-release"* ]]; then
+        echo -e "${WARN}The release you entered is not an open-release. Please be aware that a branch other than the latest open-release could cause errors when installing $stack.${NC}"
+    fi
+
+    wiki_link="https://openedx.atlassian.net/wiki/display/OpenOPS/Running+Fullstack"
+    mkdir fullstack
+    cd fullstack
+    curl -L https://raw.githubusercontent.com/edx/configuration/${OPENEDX_RELEASE}/vagrant/release/fullstack/Vagrantfile > Vagrantfile
+    vagrant plugin install vagrant-hostsupdater
+else # Throw error
+    echo -e "${ERROR}Unrecognized stack name, must be either devstack or fullstack!${NC}"
+    exit 1
+fi
+
+# Check for verbosity level
+if [[ $verbosity == 1 ]]; then
+    sed -i '' 's/-e xqueue_version=\$OPENEDX_RELEASE/-e xqueue_version=\$OPENEDX_RELEASE \\\'$'\n    -vvv/' Vagrantfile
+fi
+
+vagrant up --provider virtualbox
+
+# Check if preview mode was chosen
+if grep -q '192.168.33.10  preview.localhost' /etc/hosts; then
+    echo "Studio preview already enabled, skipping..."
+else
+    echo "Enabling use of preview within Studio..."
+    sudo bash -c "echo '192.168.33.10  preview.localhost' >> /etc/hosts"
+fi
+
+echo -e "${SUCCESS}Finished installing! You may now 'cd $stack' and login using 'vagrant ssh'"
+echo -e "Refer to the edX wiki ($wiki_link) for more information on using $stack.${NC}"