github.com/outbrain/consul@v1.4.5/website/source/docs/commands/join.html.markdown.erb (about)

     1  ---
     2  layout: "docs"
     3  page_title: "Commands: Join"
     4  sidebar_current: "docs-commands-join"
     5  description: |-
     6    The `join` command tells a Consul agent to join an existing cluster. A new Consul agent must join with at least one existing member of a cluster in order to join an existing cluster. After joining that one member, the gossip layer takes over, propagating the updated membership state across the cluster.
     7  ---
     8  
     9  # Consul Join
    10  
    11  Command: `consul join`
    12  
    13  The `join` command tells a Consul agent to join an existing cluster.
    14  A new Consul agent must join with at least one existing member of a cluster
    15  in order to join an existing cluster. After joining that one member,
    16  the gossip layer takes over, propagating the updated membership state across
    17  the cluster.
    18  
    19  If you don't join an existing cluster, then that agent is part of its own
    20  isolated cluster. Other nodes can join it.
    21  
    22  Agents can join other agents multiple times without issue. If a node that
    23  is already part of a cluster joins another node, then the clusters of the
    24  two nodes join to become a single cluster.
    25  
    26  ## Usage
    27  
    28  Usage: `consul join [options] address ...`
    29  
    30  You may call join with multiple addresses if you want to try to join
    31  multiple clusters. Consul will attempt to join all addresses, and the join
    32  command will fail only if Consul was unable to join with any.
    33  
    34  #### API Options
    35  
    36  <%= partial "docs/commands/http_api_options_client" %>
    37  
    38  #### Command Options
    39  
    40  * `-wan` - For agents running in server mode, the agent will attempt to join
    41    other servers gossiping in a WAN cluster. This is used to form a bridge between
    42    multiple datacenters.
    43  
    44