github.com/ferranbt/nomad@v0.9.3-0.20190607002617-85c449b7667c/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 <p align="center" style="text-align:center;"> 5 <img src="https://cdn.rawgit.com/hashicorp/nomad/master/website/source/assets/images/logo-text.svg" width="500" /> 6 </p> 7 8 Overview 9 ------------------------------- 10 11 Nomad is an easy-to-use, flexible, and performant workload orchestrator that deploys: 12 13 * [Containers](https://www.nomadproject.io/docs/drivers/docker.html) 14 * [Legacy applications](https://www.nomadproject.io/docs/drivers/exec.html) 15 * [Virtual machines](https://www.nomadproject.io/docs/drivers/qemu.html) 16 17 Nomad enables developers to use declarative infrastructure-as-code for deploying their applications (jobs). Nomad uses bin packing to efficiently schedule jobs and optimize for resource utilization. Nomad is supported on macOS, Windows, and Linux. 18 19 Nomad is widely adopted and used in production by PagerDuty, Target, Citadel, Trivago, SAP, Pandora, Roblox, eBay, Deluxe Entertainment, and more. 20 21 * **Deploy Containers and Legacy Applications**: Nomad’s flexibility as an orchestrator enables an organization to run containers, legacy, and batch applications together on the same infrastructure. Nomad brings core orchestration benefits to legacy applications without needing to containerize via pluggable task drivers. 22 23 * **Simple & Reliable**: Nomad runs as a single 75MB binary and is entirely self contained - combining resource management and scheduling into a single system. Nomad does not require any external services for storage or coordination. Nomad automatically handles application, node, and driver failures. Nomad is distributed and resilient, using leader election and state replication to provide high availability in the event of failures. 24 25 * **Device Plugins & GPU Support**: Nomad offers built-in support for GPU workloads such as machine learning (ML) and artificial intelligence (AI). Nomad uses device plugins to automatically detect and utilize resources from hardware devices such as GPU, FPGAs, and TPUs. 26 27 * **Federation for Multi-Region, Multi-Cloud**: Nomad was designed to support infrastructure at a global scale. Nomad supports federation out-of-the-box and can deploy jobs across multiple regions and clouds. 28 29 * **Proven Scalability**: Nomad is optimistically concurrent, which increases throughput and reduces latency for workloads. Nomad has been proven to scale to clusters of 10K+ nodes in real-world production environments. 30 31 * **HashiCorp Ecosystem**: Nomad integrates seamlessly with Terraform, Consul, Vault for provisioning, service discovery, and secrets management. 32 33 Getting Started 34 ------------------------------- 35 36 Get started with Nomad quickly in a sandbox environment on the public cloud or on your computer. 37 38 * Local 39 * [Via Vagrant](https://www.nomadproject.io/intro/getting-started/install.html) 40 * AWS 41 * [Via Terraform](https://github.com/hashicorp/nomad/tree/master/terraform/aws) 42 * Azure 43 * [Via Terraform](https://github.com/hashicorp/nomad/tree/master/terraform/azure) 44 45 These methods are not meant for production. 46 47 Documentation & Guides 48 ------------------------------- 49 50 * [Installing Nomad for Production](https://www.nomadproject.io/guides/operations/deployment-guide.html) 51 * [Advanced Job Scheduling on Nomad with Affinities](https://www.nomadproject.io/guides/advanced-scheduling/affinity.html) 52 * [Increasing Nomad Fault Tolerance with Spread](https://www.nomadproject.io/guides/advanced-scheduling/spread.html) 53 * [Load Balancing on Nomad with Fabio & Consul](https://www.nomadproject.io/guides/load-balancing/fabio.html) 54 * [Deploying Stateful Workloads via Portworx](https://www.nomadproject.io/guides/stateful-workloads/portworx.html) 55 * [Running Apache Spark on Nomad](https://www.nomadproject.io/guides/spark/spark.html) 56 * [Integrating Vault with Nomad for Secrets Management](https://www.nomadproject.io/guides/operations/vault-integration/index.html) 57 * [Securing Nomad with TLS](https://www.nomadproject.io/guides/security/securing-nomad.html) 58 * [Continuous Deployment with Nomad and Terraform](https://www.hashicorp.com/blog/continuous-deployment-with-nomad-and-terraform) 59 * [Auto-bootstrapping a Nomad Cluster](https://www.hashicorp.com/blog/auto-bootstrapping-a-nomad-cluster) 60 61 Documentation is available on the Nomad website [here](https://www.nomadproject.io/docs/index.html). 62 63 Resources 64 ------------------------------- 65 66 * Website 67 * [www.nomadproject.io](https://www.nomadproject.io) 68 * Mailing List 69 * [Google Groups](https://groups.google.com/group/nomad-tool) 70 * Gitter 71 * [Nomad Chat Room](https://gitter.im/hashicorp-nomad/Lobby) 72 * Webinars 73 * [Running Microservices with Nomad](https://www.hashicorp.com/resources/solutions-engineering-hangout-microservices-with-nomad) 74 * [Running Heterogeneous Apps on Nomad](https://www.hashicorp.com/resources/se-hangout-running-heterogeneous-apps-nomad) 75 * [Supporting Multiple Teams on a Single Nomad Cluster](https://www.hashicorp.com/resources/supporting-multiple-teams-single-nomad-cluster) 76 * [Moving Your Legacy VMWare Workloads to Nomad](https://www.hashicorp.com/resources/move-your-vmware-workloads-nomad) 77 * [Machine Learning Workflows with HashiCorp Nomad & Apache Spark](https://www.hashicorp.com/resources/machine-learning-workflows-hashicorp-nomad-apache-spark) 78 * Community Calls 79 * [04/03/2019 with Pandora & Q2EBanking](https://www.youtube.com/watch?v=OsZeKTP2u98&t=2s) 80 * [05/24/2018 with SAP Ariba](https://www.youtube.com/watch?v=eSwZwVVTDqw&t=2660s) 81 82 Who Uses Nomad 83 -------------------- 84 * CircleCI 85 * [How CircleCI Processes 4.5 Million Builds Per Month](https://stackshare.io/circleci/how-circleci-processes-4-5-million-builds-per-month) 86 * [Security & Scheduling are Not Your Core Competencies](https://www.hashicorp.com/resources/nomad-vault-circleci-security-scheduling) 87 * Citadel 88 * [End-to-End Production Nomad at Citadel](https://www.hashicorp.com/resources/end-to-end-production-nomad-citadel) 89 * [Extreme Scaling with HashiCorp Nomad & Consul](https://www.hashicorp.com/resources/citadel-scaling-hashicorp-nomad-consul) 90 * Deluxe Entertainment 91 * [How Deluxe Uses the Complete HashiStack for Video Production](https://www.hashicorp.com/resources/deluxe-hashistack-video-production) 92 * Jet.com (Walmart) 93 * [Driving down costs at Jet.com with HashiCorp Nomad](https://www.hashicorp.com/resources/jet-walmart-hashicorp-nomad-azure-run-apps) 94 * PagerDuty 95 * [PagerDuty’s Nomadic Journey](https://www.hashicorp.com/resources/pagerduty-nomad-journey) 96 * Pandora 97 * [How Pandora Uses Nomad](https://www.youtube.com/watch?v=OsZeKTP2u98&t=2s) 98 * SAP Ariba 99 * [HashiCorp Nomad @ SAP Ariba](https://www.hashicorp.com/resources/nomad-community-call-core-team-sap-ariba) 100 * SeatGeek 101 * [Nomad Helper Tools](https://github.com/seatgeek/nomad-helper) 102 * Spaceflight Industries 103 * [Spaceflight’s Hub-And-Spoke Infrastructure](https://www.hashicorp.com/blog/spaceflight-uses-hashicorp-consul-for-service-discovery-and-real-time-updates-to-their-hub-and-spoke-network-architecture) 104 * SpotInst 105 * [SpotInst and HashiCorp Nomad to Reduce EC2 Costs for Users](https://www.hashicorp.com/blog/spotinst-and-hashicorp-nomad-to-reduce-ec2-costs-fo) 106 * Target 107 * [Nomad at Target: Scaling Microservices Across Public and Private Clouds](https://www.hashicorp.com/resources/nomad-scaling-target-microservices-across-cloud) 108 * [Playing with Nomad from HashiCorp](https://danielparker.me/nomad/hashicorp/schedulers/nomad/) 109 * Trivago 110 * [Maybe You Don’t Need Kubernetes](https://matthias-endler.de/2019/maybe-you-dont-need-kubernetes/) 111 * [Nomad - Our Experiences and Best Practices](https://tech.trivago.com/2019/01/25/nomad-our-experiences-and-best-practices/) 112 * Roblox 113 * [How Roblox runs a platform for 70 million gamers on HashiCorp Nomad](https://portworx.com/architects-corner-roblox-runs-platform-70-million-gamers-hashicorp-nomad/) 114 * Oscar Health 115 * [Scalable CI at Oscar Health with Nomad and Docker](https://www.hashicorp.com/resources/scalable-ci-oscar-health-insurance-nomad-docker) 116 * eBay 117 * [HashiStack at eBay: A Fully Containerized Platform Based on Infrastructure as Code](https://www.hashicorp.com/resources/ebay-hashistack-fully-containerized-platform-iac) 118 * Joyent 119 * [Build Your Own Autoscaling Feature with HashiCorp Nomad](https://www.hashicorp.com/resources/autoscaling-hashicorp-nomad) 120 * Dutch National Police 121 * [Going Cloud-Native at the Dutch National Police](https://www.hashicorp.com/resources/going-cloud-native-at-the-dutch-national-police) 122 * N26 123 * [Tech at N26 - The Bank in the Cloud](https://medium.com/insiden26/tech-at-n26-the-bank-in-the-cloud-e5ff818b528b) 124 * Elsevier 125 * [Eslevier’s Container Framework with Nomad, Terraform, and Consul](https://www.hashicorp.com/resources/elsevier-nomad-container-framework-demo) 126 * Palantir 127 * [Enterprise Security at Palantir with the HashiCorp stack](https://www.hashicorp.com/resources/enterprise-security-hashicorp-stack) 128 * Graymeta 129 * [Backend Batch Processing At Scale with Nomad](https://www.hashicorp.com/resources/backend-batch-processing-nomad) 130 * NIH NCBI 131 * [NCBI’s Legacy Migration to Hybrid Cloud with Consul & Nomad](https://www.hashicorp.com/resources/ncbi-legacy-migration-hybrid-cloud-consul-nomad) 132 * Q2Ebanking 133 * [Q2’s Nomad Use and Overview](https://www.youtube.com/watch?v=OsZeKTP2u98&feature=youtu.be&t=1499) 134 * imgix 135 * [Cluster Schedulers & Why We Chose Nomad Over Kubernetes](https://medium.com/@copyconstruct/schedulers-kubernetes-and-nomad-b0f2e14a896) 136 * Region Syddanmark 137 138 ...and more! 139 140 Contributing to Nomad 141 -------------------- 142 143 If you wish to contribute to Nomad, you will need [Go](https://www.golang.org) installed on your machine (version 1.10.2+ is *required*). 144 145 **Developing with Vagrant** 146 There is an included Vagrantfile that can help bootstrap the process. The 147 created virtual machine is based off of Ubuntu 16, and installs several of the 148 base libraries that can be used by Nomad. 149 150 To use this virtual machine, checkout Nomad and run `vagrant up` from the root 151 of the repository: 152 153 ```sh 154 $ git clone https://github.com/hashicorp/nomad.git 155 $ cd nomad 156 $ vagrant up 157 ``` 158 159 The virtual machine will launch, and a provisioning script will install the 160 needed dependencies. 161 162 **Developing locally** 163 For local dev first make sure Go is properly installed, including setting up a 164 [GOPATH](https://golang.org/doc/code.html#GOPATH). After setting up Go, clone this 165 repository into `$GOPATH/src/github.com/hashicorp/nomad`. Then you can 166 download the required build tools such as vet, cover, godep etc by bootstrapping 167 your environment. 168 169 ```sh 170 $ make bootstrap 171 ... 172 ``` 173 174 Afterwards type `make test`. This will run the tests. If this exits with exit status 0, 175 then everything is working! 176 177 ```sh 178 $ make test 179 ... 180 ``` 181 182 To compile a development version of Nomad, run `make dev`. This will put the 183 Nomad binary in the `bin` and `$GOPATH/bin` folders: 184 185 ```sh 186 $ make dev 187 ``` 188 189 Optionally run Consul to enable service discovery and health checks: 190 191 ```sh 192 $ sudo consul agent -dev 193 ``` 194 195 And finally start the nomad agent: 196 197 ```sh 198 $ sudo bin/nomad agent -dev 199 ``` 200 201 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. 202 203 ```sh 204 $ make dev-ui 205 ... 206 $ bin/nomad 207 ... 208 209 To compile protobuf files, installing protoc is required: See 210 https://github.com/google/protobuf for more information. 211 ``` 212 213 **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. 214 215 To cross-compile Nomad, run `make prerelease` and `make release`. 216 This will generate all the static assets, compile Nomad for multiple 217 platforms and place the resulting binaries into the `./pkg` directory: 218 219 ```sh 220 $ make prerelease 221 $ make release 222 ... 223 $ ls ./pkg 224 ... 225 ```