From 067ed434c3fbe396f2956aa2e9bf93d03d2d534b Mon Sep 17 00:00:00 2001 From: Joao Fernandes Date: Fri, 27 May 2016 11:53:38 -0700 Subject: [PATCH] Updates install docs for CSE Updates install docs from 1.10 to 1.11. --- cs-engine/install.md | 93 ++++++++++++++------------------------------ cs-engine/upgrade.md | 72 +++++++++++++++++----------------- 2 files changed, 64 insertions(+), 101 deletions(-) diff --git a/cs-engine/install.md b/cs-engine/install.md index 8d8500ecd9..8404b7da9d 100644 --- a/cs-engine/install.md +++ b/cs-engine/install.md @@ -15,34 +15,18 @@ weight=0 # Install CS Docker Engine -This document describes the process of installing the commercially supported -Docker Engine (CS Engine). Installing the CS Engine is a prerequisite for -installing Docker Trusted Registry and/or the Universal Control Plane (UCP). -Follow these instructions if you are installing the CS Engine on physical or -cloud infrastructures. +Follow these instructions to install CS Docker Engine, the commercially +supported version of Docker Engine. + +CS Docker Engine can be installed on the following operating systems: -You first install the CS Engine before you install Docker Trusted Registry. -However, if you are upgrading, you reverse that order and upgrade the Trusted -Registry first. To upgrade, see the [upgrade documentation](upgrade.md). -You will need to install the latest version of the CS Engine to run with the -latest version of the Trusted Registry. You will also want to install the -CS Engine on -any clients, especially in your production environment. - -If your cloud provider is AWS, you have the option of installing the CS Engine -using an Amazon Machine Image (AMI). For more information, read -the [installation overview](index.md) to understand your options. - -The CS Engine is supported on the following operating systems: - - -* [CentOS 7.1/7.2 & RHEL 7.0/7.1 (YUM-based systems)](#install-on-centos-7-1-rhel-7-0-7-1-yum-based-systems) +* [CentOS 7.1/7.2 & RHEL 7.0/7.1 (YUM-based systems)](#install-on-centos-7-1-7-2-rhel-7-0-7-1-yum-based-systems) * [Ubuntu 14.04 LTS](#install-on-ubuntu-14-04-lts) * [SUSE Linux Enterprise 12](#install-on-suse-linux-enterprise-12-3) -## Install CentOS 7.1/7.2 & RHEL 7.0/7.1 (YUM-based systems) +## Install on CentOS 7.1/7.2 & RHEL 7.0/7.1 (YUM-based systems) This section explains how to install on CentOS 7.1/7.2 & RHEL 7.0/7.1. Only these versions are supported. CentOS 7.0 is **not** supported. On RHEL, @@ -51,7 +35,7 @@ to update its RHEL kernel. 1. Log into the system as a user with root or sudo permissions. -2. Add Docker's public key for CS packages: +2. Add the Docker public key for CS packages: ```bash $ sudo rpm --import "https://sks-keyservers.net/pks/lookup?op=get&search=0xee6d536cf7dc86e2d7d56f59a178ac6c6238f52e" @@ -63,55 +47,35 @@ to update its RHEL kernel. $ sudo yum install -y yum-utils ``` -4. Add the repository. Notice in the following code that it gets the latest -version of the CS Engine. Each time you either install or upgrade, ensure that -you are requesting the version and the OS that you want. - +4. Add the Docker repository: ```bash - $ sudo yum-config-manager --add-repo https://packages.docker.com/1.10/yum/repo/main/centos/7 + $ sudo yum-config-manager --add-repo https://packages.docker.com/1.11/yum/repo/main/centos/7 ``` -5. Install the CS Engine with the following command: + This adds the repository of the latest version of CS Docker Engine. You can + customize the URL to install an older version. + +5. Install Docker CS Engine: ```bash $ sudo yum install docker-engine ``` -6. Enable the Docker daemon as a service and then start it. +6. Enable the Docker daemon as a service and start it. ```bash $ sudo systemctl enable docker.service $ sudo systemctl start docker.service ``` -7. Verify the installation was successful by running a simple container. +7. Confirm the Docker daemon is running: - $ sudo docker run hello-world - Unable to find image 'hello-world:latest' locally - latest: Pulling from hello-world - b901d36b6f2fd75: Pull complete - 0a6ba66e537a53a: Pull complete - hello-world:latest: The image you are pulling has been verified. Important: image verification is a tech preview feature and should not be relied on to provide security. - Digest: sha256:517f03be3f8169d84711c9ffb2b3235a4d27c1eb4ad147f6248c8040adb93113 - Status: Downloaded newer image for hello-world:latest + ```bash + $ sudo docker info + ``` - Hello from Docker. - This message shows that your installation appears to be working correctly. - - To generate this message, Docker took the following steps: - 1. The Docker client contacted the Docker daemon. - 2. The Docker daemon pulled the "hello-world" image from the Docker Hub. - 3. The Docker daemon created a new container from that image which runs the - executable that produces the output you are currently reading. - 4. The Docker daemon streamed that output to the Docker client, which sent it - to your terminal. - - To try something more ambitious, you can run an Ubuntu container with: - $ docker run -it ubuntu bash - - -8. (Optional) Add non-sudo access to the Docker socket by adding your user +8. Optionally, add non-sudo access to the Docker socket by adding your user to the `docker` group. ```bash @@ -148,11 +112,12 @@ to the `docker` group. 5. Add the repository for the new version: ```bash - $ echo "deb https://packages.docker.com/1.10/apt/repo ubuntu-trusty main" | sudo tee /etc/apt/sources.list.d/docker.list + $ echo "deb https://packages.docker.com/1.11/apt/repo ubuntu-trusty main" | sudo tee /etc/apt/sources.list.d/docker.list ``` - You must modify the "ubuntu-trusty" string for your flavor of ubuntu or - debian as seen in the following options: + This adds the repository of the latest version of CS Docker Engine for the + Ubuntu Trusty distribution. Change the "ubuntu-trusty" string to the + distribution you're using: * debian-jessie (Debian 8) * debian-stretch (future release) @@ -191,22 +156,22 @@ user to the `docker` group. 1. Log into the system as a user with root or sudo permissions. 2. Refresh your repository so that curl commands and CA certificates -are available. +are available: ```bash $ sudo zypper ref ``` -3. Add the repository and the signing key. Notice in the following code -that it gets the latest version of the CS Engine. Each time you either -install or upgrade, ensure that the you are requesting the version and the -OS that you want. +3. Add the Docker repository and public key: ```bash - $ sudo zypper ar -t YUM https://packages.docker.com/1.10/yum/repo/main/opensuse/12.3 docker-1.10 + $ sudo zypper ar -t YUM https://packages.docker.com/1.11/yum/repo/main/opensuse/12.3 docker-1.11 $ sudo rpm --import 'https://sks-keyservers.net/pks/lookup?op=get&search=0xee6d536cf7dc86e2d7d56f59a178ac6c6238f52e' ``` + This adds the repository of the latest version of CS Docker Engine. You can + customize the URL to install an older version. + 4. Install the Docker daemon package: ```bash diff --git a/cs-engine/upgrade.md b/cs-engine/upgrade.md index 22bde6620e..5dbe0670e5 100644 --- a/cs-engine/upgrade.md +++ b/cs-engine/upgrade.md @@ -12,25 +12,23 @@ weight=10 # Upgrade CS Docker Engine -This article explains how to upgrade your CS Docker Engine installation. -Before starting the upgrade, make sure all containers running on that CS -Docker Engine are stopped. +This article explains how to upgrade your CS Docker Engine. -The way you upgrade your CS Docker Engine, depends on the version that is -currently installed and the version that you want to upgrade to: +The upgrade process depends on the version that is currently installed and the +version that you want to upgrade to: -* [Upgrade from the same minor version](#upgrade-from-the-same-minor-version), if -you're upgrading from 1.10 to 1.10.x, -* [Upgrade from the same major version](#upgrade-from-the-same-major-version), if -you're upgrading from 1.9 to 1.10, -* [Upgrade from a legacy version](#upgrade-from-a-legacy-version), if you're -upgrading from a version prior to 1.9. +* [Upgrade from the same minor version](#upgrade-from-the-same-minor-version) +* [Upgrade from the same major version](#upgrade-from-the-same-major-version) +* [Upgrade from a legacy version](#upgrade-from-a-legacy-version) +Before starting the upgrade, make sure you stop all containers running on the +host. This ensures your containers have time for cleaning up before exiting, +thus avoiding data loss or corruption. ## Upgrade from the same minor version Use these instructions if you're upgrading your CS Docker Engine within the -same minor version. As an example, from 1.10.0 to 1.10.1. +same minor version. As an example, from 1.1.0 to 1.1.1. ### CentOS 7.1 & RHEL 7.0/7.1 Use these instructions to upgrade YUM-based systems. @@ -41,7 +39,7 @@ Use these instructions to upgrade YUM-based systems. $ sudo yum upgrade docker-engine ``` -2. Check that the CS Engine is running: +2. Check that the CS Docker Engine is running: ```bash $ sudo docker info @@ -56,7 +54,7 @@ Use these instructions to upgrade APT-based systems. $ sudo apt-get update && sudo apt-get upgrade docker-engine ``` -2. Check that the CS Engine is running: +2. Check that the CS Docker Engine is running: ```bash $ sudo docker info @@ -70,7 +68,7 @@ Use these instructions to upgrade APT-based systems. $ sudo zypper upgrade docker-engine ``` -2. Check that the CS Engine is running: +2. Check that the CS Docker Engine is running: ```bash $ sudo docker info @@ -80,20 +78,20 @@ Use these instructions to upgrade APT-based systems. ## Upgrade from the same major version Use these instructions if you're upgrading your CS Docker Engine within the -same major version. As an example, from 1.9 to 1.10. +same major version. As an example, from 1.1.x to 1.2.x. ### CentOS 7.1 & RHEL 7.0/7.1 Use these instructions to upgrade YUM-based systems. -1. Add the docker engine repository. +1. Add the Docker Engine repository. ```bash - $ sudo yum-config-manager --add-repo https://packages.docker.com/1.10/yum/repo/main/centos/7 + $ sudo yum-config-manager --add-repo https://packages.docker.com/1.11/yum/repo/main/centos/7 ``` - In this example we are adding the docker engine 1.10 repository. But sure - to add the repository of the version you want to install. + This adds the repository of the latest version of CS Docker Engine. You can + customize the URL to install other versions. 2. Install the new package: @@ -114,12 +112,12 @@ Use these instructions to update APT-based systems. 1. Add the docker engine repository. ```bash - $ echo "deb https://packages.docker.com/1.10/apt/repo ubuntu-trusty main" | sudo tee /etc/apt/sources.list.d/docker.list + $ echo "deb https://packages.docker.com/1.11/apt/repo ubuntu-trusty main" | sudo tee /etc/apt/sources.list.d/docker.list ``` - In this example we are adding the docker engine ubuntu-trusty 1.10 - repository. Be sure to use the Docker Engine version you want to upgrade to, - and your linux distribution. The following distributions are available: + This adds the repository of the latest version of CS Docker Engine for the + Ubuntu Trusty distribution. Change the "ubuntu-trusty" string to the + distribution you're using: * debian-jessie (Debian 8) * debian-stretch (future release) @@ -147,11 +145,11 @@ Use these instructions to update APT-based systems. 1. Add the docker engine repository. ```bash - $ sudo zypper ar -t YUM https://packages.docker.com/1.10/yum/repo/main/opensuse/12.3 docker-1.10 + $ sudo zypper ar -t YUM https://packages.docker.com/1.11/yum/repo/main/opensuse/12.3 docker-1.11 ``` - In this example we are adding the CS Docker Engine 1.0 repository. - Be sure to use the Docker Engine version you want to upgrade to. + This adds the repository of the latest version of CS Docker Engine. You + can customize the URL to install other versions. 2. Install the new package: @@ -181,7 +179,7 @@ Use these instructions to upgrade YUM-based systems. $ sudo yum remove docker-engine-cs ``` -2. Add Docker's public key for CS packages: +2. Add the Docker public key for CS packages: ```bash $ sudo rpm --import "https://sks-keyservers.net/pks/lookup?op=get&search=0xee6d536cf7dc86e2d7d56f59a178ac6c6238f52e" @@ -196,12 +194,12 @@ Use these instructions to upgrade YUM-based systems. 4. Add the repository for the new version and disable the old one. ```bash - $ sudo yum-config-manager --add-repo https://packages.docker.com/1.10/yum/repo/main/centos/7 + $ sudo yum-config-manager --add-repo https://packages.docker.com/1.11/yum/repo/main/centos/7 $ sudo yum-config-manager --disable 'Docker_cs*' ``` - In this example we are adding the CS Docker Engine 1.0 repository. - Be sure to use the Docker Engine version you want to upgrade to. + This adds the repository of the latest version of CS Docker Engine. You + can customize the URL to install other versions. 5. Install the new package: @@ -211,7 +209,7 @@ Use these instructions to upgrade YUM-based systems. 6. Enable the Docker daemon as a service and start it. - ``` + ```bash $ sudo systemctl enable docker.service $ sudo systemctl start docker.service ``` @@ -226,7 +224,7 @@ Use these instructions to update APT-based systems. $ sudo apt-get remove docker-engine-cs ``` -2. Add Docker's public key for CS packages: +2. Add the Docker public key for CS packages: ```bash $ curl -s 'https://sks-keyservers.net/pks/lookup?op=get&search=0xee6d536cf7dc86e2d7d56f59a178ac6c6238f52e' | sudo apt-key add --import @@ -249,12 +247,12 @@ Use these instructions to update APT-based systems. 5. Add the repository for the new version: ```bash - $ echo "deb https://packages.docker.com/1.10/apt/repo ubuntu-trusty main" | sudo tee /etc/apt/sources.list.d/docker.list + $ echo "deb https://packages.docker.com/1.11/apt/repo ubuntu-trusty main" | sudo tee /etc/apt/sources.list.d/docker.list ``` - In this example we are adding the docker engine ubuntu-trusty 1.10 - repository. Be sure to use the Docker Engine version you want to upgrade to, - and your linux distribution. The following distributions are available: + This adds the repository of the latest version of CS Docker Engine for the + Ubuntu Trusty distribution. Change the "ubuntu-trusty" string to the + distribution you're using: * debian-jessie (Debian 8) * debian-stretch (future release)