Formatting improvements for installation docs

This commit is contained in:
Misty Stanley-Jones 2017-12-12 14:39:29 -08:00 committed by Misty Stanley-Jones
parent e2f96cf4b8
commit d313d546b1
5 changed files with 112 additions and 59 deletions

View File

@ -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

View File

@ -103,7 +103,12 @@ from the repository.
2. Install packages to allow `apt` to use a repository over HTTPS:
**Jessie or Stretch**:
<ul class="nav nav-tabs">
<li class="active"><a data-toggle="tab" data-target="#jessie">Jessie or newer</a></li>
<li><a data-toggle="tab" data-target="#wheezy">Wheezy or older</a></li>
</ul>
<div class="tab-content">
<div id="jessie" class="tab-pane fade in active" markdown="1">
```bash
$ sudo apt-get install \
@ -114,7 +119,8 @@ from the repository.
software-properties-common
```
**Wheezy**:
</div>
<div id="wheezy" class="tab-pane fade" markdown="1">
```bash
$ sudo apt-get install \
@ -124,6 +130,9 @@ from the repository.
python-software-properties
```
</div>
</div> <!-- tab-content -->
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**:
<ul class="nav nav-tabs">
<li class="active"><a data-toggle="tab" data-target="#x86_64_repo">x86_64 / amd64</a></li>
<li><a data-toggle="tab" data-target="#armhf_repo">armhf</a></li>
</ul>
<div class="tab-content">
<div id="x86_64_repo" class="tab-pane fade in active" markdown="1">
```bash
$ sudo add-apt-repository \
@ -164,7 +178,8 @@ from the repository.
stable"
```
**armhf**:
</div>
<div id="armhf_repo" class="tab-pane fade" markdown="1">
```bash
$ echo "deb [arch=armhf] {{ download-url-base }} \
@ -172,6 +187,9 @@ from the repository.
sudo tee /etc/apt/sources.list.d/docker.list
```
</div>
</div> <!-- tab-content -->
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

View File

@ -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**:
<ul class="nav nav-tabs">
<li class="active"><a data-toggle="tab" data-target="#x86_64_repo">x86_64 / amd64</a></li>
<li><a data-toggle="tab" data-target="#armhf">armhf</a></li>
<li><a data-toggle="tab" data-target="#s390x_repo">IBM Z (s390x)</a></li>
</ul>
<div class="tab-content">
<div id="x86_64_repo" class="tab-pane fade in active" markdown="1">
```bash
$ sudo add-apt-repository \
@ -180,7 +187,8 @@ the repository.
stable"
```
**armhf**:
</div>
<div id="armhf" class="tab-pane fade" markdown="1">
```bash
$ sudo add-apt-repository \
@ -189,7 +197,8 @@ the repository.
stable"
```
**s390x**:
</div>
<div id="s390x_repo" class="tab-pane fade" markdown="1">
```bash
$ sudo add-apt-repository \
@ -198,6 +207,9 @@ the repository.
stable"
```
</div>
</div> <!-- tab-content -->
> **Note**: Starting with Docker 17.06, stable releases are also pushed to
> the **edge** and **test** repositories.

View File

@ -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 `<DOCKER-EE-URL>`
with the URL you noted down in the [prerequisites](#prerequisites).
**x86_64**:
```bash
$ DOCKER_EE_URL="<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.
<ul class="nav nav-tabs">
<li class="active"><a data-toggle="tab" data-target="#x86_64_repo">x86_64 / amd64</a></li>
<li><a data-toggle="tab" data-target="#s390x_repo">IBM Z (s390x)</a></li>
<li><a data-toggle="tab" data-target="#ppc64le_repo">IBM Power (ppc64le)</a></li>
</ul>
<div class="tab-content">
<div id="x86_64_repo" class="tab-pane fade in active" markdown="1">
```bash
$ sudo zypper addrepo \
<DOCKER-EE-URL>/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**:
</div>
<div id="s390x_repo" class="tab-pane fade" markdown="1">
```bash
$ sudo zypper addrepo \
<DOCKER-EE-URL>/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**:
</div>
<div id="ppc64le_repo" class="tab-pane fade" markdown="1">
```bash
$ sudo zypper addrepo \
<DOCKER-EE-URL>/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.
</div>
</div><!--tab-content-->
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 <DOCKER-EE-URL/sles/gpg
$ sudo rpm --import "${DOCKER_EE_URL}/sles/gpg"
```
#### Install Docker EE

View File

@ -147,15 +147,24 @@ from the repository.
software-properties-common
```
3. Add Docker's official GPG key using your customer Docker EE repository URL:
3. Temporarily add a `$DOCKER_EE_URL` variable into your environment. This will
only persist until you log out of the session. Replace `<DOCKER-EE-URL>`
with the URL you noted down in the [prerequisites](#prerequisites).
```bash
$ curl -fsSL <DOCKER-EE-URL>/ubuntu/gpg | sudo apt-key add -
$ DOCKER_EE_URL="<DOCKER-EE-URL>"
```
4. Add Docker's official GPG key using your customer Docker EE repository URL:
```bash
$ 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
`<DOCKER-EE-URL>` 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**:
<ul class="nav nav-tabs">
<li class="active"><a data-toggle="tab" data-target="#x86_64_repo">x86_64 / amd64</a></li>
<li><a data-toggle="tab" data-target="#s390x_repo">IBM Z (s390x)</a></li>
<li><a data-toggle="tab" data-target="#ppc64el_repo">IBM Power (ppc64el)</a></li>
</ul>
<div class="tab-content">
<div id="x86_64_repo" class="tab-pane fade in active" markdown="1">
```bash
$ sudo add-apt-repository \
"deb [arch=amd64] <DOCKER-EE-URL>/ubuntu \
"deb [arch=amd64] $DOCKER_EE_URL/ubuntu \
$(lsb_release -cs) \
stable-{{ site.docker_ee_version }}"
```
**s390x**:
</div>
<div id="s390x_repo" class="tab-pane fade" markdown="1">
```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**:
</div>
<div id="ppc64el_repo" class="tab-pane fade" markdown="1">
```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 }}"
```
</div>
</div> <!-- tab-content -->
#### Install Docker EE