github.com/noxiouz/docker@v0.7.3-0.20160629055221-3d231c78e8c5/docs/swarm/swarm-tutorial/index.md (about)

     1  <!--[metadata]>
     2  +++
     3  title = "Set up for the tutorial"
     4  description = "Getting Started tutorial for Docker Engine swarm mode"
     5  keywords = ["tutorial, cluster management, swarm mode"]
     6  advisory = "rc"
     7  [menu.main]
     8  identifier="tutorial-setup"
     9  parent="swarm-tutorial"
    10  weight=11
    11  +++
    12  <![end-metadata]-->
    13  
    14  # Getting started with swarm mode
    15  
    16  This tutorial introduces you to the features of Docker Engine Swarm mode. You
    17  may want to familiarize yourself with the [key concepts](../key-concepts.md)
    18  before you begin.
    19  
    20  The tutorial guides you through the following activities:
    21  
    22  * initializing a cluster of Docker Engines in swarm mode
    23  * adding nodes to the swarm
    24  * deploying application services to the swarm
    25  * managing the swarm once you have everything running
    26  
    27  This tutorial uses Docker Engine CLI commands entered on the command line of a
    28  terminal window. You should be able to install Docker on networked machines and
    29  be comfortable running commands in the shell of your choice.
    30  
    31  If you’re brand new to Docker, see [About Docker Engine](../../index.md).
    32  
    33  ## Set up
    34  
    35  To run this tutorial, you need the following:
    36  
    37  * [three networked host machines](#three-networked-host-machines)
    38  * [Docker Engine 1.12 or later installed](#docker-engine-1-12-or-later)
    39  * [the IP address of the manager machine](#the-ip-address-of-the-manager-machine)
    40  * [open ports between the hosts](#open-ports-between-the-hosts)
    41  
    42  ### Three networked host machines
    43  
    44  The tutorial uses three networked host machines as nodes in the swarm. These can
    45  be virtual machines on your PC, in a data center, or on a cloud service
    46  provider. This tutorial uses the following machine names:
    47  
    48  * manager1
    49  * worker1
    50  * worker2
    51  
    52  ###  Docker Engine 1.12 or later
    53  
    54  You must install Docker Engine on each one of the host machines. To use swarm
    55  mode, install the Docker Engine `v1.12.0-rc1` or later from the [Docker releases
    56  GitHub repository](https://github.com/docker/docker/releases). Alternatively,
    57  install the latest Docker for Mac or Docker for Windows Beta.
    58  
    59  >**Advisory**: Some multi-node features may not work for Docker for Mac Beta and
    60  Docker for Windows Beta. We're working on the multi-node features for GA.
    61  
    62  Verify that the Docker Engine daemon is running on each of the machines.
    63  
    64  <!-- See the following options to install:
    65  
    66  * [Install Docker Engine](../../installation/index.md).
    67  
    68  * [Example: Manual install on cloud provider](../../installation/cloud/cloud-ex-aws.md).
    69  -->
    70  
    71  ### The IP address of the manager machine
    72  
    73  The IP address must be assigned to an a network interface available to the host
    74  operating system. All nodes in the swarm must be able to access the manager at the IP address.
    75  
    76  >**Tip**: You can run `ifconfig` on Linux or Mac OS X to see a list of the
    77  available network interfaces.
    78  
    79  The tutorial uses `manager1` : `192.168.99.100`.
    80  
    81  ### Open ports between the hosts
    82  
    83  * **TCP port 2377** for cluster management communications
    84  * **TCP** and **UDP port 7946** for communication among nodes
    85  * **TCP** and **UDP port 4789** for overlay network traffic
    86  
    87  >**Tip**: Docker recommends that every node in the cluster be on the same layer
    88  3 (IP) subnet with all traffic permitted between nodes.
    89  
    90  ## What's next?
    91  
    92  After you have set up your environment, you're ready to [create a swarm](create-swarm.md).