From d313d546b14cdbf47cadf2e42a79745fad341295 Mon Sep 17 00:00:00 2001 From: Misty Stanley-Jones Date: Tue, 12 Dec 2017 14:39:29 -0800 Subject: [PATCH] Formatting improvements for installation docs --- _includes/ee-linux-install-reuse.md | 42 ++++++------------ engine/installation/linux/docker-ce/debian.md | 26 +++++++++-- engine/installation/linux/docker-ce/ubuntu.md | 18 ++++++-- engine/installation/linux/docker-ee/suse.md | 43 ++++++++++++++----- engine/installation/linux/docker-ee/ubuntu.md | 42 ++++++++++++------ 5 files changed, 112 insertions(+), 59 deletions(-) diff --git a/_includes/ee-linux-install-reuse.md b/_includes/ee-linux-install-reuse.md index 41f3d391c3..e4b1a04702 100644 --- a/_includes/ee-linux-install-reuse.md +++ b/_includes/ee-linux-install-reuse.md @@ -176,29 +176,20 @@ You can install Docker EE in different ways, depending on your needs: users are added to the group. {% if linux-dist == "centos" or linux-dist == "rhel" or linux-dist == "oraclelinux" %} -3. If you need to use `devicemapper`, edit `/etc/docker/daemon.json`. If it - does not yet exist, create it. Assuming that the file was empty, add the - following contents. - - ```json - { - "storage-driver": "devicemapper" - } - ``` - -4. For production systems using `devicemapper`, you must use `direct-lvm` mode, - which requires you to prepare the block devices. Follow the procedure in the +3. If you need to use `devicemapper`, follow the procedure in the [devicemapper storage driver guide](/engine/userguide/storagedriver/device-mapper-driver.md#configure-direct-lvm-mode-for-production){: target="_blank" class="_" } - **before starting Docker**. + **before starting Docker**. For production systems using `devicemapper`, + you must use `direct-lvm` mode, + which requires you to prepare the block devices. {% endif %} -5. Start Docker. +4. Start Docker. ```bash $ sudo systemctl start docker ``` -6. Verify that Docker EE is installed correctly by running the `hello-world` +5. Verify that Docker EE is installed correctly by running the `hello-world` image. ```bash @@ -280,29 +271,20 @@ upgrade Docker EE. users are added to the group. {% if linux-dist == "centos" or linux-dist == "rhel" or linux-dist == "oraclelinux" %} -3. If you need to use `devicemapper`, edit `/etc/docker/daemon.json`. If it - does not yet exist, create it. Assuming that the file was empty, add the - following contents. - - ```json - { - "storage-driver": "devicemapper" - } - ``` - -4. For production systems using `devicemapper`, you must use `direct-lvm` mode, - which requires you to prepare the block devices. Follow the procedure in the +3. If you need to use `devicemapper`, follow the procedure in the [devicemapper storage driver guide](/engine/userguide/storagedriver/device-mapper-driver.md#configure-direct-lvm-mode-for-production){: target="_blank" class="_" } - **before starting Docker**. + **before starting Docker**. For production systems using `devicemapper`, + you must use `direct-lvm` mode, + which requires you to prepare the block devices. {% endif %} -5. Start Docker. +4. Start Docker. ```bash $ sudo systemctl start docker ``` -6. Verify that Docker EE is installed correctly by running the `hello-world` +5. Verify that Docker EE is installed correctly by running the `hello-world` image. ```bash diff --git a/engine/installation/linux/docker-ce/debian.md b/engine/installation/linux/docker-ce/debian.md index ced10b6031..526e647aff 100644 --- a/engine/installation/linux/docker-ce/debian.md +++ b/engine/installation/linux/docker-ce/debian.md @@ -103,7 +103,12 @@ from the repository. 2. Install packages to allow `apt` to use a repository over HTTPS: - **Jessie or Stretch**: + +
+
```bash $ sudo apt-get install \ @@ -114,7 +119,8 @@ from the repository. software-properties-common ``` - **Wheezy**: +
+
```bash $ sudo apt-get install \ @@ -124,6 +130,9 @@ from the repository. python-software-properties ``` +
+
+ 3. Add Docker's official GPG key: ```bash @@ -155,7 +164,12 @@ from the repository. To also add the **edge** repository, add `edge` after `stable` on the last line of the command. - **x86_64**: + +
+
```bash $ sudo add-apt-repository \ @@ -164,7 +178,8 @@ from the repository. stable" ``` - **armhf**: +
+
```bash $ echo "deb [arch=armhf] {{ download-url-base }} \ @@ -172,6 +187,9 @@ from the repository. sudo tee /etc/apt/sources.list.d/docker.list ``` +
+
+ 5. **Wheezy only**: The version of `add-apt-repository` on Wheezy adds a `deb-src` repository that does not exist. You need to comment out this repository or running `apt-get update` will fail. Edit `/etc/apt/sources.list`. Find the diff --git a/engine/installation/linux/docker-ce/ubuntu.md b/engine/installation/linux/docker-ce/ubuntu.md index 23d7ce8885..1b1d6a9477 100644 --- a/engine/installation/linux/docker-ce/ubuntu.md +++ b/engine/installation/linux/docker-ce/ubuntu.md @@ -171,7 +171,14 @@ the repository. > to your parent Ubuntu distribution. For example, if you are using > `Linux Mint Rafaela`, you could use `trusty`. - **amd64**: + + +
+
```bash $ sudo add-apt-repository \ @@ -180,7 +187,8 @@ the repository. stable" ``` - **armhf**: +
+
```bash $ sudo add-apt-repository \ @@ -189,7 +197,8 @@ the repository. stable" ``` - **s390x**: +
+
```bash $ sudo add-apt-repository \ @@ -198,6 +207,9 @@ the repository. stable" ``` +
+
+ > **Note**: Starting with Docker 17.06, stable releases are also pushed to > the **edge** and **test** repositories. diff --git a/engine/installation/linux/docker-ee/suse.md b/engine/installation/linux/docker-ee/suse.md index d5faf46268..9296d00560 100644 --- a/engine/installation/linux/docker-ee/suse.md +++ b/engine/installation/linux/docker-ee/suse.md @@ -165,37 +165,60 @@ from the repository. #### Set up the repository -1. Use the following command to set up the **stable** repository, using the - Docker EE repository URL you located in the [prerequisites](#prerequisites). +1. Temporarily add a `$DOCKER_EE_URL` variable into your environment. This will + only persist until you log out of the session. Replace `` + with the URL you noted down in the [prerequisites](#prerequisites). - **x86_64**: + ```bash + $ DOCKER_EE_URL="" + ``` + +2. Use the following command to set up the **stable** repository. Use the + command as-is. It will work because of the variable you set in the previous + step. + + +
+
```bash $ sudo zypper addrepo \ - /sles/12.3/x86_64/stable-{{ site.docker_ee_version }} \ + "${DOCKER_EE_URL}/sles/12.3/x86_64/stable-{{ site.docker_ee_version }}" \ docker-ee-stable ``` - **s390x**: +
+
```bash $ sudo zypper addrepo \ - /sles/12.3/s390x/stable-{{ site.docker_ee_version }} \ + "${DOCKER_EE_URL}/sles/12.3/s390x/stable-{{ site.docker_ee_version }}" \ docker-ee-stable ``` - **ppc64le**: +
+ +
```bash $ sudo zypper addrepo \ - /sles/12.3/ppc64le/stable-{{ site.docker_ee_version }} \ + "${DOCKER_EE_URL}/sles/12.3/ppc64le/stable-{{ site.docker_ee_version }}" \ docker-ee-stable ``` -2. Import the GPG key from the repository. +
+
+ + +3. Import the GPG key from the repository. Use the command as-is. It will work + because of the variable you set earlier. ```bash - $ sudo rpm --import ` + with the URL you noted down in the [prerequisites](#prerequisites). + + ```bash + $ DOCKER_EE_URL="" + ``` + +4. Add Docker's official GPG key using your customer Docker EE repository URL: ```bash - $ curl -fsSL /ubuntu/gpg | sudo apt-key add - + $ curl -fsSL "${DOCKER_EE_URL}/ubuntu/gpg" | sudo apt-key add - ``` Verify that you now have the key with the fingerprint `DD91 1E99 5A64 A202 E859 07D6 BC14 F10B 6D08 5F96`, by searching for the - last eight characters of the fingerprint. + last eight characters of the fingerprint. Use the command as-is. It will + work because of the variable you set earlier. ```bash $ sudo apt-key fingerprint 6D085F96 @@ -166,41 +175,50 @@ from the repository. sub 4096R/6D085F96 2017-02-22 ``` -4. Use the following command to set up the **stable** repository, replacing - `` with the URL you noted down in the - [prerequisites](#prerequisites). +5. Use the following command to set up the **stable** repository. Use the + command as-is. It will work because of the variable you set earlier. > **Note**: The `lsb_release -cs` sub-command below returns the name of your > Ubuntu distribution, such as `xenial`. > - **x86_64**: + +
+
```bash $ sudo add-apt-repository \ - "deb [arch=amd64] /ubuntu \ + "deb [arch=amd64] $DOCKER_EE_URL/ubuntu \ $(lsb_release -cs) \ stable-{{ site.docker_ee_version }}" ``` - **s390x**: +
+
```bash $ sudo add-apt-repository \ - "deb [arch=s390x] {{ download-url-base }} \ + "deb [arch=s390x] $DOCKER_EE_URL/ubuntu \ $(lsb_release -cs) \ stable-{{ site.docker_ee_version }}" ``` - **ppc64el**: +
+
```bash $ sudo add-apt-repository \ - "deb [arch=ppc64el] {{ download-url-base }} \ + "deb [arch=ppc64el] $DOCKER_EE_URL/ubuntu \ $(lsb_release -cs) \ stable-{{ site.docker_ee_version }}" ``` +
+
#### Install Docker EE