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

Migrate to using github linking 

Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
This commit is contained in:
Sven Dowideit 2015-10-15 16:42:28 -07:00
parent ffa8fce6e9
commit 596d4caa87
13 changed files with 49 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Dockerfile
View File

@ -1,4 +1,4 @@
FROM docs/base:latest
FROM docs/base:hugo-github-linking
MAINTAINER Mary Anthony <mary@docker.com> (@moxiegirl)
RUN svn checkout https://github.com/docker/tutorials/trunk/docs/mac /docs/content/mac \
@ -24,4 +24,4 @@ RUN chmod 777 touch-up.sh && mv touch-up.sh /src && cat /dev/null > /docs/build.
# To get the git info for this repo
RUN /src/touch-up.sh /docs
RUN /src/touch-up.sh /docs

14
adminguide.md
View File

@ -15,13 +15,13 @@ weight=4
This guide explains the tasks and functions an administrator of Docker Trusted Registry needs to understand such as reporting, logging, system management,
performance metrics, optimizing the Trusted Registry file size, and deleting containers.
For tasks Docker Trusted Registry users need to accomplish, such as pushing and pulling
images, please look at the [User's Guide]({{< relref "userguide.md" >}}).
images, please look at the [User's Guide](userguide.md).
## Reporting
### Dashboard
![Docker Trusted Registry Dashboard</admin/metrics/>](../assets/admin-metrics.png)
![Docker Trusted Registry Dashboard</admin/metrics/>](assets/admin-metrics.png)
The Docker Trusted Registry Dashboard displays "hardware" resource utilization and network traffic metrics for the Docker Trusted Registry 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 Docker Trusted Registry service.
@ -36,7 +36,7 @@ service. See below for a
### Logs
![System Logs page</admin/logs/>](../assets/admin-logs.png)
![System Logs page</admin/logs/>](assets/admin-logs.png)
Click "Logs" in the global nav bar at the top of page to view the logs from your Docker Trusted Registry's containers. You will see
log sections on this page for each service in your Docker Trusted Registry instance. Older or newer
@ -321,7 +321,7 @@ If you need to stop and/or start Docker Trusted Registry (for upgrading, trouble
## See also
* To configure for your environment, see the
[Configuration instructions]({{< relref "configuration.md" >}}).
* To use Docker Trusted Registry, see the [User guide]({{< relref "userguide.md" >}}).
* To upgrade, see the [Upgrade guide]({{< relref "upgrade.md" >}}).
* To see previous changes, see the [release notes]({{< relref "release-notes.md" >}}).
[Configuration instructions](configuration.md).
* To use Docker Trusted Registry, see the [User guide](userguide.md).
* To upgrade, see the [Upgrade guide](upgrade.md).
* To see previous changes, see the [release notes](release-notes.md).

12
api/dtr_api.md
View File

@ -16,9 +16,9 @@ organizational structure by providing fine-grained, role-based access control fo
The following documents detail the API:
- [Docker Trusted Registry Accounts & Repos API: Intro & Overview](/docker-trusted-registry/api/)
- [Accounts API Doc]({{< relref "dtr_1_3_accounts.md" >}})
- [Teams API Doc]({{< relref "dtr_1_3_teams.md" >}})
- [Repositories API Doc]({{< relref "dtr_1_3_repositories.md" >}})
- [User-Owned Repository Access API Doc]({{< relref "dtr_1_3_user_repo_access.md" >}})
- [Organization-Owned Repository Access API Doc]({{< relref "dtr_1_3_team_repo_access.md" >}})
- [Organization-Owned Repository Namespace Access API Doc]({{< relref "dtr_1_3_team_repo_namespace_access.md" >}})
- [Accounts API Doc](dtr_1_3_accounts.md)
- [Teams API Doc](dtr_1_3_teams.md)
- [Repositories API Doc](dtr_1_3_repositories.md)
- [User-Owned Repository Access API Doc](dtr_1_3_user_repo_access.md)
- [Organization-Owned Repository Access API Doc](dtr_1_3_team_repo_access.md)
- [Organization-Owned Repository Namespace Access API Doc](dtr_1_3_team_repo_namespace_access.md)

12
api/index.md
View File

@ -133,10 +133,10 @@ $ curl --user readuser:password https://dtr.domain.com/api/v0/accounts
The following documents detail the API:
- [Accounts API Doc]({{< relref "dtr_1_3_accounts.md" >}})
- [Teams API Doc]({{< relref "dtr_1_3_teams.md" >}})
- [Repositories API Doc]({{< relref "dtr_1_3_repositories.md" >}})
- [User-Owned Repository Access API Doc]({{< relref "dtr_1_3_user_repo_access.md" >}})
- [Organization-Owned Repository Access API Doc]({{< relref "dtr_1_3_team_repo_access.md" >}})
- [Organization-Owned Repository Namespace Access API Doc]({{< relref "dtr_1_3_team_repo_namespace_access.md" >}})
- [Accounts API Doc](dtr_1_3_accounts.md)
- [Teams API Doc](dtr_1_3_teams.md)
- [Repositories API Doc](dtr_1_3_repositories.md)
- [User-Owned Repository Access API Doc](dtr_1_3_user_repo_access.md)
- [Organization-Owned Repository Access API Doc](dtr_1_3_team_repo_access.md)
- [Organization-Owned Repository Namespace Access API Doc](dtr_1_3_team_repo_namespace_access.md)

14
configuration.md
View File

@ -37,7 +37,7 @@ organizing the options for configuring:
## General Settings
![Domain and Ports page</admin/settings#http>](../assets/admin-settings.png)
![Domain and Ports page</admin/settings#http>](assets/admin-settings.png)
* *Domain Name*: **required** defaults to an empty string, the fully qualified domain name assigned to the Docker Trusted Registry host.
* *HTTP Port*: defaults to 80, used as the entry point for the image storage service. To see load balancer status, you can query
@ -57,7 +57,7 @@ http://&lt;dtr-host&gt;/load_balancer_status.
## Security
![Security settings page</admin/settings#security>](../assets/admin-settings-security.png)
![Security settings page</admin/settings#security>](assets/admin-settings-security.png)
* *SSL Certificate*: Used to enter the hash (string) from the SSL Certificate.
This cert must be accompanied by its private key, entered below.
@ -278,7 +278,7 @@ documentation for the full options specific to each driver.
Storage drivers can be added or customized via the [Docker Registry storage driver
API](http://docs.docker.com/registry/storagedrivers/#storage-driver-api).
![Storage settings page</admin/settings#storage>](../assets/admin-settings-storage.png)
![Storage settings page</admin/settings#storage>](assets/admin-settings-storage.png)
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
@ -330,7 +330,7 @@ to the Docker Trusted Registry web admin tool and to the Docker Trusted Registry
The current authentication methods are `None`, `Managed` and `LDAP`.
> **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]({{< relref "adminguide.md#emergency-access-to-dtr" >}}).
> settings, you may need to use the [emergency access to the Docker Trusted Registry admin web interface](adminguide.md#emergency-access-to-dtr).
### No authentication
@ -348,7 +348,7 @@ the web administration UI and metrics dashboard.
When you create users and assign their roles via the API, you do not need
to assign those users roles using the Docker Trusted Registry admin web UI.
![Managed authentication settings page</admin/settings#auth>](../assets/admin-settings-authentication-basic.png)
![Managed authentication settings page</admin/settings#auth>](assets/admin-settings-authentication-basic.png)
* 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.
@ -408,7 +408,7 @@ for the user's login-name. On OpenLDAP, it's generally `uid`, and on Microsoft A
servers, it's `sAMAccountName`. The `ldapsearch` output above should allow you to
confirm which setting you need.
![LDAP authentication settings page</admin/settings#auth>](../assets/admin-settings-authentication-ldap.png)
![LDAP authentication settings page</admin/settings#auth>](assets/admin-settings-authentication-ldap.png)
#### LDAP Configuration options
@ -441,4 +441,4 @@ You can test your current LDAP configuration before saving it by entering a test
## Next Steps
For information on getting support for Docker Trusted Registry, take a look at the
[Support information]({{< relref "support.md" >}}).
[Support information](support.md).

8
index.md
View File

@ -47,16 +47,16 @@ To get your copy of Docker Trusted Registry, including a free trial, visit [the
The following documentation for Docker Trusted Registry is available:
* **Overview** This page.
* [**Quick Start: Basic User Workflow**]({{< relref "quick-start.md" >}}) Go here to learn the
* [**Quick Start: Basic User Workflow**](quick-start.md) Go here to learn the
fundamentals of how Docker Trusted Registry works and how you can set up a simple, but useful
workflow.
* [**User Guide**]({{< relref "userguide.md" >}}) Go here to learn about using Docker Trusted Registry from day to
* [**User Guide**](userguide.md) Go here to learn about using Docker Trusted Registry from day to
day.
* [**Administrator Guide**]({{< relref "adminguide.md" >}}) Go here if you are an administrator
* [**Administrator Guide**](adminguide.md) Go here if you are an administrator
responsible for running and maintaining Docker Trusted Registry.
* [**Installation**](/docker-trusted-registry/install/) Go here for the steps you'll need to install
Docker Trusted Registry and get it working.
* [**Configuration**]({{< relref "configuration.md" >}}) Go here to find out details about
* [**Configuration**](configuration.md) Go here to find out details about
setting up and configuring Docker Trusted Registry for your particular environment.
* [**Support**](/docker-trusted-registry/install/) Go here for information on getting support for Docker Trusted Registry.
* [**The Docker Trusted Registry product page**](https://www.docker.com/docker-trusted-registry).

6
install/dtr-ami-byol-launch.md
View File

@ -93,7 +93,7 @@ The following steps walk you through the 1-Click Launch settings:
4. From the Security Group box, select "Create new based on seller settings".
![](../assets/aws-dtr-sg-rules.png)
![](assets/aws-dtr-sg-rules.png)
This option has security implications. It allows incoming connections to the listed ports from any host or IP address. You should lock this down in line with your existing AWS security policies..
@ -149,7 +149,7 @@ interface:
You'll find the Instance ID on the "Description" tab on the EC2 Dashboard as shown in the image below:
![](../assets/aws-instance-id.png)
![](assets/aws-instance-id.png)
## Configure the Docker Trusted Registry Service
@ -169,7 +169,7 @@ When you first login to the DTR Administration web interface you are prompted to
Your Docker Trusted Registry license file is available from Docker Hub. To download it, login to Docker Hub and click your username in the top right corner. Choose "Settings" and select the "Licenses" tab. Click the download button beneath your license.
![](../assets/dtr-license-download.png)
![](assets/dtr-license-download.png)
From the Docker Trusted Registry Administration web interface, select "Settings" and then "License". Under the "Apply a new license" heading select "Choose File". Select your downloaded license file and click "Save and restart".

4
install/dtr-ami-launch.md
View File

@ -80,7 +80,7 @@ The following steps walk you through the 1-Click Launch settings:
5. From the Security Group box, select "Create new based on seller settings".
![](../assets/aws-dtr-sg-rules.png)
![](assets/aws-dtr-sg-rules.png)
This option has security implications. It allows incoming connections to the listed ports from any host or IP address. You should lock this down in line with your existing AWS security policies.
@ -136,7 +136,7 @@ interface:
You'll find the Instance ID on the "Description" tab on the EC2 Dashboard as shown in the image below:
![](../assets/aws-instance-id.png)
![](assets/aws-instance-id.png)
## Configure the Docker Trusted Registry Service

2
install/engine-ami-launch.md
View File

@ -87,7 +87,7 @@ The following steps walk you through the 1-Click Launch settings:
5. From the Security Group box, select "Create new based on seller settings".
![](../assets/aws-engine-sg-rules.png)
![](assets/aws-engine-sg-rules.png)
This option has security implications. It allows incoming connections to the listed ports from any host or IP address. You should lock this down in line with your existing AWS security policies.

4
prior-release-notes.md
View File

@ -21,9 +21,9 @@ This release of Docker Trusted Registry (formerly DHE) adds major integration wi
#### New Features
* New, more granular, [roles for users]({{< relref "configuration.md#authentication" >}}). Docker Trusted Registry users can now be assigned different levels of access (admin, r/w, r/o) to the repositories. **Important:** Existing Docker Trusted Registry users should make sure to see the note [below](#dhe-1-0-upgrade-warning) regarding migrating users before upgrading.
* New, more granular, [roles for users](configuration.md#authentication). Docker Trusted Registry users can now be assigned different levels of access (admin, r/w, r/o) to the repositories. **Important:** Existing Docker Trusted Registry users should make sure to see the note [below](#dhe-1-0-upgrade-warning) regarding migrating users before upgrading.
* A new storage status indicator for storage space. The dashboard now shows used and available storage space for supported storage drivers.
* A new [diagnostics tool]({{< relref "adminguide.md#client-docker-daemon-diagnostics" >}}) gathers and bundles Docker Trusted Registry logs, system information, container information, and other configuration settings for use by Docker support or as a backup.
* A new [diagnostics tool](adminguide.md#client-docker-daemon-diagnostics) gathers and bundles Docker Trusted Registry logs, system information, container information, and other configuration settings for use by Docker support or as a backup.
* Performance and reliability improvements to the S3 storage backend.
* Docker Trusted Registry images are now available on the Amazon AWS and Microsoft Azure marketplaces.

10
quick-start.md
View File

@ -43,7 +43,7 @@ You should be able to complete this guide in about thirty minutes.
> **Note:** This guide assumes you have installed a working instance of Docker Trusted Registry
> reachable at dtr.yourdomain.com. If you need help installing and configuring
> Docker Trusted Registry, please consult the
[installation instructions]({{< relref "docker-trusted-registry/install.md" >}}).
[installation instructions](install.md).
## Pulling the official Jenkins image
@ -234,7 +234,7 @@ Now that you’ve created the custom image, it can be pushed to Docker Trusted R
You can view the traffic throughput from the custom image being pushed, by selecting `Network` from the `Load Balancer` tile on the Docker Trusted Registry Dashboard:
![](http://i.imgur.com/8KlHj9u.png)
![Docker Trusted Registry console push throughput](../assets/console-push.png)
![Docker Trusted Registry console push throughput](assets/console-push.png)
Once the image is successfully pushed, it can be downloaded, or pulled, by any
Docker host that has access to Docker Trusted Registry.
@ -309,13 +309,13 @@ The previous `docker run` command mapped port `1973` on the container to port
> not trusted. You may wish to add the certificate to the trusted store in order
> to prevent further warnings in the future.
![Jenkins landing page](../assets/jenkins-ui.png)
![Jenkins landing page](assets/jenkins-ui.png)
From within the Jenkins Web UI, navigate to `Manage Jenkins` (on the left-hand
pane) > `Manage Plugins` > `Installed`. The `Role-based Authorization Strategy`
plugin should be present with the `Uninstall` button available to the right.
![Jenkins plugin manager](../assets/jenkins-plugins.png)
![Jenkins plugin manager](assets/jenkins-plugins.png)
In another browser session, try to access Jenkins via the default HTTP port 8080
`http://<docker-host>:8080`. This should result in a "connection timeout",
@ -330,4 +330,4 @@ configured, secured Jenkins instance that can run on any infrastructure.
## Next Steps
For more information on using Docker Trusted Registry, take a look at the
[User's Guide]({{< relref "userguide.md" >}}).
[User's Guide](userguide.md).

2
release-notes.md
View File

@ -14,7 +14,7 @@ weight=100
## Prior Versions
These notes refer to the current and immediately prior releases of Docker Trusted Registry and the commercially supported Docker Engine. For notes on older versions of these, see the [prior release notes archive]({{< relref "prior-release-notes.md" >}}).
These notes refer to the current and immediately prior releases of Docker Trusted Registry and the commercially supported Docker Engine. For notes on older versions of these, see the [prior release notes archive](prior-release-notes.md).
## Docker Trusted Registry

6
userguide.md
View File

@ -16,7 +16,7 @@ weight=3
This guide covers tasks and functions a user of Docker Trusted Registry will
need to know about, such as pushing or pulling images, etc. For tasks Docker Trusted Registry
administrators need to accomplish, such as configuring or monitoring Docker Trusted Registry, please
visit the [Administrator's Guide]({{< relref "adminguide.md" >}}).
visit the [Administrator's Guide](adminguide.md).
## Overview
@ -32,7 +32,7 @@ push` command to add an image to a Docker Trusted Registry repository. To learn
images, see
[User Guide: Working with Docker Images](https://docs.docker.com/userguide/dockerimages/). For a step-by-step
example of the entire process, see the
[Quick Start: Basic Workflow Guide]({{< relref "quick-start.md" >}}).
[Quick Start: Basic Workflow Guide](quick-start.md).
> **Note**: If your Docker Trusted Registry instance has authentication enabled, you will need to
>use your command line to `docker login <dtr-hostname>` (e.g., `docker login
@ -122,7 +122,7 @@ your Docker Trusted Registry by adding it to the command:
## Next Steps
For information on administering Docker Trusted Registry, take a look at the
[Administrator's Guide]({{< relref "adminguide.md" >}}).
[Administrator's Guide](adminguide.md).
<!--TODO: