osuosl-cookbooks / pgd

Apache License 2.0
1 stars 0 forks source link

PGD Cookbook

This cookbook is for setting up PGD project for easy development.

Requirements

For testing you need the following gems:

If you use berkshelf, you also will want to install the berkshelf gem as well.

To install dependencies run 'bundle install' in the root of the directory.

Attributes

pgd_cookbook::default

Key Type Description Default
['pgd']['pgd_path'] String Full path to the location PGD gets cloned. Note: This is not where it is installed.
['pgd']['virtualenv_path'] String Where to actually install PGD to. This is the location setup.sh will create GWM's virtualenv nil
['pgd']['user'] String User to change to when running commands nil
['pgd']['group'] String Group to change to when running commands nil
['pgd']['debug'] Boolean Whether or not to set the Django debug mode on or off false
['pgd']['static_root'] String Absolute path to where you want staticfiles to be collected to /opt/pgd/collected_static
['pgd']['static_url'] String Url to find GWM's static files at. /static
['pgd']['database']['engine'] String See https://docs.djangoproject.com/en/1.6/ref/settings/#databases nil #This default value will break the cookbook.
['pgd']['database']['name'] String See https://docs.djangoproject.com/en/1.6/ref/settings/#databases nil
['pgd']['database']['user'] String See https://docs.djangoproject.com/en/1.6/ref/settings/#databases nil
['pgd']['database']['password'] String See https://docs.djangoproject.com/en/1.6/ref/settings/#databases nil
['pgd']['database']['host'] String See https://docs.djangoproject.com/en/1.6/ref/settings/#databases nil
['pgd']['database']['port'] String See https://docs.djangoproject.com/en/1.6/ref/settings/#databases nil

Usage

pgd_cookbook::default

Just include pgd_cookbook in your node's run_list.

{
  "name":"my_node",
  "run_list": [
    "recipe[pgd_cookbook]"
  ]
}

pgd_cookbook::bootstrap_user

Just include pgd_cookbook::bootstrap_user in addition to one of the previous recipes in run_list:

{
  "name":"my_node",
  "run_list": [
    "recipe[pgd_cookbook::default]"
    "recipe[pgd_cookbook::bootstrap_user]"
  ]
}

Then set the attribute node['pgd']['superuser'] to something like this:

{
  "username": "foo",
  "password": "bar",
  "email": "foo@bar.com"
}

Contributing

TODO: (optional) If this is a public cookbook, detail the process for contributing. If this is a private cookbook, remove this section.

e.g.

  1. Fork the repository on Github
  2. Create a named feature branch (like add_component_x)
  3. Write your change
  4. Write tests for your change (if applicable)
  5. Run the tests, ensuring they all pass
  6. Submit a Pull Request using Github

License and Authors

Authors: TODO: List authors