docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updates for new GUI 

Revises and updates all text to match new GUI layout and labels.

Signed-off-by: Fred Lifton <fred.lifton@docker.com>
This commit is contained in:
Fred Lifton 2015-08-14 15:45:55 -07:00
parent f898b3d957
commit dbf4c46f4a
5 changed files with 60 additions and 53 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
adminguide.md
View File

@ -16,15 +16,15 @@ This guide covers tasks and functions an administrator of Docker Trusted Registr
(DTR) will need to know about, such as reporting, logging, system management,
performance metrics, etc.
For tasks DTR users need to accomplish, such as using DTR to push and pull
images, please visit the [User's Guide]({{< relref "userguide.md" >}}).
images, please look at the [User's Guide]({{< relref "userguide.md" >}}).
## Reporting
### System Health
### Dashboard
![System Health page</admin/metrics/>](../assets/admin-metrics.png)
![DTR Dashboard</admin/metrics/>](../assets/admin-metrics.png)
The "System Health" tab displays "hardware" resource utilization and network traffic metrics for the DTR host as well as for each of its contained services. The CPU and RAM usage meters at the top indicate overall resource usage for the host, while detailed time-series charts are provided below for each service.
The "DTR Dashboard displays "hardware" resource utilization and network traffic metrics for the DTR host as well as for each of its contained services. The CPU and RAM usage meters at the top indicate overall resource usage for the host, while detailed time-series charts are provided below for each container providing a DTR service.
In addition, if your registry is using a filesystem storage driver, you will see a usage meter indicating used and available space on the storage volume. Third-party storage back-ends are not supported, so if you are using one, this meter will not be displayed.
@ -39,7 +39,7 @@ service. See below for a
![System Logs page</admin/logs/>](../assets/admin-logs.png)
Click the "Logs" tab to view all logs related to your DTR instance. You will see
Click "Logs" in the global nav bar at the top of page to view the logs from your DTR's containers. You will see
log sections on this page for each service in your DTR instance. Older or newer
logs can be loaded by scrolling up or down. See below for a
[detailed explanation of the available services](#services).

51
configuration.md
View File

@ -17,27 +17,29 @@ weight=5
This page will help you properly configure Docker Trusted Registry (DTR) so it can
run in your environment.
Start with DTR loaded in your browser and click the "Settings" tab to view
configuration options. You'll see options for configuring:
Start with DTR loaded in your browser and click "Settings" in the global nav
bar at the top of the page to view configuration options. You'll see menus
organizing the options for configuring:
* Domains and ports
* General Settings (ports, proxies, etc.)
* Security settings
* Storage settings
* Authentication settings
* Your DTR license
* Authentication settings
## Domains and Ports
## General Settings
![Domain and Ports page</admin/settings#http>](../assets/admin-settings-http.png)
* *Domain Name*: **required** defaults to an empty string, the fully qualified domain name assigned to the DTR host.
* *Load Balancer HTTP Port*: defaults to 80, used as the entry point for the image storage service. To see load balancer status, you can query
* *HTTP Port*: defaults to 80, used as the entry point for the image storage service. To see load balancer status, you can query
http://&lt;dtr-host&gt;/load_balancer_status.
* *Load Balancer HTTPS Port*: defaults to 443, used as the secure entry point
for the image storage service.
* *HTTP_PROXY*: defaults to an empty string, proxy server for HTTP requests.
* *HTTPS_PROXY*: defaults to an empty string, proxy server for HTTPS requests.
* *NO_PROXY*: defaults to an empty string, proxy bypass for HTTP and HTTPS requests.
* *HTTPS Port*: defaults to 443, used as the secure entry point for the image storage service.
* *HTTP proxy*: defaults to an empty string, proxy server for HTTP requests.
* *HTTPS proxy*: defaults to an empty string, proxy server for HTTPS requests.
* *No proxy*: defaults to an empty string, proxy bypass for HTTP and HTTPS requests.
* *Upgrade checking*: enables or disables automatic checking for DTR software updates.
> **Note**: If you need DTR to re-generate a self-signed certificate at some
@ -52,7 +54,7 @@ for the image storage service.
* *SSL Certificate*: Used to enter the hash (string) from the SSL Certificate.
This cert must be accompanied by its private key, entered below.
* *Private Key*: The hash from the private key associated with the provided
* *SSL Private Key*: The hash from the private key associated with the provided
SSL Certificate (as a standard x509 key pair).
In order to run, DTR requires encrypted communications via HTTPS/SSL between (a) the DTR registry and your Docker Engine(s), and (b) between your web browser and the DTR admin server. There are a few options for setting this up:
@ -270,7 +272,10 @@ API](http://docs.docker.com/registry/storagedrivers/#storage-driver-api).
![Storage settings page</admin/settings#storage>](../assets/admin-settings-storage.png)
* *Yaml configuration file*: This file (`/usr/local/etc/dtr/storage.yml`) is
After you select the image storage method you would like to use from the drop-down menu near the top of the page, the UI will change to reflect the configuration settings appropriate to the selected method.
### Yaml configuration file
This file (`/usr/local/etc/dtr/storage.yml`) is
used to configure the image storage services. The editable text of the file is
displayed in the dialog box. The schema of this file is identical to that used
by the [Registry 2.0](http://docs.docker.com/registry/configuration/).
@ -285,7 +290,7 @@ by the [Registry 2.0](http://docs.docker.com/registry/configuration/).
## Authentication
The "Authentication" settings tab lets DTR administrators control access
The "Authentication" settings lets DTR administrators control access
to the DTR web admin tool and to the DTR Registry.
The current authentication methods are `None`, `Managed` and `LDAP`.
@ -300,8 +305,7 @@ site. This is not recommended for any use other than testing.
### Managed authentication
With `Managed` authentication, the DTR admin can control users' access by setting
username/password pairs.
With `Managed` authentication, the DTR admin can control users' access by setting username/password pairs.
These users must then be given "admin", "read-write" or "read-only" roles.
The "read-only" role can only pull images from the registry, "read-write" can
push and pull images, and the "admin" role can push and pull and also access
@ -309,13 +313,13 @@ the web administration UI and metrics dashboard.
![Managed authentication settings page</admin/settings#auth>](../assets/admin-settings-authentication-basic.png)
* A button to add one user, or to upload a CSV file containing username,
* Choose the appropriate button to add one user, or to upload a CSV file containing username,
password pairs, and selection boxes for "admin", "read-write", and "read-only" roles.
### LDAP authentication
Using LDAP authentication allows you to integrate your DTR registry into your
organization's existing user and authentication database.
organization's existing LDAP user and authentication database.
You can configure the "userFilter" to select the set of users that are candidates
for each of the "admin", "read-write", and "read-only" roles. Unlike "Managed"
@ -355,13 +359,16 @@ confirm which setting you need.
![LDAP authentication settings page</admin/settings#auth>](../assets/admin-settings-authentication-ldap.png)
* *Use StartTLS*: defaults to unchecked, check to enable StartTLS
#### LDAP Configuration options
* *LDAP Server URL*: **required** defaults to null, LDAP server URL (e.g., - ldap://example.com)
* *Use StartTLS*: defaults to unchecked, check to enable StartTLS
* *User Base DN*: **required** defaults to null, user base DN in the form (e.g., - dc=example,dc=com)
* *User Login Attribute*: **required** defaults to null, user login attribute (e.g., - uid or sAMAccountName)
* *Search User DN*: **required** defaults to null, search user DN (e.g., - domain\username)
* *LDAP Sync Interval*: **required** defaults to 1h0m0s, sets the interval for DTR to sync with the LDAP db.
* *Search User Password*: **required** defaults to null, search user password
* *User Search filters*: allowing you to configure LDAP queries to limit the users that have the roles:
* *User Search filters*: allows you to configure LDAP queries to limit the users that have the roles:
* * *User Filter*: This filter is used to select the objects to use as candidates for the role filters
* * *Admin Role Filter*: Combined with the "User Filter" to specify users with the
"Admin" role - permitted to access the DTR web UI
@ -376,6 +383,10 @@ confirm which setting you need.
> "read-write" filter is empty, all users can push/pull any image, etc. (This
> behavior will be corrected in future versions.)
#### Confirm Configuration
You can test your LDAP configuration before saving it by entering a test username and password and then clicking "Try Login". If the login succeeds, your configuration is working.
## Next Steps
For information on getting support for DTR, take a look at the

42
install.md
View File

@ -54,7 +54,7 @@ DTR runs on the following platforms:
* RHEL 7.0 and 7.1
* CentOS 7.1
DTR 1.2.0 requires the following:
DTR 1.3.0 requires the following:
* Commercially supported Docker Engine, preferably 1.6.2-cs5 or later, running
on a supported host. (See below for instructions on how to install the
@ -275,10 +275,10 @@ temporarily.
### Setting the DTR Domain Name
The DTR Administrator site will also warn that the "Domain Name" is not set. Go
to the "Settings" tab, and set the "Domain Name" to the full host-name of your
DTR server.
Hitting the "Save and Restart DTR Server" button will generate a new certificate, which will be used
The DTR Administrator site will also warn that the "Domain Name" is not set.
Select "Settings" from the global nav bar at the top of the page, and then set
the "Domain Name" to the full host-name of your DTR server.
Clicking the "Save and Restart DTR Server" button will generate a new certificate, which will be used
by both the DTR Administrator web interface and the DTR Registry server.
After the server restarts, you will again need to allow the connection to the untrusted DTR web admin site.
@ -301,17 +301,18 @@ upload it to your DTR web admin server. Follow these steps:
obtain the license file you'd like to use.
![Download DTR license](../assets/docker-hub-org-enterprise-license.png)
3. Next, go to your DTR instance in your browser and click on the Settings tab
and then the "License" tab. Click on the "Upload license file" button, which
will open a standard file browser. Locate and select the license file you
downloaded in step 2, above. Approve the selection to close the dialog.
3. Next, go to your DTR instance in your browser, click on "Settings" in the
global nav bar and then click "License" in the Settings nav bar. Click the
"Choose File" button, which will open a standard file browser. Locate and
select the license file you downloaded in step 2, above. Approve the
selection to close the dialog.
![http settings page</admin/settings#license>](../assets/admin-settings-license.png)
4. Click the "Save and Restart DTR" button, which will quit DTR and then restart it, registering
the new license.
4. Click the "Save and restart" button, which will quit DTR and then restart
it, applying the new license.
5. Verify the acceptance of the license by confirming that the "unlicensed copy"
warning is no longer present.
5. Verify the acceptance of the license by confirming that the "Unlicensed copy"
warning is no longer present.
### Securing DTR
@ -340,17 +341,14 @@ details.
## Upgrading Docker Trusted Registry
DTR has been designed to allow on-the-fly software upgrades. Start by
clicking on the "System Health" tab. In the upper, right-hand side of the
dashboard, below the navigation bar, you'll see the currently installed version
(e.g., `Current Version: 0.1.12345`).
loading the DTR Dashboard in your browser and clicking "Settings" in the global nav bar. Then click "Updates" in the Settings nav bar. You'll see the currently installed version and a message telling you that the version is either current or that there is an update available.
If your DTR instance is the latest available, you will also see the message:
"System Up to Date."
If there is an upgrade available, you will see the message "System Update
Available!" alongside a button labeled "Update to Version X.XX". To upgrade, DTR
will pull new DTR container images from the Docker Hub. If you have not already
connected to Docker Hub, DTR will prompt you to log in.
If there is an update available, you will see the message "System Update
Available" and a button labeled "Update to Version X.XX". Click the button to
start the update process. To update, DTR will pull new DTR container images from
the Docker Hub. If you have not already connected to Docker Hub, DTR will prompt
you to log in.
The upgrade process requires a small amount of downtime to complete. To complete
the upgrade, DTR will:

6
quick-start.md
View File

@ -233,8 +233,7 @@ Now that you’ve created the custom image, it can be pushed to DTR using the
492ed3875e3e: Image successfully pushed
fc0ab3008d40: Image successfully pushed
You can view the traffic throughput while the custom image is being pushed from
the `System Health` tab in DTR:
You can view the traffic throughput from the custom image being pushed on the DTR Dashboard:
![DTR console push throughput](../assets/console-push.png)
@ -257,8 +256,7 @@ command from any Docker Host that has access to your DTR instance:
dtr.yourdomain.com/ci-infrastructure/jnkns-img: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.
Status: Downloaded newer image for dtr.yourdomain.com/ci-infrastructure/jnkns-img:latest
You can view the traffic throughput while the custom image is being pulled from
the `System Health` tab in DTR:
You can view the traffic throughput from the custom image being pulled on the DTR Dashboard:
![DTR console pull throughput](../assets/console-pull.png)

4
userguide.md
View File

@ -62,7 +62,7 @@ You push an image up to a DTR repository by using the
You can add a `tag` to your image so that you can more easily identify it
amongst other variants and so that it refers to your DTR server.
`$ docker tag hello-world:latest dtr.yourdomain.com/yourusername/hello-mine:latest`
$ docker tag hello-world:latest dtr.yourdomain.com/yourusername/hello-mine:latest
The command labels a `hello-world:latest` image using a new tag in the
`[REGISTRYHOST/][USERNAME/]NAME[:TAG]` format. The `REGISTRYHOST` in this
@ -71,7 +71,7 @@ case is your DTR server, `dtr.yourdomain.com`, and the `USERNAME` is
Once an image is tagged, you can push it to DTR with:
`$ docker push dtr.yourdomain.com/demouser/hello-mine:latest`
$ docker push dtr.yourdomain.com/yourusername/hello-mine:latest
> **Note**: If the Docker daemon on which you are running `docker push` doesn't
> have the right certificates set up, you will get an error similar to: