Files
nomad/website/content/docs/commands/server/join.mdx
Tim Gross d3ddb0aa49 docs: make it clear that federation features require ACLs (#20196)
Our documentation has a hidden assumption that users know that federation
replication requires ACLs to be enabled and bootstrapped. Add notes at some of
the places users are likely to look for it.

A separate follow-up PR to the federation tutorial should point to the ACL
multi-region tutorial as well.

Fixes: https://github.com/hashicorp/nomad/issues/20128
2024-03-22 15:15:00 -04:00

46 lines
1.4 KiB
Plaintext

---
layout: docs
page_title: 'Commands: server join'
description: >
The server join command is used to join the local server to one or more Nomad
servers.
---
# Command: server join
The `server join` command joins the local server to one or more Nomad servers.
Joining is only required for server nodes, and only needs to succeed against
one or more of the provided addresses. Once joined, the gossip layer will
handle discovery of the other server nodes in the cluster.
## Usage
```plaintext
nomad server join [options] <addr> [<addr>...]
```
One or more server addresses are required. If multiple server addresses are
specified, then an attempt will be made to join each one. If one or more nodes
are joined successfully, the exit code will be 0. Otherwise, the exit code will
be 1.
Joining servers in different regions will [federate][] the regions. This assumes
that ACLs have been bootstrapped in the authoritative region. See [Configure for
multiple regions][] in the ACLs tutorial.
## General Options
@include 'general_options_no_namespace.mdx'
## Examples
Join the local server to a remote server:
```shell-session
$ nomad server join 10.0.0.8:4648
Joined 1 servers successfully
```
[federate]: /nomad/tutorials/manage-clusters/federation
[Configure for multiple regions]: /nomad/tutorials/access-control/access-control-bootstrap#configure-for-multiple-regions