Remove Atlas references from docs
This commit is contained in:
parent
37b09f3901
commit
5d8298290e
|
@ -173,11 +173,6 @@ $ curl \
|
|||
"RPC": "127.0.0.1:4647",
|
||||
"Serf": "127.0.0.1:4648"
|
||||
},
|
||||
"Atlas": {
|
||||
"Endpoint": "",
|
||||
"Infrastructure": "",
|
||||
"Join": false
|
||||
},
|
||||
"BindAddr": "127.0.0.1",
|
||||
"Client": {
|
||||
"AllocDir": "",
|
||||
|
|
|
@ -1,85 +0,0 @@
|
|||
---
|
||||
layout: "docs"
|
||||
page_title: "atlas Stanza - Agent Configuration"
|
||||
sidebar_current: "docs-agent-configuration-atlas"
|
||||
description: |-
|
||||
The `atlas` stanza configures Nomad's integration with HashiCorp's Atlas and
|
||||
Nomad Enterprise.
|
||||
---
|
||||
|
||||
# `atlas` Stanza
|
||||
|
||||
<table class="table table-bordered table-striped">
|
||||
<tr>
|
||||
<th width="120">Placement</th>
|
||||
<td>
|
||||
<code>**atlas**</code>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
The `atlas` stanza configures Nomad's integration with
|
||||
[HashiCorp's Atlas][atlas] and Nomad Enterprise.
|
||||
|
||||
```hcl
|
||||
atlas {
|
||||
infrastructure = "hashicorp/example"
|
||||
join = true
|
||||
}
|
||||
```
|
||||
|
||||
~> Nomad integration with Atlas is **currently in private beta** and only
|
||||
available to select users. As the functionality becomes more widely available,
|
||||
additional examples and documented will be listed here.
|
||||
|
||||
## `atlas` Parameters
|
||||
|
||||
- `endpoint` `(string: "https://atlas.hashicorp.com")` - Specifies the address
|
||||
of the Atlas service to connect.
|
||||
|
||||
- `infrastructure` `(string: <required>)` - Specifies the name of the Atlas
|
||||
infrastructure to connect the agent. This should be of the form
|
||||
`<organization>/<infrastructure>`, and requires a valid `token`
|
||||
|
||||
- `join` `(bool: false)` - Specifies if the auto-join functionality should be
|
||||
enabled.
|
||||
|
||||
- `token` `(string: <required>)` - Specifies the Atlas token to use for
|
||||
authentication. This token must have access to the provided `infrastructure`.
|
||||
This can also optionally be specified using the `ATLAS_TOKEN` environment
|
||||
variable.
|
||||
|
||||
## `atlas` Examples
|
||||
|
||||
The following examples only show the `atlas` stanzas. Remember that the
|
||||
`atlas` stanza is only valid in the placements listed above.
|
||||
|
||||
### Nomad Enterprise SaaS
|
||||
|
||||
This example connects to the public Nomad Enterprise service to the
|
||||
infrastructure named "hashicorp/example". The provided token must have
|
||||
permissions to manage the infrastructure or access will be denied.
|
||||
|
||||
```hcl
|
||||
atlas {
|
||||
infrastructure = "hashicorp/example"
|
||||
token = "abcd.atlasv1.efghi...."
|
||||
join = true
|
||||
}
|
||||
```
|
||||
|
||||
### On-Premise Nomad Enterprise
|
||||
|
||||
This example connects to a custom Nomad Enterprise server, such as an on-premise
|
||||
installation.
|
||||
|
||||
```hcl
|
||||
atlas {
|
||||
endpoint = "https://corp.atlas.local/"
|
||||
infrastructure = "acme/example"
|
||||
join = true
|
||||
}
|
||||
```
|
||||
|
||||
[atlas]: https://atlas.hashicorp.com/ "Atlas by HashiCorp"
|
|
@ -195,7 +195,6 @@ see the [drivers documentation](/docs/drivers/index.html).
|
|||
```text
|
||||
CONSUL_TOKEN
|
||||
VAULT_TOKEN
|
||||
ATLAS_TOKEN
|
||||
AWS_ACCESS_KEY_ID
|
||||
AWS_SECRET_ACCESS_KEY
|
||||
AWS_SESSION_TOKEN
|
||||
|
|
|
@ -66,10 +66,6 @@ consul {
|
|||
address = "1.2.3.4:8500"
|
||||
}
|
||||
|
||||
atlas {
|
||||
infrastructure = "hashicorp/mars"
|
||||
token = "atlas.v1.AFE84330943"
|
||||
}
|
||||
```
|
||||
|
||||
~> Note that it is strongly recommended **not** to operate a node as both
|
||||
|
@ -114,9 +110,6 @@ testing.
|
|||
reachable from all server nodes. It is not required that clients can reach
|
||||
this address.
|
||||
|
||||
- `atlas` <code>([Atlas][atlas]: nil)</code> - Specifies if Nomad should connect
|
||||
to Nomad Enterprise and Atlas.
|
||||
|
||||
- `bind_addr` `(string: "0.0.0.0")` - Specifies which address the Nomad
|
||||
agent should bind to for network services, including the HTTP interface as
|
||||
well as the internal gossip protocol and RPC mechanism. This should be
|
||||
|
@ -233,7 +226,6 @@ http_api_response_headers {
|
|||
[hcl]: https://github.com/hashicorp/hcl "HashiCorp Configuration Language"
|
||||
[go-sockaddr/template]: https://godoc.org/github.com/hashicorp/go-sockaddr/template
|
||||
[consul]: /docs/agent/configuration/consul.html "Nomad Agent consul Configuration"
|
||||
[atlas]: /docs/agent/configuration/atlas.html "Nomad Agent atlas Configuration"
|
||||
[vault]: /docs/agent/configuration/vault.html "Nomad Agent vault Configuration"
|
||||
[tls]: /docs/agent/configuration/tls.html "Nomad Agent tls Configuration"
|
||||
[client]: /docs/agent/configuration/client.html "Nomad Agent client Configuration"
|
||||
|
|
|
@ -46,7 +46,6 @@ $ nomad agent -dev
|
|||
==> Starting Nomad agent...
|
||||
==> Nomad agent configuration:
|
||||
|
||||
Atlas: (Infrastructure: 'hashicorp/example' Join: false)
|
||||
Client: true
|
||||
Log Level: INFO
|
||||
Region: global (DC: dc1)
|
||||
|
@ -61,11 +60,6 @@ $ nomad agent -dev
|
|||
|
||||
There are several important messages that `nomad agent` outputs:
|
||||
|
||||
- **Atlas**: This shows the [Atlas infrastructure](https://atlas.hashicorp.com)
|
||||
with which the node is registered, if any. It also indicates if auto-join is
|
||||
enabled. The Atlas infrastructure is set using `-atlas` and auto-join is
|
||||
enabled by setting `-atlas-join`.
|
||||
|
||||
- **Client**: This indicates whether the agent has enabled client mode.
|
||||
Client nodes fingerprint their host environment, register with servers,
|
||||
and run tasks.
|
||||
|
|
|
@ -24,10 +24,6 @@ via CLI arguments. The `agent` command accepts the following arguments:
|
|||
|
||||
* `-alloc-dir=<path>`: Equivalent to the Client [alloc_dir](#alloc_dir) config
|
||||
option.
|
||||
* `-atlas=<infrastructure>`: Equivalent to the Atlas
|
||||
[infrastructure](#infrastructure) config option.
|
||||
* `-atlas-join`: Equivalent to the Atlas [join](#join) config option.
|
||||
* `-atlas-token=<token>`: Equivalent to the Atlas [token](#token) config option.
|
||||
* `-bind=<address>`: Equivalent to the [bind_addr](#bind_addr) config option.
|
||||
* `-bootstrap-expect=<num>`: Equivalent to the
|
||||
[bootstrap_expect](#bootstrap_expect) config option.
|
||||
|
|
|
@ -19,15 +19,6 @@ This anonymous ID can can be disabled. Using the Checkpoint service is optional
|
|||
See [`disable_anonymous_signature`](/docs/agent/configuration/index.html#disable_anonymous_signature)
|
||||
and [`disable_update_check`](/docs/agent/configuration/index.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 a 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
|
||||
|
|
|
@ -49,7 +49,6 @@ $ sudo nomad agent -config server.hcl
|
|||
==> Starting Nomad agent...
|
||||
==> Nomad agent configuration:
|
||||
|
||||
Atlas: <disabled>
|
||||
Client: false
|
||||
Log Level: DEBUG
|
||||
Region: global (DC: dc1)
|
||||
|
@ -122,7 +121,6 @@ $ sudo nomad agent -config client1.hcl
|
|||
==> Starting Nomad agent...
|
||||
==> Nomad agent configuration:
|
||||
|
||||
Atlas: <disabled>
|
||||
Client: true
|
||||
Log Level: DEBUG
|
||||
Region: global (DC: dc1)
|
||||
|
|
|
@ -32,7 +32,6 @@ vagrant@nomad:~$ sudo nomad agent -dev
|
|||
==> Starting Nomad agent...
|
||||
==> Nomad agent configuration:
|
||||
|
||||
Atlas: <disabled>
|
||||
Client: true
|
||||
Log Level: DEBUG
|
||||
Region: global (DC: dc1)
|
||||
|
|
|
@ -257,9 +257,6 @@
|
|||
<li<%= sidebar_current("docs-agent-configuration") %>>
|
||||
<a href="/docs/agent/configuration/index.html">Configuration</a>
|
||||
<ul class="nav">
|
||||
<li <%= sidebar_current("docs-agent-configuration-atlas") %>>
|
||||
<a href="/docs/agent/configuration/atlas.html">atlas</a>
|
||||
</li>
|
||||
<li <%= sidebar_current("docs-agent-configuration-client") %>>
|
||||
<a href="/docs/agent/configuration/client.html">client</a>
|
||||
</li>
|
||||
|
|
Loading…
Reference in a new issue