docker-docs/_data/engine-cli/docker_swarm_init.yaml

command: docker swarm init
short: Initialize a swarm
long: |-
  Initialize a swarm. The docker engine targeted by this command becomes a manager
  in the newly created single-node swarm.
usage: docker swarm init [OPTIONS]
pname: docker swarm
plink: docker_swarm.yaml
options:
- option: advertise-addr
  value_type: string
  description: 'Advertised address (format: <ip|interface>[:port])'
  deprecated: false
  experimental: false
  experimentalcli: false
  kubernetes: false
  swarm: false
- option: autolock
  value_type: bool
  default_value: "false"
  description: |
    Enable manager autolocking (requiring an unlock key to start a stopped manager)
  deprecated: false
  experimental: false
  experimentalcli: false
  kubernetes: false
  swarm: false
- option: availability
  value_type: string
  default_value: active
  description: Availability of the node ("active"|"pause"|"drain")
  deprecated: false
  experimental: false
  experimentalcli: false
  kubernetes: false
  swarm: false
- option: cert-expiry
  value_type: duration
  default_value: 2160h0m0s
  description: Validity period for node certificates (ns|us|ms|s|m|h)
  deprecated: false
  experimental: false
  experimentalcli: false
  kubernetes: false
  swarm: false
- option: data-path-addr
  value_type: string
  description: |
    Address or interface to use for data path traffic (format: <ip|interface>)
  deprecated: false
  min_api_version: "1.31"
  experimental: false
  experimentalcli: false
  kubernetes: false
  swarm: false
- option: data-path-port
  value_type: uint32
  default_value: "0"
  description: |
    Port number to use for data path traffic (1024 - 49151). If no value is set or is set to 0, the default port (4789) is used.
  deprecated: false
  min_api_version: "1.40"
  experimental: false
  experimentalcli: false
  kubernetes: false
  swarm: false
- option: default-addr-pool
  value_type: ipNetSlice
  default_value: '[]'
  description: default address pool in CIDR format
  deprecated: false
  min_api_version: "1.39"
  experimental: false
  experimentalcli: false
  kubernetes: false
  swarm: false
- option: default-addr-pool-mask-length
  value_type: uint32
  default_value: "24"
  description: default address pool subnet mask length
  deprecated: false
  min_api_version: "1.39"
  experimental: false
  experimentalcli: false
  kubernetes: false
  swarm: false
- option: dispatcher-heartbeat
  value_type: duration
  default_value: 5s
  description: Dispatcher heartbeat period (ns|us|ms|s|m|h)
  deprecated: false
  experimental: false
  experimentalcli: false
  kubernetes: false
  swarm: false
- option: external-ca
  value_type: external-ca
  description: Specifications of one or more certificate signing endpoints
  deprecated: false
  experimental: false
  experimentalcli: false
  kubernetes: false
  swarm: false
- option: force-new-cluster
  value_type: bool
  default_value: "false"
  description: Force create a new cluster from current state
  deprecated: false
  experimental: false
  experimentalcli: false
  kubernetes: false
  swarm: false
- option: listen-addr
  value_type: node-addr
  default_value: 0.0.0.0:2377
  description: 'Listen address (format: <ip|interface>[:port])'
  deprecated: false
  experimental: false
  experimentalcli: false
  kubernetes: false
  swarm: false
- option: max-snapshots
  value_type: uint64
  default_value: "0"
  description: Number of additional Raft snapshots to retain
  deprecated: false
  min_api_version: "1.25"
  experimental: false
  experimentalcli: false
  kubernetes: false
  swarm: false
- option: snapshot-interval
  value_type: uint64
  default_value: "10000"
  description: Number of log entries between Raft snapshots
  deprecated: false
  min_api_version: "1.25"
  experimental: false
  experimentalcli: false
  kubernetes: false
  swarm: false
- option: task-history-limit
  value_type: int64
  default_value: "5"
  description: Task history retention limit
  deprecated: false
  experimental: false
  experimentalcli: false
  kubernetes: false
  swarm: false
