Fixes wrong instruction on upgrade docs

Fixed an instruction that was pulling the
dockerhubenterprise/trusted-registry-dev image instead of
docker/trusted-registry.

Fixed minor indentation issues, and broken links.

Signed-off-by: Joao Fernandes <joao.fernandes@docker.com>
This commit is contained in:
Joao Fernandes 2016-03-01 17:28:10 -08:00
parent ce2a40afdb
commit 0b40091629
3 changed files with 158 additions and 84 deletions

View File

@ -27,7 +27,7 @@ There are three authentication methods:
![Auth settings page</admin/settings#auth>](../images/admin-settings-auth.png) ![Auth settings page</admin/settings#auth>](../images/admin-settings-auth.png)
> **Note**: If you have issues logging into the Docker Trusted Registry admin web interface after changing the authentication settings, you may need to use the [emergency access to the Docker Trusted Registry admin web interface](../adminguide.md/#emergency-access-to-the-trusted-registry:ea325b0e2f1f338fce9ff1e56f5ebfb2"). > **Note**: If you have issues logging into the Docker Trusted Registry admin web interface after changing the authentication settings, you may need to use the [emergency access to the Docker Trusted Registry admin web interface](../adminguide.md/#emergency-access-to-the-trusted-registry).
## No authentication (None) ## No authentication (None)

View File

@ -162,7 +162,7 @@ Securing Docker Trusted Registry is **required**. You will not be able to push
or pull from Docker Trusted Registry until you secure it. or pull from Docker Trusted Registry until you secure it.
There are several options and methods for securing Docker Trusted Registry. For There are several options and methods for securing Docker Trusted Registry. For
more information, see the [configuration documentation](../configuration.md#security) more information, see the [configuration documentation](../configure/config-security.md)
## Push and pull images ## Push and pull images
@ -178,12 +178,12 @@ web admin interface or the Docker Trusted Registry. You can restrict access
using an in-Docker Trusted Registry configured set of users (and passwords), or using an in-Docker Trusted Registry configured set of users (and passwords), or
you can configure Docker Trusted Registry to use LDAP based authentication. you can configure Docker Trusted Registry to use LDAP based authentication.
See [Docker Trusted Registry Authentication settings](../configuration.md#authentication) for more details. See [Docker Trusted Registry Authentication settings](../configure/config-auth.md) for more details.
## See also ## See also
* To configure for your environment, see the * To configure for your environment, see the
[configuration instructions](../configuration.md). [configuration instructions](../configure/configuration.md).
* To use Docker Trusted Registry, see [the User guide](../userguide.md). * To use Docker Trusted Registry, see [the User guide](../userguide.md).
* To make administrative changes, see [the Admin guide](../adminguide.md). * To make administrative changes, see [the Admin guide](../adminguide.md).
* To see previous changes, see [the release notes](../release-notes.md). * To see previous changes, see [the release notes](../release-notes.md).

View File

@ -32,13 +32,23 @@ about 15 minutes.
To upgrade, perform the following steps: To upgrade, perform the following steps:
1. Load the Trusted Registry Dashboard in your browser and navigate to > Settings > Updates. 1. Load the Trusted Registry Dashboard in your browser and navigate to
**Settings > Updates**.
2. Click Updates in the Settings nav bar. You can see the currently installed version and a message stating that the version is either current or an update is 2. Click **Updates** in the Settings navigation bar.
available. If an update is available, the message states: System Update
Available and an enabled button displays Update to version X.X.X.
3. Click Update to start the update process. The process may take longer than what the message indicates. To check the status of the install, SSH into the Trusted Registry host through a command line: You can see the currently installed version and a message stating that
the version is either current or an update is available. If an update
is available, the message states:
"System Update Available and an enabled button displays Update
to version X.X.X.""
3. Click Update to start the update process.
The process may take longer than what the message indicates.
To check the status of the install, SSH into the Trusted Registry
host through a command line:
``` ```
$ sudo docker logs -f $(sudo docker ps -a --no-trunc | grep 'manager execute-upgrade' | head -n1 | awk '{print $1}') $ sudo docker logs -f $(sudo docker ps -a --no-trunc | grep 'manager execute-upgrade' | head -n1 | awk '{print $1}')
@ -46,45 +56,63 @@ Available and an enabled button displays Update to version X.X.X.
4. Refresh your screen to see the latest changes. 4. Refresh your screen to see the latest changes.
The Dashboard displays a message that the upgrade successfully completed and that you need to upgrade to the latest CS Engine. The Dashboard displays a message that the upgrade successfully
completed and that you need to upgrade to the latest CS Engine.
## Upgrade Docker Trusted Registry offline ## Upgrade Docker Trusted Registry offline
To upgrade the Trusted Registry offline, perform the following steps: To upgrade the Trusted Registry offline, perform the following steps:
1. Since you are retrieving a large file, use the `wget` command in your command line to get the Trusted Registry files. The following command is an example getting DTR 1.4.3. Ensure to get your correct version. 1. Since you are retrieving a large file, use the `wget` command in your
command line to get the Trusted Registry files. The following
command is an example getting DTR 1.4.3. Ensure to get your correct version.
`wget https://packages.docker.com/dtr/1.4/dtr-1.4.3.tar` ```
$ wget https://packages.docker.com/dtr/1.4/dtr-1.4.3.tar
```
2. After downloading, move the `tar` file to the offline machine you want to install the Trusted Registry. 2. After downloading, move the `tar` file to the offline machine you
want to install the Trusted Registry.
3. On that machine, verify that the CS Engine is installed. If it is not, see the [CS Engine install directions](install-csengine.md). 3. On that machine, verify that the CS Engine is installed.
If it is not, see the [CS Engine install directions](install-csengine.md).
`$ docker --version` ```bash
$ docker --version
```
> **Note:** To remain compliant with your Docker Trusted Registry support agreement, you **must** use the current version of commercially supported Docker Engine. Running the open source version of Engine is **not** supported. > **Note:** To remain compliant with your Docker Trusted Registry support
> agreement, you **must** use the current version of commercially supported
> Docker Engine. Running the open source version of Engine is **not**
> supported.
5. Open a terminal window on that machine and load the `tar` file using the following command. Again, ensure you get the correct version. 5. Open a terminal window on that machine and load the `tar` file using the
following command. Again, ensure you get the correct version.
`$ sudo docker load < dtr-1.4.3.tar` ```bash
$ sudo docker load < dtr-1.4.3.tar
```
6. Upgrade the Trusted Registry with the following command: 6. Upgrade the Trusted Registry with the following command:
`$ sudo bash -c "$(docker run dockerhubenterprise/trusted-registry-dev upgrade latest)"` ```bash
$ sudo bash -c "$(docker run docker/trusted-registry upgrade latest)"
```
> **Note**: `sudo` is needed for `docker/trusted-registry` commands to > **Note**: sudo is needed for `docker/trusted-registry` commands to
> ensure that the Bash script is run with full access to the Docker host. > ensure that the Bash script is run with full access to the Docker host.
### What is updated in the Trusted Registry? ### What is updated in the Trusted Registry?
The Trusted Registry pulls new container images from Docker Hub. Then it deploys those containers. Finally, it stops and removes the old containers. The Trusted Registry pulls new container images from Docker Hub.
Then it deploys those containers. Finally, it stops and removes the
old containers.
If the CS Engine is upgraded first, then the Trusted Registry can still be If the CS Engine is upgraded first, then the Trusted Registry can still be
upgraded from a command line by running the following command. Ensure to put the upgraded from a command line by running the following command. Ensure to put the
correct version that you want. correct version that you want.
```bash
```
$ sudo bash -c "$(sudo docker run docker/trusted-registry:1.3.3 upgrade 1.4.3)" $ sudo bash -c "$(sudo docker run docker/trusted-registry:1.3.3 upgrade 1.4.3)"
``` ```
@ -97,7 +125,9 @@ Whichever path you select, you must first stop the Trusted Registry prior to
upgrading the CS Engine. Run `docker ps` to verify which version you have, then upgrading the CS Engine. Run `docker ps` to verify which version you have, then
ensure the following command contains your version. ensure the following command contains your version.
`$ sudo bash -c "$(sudo docker run docker/trusted-registry:1.4.3 stop)"` ```
$ sudo bash -c "$(sudo docker run docker/trusted-registry:1.4.3 stop)"
```
>**WARNING**: If you stop the CS Engine, while the Trusted Registry is running, the Trusted Registry may not perform as expected and you must restart it. >**WARNING**: If you stop the CS Engine, while the Trusted Registry is running, the Trusted Registry may not perform as expected and you must restart it.
@ -117,27 +147,34 @@ Engine, and install the new version.
1. Remove the current CS Engine: 1. Remove the current CS Engine:
`$ sudo yum remove docker-engine-cs` ```
$ sudo yum remove docker-engine-cs
```
2. Add Docker's public key for CS packages: 2. Add Docker's public key for CS packages:
``` ```bash
$ sudo rpm --import "https://sks-keyservers.net/pks/lookup?op=get&search=0xee6d536cf7dc86e2d7d56f59a178ac6c6238f52e" $ sudo rpm --import "https://sks-keyservers.net/pks/lookup?op=get&search=0xee6d536cf7dc86e2d7d56f59a178ac6c6238f52e"
``` ```
3. Install yum-utils if necessary: 3. Install yum-utils if necessary:
`$ sudo yum install -y yum-utils` ```bash
$ sudo yum install -y yum-utils
```
4. Add the repository for the new version and disable the old one. Also, ensure in the following code snippet that you have the OS that you want. 4. Add the repository for the new version and disable the old one. Also, ensure in the following code snippet that you have the OS that you want.
``` ```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.10/yum/repo/main/centos/7
$ sudo yum-config-manager --disable 'Docker_cs*' $ sudo yum-config-manager --disable 'Docker_cs*'
``` ```
5. Install the new package: 5. Install the new package:
`$ sudo yum install docker-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 then start it.
@ -159,31 +196,38 @@ Engine, and install the new version.
1. Remove the current Engine: 1. Remove the current Engine:
`$ sudo apt-get remove docker-engine-cs` ```bash
$ sudo apt-get remove docker-engine-cs
```
2. Add Docker's public key for CS packages: 2. Add Docker's public key for CS packages:
``` ```bash
$ curl -s 'https://sks-keyservers.net/pks/lookup?op=get&search=0xee6d536cf7dc86e2d7d56f59a178ac6c6238f52e' | sudo apt-key add --import $ curl -s 'https://sks-keyservers.net/pks/lookup?op=get&search=0xee6d536cf7dc86e2d7d56f59a178ac6c6238f52e' | sudo apt-key add --import
``` ```
3. Install the HTTPS helper for apt (your system may already have it): 3. Install the HTTPS helper for apt (your system may already have it):
`$ sudo apt-get update && sudo apt-get install apt-transport-https` ```bash
$ sudo apt-get update && sudo apt-get install apt-transport-https
```
4. Install additional virtual drivers not in the base image. 4. Install additional virtual drivers not in the base image.
`$ sudo apt-get install -y linux-image-extra-virtual` ```bash
$ sudo apt-get install -y linux-image-extra-virtual
```
You may need to reboot your server after updating the LTS kernel. You may need to reboot your server after updating the LTS kernel.
5. Add the repository for the new version: 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.10/apt/repo ubuntu-trusty main" | sudo tee /etc/apt/sources.list.d/docker.list
``` ```
Modify the "ubuntu-trusty" string for your flavor of ubuntu or debian as seen in the following options. Modify the "ubuntu-trusty" string for your flavor of ubuntu or debian
as seen in the following options.
* debian-jessie (Debian 8) * debian-jessie (Debian 8)
* debian-stretch (future release) * debian-stretch (future release)
@ -197,13 +241,15 @@ Engine, and install the new version.
6. Install the upgraded package: 6. Install the upgraded package:
`$ sudo apt-get upgrade docker-engine` ```bash
$ sudo apt-get upgrade docker-engine
```
7. Restart the Trusted Registry: 7. Restart the Trusted Registry:
`$ sudo bash -c "$(sudo docker run docker/trusted-registry restart)"` ```bash
$ sudo bash -c "$(sudo docker run docker/trusted-registry restart)"
```
### Upgrade major to major versions ### Upgrade major to major versions
@ -213,36 +259,44 @@ system.
#### CentOS 7.1 & RHEL 7.0/7.1 (YUM-based systems) #### CentOS 7.1 & RHEL 7.0/7.1 (YUM-based systems)
1. 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 the you are requesting the version and the OS that you want. 1. 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 the you are requesting the version and the OS that you want.
``` ```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.10/yum/repo/main/centos/7
``` ```
2. Install the new package: 2. Install the new package:
`$ sudo yum update docker-engine` ```bash
$ sudo yum update docker-engine
```
3. Verify that the CS Engine is running: 3. Verify that the CS Engine is running:
`$ sudo docker info` ```bash
$ sudo docker info
```
4. Restart the Trusted Registry: 4. Restart the Trusted Registry:
`$ sudo bash -c "$(sudo docker run docker/trusted-registry restart)"` ```bash
$ sudo bash -c "$(sudo docker run docker/trusted-registry restart)"
```
#### Ubuntu 14.04 LTS (APT-based systems) #### Ubuntu 14.04 LTS (APT-based systems)
1. Add the repository for the new version. 1. 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.10/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. You must modify the "ubuntu-trusty" string for your flavor of ubuntu
or debian as seen in the following options.
* debian-jessie (Debian 8) * debian-jessie (Debian 8)
* debian-stretch (future release) * debian-stretch (future release)
@ -256,17 +310,19 @@ system.
2. Update your `docker-engine` package. 2. Update your `docker-engine` package.
``` ```bash
$ sudo apt-get update && sudo apt-get upgrade docker-engine $ sudo apt-get update && sudo apt-get upgrade docker-engine
``` ```
3. Verify that the CS Engine is running: 3. Verify that the CS Engine is running:
`$ sudo docker info` ```bash
$ sudo docker info
```
4. Restart the Trusted Registry: 4. Restart the Trusted Registry:
``` ```bash
$ sudo bash -c "$(sudo docker run docker/trusted-registry restart)" $ sudo bash -c "$(sudo docker run docker/trusted-registry restart)"
``` ```
@ -274,27 +330,28 @@ system.
1. 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 the you are requesting the version and the OS that you want. 1. 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 the you are requesting the version and the OS that you want.
``` ```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.10/yum/repo/main/opensuse/12.3 docker-1.10
``` ```
2. Install the new package: 2. Install the new package:
`$ sudo zypper update docker-engine` ```bash
$ sudo zypper update docker-engine
```
3. Verify that the CS Engine is running: 3. Verify that the CS Engine is running:
`$ sudo docker info` ```bash
$ sudo docker info
```
4. Restart the Trusted Registry: 4. Restart the Trusted Registry:
``` ```bash
$ sudo bash -c "$(sudo docker run docker/trusted-registry restart)" $ sudo bash -c "$(sudo docker run docker/trusted-registry restart)"
``` ```
### Upgrade minor to minor versions ### Upgrade minor to minor versions
Use these streamlined directions in upgrading minor to minor versions of the CS Use these streamlined directions in upgrading minor to minor versions of the CS
@ -306,15 +363,19 @@ steps depending on your type of system.
1. Update your `docker-engine` package: 1. Update your `docker-engine` package:
`$ sudo yum upgrade docker-engine` ```bash
$ sudo yum upgrade docker-engine
```
2. Verify that the CS Engine is running: 2. Verify that the CS Engine is running:
`$ sudo docker info` ```bash
$ sudo docker info
```
3. Restart the Trusted Registry: 3. Restart the Trusted Registry:
``` ```bash
$ sudo bash -c "$(sudo docker run docker/trustmed-registry restart)" $ sudo bash -c "$(sudo docker run docker/trustmed-registry restart)"
``` ```
@ -322,28 +383,41 @@ steps depending on your type of system.
1. Update your `docker-engine` package: 1. Update your `docker-engine` package:
`$ sudo apt-get update && sudo apt-get upgrade docker-engine` ```bash
$ sudo apt-get update && sudo apt-get upgrade docker-engine
```
2. Verify that the CS Engine is running: 2. Verify that the CS Engine is running:
`$ sudo docker info` ```bash
$ sudo docker info
```
3. Restart the Trusted Registry: 3. Restart the Trusted Registry:
`$ sudo bash -c "$(sudo docker run docker/trusted-registry restart)"`
```bash
$ sudo bash -c "$(sudo docker run docker/trusted-registry restart)"
```
#### SUSE Enterprise 12.3 #### SUSE Enterprise 12.3
1. Update your `docker-engine` package: 1. Update your `docker-engine` package:
`$ sudo zypper upgrade docker-engine` ```bash
$ sudo zypper upgrade docker-engine
```
2. Verify that the CS Engine is running: 2. Verify that the CS Engine is running:
`$ sudo docker info` ```bash
$ sudo docker info
```
3. Restart the Trusted Registry: 3. Restart the Trusted Registry:
`$ sudo bash -c "$(sudo docker run docker/trusted-registry restart)"` ```bash
$ sudo bash -c "$(sudo docker run docker/trusted-registry restart)"
```
## See also ## See also