k0kubun/mruby-cli repository overview

⁠:sushi: mitamae

mitamae is a tool to automate configuration management using a Chef-like DSL powered by mruby.

⁠Key Features

• Fast - mitamae is optimized for local execution. It uses C functions via mruby libraries for core operations where possible, instead of executing commands on a shell or over a SSH connection like other tools, which is very slow.

• Simple - Running mitamae doesn't require Chef Server, Berkshelf, Data Bags, or even RubyGems. The mitamae core provides only essential features. You can quickly be a master of mitamae.

• Single Binary - mitamae can be deployed by just transferring a single binary to servers. You don't need to rely on slow operations over a SSH connection to workaround deployment problems.

⁠Installation

Download a binary for your platform from GitHub Releases⁠.

curl -L https://github.com/itamae-kitchen/mitamae/releases/latest/download/mitamae-x86_64-linux.tar.gz \
  | tar xvz
./mitamae-x86_64-linux help

⁠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 mitamae local command to apply a recipe to a local machine.

$ mv mitamae-x86_64-linux mitamae
$ ./mitamae local recipe.rb
 INFO : Starting mitamae...
 INFO : Recipe: /home/user/recipe.rb
 INFO :   package[nginx] installed will change from 'false' to 'true'
 INFO :   service[nginx] enabled will change from 'false' to 'true'
 INFO :   service[nginx] running will change from 'false' to 'true'

See mitamae help local for available options. --log-level=debug is helpful to inspect what's executed in detail.

⁠Documentation

mitamae was built as an alternative implementation of Itamae⁠. Therefore you may refer to resources related to Itamae for mitamae as well.

⁠How to write recipes

Please refer to Itamae wiki⁠:

• Resources⁠
  • directory resource⁠
  • execute resource⁠
  • file resource⁠
  • gem_package resource⁠
  • git resource⁠
  • group resource⁠
  • http_request resource⁠
  • link resource⁠
  • local_ruby_block resource⁠
  • package resource⁠
  • remote_directory resource⁠
  • remote_file resource⁠
  • service resource⁠
  • template resource⁠
  • user resource⁠
• Definitions⁠
• Including Recipes⁠
• Node Attributes⁠
• run_command⁠
• Host Inventory⁠

⁠Plugins

Please see PLUGINS.md⁠ for how to install or create plugins for mitamae.

Find mitamae plugins⁠ and Itamae plugins supporting mitamae⁠ on GitHub.

⁠mruby features

The DSL is based on mruby instead of standard Ruby unlike Chef and Itamae. You may use the following mruby features in mitamae recipes.

• mruby's built-in features⁠
  • Some features may not be available if not specified or used by mrbgem.rake dependencies⁠.
  • Check MRUBY_VERSION⁠ used by mitamae and Latest News on mruby.org⁠.
• mruby-at_exit⁠
• mruby-dir-glob⁠
• mruby-dir⁠
• mruby-env⁠
• mruby-erb⁠
• mruby-etc⁠
• mruby-file-stat⁠
• mruby-hashie⁠
• mruby-json⁠
• mruby-open3⁠
• mruby-shellwords⁠
• mruby-tempfile⁠
• mruby-uri⁠
• mruby-yaml⁠

⁠Supported platforms

• See Releases⁠ for supported architectures.
• All operating systems supported by Serverspec⁠ are supported since they share their underlying library, Specinfra⁠.
  • See CHANGELOG⁠ or mruby-specinfra⁠ to find what Specinfra version is used.

⁠Running mitamae on servers

When you want to use mitamae on remote servers, you need to distribute a mitamae binary and recipes to the servers and run them remotely. There are at least the following ways to do it:

• rsync and ssh - It's handy to send them using rsync and run them using ssh when you apply recipes to a few servers. hocho⁠ is a convenient tool to do this. While it's over a SSH connection, it's much faster than other tools which establish a SSH connection for each operation like itamae ssh.
• deployment tool - A more scalable way is to install an agent to each server and notify the agents to fetch mitamae and recipes from an object storage and run them. Deployment tools like AWS CodeDeploy⁠ are useful to achieve them.

⁠Migrating from Chef

While the DSL is inspired by Chef, there are some differences you need to keep in mind when you migrate Chef recipes to mitamae recipes.

⁠Change Log

See CHANGELOG.md⁠.

⁠Contributing

Please refer to CONTRIBUTING.md⁠.

⁠License

MIT License⁠