For HW #1, we have some specific instructions to make it so that your TAs can easily grade your work. Doing these steps should not take long. They can be done after you are finished). But best practice would be to set this up at the start when your project is just getting started, and then checking that your docker deployment works as you add components, libraries, etc. Please do not wait until the last minute to try them out as you may run into issues that could delay your submission.

Final Checklist

• [ ] Follow the instructions on this page below
• [ ] One person from each team needs to submit this linked google form with basic info on your team.
• [ ] To help with your final testing and organization to ensure that no required piece of functionality is missed, refer to the HW1 requirements spreadsheet posted along with the assignment. You must fill out this spreadsheet and place it in your gitlab repo. For each of the requirements, simply indicate whether this is something you successfully implemented or not. If you didn't quite get a piece of functionality working, indicate an estimate of what % of the way to completion you got for that function.
• [ ] Don't forget to put your danger log (e.g. danger_log.txt) in your gitlab repo
• [ ] Push your code to your gitlab repo with a commit message of "finalize" when you are ready to submit. This will be the commit we use for grading.
• [ ] After these steps are complete, one partner simply needs to paste the link of your gitlab repo to Canvas as the submission to Homework #1 (don't forget to add TAs and instructor as "reporters" to the repo).

Before you submit your assignment, please make sure to do the following:

(Please ignore step 1-3 if already finished)

1. On your vm, execute:

   sudo apt-get install docker.io docker-compose

2. Download the docker-v2.zip file posted along with HW1 on Sakai and unzip it.  (It may be easier to download to your computer, then scp to your vm, then unzip)

   You should get:

   docker-deploy   
      |—docker-compose.yml
      |—nginx     
      |     |—config   
      |            |—web-app.conf   
      |—web-app         
            |—Dockerfile         
            |—requirements.txt
   

3. Place your homework 1 into the web-app directory.  That is, you should now end up with this structure (Don't understand?):

   docker-deploy
      |—docker-compose.yml
      |—nginx
      |     |—config
      |            |—web-app.conf
      |—web-app
            |—Dockerfile
            |—requirements.txt
            |—manage.py
            |—templates
            |....all your other directories for the project...
   

4. Edit your site's main settings.py file as follows: (why?)

   1. find ALLOWED_HOSTS and add 'web', so now it says:

      ALLOWED_HOSTS = ['web’, ...any other hostname you need]

   2. find your DB config and replace it with: [below is an working example, as postgres has a default user called postgres but if it works with other configuration is also allowed]

   DATABASES = {
       'default': {
           'ENGINE': 'django.db.backends.postgresql',
           'NAME': 'postgres',
           'USER': 'postgres',
           'HOST': 'db',
           'PORT': 5432,
       }}
   

5. If your homework requires anything special to be installed, If it is a python package (installed with pip) add it to web-app/requirements.txt

   1. If you installed anything else with apt-get, place a line in the Dockerfile:

      RUN apt-get update && apt-get install -yq --no-install-recommends  WHATEVERPACKAGES && apt-get clean

   2. If you needed any other server setup, add appropriate RUN commands to the Dockerfile

6. Test out the setup.

   1. cd into the docker-deploy directory

   2. sudo docker-compose up

      This should start up your web-app with an empty postgres database, listening on port 8000.  You should be able to connect to your vm on this port and interact with your web-app exactly as you expect.

7. Make a git repository on gitlab.oit.duke.edu. The project should be named exactly as follows: erss-hwk1-netid1-netid2.  Where netid1 and netid2 are the netids of the two people in the group (e.g., erss-hwk1-bmr23-yl483).  Grant access to your TAs and instructors by adding the following Net IDs as "reporters" to your project --  lz238(Longhao), hl490(Evan),  zg73(Zixu), kl461(Kaixin), bmr23 (Brian).  Your git repository should include the entire docker-deploy directory and all its subdirectories.  This way your TAs can run your homework to grade it by doing.

   git clone (repo link)
   cd erss-hwk1-netid1-netid2
   sudo docker-compose up
   

   • [You may wish to clone your repo from the gitlab link into an empty directory, and run 'sudo docker-compose up' on it to check that your submission has everything you need.]

8. Submission will be done by taking whatever you have at the deadline.  If you want to submit late (consult syllabus for grade penalties for so doing) then email myself and the TAs and let them know this before the deadline.  Otherwise, they will just take whatever is in your gitlab repo at the deadline and clone it.