Skip to content

Latest commit

 

History

History
65 lines (36 loc) · 2.65 KB

PROJECT_README.md

File metadata and controls

65 lines (36 loc) · 2.65 KB

$NEW_PROJECT_SLUG

What is this?

TKTK: Describe $NEW_PROJECT_SLUG here.

Assumptions

The following things are assumed to be true in this documentation.

  • You are running OSX.
  • You are using Python 2.7. (Probably the version that came OSX.)
  • You have virtualenv and virtualenvwrapper installed and working.

For more details our stack, see our development environment blog post.

What's in here?

The project contains the following folders and important files:

  • fabfile -- Fabric commands for automating setup, deployment, data processing, etc.
  • app_config.py -- Global project configuration for scripts, deployment, etc.
  • crontab -- Cron jobs to be installed as part of the project.
  • requirements.txt -- Python requirements.
  • run_on_server.sh -- Shell script to run at the beginning of cron jobs to source environment variables and virtual environments.

Bootstrap the project

cd $NEW_PROJECT_SLUG
mkvirtualenv $NEW_PROJECT_SLUG
pip install -r requirements.txt

Hide project secrets

Project secrets should never be stored in app_config.py or anywhere else in the repository. They will be leaked to the client if you do. Instead, always store passwords, keys, etc. in environment variables and document that they are needed here in the README.

Any environment variable that starts with $PROJECT_SLUG_ will be automatically loaded when app_config.get_secrets() is called.

Deploy to EC2

  1. Run fab staging master servers.setup to configure the server.
  2. Run fab staging master deploy to deploy the project to the server. Note that this will also install your crontab.

Managing cron jobs

Cron jobs are defined in the file crontab. Each task should use the run_on_server.sh shim to ensure the project's virtualenv is properly activated prior to execution. For example:

* * * * * ubuntu bash /home/ubuntu/apps/$NEW_PROJECT_FILENAME/repository/cron.sh fab $DEPLOYMENT_TARGET cron_jobs.test >> /var/log/$NEW_PROJECT_FILENAME/crontab.log 2>&1

The cron jobs themselves should be defined in fabfile/cron_jobs.py whenever possible.

To install the cronjob, run either fab staging master deploy, which will also synchronize the repo with the latest on Github, or fab staging master servers.install_crontab to simply copy the crontab on the server to etc/cron.d.

To uninstall the cronjob (a recommended practice for disabling the job), run fab staging master servers.uninstall_cronjob.