examples: "```bash\n$ docker swarm init --advertise-addr 192.168.99.121\nSwarm initialized:
  current node (bvz81updecsj6wjz393c09vti) is now a manager.\n\nTo add a worker to
  this swarm, run the following command:\n\n    docker swarm join \\\n    --token
  SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-1awxwuwd3z9j1z3puu7rcgdbx
  \\\n    172.17.0.2:2377\n\nTo add a manager to this swarm, run 'docker swarm join-token
  manager' and follow the instructions.\n```\n\n`docker swarm init` generates two
  random tokens, a worker token and a manager token. When you join\na new node to
  the swarm, the node joins as a worker or manager node based upon the token you pass\nto
  [swarm join](swarm_join.md).\n\nAfter you create the swarm, you can display or rotate
  the token using\n[swarm join-token](swarm_join_token.md).\n\n### `--autolock`\n\nThis
  flag enables automatic locking of managers with an encryption key. The\nprivate
  keys and data stored by all managers will be protected by the\nencryption key printed
  in the output, and will not be accessible without it.\nThus, it is very important
  to store this key in order to activate a manager\nafter it restarts. The key can
  be passed to `docker swarm unlock` to reactivate\nthe manager. Autolock can be disabled
  by running\n`docker swarm update --autolock=false`. After disabling it, the encryption
  key\nis no longer required to start the manager, and it will start up on its own\nwithout
  user intervention.\n\n### `--cert-expiry`\n\nThis flag sets the validity period
  for node certificates.\n\n### `--dispatcher-heartbeat`\n\nThis flag sets the frequency
  with which nodes are told to use as a\nperiod to report their health.\n\n### `--external-ca`\n\nThis
  flag sets up the swarm to use an external CA to issue node certificates. The value
  takes\nthe form `protocol=X,url=Y`. The value for `protocol` specifies what protocol
  should be used\nto send signing requests to the external CA. Currently, the only
  supported value is `cfssl`.\nThe URL specifies the endpoint where signing requests
  should be submitted.\n\n### `--force-new-cluster`\n\nThis flag forces an existing
  node that was part of a quorum that was lost to restart as a single node Manager
  without losing its data.\n\n### `--listen-addr`\n\nThe node listens for inbound
  swarm manager traffic on this address. The default is to listen on\n0.0.0.0:2377.
  It is also possible to specify a network interface to listen on that interface's\naddress;
  for example `--listen-addr eth0:2377`.\n\nSpecifying a port is optional. If the
  value is a bare IP address or interface\nname, the default port 2377 will be used.\n\n###
  `--advertise-addr`\n\nThis flag specifies the address that will be advertised to
  other members of the\nswarm for API access and overlay networking. If unspecified,
  Docker will check\nif the system has a single IP address, and use that IP address
  with the\nlistening port (see `--listen-addr`). If the system has multiple IP addresses,\n`--advertise-addr`
  must be specified so that the correct address is chosen for\ninter-manager communication
  and overlay networking.\n\nIt is also possible to specify a network interface to
  advertise that interface's address;\nfor example `--advertise-addr eth0:2377`.\n\nSpecifying
  a port is optional. If the value is a bare IP address or interface\nname, the default
  port 2377 will be used.\n\n### `--data-path-addr`\n\nThis flag specifies the address
  that global scope network drivers will publish towards\nother nodes in order to
  reach the containers running on this node.\nUsing this parameter it is then possible
  to separate the container's data traffic from the\nmanagement traffic of the cluster.\nIf
  unspecified, Docker will use the same IP address or interface that is used for the\nadvertise
  address.\n\n### `--data-path-port`\n\nThis flag allows you to configure the UDP
  port number to use for data path\ntraffic. The provided port number must be within
  the 1024 - 49151 range. If\nthis flag is not set or is set to 0, the default port
  number 4789 is used.\nThe data path port can only be configured when initializing
  the swarm, and\napplies to all nodes that join the swarm.\nThe following example
  initializes a new Swarm, and configures the data path\nport to UDP port 7777;\n\n```bash\ndocker
  swarm init --data-path-port=7777\n```\nAfter the swarm is initialized, use the `docker
  info` command to verify that\nthe port is configured:\n\n```bash\ndocker info\n\t...\n\tClusterID:
  9vs5ygs0gguyyec4iqf2314c0\n\tManagers: 1\n\tNodes: 1\n\tData Path Port: 7777\n\t...\n```\n\n###
  `--default-addr-pool`\nThis flag specifies default subnet pools for global scope
  networks.\nFormat example is `--default-addr-pool 30.30.0.0/16 --default-addr-pool
  40.40.0.0/16`\n\n### `--default-addr-pool-mask-length`\nThis flag specifies default
  subnet pools mask length for default-addr-pool.\nFormat example is `--default-addr-pool-mask-length
  24`\n\n### `--task-history-limit`\n\nThis flag sets up task history retention limit.\n\n###
  `--max-snapshots`\n\nThis flag sets the number of old Raft snapshots to retain in
  addition to the\ncurrent Raft snapshots. By default, no old snapshots are retained.
  This option\nmay be used for debugging, or to store old snapshots of the swarm state
  for\ndisaster recovery purposes.\n\n### `--snapshot-interval`\n\nThis flag specifies
  how many log entries to allow in between Raft snapshots.\nSetting this to a higher
  number will trigger snapshots less frequently.\nSnapshots compact the Raft log and
  allow for more efficient transfer of the\nstate to new managers. However, there
  is a performance cost to taking snapshots\nfrequently.\n\n### `--availability`\n\nThis
  flag specifies the availability of the node at the time the node joins a master.\nPossible
  availability values are `active`, `pause`, or `drain`.\n\nThis flag is useful in
  certain situations. For example, a cluster may want to have\ndedicated manager nodes
  that are not served as worker nodes. This could be achieved\nby passing `--availability=drain`
  to `docker swarm init`."
deprecated: false
min_api_version: "1.24"
experimental: false
experimentalcli: false
kubernetes: false
swarm: true