diff --git a/Makefile b/Makefile index 1a229cf600..df8cece166 100644 --- a/Makefile +++ b/Makefile @@ -1,17 +1,4 @@ -.PHONY: all binary build cross default docs docs-build docs-shell shell test test-unit test-integration test-integration-cli test-docker-py validate - -# env vars passed through directly to Docker's build scripts -# to allow things like `make DOCKER_CLIENTONLY=1 binary` easily -# `docs/sources/contributing/devenvironment.md ` and `project/PACKAGERS.md` have some limited documentation of some of these -DOCKER_ENVS := \ - -e BUILDFLAGS \ - -e DOCKER_CLIENTONLY \ - -e DOCKER_EXECDRIVER \ - -e DOCKER_GRAPHDRIVER \ - -e TESTDIRS \ - -e TESTFLAGS \ - -e TIMEOUT -# note: we _cannot_ add "-e DOCKER_BUILDTAGS" here because even if it's unset in the shell, that would shadow the "ENV DOCKER_BUILDTAGS" set in our Dockerfile, which is very important for our official builds +.PHONY: all default docs docs-build docs-shell shell test # to allow `make DOCSDIR=docs docs-shell` (to create a bind mount in docs) DOCS_MOUNT := $(if $(DOCSDIR),-v $(CURDIR)/$(DOCSDIR):/$(DOCSDIR)) @@ -25,9 +12,8 @@ HUGO_BASE_URL=$(shell test -z "$(DOCKER_IP)" && echo localhost || echo "$(DOCKER HUGO_BIND_IP=0.0.0.0 GIT_BRANCH := $(shell git rev-parse --abbrev-ref HEAD 2>/dev/null) -DOCKER_IMAGE := docker$(if $(GIT_BRANCH),:$(GIT_BRANCH)) -DOCKER_DOCS_IMAGE := docs-base$(if $(GIT_BRANCH),:$(GIT_BRANCH)) - +GIT_BRANCH_CLEAN := $(shell echo $(GIT_BRANCH) | sed -e "s/[^[:alnum:]]/-/g") +DOCKER_DOCS_IMAGE := docker-docs$(if $(GIT_BRANCH_CLEAN),:$(GIT_BRANCH_CLEAN)) DOCKER_RUN_DOCS := docker run --rm -it $(DOCS_MOUNT) -e AWS_S3_BUCKET -e NOCACHE @@ -36,7 +22,7 @@ GITCOMMIT := $(shell git rev-parse --short HEAD 2>/dev/null) default: docs -test: docs-build +local: docs-build $(DOCKER_RUN_DOCS) -p $(if $(DOCSPORT),$(DOCSPORT):)8000 \ -v $(CURDIR):/docs/content/docker-trusted-registry/ \ -e DOCKERHOST "$(DOCKER_DOCS_IMAGE)" \ @@ -50,17 +36,13 @@ docs: docs-build docs-draft: docs-build $(DOCKER_RUN_DOCS) -p $(if $(DOCSPORT),$(DOCSPORT):)8000 -e DOCKERHOST "$(DOCKER_DOCS_IMAGE)" hugo server --buildDrafts="true" --port=$(DOCSPORT) --baseUrl=$(HUGO_BASE_URL) --bind=$(HUGO_BIND_IP) - docs-shell: docs-build $(DOCKER_RUN_DOCS) -p $(if $(DOCSPORT),$(DOCSPORT):)8000 "$(DOCKER_DOCS_IMAGE)" bash +test: docs-build + $(DOCKER_RUN_DOCS) -p $(if $(DOCSPORT),$(DOCSPORT):)8000 "$(DOCKER_DOCS_IMAGE)" docs-build: -# ( git remote | grep -v upstream ) || git diff --name-status upstream/release..upstream/docs ./ > ./changed-files -# echo "$(GIT_BRANCH)" > GIT_BRANCH -# echo "$(AWS_S3_BUCKET)" > AWS_S3_BUCKET -# echo "$(GITCOMMIT)" > GITCOMMIT - # bring the generated apidocs into the context. rm -rf ./apidocgen/ cp -r ../apidocgen/output apidocgen docker build -t "$(DOCKER_DOCS_IMAGE)" . diff --git a/configure/config-auth.md b/configure/config-auth.md index f64aaed75d..4faabdf222 100644 --- a/configure/config-auth.md +++ b/configure/config-auth.md @@ -39,7 +39,7 @@ See the [configuration overview](configuration.md) to manually create an admin a ## Managed authentication -With `Managed` authentication, the Trusted Registry admin can manually control users' access by setting username/password pairs. The admin can then [use the API](http://docs.docker.com/apidocs/v1.3.3/) to give these users global "admin", "read-write" or "read-only" privileges while assigning them organization, team, or user repository access. Note that you can **only** set the global role of `Admin - all repositories` though the UI for the admin. The global roles for `Read-write - all repositories` and `Read-only - all repositories` have been deprecated. +With `Managed` authentication, the Trusted Registry admin can manually control users' access by setting username/password pairs. The admin can then [use the API](https://docs.docker.com/apidocs/v1.3.3/) to give these users global "admin", "read-write" or "read-only" privileges while assigning them organization, team, or user repository access. Note that you can **only** set the global role of `Admin - all repositories` though the UI for the admin. The global roles for `Read-write - all repositories` and `Read-only - all repositories` have been deprecated. When you create users and assign their roles through the API, you do not need to assign those users roles using the Trusted Registry admin UI. diff --git a/configure/config-storage.md b/configure/config-storage.md index c3dbf3bfd7..e91bd12686 100644 --- a/configure/config-storage.md +++ b/configure/config-storage.md @@ -160,10 +160,10 @@ YAML file (which is discussed further in this document.) >**Note**: Changing your storage backend requires you to restart the Trusted Registry. -See the [Registry configuration](http://docs.docker.com/registry/configuration/) +See the [Registry configuration](/registry/configuration.md) documentation for the full options specific to each driver. Storage drivers can be customized through the [Docker Registry storage driver -API](http://docs.docker.com/registry/storagedrivers/#storage-driver-api). +API](/registry/storage-drivers/index.md#storage-driver-api). ### Filesystem settings @@ -191,7 +191,7 @@ region, chunksize, and prefix. If the previous quick setup options are not sufficient to configure your Registry options, you can upload a YAML file. The schema of this file is -identical to that used by the [Registry](http://docs.docker.com/registry/configuration/). +identical to that used by the [Registry](/registry/configuration.md). There are several benefits to using a YAML file as it can provide an additional level of granularity in defining your storage backend. Advantages @@ -207,7 +207,7 @@ include: 2. Select Download to get the text based file. It contains a minimum amount of information and you're going to need additional data based on your driver and business requirements. -3. Go [here](http://docs.docker.com/registry/configuration/#list-of-configuration-options") to see the open source YAML file. Copy the sections you need and paste into your `storage.yml` file. Note that some settings may contradict others, so +3. Go [here](/registry/configuration.md#list-of-configuration-options") to see the open source YAML file. Copy the sections you need and paste into your `storage.yml` file. Note that some settings may contradict others, so ensure your choices make sense. 4. Save the YAML file and return to the UI. 5. On the Storage screen, upload the file, review your changes, and click Save. diff --git a/cs-engine/release-notes/prior-release-notes.md b/cs-engine/release-notes/prior-release-notes.md index 9b7b8dd8d1..cbf98e6492 100644 --- a/cs-engine/release-notes/prior-release-notes.md +++ b/cs-engine/release-notes/prior-release-notes.md @@ -27,7 +27,7 @@ fully manageable on its own lifecycle. You can also use plugins to extend network functionality. * Docker, Inc. now provides support for the in-box Overlay (for cross-host networking) and Bridge network plugins. You can find more information about how -to manage networks and using network plugins in the [documentation](https://docs.docker.com/engine/userguide/networking/dockernetworks/). +to manage networks and using network plugins in the [documentation](/engine/userguide/networking/dockernetworks.md). * Volume Management and Plugins. Volumes also become discrete, manageable objects in Docker. Volumes can be listed, created, deleted, and inspected. Similar to networks, they have their own managed lifecycle outside of the @@ -271,5 +271,5 @@ Because this addition is preventative, no CVE-ID is requested. ## CS Engine 1.6.0-cs2 (23 Apr 2015) -First release, see the [Docker Engine 1.6.0 Release notes](http://docs.docker.com/v1.6/release-notes/) +First release, see the [Docker Engine 1.6.0 Release notes](https://docs.docker.com/v1.6/release-notes/) for more details. diff --git a/install/install-dtr.md b/install/install-dtr.md index 1d0d19b565..de2e2ad314 100644 --- a/install/install-dtr.md +++ b/install/install-dtr.md @@ -25,13 +25,13 @@ Use these instructions to install DTR. ## Step 1. Validate the system requirements The first step in installing DTR, is ensuring your -infrastructure has all the [requirements DTR needs to run](system-requirements). +infrastructure has all the [requirements DTR needs to run](system-requirements.md). ## Step 2. Install UCP Since DTR requires a Docker Universal Control Plane (UCP) cluster to run, you need to install UCP first. -[Learn how to install UCP](http://docs.docker.com/ucp/installation/install-production/). +[Learn how to install UCP](https://docs.docker.com/ucp/installation/install-production/). ## Step 3. Install DTR diff --git a/quick-start.md b/quick-start.md index 95568af6fb..d8a23b0bcf 100644 --- a/quick-start.md +++ b/quick-start.md @@ -52,7 +52,7 @@ First, you will retrieve a copy of the official Jenkins image from the Docker Hu Docker can't find an image locally, it will attempt to pull the image from the Docker Hub. From the CLI of a machine running the Docker Engine on your network, use the -[`docker pull`](https://docs.docker.com/reference/commandline/pull) +[`docker pull`](/engine/reference/commandline/pull.md) command to pull the public Jenkins image. $ docker pull jenkins @@ -61,7 +61,7 @@ command to pull the public Jenkins image. > you are a member of the `docker` group or have root privileges. Otherwise, you > may need to add `sudo` to the example commands below. -Docker will start the process of pulling the image from the Hub. Once it has completed, the Jenkins image should be visible in the output of a [`docker images`](https://docs.docker.com/reference/commandline/images) command, which lists your available images: +Docker will start the process of pulling the image from the Hub. Once it has completed, the Jenkins image should be visible in the output of a [`docker images`](/engine/reference/commandline/images.md) command, which lists your available images: $ docker images REPOSITORY TAG IMAGE ID CREATED VIRTUAL SIZE @@ -119,7 +119,7 @@ image, you need to: ### Creating a Dockerfile In the same directory as the `plugins` file and the private key and certificate, -create a new [`Dockerfile`](https://docs.docker.com/reference/builder/) with the +create a new [`Dockerfile`](/engine/reference/builder.md) with the following contents: FROM jenkins @@ -167,7 +167,7 @@ the image being built. Now that the `Dockerfile`, the `plugins` file, and the files required for HTTPS operation are created in your current working directory, you can build your custom image using the -[`docker build` command](https://docs.docker.com/reference/commandline/build): +[`docker build` command](/engine/reference/commandline/build.md): docker build -t dtr.yourdomain.com/ci-infrastructure/jnkns-img . @@ -217,7 +217,7 @@ image pulled earlier: > request failed with status: 401 Unauthorized Now that you’ve created the custom image, it can be pushed to Docker Trusted Registry using the -[`docker push` command](https://docs.docker.com/reference/commandline/push): +[`docker push` command](/engine/reference/commandline/push.md): $ docker push dtr.yourdomain.com/ci-infrastructure/jnkns-img 511136ea3c5a: Image successfully pushed @@ -237,7 +237,7 @@ Docker host that has access to Docker Trusted Registry. ## Pulling from Docker Trusted Registry To pull the `jnkns-img` image from Docker Trusted Registry, run the -[`docker pull`](https://docs.docker.com/reference/commandline/pull) +[`docker pull`](/engine/reference/commandline/pull.md) command from any Docker Host that has access to your Docker Trusted Registry instance: $ docker pull dtr.yourdomain.com/ci-infrastructure/jnkns-img @@ -264,7 +264,7 @@ in the output of the `docker images` command: Now that you’ve successfully pulled the customized Jenkins image from Docker Trusted Registry, you can create a container from it with the -[`docker run` command](https://docs.docker.com/reference/commandline/run): +[`docker run` command](/engine/reference/commandline/run.md): $ docker run -p 1973:1973 --name jenkins01 dtr.yourdomain.com/ci-infrastructure/jnkns-img @@ -287,7 +287,7 @@ can create a container from it with the > your environment. You can view the newly launched a container, called `jenkins01`, using the -[`docker ps` command](https://docs.docker.com/reference/commandline/ps): +[`docker ps` command](/engine/reference/commandline/ps.md): $ docker ps CONTAINER ID IMAGE COMMAND CREATED STATUS ...PORTS NAMES diff --git a/release-notes/prior-release-notes.md b/release-notes/prior-release-notes.md index 4a3534d084..3ca465d338 100644 --- a/release-notes/prior-release-notes.md +++ b/release-notes/prior-release-notes.md @@ -138,7 +138,7 @@ documentation. * Users, depending on their roles, can access account information through the Trusted Registry UI. - * View new API documentation through the Trusted Registry UI. You can also view this [documentation](https://docs.docker.com/docker-trusted-registry/) from Docker, Inc. docs section. + * View new API documentation through the Trusted Registry UI. You can also view this [documentation](/docker-trusted-registry/overview.md) from Docker, Inc. docs section. * New APIs @@ -260,7 +260,7 @@ This release addresses a few bugs and issues in Docker Trusted Registry 1.2.0 an * A completely new user-interface for the Admin application brings Docker Trusted Registry in line with other Docker products and provides greater ease-of-use. -* A new Accounts & Repos API provides new fine-grained role-based access control down to the per-repo level. See the [API's documentation](http://docs.docker.com/apidocs/v1.3.3/) for more information. +* A new Accounts & Repos API provides new fine-grained role-based access control down to the per-repo level. See the [API's documentation](https://docs.docker.com/apidocs/v1.3.3/) for more information. * Improvements to the handling of configuration changes so that fewer restarts are required. diff --git a/repos-and-images/push-and-pull-images.md b/repos-and-images/push-and-pull-images.md index f00bb206a5..a2cea05499 100644 --- a/repos-and-images/push-and-pull-images.md +++ b/repos-and-images/push-and-pull-images.md @@ -22,7 +22,7 @@ development environments. Pushing and pulling images with Trusted Registry works similarly like any other Docker registry. You use the `docker pull` command to retrieve images and the `docker push` command to add an image. To learn more about Docker images, see -[User Guide: Working with Docker Images](https://docs.docker.com/engine/userguide/dockerimages/). For a step-by-step +[User Guide: Working with Docker Images](/engine/userguide/containers/dockerimages.md). For a step-by-step example of the entire process, see the [Quickstart guide](../quick-start.md). @@ -49,7 +49,7 @@ example of the entire process, see the ## Push images You push an image up to a Docker Trusted Registry repository by using the -[`docker push` command](https://docs.docker.com/reference/commandline/push). +[`docker push` command](/engine/reference/commandline/push.md). You can add a `tag` to your image so that you can more easily identify it among other variants and so that it refers to your Docker Trusted Registry server. @@ -83,9 +83,9 @@ Once an image is tagged, you can push it to Docker Trusted Registry with: ## Pull images You can retrieve an image with the -[`docker pull` command](https://docs.docker.com/reference/commandline/run), +[`docker pull` command](/engine/reference/commandline/run.md), or you can retrieve an image and run Docker to build the container with the -[`docker run`command](https://docs.docker.com/reference/commandline/run). +[`docker run`command](/engine/reference/commandline/run.md). To retrieve an image from the Trusted Registry and then run Docker to build the container, add