Deployment Notification Provider for RunDeck
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
exe
lib
spec
.gitignore
.gitlab-ci.yml
.rubocop.yml
CHANGELOG.md
Gemfile
Gemfile.lock
LICENSE.txt
README.md
Rakefile
deploy-info.gemspec

README.md

Deploy-Info

  • Deployment Notification Provider for RunDeck
  • Pulls information potentially not readily available to RunDeck
  • One simple POST from RunDeck instead of a script (NewRelic Deploys require a JSON POST)
  • Maybe Eventually: Record last deployed revision locally and feed it back for consumption/display inside RunDeck

Background

This project's initial purpose is/was to fire off NewRelic & Rollbar deployment notifications from RunDeck. It can be difficult to grab information such as a commit SHA when you may just be deploying a branch from RunDeck. This serves to fill that gap and ensure the revision field is populated appropriately, and it can also be utilized to keep your NewRelic API key out of visibility in the RunDeck console.

NOTE: This API should NOT be exposed to the world unless you plan to secure it with a reverse-proxy or something. It is intended to only be bound to localhost on the same server as RunDeck.

Running as a Service

You'll likely want to run this as a service, SystemD or Upstart will likely be your friend in this regard.

Security

You should lock down permissions on all configuration files in this project to only the user which this runs as...

To run this project securely, DON'T run it as the RunDeck user.

Caching

This leans on rack-cache to serve as a caching mechanism. The objective here was to make sure we don't pummel the Chef API with redundant queries.

  • Timeout can be configured via the cache_timeout setting. Default: 30 seconds

Installation

Add this line to your application's Gemfile:

gem 'deploy-info'

And then execute:

$ bundle

Or install it yourself as:

$ gem install deploy-info

Usage

TODO: Write usage instructions here

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/bdwyertech/deploy-info. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.