From 043be2dcd29f2c2c826f481ef1903a62517d9faf Mon Sep 17 00:00:00 2001 From: Jim Galasyn Date: Wed, 3 Jan 2018 09:02:52 -0800 Subject: [PATCH] Port UCP install topics to template (#386) * Start porting UCP install topics to template * Port install topics to template --- .../install/architecture-specific-images.md | 17 ++++++++++++- .../ucp/3.0/guides/admin/install/index.md | 25 ++++++++++++++----- .../guides/admin/install/install-offline.md | 19 +++++++++++--- .../guides/admin/install/plan-installation.md | 18 ++++++++++--- .../admin/install/system-requirements.md | 21 +++++++++++++--- .../ucp/3.0/guides/admin/install/uninstall.md | 17 ++++++++++--- .../guides/admin/install/upgrade-offline.md | 17 ++++++++++--- .../ucp/3.0/guides/admin/install/upgrade.md | 19 +++++++++++--- 8 files changed, 127 insertions(+), 26 deletions(-) diff --git a/datacenter/ucp/3.0/guides/admin/install/architecture-specific-images.md b/datacenter/ucp/3.0/guides/admin/install/architecture-specific-images.md index 227c66cf18..42fe5f879b 100644 --- a/datacenter/ucp/3.0/guides/admin/install/architecture-specific-images.md +++ b/datacenter/ucp/3.0/guides/admin/install/architecture-specific-images.md @@ -1,8 +1,17 @@ --- title: Architecture-specific images -description: Learn how to use images that are specific to particular hardware architectures in Docker Universal Control Plane. +description: Learn how to deploy Docker Universal Control Plane using images that are specific to particular hardware architectures. keywords: UCP, Docker EE, image, IBM z, Windows +ui_tabs: +- version: ucp-3.0 + orhigher: true +- version: ucp-2.2 + orlower: true +next_steps: +- path: ../configure/join-nodes/ + title: Join nodes to your cluster --- +{% if include.version=="ucp-3.0" %} Docker Universal Control Plane deploys images for a number of different hardware architectures, including IBM z systems. Some architectures require @@ -41,3 +50,9 @@ following table to ensure that you're pulling the right images for each node. |-------------------------|----------------|--------------------| | ucp-agent | ucp-agent-win | ucp-agent-s390x | | ucp-dsinfo | ucp-dsinfo-win | ucp-dsinfo-s390x | + +{% elsif include.version=="ucp-2.2" %} + +Learn about [architecture-specific images](/datacenter/ucp/2.2/guides/admin/install/architecture-specific-images.md). + +{% endif %} \ No newline at end of file diff --git a/datacenter/ucp/3.0/guides/admin/install/index.md b/datacenter/ucp/3.0/guides/admin/install/index.md index 0039ad275c..9191498e40 100644 --- a/datacenter/ucp/3.0/guides/admin/install/index.md +++ b/datacenter/ucp/3.0/guides/admin/install/index.md @@ -2,7 +2,18 @@ title: Install UCP for production description: Learn how to install Docker Universal Control Plane on production. keywords: Universal Control Plane, UCP, install, Docker EE +ui_tabs: +- version: ucp-3.0 + orhigher: true +- version: ucp-2.2 + orlower: true +next_steps: +- path: ../configure/use-your-own-tls-certificates/ + title: Use your own TLS certificates +- path: ../configure/join-nodes/ + title: Join nodes to your cluster --- +{% if include.version=="ucp-3.0" %} Docker Universal Control Plane (UCP) is a containerized application that you can install on-premise or on a cloud infrastructure. @@ -38,7 +49,7 @@ 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 about the named volumes used by UCP](../../ucp-architecture.md). If these volumes don't exist, they'll be automatically created when installing UCP. @@ -59,10 +70,10 @@ To install UCP: ```none # Pull the latest version of UCP - $ docker image pull {{ page.ucp_org }}/{{ page.ucp_repo }}:{{ page.ucp_version }} + docker image pull {{ page.ucp_org }}/{{ page.ucp_repo }}:{{ page.ucp_version }} # Install UCP - $ docker container run --rm -it --name ucp \ + docker container run --rm -it --name ucp \ -v /var/run/docker.sock:/var/run/docker.sock \ {{ page.ucp_org }}/{{ page.ucp_repo }}:{{ page.ucp_version }} install \ --host-address \ @@ -141,7 +152,9 @@ To add more computational resources to your swarm, you can join worker nodes. These nodes execute tasks assigned to them by the manager nodes. Follow the same steps as before, but don't check the **Add node as a manager** option. -## Where to go next +{% elsif include.version=="ucp-2.2" %} + +Learn about [installing UCP for production](/datacenter/ucp/2.2/guides/admin/install/index.md). + +{% endif %} -* [Use your own TLS certificates](../configure/use-your-own-tls-certificates.md) -* [Join nodes to your cluster](../configure/join-nodes/index.md) diff --git a/datacenter/ucp/3.0/guides/admin/install/install-offline.md b/datacenter/ucp/3.0/guides/admin/install/install-offline.md index 3004dc21fe..5706a9a5de 100644 --- a/datacenter/ucp/3.0/guides/admin/install/install-offline.md +++ b/datacenter/ucp/3.0/guides/admin/install/install-offline.md @@ -3,7 +3,18 @@ title: Install UCP offline description: Learn how to install Docker Universal Control Plane. on a machine with no internet access. keywords: UCP, install, offline, Docker EE +ui_tabs: +- version: ucp-3.0 + orhigher: true +- version: ucp-2.2 + orlower: true +next_steps: +- path: index/ + title: Install UCP +- path: system-requirements/ + title: System requirements --- +{% if include.version=="ucp-3.0" %} The procedure to install Docker Universal Control Plane on a host is the same, whether the host has access to the internet or not. @@ -67,8 +78,10 @@ Follow the same steps for the DTR binaries. Now that the offline hosts have all the images needed to install UCP, you can [install Docker UCP on one of the manager nodes](index.md). +{% elsif include.version=="ucp-2.2" %} + +Learn about [installing UCP offline](/datacenter/ucp/2.2/guides/admin/install/install-offline.md). + +{% endif %} -## Where to go next -* [Install UCP](index.md). -* [System requirements](system-requirements.md) diff --git a/datacenter/ucp/3.0/guides/admin/install/plan-installation.md b/datacenter/ucp/3.0/guides/admin/install/plan-installation.md index 7445ec64cf..c9a8196c64 100644 --- a/datacenter/ucp/3.0/guides/admin/install/plan-installation.md +++ b/datacenter/ucp/3.0/guides/admin/install/plan-installation.md @@ -2,7 +2,18 @@ title: Plan a production UCP installation description: Learn about the Docker Universal Control Plane architecture, and the requirements to install it on production. keywords: UCP, install, Docker EE +ui_tabs: +- version: ucp-3.0 + orhigher: true +- version: ucp-2.2 + orlower: true +next_steps: +- path: index/ + title: Install UCP +- path: system-requirements/ + title: UCP System requirements --- +{% if include.version=="ucp-3.0" %} Docker Universal Control Plane helps you manage your container cluster from a centralized place. This article explains what you need to consider before @@ -100,7 +111,8 @@ for all managers, rather than one for each manager node. In this case, the certificate files are copied automatically to any new manager nodes joining the cluster or being promoted to a manager role. -## Where to go next +{% elsif include.version=="ucp-2.2" %} -* [UCP system requirements](system-requirements.md) -* [Install UCP](index.md) +Learn about [planning your UCP installation](/datacenter/ucp/2.2/guides/admin/install/plan-installation.md). + +{% endif %} diff --git a/datacenter/ucp/3.0/guides/admin/install/system-requirements.md b/datacenter/ucp/3.0/guides/admin/install/system-requirements.md index f85cb0dc87..a41cccef5b 100644 --- a/datacenter/ucp/3.0/guides/admin/install/system-requirements.md +++ b/datacenter/ucp/3.0/guides/admin/install/system-requirements.md @@ -2,10 +2,22 @@ title: UCP System requirements description: Learn about the system requirements for installing Docker Universal Control Plane. keywords: UCP, architecture, requirements, Docker EE +ui_tabs: +- version: ucp-3.0 + orhigher: true +- version: ucp-2.2 + orlower: true +next_steps: +- path: plan-installation/ + title: Plan your installation +- path: ../../ucp-architecture/ + title: UCP architecture redirect_from: - /enterprise/admin/install/system-requirements/ --- +{% if include.version=="ucp-3.0" %} + Docker Universal Control Plane can be installed on-premises or on the cloud. Before installing, be sure your infrastructure has these requirements. @@ -117,7 +129,10 @@ UCP {{ page.ucp_version }} requires minimum versions of the following Docker com - Docker EE Engine 17.06 or higher - DTR 2.5 or higher -## Where to go next +{% elsif include.version=="ucp-2.2" %} + +[UCP System requirements](/datacenter/ucp/2.2/guides/admin/install/system-requirements.md). + +{% endif %} + -* [UCP architecture](/datacenter/ucp/3.0/guides/ucp-architecture.md) -* [Plan your installation](/datacenter/ucp/3.0/guides/admin/install/plan-installation.md) diff --git a/datacenter/ucp/3.0/guides/admin/install/uninstall.md b/datacenter/ucp/3.0/guides/admin/install/uninstall.md index ef76086b3f..13e1b692aa 100644 --- a/datacenter/ucp/3.0/guides/admin/install/uninstall.md +++ b/datacenter/ucp/3.0/guides/admin/install/uninstall.md @@ -2,7 +2,16 @@ title: Uninstall UCP description: Learn how to uninstall a Docker Universal Control Plane swarm. keywords: UCP, uninstall, install, Docker EE +ui_tabs: +- version: ucp-3.0 + orhigher: true +- version: ucp-2.2 + orlower: true +next_steps: +- path: ../configure/join-nodes/ + title: Join nodes to your cluster --- +{% if include.version=="ucp-3.0" %} Docker UCP is designed to scale as your applications grow in size and usage. You can [add and remove nodes](../configure/scale-your-cluster.md) from the @@ -26,7 +35,7 @@ To uninstall UCP, log in to a manager node using ssh, and run the following command: ```bash -$ docker container run --rm -it \ +docker container run --rm -it \ -v /var/run/docker.sock:/var/run/docker.sock \ --name ucp \ {{ page.ucp_org }}/{{ page.ucp_repo }}:{{ page.ucp_version }} uninstall-ucp --interactive @@ -49,6 +58,8 @@ in the swarm won't be able to communicate at all. To fix this, either reinstall UCP before the certificates expire or disable swarm mode by running `docker swarm leave --force` on every node. -## Where to go next +{% elsif include.version=="ucp-2.2" %} -* [Join nodes to your cluster](../configure/join-nodes/index.md) +Learn about [uninstalling UCP](/datacenter/ucp/2.2/guides/admin/install/uninstall.md). + +{% endif %} diff --git a/datacenter/ucp/3.0/guides/admin/install/upgrade-offline.md b/datacenter/ucp/3.0/guides/admin/install/upgrade-offline.md index 7f4920d0db..6b534ccc6d 100644 --- a/datacenter/ucp/3.0/guides/admin/install/upgrade-offline.md +++ b/datacenter/ucp/3.0/guides/admin/install/upgrade-offline.md @@ -2,7 +2,18 @@ title: Upgrade UCP offline description: Learn how to upgrade Docker Universal Control Plane on a machine with no internet access. keywords: ucp, upgrade, offline +ui_tabs: +- version: ucp-3.0 + orhigher: true +- version: ucp-2.2 + orlower: true +next_steps: +- path: upgrade/ + title: Upgrade UCP +- path: ../../release-notes/ + title: Release Notes --- +{% if include.version=="ucp-3.0" %} Upgrading Universal Control Plane is the same, whether your hosts have access to the internet or not. @@ -55,8 +66,8 @@ For each machine that you want to manage with UCP: Now that the offline hosts have all the images needed to upgrade UCP, you can [upgrade Docker UCP](upgrade.md). +{% elsif include.version=="ucp-2.2" %} -## Where to go next +Learn about [upgrading UCP offline](/datacenter/ucp/2.2/guides/admin/install/upgrade-offline.md). -* [Upgrade UCP](upgrade.md) -* [Release Notes](release-notes.md) +{% endif %} diff --git a/datacenter/ucp/3.0/guides/admin/install/upgrade.md b/datacenter/ucp/3.0/guides/admin/install/upgrade.md index 306e115b23..5e59581687 100644 --- a/datacenter/ucp/3.0/guides/admin/install/upgrade.md +++ b/datacenter/ucp/3.0/guides/admin/install/upgrade.md @@ -2,7 +2,16 @@ title: Upgrade to UCP 3.0 description: Learn how to upgrade Docker Universal Control Plane with minimal impact to your users. keywords: UCP, upgrade, update +ui_tabs: +- version: ucp-3.0 + orhigher: true +- version: ucp-2.2 + orlower: true +next_steps: +- path: ../../release-notes/ + title: UCP release notes --- +{% if include.version=="ucp-3.0" %} This page guides you in upgrading Docker Universal Control Plane (UCP) to version {{ page.ucp_version }}. @@ -86,9 +95,9 @@ To upgrade from the CLI, log into a UCP manager node using ssh, and run: ``` # Get the latest version of UCP -$ docker image pull {{ page.ucp_org }}/{{ page.ucp_repo }}:{{ page.ucp_version }} +docker image pull {{ page.ucp_org }}/{{ page.ucp_repo }}:{{ page.ucp_version }} -$ docker container run --rm -it \ +docker container run --rm -it \ --name ucp \ -v /var/run/docker.sock:/var/run/docker.sock \ {{ page.ucp_org }}/{{ page.ucp_repo }}:{{ page.ucp_version }} \ @@ -101,6 +110,8 @@ for any necessary configuration values. Once the upgrade finishes, navigate to the UCP web UI and make sure that all the nodes managed by UCP are healthy. -## Where to go next +{% elsif include.version=="ucp-2.2" %} -* [UCP release notes](../../release-notes/index.md) +Learn about [upgrading UCP](/datacenter/ucp/2.2/guides/admin/install/upgrade.md). + +{% endif %}