Fix datacenter broken links

This commit is contained in:
Joao Fernandes 2016-11-09 18:21:24 -08:00
parent e0ad4278d3
commit 1b905e114c
21 changed files with 194 additions and 190 deletions

View File

@ -639,11 +639,11 @@ toc:
title: Architecture
- sectiontitle: Installation
section:
- path: /datacenter/ucp/2.0/installation/
- path: /datacenter/ucp/2.0/installation/system-requirements/
title: System requirements
- path: /datacenter/ucp/2.0/installation/plan-production-install/
title: Plan a production installation
- path: /datacenter/ucp/2.0/installation/install-production/
- path: /datacenter/ucp/2.0/installation/
title: Install UCP for production
- path: /datacenter/ucp/2.0/installation/install-offline/
title: Install offline

View File

@ -209,4 +209,4 @@ ensure your choices make sense.
## See also
* [Configure security settings](config-security.md)
* [Use your own certificates](index.md)

View File

@ -20,7 +20,7 @@ infrastructure has all the [requirements DTR needs to run](system-requirements.m
Since DTR requires Docker Universal Control Plane (UCP)
to run, you need to install UCP on all the nodes where you plan to install DTR.
[Learn how to install UCP](https://docs.docker.com/ucp/installation/install-production/).
[Learn how to install UCP](/datacenter/ucp/2.0/installation/install.md).
Make sure all the nodes you plan on installing DTR are being managed by UCP.

View File

@ -38,4 +38,4 @@ Click the **Apply new license** button, and upload your new license file.
## Where to go next
* [Install DTR](index.md)
* [Install DTR offline](install-dtr-offline.md)
* [Install DTR offline](install-offline.md)

View File

@ -57,4 +57,4 @@ Now you can confirm on Docker Universal Control Plane that the DTR replica
## Where to go next
* [Install DTR](index.md)
* [Install DTR offline](install-dtr-offline.md)
* [Install DTR offline](install-offline.md)

View File

@ -36,7 +36,7 @@ To upgrade DTR you use the `upgrade` command.
If the node you're upgrading doesn't have access to the internet, you can
use a machine with internet connection to
[pull all the DTR images](../install-dtr-offline.md).
[pull all the DTR images](../install-offline.md).
4. Run the upgrade command.
@ -54,5 +54,5 @@ To upgrade DTR you use the `upgrade` command.
## Where to go next
* [Upgrade to DTR 2.0](upgrade-major.md)
* [System requirements](system-requirements.md)
* [Monitor DTR](../../monitor-troubleshoot/index.md)

View File

@ -8,7 +8,7 @@ keywords:
Here you can learn about new features, bug fixes, breaking changes and
known issues for each DTR version.
You can then use [the upgrade instructions](../install/upgrade/upgrade-major.md),
You can then use [the upgrade instructions](../install/upgrade.md),
to upgrade your installation to the latest release.
## DTR 2.1 Beta 3

View File

@ -74,4 +74,4 @@ deployed.
## Where to go next
* [Deploy an app from the UI](deploy-app-ui.md)
* [Deploy an app from the UI](index.md)

View File

@ -64,5 +64,5 @@ By default, the data for these volumes can be found at
## Where to go next
* [System requirements](installation/system-requirements.md)
* [System requirements](installation/index.md)
* [Plan a production installation](installation/plan-production-install.md)

View File

@ -20,5 +20,5 @@ You can configure UCP for sending logs to a remote logging service:
## Where to go next
* [Integrate with DTR](dtr-integration.md)
* [Set up high availability](../high-availability/set-up-high-availability.md)
* [Integrate with DTR](integrate-with-dtr.md)
* [Set up high availability](../high-availability/index.md)

View File

@ -112,6 +112,6 @@ Get https://dtr/v1/_ping: x509: certificate signed by unknown authority
## Where to go next
* [Monitor your cluster](../monitor/monitor-ucp.md)
* [Troubleshoot your cluster](../monitor/troubleshoot-ucp.md)
* [Monitor your cluster](../monitor/index.md)
* [Troubleshoot your cluster](../monitor/troubleshoot.md)
* [Run only signed images](../content-trust/index.md)

View File

@ -12,7 +12,7 @@ allows you to extend service discovery to have name-based virtual hosting for
HTTP services.
See the
[Docker Engine documentation on overlay networks](https://docs.docker.com/engine/swarm/networking/)
[Docker Engine documentation on overlay networks](/engine/swarm/networking.md)
for more information on what Docker Engine provides.
This feature is currently experimental.

View File

@ -46,7 +46,7 @@ To interact with the Notary server, you need to
Once you've installed the Notary client, you need to configure it to talk to
the Notary server that is built into Docker Trusted Registry. This can be done
using a [Notary configuration file](https://docs.docker.com/notary/reference/client-config/#/remote-server-section-optional)
using a [Notary configuration file](/notary/reference/client-config.md)
or by running:
```bash
@ -170,4 +170,4 @@ $ notary key import key.pem
## Where to go next
* [Manage trusted repositories](manage-trusted-repositories.md)
* [Get started with Notary](https://docs.docker.com/notary/getting_started/)
* [Get started with Notary](/notary/getting_started.md)

View File

@ -124,4 +124,4 @@ directory where your private keys are stored, with the `-d` flag.
## Where to go next
* [Run only the images you trust](index.md)
* [Get started with Notary](https://docs.docker.com/notary/getting_started/)
* [Get started with Notary](/notary/getting_started.md)

View File

@ -7,7 +7,7 @@ keywords:
When you decide to start using Docker Universal Control Plane on a production
setting, you should
[configure it for high availability](set-up-high-availability.md).
[configure it for high availability](index.md).
The next step is creating a backup policy and disaster recovery plan.
@ -116,7 +116,7 @@ UCP configuration data:
disruptive operation and any existing tasks will be either terminated or
suspended.
2. Obtain a backup of one of the remaining manager nodes if one is not already
available.
available.
3. Perform a restore operation on the recovered swarm manager node.
4. For all other nodes of the cluster, perform a `docker swarm leave --force`
and then a `docker swarm join` operation with the cluster's new join-token.

View File

@ -65,4 +65,4 @@ the images you deploy have not been altered in any way.
## Where to go next
* [UCP architecture](architecture.md)
* [Install UCP](installation/install-production.md)
* [Install UCP](installation/install.md)

View File

@ -1,60 +1,129 @@
---
title: UCP System requirements
description: Learn about the system requirements for installing Docker Universal Control
Plane.
title: Install UCP for production
description: Learn how to install Docker Universal Control Plane on production
keywords:
- docker, ucp, architecture, requirements
- Universal Control Plane, UCP, install
---
Docker Universal Control Plane can be installed on-premises or on the cloud.
Before installing, be sure your infrastructure has these requirements.
Docker Universal Control Plane (UCP) is a containerized application that can be
installed on-premise or on a cloud infrastructure.
## Hardware and software requirements
If you're installing Docker Datacenter on Azure, [follow this guide](https://success.docker.com/?cid=ddc-on-azure).
You can install UCP on-premises or on a cloud provider. To install UCP,
all nodes must have:
## Step 1: Validate the system requirements
* Linux kernel version 3.10 or higher
* CS Docker Engine version 1.12.1 or higher
* 2.00 GB of RAM
* 3.00 GB of available disk space
* A static IP address
The first step to installing UCP, is ensuring your
infrastructure has all the [requirements UCP needs to run](system-requirements.md).
For highly-available installations, you also need a way to transfer files
between hosts.
## Ports used
## Step 2: Install CS Docker on all nodes
When installing UCP on a host, make sure the following ports are open:
UCP is a containerized application that requires CS Docker Engine 1.12.0 or
above to run. Start by installing CS Docker Engine on all hosts that you want to
manage with UCP.
| Hosts | Direction | Port | Purpose |
|:------------------|:---------:|:------------------------|:----------------------------------------------------------------------------------|
| managers, workers | in | TCP 443 (configurable) | Port for the UCP web UI and API |
| managers | in | TCP 2376 (configurable) | Port for the Docker Swarm manager. Used for backwards compatibility |
| managers, workers | in | TCP 2377 (configurable) | Port for communication between swarm nodes |
| managers, workers | in, out | TCP, UDP 4789 | Port for overlay networking |
| managers, workers | in, out | TCP, UDP 7946 | Port for overlay networking |
| managers, workers | in | TCP 12376 | Port for a TLS proxy that provides access to UCP, Docker Engine, and Docker Swarm |
| managers | in | TCP 12379 | Port for internal node configuration, cluster configuration, and HA |
| managers | in | TCP 12380 | Port for internal node configuration, cluster configuration, and HA |
| managers | in | TCP 12381 | Port for the certificate authority |
| managers | in | TCP 12382 | Port for the UCP certificate authority |
| managers | in | TCP 12383 | Port for the authentication storage backend |
| managers | in | TCP 12384 | Port for the authentication storage backend for replication across managers |
| managers | in | TCP 12385 | Port for the authentication service API |
| managers | in | TCP 12386 | Port for the authentication worker |
Make sure you install the same CS Docker Engine version on all the nodes. Also,
if you're creating virtual machine templates with CS Docker Engine already
installed, make sure the `/etc/docker/key.json` file is not included in the
virtual machine image. When provisioning the virtual machine, restart the Docker
daemon to generate a new `/etc/docker/key.json` file.
## Compatibility and maintenance lifecycle
## Step 3: Customize named volumes
Docker Datacenter is a software subscription that includes 3 products:
Skip this step if you want to use the defaults provided by UCP.
* CS Docker Engine,
* Docker Trusted Registry,
* Docker Universal Control Plane.
Docker UCP uses named volumes to persist data. If you want
to customize the drivers used to manage these volumes, you can create the
volumes before installing UCP. When you install UCP, the installer
will notice that the volumes already exist, and will start using them.
[Learn about the named volumes used by UCP](../architecture.md).
[Learn more about the maintenance lifecycle for these products](http://success.docker.com/Get_Help/Compatibility_Matrix_and_Maintenance_Lifecycle).
If these volumes don't exist, they'll be automatically created when installing
UCP.
## Step 4: Install UCP
To install UCP you use the `docker/ucp` image, which has commands to install and
manage UCP.
To install UCP:
1. Use ssh to log in into the host where you want to install UCP.
2. Run the following command:
```bash
# Pull the latest version of UCP
$ docker pull docker/ucp:latest
# Install UCP
$ docker run --rm -it --name ucp \
-v /var/run/docker.sock:/var/run/docker.sock \
docker/ucp install \
--host-address <node-ip-address> \
--interactive
```
This runs the install command in interactive mode, so that you're
prompted for any necessary configuration values.
To find what other options are available in the install command, check the
[reference documentation](../reference/install.md).
## Step 5: License your installation
Now that UCP is installed, you need to license it. In your browser, navigate
to the UCP web UI and upload your license.
![](../images/install-production-1.png)
If you don't have a license yet, [learn how to get a free trial license](license.md).
## Step 6: Join manager nodes
Skip this step if you don't want your UCP swarm to be highly available.
To make your UCP swarm fault-tolerant and highly available, you
can join more manager nodes to your it. Manager nodes are the nodes in the
swarm that perform the orchestration and swarm management tasks, and
dispatch tasks for worker nodes to execute.
[Learn more about high-availability](../high-availability/index.md).
To join manager nodes to the swarm, go to the **UCP web UI**, navigate to
the **Resources** page, and go to the **Nodes** section.
![](../images/install-production-2.png)
Click the **Add Node button** to add a new node.
![](../images/install-production-3.png)
Check the 'Add node as a manager' to turn this node into a manager and replicate
UCP for high-availability.
Set the 'Use a custom listen address' option if you want to customize the
network and port where this node will listen for swarm management traffic. By
default the node listens on port 2377.
Set the 'Use a custom advertise address' option if you want to customize the
network and port this node will advertise to other swarm members so that they
can reach it.
For each manager node that you want to join to UCP, login into that
node using ssh, and run the join command that is displayed on UCP.
![](../images/install-production-4.png)
After you run the join command in the node, the node starts being displayed
in UCP.
## Step 7: Join worker nodes
Skip this step if you don't want to add more nodes to run and scale your apps.
To add more computational resources to your swarm, you can join worker nodes.
These nodes execute tasks assigned to them by the manager nodes. For this,
use the same steps as before, but don't check the 'Add node as a manager'
option.
## Where to go next
* [UCP architecture](../architecture.md)
* [Plan a production installation](plan-production-install.md)
* [Use externally-signed certificates](../configuration/index.md)
* [Integrate with LDAP](../configuration/ldap-integration.md)

View File

@ -1,125 +0,0 @@
---
title: Install UCP for production
description: Learn how to install Docker Universal Control Plane on production
keywords:
- Universal Control Plane, UCP, install
---
Docker Universal Control Plane (UCP) is a containerized application that can be
installed on-premise or on a cloud infrastructure.
If you're installing Docker Datacenter on Azure, [follow this guide](https://success.docker.com/?cid=ddc-on-azure).
## Step 1: Validate the system requirements
The first step to installing UCP, is ensuring your
infrastructure has all the [requirements UCP needs to run](system-requirements.md).
## Step 2: Install CS Docker on all nodes
UCP is a containerized application that requires CS Docker Engine 1.12.0 or
above to run. Start by installing CS Docker Engine on all hosts that you want to
manage with UCP.
Make sure you install the same CS Docker Engine version on all the nodes. Also,
if you're creating virtual machine templates with CS Docker Engine already
installed, make sure the `/etc/docker/key.json` file is not included in the
virtual machine image. When provisioning the virtual machine, restart the Docker
daemon to generate a new `/etc/docker/key.json` file.
## Step 3: Customize named volumes
Skip this step if you want to use the defaults provided by UCP.
Docker UCP uses named volumes to persist data. If you want
to customize the drivers used to manage these volumes, you can create the
volumes before installing UCP. When you install UCP, the installer
will notice that the volumes already exist, and will start using them.
[Learn about the named volumes used by UCP](../architecture.md).
If these volumes don't exist, they'll be automatically created when installing
UCP.
## Step 4: Install UCP
To install UCP you use the `docker/ucp` image, which has commands to install and
manage UCP.
To install UCP:
1. Use ssh to log in into the host where you want to install UCP.
2. Run the following command:
```bash
$ docker run --rm -it --name ucp \
-v /var/run/docker.sock:/var/run/docker.sock \
docker/ucp:2.0.0-beta3 install \
--host-address <node-ip-address> \
--interactive
```
This runs the install command in interactive mode, so that you're
prompted for any necessary configuration values.
To find what other options are available in the install command, check the
[reference documentation](../reference/install.md).
## Step 5: License your installation
Now that UCP is installed, you need to license it. In your browser, navigate
to the UCP web UI and upload your license.
![](../images/install-production-1.png)
If you don't have a license yet, [learn how to get a free trial license](license.md).
## Step 6: Join manager nodes
Skip this step if you don't want your UCP swarm to be highly available.
To make your UCP swarm fault-tolerant and highly available, you
can join more manager nodes to your it. Manager nodes are the nodes in the
swarm that perform the orchestration and swarm management tasks, and
dispatch tasks for worker nodes to execute.
[Learn more about high-availability](../high-availability/set-up-high-availability.md).
To join manager nodes to the swarm, go to the **UCP web UI**, navigate to
the **Resources** page, and go to the **Nodes** section.
![](../images/install-production-2.png)
Click the **Add Node button** to add a new node.
![](../images/install-production-3.png)
Check the 'Add node as a manager' to turn this node into a manager and replicate
UCP for high-availability.
Set the 'Use a custom listen address' option if you want to customize the
network and port where this node will listen for swarm management traffic. By
default the node listens on port 2377.
Set the 'Use a custom advertise address' option if you want to customize the
network and port this node will advertise to other swarm members so that they
can reach it.
For each manager node that you want to join to UCP, login into that
node using ssh, and run the join command that is displayed on UCP.
![](../images/install-production-4.png)
After you run the join command in the node, the node starts being displayed
in UCP.
## Step 7: Join worker nodes
Skip this step if you don't want to add more nodes to run and scale your apps.
To add more computational resources to your swarm, you can join worker nodes.
These nodes execute tasks assigned to them by the manager nodes. For this,
use the same steps as before, but don't check the 'Add node as a manager'
option.
## Where to go next
* [Use externally-signed certificates](../configuration/use-externally-signed-certs.md)
* [Integrate with LDAP](../configuration/ldap-integration.md)

View File

@ -0,0 +1,60 @@
---
title: UCP System requirements
description: Learn about the system requirements for installing Docker Universal Control
Plane.
keywords:
- docker, ucp, architecture, requirements
---
Docker Universal Control Plane can be installed on-premises or on the cloud.
Before installing, be sure your infrastructure has these requirements.
## Hardware and software requirements
You can install UCP on-premises or on a cloud provider. To install UCP,
all nodes must have:
* Linux kernel version 3.10 or higher
* CS Docker Engine version 1.12.1 or higher
* 2.00 GB of RAM
* 3.00 GB of available disk space
* A static IP address
For highly-available installations, you also need a way to transfer files
between hosts.
## Ports used
When installing UCP on a host, make sure the following ports are open:
| Hosts | Direction | Port | Purpose |
|:------------------|:---------:|:------------------------|:----------------------------------------------------------------------------------|
| managers, workers | in | TCP 443 (configurable) | Port for the UCP web UI and API |
| managers | in | TCP 2376 (configurable) | Port for the Docker Swarm manager. Used for backwards compatibility |
| managers, workers | in | TCP 2377 (configurable) | Port for communication between swarm nodes |
| managers, workers | in, out | TCP, UDP 4789 | Port for overlay networking |
| managers, workers | in, out | TCP, UDP 7946 | Port for overlay networking |
| managers, workers | in | TCP 12376 | Port for a TLS proxy that provides access to UCP, Docker Engine, and Docker Swarm |
| managers | in | TCP 12379 | Port for internal node configuration, cluster configuration, and HA |
| managers | in | TCP 12380 | Port for internal node configuration, cluster configuration, and HA |
| managers | in | TCP 12381 | Port for the certificate authority |
| managers | in | TCP 12382 | Port for the UCP certificate authority |
| managers | in | TCP 12383 | Port for the authentication storage backend |
| managers | in | TCP 12384 | Port for the authentication storage backend for replication across managers |
| managers | in | TCP 12385 | Port for the authentication service API |
| managers | in | TCP 12386 | Port for the authentication worker |
## Compatibility and maintenance lifecycle
Docker Datacenter is a software subscription that includes 3 products:
* CS Docker Engine,
* Docker Trusted Registry,
* Docker Universal Control Plane.
[Learn more about the maintenance lifecycle for these products](http://success.docker.com/Get_Help/Compatibility_Matrix_and_Maintenance_Lifecycle).
## Where to go next
* [UCP architecture](../architecture.md)
* [Plan a production installation](plan-production-install.md)

View File

@ -74,5 +74,5 @@ To learn more about the `etcdctl` utility, check the
## Where to go next
* [Monitor your cluster](monitor-ucp.md)
* [Monitor your cluster](index.md)
* [Get support](../support.md)