https://github.com/tubbo/hibachi
Manage Chef configuration with your Rails app
https://github.com/tubbo/hibachi
Last synced: about 1 month ago
JSON representation
Manage Chef configuration with your Rails app
- Host: GitHub
- URL: https://github.com/tubbo/hibachi
- Owner: tubbo
- License: mit
- Created: 2014-06-05T19:03:39.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2023-12-15T02:56:23.000Z (over 1 year ago)
- Last Synced: 2025-02-27T11:35:39.904Z (2 months ago)
- Language: Ruby
- Homepage:
- Size: 109 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Hibachi
[](https://travis-ci.org/tubbo/hibachi)
[](https://codeclimate.com/github/tubbo/hibachi)
[](https://codeclimate.com/github/tubbo/hibachi/coverage)
[](http://inch-ci.org/github/tubbo/hibachi)
An object-resource mapper for your Chef server. Enables a Rails app to
manipulate its own Chef node attributes and trigger a `chef-client`
run on its local machine, as well as any others your client has access
to.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'hibachi'
```
And then execute:
```bash
$ bundle
```
## Usage
Generate a new model with the following command:
```bash
$ rails generate hibachi:model network_interface name is_static:boolean address netmask gateway --plural
```
This will generate the following model and an accompanying test:
```ruby
class NetworkInterface < Hibachi::Model
pluralized!
field :name, type: String
field :is_static, type: Boolean
field :address, type: String
field :netmask, type: String
field :gateway, type: String
end
```
To learn more about how to use Hibachi, [visit the Wiki][wiki]
## Development
You can run `bin/setup` to install all dependencies in one go, and
`bin/console` for an interactive console prompt. We also provide `rake`
and `rspec` commands for running regular shell tasks.
### Running Tests
To run tests and check against the Ruby style guide:
```bash
$ rake
```
### Releasing
To release a new version of this gem, bump the version number in
`lib/hibachi/version.rb` and run the following command to push a Git tag
to the server. [Travis][ci] will handle deploying the gem to RubyGems on new
successful tag builds:
```bash
$ rake publish
```
### Contributing
A passing build is required for any contributions made to this project.
We also prefer you write tests for any new features you wish to add and
use the test framework to highlight how and why bug fixes had to occur.
1. Fork it ( https://github.com/tubbo/hibachi/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request
[wiki]: https://github.com/tubbo/hibachi/wiki
[ci]: https://travis-ci.org