https://github.com/linuxthor/knife-gadgets
Add hooks to knife to run custom scripts at key points
https://github.com/linuxthor/knife-gadgets
Last synced: 5 months ago
JSON representation
Add hooks to knife to run custom scripts at key points
- Host: GitHub
- URL: https://github.com/linuxthor/knife-gadgets
- Owner: linuxthor
- License: gpl-2.0
- Created: 2015-10-23T06:52:43.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2015-10-23T10:16:53.000Z (over 10 years ago)
- Last Synced: 2025-06-30T10:07:07.912Z (8 months ago)
- Language: Ruby
- Size: 148 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# knife-gadgets
A knife plugin that adds hooks to knife to run external scripts at key points and potentially abort the action being taken.
Install by copying to .chef/plugins/knife/
Currently there are two hooks in the 'cookbook upload' command:
1. Before syntax checking (useful for extra checking/linting of cookbooks)
2. After syntax checking has passed but before upload takes place (a good time to commit to SCM)
When the hook code runs it checks if the configuration options 'prevalidate_hook' and 'postvalidate_hook' are set (e.g in knife.rb) and runs the scripts they point to.
Example knife.rb settings:
```
prevalidate_hook "/home/user/Chef/prevalidate_cookbook.sh"
postvalidate_hook "/home/user/Chef/postvalidate_cookbook.sh"
```
The following environment variables are populated when calling the external helper:
```
$CURRENT_COOKBOOK #name of the current cookbook
$COOKBOOK_PATH #filesystem path to cookbooks
$NODE_NAME #name of client
```
If a script returns a non-zero exit code the 'cookbook upload' operation is aborted.
It is planned to add additional hooks over time.