mirror of
https://github.com/kemko/nomad.git
synced 2026-01-05 01:45:44 +03:00
53b083b8c5
* Move commands from docs to its own root-level directory * temporarily use modified dev-portal branch with nomad ia changes * explicitly clone nomad ia exp branch * retrigger build, fixed dev-portal broken build * architecture, concepts and get started individual pages * fix get started section destinations * reference section * update repo comment in website-build.sh to show branch * docs nav file update capitalization * update capitalization to force deploy * remove nomad-vs-kubernetes dir; move content to what is nomad pg * job section * Nomad operations category, deploy section * operations category, govern section * operations - manage * operations/scale; concepts scheduling fix * networking * monitor * secure section * remote auth-methods folder and move up pages to sso; linkcheck * Fix install2deploy redirects * fix architecture redirects * Job section: Add missing section index pages * Add section index pages so breadcrumbs build correctly * concepts/index fix front matter indentation * move task driver plugin config to new deploy section * Finish adding full URL to tutorials links in nav * change SSO to Authentication in nav and file system * Docs NomadIA: Move tutorials into NomadIA branch (#26132) * Move governance and policy from tutorials to docs * Move tutorials content to job-declare section * run jobs section * stateful workloads * advanced job scheduling * deploy section * manage section * monitor section * secure/acl and secure/authorization * fix example that contains an unseal key in real format * remove images from sso-vault * secure/traffic * secure/workload-identities * vault-acl change unseal key and root token in command output sample * remove lines from sample output * fix front matter * move nomad pack tutorials to tools * search/replace /nomad/tutorials links * update acl overview with content from deleted architecture/acl * fix spelling mistake * linkcheck - fix broken links * fix link to Nomad variables tutorial * fix link to Prometheus tutorial * move who uses Nomad to use cases page; move spec/config shortcuts add dividers * Move Consul out of Integrations; move namespaces to govern * move integrations/vault to secure/vault; delete integrations * move ref arch to docs; rename Deploy Nomad back to Install Nomad * address feedback * linkcheck fixes * Fixed raw_exec redirect * add info from /nomad/tutorials/manage-jobs/jobs * update page content with newer tutorial * link updates for architecture sub-folders * Add redirects for removed section index pages. Fix links. * fix broken links from linkcheck * Revert to use dev-portal main branch instead of nomadIA branch * build workaround: add intro-nav-data.json with single entry * fix content-check error * add intro directory to get around Vercel build error * workound for emtpry directory * remove mdx from /intro/ to fix content-check and git snafu * Add intro index.mdx so Vercel build should work --------- Co-authored-by: Tu Nguyen <im2nguyen@gmail.com>
84 lines
3.5 KiB
Plaintext
84 lines
3.5 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: Nomad quickstart
|
|
description: |-
|
|
The Nomad quickstart page contains links to resources that show you how to get started using Nomad locally or in a cloud environment.
|
|
---
|
|
|
|
# Nomad quickstart
|
|
|
|
These installations are designed to get you started with Nomad and should
|
|
be used only for experimentation purposes. If you are looking to install Nomad
|
|
in production, refer to the [Production Installation
|
|
guide](/nomad/docs/deploy/production).
|
|
|
|
## Nomad tutorials
|
|
|
|
We recommend these tutorials, which provision a Nomad cluster for you.
|
|
|
|
- [Get Started][]: Get up and running with Nomad by learning about scheduling,
|
|
setting up a cluster, and deploying an example job. Create a Nomad cluster
|
|
on your local machine or in an AWS, Azure, or Google Cloud Platform (GCP)
|
|
cloud environment. This tutorial series has an associated code repository so
|
|
you can review the Terraform provisioning scripts and Nomad job specifications.
|
|
- [Cluster Setup][]: Provision a Nomad cluster on AWS, Azure, or GCP. Enable
|
|
Consul and access control lists (ACLs). This tutorial series has an associated
|
|
code repository so you can review the Terraform provisioning scripts.
|
|
- [Enable gossip encryption for Nomad][interactive]: Launch an interactive lab
|
|
to use Nomad in your browser.
|
|
|
|
## Cloud installation
|
|
|
|
The Nomad repository contains guides and Terraform scripts for provisioning a
|
|
Nomad sandbox environment on AWS, Azure, or GCP with Consul and Vault. You can
|
|
explore Nomad and its integrations with the HashiCorp stack.
|
|
|
|
- [Provision a Nomad cluster on AWS][]
|
|
- [Provision a Nomad cluster on Azure][]
|
|
- [Provision a Nomad cluster on GCP][]
|
|
|
|
## Local installation
|
|
|
|
Use one of the following methods to run a local Nomad sandbox environment:
|
|
|
|
- Install a binary
|
|
|
|
Refer to the [Install Nomad guide][installing-binary] to install the latest
|
|
Nomad release binary.
|
|
|
|
Run Nomad with the `sudo nomad agent -dev` [command][agent-dev], which
|
|
starts the Nomad agent in development mode.
|
|
|
|
If you are using Docker Desktop for Windows or MacOS, refer to [How to connect
|
|
to my host network when using Docker Desktop (Windows and MacOS)][faq-win-mac]
|
|
for instructions on binding Nomad to a non-loopback network interface.
|
|
|
|
- Use Vagrant and VirtualBox
|
|
|
|
This option requires AMD hardware.
|
|
|
|
The Nomad repository contains a Vagrantfile. Refer to the [Developing with
|
|
Vagrant section][vagrant] of the [Nomad Codebase
|
|
Documentation][compile-source] file for instructions.
|
|
|
|
- Compile and run from source
|
|
|
|
This option requires software engineering experience and a workstation set up
|
|
for Go, Node, and Docker development.
|
|
|
|
Refer to the Nomad repository's [Nomad Codebase Documentation][compile-source]
|
|
file for details.
|
|
|
|
[faq-win-mac]: /nomad/docs/faq#q-how-to-connect-to-my-host-network-when-using-docker-desktop-windows-and-macos
|
|
[installing-binary]: /nomad/docs/deploy
|
|
[Get Started]: /nomad/tutorials/get-started
|
|
[Cluster Setup]: /nomad/tutorials/cluster-setup
|
|
[interactive]: /nomad/tutorials/interactive/security-gossip-encryption
|
|
[Provision a Nomad cluster on AWS]: https://github.com/hashicorp/nomad/blob/main/terraform/aws/README.md
|
|
[Provision a Nomad cluster on Azure]:
|
|
https://github.com/hashicorp/nomad/blob/main/terraform/azure/README.md
|
|
[Provision a Nomad cluster on GCP]: https://github.com/hashicorp/nomad/blob/main/terraform/gcp/README.md
|
|
[agent-dev]: /nomad/commands/agent#dev
|
|
[vagrant]: https://github.com/hashicorp/nomad/blob/main/contributing/README.md#developing-with-vagrant
|
|
[compile-source]: https://github.com/hashicorp/nomad/blob/main/contributing/README.md
|