dkirillov/distribution
1
0
Fork 0
forked from TrueCloudLab/distribution
Code Pull requests Activity

Metadata and formatting fixes needed for Jekyll build

Browse source 
Signed-off-by: Misty Stanley-Jones <misty@docker.com>
(cherry picked from commit 49d6706ce9d952718725350d82d9ea7deb4f7326)
Signed-off-by: Misty Stanley-Jones <misty@docker.com>
This commit is contained in:
Misty Stanley-Jones 2016-11-10 15:37:21 -08:00
parent 6b3ccf9640
commit abd2d765ac
14 changed files with 22 additions and 62 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/configuration.md
View file

@ -1,11 +1,9 @@
--- ---
title: "Configuring a registry" title: "Registry Configuration Reference"
description: "Explains how to configure a registry" 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"
--- ---
# Registry Configuration Reference
The Registry configuration is based on a YAML file, detailed below. While it comes with sane default values out of the box, you are heavily encouraged to review it exhaustively before moving your systems to production. The Registry configuration is based on a YAML file, detailed below. While it comes with sane default values out of the box, you are heavily encouraged to review it exhaustively before moving your systems to production.
## Override specific configuration options ## Override specific configuration options

11
docs/spec/api.md
View file

@ -1,11 +1,9 @@
--- ---
title: "HTTP API V2" title: "Docker Registry HTTP API V2"
description: "Specification for the Registry API." 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"
--- ---
# Docker Registry HTTP API V2
## Introduction ## Introduction
The _Docker Registry HTTP API_ is the protocol to facilitate distribution of The _Docker Registry HTTP API_ is the protocol to facilitate distribution of
@ -4842,8 +4840,3 @@ The following headers will be returned with the response:
|----|-----------| |----|-----------|
|`Content-Length`|Length of the JSON response body.| |`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|

6
docs/spec/api.md.tmpl
View file

@ -1,11 +1,9 @@
--- ---
title: "HTTP API V2" title: "Docker Registry HTTP API V2"
description: "Specification for the Registry API." 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"
--- ---
# Docker Registry HTTP API V2
## Introduction ## Introduction
The _Docker Registry HTTP API_ is the protocol to facilitate distribution of The _Docker Registry HTTP API_ is the protocol to facilitate distribution of

6
docs/spec/auth/index.md
View file

@ -1,11 +1,9 @@
--- ---
title: "Docker Registry Token Authentication" title: "Docker Registry v2 authentication"
description: "Docker Registry v2 authentication schema" 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"
--- ---
# Docker Registry v2 authentication
See the [Token Authentication Specification](token.md), See the [Token Authentication Specification](token.md),
[Token Authentication Implementation](jwt.md), [Token Authentication Implementation](jwt.md),
[Token Scope Documentation](scope.md), [Token Scope Documentation](scope.md),

6
docs/spec/auth/jwt.md
View file

@ -1,11 +1,9 @@
--- ---
title: "Token Authentication Implementation" title: "Docker Registry v2 Bearer token specification"
description: "Describe the reference implementation of the Docker Registry v2 authentication schema" 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"
--- ---
# Docker Registry v2 Bearer token specification
This specification covers the `docker/distribution` implementation of the This specification covers the `docker/distribution` implementation of the
v2 Registry's authentication schema. Specifically, it describes the JSON v2 Registry's authentication schema. Specifically, it describes the JSON
Web Token schema that `docker/distribution` has adopted to implement the Web Token schema that `docker/distribution` has adopted to implement the

6
docs/spec/auth/oauth.md
View file

@ -1,11 +1,9 @@
--- ---
title: "Oauth2 Token Authentication" title: "Docker Registry v2 authentication using OAuth2"
description: "Specifies the Docker Registry v2 authentication" 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"
--- ---
# Docker Registry v2 authentication using OAuth2
This document describes support for the OAuth2 protocol within the authorization This document describes support for the OAuth2 protocol within the authorization
server. [RFC6749](https://tools.ietf.org/html/rfc6749) should be used as a server. [RFC6749](https://tools.ietf.org/html/rfc6749) should be used as a
reference for the protocol and HTTP endpoints described here. reference for the protocol and HTTP endpoints described here.

6
docs/spec/auth/scope.md
View file

@ -1,11 +1,9 @@
--- ---
title: "Token Scope Documentation" title: "Docker Registry Token Scope and Access"
description: "Describes the scope and access fields used for registry authorization tokens" 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"
--- ---
# Docker Registry Token Scope and Access
Tokens used by the registry are always restricted what resources they may Tokens used by the registry are always restricted what resources they may
be used to access, where those resources may be accessed, and what actions be used to access, where those resources may be accessed, and what actions
may be done on those resources. Tokens always have the context of a user which may be done on those resources. Tokens always have the context of a user which

6
docs/spec/auth/token.md
View file

@ -1,11 +1,9 @@
--- ---
title: "Token Authentication Specification" title: "Docker Registry v2 authentication via central service"
description: "Specifies the Docker Registry v2 authentication" 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"
--- ---
# Docker Registry v2 authentication via central service
This document outlines the v2 Docker registry authentication scheme: This document outlines the v2 Docker registry authentication scheme:
![v2 registry auth](https://docs.google.com/drawings/d/1EHZU9uBLmcH0kytDClBv6jv6WR4xZjE8RKEUw1mARJA/pub?w=480&h=360) ![v2 registry auth](https://docs.google.com/drawings/d/1EHZU9uBLmcH0kytDClBv6jv6WR4xZjE8RKEUw1mARJA/pub?w=480&h=360)

4
docs/spec/implementations.md
View file

@ -1,9 +1,8 @@
--- ---
published: false published: false
title: Distribution API Implementations
--- ---
# Distribution API Implementations
This is a list of known implementations of the Distribution API spec. This is a list of known implementations of the Distribution API spec.
## [Docker Distribution Registry](https://github.com/docker/distribution) ## [Docker Distribution Registry](https://github.com/docker/distribution)
@ -27,4 +26,3 @@ _Known Issues_
- No resumable push support - No resumable push support
- No PATCH implementation for blob upload - No PATCH implementation for blob upload
- Content ranges ignored - Content ranges ignored

6
docs/spec/index.md
View file

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

6
docs/spec/json.md
View file

@ -2,13 +2,9 @@
published: false published: false
title: "Docker Distribution JSON Canonicalization" title: "Docker Distribution JSON Canonicalization"
description: "Explains registry JSON objects" description: "Explains registry JSON objects"
keywords: ["registry, service, images, repository, json"] keywords: "registry, service, images, repository, json"
--- ---
# Docker Distribution JSON Canonicalization
To provide consistent content hashing of JSON objects throughout Docker To provide consistent content hashing of JSON objects throughout Docker
Distribution APIs, the specification defines a canonical JSON format. Adopting Distribution APIs, the specification defines a canonical JSON format. Adopting
such a canonicalization also aids in caching JSON responses. such a canonicalization also aids in caching JSON responses.

4
docs/spec/manifest-v2-1.md
View file

@ -1,11 +1,9 @@
--- ---
title: "Image Manifest V 2, Schema 1 " title: "Image Manifest V 2, Schema 1 "
description: "image manifest for the Registry." 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"
--- ---
# Image Manifest Version 2, Schema 1
This document outlines the format of of the V2 image manifest. The image This document outlines the format of of the V2 image manifest. The image
manifest described herein was introduced in the Docker daemon in the [v1.3.0 manifest described herein was introduced in the Docker daemon in the [v1.3.0
release](https://github.com/docker/docker/commit/9f482a66ab37ec396ac61ed0c00d59122ac07453). release](https://github.com/docker/docker/commit/9f482a66ab37ec396ac61ed0c00d59122ac07453).

4
docs/spec/manifest-v2-2.md
View file

@ -1,11 +1,9 @@
--- ---
title: "Image Manifest V 2, Schema 2 " title: "Image Manifest V 2, Schema 2 "
description: "image manifest for the Registry." 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"
--- ---
# Image Manifest Version 2, Schema 2
This document outlines the format of of the V2 image manifest, schema version 2. This document outlines the format of of the V2 image manifest, schema version 2.
The original (and provisional) image manifest for V2 (schema 1), was introduced The original (and provisional) image manifest for V2 (schema 1), was introduced
in the Docker daemon in the [v1.3.0 in the Docker daemon in the [v1.3.0

7
docs/spec/menu.md
View file

@ -1,7 +0,0 @@
---
title: "Reference"
description: "Explains registry JSON objects"
keywords: ["registry, service, images, repository, json"]
type: "menu"
identifier: "smn_registry_ref"
---