Skip to content

Commit 5909a90

Browse files
author
Joao Fernandes
committed
Adds docs missing for 1.1.0
* closes docker#938 * closes docker#1252 * closes docker#1318 * closes docker#448 * closes docker#1465 * closes docker#1317 * closes docker#912 * closes docker#1473
1 parent 02b236f commit 5909a90

File tree

14 files changed

+306
-103
lines changed

14 files changed

+306
-103
lines changed

access-ucp/index.md

+7
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,10 @@ identifier="mn_ucp_access"
99
weight=31
1010
+++
1111
<![end-metadata]-->
12+
13+
# Access UCP
14+
15+
This section includes the following topics:
16+
17+
* [Web-based access](web-based-access.md)
18+
* [CLI-based access](cli-based-access.md)

applications/index.md

+7
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,10 @@ identifier="mn_ucp_applications"
99
weight=80
1010
+++
1111
<![end-metadata]-->
12+
13+
# UCP applications
14+
15+
This section includes the following topics:
16+
17+
* [Deploy an app from the UI](deploy-app-ui.md)
18+
* [Deploy an app from the CLI](deploy-app-cli.md)

configuration/index.md

+8
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,11 @@ identifier="mn_ucp_configuration"
99
weight=50
1010
+++
1111
<![end-metadata]-->
12+
13+
# UCP configuration
14+
15+
This section includes the following topics:
16+
17+
* [Set up container networking](multi-host-networking.md)
18+
* [Integrate with Docker Trusted Registry](dtr-integration.md)
19+
* [Configure UCP logging](configure-logs.md)

high-availability/backups-and-disaster-recovery.md

+31-28
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,7 @@ The next step is creating a backup policy and disaster recovery plan.
2020

2121
## Backup policy
2222

23-
Docker UCP nodes persist data using [named volumes](../architecture.md):
24-
25-
* Controller nodes persist cluster configurations, certificates, and keys
26-
used to issue certificates and user bundles. This data is replicated on every
27-
controller node in the cluster.
28-
* Nodes are stateless. They only store certificates for mutual TLS, that
29-
can be regenerated.
23+
Docker UCP nodes persist data using [named volumes](../architecture.md).
3024

3125
As part of your backup policy you should regularly create backups of the
3226
controller nodes. Since the nodes used for running user containers don't
@@ -46,19 +40,7 @@ To have minimal impact on your business, you should:
4640
* Configure UCP for high availability. This allows load-balancing user requests
4741
across multiple UCP controller nodes.
4842

49-
## Backup UCP data
50-
51-
To learn about the options available on the `docker/ucp backup` command, you can
52-
check the reference documentation, or run:
53-
54-
```bash
55-
$ docker run --rm docker/ucp backup --help
56-
```
57-
58-
When creating a backup, the resulting tar archive contains sensitive information
59-
like private keys. To ensure this information is kept private you should run
60-
the backup command with the `--passphrase` option. This encrypts
61-
the backup with a passphrase of your choice.
43+
## Backup command
6244

6345
The example below shows how to create a backup of a UCP controller node:
6446

@@ -68,14 +50,6 @@ $ docker run --rm -i --name ucp \
6850
-v /var/run/docker.sock:/var/run/docker.sock \
6951
docker/ucp --interactive --passphrase "secret" > /tmp/backup.tar
7052

71-
Do you want proceed with the backup? (y/n):
72-
$ y
73-
74-
INFO[0000] Temporarily Stopping local UCP containers to ensure a consistent backup
75-
INFO[0000] Beginning backup
76-
INFO[0001] Backup completed successfully
77-
INFO[0002] Resuming stopped UCP containers
78-
7953
# Decrypt the backup and list its contents
8054
$ gpg --decrypt /tmp/backup.tar | tar --list
8155

