fix type of keywords entry in frontmatter (in /registry/) (#517)

keywords should be a string, not an array containing one string

Signed-off-by: Gaetan de Villele <gdevillele@gmail.com>
pull/3397/head
Gaetan 2016-11-10 11:54:25 -08:00 committed by John Mulhausen
parent bc1e162172
commit cc71bedafb
33 changed files with 68 additions and 101 deletions

View File

@ -1,7 +1,6 @@
---
description: describes get by digest pitfall
keywords:
- registry, manifest, images, tags, repository, distribution, digest
keywords: registry, manifest, images, tags, repository, distribution, digest
title: Registry compatibility
---
@ -75,4 +74,4 @@ constraints of CAS.*
For this reason 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 will cause the Engine to receive a manifest it cannot use and the
pull will fail.
pull will fail.

View File

@ -1,7 +1,6 @@
---
description: Explains how to configure a registry
keywords:
- registry, on-prem, images, tags, repository, distribution, configuration
keywords: registry, on-prem, images, tags, repository, distribution, configuration
title: Registry configuration reference
---
@ -1857,4 +1856,4 @@ The following example illustrates these values:
>**Note**: Cloudfront keys exist separately to other AWS keys. See
>[the documentation on AWS credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html)
>for more information.
>for more information.

View File

@ -1,7 +1,6 @@
---
description: Explains how to deploy a registry
keywords:
- registry, on-prem, images, tags, repository, distribution, deployment
keywords: registry, on-prem, images, tags, repository, distribution, deployment
title: Deploying a registry server
---
@ -228,4 +227,4 @@ You will find more specific and advanced informations in the following sections:
- [Advanced "recipes"](recipes/index.md)
- [Registry API](spec/api.md)
- [Storage driver model](storage-drivers/index.md)
- [Token authentication](spec/auth/token.md)
- [Token authentication](spec/auth/token.md)

View File

@ -1,7 +1,6 @@
---
description: describes deprecated functionality
keywords:
- registry, manifest, images, signatures, repository, distribution, digest
keywords: registry, manifest, images, signatures, repository, distribution, digest
title: Docker Registry deprecation
---
@ -18,4 +17,4 @@ not stored in the registry. This does not alter the functional behavior of
the registry.
Old signatures blobs can be removed from the registry storage by running the
garbage-collect subcommand.
garbage-collect subcommand.

View File

@ -1,7 +1,6 @@
---
description: High level discussion of garbage collection
keywords:
- registry, garbage, images, tags, repository, distribution
keywords: registry, garbage, images, tags, repository, distribution
title: Garbage collection
---
@ -127,4 +126,4 @@ blob eligible for deletion: sha256:7e15ce58ccb2181a8fced7709e9893206f0937cc9543b
blob eligible for deletion: sha256:87192bdbe00f8f2a62527f36bb4c7c7f4eaf9307e4b87e8334fb6abec1765bcb
blob eligible for deletion: sha256:b549a9959a664038fc35c155a95742cf12297672ca0ae35735ec027d55bf4e97
blob eligible for deletion: sha256:f251d679a7c61455f06d793e43c06786d7766c88b8c24edf242b2c08e3c3f599
```
```

View File

@ -1,7 +1,6 @@
---
description: Getting help with the Registry
keywords:
- registry, on-prem, images, tags, repository, distribution, help, 101, TL;DR
keywords: registry, on-prem, images, tags, repository, distribution, help, 101, TL;DR
title: Get help
---
@ -15,4 +14,4 @@ If you want to report a bug:
- be sure to first read about [how to contribute](https://github.com/docker/distribution/blob/master/CONTRIBUTING.md)
- you can then do so on the [GitHub project bugtracker](https://github.com/docker/distribution/issues)
You can also find out more about the Docker's project [Getting Help resources](/opensource/get-help.md).
You can also find out more about the Docker's project [Getting Help resources](/opensource/get-help.md).

View File

@ -1,9 +1,8 @@
---
description: High-level overview of the Registry
keywords: registry, on-prem, images, tags, repository, distribution
redirect_from:
- /registry/overview/
description: High-level overview of the Registry
keywords:
- registry, on-prem, images, tags, repository, distribution
title: Docker Registry
---
@ -67,4 +66,4 @@ Now stop your registry and remove all data
You should now read the [detailed introduction about the
registry](introduction.md), or jump directly to [deployment
instructions](deploying.md).
instructions](deploying.md).

View File

@ -1,7 +1,6 @@
---
description: Deploying a Registry in an insecure fashion
keywords:
- registry, on-prem, images, tags, repository, distribution, insecure
keywords: registry, on-prem, images, tags, repository, distribution, insecure
title: Test an insecure registry
---
@ -105,4 +104,4 @@ update-ca-trust
$ update-ca-trust enable
```
Now restart docker (`service docker stop && service docker start`, or any other way you use to restart docker).
Now restart docker (`service docker stop && service docker start`, or any other way you use to restart docker).

View File

@ -1,7 +1,6 @@
---
description: Explains what the Registry is, basic use cases and requirements
keywords:
- registry, on-prem, images, tags, repository, distribution, use cases, requirements
keywords: registry, on-prem, images, tags, repository, distribution, use cases, requirements
title: About Registry
---
@ -73,4 +72,4 @@ golang are certainly useful as well for advanced operations or hacking.
## Next
Dive into [deploying your registry](deploying.md)
Dive into [deploying your registry](deploying.md)

View File

@ -1,7 +1,6 @@
---
description: Explains how to work with registry notifications
keywords:
- registry, on-prem, images, tags, repository, distribution, notifications, advanced
keywords: registry, on-prem, images, tags, repository, distribution, notifications, advanced
title: Work with notifications
---
@ -341,4 +340,4 @@ provide acceptable guarantees, adding a transactional `Sink` to the registry
is a possibility, although it may have an effect on request service time.
Please see the
[godoc](http://godoc.org/github.com/docker/distribution/notifications#Sink)
for more information.
for more information.

View File

@ -1,7 +1,6 @@
---
description: Restricting access to your registry using an apache proxy
keywords:
- registry, on-prem, images, tags, repository, distribution, authentication, proxy, apache, httpd, TLS, recipe, advanced
keywords: registry, on-prem, images, tags, repository, distribution, authentication, proxy, apache, httpd, TLS, recipe, advanced
title: Authenticate proxy with apache
---
@ -207,4 +206,4 @@ Now, login with a "pull-only" user (using `testuser` and `testpassword`), then p
Verify that the "pull-only" can NOT push:
docker push myregistrydomain.com:5043/test
docker push myregistrydomain.com:5043/test

View File

@ -1,7 +1,6 @@
---
description: Fun stuff to do with your registry
keywords:
- registry, on-prem, images, tags, repository, distribution, recipes, advanced
keywords: registry, on-prem, images, tags, repository, distribution, recipes, advanced
title: Recipes Overview
---
@ -28,4 +27,4 @@ At this point, it's assumed that:
* [using Apache as an authenticating proxy](apache.md)
* [using Nginx as an authenticating proxy](nginx.md)
* [running a Registry on macOS](osx-setup-guide.md)
* [mirror the Docker Hub](mirror.md)
* [mirror the Docker Hub](mirror.md)

View File

@ -1,7 +1,6 @@
---
description: Setting-up a local mirror for Docker Hub images
keywords:
- registry, on-prem, images, tags, repository, distribution, mirror, Hub, recipe, advanced
keywords: registry, on-prem, images, tags, repository, distribution, mirror, Hub, recipe, advanced
title: Registry as a pull through cache
---
@ -94,4 +93,4 @@ For example, if your mirror is serving on `http://10.0.0.2:5000`, you would run:
> NOTE: Depending on your local host setup, you may be able to add the
`--registry-mirror` option to the `DOCKER_OPTS` variable in
`/etc/default/docker`.
`/etc/default/docker`.

View File

@ -1,7 +1,6 @@
---
description: Restricting access to your registry using a nginx proxy
keywords:
- registry, on-prem, images, tags, repository, distribution, nginx, proxy, authentication, TLS, recipe, advanced
keywords: registry, on-prem, images, tags, repository, distribution, nginx, proxy, authentication, TLS, recipe, advanced
title: Authenticate proxy with nginx
---
@ -200,4 +199,4 @@ tag and push your first image:
docker login -u=testuser -p=testpassword -e=root@example.ch myregistrydomain.com:5043
docker tag ubuntu myregistrydomain.com:5043/test
docker push myregistrydomain.com:5043/test
docker pull myregistrydomain.com:5043/test
docker pull myregistrydomain.com:5043/test

View File

@ -1,7 +1,6 @@
---
description: Explains how to run a registry on macOS
keywords:
- registry, on-prem, images, tags, repository, distribution, macOS, recipe, advanced
keywords: registry, on-prem, images, tags, repository, distribution, macOS, recipe, advanced
title: macOS Setup Guide
---
@ -73,4 +72,4 @@ Start the Docker registry:
### Unloading the docker registry service
launchctl unload ~/Library/LaunchAgents/com.docker.registry.plist
launchctl unload ~/Library/LaunchAgents/com.docker.registry.plist

View File

@ -1,7 +1,6 @@
---
description: Specification for the Registry API.
keywords:
- registry, on-prem, images, tags, repository, distribution, api, advanced
keywords: registry, on-prem, images, tags, repository, distribution, api, advanced
title: Docker Registry HTTP API V2
---
@ -5476,4 +5475,4 @@ The following headers will be returned with the response:
|Name|Description|
|----|-----------|
|`Content-Length`|Length of the JSON response body.|
|`Link`|RFC5988 compliant rel='next' with URL to next result set, if available|
|`Link`|RFC5988 compliant rel='next' with URL to next result set, if available|

View File

@ -1,11 +1,10 @@
---
description: Docker Registry v2 authentication schema
keywords:
- registry, on-prem, images, tags, repository, distribution, authentication, advanced
keywords: registry, on-prem, images, tags, repository, distribution, authentication, advanced
title: Docker Registry v2 authentication
---
See the [Token Authentication Specification](token.md),
[Token Authentication Implementation](jwt.md),
[Token Scope Documentation](scope.md),
[OAuth2 Token Authentication](oauth.md) for more information.
[OAuth2 Token Authentication](oauth.md) for more information.

View File

@ -1,7 +1,6 @@
---
description: Describe the reference implementation of the Docker Registry v2 authentication schema
keywords:
- registry, on-prem, images, tags, repository, distribution, JWT authentication, advanced
keywords: registry, on-prem, images, tags, repository, distribution, JWT authentication, advanced
title: Docker Registry v2 Bearer token specification
---
@ -325,4 +324,4 @@ authorization then the registry will return the appropriate error.
At no point in this process should the registry need to call back to the
authorization server. The registry only needs to be supplied with the trusted
public keys to verify the token signatures.
public keys to verify the token signatures.

View File

@ -1,7 +1,6 @@
---
description: Specifies the Docker Registry v2 authentication
keywords:
- registry, on-prem, images, tags, repository, distribution, oauth2, advanced
keywords: registry, on-prem, images, tags, repository, distribution, oauth2, advanced
title: Docker Registry v2 authentication using OAuth2
---
@ -181,4 +180,4 @@ HTTP/1.1 200 OK
Content-Type: application/json
{"refresh_token":"kas9Da81Dfa8","access_token":"eyJhbGciOiJFUzI1NiIsInR5":"expires_in":900,"scope":"repository:samalba/my-app:pull,repository:samalba/my-app:push"}
```
```

View File

@ -1,7 +1,6 @@
---
description: Describes the scope and access fields used for registry authorization tokens
keywords:
- registry, on-prem, images, tags, repository, distribution, advanced, access, scope
keywords: registry, on-prem, images, tags, repository, distribution, advanced, access, scope
title: Docker Registry token scope and access
---
@ -133,4 +132,4 @@ restricting scope to specific type, name, and actions combinations should be
done by fetching an access token using the refresh token. Since the refresh
token is not scoped to specific resources for an audience, extra care should
be taken to only use the refresh token to negotiate new access tokens directly
with the authorization server, and never with a resource provider.
with the authorization server, and never with a resource provider.

View File

@ -1,7 +1,6 @@
---
description: Specifies the Docker Registry v2 authentication
keywords:
- registry, on-prem, images, tags, repository, distribution, Bearer authentication, advanced
keywords: registry, on-prem, images, tags, repository, distribution, Bearer authentication, advanced
title: Docker Registry v2 authentication via central service
---
@ -248,4 +247,4 @@ Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NiIsImtpZCI6IkJWM0Q6MkFWWj
```
This is also described in [Section 2.1 of RFC 6750: The OAuth 2.0 Authorization
Framework: Bearer Token Usage](https://tools.ietf.org/html/rfc6750#section-2.1)
Framework: Bearer Token Usage](https://tools.ietf.org/html/rfc6750#section-2.1)

View File

@ -1,11 +1,10 @@
---
description: Explains registry JSON objects
keywords:
- registry, service, images, repository, json
keywords: registry, service, images, repository, json
title: Docker Registry Reference
---
* [HTTP API V2](api.md)
* [Storage Driver](../storage-drivers/index.md)
* [Token Authentication Specification](auth/token.md)
* [Token Authentication Implementation](auth/jwt.md)
* [Token Authentication Implementation](auth/jwt.md)

View File

@ -1,8 +1,7 @@
---
description: Explains registry JSON objects
keywords: registry, service, images, repository, json
published: false
keywords:
- registry, service, images, repository, json
title: Docker Distribution JSON canonicalization
---
@ -84,4 +83,4 @@ var canonical bytes.Buffer
if err := json.Indent(&canonical, incoming, "", ""); err != nil {
// ... handle error
}
```
```

View File

@ -1,7 +1,6 @@
---
description: image manifest for the Registry.
keywords:
- registry, on-prem, images, tags, repository, distribution, api, advanced, manifest
keywords: registry, on-prem, images, tags, repository, distribution, api, advanced, manifest
title: Image manifest V2, schema 1
---
@ -159,4 +158,4 @@ by *libtrust*. A signature consists of the following fields:
]
}
```
```

View File

@ -1,7 +1,6 @@
---
description: image manifest for the Registry.
keywords:
- registry, on-prem, images, tags, repository, distribution, api, advanced, manifest
keywords: registry, on-prem, images, tags, repository, distribution, api, advanced, manifest
title: Image manifest V2, schema 2
---
@ -290,4 +289,4 @@ their own, but only serve to fill in the parent chain in a compatible way.
The IDs in these synthetic configurations will be derived from hashes of their
respective blobs. The registry will create these configurations and their IDs
using the same scheme as Docker 1.10 when it creates a legacy manifest to push
to a registry which doesn't support the new format.
to a registry which doesn't support the new format.

View File

@ -1,7 +1,6 @@
---
description: Explains how to use the Azure storage drivers
keywords:
- registry, service, driver, images, storage, azure
keywords: registry, service, driver, images, storage, azure
title: Microsoft Azure storage driver
---
@ -69,4 +68,4 @@ An implementation of the `storagedriver.StorageDriver` interface which uses [Mic
* To get information about
[azure-blob-storage](http://azure.microsoft.com/en-us/services/storage/) visit
the Microsoft website.
* You can use Microsoft's [Blob Service REST API](https://msdn.microsoft.com/en-us/library/azure/dd135733.aspx) to [create a container] (https://msdn.microsoft.com/en-us/library/azure/dd179468.aspx).
* You can use Microsoft's [Blob Service REST API](https://msdn.microsoft.com/en-us/library/azure/dd135733.aspx) to [create a container] (https://msdn.microsoft.com/en-us/library/azure/dd179468.aspx).

View File

@ -1,7 +1,6 @@
---
description: Explains how to use the filesystem storage drivers
keywords:
- registry, service, driver, images, storage, filesystem
keywords: registry, service, driver, images, storage, filesystem
title: Filesystem storage driver
---
@ -15,4 +14,4 @@ there is adequate space available. Defaults to `/var/lib/registry`.
`maxthreads`: (optional) The maximum number of simultaneous blocking filesystem
operations permitted within the registry. Each operation spawns a new thread and
may cause thread exhaustion issues if many are done in parallel. Defaults to
`100`, and can be no lower than `25`.
`100`, and can be no lower than `25`.

View File

@ -1,7 +1,6 @@
---
description: Explains how to use the Google Cloud Storage drivers
keywords:
- registry, service, driver, images, storage, gcs, google, cloud
keywords: registry, service, driver, images, storage, gcs, google, cloud
title: Google Cloud Storage driver
---
@ -69,4 +68,4 @@ An implementation of the `storagedriver.StorageDriver` interface which uses Goog
**Note** Instead of a key file you can use [Google Application Default Credentials](https://developers.google.com/identity/protocols/application-default-credentials).
`rootdirectory`: (optional) The root directory tree in which all registry files will be stored. Defaults to the empty string (bucket root).
`rootdirectory`: (optional) The root directory tree in which all registry files will be stored. Defaults to the empty string (bucket root).

View File

@ -1,9 +1,8 @@
---
description: Explains how to use storage drivers
keywords: registry, on-prem, images, tags, repository, distribution, storage drivers, advanced
redirect_from:
- /registry/storagedrivers/
description: Explains how to use storage drivers
keywords:
- registry, on-prem, images, tags, repository, distribution, storage drivers, advanced
title: Docker Registry storage driver
---
@ -56,4 +55,4 @@ Storage drivers should call `factory.Register` with their driver name in an `ini
Storage driver test suites are provided in
`storagedriver/testsuites/testsuites.go` and may be used for any storage
driver written in Go. Tests can be registered using the `RegisterSuite`
function, which run the same set of tests for any registered drivers.
function, which run the same set of tests for any registered drivers.

View File

@ -1,7 +1,6 @@
---
description: Explains how to use the in-memory storage drivers
keywords:
- registry, service, driver, images, storage, in-memory
keywords: registry, service, driver, images, storage, in-memory
title: In-memory storage driver (testing only)
---
@ -14,4 +13,4 @@ volatile memory, use the [`filesystem` driver](filesystem.md) on a ramdisk.
## Parameters
None
None

View File

@ -1,7 +1,6 @@
---
description: Explains how to use the Aliyun OSS storage driver
keywords:
- registry, service, driver, images, storage, OSS, aliyun
keywords: registry, service, driver, images, storage, OSS, aliyun
title: Aliyun OSS storage driver
---
@ -119,4 +118,4 @@ no
<td> The root directory tree in which to store all registry files. Defaults to an empty string (bucket root).
</td>
</tr>
</table>
</table>

View File

@ -1,7 +1,6 @@
---
description: Explains how to use the S3 storage drivers
keywords:
- registry, service, driver, images, storage, S3
keywords: registry, service, driver, images, storage, S3
title: S3 storage driver
---
@ -273,4 +272,4 @@ middleware:
A CloudFront key-pair is required for all AWS accounts needing access to your
CloudFront distribution. For information, please see [Creating CloudFront Key
Pairs](http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-trusted-signers.html#private-content-creating-cloudfront-key-pairs).
Pairs](http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-trusted-signers.html#private-content-creating-cloudfront-key-pairs).

View File

@ -1,7 +1,6 @@
---
description: Explains how to use the OpenStack swift storage driver
keywords:
- registry, service, driver, images, storage, swift
keywords: registry, service, driver, images, storage, swift
title: OpenStack Swift storage driver
---
@ -240,4 +239,4 @@ configuration file can specify the following optional parameters :
</p>
</td>
</tr>
</table>
</table>