Skip to content

Latest commit

 

History

History
109 lines (78 loc) · 4.11 KB

README.md

File metadata and controls

109 lines (78 loc) · 4.11 KB
Raw

oc-opsworks-recipes Build Status

A custom cookbook in support of mh-opsworks.

Supported Platforms

Amazon Linux 2018.03, and more specifically amazon opsworks

Development

Requirements

  • ruby >= 2
  • vagrant >= 1.7.0

Development setup

First, satisfy the requirements above. Then:

    git clone https://github.com/harvard-dce/oc-opsworks-recipes/
    cd oc-opsworks-recipes
    bundle

You should now have test-kitchen and the vagrant tooling for test-kitchen installed. You probably need to read up on test-kitchen if you're not familiar with it.

Documentation

High level documentation is available for most recipes. Given how tightly bound this project is to mh-opsworks, we frequently refer you to documentation in that project as well.

To generate and access the recipe docs after you've set this project up:

    # Generate them
    ./bin/generate_docs.sh
    # In a separate terminal, spin up a web server in the doc/ directory
    cd doc && ruby -run -e httpd . -p 9090

Docs will be available on localhost:9090. Click into the "Cookbooks List" to see recipe-level documentation.

If you're on linux and have installed inotifywait (on debian this is in inotify-tools) ./bin/generate_docs.sh will watch for changes and automatically regenerate documentation for you. Hit control-c to exit.

If you aren't on linux you need to generate the docs yourself automatically after changing them - just run ./bin/generate_docs.sh manually.

Process

  • Create a branch off the develop branch

  • Edit your cluster config to use this branch in your development cluster

  • Write tests - currently we support bats tests, but serverspec should work fine too once we get to it.

  • Make your changes and push them to your recipe branch

  • Update your recipe's description in metadata.rb

  • Run ./bin/run_foodcritic.sh to lint your recipes. This uses foodcritic to lint your recipes for best practices. See .foodcritic for config and information on tests we skip. We also run these tests via travis here

  • Run your kitchen tests

      kitchen test <your test suite>

  • (optional, but do it relatively frequently) run the full kitchen tests

      kitchen test all

  • Update your cluster's chef recipes and redeploy to run them. If your recipe isn't run during the opsworks deploy lifecycle, then run it manually to test.

  • Work on your feature until it's ready to be merged into the develop branch.

  • Be sure to update the "To be released" section of the CHANGELOG.md file with a description of your change, and whether or not it requires a manual recipe invocation. If your change runs as part of the deploy lifecycle, it will be run the next time the main app is deployed to a cluster and therefore does not require a manual chef recipe invocation.

  • Rebase against develop and submit a pull request off of develop.

QA'ing and releasing new chef recipes

  • Update CHANGELOG.md to collapse all "To be released" changes under a new version, following semver.
  • Rebase develop onto master (just to be sure).
  • Cut an RC tag and link that into your staging cluster. Annotate the tag to reference the opencast tag this is meant to work with.
  • QA. When QA passes,
  • Merge the RC tag into master,
  • Tag the release on master based on the RC tag
  • Push the tag to the remote via git push --tags
  • Make sure the release manager knows the correct tag to use in the cluster config.

Contributors

License

This project is under an Apache 2.0 license. Please see LICENSE.txt for details.

Copyright

2015 President and Fellows of Harvard College