Skip to content

C
configuration
Commit 742a07fb by John Jarvis
Options

Merge pull request #442 from edx/jarv/vagrant-releases 

Jarv/vagrant releases
parents ce208fc6 5f234b0e
Showing with 80 additions and 314 deletions
playbooks/roles/discern/defaults/main.yml
......@@ -35,7 +35,7 @@ discern_nltk_data_dir: "{{ discern_data_dir}}/nltk_data"
discern_source_repo: https://github.com/edx/discern.git
discern_settings: discern.aws
discern_branch: dev
discern_branch: master
discern_gunicorn_port: 8070
discern_gunicorn_host: 127.0.0.1
......
playbooks/roles/edxapp/defaults/main.yml
......@@ -459,4 +459,4 @@ worker_django_settings_module: 'aws'
# Skip supervisor tasks
# Useful when supervisor is not installed (local dev)
edxapp_skip_supervisor: False
devstack: False
playbooks/roles/edxapp/handlers/main.yml
......@@ -5,7 +5,7 @@
supervisorctl_path={{ supervisor_ctl }}
config={{ supervisor_cfg }}
name="edxapp:{{ item }}"
when: not edxapp_skip_supervisor
when: not devstack
sudo_user: "{{ supervisor_service_user }}"
with_items: service_variants_enabled
tags: deploy
......@@ -16,7 +16,7 @@
supervisorctl_path={{ supervisor_ctl }}
config={{ supervisor_cfg }}
state=restarted
when: celery_worker is defined and not edxapp_skip_supervisor
when: celery_worker is defined and not devstack
with_items: edxapp_workers
sudo_user: "{{ common_web_user }}"
tags: deploy
playbooks/roles/edxapp/tasks/deploy.yml
......@@ -227,7 +227,7 @@
register: supervisor_update
sudo_user: "{{ supervisor_service_user }}"
changed_when: supervisor_update.stdout != ""
when: not edxapp_skip_supervisor
when: not devstack
tags: deploy
- name: edxapp | ensure edxapp has started
......@@ -237,7 +237,7 @@
config={{ supervisor_cfg }}
name="edxapp:{{ item }}"
sudo_user: "{{ supervisor_service_user }}"
when: not edxapp_skip_supervisor
when: not devstack
with_items: service_variants_enabled
tags: deploy
......@@ -247,7 +247,7 @@
supervisorctl_path={{ supervisor_ctl }}
config={{ supervisor_cfg }}
state=started
when: celery_worker is defined and not edxapp_skip_supervisor
when: celery_worker is defined and not devstack
with_items: edxapp_workers
sudo_user: "{{ supervisor_service_user }}"
tags: deploy
playbooks/roles/edxapp/tasks/service_variant_config.yml
......@@ -29,7 +29,7 @@
src={{ item }}.conf.j2 dest={{ supervisor_cfg_dir }}/{{ item }}.conf
owner={{ supervisor_user }}
with_items: service_variants_enabled
when: celery_worker is not defined and not edxapp_skip_supervisor
when: celery_worker is not defined and not devstack
sudo_user: "{{ supervisor_user }}"
tags:
- deploy
......@@ -38,7 +38,7 @@
template: >
src=edxapp.conf.j2 dest={{ supervisor_cfg_dir }}/edxapp.conf
owner={{ supervisor_user }}
when: celery_worker is not defined and not edxapp_skip_supervisor
when: celery_worker is not defined and not devstack
sudo_user: "{{ supervisor_user }}"
tags:
- deploy
......@@ -49,7 +49,7 @@
template: >
src=workers.conf.j2 dest={{ supervisor_cfg_dir }}/workers.conf
owner={{ supervisor_user }}
when: celery_worker is defined and not edxapp_skip_supervisor
when: celery_worker is defined and not devstack
sudo_user: "{{ supervisor_user }}"
tags:
- deploy
......
playbooks/roles/forum/defaults/main.yml
......@@ -60,4 +60,4 @@ forum_services:
# Skip supervisor tasks
# Used in local dev where supervisor isn't installed
forum_skip_supervisor: False
devstack: False
playbooks/roles/forum/handlers/main.yml
......@@ -5,5 +5,5 @@
supervisorctl_path={{ supervisor_ctl }}
config={{ supervisor_cfg }}
state=restarted
when: not forum_skip_supervisor
when: not devstack
tags: deploy
playbooks/roles/forum/tasks/deploy.yml
......@@ -6,7 +6,7 @@
owner={{ supervisor_user }}
mode=0644
sudo_user: "{{ supervisor_user }}"
when: not forum_skip_supervisor
when: not devstack
register: forum_supervisor
tags: deploy
......@@ -16,7 +16,7 @@
dest={{ forum_supervisor_wrapper }}
mode=0755
sudo_user: "{{ forum_user }}"
when: not forum_skip_supervisor
when: not devstack
notify: forum | restart the forum service
tags: deploy
......@@ -45,7 +45,7 @@
shell: "{{ supervisor_ctl }} -c {{ supervisor_cfg }} update"
register: supervisor_update
changed_when: supervisor_update.stdout != ""
when: not forum_skip_supervisor
when: not devstack
tags: deploy
- name: forum | ensure forum is started
......@@ -54,5 +54,5 @@
supervisorctl_path={{ supervisor_ctl }}
config={{ supervisor_cfg }}
state=started
when: not forum_skip_supervisor
when: not devstack
tags: deploy
playbooks/roles/forum/tasks/test.yml
......@@ -3,7 +3,7 @@
- name: forum | test that the required service are listening
wait_for: port={{ item.port }} host={{ item.host }} timeout=30
with_items: "{{ forum_services }}"
when: not forum_skip_supervisor
when: not devstack
tags:
- forum
- test
playbooks/vagrant-devstack.yml
......@@ -5,8 +5,7 @@
vars:
migrate_db: "yes"
openid_workaround: True
edxapp_skip_supervisor: True
forum_skip_supervisor: True
devstack: True
edx_platform_commit: 'master'
vars_files:
- "group_vars/all"
......
vagrant/devstack/README.rst
......@@ -18,253 +18,5 @@ The ``devstack`` instance is designed to run code and tests, but you can do most
- You can load pages served by the running Vagrant instance.
Prerequisites
-------------
This guide assumes:
- You know how to open a terminal and use basic Linux operating system commands.
- You understand basic virtualization concepts and are familiar with `Vagrant`__
- You are familiar with `Django`__ development (for LMS and Studio)
- You are familiar with `Sinatra`__ development (for Forums)
__ http://docs.vagrantup.com/v2/
__ http://www.djangoproject.com/
__ http://www.sinatrarb.com/
Installation
------------
1. `Install Vagrant`__ (version 1.3.4 or higher)
2. Install the ``vagrant-hostsupdater`` plugin:
.. code:: bash
vagrant plugin install vagrant-hostsupdater
3. `Install Ansible`__ (version 1.3.2 or higher)
4. Clone the edX configuration repo:
.. code:: bash
git clone https://github.com/edx/configuration
5. From the ``configuration/vagrant/devstack`` directory, create the Vagrant instance. If you have never used Vagrant before, take a moment to read the `Why Vagrant?`__ page, which explains the Vagrant commands in detail.
.. code:: bash
vagrant up
A new Vagrant instance will be created, with requirements for these repositories installed:
- `edx-platform`__ (LMS and Studio)
- `cs_comments_service`__
The first time you create the instance, Vagrant will download the base box, which is about 2GB.
After downloading the base box, Vagrant will automatically provision your new virtual server using the Ansible scripts from this repo.
If you destroy and recreate the VM, Vagrant will re-use the box it downloaded.
__ http://docs.vagrantup.com/v2/installation/index.html
__ http://www.ansibleworks.com/docs/intro_installation.html
__ http://docs.vagrantup.com/v2/why-vagrant/index.html
__ https://github.com/edx/edx-platform
__ https://github.com/edx/cs_comments_service
Troubleshooting
---------------
Please refer to the `edx-platform wiki`__ for solutions to common issues.
__ https://github.com/edx/edx-platform/wiki/Simplified-install-with-vagrant#troubleshooting
Getting Started
---------------
In the ``configuration/vagrant/devstack`` directory, `ssh into the Vagrant instance`__:
.. code:: bash
vagrant ssh
This will log you in as the ``vagrant`` user. Within the Vagrant instance, you will be able to start services (LMS, Studio, and Forums) and run tests.
- The ``edx-platform`` repo (for LMS and Studio) is cloned to ``/edx/app/edxapp/edx-platform`` and synced with ``devstack/edx-platform`` on the host system.
- The ``cs_comments_service`` repo (for Forums) is cloned to ``/edx/app/forum/cs_comments_service`` and synced with ``devstack/cs_comments_service`` on the host system.
To start the services and run tests, you will need to log in as either the ``edxapp`` or ``forum`` user. See below for instructions.
__ http://docs.vagrantup.com/v2/getting-started/up.html
LMS Workflow
------------
1. Within the Vagrant instance, switch to the ``edxapp`` account:
.. code:: bash
sudo su edxapp
2. Compile Sass and CoffeeScript:
.. code:: bash
rake assets[lms,devstack]
3. Update Python requirements:
.. code:: bash
pip install -r requirements/edx/base.txt
4. Update the Ruby requirements:
.. code:: bash
bundle install
5. Start the LMS using `runserver`__:
.. code:: bash
./manage.py lms runserver --settings=devstack 0.0.0.0:8000
6. Open a browser on your host machine and navigate to ``localhost:8000`` to load the LMS. (Vagrant will forward port 8000 to the LMS server running in the VM.)
__ https://docs.djangoproject.com/en/dev/ref/django-admin/#runserver-port-or-address-port
Studio Workflow
---------------
1. Within the Vagrant instance, switch to the ``edxapp`` account:
.. code:: bash
sudo su edxapp
2. Compile Sass and CoffeeScript:
.. code:: bash
rake assets[cms,devstack]
3. Update Python requirements:
.. code:: bash
pip install -r requirements/edx/base.txt
4. Update the Ruby requirements:
.. code:: bash
bundle install
5. Start Studio using `runserver`__:
.. code:: bash
./manage.py cms runserver --settings=devstack 0.0.0.0:8001
6. Open a browser on your host machine and navigate to ``localhost:8001`` to load Studio. (Vagrant will forward port 8001 to the Studio server running in the VM.)
__ https://docs.djangoproject.com/en/dev/ref/django-admin/#runserver-port-or-address-port
Forum Workflow
--------------
1. Within the Vagrant instance, switch to the ``forum`` account:
.. code:: bash
sudo su forum
2. Update Ruby requirements:
.. code:: bash
bundle install
3. Start the server:
.. code:: bash
ruby app.rb
4. Access the API at ``localhost:4567`` (Vagrant will forward port 4567 to the Forum server running in the VM.)
Running LMS/Studio Tests
------------------------
1. Within the Vagrant instance, switch to the ``edxapp`` account:
.. code:: bash
sudo su edxapp
2. Run the Python unit tests:
.. code:: bash
rake test:python
3. Run the JavaScript unit tests:
.. code:: bash
rake test:js
4. Run the LMS and Studio acceptance tests:
.. code:: bash
rake test:acceptance
See `edx-platform testing documentation`__ for detailed information about writing and running tests.
__ https://github.com/edx/edx-platform/blob/master/docs/internal/testing.md
Updating the Environment
------------------------
If system requirements change, you will need to update the Vagrant instance:
1. Checkout the release branch of the configuration repo:
.. code:: bash
git checkout release
git pull
2. From the ``configuration/vagrant/devstack`` directory, provision the Vagrant instance:
.. code:: bash
vagrant provision
This process will perform a ``git clean`` of the ``edx-platform`` and ``cs_comments_service`` repositories, so make sure that any changes you had are checked in or stashed.
Recreating the Environment
--------------------------
To destroy and recreate the environment:
.. code:: bash
vagrant destroy
vagrant up
This will perform a ``git clean`` of the ``edx-platform`` and ``cs_comments_service`` repositories. You will also lose any work stored in the Vagrant instance as that instance will be destroyed and a new one created from scratch.
Installation instructions - https://github.com/edx/configuration/wiki#installing-edx-using-a-pre-built-vagrant-devstack-image
Using the devstack - https://github.com/edx/configuration/wiki/Using-the-edX-devstack
vagrant/devstack/Vagrantfile
......@@ -3,21 +3,15 @@ CPU_COUNT = 2
Vagrant.configure("2") do |config|
# For efficiency, we create custom base box from an Ubuntu 12.04 image
# Once the custom base box is created, we use that as a starting point.
# config.vm.box = "precise64"
# config.vm.box_url = "http://files.vagrantup.com/precise64.box"
config.vm.box = "edx-devstack"
config.vm.box_url = "https://s3.amazonaws.com/vagrant.testeng.edx.org/edx-devstack.box"
# Creates a devstack from a base Ubuntu 12.04 image
config.vm.box = "precise64"
config.vm.box_url = "http://files.vagrantup.com/precise64.box"
config.vm.network :private_network, ip: "192.168.33.10"
config.vm.network :forwarded_port, guest: 8000, host: 8000
config.vm.network :forwarded_port, guest: 8001, host: 8001
config.vm.network :forwarded_port, guest: 4567, host: 4567
config.vm.synced_folder "edx-platform", "/edx/app/edxapp/edx-platform", :create => true, nfs: true
config.vm.synced_folder "cs_comments_service", "/edx/app/forum/cs_comments_service", :create => true, nfs: true
config.hostsupdater.aliases = ["preview.localhost"]
config.vm.provider :virtualbox do |vb|
......
vagrant/fullstack/README.rst 0 → 100644
devstack
========
Vagrant instance for a production like configuration running all services on a single server
Installation instructions - https://github.com/edx/configuration/wiki#installing-edx-using-a-pre-built-vagrant-fullstack-image
vagrant/release/dosa/devstack/Vagrantfile 0 → 100644
MEMORY = 2048
CPU_COUNT = 2
edx_platform_mount_dir = "cs_comments_service"
forum_mount_dir = "edx-platform"
if ENV['VAGRANT_MOUNT_BASE']
edx_platform_mount_dir = ENV['VAGRANT_MOUNT_BASE'] + "/" + forum_mount_dir
forum_mount_dir = ENV['VAGRANT_MOUNT_BASE'] + "/" + edx_platform_mount_dir
end
Vagrant.configure("2") do |config|
config.vm.box = "edx-devstack"
config.vm.box_url = "http://edx-static.s3.amazonaws.com/vagrant-images/20131113-dosa-devstack.box"
config.vm.network :private_network, ip: "192.168.33.10"
config.vm.network :forwarded_port, guest: 8000, host: 8000
config.vm.network :forwarded_port, guest: 8001, host: 8001
config.vm.network :forwarded_port, guest: 4567, host: 4567
config.vm.synced_folder "#{edx_platform_mount_dir}", "/edx/app/edxapp/edx-platform", :create => true, nfs: true
config.vm.synced_folder "#{forum_mount_dir}", "/edx/app/forum/cs_comments_service", :create => true, nfs: true
config.hostsupdater.aliases = ["preview.localhost"]
config.vm.provider :virtualbox do |vb|
vb.customize ["modifyvm", :id, "--memory", MEMORY.to_s]
vb.customize ["modifyvm", :id, "--cpus", CPU_COUNT.to_s]
end
edxapp_version = "master"
forum_version = "master"
config.vm.provision :ansible do |ansible|
ansible.playbook = "../../../../playbooks/vagrant-devstack.yml"
ansible.inventory_path = "../../../../playbooks/vagrant/inventory.ini"
ansible.tags = "deploy"
ansible.verbose = "extra"
end
end
vagrant/release/dosa/devstack/ansible.cfg 0 → 120000
../../../../playbooks/ansible.cfg
\ No newline at end of file
vagrant/shortstack-xml/Vagrantfile → vagrant/release/dosa/fullstack/Vagrantfile
MEMORY = 1024
MEMORY = 2048
CPU_COUNT = 2
Vagrant.configure("2") do |config|
config.vm.box = "precise64"
config.vm.box_url = "http://files.vagrantup.com/precise64.box"
config.vm.box = "edx-fullstack"
config.vm.box_url = "http://edx-static.s3.amazonaws.com/vagrant-images/20131113-dosa-fullstack.box"
config.vm.network :private_network, ip: "192.168.33.10"
......@@ -16,9 +16,8 @@ Vagrant.configure("2") do |config|
config.vm.provision :ansible do |ansible|
# point Vagrant at the location of your playbook you want to run
ansible.playbook = "../../playbooks/vagrant-shortstack-xml.yml"
ansible.inventory_path = "../../playbooks/vagrant/inventory.ini"
ansible.playbook = "../../../../playbooks/vagrant-fullstack.yml"
ansible.inventory_path = "../../../../playbooks/vagrant/inventory.ini"
ansible.verbose = "extra"
end
end
vagrant/release/dosa/fullstack/ansible.cfg 0 → 120000
../../../../playbooks/ansible.cfg
\ No newline at end of file
vagrant/shortstack-xml/ansible.cfg deleted 120000 → 0
../../playbooks/ansible.cfg
\ No newline at end of file
vagrant/shortstack/Vagrantfile deleted 100644 → 0
MEMORY = 2048
CPU_COUNT = 2
Vagrant.configure("2") do |config|
config.vm.box = "precise64"
config.vm.box_url = "http://files.vagrantup.com/precise64.box"
config.vm.network :private_network, ip: "192.168.33.10"
config.vm.provider :virtualbox do |vb|
vb.customize ["modifyvm", :id, "--memory", MEMORY.to_s]
# You can adjust this to the amount of CPUs your system has available
vb.customize ["modifyvm", :id, "--cpus", CPU_COUNT.to_s]
end
config.vm.provision :ansible do |ansible|
# point Vagrant at the location of your playbook you want to run
ansible.playbook = "../../playbooks/vagrant-shortstack.yml"
ansible.inventory_path = "../../playbooks/vagrant/inventory.ini"
ansible.verbose = "extra"
# to target the master branch of edx-platform, instead of the release branch,
# just uncomment this line
# ansible.extra_vars = { edx_platform_commit: "master" }
end
end
vagrant/shortstack/ansible.cfg deleted 120000 → 0
../../playbooks/ansible.cfg
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment