sorah / hocho

Hocho: Run Itamae easily with host inventory

Hocho: an itamae wrapper

Hocho is a wrapper of the provisioning tool itamae.

Features

• Drivers
  • itamae ssh support
  • remote itamae local support on rsync+bundler
  • remote mitamae support
• Simple pluggable host inventory, discovery

Installation

Add this line to your application's Gemfile:

gem 'hocho'

And then execute:

$ bundle

Or install it yourself as:

$ gem install hocho

Usage

# hocho.yml
inventory_providers:
  file:
    path: './hosts'

property_providers:
  ## Provide default values to host properties (reverse_merge).
  - add_default:
      properties:
        blah: blahblah
        # preferred_driver: mitamae
        attributes:
          node_attributes_goes_here: hello

  ## Run ruby script to mutate host properties
  - ruby_script:
      name: name-for-your-convenience # optional
      script: 'host.properties[:hello] = Time.now.xmlschema'
    ## or 
    # file: path/to/script.rb

# driver_options:
#   mitamae:
#     mitamae_prepare_script: 'wget -O /usr/local/bin/mitamae https://...'

# ./hosts/test.yml
test.example.org:
  # ssh_options:
  #   user: ...
  properties:
    # preferred_driver: bundler
    # preferred_driver: mitamae
    attributes:
      node_attributes_goes_here: hello
    run_list:
      - roles/app/default.rb

$ hocho list
$ hocho show test.example.org
$ hocho apply test.example.org

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hocho.

License

The gem is available as open source under the terms of the MIT License.

hocho's Issues

HOWTO: shared attributes

I have an itamae project configuring a set of similar machines. They share some attributes, so I'm using two yml files per host: one shared and one unique.

Now I'm trying to migrate to hocho. The problem I'm having is:

1. Hocho doesn't support --node-json or --node-yaml switches
2. Hocho (or rather Psych) doesn't parse yaml aliases, which doesn't allow moving shared attributes in a separate key to reuse for specific hosts

Is there some workaround for this issue? If no, I can create a pull request adding support for --node-yaml.

How to keep files for failed run?

In https://github.com/sorah/hocho/blob/master/lib/hocho/drivers/ssh_base.rb#L48 there's the check for keep_synced_files which is not defined anywhere. Looks like this feature didn't survive dec1dab and f4a4576. Though it would be great to have: sometimes debugging on an actual server is the only way to go.

If you are ok with such feature I'm willing to submit a PR.