github.com/hhrutter/nomad@v0.6.0-rc2.0.20170723054333-80c4b03f0705/README.md (about)

     1  Nomad [![Build Status](https://travis-ci.org/hashicorp/nomad.svg)](https://travis-ci.org/hashicorp/nomad) [![Join the chat at https://gitter.im/hashicorp-nomad/Lobby](https://badges.gitter.im/hashicorp-nomad/Lobby.svg)](https://gitter.im/hashicorp-nomad/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
     2  =========
     3  -	Website: https://www.nomadproject.io
     4  -	Mailing list: [Google Groups](https://groups.google.com/group/nomad-tool)
     5  
     6  <p align="center" style="text-align:center;">
     7    <img src="https://cdn.rawgit.com/hashicorp/nomad/master/website/source/assets/images/logo-text.svg" width="500" />
     8  </p>
     9  
    10  Nomad is a cluster manager, designed for both long lived services and short
    11  lived batch processing workloads. Developers use a declarative job specification
    12  to submit work, and Nomad ensures constraints are satisfied and resource utilization
    13  is optimized by efficient task packing. Nomad supports all major operating systems
    14  and virtualized, containerized, or standalone applications.
    15  
    16  The key features of Nomad are:
    17  
    18  * **Docker Support**: Jobs can specify tasks which are Docker containers.
    19    Nomad will automatically run the containers on clients which have Docker
    20    installed, scale up and down based on the number of instances requested, and
    21    automatically recover from failures.
    22  
    23  * **Multi-Datacenter and Multi-Region Aware**: Nomad is designed to be
    24    a global-scale scheduler. Multiple datacenters can be managed as part
    25    of a larger region, and jobs can be scheduled across datacenters if
    26    requested. Multiple regions join together and federate jobs making it
    27    easy to run jobs anywhere.
    28  
    29  * **Operationally Simple**: Nomad runs as a single binary that can be
    30    either a client or server, and is completely self contained. Nomad does
    31    not require any external services for storage or coordination. This means
    32    Nomad combines the features of a resource manager and scheduler in a single
    33    system.
    34  
    35  * **Distributed and Highly-Available**: Nomad servers cluster together and
    36    perform leader election and state replication to provide high availability
    37    in the face of failure. The Nomad scheduling engine is optimized for
    38    optimistic concurrency allowing all servers to make scheduling decisions to
    39    maximize throughput.
    40  
    41  * **HashiCorp Ecosystem**: Nomad integrates with the entire HashiCorp
    42    ecosystem of tools. Along with all HashiCorp tools, Nomad is designed
    43    in the unix philosophy of doing something specific and doing it well.
    44    Nomad integrates with tools like Packer, Consul, and Terraform to support
    45    building artifacts, service discovery, monitoring and capacity management.
    46  
    47  For more information, see the [introduction section](https://www.nomadproject.io/intro)
    48  of the Nomad website.
    49  
    50  Getting Started & Documentation
    51  -------------------------------
    52  
    53  All documentation is available on the [Nomad website](https://www.nomadproject.io).
    54  
    55  Developing Nomad
    56  --------------------
    57  
    58  If you wish to work on Nomad itself or any of its built-in systems,
    59  you will first need [Go](https://www.golang.org) installed on your
    60  machine (version 1.8+ is *required*).
    61  
    62  **Developing with Vagrant**
    63  There is an included Vagrantfile that can help bootstrap the process. The
    64  created virtual machine is based off of Ubuntu 16, and installs several of the
    65  base libraries that can be used by Nomad.
    66  
    67  To use this virtual machine, checkout Nomad and run `vagrant up` from the root
    68  of the repository:
    69  
    70  ```sh
    71  $ git clone https://github.com/hashicorp/nomad.git
    72  $ cd nomad
    73  $ vagrant up
    74  ```
    75  
    76  The virtual machine will launch, and a provisioning script will install the
    77  needed dependencies.
    78  
    79  **Developing locally**
    80  For local dev first make sure Go is properly installed, including setting up a
    81  [GOPATH](https://golang.org/doc/code.html#GOPATH). After setting up Go, clone this 
    82  repository into `$GOPATH/src/github.com/hashicorp/nomad`. Then you can
    83  download the required build tools such as vet, cover, godep etc by bootstrapping
    84  your environment.
    85  
    86  ```sh
    87  $ make bootstrap
    88  ...
    89  ```
    90  
    91  Afterwards type `make test`. This will run the tests. If this exits with exit status 0,
    92  then everything is working!
    93  
    94  ```sh
    95  $ make test
    96  ...
    97  ```
    98  
    99  To compile a development version of Nomad, run `make dev`. This will put the
   100  Nomad binary in the `bin` and `$GOPATH/bin` folders:
   101  
   102  ```sh
   103  $ make dev
   104  ...
   105  $ bin/nomad
   106  ...
   107  ```
   108  
   109  To cross-compile Nomad, run `make bin`. This will compile Nomad for multiple
   110  platforms and place the resulting binaries into the `./pkg` directory:
   111  
   112  ```sh
   113  $ make bin
   114  ...
   115  $ ls ./pkg
   116  ...
   117  ```