github.com/zoomfoo/nomad@v0.8.5-0.20180907175415-f28fd3a1a056/README.md (about) 1 Nomad [](https://travis-ci.org/hashicorp/nomad) [](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 * **Operationally Simple**: Nomad runs as a single binary that can be 25 either a client or server, and is completely self contained. Nomad does 26 not require any external services for storage or coordination. This means 27 Nomad combines the features of a resource manager and scheduler in a single 28 system. 29 30 * **Multi-Datacenter and Multi-Region Aware**: Nomad is designed to be 31 a global-scale scheduler. Multiple datacenters can be managed as part 32 of a larger region, and jobs can be scheduled across datacenters if 33 requested. Multiple regions join together and federate jobs making it 34 easy to run jobs anywhere. 35 36 * **Flexible Workloads**: Nomad has extensible support for task drivers, allowing it to run 37 containerized, virtualized, and standalone applications. Users can easily start Docker 38 containers, VMs, or application runtimes like Java. Nomad supports Linux, Windows, BSD, and OSX, 39 providing the flexibility to run any workload. 40 41 * **Built for Scale**: Nomad was designed from the ground up to support global scale 42 infrastructure. Nomad is distributed and highly available, using both 43 leader election and state replication to provide availability in the face 44 of failures. Nomad is optimistically concurrent, enabling all servers to participate 45 in scheduling decisions which increases the total throughput and reduces latency 46 to support demanding workloads. Nomad has been proven to scale to cluster sizes that 47 exceed 10k nodes in real-world production environments. 48 49 * **HashiCorp Ecosystem**: HashiCorp Ecosystem: Nomad integrates with the 50 entire HashiCorp ecosystem of tools. Like all HashiCorp tools, Nomad follows 51 the UNIX design philosophy of doing something specific and doing it well. 52 Nomad integrates with Terraform, Consul, and Vault for provisioning, service 53 discovery, and secrets management. 54 55 For more information, see the [introduction section](https://www.nomadproject.io/intro) 56 of the Nomad website. 57 58 Getting Started & Documentation 59 ------------------------------- 60 61 All documentation is available on the [Nomad website](https://www.nomadproject.io). 62 63 Developing Nomad 64 -------------------- 65 66 If you wish to work on Nomad itself or any of its built-in systems, 67 you will first need [Go](https://www.golang.org) installed on your 68 machine (version 1.10.2+ is *required*). 69 70 **Developing with Vagrant** 71 There is an included Vagrantfile that can help bootstrap the process. The 72 created virtual machine is based off of Ubuntu 16, and installs several of the 73 base libraries that can be used by Nomad. 74 75 To use this virtual machine, checkout Nomad and run `vagrant up` from the root 76 of the repository: 77 78 ```sh 79 $ git clone https://github.com/hashicorp/nomad.git 80 $ cd nomad 81 $ vagrant up 82 ``` 83 84 The virtual machine will launch, and a provisioning script will install the 85 needed dependencies. 86 87 **Developing locally** 88 For local dev first make sure Go is properly installed, including setting up a 89 [GOPATH](https://golang.org/doc/code.html#GOPATH). After setting up Go, clone this 90 repository into `$GOPATH/src/github.com/hashicorp/nomad`. Then you can 91 download the required build tools such as vet, cover, godep etc by bootstrapping 92 your environment. 93 94 ```sh 95 $ make bootstrap 96 ... 97 ``` 98 99 Afterwards type `make test`. This will run the tests. If this exits with exit status 0, 100 then everything is working! 101 102 ```sh 103 $ make test 104 ... 105 ``` 106 107 To compile a development version of Nomad, run `make dev`. This will put the 108 Nomad binary in the `bin` and `$GOPATH/bin` folders: 109 110 ```sh 111 $ make dev 112 ``` 113 114 Optionally run Consul to enable service discovery and health checks: 115 116 ```sh 117 $ sudo consul agent -dev 118 ``` 119 120 And finally start the nomad agent: 121 122 ```sh 123 $ sudo bin/nomad agent -dev 124 ``` 125 126 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. 127 128 ```sh 129 $ make dev-ui 130 ... 131 $ bin/nomad 132 ... 133 134 To compile protobuf files, installing protoc is required: See 135 https://github.com/google/protobuf for more information. 136 ``` 137 138 **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. 139 140 To cross-compile Nomad, run `make release`. This will compile Nomad for multiple 141 platforms and place the resulting binaries into the `./pkg` directory: 142 143 ```sh 144 $ make release 145 ... 146 $ ls ./pkg 147 ... 148 ```