cookbook 'run-notifier', '= 0.4.1'
run-notifier (8) Versions 0.4.1 Follow2
Installs/Configures chef-run-notifier
cookbook 'run-notifier', '= 0.4.1', :supermarket
knife supermarket install run-notifier
knife supermarket download run-notifier
chef-run-notifier Cookbook
Run Notifier to send notification to HipChat and / or Slack if chef run successfully or failed.
https://supermarket.chef.io/cookbooks/run-notifier
<img width="644" alt="screen shot 2017-12-11 at 8 21 29 pm" src="https://user-images.githubusercontent.com/3461316/33849588-59abc1c4-deb1-11e7-9726-121f13cce42a.png">
Requirements
- Chef version 11 :negative_squared_cross_mark:
- Chef version 12 :white_check_mark:
- Chef version 13 :negative_squared_cross_mark:
Attributes
chef-run-notifier::default
| Key | Type | Description | Default |
|---|---|---|---|
| ['run_notifier']['slack']['enabled'] | Boolean | Wheather to enable slack or not | false |
| ['run_notifier']['slack']['webhook_url'] | String | Webhook URL | https://abc.com |
| ['run_notifier']['slack']['channel'] | String | Channel | #default |
| ['run_notifier']['slack']['username'] | String | Username | FainNow |
| ['run_notifier']['hipchat']['enabled'] | Boolean | Wheather to enable hicphat or not | false |
| ['run_notifier']['hipchat']['api_token'] | String | HipChat API token | 1234 |
| ['run_notifier']['hipchat']['username'] | String | Username | FaiNow |
| ['run_notifier']['hipchat']['room_name'] | String | Room name | default |
| ['run_notifier']['hipchat']['notify'] | Boolean | Whether to notify user or not | |
| ['run_notifier']['custom_messages]['success_message] | String | custom success message | '"Chef run succesfully on #{node.name}"' |
| ['run_notifier']['custom_messages']['failed_message'] | String | custom failed message | '"Failure on #{node.name}: #{run_status.formatted_exception}"' |
Usage
chef-run-notifier::default
Just include chef-run-notifier in your node's run_list:
{
"name":"my_node",
"run_list": [
"recipe[run-notifier]"
]
}
Contributing
- Fork the repository on Github
- Create a named feature branch (like
add_component_x) - Write your change
- Write tests for your change (if applicable)
- Run the tests, ensuring they all pass,
bundle exec rspecas well askitchen test - Submit a Pull Request using Github
License and Authors
Author: Faizal Zakaria
Dependent cookbooks
| chef_handler >= 0.0.0 |
Contingent cookbooks
There are no cookbooks that are contingent upon this one.
Collaborator Number Metric
0.4.1 failed this metric
Failure: Cookbook has 0 collaborators. A cookbook must have at least 2 collaborators to pass this metric.
Contributing File Metric
0.4.1 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file
Foodcritic Metric
0.4.1 passed this metric
No Binaries Metric
0.4.1 passed this metric
Testing File Metric
0.4.1 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
0.4.1 passed this metric
0.4.1 failed this metric
0.4.1 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file
Foodcritic Metric
0.4.1 passed this metric
No Binaries Metric
0.4.1 passed this metric
Testing File Metric
0.4.1 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
0.4.1 passed this metric
0.4.1 passed this metric
0.4.1 passed this metric
Testing File Metric
0.4.1 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
0.4.1 passed this metric
0.4.1 failed this metric
0.4.1 passed this metric
