Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions registry/compatibility.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down Expand Up @@ -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.
5 changes: 2 additions & 3 deletions registry/configuration.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down Expand Up @@ -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.
5 changes: 2 additions & 3 deletions registry/deploying.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down Expand Up @@ -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)
5 changes: 2 additions & 3 deletions registry/deprecated.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand All @@ -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.
5 changes: 2 additions & 3 deletions registry/garbage-collection.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down Expand Up @@ -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
```
```
5 changes: 2 additions & 3 deletions registry/help.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand All @@ -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).
7 changes: 3 additions & 4 deletions registry/index.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down Expand Up @@ -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).
5 changes: 2 additions & 3 deletions registry/insecure.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down Expand Up @@ -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).
5 changes: 2 additions & 3 deletions registry/introduction.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down Expand Up @@ -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)
5 changes: 2 additions & 3 deletions registry/notifications.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down Expand Up @@ -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.
5 changes: 2 additions & 3 deletions registry/recipes/apache.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down Expand Up @@ -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
5 changes: 2 additions & 3 deletions registry/recipes/index.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand All @@ -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)
5 changes: 2 additions & 3 deletions registry/recipes/mirror.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down Expand Up @@ -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`.
5 changes: 2 additions & 3 deletions registry/recipes/nginx.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down Expand Up @@ -200,4 +199,4 @@ tag and push your first image:
docker login -u=testuser -p=testpassword [email protected] 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
5 changes: 2 additions & 3 deletions registry/recipes/osx-setup-guide.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down Expand Up @@ -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
5 changes: 2 additions & 3 deletions registry/spec/api.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down Expand Up @@ -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|
5 changes: 2 additions & 3 deletions registry/spec/auth/index.md
Original file line number Diff line number Diff line change
@@ -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.
5 changes: 2 additions & 3 deletions registry/spec/auth/jwt.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down Expand Up @@ -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.
5 changes: 2 additions & 3 deletions registry/spec/auth/oauth.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down Expand Up @@ -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"}
```
```
5 changes: 2 additions & 3 deletions registry/spec/auth/scope.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down Expand Up @@ -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.
5 changes: 2 additions & 3 deletions registry/spec/auth/token.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down Expand Up @@ -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)
5 changes: 2 additions & 3 deletions registry/spec/index.md
Original file line number Diff line number Diff line change
@@ -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)
5 changes: 2 additions & 3 deletions registry/spec/json.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down Expand Up @@ -84,4 +83,4 @@ var canonical bytes.Buffer
if err := json.Indent(&canonical, incoming, "", ""); err != nil {
// ... handle error
}
```
```
5 changes: 2 additions & 3 deletions registry/spec/manifest-v2-1.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down Expand Up @@ -159,4 +158,4 @@ by *libtrust*. A signature consists of the following fields:
]
}

```
```
Loading