No commit activity in last 3 years
No release in over 3 years
API to implement a webhook stage for spinnaker to stop sidekiq workers gracefully
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

Runtime

>= 5.0
>= 4.0
 Project Readme

Spinnaker::Sidekiq

API to implement a webhook stage for spinnaker to stop sidekiq workers gracefully.

Installation

Add this line to your application's Gemfile:

gem 'spinnaker-sidekiq'

And then execute:

$ bundle

Or install it yourself as:

$ gem install spinnaker-sidekiq

Usage

Mount the engine in your rails application.

mount Spinnaker::Sidekiq::Engine, at: "/spinnaker/sidekiq"

API token can be specified by environment variable SPINNAKER_SIDEKIQ_API_TOKEN or doing:

Spinnaker::Sidekiq.api_token = 'SECRET_VALUE'

In spinnaker, create a webhook stage with the following configuration:

  • Webhook URL: https://example.com/spinnaker/sidekiq/quiet_all
  • Method: POST
  • Payload {}
  • Custom Headers: Authorization value Token SPINNAKER_API_TOKEN
  • Status JsonPath: $.status
  • Progress location: $.progress
  • SUCCESS status mapping: quiet

Contributing

Contribution directions go here.

License

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