Merge pull request #552 from edx/jarv/ansible

Jarv/ansible

playbooks/cloudformation.yml

----
-# This playbook demonstrates how to use the ansible cloudformation module to launch an AWS CloudFormation stack.
-#
-# This module requires that the boto python library is installed, and that you have your AWS credentials
-# in $HOME/.boto
-
-#The thought here is to bring up a bare infrastructure with CloudFormation, but use ansible to configure it.
-#I generally do this in 2 different playbook runs as to allow the ec2.py inventory to be updated.
-
-#This module also uses "complex arguments" which were introduced in ansible 1.1 allowing you to specify the
-#Cloudformation template parameters
-
-#This example launches a 3 node AutoScale group, with a security group, and an InstanceProfile with root permissions.
-
-#If a stack does not exist, it will be created.  If it does exist and the template file has changed, the stack will be updated.
-#If the parameters are different, the stack will also be updated.
-
-#CloudFormation stacks can take awhile to provision, if you are curious about its status, use the AWS
-#web console or one of the CloudFormation CLI's.
-
-#Example update -- try first launching the stack with 3 as the ClusterSize.  After it is launched, change it to 4
-#and run the playbook again.
-
-- name: provision stack
-  hosts: localhost
-  connection: local
-  gather_facts: false
-
-  # Launch the cloudformation-example.json template.  Register the output.
-
-  tasks:
-  - name: edX configuration
-    cloudformation: >
-      stack_name="$name" state=present
-      region=$region disable_rollback=false
-      template=../cloudformation_templates/edx-server-multi-instance.json
-    args:
-      template_parameters:
-        KeyName: $key
-        InstanceType: m1.small
-        GroupTag: $group
-    register: stack
-  - name: show stack outputs
-    debug: msg="My stack outputs are ${stack.stack_outputs}"

playbooks/edx-east/edx_ansible.yml

+- name: Deploy ansible
+  hosts: all
+  sudo: True
+  gather_facts: True
+  roles:
+    - edx_ansible

playbooks/edx-east/edx_sandbox.yml

@@ -29,3 +29,4 @@
       rbenv_dir: "{{ forum_home }}"
       rbenv_ruby_version: "{{ forum_ruby_version }}"
     - forum
+    - edx_ansible

playbooks/edx_notifier.yml

-- name: Configure stage instance(s)
-  hosts: notifier_stage
-  sudo: True
-  vars_files:
-    - "{{ secure_dir }}/vars/stage/notifier.yml"
-    - "{{ secure_dir }}/vars/users.yml"
-  gather_facts: True
-  roles:
-    - common
-    - role: virtualenv
-      virtualenv_user: "notifier"
-      virtualenv_user_home: "/opt/wwc/notifier"
-      virtualenv_name: "notifier"
-    - notifier
-
-- name: Configure loadtest instance(s)
-  hosts: notifier_loadtest
-  sudo: True
-  vars_files:
-    - "{{ secure_dir }}/vars/loadtest/notifier.yml"
-    - "{{ secure_dir }}/vars/users.yml"
-  gather_facts: True
-  roles:
-    - common
-    - role: virtualenv
-      virtualenv_user: "notifier"
-      virtualenv_user_home: "/opt/wwc/notifier"
-      virtualenv_name: "notifier"
-    - notifier
-
-- name: Configure stage edge instance(s)
-  hosts: notifier_edge_stage
-  sudo: True
-  vars_files:
-    - "{{ secure_dir }}/vars/edge_stage/notifier.yml"
-    - "{{ secure_dir }}/vars/users.yml"
-  gather_facts: True
-  roles:
-    - common
-    - role: virtualenv
-      virtualenv_user: "notifier"
-      virtualenv_user_home: "/opt/wwc/notifier"
-      virtualenv_name: "notifier"
-    - notifier
-
-- name: Configure prod instance(s)
-  hosts: notifier_prod
-  sudo: True
-  vars_files:
-    - "{{ secure_dir }}/vars/prod/notifier.yml"
-    - "{{ secure_dir }}/vars/users.yml"
-  gather_facts: True
-  roles:
-    - common
-    - role: virtualenv
-      virtualenv_user: "notifier"
-      virtualenv_user_home: "/opt/wwc/notifier"
-      virtualenv_name: "notifier"
-    - notifier
-
-- name: Configure edge prod instance(s)
-  hosts: notifier_edge_prod
-  sudo: True
-  vars_files:
-    - "{{ secure_dir }}/vars/edge_prod/notifier.yml"
-    - "{{ secure_dir }}/vars/users.yml"
-  gather_facts: True
-  vars:
-  roles:
-    - common
-    - role: virtualenv
-      virtualenv_user: "notifier"
-      virtualenv_user_home: "/opt/wwc/notifier"
-      virtualenv_name: "notifier"
-    - notifier

