Skip to content

Latest commit

 

History

History
100 lines (66 loc) · 2.85 KB

README.md

File metadata and controls

100 lines (66 loc) · 2.85 KB

Gem Version Code Climate Build Status Slack

Simple and lightweight configuration management tool inspired by Chef.

Concept

  • Chef-like DSL (but not compatible with Chef)
  • Simpler and lighter weight than Chef
  • Only recipes
  • Idempotent

Installation

$ gem install itamae

Getting Started

Create a recipe file as recipe.rb:

package 'nginx' do
  action :install
end

service 'nginx' do
  action [:enable, :start]
end

And then excute itamae command to apply a recipe to a local machine.

$ itamae local recipe.rb
 INFO : Starting Itamae...
 INFO : Recipe: /home/user/recipe.rb
 INFO :    package[nginx]
 INFO :       action: install
 INFO :          installed will change from 'false' to 'true'
 INFO :    service[nginx]
 INFO :       action: enable
 INFO :       action: start

Or you can apply a recipe to a remote machine by itamae ssh.

$ itamae ssh --host host001.example.jp recipe.rb

You can also apply a recipe to Vagrant VM by itamae ssh --vagrant.

$ itamae ssh --vagrant --host vm_name recipe.rb

You can find further information to use Itamae on Itamae Wiki.

Enjoy!

Documentation

https://github.com/itamae-kitchen/itamae/wiki

Run tests

Requirements: Vagrant

$ bundle exec rake spec

Get Involved

Presentations / Articles

in Japanese

Contributing

If you have a problem, please create an issue or a pull request.

  1. Fork it
  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 new Pull Request