@@ -89,6 +63,35 @@ Enter passphrase: secret
8963
# output snipped
9064
```
9165

66+
## Restore command
67+
68+
The example below shows how to restore a UCP controller node from an existing
69+
backup:
70+
71+
```bash
72+
$ docker run --rm -i --name ucp \
73+
-v /var/run/docker.sock:/var/run/docker.sock \
74+
docker/ucp restore -i < backup.tar
75+
```
76+
77+
78+
## Restore your cluster
79+
80+
Configuring UCP to have multiple controller nodes allows you tolerate a certain
81+
amount of node failures. If multiple nodes fail at the same time, causing the
82+
cluster to go down, you can use an existing backup to recover.
83+
84+
As an example, if you have a cluster with three controller nodes, A, B, and C,
85+
and your most recent backup was of node A:
86+
87+
1. Stop controllers B and C with the `stop` command,
88+
2. Restore controller A,
89+
3. Uninstall UCP from controllers B and C,
90+
4. Join nodes B and C to the cluster.
91+
92+
You should now have your cluster up and running.
93+
94+
9295
## Where to go next
9396

9497
* [Set up high availability](set-up-high-availability.md)

high-availability/index.md

+8
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,11 @@ identifier="mn_ucp_high_availability"
99
weight=60
1010
+++
1111
<![end-metadata]-->
12+
13+
# Configure UCP for high availability
14+
15+
This section includes the following topics:
16+
17+
* [Set up high availability](set-up-high-availability.md)
18+
* [Replicate CAs for high availability](replicate-cas.md)
19+
* [Backups and disaster recovery](backups-and-disaster-recovery.md)

index.md

+12
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,15 @@ solution from Docker. You install it behind your firewall, and it helps you
1515
manage your whole cluster from a single place.
1616

1717
The UCP documentation includes the following topics:
18+
19+
* [Universal Control Plane overview](overview.md)
20+
* [Evaluate UCP in a sandbox](install-sandbox.md)
21+
* [Architecture](architecture.md)
22+
* [Installation](installation/system-requirements.md)
23+
* [Access UCP](access-ucp/web-based-access.md)
24+
* [Configuration](configuration/multi-host-networking.md)
25+
* [Monitor and troubleshoot](monitor/monitor-ucp.md)
26+
* [High availability](high-availability/set-up-high-availability.md)
27+
* [User management](user-management/manage-users.md)
28+
* [Applications](applications/deploy-app-ui.md)
29+
* [Release notes](release_notes.md)

installation/index.md

+12
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,15 @@ identifier="mn_ucp_installation"
99
weight=30
1010
+++
1111
<![end-metadata]-->
12+
13+
# Install UCP
14+
15+
This section includes the following topics:
16+
17+
* [System requirements](system-requirements.md)
18+
* [Plan a production installation](plan-production-install.md)
19+
* [Install UCP for production](install-production.md)
20+
* [Install offline](install-offline.md)
21+
* [License UCP](license.md)
22+
* [Upgrade UCP](upgrade.md)
23+
* [Uninstall UCP](uninstall.md)

installation/install-production.md

+47-35
Original file line numberDiff line numberDiff line change
@@ -16,19 +16,21 @@ weight=20
1616
Docker Universal Control Plane (UCP) is a containerized application that can be
1717
installed on-premises or on a cloud infrastructure.
1818

19+
## Step 1: Validate the system requirements
20+
1921
The first step in installing UCP, is ensuring your
2022
infrastructure 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

2527
UCP requires you to install Docker CS Engine 1.10 or above on all nodes of
2628
your UCP cluster.
2729

2830
For each node that you want to add to the UCP cluster, install the CS Docker
2931
Engine.
3032

31-
## Step 2: Customize named volumes
33+
## Step 3: Customize named volumes
3234

3335
This step is optional.
3436

@@ -40,7 +42,9 @@ If the volumes don't exist, when installing UCP they are
4042
created 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

4549
The UCP cluster uses TLS to secure all communications. Two Certificate
4650
Authorities (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

7478
To install UCP you use the `docker/ucp` image. This image has commands to
7579
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).
8181

8282
To 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
101114
3. 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
![](../images/login.png)
108121
109-
## Step 5: License your installation
122+
## Step 6: License your installation
110123
111124
Now 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
136148
For 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

152165
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.
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

157169
4. 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

166178
Now you can add additional nodes to your UCP cluster. These are the nodes that
167179
will 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

191203
To validate that your cluster is correctly configured, you should try accessing
192204
the cluster with the Docker CLI client. For this, you'll need to get a client

0 commit comments

Comments
 (0)