henchman

command module
v0.0.0-...-916d208 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 8, 2015 License: BSD-2-Clause Imports: 7 Imported by: 0

README

henchman Build Status

What is Henchman

Henchman is a non-agent based orchestration and automation tool created in Go, and inspired by Ansible.

Why Go?

Although, python and ruby are awesome as systems languages, Golang fits this 'get shit done' niche more. Dependencies is generally an issue in ruby/python where users have to install and maintain gems/pip modules. With Go there are no dependencies to install, and a single binary file and can shipped and ready to use. In addition, Go has built in concurrency constructs, and a specific way to do things.

Setup

  • Install go here
  • Clone this repo to $GOPATH/src/github.com/apigee
  • If you have not done so, set export $PATH=$PATH:$GOPATH/bin
  • go get github.com/tools/godep
  • godep restore
  • go build -o hench

How Henchman Works

Henchman executes a plan (a collection of tasks) on a given set of machines. Each plan will run the list of tasks by SSHing into a machine, and generally copy over the module specified by the task and execute it.

Plan

A plan is a collection of tasks written in YAML notation.

Insert a fat Plan example here with all features Insert pratical use case here

Hosts

Explain features of hosts section. Include Examples

Vars

Explain all aspects and features of Vars here. Include Examples

Tasks

Explain all features of tasks. Include Examples

Inventories

How to Use

CLI commands insert here.

If you are using Vagrant to spin up vms ./hench exec plan.yml --inventory inv.yaml --user vagrant --keyfile < >

Modules

Contributing

Just clone or fork from https://github.com/apigee/henchman and off you go! Or you can help by creating more modules. Look at the modules section for more details.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
Godeps
_workspace/src/github.com/flosch/pongo2
A Django-syntax like template-engine Blog posts about pongo2 (including introduction and migration): https://www.florian-schlachter.de/?tag=pongo2 Complete documentation on the template language: https://docs.djangoproject.com/en/dev/topics/templates/ Try out pongo2 live in the pongo2 playground: https://www.florian-schlachter.de/pongo2/ Make sure to read README.md in the repository as well.
A Django-syntax like template-engine Blog posts about pongo2 (including introduction and migration): https://www.florian-schlachter.de/?tag=pongo2 Complete documentation on the template language: https://docs.djangoproject.com/en/dev/topics/templates/ Try out pongo2 live in the pongo2 playground: https://www.florian-schlachter.de/pongo2/ Make sure to read README.md in the repository as well.
_workspace/src/github.com/stretchr/testify/assert
Package assert provides a set of comprehensive testing tools for use with the normal Go testing system.
Package assert provides a set of comprehensive testing tools for use with the normal Go testing system.
_workspace/src/github.com/stretchr/testify/require
Alternative testing tools which stop test execution if test failed.
Alternative testing tools which stop test execution if test failed.
_workspace/src/gopkg.in/yaml.v2
Package yaml implements YAML support for the Go language.
Package yaml implements YAML support for the Go language.
Godeps/_workspace/src/github.com/stretchr/testify/assert
Package assert provides a set of comprehensive testing tools for use with the normal Go testing system.
Package assert provides a set of comprehensive testing tools for use with the normal Go testing system.
Godeps/_workspace/src/github.com/stretchr/testify/require
Alternative testing tools which stop test execution if test failed.
Alternative testing tools which stop test execution if test failed.
Godeps/_workspace/src/gopkg.in/yaml.v2
Package yaml implements YAML support for the Go language.
Package yaml implements YAML support for the Go language.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL