From 1524e2d2712e9936c8d7258d9a6450df8d109274 Mon Sep 17 00:00:00 2001 From: Armon Dadgar Date: Sun, 20 Sep 2015 20:29:51 -0700 Subject: [PATCH] website: working on docs --- website/source/docs/agent/config.html.md | 11 +++++++ website/source/docs/agent/running.html.md | 11 +++++++ website/source/docs/faq.html.md | 38 +++++++++++++++++++++++ website/source/layouts/docs.erb | 12 +++++-- 4 files changed, 69 insertions(+), 3 deletions(-) create mode 100644 website/source/docs/agent/config.html.md create mode 100644 website/source/docs/agent/running.html.md create mode 100644 website/source/docs/faq.html.md diff --git a/website/source/docs/agent/config.html.md b/website/source/docs/agent/config.html.md new file mode 100644 index 000000000..c61ea370a --- /dev/null +++ b/website/source/docs/agent/config.html.md @@ -0,0 +1,11 @@ +--- +layout: "docs" +page_title: "Configuration" +sidebar_current: "docs-agent-config" +description: |- + Learn about the configuration options available for the Nomad agent. +--- + +# Configuration + +TODO diff --git a/website/source/docs/agent/running.html.md b/website/source/docs/agent/running.html.md new file mode 100644 index 000000000..70d9d65c4 --- /dev/null +++ b/website/source/docs/agent/running.html.md @@ -0,0 +1,11 @@ +--- +layout: "docs" +page_title: "Running and Stopping" +sidebar_current: "docs-agent-running" +description: |- + Learn about the the lifecycle of a Nomad agent, running and stopping. +--- + +# Running and Stopping + +TODO diff --git a/website/source/docs/faq.html.md b/website/source/docs/faq.html.md new file mode 100644 index 000000000..202982e2e --- /dev/null +++ b/website/source/docs/faq.html.md @@ -0,0 +1,38 @@ +--- +layout: "docs" +page_title: "Frequently Asked Questions" +sidebar_current: "docs-faq" +description: |- + Frequently asked questions and answers for Nomad +--- + +# Frequently Asked Questions + +## Q: What is Checkpoint? / Does Nomad call home? + +Nomad makes use of a HashiCorp service called [Checkpoint](http://checkpoint.hashicorp.com) +which is used to check for updates and critical security bulletins. +Only anonymous information, which cannot be used to identify the user or host, is +sent to Checkpoint. An anonymous ID is sent which helps de-duplicate warning messages. +This anonymous ID can can be disabled. Using the Checkpoint service is optional and can be disabled. + +See [`disable_anonymous_signature`](/docs/agent/config.html#disable_anonymous_signature) +and [`disable_update_check`](/docs/agent/config.html#disable_update_check). + +## Q: How does Atlas integration work? + +Nomad makes use of a HashiCorp service called [SCADA](http://scada.hashicorp.com) +(Supervisory Control And Data Acquisition). The SCADA system allows clients to maintain +long-running connections to Atlas. Atlas can in turn provide auto-join facilities for +Nomad agents (supervisory control) and an dashboard showing the state of the system (data acquisition). + +Using the SCADA service is optional. SCADA is only enabled by opt-in. + +## Q: Is Nomad eventually or strongly consistent? + +Nomad makes use of both a [consensus protocol](/docs/internals/consensus.html) and +a [gossip protocol](/docs/internals/gossip.html). The consensus protocol is strongly +consistent, and is used for all state replication and scheduling. The gossip protocol +is used to manage the addresses of servers for automatic clustering and multi-region +federation. This means all data that managed by Nomad is strongly consistent. + diff --git a/website/source/layouts/docs.erb b/website/source/layouts/docs.erb index 38e553859..162d50f01 100644 --- a/website/source/layouts/docs.erb +++ b/website/source/layouts/docs.erb @@ -31,7 +31,6 @@ Installation -
> Job Specification @@ -62,7 +61,6 @@ -
> Commands (CLI) @@ -108,7 +106,11 @@