diff --git a/.gitignore b/.gitignore index 366c6d8a5a..010dcf6657 100644 --- a/.gitignore +++ b/.gitignore @@ -6,5 +6,4 @@ _site/** .sass-cache/** CNAME Gemfile.lock -_samples/library/** _kbase/** diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d9c125d19f..e3bda7862a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,7 +7,7 @@ help. If a reviewer realizes you have based your work on the wrong branch, we'll let you know so that you can rebase it. >**Note**: To contribute code to Docker projects, see the -[Contribution guidelines](opensource/). +[Contribution guidelines](/opensource/). ### Files not edited here @@ -30,7 +30,7 @@ you give it a try! ### Overall doc improvements -Most commits will be made against the `master` branch. This include: +Most commits will be made against the `master` branch. This includes: - Conceptual and task-based information not specific to new features - Restructuring / rewriting @@ -121,5 +121,5 @@ know. ## Style guide -Docker does not currently maintain a style guide. Use your best judgment, and +Docker does not currently maintain a style guide. Use your best judgment, and try to follow the example set by the existing documentation. diff --git a/Dockerfile b/Dockerfile index f91e3545d8..07e4dec0e3 100644 --- a/Dockerfile +++ b/Dockerfile @@ -64,15 +64,6 @@ COPY --from=docs/docker.github.io:v17.12 ${TARGET} ${TARGET} COPY --from=docs/docker.github.io:v18.03 ${TARGET} ${TARGET} COPY --from=docs/docker.github.io:v18.09 ${TARGET} ${TARGET} -# Fetch library samples (documentation from official images on Docker Hub) -# Only add the files that are needed to build these reference docs, so that -# these docs are only rebuilt if changes were made to the configuration. -# @todo find a way to build HTML in this stage, and still have them included in the navigation tree -FROM builderbase AS library-samples -COPY ./_scripts/fetch-library-samples.sh ./_scripts/ -COPY ./_samples/boilerplate.txt ./_samples/ -RUN bash ./_scripts/fetch-library-samples.sh - # Fetch upstream resources (reference documentation) # Only add the files that are needed to build these reference docs, so that # these docs are only rebuilt if changes were made to the configuration. @@ -86,7 +77,6 @@ RUN bash ./_scripts/fetch-upstream-resources.sh . # Build the current docs from the checked out branch FROM builderbase AS current COPY . . -COPY --from=library-samples /usr/src/app/md_source/. ./ COPY --from=upstream-resources /usr/src/app/md_source/. ./ # Build the static HTML, now that everything is in place diff --git a/Jenkinsfile b/Jenkinsfile index 5ab1a8d441..0f6897f2f0 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -46,7 +46,9 @@ pipeline { withDockerRegistry(reg) { sh """ docker build -t docs/docker.github.io:prod-${env.BUILD_NUMBER} . + docker tag docs/docker.github.io:prod-${env.BUILD_NUMBER} docs/docker.github.io:latest docker push docs/docker.github.io:prod-${env.BUILD_NUMBER} + docker push docs/docker.github.io:latest unzip -o $UCP_BUNDLE cd ucp-bundle-success_bot export DOCKER_TLS_VERIFY=1 @@ -105,4 +107,11 @@ pipeline { } } } + post { + unsuccessful { + sh """ + curl -X POST -H 'Content-type: application/json' --data '{"text":"Error in docker.github.io:published build. Please contact the Customer Success Engineering team for help."}' $SLACK + """ + } + } } diff --git a/_config.yml b/_config.yml index c8b91ebebe..77b4854621 100644 --- a/_config.yml +++ b/_config.yml @@ -111,7 +111,7 @@ defaults: - scope: path: "install" values: - win_latest_build: "docker-19.03.1" + win_latest_build: "docker-19.03.2" - scope: path: "datacenter" values: @@ -124,8 +124,8 @@ defaults: ucp_repo: "ucp" dtr_org: "docker" dtr_repo: "dtr" - ucp_version: "3.2.0" - dtr_version: "2.7.1" + ucp_version: "3.2.1" + dtr_version: "2.7.2" # Previous DTR Releases - scope: path: "datacenter/dtr/2.6" @@ -133,21 +133,21 @@ defaults: hide_from_sitemap: true dtr_org: "docker" dtr_repo: "dtr" - dtr_version: "2.6.8" + dtr_version: "2.6.9" - scope: path: "datacenter/dtr/2.5" values: hide_from_sitemap: true dtr_org: "docker" dtr_repo: "dtr" - dtr_version: "2.5.13" + dtr_version: "2.5.14" - scope: path: "datacenter/dtr/2.4" values: hide_from_sitemap: true dtr_org: "docker" dtr_repo: "dtr" - dtr_version: "2.4.13" + dtr_version: "2.4.14" - scope: path: "datacenter/dtr/2.3" values: @@ -178,21 +178,21 @@ defaults: hide_from_sitemap: true ucp_org: "docker" ucp_repo: "ucp" - ucp_version: "3.1.9" + ucp_version: "3.1.10" - scope: path: "datacenter/ucp/3.0" values: hide_from_sitemap: true ucp_org: "docker" ucp_repo: "ucp" - ucp_version: "3.0.13" + ucp_version: "3.0.14" - scope: path: "datacenter/ucp/2.2" values: hide_from_sitemap: true ucp_org: "docker" ucp_repo: "ucp" - ucp_version: "2.2.20" + ucp_version: "2.2.21" - scope: path: "datacenter/ucp/2.1" values: diff --git a/_data/ddc_offline_files_2.yaml b/_data/ddc_offline_files_2.yaml index 529ca2fefe..a025a83786 100644 --- a/_data/ddc_offline_files_2.yaml +++ b/_data/ddc_offline_files_2.yaml @@ -6,6 +6,12 @@ - product: "ucp" version: "3.2" tar-files: + - description: "3.2.1 Linux" + url: https://packages.docker.com/caas/ucp_images_3.2.1.tar.gz + - description: "3.2.1 Windows Server 2016 LTSC" + url: https://packages.docker.com/caas/ucp_images_win_2016_3.2.1.tar.gz + - description: "3.2.1 Windows Server 2019 LTSC" + url: https://packages.docker.com/caas/ucp_images_win_2019_3.2.1.tar.gz - description: "3.2.0 Linux" url: https://packages.docker.com/caas/ucp_images_3.2.0.tar.gz - description: "3.2.0 Windows Server 2016 LTSC" @@ -15,6 +21,14 @@ - product: "ucp" version: "3.1" tar-files: + - description: "3.1.10 Linux" + url: https://packages.docker.com/caas/ucp_images_3.1.10.tar.gz + - description: "3.1.10 Windows Server 2016 LTSC" + url: https://packages.docker.com/caas/ucp_images_win_2016_3.1.10.tar.gz + - description: "3.1.10 Windows Server 1803" + url: https://packages.docker.com/caas/ucp_images_win_1803_3.1.10.tar.gz + - description: "3.1.10 Windows Server 2019 LTSC" + url: https://packages.docker.com/caas/ucp_images_win_2019_3.1.10.tar.gz - description: "3.1.9 Linux" url: https://packages.docker.com/caas/ucp_images_3.1.9.tar.gz - description: "3.1.9 Windows Server 2016 LTSC" @@ -108,6 +122,14 @@ - product: "ucp" version: "3.0" tar-files: + - description: "3.0.14 Linux" + url: https://packages.docker.com/caas/ucp_images_3.0.14.tar.gz + - description: "3.0.14 IBM Z" + url: https://packages.docker.com/caas/ucp_images_s390x_3.0.14.tar.gz + - description: "3.0.14 Windows Server 2016 LTSC" + url: https://packages.docker.com/caas/ucp_images_win_2016_3.0.14.tar.gz + - description: "3.0.14 Windows Server 1803" + url: https://packages.docker.com/caas/ucp_images_win_1803_3.0.14.tar.gz - description: "3.0.13 Linux" url: https://packages.docker.com/caas/ucp_images_3.0.13.tar.gz - description: "3.0.13 IBM Z" @@ -227,6 +249,12 @@ - product: "ucp" version: "2.2" tar-files: + - description: "2.2.21 Linux" + url: https://packages.docker.com/caas/ucp_images_2.2.21.tar.gz + - description: "2.2.21 IBM Z" + url: https://packages.docker.com/caas/ucp_images_s390x_2.2.21.tar.gz + - description: "2.2.21 Windows" + url: https://packages.docker.com/caas/ucp_images_win_2.2.21.tar.gz - description: "2.2.20 Linux" url: https://packages.docker.com/caas/ucp_images_2.2.20.tar.gz - description: "2.2.20 IBM Z" @@ -344,6 +372,8 @@ - product: "dtr" version: "2.7" tar-files: + - description: "DTR 2.7.2 Linux x86" + url: https://packages.docker.com/caas/dtr_images_2.7.2.tar.gz - description: "DTR 2.7.1 Linux x86" url: https://packages.docker.com/caas/dtr_images_2.7.1.tar.gz - description: "DTR 2.7.0 Linux x86" @@ -351,6 +381,8 @@ - product: "dtr" version: "2.6" tar-files: + - description: "DTR 2.6.9 Linux x86" + url: https://packages.docker.com/caas/dtr_images_2.6.9.tar.gz - description: "DTR 2.6.8 Linux x86" url: https://packages.docker.com/caas/dtr_images_2.6.8.tar.gz - description: "DTR 2.6.7 Linux x86" @@ -372,6 +404,8 @@ - product: "dtr" version: "2.5" tar-files: + - description: "DTR 2.5.14 Linux x86" + url: https://packages.docker.com/caas/dtr_images_2.5.14.tar.gz - description: "DTR 2.5.13 Linux x86" url: https://packages.docker.com/caas/dtr_images_2.5.13.tar.gz - description: "DTR 2.5.12 Linux x86" @@ -401,6 +435,8 @@ - product: "dtr" version: "2.4" tar-files: + - description: "DTR 2.4.14 Linux x86" + url: https://packages.docker.com/caas/dtr_images_2.4.14.tar.gz - description: "DTR 2.4.13 Linux x86" url: https://packages.docker.com/caas/dtr_images_2.4.13.tar.gz - description: "DTR 2.4.12 Linux x86" diff --git a/_data/glossary.yaml b/_data/glossary.yaml index 659648bd26..2ab21dae3a 100644 --- a/_data/glossary.yaml +++ b/_data/glossary.yaml @@ -1,4 +1,4 @@ -amd64: | +amd64: | AMD64 is AMD's 64-bit extension of Intel's x86 architecture, and is also referred to as x86_64 (or x86-64). aufs: | @@ -26,6 +26,8 @@ cgroups: | of processes. Docker relies on cgroups to control and isolate resource limits. *Also known as : control groups* +cluster: | + A cluster is a group of machines that work together to run workloads and provide high availability. collection: | A collection is a group of swarm resources that Docker Engine - Enterprise uses for role-based access control. Collections enable organizing permissions for resources like @@ -219,6 +221,8 @@ parent image: | in the image's Dockerfile. All subsequent commands are applied to this parent image. A Dockerfile with no `FROM` directive has no parent image, and is called a **base image**. +persistent storage: | + Persistent storage or volume storage provides a way for a user to add a persistent layer to the running container's file system. This persistent layer could live on the container host or an external device. The lifecycle of this persistent layer is not connected to the lifecycle of the container, allowing a user to retain state. registry: | A Registry is a hosted service containing [repositories](#repository) of [images](#image) which responds to the Registry API. diff --git a/_data/toc.yaml b/_data/toc.yaml index ac5387e71d..3b29e9e293 100644 --- a/_data/toc.yaml +++ b/_data/toc.yaml @@ -285,7 +285,7 @@ guides: - path: /config/containers/runmetrics/ title: Container runtime metrics - path: /config/containers/resource_constraints/ - title: Limit a container's resources + title: Runtime options with Memory, CPUs, and GPUs - path: /config/labels-custom-metadata/ title: Apply custom metadata to containers nosync: true @@ -1257,9 +1257,6 @@ reference: samples: - path: /samples/#tutorial-labs title: Tutorial labs -- sectiontitle: Library references - section: - - generateTOC: library - sectiontitle: Sample applications section: - path: /samples/ @@ -1282,6 +1279,8 @@ samples: title: Riak - path: /engine/examples/running_ssh_service/ title: SSHd +- path: /samples/#library-references + title: Library references manuals: - sectiontitle: Docker Enterprise @@ -1296,8 +1295,12 @@ manuals: section: - path: /cluster/ title: Overview + - path: /cluster/release-notes/ + title: Release notes - path: /cluster/aws/ title: Docker Cluster on AWS + - path: /cluster/azure/ + title: Docker Cluster on Azure - path: /cluster/cluster-file/ title: Cluster file structure - path: /cluster/reference/envvars/ @@ -1479,7 +1482,7 @@ manuals: - title: Offline installation path: /ee/ucp/interlock/deploy/offline-install/ - title: Layer 7 routing upgrade - path: /ee/ucp/interlock/deploy/upgrade/ + path: /ee/ucp/interlock/deploy/upgrade/ - sectiontitle: Configuration section: - title: Configure your deployment @@ -1501,15 +1504,15 @@ manuals: - title: Using context or path-based routing path: /ee/ucp/interlock/usage/context/ - title: Specifying a routing mode - path: /ee/ucp/interlock/usage/interlock-vip-mode/ + path: /ee/ucp/interlock/usage/interlock-vip-mode/ - title: Using routing labels - path: /ee/ucp/interlock/usage/labels-reference/ + path: /ee/ucp/interlock/usage/labels-reference/ - title: Publishing a default host service path: /ee/ucp/interlock/usage/default-backend/ - title: Specifying a routing mode - path: /ee/ucp/interlock/usage/interlock-vip-mode/ + path: /ee/ucp/interlock/usage/interlock-vip-mode/ - title: Using routing labels - path: /ee/ucp/interlock/usage/labels-reference.md/ + path: /ee/ucp/interlock/usage/labels-reference.md/ - title: Implementing redirects path: /ee/ucp/interlock/usage/redirects/ - title: Implementing a service cluster @@ -1529,7 +1532,7 @@ manuals: - title: Deploy a Compose-based app path: /ee/ucp/kubernetes/deploy-with-compose/ - title: Using Pod Security Policies - path: /ee/ucp/kubernetes/pod-security-policies/ + path: /ee/ucp/kubernetes/pod-security-policies/ - title: Create a service account for a Kubernetes app path: /ee/ucp/kubernetes/create-service-account/ - title: Install an unmanaged CNI plugin @@ -1545,7 +1548,7 @@ manuals: - title: Use Azure Files Storage path: /ee/ucp/kubernetes/storage/use-azure-files/ - title: Use AWS EBS Storage - path: /ee/ucp/kubernetes/storage/configure-aws-storage/ + path: /ee/ucp/kubernetes/storage/configure-aws-storage/ - title: Configure iSCSI path: /ee/ucp/kubernetes/storage/use-iscsi/ - title: Deploy a CSI plugin @@ -1553,13 +1556,13 @@ manuals: - sectiontitle: Cluster Ingress section: - title: Overview - path: /ee/ucp/kubernetes/cluster-ingress/ + path: /ee/ucp/kubernetes/cluster-ingress/ - title: Install Ingress path: /ee/ucp/kubernetes/cluster-ingress/install/ - title: Deploy Simple Application path: /ee/ucp/kubernetes/cluster-ingress/ingress/ - title: Deploy a Canary Deployment - path: /ee/ucp/kubernetes/cluster-ingress/canary/ + path: /ee/ucp/kubernetes/cluster-ingress/canary/ - title: Implementing Persistent (sticky) Sessions path: /ee/ucp/kubernetes/cluster-ingress/sticky/ - title: API reference @@ -1756,7 +1759,7 @@ manuals: - title: Offline installation path: /datacenter/ucp/3.1/guides/interlock/deploy/offline-install/ - title: Layer 7 routing upgrade - path: /datacenter/ucp/3.1/guides/interlock/deploy/upgrade/ + path: /datacenter/ucp/3.1/guides/interlock/deploy/upgrade/ - sectiontitle: Configuration section: - title: Configure your deployment @@ -1778,9 +1781,9 @@ manuals: - title: Using context or path-based routing path: /datacenter/ucp/3.1/guides/interlock/usage/context/ - title: Specifying a routing mode - path: /datacenter/ucp/3.1/guides/interlock/usage/interlock-vip-mode/ + path: /datacenter/ucp/3.1/guides/interlock/usage/interlock-vip-mode/ - title: Using routing labels - path: /datacenter/ucp/3.1/guides/interlock/usage/labels-reference/ + path: /datacenter/ucp/3.1/guides/interlock/usage/labels-reference/ - title: Implementing redirects path: /datacenter/ucp/3.1/guides/interlock/usage/redirects/ - title: Implementing a service cluster @@ -1816,7 +1819,7 @@ manuals: - title: Use Azure Files Storage path: /datacenter/ucp/3.1/guides/kubernetes/storage/use-azure-files/ - title: Use AWS EBS Storage - path: /datacenter/ucp/3.1/guides/kubernetes/storage/configure-aws-storage/ + path: /datacenter/ucp/3.1/guides/kubernetes/storage/configure-aws-storage/ - title: API reference path: /datacenter/ucp/3.1/reference/api/ nosync: true @@ -2084,7 +2087,7 @@ manuals: - path: /datacenter/ucp/2.2/guides/admin/configure/run-only-the-images-you-trust/ title: Run only the images you trust - path: /datacenter/ucp/2.2/guides/admin/configure/use-trusted-images-for-ci/ - title: Use trusted images for continuous integration + title: Use trusted images for continuous integration - path: /datacenter/ucp/2.2/guides/admin/configure/scale-your-cluster/ title: Scale your cluster - path: /datacenter/ucp/2.2/guides/admin/configure/set-session-timeout/ @@ -2868,25 +2871,25 @@ manuals: path: /datacenter/dtr/2.6/guides/admin/disaster-recovery/restore-from-backup/ - sectiontitle: CLI Reference section: - - path: /reference/dtr/2.6/cli/ + - path: /datacenter/dtr/2.6/reference/cli/ title: Overview - - path: /reference/dtr/2.6/cli/backup/ + - path: /datacenter/dtr/2.6/reference/cli/backup/ title: backup - - path: /reference/dtr/2.6/cli/destroy/ + - path: /datacenter/dtr/2.6/reference/cli/destroy/ title: destroy - - path: /reference/dtr/2.6/cli/emergency-repair/ + - path: /datacenter/dtr/2.6/reference/cli/emergency-repair/ title: emergency-repair - - path: /reference/dtr/2.6/cli/install/ + - path: /datacenter/dtr/2.6/reference/cli/install/ title: install - - path: /reference/dtr/2.6/cli/join/ + - path: /datacenter/dtr/2.6/reference/cli/join/ title: join - - path: /reference/dtr/2.6/cli/reconfigure/ + - path: /datacenter/dtr/2.6/reference/cli/reconfigure/ title: reconfigure - - path: /reference/dtr/2.6/cli/remove/ + - path: /datacenter/dtr/2.6/reference/cli/remove/ title: remove - - path: /reference/dtr/2.6/cli/restore/ + - path: /datacenter/dtr/2.6/reference/cli/restore/ title: restore - - path: /reference/dtr/2.6/cli/upgrade/ + - path: /datacenter/dtr/2.6/reference/cli/upgrade/ title: upgrade - sectiontitle: User guides section: @@ -3751,7 +3754,7 @@ manuals: title: Docker Enterprise Architecture - path: /ee/supported-platforms/ title: Supported platforms - nosync: true + nosync: true - path: /ee/end-to-end-install/ title: Deploy Docker Enterprise - path: /ee/upgrade/ @@ -3777,7 +3780,7 @@ manuals: - path: /ee/admin/restore/restore-ucp/ title: Restore UCP - path: /ee/admin/restore/restore-dtr/ - title: Restore DTR + title: Restore DTR - path: /cluster/reference/restore/ title: Restore clusters with Docker Cluster - sectiontitle: Disaster Recovery @@ -3990,6 +3993,12 @@ manuals: section: - path: /docker-hub/ title: Quickstart + - sectiontitle: Security and Authentication + section: + - path: /docker-hub/access-tokens/ + title: Managing Access Tokens + - path: /docker-hub/release-notes/ + title: Release notes - path: /docker-hub/repos/ title: Repositories - path: /docker-hub/official_images/ @@ -4100,6 +4109,8 @@ manuals: title: Image manifest v 2, schema 1 - path: /registry/spec/manifest-v2-2/ title: Image manifest v 2, schema 2 + - path: /registry/spec/deprecated-schema-v1/ + title: Update deprecated schema v1 images - sectiontitle: Registry storage drivers section: - path: /registry/storage-drivers/ @@ -4131,7 +4142,7 @@ manuals: - path: /registry/spec/auth/token/ title: Token authentication specification - path: /release-notes/ - title: Release notes + title: Release notes - sectiontitle: Superseded products and tools section: - path: /cs-engine/1.13/release-notes/ @@ -4303,7 +4314,7 @@ manuals: - path: /swarm/swarm-api/ title: Docker Swarm API - path: /release-notes/docker-swarm/ - title: Docker Swarm release notes + title: Docker Swarm release notes - sectiontitle: Docker Toolbox (legacy) section: - path: /toolbox/overview/ diff --git a/_includes/cli.md b/_includes/cli.md index cc28bc268c..66ff4963b9 100644 --- a/_includes/cli.md +++ b/_includes/cli.md @@ -33,26 +33,26 @@ your client and daemon API versions. > This command is experimental. > -> This command is experimental on the Docker daemon. It should not be used in production environments. +> This command is experimental on the Docker daemon. It should not be used in +> production environments. > To enable experimental features on the Docker daemon, edit the > [daemon.json](/engine/reference/commandline/dockerd.md#daemon-configuration-file) > and set `experimental` to `true`. > > {% include experimental.md %} -{: .important } {% endif %} {% if site.data[include.datafolder][include.datafile].experimentalcli %} -> This command is experimental. +> This command is experimental on the Docker client. +> +> **It should not be used in production environments.** > -> This command is experimental on the Docker client. It should not be used in production environments. > To enable experimental features in the Docker CLI, edit the > [config.json](/engine/reference/commandline/cli.md#configuration-files) -> and set `experimental` to `enabled`. -> -> {% include experimental.md %} +> and set `experimental` to `enabled`. You can go [here](https://github.com/docker/docker.github.io/blob/master/_includes/experimental.md) +> for more information. {: .important } {% endif %} diff --git a/_includes/experimental.md b/_includes/experimental.md index 88cf393bf2..acab2783f5 100644 --- a/_includes/experimental.md +++ b/_includes/experimental.md @@ -1,6 +1,15 @@ -Experimental features provide early access to future product functionality. These features are intended for testing and feedback only as they may change between releases without warning or can be removed entirely from a future release. Experimental features must not be used in production environments. Docker does not offer support for experimental features. For more information, see [Experimental features](https://success.docker.com/article/experimental-features). +Experimental features provide early access to future product functionality. +These features are intended for testing and feedback only as they may change +between releases without warning or can be removed entirely from a future +release. Experimental features must not be used in production environments. +Docker does not offer support for experimental features. For more information, +see [Experimental features](https://success.docker.com/article/experimental-features). > -> To enable experimental features in the Docker CLI, edit the `config.json` file and set `experimental` to enabled. +> To enable experimental features in the Docker CLI, edit the `config.json` +> file and set `experimental` to enabled. > -> To enable experimental features from the Docker Desktop menu, click **Settings** (**Preferences** on macOS) > **Daemon** and then select the **Experimental features** check box. +> To enable experimental features from the Docker Desktop menu, click +> **Settings** (**Preferences** on macOS) > **Daemon** and then select the +> **Experimental features** check box. +{: .important } diff --git a/_includes/generateTOC.html b/_includes/generateTOC.html deleted file mode 100644 index d4db0fe9eb..0000000000 --- a/_includes/generateTOC.html +++ /dev/null @@ -1,3 +0,0 @@ -{% if include.tocToGenerate=="library"%}{% for thisPage in site.samples %} -