From dc7801c55b5aaf75a6b40eb01bb156b994c80214 Mon Sep 17 00:00:00 2001 From: Usha Mandya Date: Fri, 3 Jul 2020 15:25:54 +0100 Subject: [PATCH] Add note on Docker Hub --- docs/compatibility.md | 2 ++ docs/deploying.md | 2 ++ docs/deprecated.md | 2 ++ docs/garbage-collection.md | 2 ++ docs/help.md | 2 ++ docs/index.md | 2 ++ docs/insecure.md | 2 ++ docs/introduction.md | 2 ++ docs/notifications.md | 2 ++ docs/recipes/apache.md | 2 ++ docs/recipes/index.md | 2 ++ docs/recipes/mirror.md | 2 ++ docs/recipes/nginx.md | 2 ++ docs/recipes/osx-setup-guide.md | 2 ++ docs/storage-drivers/azure.md | 2 ++ docs/storage-drivers/filesystem.md | 2 ++ docs/storage-drivers/gcs.md | 2 ++ docs/storage-drivers/index.md | 2 ++ docs/storage-drivers/inmemory.md | 2 ++ docs/storage-drivers/oss.md | 2 ++ docs/storage-drivers/s3.md | 2 ++ docs/storage-drivers/swift.md | 2 ++ 22 files changed, 44 insertions(+) diff --git a/docs/compatibility.md b/docs/compatibility.md index 6462b557..d162d8d4 100644 --- a/docs/compatibility.md +++ b/docs/compatibility.md @@ -4,6 +4,8 @@ keywords: registry, manifest, images, tags, repository, distribution, digest title: Registry compatibility --- +{% include registry.md %} + ## Synopsis If a manifest is pulled by _digest_ from a registry 2.3 with Docker Engine 1.9 and older, and the manifest was pushed with Docker Engine 1.10, a security check diff --git a/docs/deploying.md b/docs/deploying.md index 8616cac2..ab26d756 100644 --- a/docs/deploying.md +++ b/docs/deploying.md @@ -4,6 +4,8 @@ keywords: registry, on-prem, images, tags, repository, distribution, deployment title: Deploy a registry server --- +{% include registry.md %} + Before you can deploy a registry, you need to install Docker on the host. A registry is an instance of the `registry` image, and runs within Docker. diff --git a/docs/deprecated.md b/docs/deprecated.md index d3242b25..a46b2c1f 100644 --- a/docs/deprecated.md +++ b/docs/deprecated.md @@ -4,6 +4,8 @@ keywords: registry, manifest, images, signatures, repository, distribution, dige title: Docker Registry deprecation --- +{% include registry.md %} + This document details functionality or components which are deprecated within the registry. diff --git a/docs/garbage-collection.md b/docs/garbage-collection.md index cc301c6a..76832865 100644 --- a/docs/garbage-collection.md +++ b/docs/garbage-collection.md @@ -4,6 +4,8 @@ keywords: registry, garbage, images, tags, repository, distribution title: Garbage collection --- +{% include registry.md %} + As of v2.4.0 a garbage collector command is included within the registry binary. This document describes what this command does and how and why it should be used. diff --git a/docs/help.md b/docs/help.md index da1f16f9..ea745f34 100644 --- a/docs/help.md +++ b/docs/help.md @@ -4,6 +4,8 @@ keywords: registry, on-prem, images, tags, repository, distribution, help, 101, title: Get help --- +{% include registry.md %} + If you need help, or just want to chat, you can reach us: - on the [Docker forums](https://forums.docker.com/c/open-source-projects/opensrcreg). diff --git a/docs/index.md b/docs/index.md index 5d05205a..a9158ee4 100644 --- a/docs/index.md +++ b/docs/index.md @@ -6,6 +6,8 @@ redirect_from: title: Docker Registry --- +{% include registry.md %} + ## What it is The Registry is a stateless, highly scalable server side application that stores diff --git a/docs/insecure.md b/docs/insecure.md index 7aa512a9..df630ee8 100644 --- a/docs/insecure.md +++ b/docs/insecure.md @@ -4,6 +4,8 @@ keywords: registry, on-prem, images, tags, repository, distribution, insecure title: Test an insecure registry --- +{% include registry.md %} + While it's highly recommended to secure your registry using a TLS certificate issued by a known CA, you can choose to use self-signed certificates, or use your registry over an unencrypted HTTP connection. Either of these choices diff --git a/docs/introduction.md b/docs/introduction.md index 471ad510..bb634861 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -4,6 +4,8 @@ keywords: registry, on-prem, images, tags, repository, distribution, use cases, title: About Registry --- +{% include registry.md %} + A registry is a storage and content delivery system, holding named Docker images, available in different tagged versions. diff --git a/docs/notifications.md b/docs/notifications.md index f11b53f1..62854f81 100644 --- a/docs/notifications.md +++ b/docs/notifications.md @@ -4,6 +4,8 @@ keywords: registry, on-prem, images, tags, repository, distribution, notificatio title: Work with notifications --- +{% include registry.md %} + The Registry supports sending webhook notifications in response to events happening within the registry. Notifications are sent in response to manifest pushes and pulls and layer pushes and pulls. These actions are serialized into diff --git a/docs/recipes/apache.md b/docs/recipes/apache.md index b559d264..45a10c66 100644 --- a/docs/recipes/apache.md +++ b/docs/recipes/apache.md @@ -4,6 +4,8 @@ keywords: registry, on-prem, images, tags, repository, distribution, authenticat title: Authenticate proxy with apache --- +{% include registry.md %} + ## Use-case People already relying on an apache proxy to authenticate their users to other services might want to leverage it and have Registry communications tunneled through the same pipeline. diff --git a/docs/recipes/index.md b/docs/recipes/index.md index 97d32269..c7c0cae3 100644 --- a/docs/recipes/index.md +++ b/docs/recipes/index.md @@ -4,6 +4,8 @@ keywords: registry, on-prem, images, tags, repository, distribution, recipes, ad title: Recipes overview --- +{% include registry.md %} + This list of "recipes" provides end-to-end scenarios for exotic or otherwise advanced use-cases. These recipes are not useful for most standard set-ups. diff --git a/docs/recipes/mirror.md b/docs/recipes/mirror.md index 09e25abb..949a8118 100644 --- a/docs/recipes/mirror.md +++ b/docs/recipes/mirror.md @@ -6,6 +6,8 @@ redirect_from: - /engine/admin/registry_mirror/ --- +{% include registry.md %} + ## Use-case If you have multiple instances of Docker running in your environment, such as diff --git a/docs/recipes/nginx.md b/docs/recipes/nginx.md index 87d0358b..892e132a 100644 --- a/docs/recipes/nginx.md +++ b/docs/recipes/nginx.md @@ -6,6 +6,8 @@ redirect_from: - /registry/nginx/ --- +{% include registry.md %} + ## Use-case People already relying on a nginx proxy to authenticate their users to other diff --git a/docs/recipes/osx-setup-guide.md b/docs/recipes/osx-setup-guide.md index d5f09299..90891fd4 100644 --- a/docs/recipes/osx-setup-guide.md +++ b/docs/recipes/osx-setup-guide.md @@ -4,6 +4,8 @@ keywords: registry, on-prem, images, tags, repository, distribution, macOS, reci title: macOS setup guide --- +{% include registry.md %} + ## Use-case This is useful if you intend to run a registry server natively on macOS. diff --git a/docs/storage-drivers/azure.md b/docs/storage-drivers/azure.md index 28363e55..bc3007ac 100644 --- a/docs/storage-drivers/azure.md +++ b/docs/storage-drivers/azure.md @@ -4,6 +4,8 @@ keywords: registry, service, driver, images, storage, azure title: Microsoft Azure storage driver --- +{% include registry.md %} + An implementation of the `storagedriver.StorageDriver` interface which uses [Microsoft Azure Blob Storage](http://azure.microsoft.com/en-us/services/storage/) for object storage. ## Parameters diff --git a/docs/storage-drivers/filesystem.md b/docs/storage-drivers/filesystem.md index ab50f0f6..7935f7d3 100644 --- a/docs/storage-drivers/filesystem.md +++ b/docs/storage-drivers/filesystem.md @@ -4,6 +4,8 @@ keywords: registry, service, driver, images, storage, filesystem title: Filesystem storage driver --- +{% include registry.md %} + An implementation of the `storagedriver.StorageDriver` interface which uses the local filesystem. ## Parameters diff --git a/docs/storage-drivers/gcs.md b/docs/storage-drivers/gcs.md index 624ea616..d9184254 100644 --- a/docs/storage-drivers/gcs.md +++ b/docs/storage-drivers/gcs.md @@ -4,6 +4,8 @@ keywords: registry, service, driver, images, storage, gcs, google, cloud title: Google Cloud Storage driver --- +{% include registry.md %} + An implementation of the `storagedriver.StorageDriver` interface which uses Google Cloud for object storage. ## Parameters diff --git a/docs/storage-drivers/index.md b/docs/storage-drivers/index.md index 9025bced..097ffab7 100644 --- a/docs/storage-drivers/index.md +++ b/docs/storage-drivers/index.md @@ -6,6 +6,8 @@ redirect_from: title: Docker Registry storage driver --- +{% include registry.md %} + This document describes the registry storage driver model, implementation, and explains how to contribute new storage drivers. ## Provided drivers diff --git a/docs/storage-drivers/inmemory.md b/docs/storage-drivers/inmemory.md index b4bdaeed..6e913045 100644 --- a/docs/storage-drivers/inmemory.md +++ b/docs/storage-drivers/inmemory.md @@ -4,6 +4,8 @@ keywords: registry, service, driver, images, storage, in-memory title: In-memory storage driver (testing only) --- +{% include registry.md %} + For purely tests purposes, you can use the `inmemory` storage driver. This driver is an implementation of the `storagedriver.StorageDriver` interface which uses local memory for object storage. If you would like to run a registry from diff --git a/docs/storage-drivers/oss.md b/docs/storage-drivers/oss.md index 23016dd5..4a18c1f5 100644 --- a/docs/storage-drivers/oss.md +++ b/docs/storage-drivers/oss.md @@ -4,6 +4,8 @@ keywords: registry, service, driver, images, storage, OSS, aliyun title: Aliyun OSS storage driver --- +{% include registry.md %} + An implementation of the `storagedriver.StorageDriver` interface which uses [Aliyun OSS](https://www.alibabacloud.com/product/oss) for object storage. diff --git a/docs/storage-drivers/s3.md b/docs/storage-drivers/s3.md index 6dafd947..91a13dc6 100644 --- a/docs/storage-drivers/s3.md +++ b/docs/storage-drivers/s3.md @@ -4,6 +4,8 @@ keywords: registry, service, driver, images, storage, S3 title: S3 storage driver --- +{% include registry.md %} + An implementation of the `storagedriver.StorageDriver` interface which uses Amazon S3 or S3 compatible services for object storage. diff --git a/docs/storage-drivers/swift.md b/docs/storage-drivers/swift.md index cda1d060..f0027ee8 100644 --- a/docs/storage-drivers/swift.md +++ b/docs/storage-drivers/swift.md @@ -4,6 +4,8 @@ keywords: registry, service, driver, images, storage, swift title: OpenStack Swift storage driver --- +{% include registry.md %} + An implementation of the `storagedriver.StorageDriver` interface that uses [OpenStack Swift](http://docs.openstack.org/developer/swift/) for object storage.