github.com/ncodes/nomad@v0.5.7-0.20170403112158-97adf4a74fb3/website/source/docs/agent/configuration/atlas.html.md (about)

     1  ---
     2  layout: "docs"
     3  page_title: "atlas Stanza - Agent Configuration"
     4  sidebar_current: "docs-agent-configuration-atlas"
     5  description: |-
     6    The `atlas` stanza configures Nomad's integration with HashiCorp's Atlas and
     7    Nomad Enterprise.
     8  ---
     9  
    10  # `atlas` Stanza
    11  
    12  <table class="table table-bordered table-striped">
    13    <tr>
    14      <th width="120">Placement</th>
    15      <td>
    16        <code>**atlas**</code>
    17      </td>
    18    </tr>
    19  </table>
    20  
    21  
    22  The `atlas` stanza configures Nomad's integration with
    23  [HashiCorp's Atlas][atlas] and Nomad Enterprise.
    24  
    25  ```hcl
    26  atlas {
    27    infrastructure = "hashicorp/example"
    28    join           = true
    29  }
    30  ```
    31  
    32  ~> Nomad integration with Atlas is **currently in private beta** and only
    33  available to select users. As the functionality becomes more widely available,
    34  additional examples and documented will be listed here.
    35  
    36  ## `atlas` Parameters
    37  
    38  - `endpoint` `(string: "https://atlas.hashicorp.com")` - Specifies the address
    39    of the Atlas service to connect.
    40  
    41  - `infrastructure` `(string: <required>)` - Specifies the name of the Atlas
    42    infrastructure to connect the agent. This should be of the form
    43    `<organization>/<infrastructure>`, and requires a valid `token`
    44  
    45  - `join` `(bool: false)` - Specifies if the auto-join functionality should be
    46    enabled.
    47  
    48  - `token` `(string: <required>)` - Specifies the Atlas token to use for
    49    authentication. This token must have access to the provided `infrastructure`.
    50    This can also optionally be specified using the `ATLAS_TOKEN` environment
    51    variable.
    52  
    53  ## `atlas` Examples
    54  
    55  The following examples only show the `atlas` stanzas. Remember that the
    56  `atlas` stanza is only valid in the placements listed above.
    57  
    58  ### Nomad Enterprise SaaS
    59  
    60  This example connects to the public Nomad Enterprise service to the
    61  infrastructure named "hashicorp/example". The provided token must have
    62  permissions to manage the infrastructure or access will be denied.
    63  
    64  ```hcl
    65  atlas {
    66    infrastructure = "hashicorp/example"
    67    token          = "abcd.atlasv1.efghi...."
    68    join           = true
    69  }
    70  ```
    71  
    72  ### On-Premise Nomad Enterprise
    73  
    74  This example connects to a custom Nomad Enterprise server, such as an on-premise
    75  installation.
    76  
    77  ```hcl
    78  atlas {
    79    endpoint       = "https://corp.atlas.local/"
    80    infrastructure = "acme/example"
    81    join           = true
    82  }
    83  ```
    84  
    85  [atlas]: https://atlas.hashicorp.com/ "Atlas by HashiCorp"