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