Merge remote-tracking branch 'docker.github.io/master'

This commit is contained in:
root 2020-01-21 21:00:27 +00:00
commit b3efebff8f
1 changed files with 53 additions and 83 deletions

View File

@ -13,31 +13,28 @@ toc_max: 4
>{% include enterprise_label_shortform.md %} >{% include enterprise_label_shortform.md %}
To get started with Docker Engine - Enterprise on Ubuntu, make sure you > **Important**
[meet the prerequisites](#prerequisites), then >
[install Docker](#install-docker-ee). > Docker Engine - Community users should go to
[Get Docker Engine - Community for Ubuntu](/install/linux/docker-ce/ubuntu.md)
**instead of this topic**.
{: .important}
## Prerequisites ## Prerequisites
Docker Engine - Community users should go to Confirm that all prerequisites are met before installing Docker Engine - Enterprise on Ubuntu.
[Get Docker Engine - Community for Ubuntu](/install/linux/docker-ce/ubuntu.md)
**instead of this topic**.
To install Docker Engine - Enterprise, you need to know the Docker Engine - The product URL associated with your trial or subscription is required to install Docker Engine - Enterprise, which can be attained using the following procedure (note that these instructions apply to Docker on Ubuntu and for Docker on Linux, which includes access to Docker Engine - Enterprise for all Linux distributions):
Enterprise repository URL associated with your trial or subscription. These
instructions work for Docker on Ubuntu and for Docker on Linux, which includes
access to Docker Engine - Enterprise for all Linux distributions. To get this
information, do the following:
- Go to [https://hub.docker.com/my-content](https://hub.docker.com/my-content). 1. Go to [https://hub.docker.com/my-content](https://hub.docker.com/my-content).
- Each subscription or trial you have access to is listed. Click the **Setup** 2. Each subscription or trial you have access to is listed. Click the **Setup**
button for **Docker Enterprise Edition for Ubuntu**. button for **Docker Enterprise Edition for Ubuntu**.
- Copy the URL from the field labeled 3. Copy the URL from the field labeled
**Copy and paste this URL to download your Edition**. **Copy and paste this URL to download your Edition**.
Use this URL when you see the placeholder text `<DOCKER-EE-URL>`. Use this URL when you see the placeholder text `<DOCKER-EE-URL>`.
To learn more about Docker Enterprise, see To learn more about Docker Engine - Enterprise, see
[Docker Enterprise Edition](https://www.docker.com/enterprise-edition/){: target="_blank" class="_" }. [Docker Enterprise Edition](https://www.docker.com/enterprise-edition/){: target="_blank" class="_" }.
### OS requirements ### OS requirements
@ -45,51 +42,37 @@ To learn more about Docker Enterprise, see
To learn more about software requirements and supported storage drivers, To learn more about software requirements and supported storage drivers,
check the [compatibility matrix](https://success.docker.com/article/compatibility-matrix). check the [compatibility matrix](https://success.docker.com/article/compatibility-matrix).
> **Note:** > **Note**
>
> IBM Z (`s390x`) is supported for Docker Engine - Enterprise 17.06.xx only. > IBM Z (`s390x`) is supported for Docker Engine - Enterprise 17.06.xx only.
### Uninstall old versions ### Uninstall old versions
Older versions of Docker were called `docker` or `docker-engine`. In addition, Use the `apt-get remove` command to uninstall older versions of Docker Engine - Enterprise (called `docker` or `docker-engine`). In addition,
if you are upgrading from Docker Engine - Community to Docker Engine - if you are upgrading from Docker Engine - Community to Docker Engine - Enterprise, remove the Docker Engine - Community package.
Enterprise, remove the Docker Engine - Community package.
```bash ```bash
$ sudo apt-get remove docker docker-engine docker-ce docker-ce-cli docker.io $ sudo apt-get remove docker docker-engine docker-ce docker-ce-cli docker.io
``` ```
It's OK if `apt-get` reports that none of these packages are installed. The `apt-get` command may report that none of the packages are installed.
The contents of `/var/lib/docker/`, including images, containers, volumes, and > **Note**
networks, are preserved. The Docker Engine - Enterprise package is now called >
`docker-ee`. > The contents of `/var/lib/docker/`, including images, containers, volumes, and networks, are preserved. The Docker Engine - Enterprise package is now called `docker-ee`.
#### Extra steps for aufs #### Extra steps for aufs
For Ubuntu 16.04 and higher, the Linux kernel includes support for overlay2, For Ubuntu 16.04 and higher, the Linux kernel includes support for overlay2,
and Docker Engine - Enterprise uses it as the default storage driver. If you and Docker Engine - Enterprise uses it as the default storage driver. If you need to use [aufs](/engine/userguide/storagedriver/aufs-driver.md) instead, be aware that it must be manually configured.
need to use `aufs` instead, you need to configure it manually.
See [aufs](/engine/userguide/storagedriver/aufs-driver.md).
## Install Docker Engine - Enterprise ## Install Docker Engine - Enterprise
You can install Docker Engine - Enterprise in different ways, depending on your Docker Engine - Enterprise can be installed either via [Docker repositories](#install-using-the-repository), or by downloading and installing the DEB package and thereafter manually managing all upgrades. The Docker repository method is recommended, for the ease it lends in terms of both installation and upgrade tasks. The more manual DEB package approach, however, is useful in certain situations, such as installing Docker on air-gapped system that have no access to the Internet.
needs.
- Most users
[set up Docker's repositories](#install-using-the-repository) and install
from them, for ease of installation and upgrade tasks. This is the
recommended approach.
- Some users download the DEB package and install it manually and manage
upgrades completely manually. This is useful in situations such as installing
Docker on air-gapped systems with no access to the internet.
### Install using the repository ### Install using the repository
Before you install Docker Engine - Enterprise for the first time on a new host Naturally, to install Docker Engine - Enterprise on a new host machine using the Docker repository you must first set the repository up on the machine.
machine, you need to set up the Docker repository. Afterward, you can install
and update Docker Engine - Enterprise from the repository.
#### Set up the repository #### Set up the repository
@ -109,9 +92,7 @@ and update Docker Engine - Enterprise from the repository.
software-properties-common software-properties-common
``` ```
3. Temporarily add a `$DOCKER_EE_URL` variable into your environment. This 3. Temporarily add a `$DOCKER_EE_URL` variable into your environment (it persists only up until you log out of the session). Replace `<DOCKER-EE-URL>` with the URL you noted down in the [prerequisites](#prerequisites).
only persists until you log out of the session. Replace `<DOCKER-EE-URL>`
with the URL you noted down in the [prerequisites](#prerequisites).
```bash ```bash
$ DOCKER_EE_URL="<DOCKER-EE-URL>" $ DOCKER_EE_URL="<DOCKER-EE-URL>"
@ -119,19 +100,19 @@ and update Docker Engine - Enterprise from the repository.
4. Temporarily add a `$DOCKER_EE_VERSION` variable into your environment. 4. Temporarily add a `$DOCKER_EE_VERSION` variable into your environment.
> **Note:** If you need to run Docker Enterprise 2.0, please see the
> following instructions:
> * [18.09](https://docs.docker.com/v18.09/ee/supported-platforms/) - Docker
> Enterprise Edition 2.1 (Docker Engine, UCP, and DTR).
> * [18.03](https://docs.docker.com/v18.03/ee/supported-platforms/) - Older
> Docker Engine - Enterprise only release
> * [17.06](https://docs.docker.com/v17.06/engine/installation/) - Docker
> Enterprise Edition 2.0 (Docker Engine, UCP, and DTR).
```bash ```bash
$ DOCKER_EE_VERSION={{ site.docker_ee_version }} $ DOCKER_EE_VERSION={{ site.docker_ee_version }}
``` ```
> **Note**
>
> If you need to run Docker Enterprise 2.0, refer to the following:
> * [18.09](https://docs.docker.com/v18.09/ee/supported-platforms/) - Docker
> Enterprise Edition 2.1 (Docker Engine, UCP, and DTR).
> * [18.03](https://docs.docker.com/v18.03/ee/supported-platforms/) - Older
> Docker Engine - Enterprise only release
> * [17.06](https://docs.docker.com/v17.06/engine/installation/) - Docker
> Enterprise Edition 2.0 (Docker Engine, UCP, and DTR).
5. Add Docker's official GPG key using your customer Docker Engine - Enterprise 5. Add Docker's official GPG key using your customer Docker Engine - Enterprise
repository URL. repository URL.
@ -139,7 +120,7 @@ and update Docker Engine - Enterprise from the repository.
$ curl -fsSL "${DOCKER_EE_URL}/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 6. Verify that you now have the key with the fingerprint
`DD91 1E99 5A64 A202 E859 07D6 BC14 F10B 6D08 5F96`, by searching for the `DD91 1E99 5A64 A202 E859 07D6 BC14 F10B 6D08 5F96`, by searching for the
last eight characters of the fingerprint. Use the command as-is. It works last eight characters of the fingerprint. Use the command as-is. It works
because of the variable you set earlier. because of the variable you set earlier.
@ -153,12 +134,7 @@ and update Docker Engine - Enterprise from the repository.
sub 4096R/6D085F96 2017-02-22 sub 4096R/6D085F96 2017-02-22
``` ```
6. Use the following command to set up the **stable** repository. Use the 7. Set up the **stable** repository, using the following command as-is (which works due to the variable set up earlier in the process).
command as-is. It works 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`.
>
```bash ```bash
$ sudo add-apt-repository \ $ sudo add-apt-repository \
@ -166,7 +142,11 @@ and update Docker Engine - Enterprise from the repository.
$(lsb_release -cs) \ $(lsb_release -cs) \
stable-$DOCKER_EE_VERSION" stable-$DOCKER_EE_VERSION"
``` ```
> **Note**
>
> The included `lsb_release -cs` sub command returns the name of your
> Ubuntu distribution, for example, `xenial`.
#### Install Docker Engine - Enterprise #### Install Docker Engine - Enterprise
1. Update the `apt` package index. 1. Update the `apt` package index.
@ -175,27 +155,23 @@ and update Docker Engine - Enterprise from the repository.
$ sudo apt-get update $ sudo apt-get update
``` ```
2. Install the latest version of Docker Engine - Enterprise, or go to the next 2. Install the latest version of Docker Engine - Enterprise and containerd, or go to the next step to install a specific version. Any existing installation of Docker is replaced.
step to install a specific version. Any existing installation of Docker is
replaced.
Use this command to install the latest version of Docker Engine - Enterprise
and containerd:
```bash ```bash
$ sudo apt-get install docker-ee docker-ee-cli containerd.io $ sudo apt-get install docker-ee docker-ee-cli containerd.io
``` ```
> **Warning:** If you have multiple Docker repositories enabled, installing > **Warning**
>
> If you have multiple Docker repositories enabled, installing
> or updating without specifying a version in the `apt-get install` or > or updating without specifying a version in the `apt-get install` or
> `apt-get update` command always installs the highest possible version, > `apt-get update` command always installs the highest possible version,
> which may not be appropriate for your stability needs. > which may not be appropriate for your stability needs.
{:.warning} {:.warning}
3. On production systems, you should install a specific version of Docker 3. On production systems, you should install a specific version of Docker
Engine - Enterprise instead of always using the latest. This output is Engine - Enterprise instead of always using the latest. The following output is truncated.
truncated. List the available versions.
```bash ```bash
$ apt-cache madison docker-ee $ apt-cache madison docker-ee
@ -207,14 +183,12 @@ and update Docker Engine - Enterprise from the repository.
suffix on the version, in this example). Choose a specific version to suffix on the version, in this example). Choose a specific version to
install. The second column is the version string. The third column is the install. The second column is the version string. The third column is the
repository name, which indicates which repository the package is from and repository name, which indicates which repository the package is from and
by extension its stability level. To install a specific version, append the by extension its stability level. To install a specific version, append the version string to the package name and separate them by an equals sign
version string to the package name and separate them by an equals sign
(`=`). (`=`).
```bash ```bash
$ sudo apt-get install docker-ee=<VERSION_STRING> docker-ee-cli=<VERSION_STRING> containerd.io $ sudo apt-get install docker-ee=<VERSION_STRING> docker-ee-cli=<VERSION_STRING> containerd.io
``` ```
The Docker daemon starts automatically. The Docker daemon starts automatically.
4. Verify that Docker is installed correctly by running the `hello-world` 4. Verify that Docker is installed correctly by running the `hello-world`
@ -235,8 +209,6 @@ configuration steps.
#### Upgrade Docker Engine - Enterprise #### Upgrade Docker Engine - Enterprise
To upgrade Docker Engine - Enterprise, follow the steps below:
1. If upgrading to a new major Docker Engine - Enterprise version (such as when 1. If upgrading to a new major Docker Engine - Enterprise version (such as when
going from Docker 18.03.x to Docker 18.09.x), going from Docker 18.03.x to Docker 18.09.x),
[add the new repository](#set-up-the-repository){: target="_blank" class="_" }. [add the new repository](#set-up-the-repository){: target="_blank" class="_" }.
@ -255,12 +227,10 @@ need to download a new file or set of files each time you want to upgrade Docker
Engine - Enterprise. Engine - Enterprise.
1. Go to the Docker Engine - Enterprise repository URL associated with your 1. Go to the Docker Engine - Enterprise repository URL associated with your
trial or subscription in your browser. Go to trial or subscription in your browser. Go to `/ubuntu/dists/bionic/pool/stable-<VERSION>/amd64/` and download the `.deb` file for the Ubuntu release, Docker EE version, and architecture you want to install.
`ubuntu/dists/<distribution>/pool/stable-<VERSION>` and download the `.deb`
file(s) for the Docker Engine - Enterprise version and architecture you want
to install.
> **Note:** > **Note**
>
> Starting with 19.03, you have to download three `.deb` files. They > Starting with 19.03, you have to download three `.deb` files. They
> are `docker-ee-cli_<version>.deb`, `containerd.io_<version>.deb`, and > are `docker-ee-cli_<version>.deb`, `containerd.io_<version>.deb`, and
> `docker-ee_<version>.deb`. > `docker-ee_<version>.deb`.
@ -314,7 +284,7 @@ new file.
``` ```
2. Images, containers, volumes, or customized configuration files on your host 2. Images, containers, volumes, or customized configuration files on your host
are not automatically removed. To delete all images, containers, and are not automatically removed. Run the following command to delete all images, containers, and
volumes. volumes.
```bash ```bash