@@ -16,19 +16,21 @@ weight=20
1616Docker Universal Control Plane (UCP) is a containerized application that can be
1717installed on-premises or on a cloud infrastructure.
1818
19+ ## Step 1: Validate the system requirements
20+
1921The first step in installing UCP, is ensuring your
2022infrastructure has all the [ requirements UCP needs to run] ( system-requirements ) .
21- Once that is done, use these instructions to install UCP.
2223
23- ## Step 1: Install CS Docker on all nodes
24+
25+ ## Step 2: Install CS Docker on all nodes
2426
2527UCP requires you to install Docker CS Engine 1.10 or above on all nodes of
2628your UCP cluster.
2729
2830For each node that you want to add to the UCP cluster, install the CS Docker
2931Engine.
3032
31- ## Step 2 : Customize named volumes
33+ ## Step 3 : Customize named volumes
3234
3335This step is optional.
3436
@@ -40,7 +42,9 @@ If the volumes don't exist, when installing UCP they are
4042created with the default volume driver and flags.
4143
4244
43- ## Step 3: Customize the CA used
45+ ## Step 4: Customize the CA used
46+
47+ This step is optional.
4448
4549The UCP cluster uses TLS to secure all communications. Two Certificate
4650Authorities (CA) are used for this:
@@ -69,15 +73,11 @@ If you want to use your own certificates:
6973 | key.pem | Your UCP controller private key. |
7074
7175
72- ## Step 4 : Install the UCP controller
76+ ## Step 5 : Install the UCP controller
7377
7478To install UCP you use the ` docker/ucp ` image. This image has commands to
7579install, configure, and backup UCP. To find what commands and options are
76- available, check the [ reference documentation] ( ../reference/install.md ) , or run:
77-
78- ``` bash
79- $ docker run --rm -it docker/ucp --help
80- ```
80+ available, check the [ reference documentation] ( ../reference/install.md ) .
8181
8282To install UCP:
8383
@@ -91,47 +91,59 @@ To install UCP:
9191
9292 ``` bash
9393 $ docker run --rm -it --name ucp \
94- -v /var/run/docker.sock:/var/run/docker.sock
95- docker/ucp install -i
94+ -v /var/run/docker.sock:/var/run/docker.sock \
95+ docker/ucp install -i \
96+ --host-address < $UCP_PUBLIC_IP >
9697 ```
9798
98- If you are using server certificates signed by an external CA, include
99- the ` --external-server-cert` option at the end of the command.
99+ Where:
100+
101+ * i, specify to run the install command interactively,
102+ * host-address, is the public IP where users or a load balancer can access
103+ UCP,
104+ * Also, include the ` --external-server-cert` flag if you' re using server
105+ certificates signed by an external CA.
106+
107+ </br>
108+ When installing Docker UCP, overlay networking is automatically configured
109+ for you. If you are running Docker CS Engine 1.10, or have custom
110+ configurations on your Docker CS Engine, you need to restart the Docker
111+ daemon at this point.
112+
100113
1011143. Check that the UCP web application is running.
102115
103116 In your browser, navigate to the address where you' ve installed UCP.
104- If you' re not using your own certificates , your browser warns that UCP is
117+ If you' re not using an external CA , your browser warns that UCP is
105118 an unsafe site.
106119
107120 
108121
109- # # Step 5 : License your installation
122+ ## Step 6 : License your installation
110123
111124Now that your UCP controller is installed, you need to license it.
112125[Learn how to license your installation](license.md).
113126
114- # # Step 6: Backup the controller CAs
127+ ## Step 7: Backup the controller CAs
128+
129+ This step is optional.
115130
116- Docker UCP has support for high-availability. For an highly available
117- installation, you add more controller nodes to the UCP cluster. The controller
118- nodes are replicas of each other.
131+ For an highly available installation, you can add more controller nodes to
132+ the UCP cluster. The controller nodes are replicas of each other.
119133[Learn more about high-availability](../high-availability/set-up-high-availability.md).
120134
121- When configuring UCP for high-availability, you need to ensure the CAs running
122- on each UCP controller node are interchangeable. This is done by using the same
123- certificates and keys for every CA on the cluster.
135+ For this, you need to make the CAs on each controller node, use the same
136+ root certificates and keys.
124137[Learn how to replicate the CAs for high availability](../high-availability/replicate-cas.md).
125138
126- # # Step 7: Add controller replicas to the UCP cluster
127139
128- To add more controller nodes to the cluster, use the
129- ` docker/ucp join --replica ` command. To find what commands and options are
130- available, check the [reference documentation](../reference/join.md), or run:
140+ ## Step 8: Add controller replicas to the UCP cluster
141+
142+ This step is optional.
131143
132- ` ` ` bash
133- $ docker run --rm -it docker/ucp join --help
134- ` ` `
144+ For an highly available installation, you can add more controller nodes to
145+ the UCP cluster. For that, use the ` docker/ucp join --replica` command.
146+ [Learn more about the join command](../reference/join.md).
135147
136148For each node that you want to install as a controller replica:
137149
@@ -146,13 +158,13 @@ For each node that you want to install as a controller replica:
146158 ` ` ` bash
147159 $ docker run --rm -it --name ucp \
148160 -v /var/run/docker.sock:/var/run/docker.sock \
149- docker/ucp join -i --replica
161+ docker/ucp join -i \
162+ --replica
150163 ` ` `
151164
1521653. Repeat steps 1 and 2 on the other nodes you want to set up as replicas.
166+ Make sure you set up 3, 5, or 7 controllers.
153167
154- For high availability, make sure to set up 3, 5, or 7 controller nodes.
155- [Learn more about high-availability](../high-availability/set-up-high-availability.md).
156168
1571694. Check the cluster state.
158170
@@ -161,7 +173,7 @@ For each node that you want to install as a controller replica:
161173 ! [UCP nodes page](../images/replica-nodes.png)
162174
163175
164- ## Step 8 : Add more nodes to the UCP cluster
176+ # # Step 9 : Add more nodes to the UCP cluster
165177
166178Now you can add additional nodes to your UCP cluster. These are the nodes that
167179will be running your containers.
@@ -186,7 +198,7 @@ For each node that you want to add to your UCP cluster:
186198
187199 ! [UCP nodes page](../images/nodes-page.png)
188200
189- ## Step 9 . Download an admin user bundle
201+ # # Step 10 . Download a client certificate bundle
190202
191203To validate that your cluster is correctly configured, you should try accessing
192204the cluster with the Docker CLI client. For this, you' ll need to get a client
0 commit comments