playbooks/edx_provision_test.yml

-- name: Create sandbox instance
-  hosts: localhost
-  connection: local
-  gather_facts: False
-  vars:
-    keypair: continuous-integration
-    instance_type: m1.small
-    security_group: sandbox
-    image: ami-d0f89fb9
-    region: us-east-1
-    instance_tags: '{"disposable": "true"}'
-  roles:
-    - launch_instance
-
-- name: Configure instance(s)
-  hosts: launched
-  sudo: True
-  gather_facts: True
-  vars:
-    migrate_db: "yes"
-    openid_workaround: True
-    ansible_ssh_private_key_file: /var/lib/jenkins/continuous-integration.pem
-  vars_files:
-    - "{{ secure_dir }}/vars/edxapp_ref_users.yml"
-    - "{{ secure_dir }}/vars/edxapp_sandbox.yml"
-    - "{{ secure_dir }}/vars/edx_jenkins_tests.yml"
-  roles:
-    - common
-    - role: nginx
-      nginx_sites:
-      - lms
-      - cms
-      - lms-preview
-      - xserver
-      - xqueue
-    - edxlocal
-    - mongo
-    - edxapp
-    - xqueue
-    - xserver
-
-- name: Terminate instances
-  hosts: localhost
-  connection: local
-  tasks:
-    - name: Terminate instances that were previously launched
-      local_action: 
-        module: ec2_local
-        state: 'absent'
-        instance_ids: ${ec2.instance_ids}

playbooks/edx_sandbox.yml

-# This playbook is to configure
-# the official edX sandbox instance
-# sandbox.edx.org
-#
-# On the machine you want to configure run the following
-# command from the configuration/playbooks directory:
-#   ansible-playbook -c local --limit "localhost:127.0.0.1" /path/to/configuration/playbooks/edx_sandbox.yml -i "localhost,"
-# 
-# To use different default ports for lms-preview, cms and to set the lms_base and lms_preview_base,
-# for the following configuration:
-#   studio listening on port 80 - studio.example.com
-#   lms listening on port 80 - example.com
-#   lms-preview listening on port 80 - preview.example.com
-#
-#   ansible-playbook -c local --limit "localhost:127.0.0.1" path/to/configuration/playbooks/edx_sandbox.yml -i "localhost," -e "EDXAPP_CMS_NGINX_PORT=80 EDXAPP_LMS_PREVIEW_NGINX_PORT=80 EDXAPP_LMS_BASE=example.com  EDXAPP_PREVIEW_LMS_BASE=preview.example.com"
-#
-- name: Configure instance(s)
-  hosts: localhost
-  sudo: True
-  gather_facts: True
-  vars:
-    migrate_db: "yes"
-    openid_workaround: True
-  roles:
-    - common
-    - supervisor
-    - role: nginx
-      nginx_sites:
-      - lms
-      - cms
-      - lms-preview
-      - xqueue
-      - ora
-    - edxlocal
-    - mongo
-    - edxapp
-    - { role: 'rabbitmq', rabbitmq_ip: '127.0.0.1' }
-    - { role: 'edxapp', celery_worker: True }
-    - oraclejdk
-    - elasticsearch
-    - forum
-    - { role: "xqueue", update_users: True }
-    - ora

playbooks/edxapp_ref.yml

-- hosts: tag_Group_edxapp_ref
-  sudo: True
-  vars_files:
-    - "{{ secure_dir }}/vars/edxapp_ref_vars.yml"
-    - "{{ secure_dir }}/vars/edxapp_ref_users.yml"
-  roles:
-    - common
-    - role: nginx
-      nginx_sites:
-      - lms
-      - cms
-      - lms-preview
-    - gunicorn
-    - edxapp
-    - ruby
-    - npm
-    # run this role last
-    - in_production

