@@ -16,19 +16,21 @@ weight=20
16
16
Docker Universal Control Plane (UCP) is a containerized application that can be
17
17
installed on-premises or on a cloud infrastructure.
18
18
19
+ ## Step 1: Validate the system requirements
20
+
19
21
The first step in installing UCP, is ensuring your
20
22
infrastructure has all the [ requirements UCP needs to run] ( system-requirements ) .
21
- Once that is done, use these instructions to install UCP.
22
23
23
- ## Step 1: Install CS Docker on all nodes
24
+
25
+ ## Step 2: Install CS Docker on all nodes
24
26
25
27
UCP requires you to install Docker CS Engine 1.10 or above on all nodes of
26
28
your UCP cluster.
27
29
28
30
For each node that you want to add to the UCP cluster, install the CS Docker
29
31
Engine.
30
32
31
- ## Step 2 : Customize named volumes
33
+ ## Step 3 : Customize named volumes
32
34
33
35
This step is optional.
34
36
@@ -40,7 +42,9 @@ If the volumes don't exist, when installing UCP they are
40
42
created with the default volume driver and flags.
41
43
42
44
43
- ## Step 3: Customize the CA used
45
+ ## Step 4: Customize the CA used
46
+
47
+ This step is optional.
44
48
45
49
The UCP cluster uses TLS to secure all communications. Two Certificate
46
50
Authorities (CA) are used for this:
@@ -69,15 +73,11 @@ If you want to use your own certificates:
69
73
| key.pem | Your UCP controller private key. |
70
74
71
75
72
- ## Step 4 : Install the UCP controller
76
+ ## Step 5 : Install the UCP controller
73
77
74
78
To install UCP you use the ` docker/ucp ` image. This image has commands to
75
79
install, 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 ) .
81
81
82
82
To install UCP:
83
83
@@ -91,47 +91,59 @@ To install UCP:
91
91
92
92
``` bash
93
93
$ 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 >
96
97
```
97
98
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
+
100
113
101
114
3. Check that the UCP web application is running.
102
115
103
116
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
105
118
an unsafe site.
106
119
107
120

108
121
109
- # # Step 5 : License your installation
122
+ ## Step 6 : License your installation
110
123
111
124
Now that your UCP controller is installed, you need to license it.
112
125
[Learn how to license your installation](license.md).
113
126
114
- # # Step 6: Backup the controller CAs
127
+ ## Step 7: Backup the controller CAs
128
+
129
+ This step is optional.
115
130
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.
119
133
[Learn more about high-availability](../high-availability/set-up-high-availability.md).
120
134
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.
124
137
[Learn how to replicate the CAs for high availability](../high-availability/replicate-cas.md).
125
138
126
- # # Step 7: Add controller replicas to the UCP cluster
127
139
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.
131
143
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).
135
147
136
148
For each node that you want to install as a controller replica:
137
149
@@ -146,13 +158,13 @@ For each node that you want to install as a controller replica:
146
158
` ` ` bash
147
159
$ docker run --rm -it --name ucp \
148
160
-v /var/run/docker.sock:/var/run/docker.sock \
149
- docker/ucp join -i --replica
161
+ docker/ucp join -i \
162
+ --replica
150
163
` ` `
151
164
152
165
3. 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.
153
167
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).
156
168
157
169
4. Check the cluster state.
158
170
@@ -161,7 +173,7 @@ For each node that you want to install as a controller replica:
161
173
! [UCP nodes page](../images/replica-nodes.png)
162
174
163
175
164
- ## Step 8 : Add more nodes to the UCP cluster
176
+ # # Step 9 : Add more nodes to the UCP cluster
165
177
166
178
Now you can add additional nodes to your UCP cluster. These are the nodes that
167
179
will be running your containers.
@@ -186,7 +198,7 @@ For each node that you want to add to your UCP cluster:
186
198
187
199
! [UCP nodes page](../images/nodes-page.png)
188
200
189
- ## Step 9 . Download an admin user bundle
201
+ # # Step 10 . Download a client certificate bundle
190
202
191
203
To validate that your cluster is correctly configured, you should try accessing
192
204
the cluster with the Docker CLI client. For this, you' ll need to get a client
0 commit comments