Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README: Align with Consul README #9681

Merged
merged 5 commits into from
Dec 18, 2020
Merged

README: Align with Consul README #9681

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8791619
README: Align with Consul README
Dec 18, 2020
55de39d
Small style fixes
Dec 18, 2020
9d35278
-Cluster
Dec 18, 2020
53e810b
Be consistent with Learn: quickstart links
Dec 18, 2020
8d4bd6e
Add link to homepage from image
Dec 18, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
198 changes: 23 additions & 175 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,23 @@
Nomad [![Build Status](https://circleci.com/gh/hashicorp/nomad.svg?style=svg)](https://circleci.com/gh/hashicorp/nomad) [![Discuss](https://img.shields.io/badge/discuss-nomad-00BC7F?style=flat)](https://discuss.hashicorp.com/c/nomad)
=========
===

<p align="center" style="text-align:center;">
<img src="https://github.com/hashicorp/nomad/blob/19c404ca791d6ebe95a81738d7dc6623ab28564d/website/public/img/logo-hashicorp.svg" width="500" />
<a href="https://nomadproject.io">
<img alt="HashiCorp Nomad logo" src="website/public/img/logo-hashicorp.svg" width="500" />
</a>
</p>

Overview
-------------------------------
Nomad is a simple and flexible workload orchestrator to deploy and manage containers ([docker](https://www.nomadproject.io/docs/drivers/docker.html), [podman](https://www.nomadproject.io/docs/drivers/podman)), non-containerized applications ([executable](https://www.nomadproject.io/docs/drivers/exec.html), [Java](https://www.nomadproject.io/docs/drivers/java)), and virtual machines ([qemu](https://www.nomadproject.io/docs/drivers/qemu.html)) across on-prem and clouds at scale.

Nomad is an easy-to-use, flexible, and performant workload orchestrator that deploys:
Nomad is supported on Linux, Windows, and macOS. A commercial version of Nomad, [Nomad Enterprise](https://www.nomadproject.io/docs/enterprise), is also available.

* [Containers](https://www.nomadproject.io/docs/drivers/docker.html)
* [Non-containerized applications](https://www.nomadproject.io/docs/drivers/exec.html)
* [Virtual machines](https://www.nomadproject.io/docs/drivers/qemu.html)
* Website: https://nomadproject.io
* Tutorials: [HashiCorp Learn](https://learn.hashicorp.com/nomad)
* Forum: [Discuss](https://discuss.hashicorp.com/c/nomad)
* Mailing List: [Google Groups](https://groups.google.com/group/nomad-tool)
* Gitter: [hashicorp-nomad](https://gitter.im/hashicorp-nomad/Lobby)

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.

Nomad is widely adopted and used in production by PagerDuty, CloudFlare, Roblox, Pandora, and more.
Nomad provides several key features:

* **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.

Expand All @@ -30,176 +31,23 @@ Nomad is widely adopted and used in production by PagerDuty, CloudFlare, Roblox,

* **HashiCorp Ecosystem**: Nomad integrates seamlessly with Terraform, Consul, Vault for provisioning, service discovery, and secrets management.

Getting Started
-------------------------------

Get started with Nomad quickly in a sandbox environment on the public cloud or on your computer.

* Local
* [Via Vagrant](https://www.nomadproject.io/intro/getting-started/install.html)
* AWS
* [Via Terraform](https://github.com/hashicorp/nomad/tree/master/terraform/aws)
* Azure
* [Via Terraform](https://github.com/hashicorp/nomad/tree/master/terraform/azure)
* GCP
* [Via Terraform](https://github.com/hashicorp/nomad/tree/master/terraform/gcp)

These methods are not meant for production.
Quick Start
---

Documentation & Guides
-------------------------------
#### Testing
See [Learn: Getting Started](https://learn.hashicorp.com/collections/nomad/get-started) for instructions on setting up a local Nomad cluster for non-production use.

Documentation is available on the Nomad website [here](https://www.nomadproject.io/docs/index.html).
Guides are available on HashiCorp Learn website [here](https://learn.hashicorp.com/nomad).
Optionally, find Terraform manifests for bringing up a development Nomad cluster on a public cloud in the [`terraform`](terraform/) directory.

Resources
-------------------------------
#### Production
See [Learn: Nomad Reference Architecture](https://learn.hashicorp.com/tutorials/nomad/production-reference-architecture-vm-with-consul?in=nomad/production) for recommended practices and a reference architecture for production deployments.

* Website
* [www.nomadproject.io](https://www.nomadproject.io)
* Mailing List
* [Google Groups](https://groups.google.com/group/nomad-tool)
* Gitter
* [Nomad Chat Room](https://gitter.im/hashicorp-nomad/Lobby)
Documentation
---
Full, comprehensive documentation is available on the Nomad website: https://www.nomadproject.io/docs

Who Uses Nomad
--------------------
* Roblox
* [How Roblox built a platform for 100 million players with Nomad (2020)](https://www.hashicorp.com/case-studies/roblox/)
* [How Roblox runs a platform for 70 million gamers on Nomad (2019)](https://portworx.com/architects-corner-roblox-runs-platform-70-million-gamers-hashicorp-nomad/)
* Cloudflare
* [How We Use HashiCorp Nomad (2020)](https://blog.cloudflare.com/how-we-use-hashicorp-nomad/)
* BetterHelp
* [How the world's largest online therapy provider runs on Nomad (2020)](https://www.youtube.com/watch?v=eN2ghrGpiUo)
* Navi Capital
* [How Nomad powers a $1B hedge fund in Brazil (2020)](https://www.hashicorp.com/blog/nomad-community-story-navi-capital/)
* Trivago
* [Maybe You Don’t Need Kubernetes (2019)](https://endler.dev/2019/maybe-you-dont-need-kubernetes/)
* [Nomad - Our Experiences and Best Practices (2019)](https://tech.trivago.com/2019/01/25/nomad-our-experiences-and-best-practices/)
* Reaktor
* [Nomad: Kubernetes, but without the complexity (2019)](https://youtu.be/GkmyNBUugg8)
* Pandora
* [How Pandora Uses Nomad (2019)](https://www.youtube.com/watch?v=OsZeKTP2u98&t=2s)
* CircleCI
* [How CircleCI Processes 4.5 Million Builds Per Month (2019)](https://stackshare.io/circleci/how-circleci-processes-4-5-million-builds-per-month)
* [Security & Scheduling are Not Your Core Competencies (2018)](https://www.hashicorp.com/resources/nomad-vault-circleci-security-scheduling)
* Q2
* [Q2’s Nomad Use and Overview (2019)](https://www.youtube.com/watch?v=OsZeKTP2u98&feature=youtu.be&t=1499)
* Citadel
* [End-to-End Production Nomad at Citadel (2017)](https://www.hashicorp.com/resources/end-to-end-production-nomad-citadel)
* [Extreme Scaling with HashiCorp Nomad & Consul (2016)](https://www.hashicorp.com/resources/citadel-scaling-hashicorp-nomad-consul)
* Deluxe Entertainment
* [How Deluxe Uses the Complete HashiStack for Video Production (2018)](https://www.hashicorp.com/resources/deluxe-hashistack-video-production)
* Jet.com (Walmart)
* [Driving down costs at Jet.com with HashiCorp Nomad (2017)](https://www.hashicorp.com/resources/jet-walmart-hashicorp-nomad-azure-run-apps)
* PagerDuty
* [PagerDuty’s Nomadic Journey (2017)](https://www.hashicorp.com/resources/pagerduty-nomad-journey)
* SAP Ariba
* [HashiCorp Nomad @ SAP Ariba (2018)](https://www.hashicorp.com/resources/nomad-community-call-core-team-sap-ariba)
* Target
* [Nomad at Target: Scaling Microservices Across Public and Private Clouds (2018)](https://www.hashicorp.com/resources/nomad-scaling-target-microservices-across-cloud)
* [Playing with Nomad from HashiCorp (2017)](https://danielparker.me/nomad/hashicorp/schedulers/nomad/)
* Oscar Health
* [Scalable CI at Oscar Health with Nomad and Docker (2018)](https://www.hashicorp.com/resources/scalable-ci-oscar-health-insurance-nomad-docker)
* eBay
* [HashiStack at eBay: A Fully Containerized Platform Based on Infrastructure as Code (2018)](https://www.hashicorp.com/resources/ebay-hashistack-fully-containerized-platform-iac)
* Dutch National Police
* [Going Cloud-Native at the Dutch National Police (2018)](https://www.hashicorp.com/resources/going-cloud-native-at-the-dutch-national-police)
* N26
* [Tech at N26 - The Bank in the Cloud (2018)](https://medium.com/insiden26/tech-at-n26-the-bank-in-the-cloud-e5ff818b528b)
* Elsevier
* [Eslevier’s Container Framework with Nomad, Terraform, and Consul (2017)](https://www.hashicorp.com/resources/elsevier-nomad-container-framework-demo)
* Graymeta
* [Backend Batch Processing At Scale with Nomad (2017)](https://www.hashicorp.com/resources/backend-batch-processing-nomad)
* NIH NCBI
* [NCBI’s Legacy Migration to Hybrid Cloud with Consul & Nomad (2018)](https://www.hashicorp.com/resources/ncbi-legacy-migration-hybrid-cloud-consul-nomad)
* imgix
* [Cluster Schedulers & Why We Chose Nomad Over Kubernetes (2017)](https://medium.com/@copyconstruct/schedulers-kubernetes-and-nomad-b0f2e14a896)

...and more!
Guides are available on [HashiCorp Learn](https://learn.hashicorp.com/nomad).

Contributing
--------------------
See the [`contributing`](contributing/) directory for more developer documentation.

### Developing with Vagrant
A development environment is supplied via Vagrant to make getting started easier.

1. Install [Vagrant](https://www.vagrantup.com/docs/installation)
1. Install [Virtualbox](https://www.virtualbox.org/)
1. Bring up the Vagrant project
```sh
$ git clone https://github.com/hashicorp/nomad.git
$ cd nomad
$ vagrant up
```

The virtual machine will launch, and a provisioning script will install the
needed dependencies within the VM.

### Developing without Vagrant
1. Install [Go 1.15.5+](https://golang.org/) *(Note: `gcc-go` is not supported)*
1. Clone this repo
```sh
$ git clone https://github.com/hashicorp/nomad.git
$ cd nomad
```
1. Bootstrap your environment
```sh
$ make bootstrap
```
1. (Optionally) Set a higher ulimit, as Nomad creates many file handles during normal operations
```sh
$ [ "$(ulimit -n)" -lt 1024 ] && ulimit -n 1024
```
1. Verify you can run tests
```sh
$ make test
```

### Running a development build

1. Compile a development binary (see the [UI README](https://github.com/hashicorp/nomad/blob/master/ui/README.md) to include the web UI in the binary)
```sh
$ make dev
# find the built binary at ./bin/nomad
```
1. Start the agent in dev mode
```sh
$ sudo bin/nomad agent -dev
```
1. (Optionally) Run Consul to enable service discovery and health checks
1. Download [Consul](https://www.consul.io/downloads)
1. Start Consul in dev mode
```sh
$ consul agent -dev
```

### Compiling Protobufs
If in the course of your development you change a Protobuf file (those ending in .proto), you'll need to recompile the protos.

1. Install [Buf](https://docs.buf.build/installation)
1. Compile Protobufs
```sh
$ make proto
```

### Building the Web UI
See the [UI README](https://github.com/hashicorp/nomad/blob/master/ui/README.md) for instructions.

### Create a release binary
To create a release binary:

```sh
$ make prerelease
$ make release
$ ls ./pkg
```

This will generate all the static assets, compile Nomad for multiple
platforms and place the resulting binaries into the `./pkg` directory.

API Compatibility
--------------------

Only the `api/` and `plugins/` packages are intended to be imported by other projects. The root Nomad module does not follow semver and is not intended to be imported directly by other projects.
100 changes: 97 additions & 3 deletions contributing/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,103 @@
# Nomad Codebase Documentation
Nomad Codebase Documentation
===

This directory contains some documentation about the Nomad codebase,
aimed at readers who are interested in making code contributions.

If you're looking for information on _using_ Nomad, please instead refer
to the [Nomad website](https://nomadproject.io).

Developing with Vagrant
---
A development environment is supplied via Vagrant to make getting started easier.

1. Install [Vagrant](https://www.vagrantup.com/docs/installation)
1. Install [Virtualbox](https://www.virtualbox.org/)
1. Bring up the Vagrant project
```sh
$ git clone https://github.com/hashicorp/nomad.git
$ cd nomad
$ vagrant up
```

The virtual machine will launch, and a provisioning script will install the
needed dependencies within the VM.

1. SSH into the VM
```sh
$ vagrant ssh
```

Developing without Vagrant
---
1. Install [Go 1.15.5+](https://golang.org/) *(Note: `gcc-go` is not supported)*
1. Clone this repo
```sh
$ git clone https://github.com/hashicorp/nomad.git
$ cd nomad
```
1. Bootstrap your environment
```sh
$ make bootstrap
```
1. (Optionally) Set a higher ulimit, as Nomad creates many file handles during normal operations
```sh
$ [ "$(ulimit -n)" -lt 1024 ] && ulimit -n 1024
```
1. Verify you can run tests
```sh
$ make test
```

Running a development build
---
1. Compile a development binary (see the [UI README](https://github.com/hashicorp/nomad/blob/master/ui/README.md) to include the web UI in the binary)
```sh
$ make dev
# find the built binary at ./bin/nomad
```
1. Start the agent in dev mode
```sh
$ sudo bin/nomad agent -dev
```
1. (Optionally) Run Consul to enable service discovery and health checks
1. Download [Consul](https://www.consul.io/downloads)
1. Start Consul in dev mode
```sh
$ consul agent -dev
```

Compiling Protobufs
---
If in the course of your development you change a Protobuf file (those ending in .proto), you'll need to recompile the protos.

1. Install [Buf](https://docs.buf.build/installation)
1. Compile Protobufs
```sh
$ make proto
```

Building the Web UI
---
See the [UI README](https://github.com/hashicorp/nomad/blob/master/ui/README.md) for instructions.

Create a release binary
---
To create a release binary:

```sh
$ make prerelease
$ make release
$ ls ./pkg
```

This will generate all the static assets, compile Nomad for multiple
platforms and place the resulting binaries into the `./pkg` directory.

API Compatibility
--------------------
Only the `api/` and `plugins/` packages are intended to be imported by other projects. The root Nomad module does not follow semver and is not intended to be imported directly by other projects.

## Architecture

The code for Nomad's major components is organized as:
Expand All @@ -27,7 +119,8 @@ Client -> HTTP API -> RPC -> StateStore
Client -> HTTP API -> RPC -> Raft -> FSM -> StateStore
```

## Checklists
Checklists
---

When adding new features to Nomad there are often many places to make changes.
It is difficult to determine where changes must be made and easy to make
Expand All @@ -40,6 +133,7 @@ developers and reviewers confidence that the proper changes have been made:
* [New CLI command](checklist-command.md)
* [New RPC endpoint](checklist-rpc-endpoint.md)

## Tooling
Tooling
---

* [Go tool versions](golang.md)