playbooks/edxapp_rolling_example.yml

-# ansible-playbook -v --user=ubuntu  edxapp_rolling_example.yml -i ./ec2.py  --private-key=/path/to/deployment.pem 
-
-- hosts: tag_Group_anothermulti
-  serial: 2
-  vars_files:
-    - "{{ secure_dir }}/vars/edxapp_stage_vars.yml"
-    - "{{ secure_dir }}/vars/users.yml"
-  pre_tasks:
-    - name: Gathering ec2 facts 
-      ec2_facts: 
-    - name: Removing instance from the ELB
-      local_action: ec2_elb
-      args:
-        instance_id: "{{ ansible_ec2_instance_id }}"
-        state: 'absent'
-  roles:
-    - common
-    - role: nginx 
-      nginx_sites:
-      - lms
-      - cms
-      - lms-preview
-    - edxapp
-    - ruby
-  post_tasks:
-    - name: Adding instance back to the ELB
-      local_action: ec2_elb
-      args:
-        instance_id: "{{ ansible_ec2_instance_id }}"
-        ec2_elbs: "{{ ec2_elbs }}"
-        state: 'present'

playbooks/jenkins-inventory.ini

-[jenkins_test]
-jenkins-test.sandbox.edx.org

playbooks/roles/edx_ansible/defaults/main.yml

+---
+#
+# edX Configuration
+#
+# github:     https://github.com/edx/configuration
+# wiki:       https://github.com/edx/configuration/wiki
+# code style: https://github.com/edx/configuration/wiki/Ansible-Coding-Conventions
+# license:    https://github.com/edx/configuration/blob/master/LICENSE.TXT
+#
+##
+# Defaults for role edx_ansible, an edx_ansible role to install edx_ansible
+#
+#
+# OS packages
+#
+
+edx_ansible_debian_pkgs:
+  - python-pip
+  - python-apt
+  - git-core
+  - build-essential
+  - python-dev
+  - libxml2-dev
+  - libxslt1-dev
+  - curl
+edx_ansible_app_dir: "{{ COMMON_APP_DIR }}/edx_ansible"
+edx_ansible_code_dir: "{{ edx_ansible_app_dir }}/edx_ansible"
+edx_ansible_data_dir: "{{ COMMON_DATA_DIR }}/edx_ansible"
+edx_ansible_venvs_dir: "{{ edx_ansible_app_dir }}/venvs"
+edx_ansible_venv_dir: "{{ edx_ansible_venvs_dir }}/edx_ansible"
+edx_ansible_venv_bin: "{{ edx_ansible_venv_dir }}/bin"
+edx_ansible_user: "edx-ansible"
+edx_ansible_source_repo: https://github.com/edx/configuration.git
+edx_ansible_requirements_file: "{{ edx_ansible_code_dir }}/requirements.txt"
+# edX configuration repo
+configuration_version: master

playbooks/roles/edx_ansible/meta/main.yml

+---
+#
+# edX Configuration
+#
+# github:     https://github.com/edx/configuration
+# wiki:       https://github.com/edx/configuration/wiki
+# code style: https://github.com/edx/configuration/wiki/Ansible-Coding-Conventions
+# license:    https://github.com/edx/configuration/blob/master/LICENSE.TXT
+#
+##
+# Role includes for role edx_ansible
+dependencies:
+  - supervisor

playbooks/roles/edx_ansible/tasks/deploy.yml

+---
+- name: edx_ansible | git checkout edx_ansible repo into edx_ansible_code_dir
+  git: dest={{ edx_ansible_code_dir }} repo={{ edx_ansible_source_repo }} version={{ configuration_version }}
+  sudo_user: "{{ edx_ansible_user }}"
+  tags: deploy
+
+- name : edx_ansible | install edx_ansible venv requirements
+  pip: requirements="{{ edx_ansible_requirements_file }}" virtualenv="{{ edx_ansible_venv_dir }}" state=present
+  sudo_user: "{{ edx_ansible_user }}"
+  tags: deploy

playbooks/roles/edx_ansible/tasks/main.yml

