profcab / opendsa-devstack

Setting Up a Vagrant Development Environment for OpenDSA

Introduction:

Vagrant is designed to run on multiple platforms, including Mac OS X, Microsoft Windows, Debian, Ubuntu, CentOS, RedHat and Fedora. In this document we describe how to configure and run an OpenDSA project virtual development environment through Vagrant.

Installation Steps:

1. Install Vagrant

2. Install VirtualBox

3. Clone this repository

4. $ cd OpenDSA-DevStack

5. $ vagrant up (This will take a long time to install everything the first time!)

6. $ vagrant ssh

7. $ cd /vagrant

8. $ ./runservers.sh

9. After the provisioning script is complete you can go to:

   • http://192.168.33.10:8080 for OpenDSA content server
   • https://192.168.33.10:9292 for OpenDSA-LTI server
   • https://192.168.33.10:9200 for code-workout server

Shut Down The Virtual Machine:

After you finish your work, you need to turn the virtual machine off.

1. Exit the virtual machine terminal by typing exit
2. Change directory to OpenDSA-DevStack
3. $ vagrant halt

Re-run Development Servers:

If you decided to shut down the virtual machine using vagrant halt, you have to re-run the servers again after you do vagrant up.

1. Change directory to OpenDSA-DevStack
2. $ vagrant up
3. $ vagrant ssh
4. $ cd /vagrant
5. $ ./runservers.sh

Reprovision The Virtual Machine:

If anything went wrong or you want to reprovision your virtual machine for any reason, follow these steps.

1. Change directory to OpenDSA-DevStack
2. $ git pull
3. $ vagrant destroy
4. $ vagrant up

Virtual Machine sudo password:

The sudo password is vagrant (in case you need to execute any commands that require sudo).

Development Workflow:

The provisioning script will clone the OpenDSA, OpenDSA-LTI, and code-workout repositories inside the OpenDSA-DevStack directory. The OpenDSA-DevStack directory is shared between your host machine and the virtual machine, so you can do your development to any of these repositories on your host machine using your preferred tools or IDEs (from "outside" the virtual machine). All changes that you make will take effect immediately, and you can test them through the virtual machine server URLs provided earlier. You can commit and push your changes from your host machine. However, if you want to compile books in OpenDSA, you have to do that from within the virtual machine. Do so as follows:

1. Open a new terminal within your virtual machine
2. $ cd OpenDSA-DevStack
3. $ vagrant ssh (you don't need to do vagrant up if the VM is already up and running)
4. $ cd /vagrant/OpenDSA
5. make <<CONFIG_FILE_NAME>>

Keep OpenDSA-DevStack up to date:

Other developers might make changes to any of the repositories cloned by the OpenDSA-DevStack. To keep your local version up to date with the latest version do the following:

1. Open a new terminal
2. Change directory to OpenDSA-DevStack
3. $ vagrant reload
4. $ vagrant ssh
5. $ cd /vagrant
6. $ ./get_latest.sh

opendsa and codeworkout Databases Test Data

The initial database population is defined by lib/tasks/sample_data.rake. It uses the factories defined in spec/factories/* to generate entities. If you add new model classes and want to generate test data in the database, please add to the sample_data.rake file so that this population will happen automatically for everyone. The sample_data.rake contains only "sample/try out" data for use during development, and it won't appear on the production server. Initial database contents provided for all new installs, including the production server, is described in db/seeds.rb instead.

• opendsa database includes the following admin account:

  • [email protected] (pass: adminadmin)

• codeworkout database includes the following admin account:

  • [email protected] (pass: adminadmin)

• Both opendsa and codeworkout databases include the following accounts:

  • [email protected] (pass: hokiehokie), has instructor access
  • example-*@railstutorial.org (pass: hokiehokie) 50 students

  It also includes the following other objects:

  • Five terms (Spring, Summer I, Summer II, Fall, and Winter 2016),
  • one organization (VT)
  • one course (CS 1114)
  • two offerings of 1114 (one each term)
    • one course offering is set up with the admin and instructor as instructors, and all other sample accounts as students

Generate Canvas course using OpenDSA web interface.

1. Make sure OpenDSA-DevStack is up to date by following the instructions here.
2. After you are done you should have OpenDSA-LTI server running. Go to https://192.168.33.10:9292 to make sure your application is up and running.
3. Follow the instructions on the instructor's guide page to set up your Canvas course. Note: skip the first step in this guide since you can use the admin account ([email protected], pass: adminadmin) to cerate the course.

Production deployment workflow

If you are responsible for maintaining an OpenDSA-LTI production server, follow the instructions in this section to perform deployment to the production server.

Deployment to the production server is initiated from the development environment. It starts with changes you make to OpenDSA-LTI or OpenDSA repositories in OpenDSA-DevStack. First, test these changes locally using OpenDSA-DevStack development servers. Second, commit and push any OpenDSA-LTI and OpenDSA changes. Finally, initiate the production deployment command from within OpenDSA-DevStack. It is important to push your changes before the deployment. Every time you deploy your code, Capistrano will clone the latest version of OpenDSA-LTI, then perform the deployment tasks. One of the tasks gets the latest version of OpenDSA from GitHub as well.

The following steps need to be done only once to generate a pair of authentication keys. Note: Do not enter a passphrase, and replace prod_server with your domain name. Some installations use both a staging and a production server. If yours has both, then you will need to do the cat line for each one.

   
      Change directory to OpenDSA-DevStack
      $ vagrant up
      $ vagrant ssh
      $ ssh-keygen -t rsa
      $ cat .ssh/id_rsa.pub | ssh deploy@prod_server 'cat >> .ssh/authorized_keys'

      Enter deploy user password for the last time
   

Here are the steps that you need to follow every time you want to perform a production deployment:

   
      Change directory to OpenDSA-DevStack
      $ vagrant up
      $ vagrant ssh
      $ cd /vagrant/OpenDSA-LTI
      $ git pull any new code
      $ commit and push any changes
      Execute the following command to deploy to the staging server:
      $ bundle exec cap staging deploy
      Execute the following command to deploy to the production server:
      $ bundle exec cap production deploy
      ...
      $ Please enter a branch (<current_branch>): <Branch to deploy. Leave blank to deploy current_branch>
   

Connect to Vagrant VM Database:

During development, it is convenient to connect to opendsa and codeworkout databases from your host machine using MySQL Workbench. Once you installed MySQL Workbench create a new connection to Vagrant VM Database using the following setup:

• Connection Name: OpenDSA-Devstack
• Connection Method: Standard TCP/IP over SSH
• SSH Hostname: 192.168.33.10
• SSH Username: vagrant
• SSH Password: vagrant
• MySQL Hostname: 127.0.0.1
• MySQL Server Port: 3306
• Username: opendsa
• Password: opendsa

Getting Chrome to accept Self Signed SSL for Local Development with Vagrant

• On the page with the untrusted certificate (https:// is crossed out in red), click the lock > Certificate Information.
• Click the Details tab > Export. Choose PKCS #7, single certificate as the file format.
• Then follow my original instructions to get to the Manage Certificates page. Click the `Authorities tab > Import and choose the file to which you exported the certificate.
• If prompted certification store, choose Trusted Root Certificate Authorities
• Check all boxes and click OK. Restart Chrome.