Skip to content

Latest commit

 

History

History
54 lines (38 loc) · 1.5 KB

installation.md

File metadata and controls

54 lines (38 loc) · 1.5 KB

Installation

In order to build Gru you need Go version 1.7 or later.

Building Gru is as easy as executing the commands below.

$ git clone https://github.com/dnaeon/gru
$ cd gru
$ make

Optional requirements

The optional requirements listed below are needed if you need to orchestrate remote systems. They are not required if you use Gru in stand-alone mode.

etcd is used for discovery of minions and communication between the minions and clients, so in order to orchestrate remote minions you need to make sure that you have etcd up and running, so that remote minions can connect to it.

For more information about installing and configuring etcd, please refer to the official etcd documentation.

Git is used for syncing code and data files to the remote minions, so make sure that you have Git installed as well.

Shell Completion

You can enable shell autocompletion by sourcing the correct file from the contrib/autocomplete directory for your shell.

For instance to enable bash autocompletion on an Arch Linux system, you would do.

$ sudo cp contrib/autocomplete/bash_autocomplete /usr/share/bash-completion/completions/gructl

Note that you will need to install the bash-completion package, if you don't have it installed already.

Tests

You can run the tests by executing the command below.

$ make test