+---
+#
+# edX Configuration
+#
+# github:     https://github.com/edx/configuration
+# wiki:       https://github.com/edx/configuration/wiki
+# code style: https://github.com/edx/configuration/wiki/Ansible-Coding-Conventions
+# license:    https://github.com/edx/configuration/blob/master/LICENSE.TXT
+#
+#
+# Tasks for role edx_ansible
+#
+# Overview:
+#
+# This is an edx_ansible role that installs edx_ansible :)
+# The purpose is to install edx_ansible on a server so
+# that it can be updated locally.
+#
+# This role will also drop some helper scripts that
+# for running edx_ansible tasks
+#
+# Example play:
+#
+#
+#
+- name: edx_ansible | create application user
+  user: >
+    name="{{ edx_ansible_user }}"
+    home="{{ edx_ansible_app_dir }}"
+    createhome=no
+    shell=/bin/false
+
+- name: edx_ansible | create edx_ansible app and venv dir
+  file: >
+    path="{{ item }}"
+    state=directory
+    owner="{{ edx_ansible_user }}"
+    group="{{ common_web_group }}"
+  with_items:
+    - "{{ edx_ansible_app_dir }}"
+    - "{{ edx_ansible_venvs_dir }}"
+
+- name: edx_ansible | install a bunch of system packages on which edx_ansible relies
+  apt: pkg={{','.join(edx_ansible_debian_pkgs)}} state=present
+
+- include: deploy.yml
+
+- name: edx_ansible | create update script
+  template: >
+    dest={{ edx_ansible_app_dir}}/update
+    src=update.j2 owner={{ edx_ansible_user }} group={{ edx_ansible_user }} mode=755
+
+- name: edxapp | create a symlink for update.sh
+  file: >
+    src={{ edx_ansible_app_dir }}/update
+    dest={{ COMMON_BIN_DIR }}/update
+    state=link

playbooks/roles/edx_ansible/templates/update.j2

+#!/usr/bin/env bash
+
+# This script runs edx_ansible locally
+
+set -e
+usage() {
+SAVE_IFS=$IFS
+IFS=","
+    cat<<EO
+
+    Usage: $PROG <repo> <version>
+            -v        add verbosity to edx_ansible run
+            -h        this
+
+    <repo> - must be one of [${!repos_to_cmd[*]}]
+    <version> - can be a commit or tag
+
+EO
+IFS=$SAVE_IFS
+}
+
+declare -A repos_to_cmd
+edx_ansible_cmd="{{ edx_ansible_venv_bin}}/ansible-playbook -i localhost, -c local --tags deploy"
+repos_to_cmd["edx-platform"]="$edx_ansible_cmd edxapp.yml -e 'edx_platform_version=$2'"
+repos_to_cmd["xqueue"]="$edx_ansible_cmd xqueue.yml -e 'xqueue_version=$2'"
+repos_to_cmd["forums"]="$edx_ansible_cmd forums.yml -e 'forum_version=$2'"
+repos_to_cmd["xserver"]="$edx_ansible_cmd forums.yml -e 'xserver_version=$2'"
+repos_to_cmd["ease"]="$edx_ansible_cmd discern.yml -e 'discern_ease_version=$2' && $edx_ansible_cmd ora.yml -e 'ora_ease_version=$2'"
+repos_to_cmd["discern"]="$edx_ansible_cmd discern.yml -e 'discern_version=$2'"
+repos_to_cmd["edx-ora"]="$edx_ansible_cmd ora.yml -e 'ora_version=$2'"
+repos_to_cmd["configuration"]="$edx_ansible_cmd edx_ansible.yml -e 'configuration_version=$2'"
+
+PROG=${0##*/}
+while getopts "vh" opt; do
+  case $opt in
+    v)
+        verbose="-vvvv"
+        shift
+        ;;
+    h)
+        usage
+        exit 0
+        ;;
+  esac
+done
+
+
+if [[ -z $1 || -z $2 ]]; then
+    echo
+    echo "ERROR: You must specify a repo and commit"
+    usage
+    exit 1
+fi
+
+if [[ -z ${repos_to_cmd[$1]} ]]; then
+    echo
+    echo "ERROR: Invalid repo name"
+    usage
+    exit 1
+fi
+
+cd {{ edx_ansible_code_dir }}/playbooks/edx-east
+eval "sudo ${repos_to_cmd["$1"]} $verbose"

playbooks/roles/edxapp/tasks/deploy.yml

@@ -211,8 +211,7 @@
 # https://code.launchpad.net/~wligtenberg/django-openid-auth/mysql_fix/+merge/22726
 # This is necessary for when syncdb is run and the django_openid_auth module is installed,
 # not sure if this fix will ever get merged
-# We should never do this in production
-- name: edxapp | openid workaround - NOT FOR PRODUCTION
+- name: edxapp | openid workaround
   shell: sed -i -e 's/claimed_id = models.TextField(max_length=2047, unique=True/claimed_id = models.TextField(max_length=2047/' {{ edxapp_venv_dir }}/lib/python2.7/site-packages/django_openid_auth/models.py
   when: openid_workaround is defined
   sudo_user: "{{ edxapp_user }}"

playbooks/site.yml

-- include: edxapp.yml

playbooks/stage-ansible.cfg

-# ansible reads $ANSIBLE_CONFIG, ansible.cfg, ~/.ansible.cfg or /etc/ansible/ansible.cfg
-
-[defaults]
-# Always have these for using the configuration repo
-jinja2_extensions=jinja2.ext.do
-hash_behaviour=merge
-
-# These are environment-specific defaults
-forks=10
-#forks=1
-log_path=stage-edx-ansible.log
-transport=ssh
-hostfile=./ec2.py
-extra_vars='key=deployment name=edx-stage group=edx-stage region=us-west-1'
-user=ubuntu
-
-[ssh_connection]
-# example from https://github.com/ansible/ansible/blob/devel/examples/ansible.cfg
-#ssh_args=-o ControlMaster=auto -o ControlPersist=60s -o ControlPath=/tmp/ansible-ssh-%h-%p-%r
-ssh_args=-F stage-ssh-config
-scp_if_ssh=True

playbooks/stage-ssh-config

-#### edx-stage VPC 
-
-Host 54.241.183.3
-#Host ec2-54-241-183-3.us-west-1.compute.amazonaws.com
-#Host vpc-jumpbox
-    #HostName ec2-54-241-183-3.us-west-1.compute.amazonaws.com
-    HostName 54.241.183.3
-    User ubuntu
-    ForwardAgent yes
-
-Host *.us-west-1.compute.internal
-    User ubuntu
-    ForwardAgent yes
-    #ProxyCommand ssh -W %h:%p ec2-54-241-183-3.us-west-1.compute.amazonaws.com
-    #ProxyCommand ssh -W %h:%p vpc-jumpbox
-    ProxyCommand ssh -W %h:%p ubuntu@54.241.183.3
-
-Host *
-    ForwardAgent yes
-    SendEnv LANG LC_*
-    HashKnownHosts yes
-    GSSAPIAuthentication yes
-    GSSAPIDelegateCredentials no
-

playbooks/vagrant-fullstack.yml

@@ -29,3 +29,4 @@
     - { role: "xqueue", update_users: True }
     - ora
     - discern
+    - edx_ansible

playbooks/vagrant-shortstack-xml.yml

-- name: Configure instance(s)
-  hosts: vagrant
-  sudo: True
-  gather_facts: True
-  vars:
-    migrate_db: "yes"
-    openid_workaround: True
-  vars_files:
-    - "group_vars/all"
-  roles:
-    - role: nginx
-      nginx_sites:
-      - lms
-      - cms
-      - lms-preview
-    - edxlocal
-    - mongo
-    - { role: 'edxapp', EDXAPP_LMS_NGINX_PORT: 18030, EDXAPP_LMS_XML_NGINX_PORT: 80 }

playbooks/vagrant-shortstack.yml

-- name: Configure instance(s)
-  hosts: vagrant
-  sudo: True
-  gather_facts: True
-  vars:
-    migrate_db: "yes"
-    openid_workaround: True
-  vars_files:
-    - "group_vars/all"
-  roles:
-    - role: nginx
-      nginx_sites:
-      - lms
-      - cms
-      - lms-preview
-    - edxlocal
-    - mongo
-    - edxapp
-    - oraclejdk
-    - elasticsearch
-    - { role: 'edxapp', celery_worker: True }
-    - forum