pax_global_header 0000666 0000000 0000000 00000000064 14561457051 0014522 g ustar 00root root 0000000 0000000 52 comment=f1d00ebd2d6d6805170d5543dbca4b850f35f9af docker-image-spec-1.3.1/ 0000775 0000000 0000000 00000000000 14561457051 0015003 5 ustar 00root root 0000000 0000000 docker-image-spec-1.3.1/LICENSE 0000664 0000000 0000000 00000026135 14561457051 0016017 0 ustar 00root root 0000000 0000000 Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. docker-image-spec-1.3.1/README.md 0000664 0000000 0000000 00000005405 14561457051 0016266 0 ustar 00root root 0000000 0000000 # Docker Image Specification v1. This directory contains documents about Docker Image Specification v1.X. The Docker Image Specification is the image specification as used by the Docker Engine, and was used as foundation of the OCI image specification. The Docker Image Specification provides a superset of the OCI Image specification; it is OCI-compatible, but some extensions that are specific to the Docker Engine implementation. Refer to [spec.md](spec.md) for the current version of the Docker Image Specification, and the [OCI Image specification](https://github.com/opencontainers/image-spec/) for an in-depth specification of the OCI Image specs. The v1 file layout and manifests are no longer used in Moby and Docker, except in `docker save` and `docker load`. However, v1 Image JSON (`application/vnd.docker.container.image.v1+json`) has been still widely used and officially adopted in [V2 manifest](https://github.com/distribution/distribution/blob/main/docs/content/spec/manifest-v2-2.md) and in [OCI Image Format Specification](https://github.com/opencontainers/image-spec). ## v1.X rough Changelog All 1.X versions are compatible with older ones. ### [v1.3](spec.md) * Implemented in Docker v25.0 Changes: * `StartInterval` was added to the `Healthcheck` struct in the Image JSON ### [v1.2](https://github.com/moby/moby/blob/daa4618da826fb1de4fc2478d88196edbba49b2f/image/spec/v1.2.md) * Implemented in Docker v1.12 (July, 2016) * The official spec document was written in August 2016 ([#25750](https://github.com/moby/moby/pull/25750)) Changes: * `Healthcheck` struct was added to Image JSON ### [v1.1](https://github.com/moby/moby/blob/daa4618da826fb1de4fc2478d88196edbba49b2f/image/spec/v1.1.md) * Implemented in Docker v1.10 (February, 2016) * The official spec document was written in April 2016 ([#22264](https://github.com/moby/moby/pull/22264)) Changes: * IDs were made into SHA256 digest values rather than random values * Layer directory names were made into deterministic values rather than random ID values * `manifest.json` was added ### [v1](https://github.com/moby/moby/blob/daa4618da826fb1de4fc2478d88196edbba49b2f/image/spec/v1.md) * The initial revision * The official spec document was written in late 2014 ([#9560](https://github.com/moby/moby/pull/9560)), but actual implementations had existed even earlier ## Related specifications * [Open Containers Initiative (OCI) Image Format Specification v1.0.0](https://github.com/opencontainers/image-spec/tree/v1.0.0) * [Docker Image Manifest Version 2, Schema 2](https://github.com/distribution/distribution/blob/main/docs/content/spec/manifest-v2-2.md) * [Docker Image Manifest Version 2, Schema 1](https://github.com/distribution/distribution/blob/main/docs/content/spec/deprecated-schema-v1.md) (*DEPRECATED*) docker-image-spec-1.3.1/go.mod 0000664 0000000 0000000 00000000411 14561457051 0016105 0 ustar 00root root 0000000 0000000 module github.com/moby/docker-image-spec go 1.18 require github.com/opencontainers/image-spec v1.0.2 require github.com/opencontainers/go-digest v1.0.0 // indirect retract v1.3.0 // Package github.com/moby/docker-image-spec/specs-go has the wrong package name. docker-image-spec-1.3.1/go.sum 0000664 0000000 0000000 00000000574 14561457051 0016144 0 ustar 00root root 0000000 0000000 github.com/opencontainers/go-digest v1.0.0 h1:apOUWs51W5PlhuyGyz9FCeeBIOUDA/6nW8Oi/yOhh5U= github.com/opencontainers/go-digest v1.0.0/go.mod h1:0JzlMkj0TRzQZfJkVvzbP0HBR3IKzErnv2BNG4W4MAM= github.com/opencontainers/image-spec v1.0.2 h1:9yCKha/T5XdGtO0q9Q9a6T5NUCsTn/DrBg0D7ufOcFM= github.com/opencontainers/image-spec v1.0.2/go.mod h1:BtxoFyWECRxE4U/7sNtV5W15zMzWCbyJoFRP3s7yZA0= docker-image-spec-1.3.1/spec.md 0000664 0000000 0000000 00000064215 14561457051 0016267 0 ustar 00root root 0000000 0000000 # Docker Image Specification v1.3.0 An *Image* is an ordered collection of root filesystem changes and the corresponding execution parameters for use within a container runtime. This specification outlines the format of these filesystem changes and corresponding parameters and describes how to create and use them for use with a container runtime and execution tool. This version of the image specification was adopted starting in Docker 1.12. ## Terminology This specification uses the following terms:
sha256:a9561eb1b190625c9adb5a9513e72c4dedafc1cb2d4c5236c9a6957ec7dfd5a9
.
Layers must be packed and unpacked reproducibly to avoid changing the
layer ID, for example by using tar-split to save the tar headers. Note
that the digest used as the layer ID is taken over an uncompressed
version of the tar.
ChainID
. For a
single layer (or the layer at the bottom of a stack), the
ChainID
is equal to the layer's DiffID
.
Otherwise the ChainID
is given by the formula:
ChainID(layerN) = SHA256hex(ChainID(layerN-1) + " " + DiffID(layerN))
.
sha256:a9561eb1b190625c9adb5a9513e72c4dedafc1cb2d4c5236c9a6957ec7dfd5a9
.
Since the configuration JSON that gets hashed references hashes of each
layer in the image, this formulation of the ImageID makes images
content-addressable.
[a-zA-Z0-9_.-]
, except they may not start with a .
or -
character. Tags are limited to 128 characters.
:
). For example, in an image tagged with the name
my-app:3.1.4
, my-app
is the Repository
component of the name. A repository name is made up of slash-separated
name components, optionally prefixed by a DNS hostname. The hostname
must comply with standard DNS rules, but may not contain
_
characters. If a hostname is present, it may optionally
be followed by a port number in the format :8080
.
Name components may contain lowercase characters, digits, and
separators. A separator is defined as a period, one or two underscores,
or one or more dashes. A name component may not start or end with
a separator.
string
string
string
string
struct
null
, in
which case any execution parameters should be specified at creation of
the container.
string
The username or UID which the process in the container should run as. This acts as a default value to use when the value is not specified when creating a container.
All of the following are valid:
user
uid
user:group
uid:gid
uid:group
user:gid
If group
/gid
is not specified, the
default group and supplementary groups of the given
user
/uid
in /etc/passwd
from the container are applied.
integer
integer
-1
to
disable swap. This acts as a default value to use when the
value is not specified when creating a container.
integer
struct
map[string]struct{}
and is represented in JSON as
an object mapping its keys to an empty object. Here is an
example:
{ "8080": {}, "53/udp": {}, "2356/tcp": {} }Its keys can be in the format of:
"port/tcp"
"port/udp"
"port"
"tcp"
if not
specified. These values act as defaults and are merged with
any specified when creating a container.
array of strings
VARNAME="var value"
.
These values act as defaults and are merged with any specified
when creating a container.
array of strings
array of strings
Entrypoint
value is
not specified, then the first entry of the Cmd
array should be interpreted as the executable to run.
boolean
Entrypoint
or Cmd
or both, contain only a single element array
that is a pre-escaped, and combined into a single string, **CommandLine**.
If "true", the value in Entrypoint
or Cmd
Cmd
should be used as-is to avoid double escaping.
Note, the exact behavior of ArgsEscaped
is complex
and subject to implementation details.
struct
{ "Test": [ "CMD-SHELL", "/usr/bin/check-health localhost" ], "Interval": 30000000000, "Timeout": 10000000000, "Retries": 3, "StartInterval": 3000000000 }The object has the following fields.
array of strings
[]
: inherit healthcheck from base image["NONE"]
: disable healthcheck["CMD", arg1, arg2, ...]
: exec arguments directly["CMD-SHELL", command]
: run command with system's default shellinteger
integer
integer
integer
struct
map[string]struct{}
and is represented in
JSON as an object mapping its keys to an empty object. Here is
an example:
{ "/var/my-app-data/": {}, "/etc/some-config.d/": {}, }
string
array of strings
array of strings
["/bin/sh", "-c"]
, and ["cmd", "/S", "/C"]
on Windows. This field is set by the SHELL
instruction in a Dockerfile, and *must* be written in JSON
form.
struct
type
is usually set to layers
.
diff_ids
is an array of layer content hashes (DiffIDs
), in order from bottom-most to top-most.
"rootfs": { "diff_ids": [ "sha256:c6f988f4874bb0add23a778f753c65efe992244e148a1d2ec2a8b664fb66bbd1", "sha256:5f70bf18a086007016e948b04aed3b82103a36bea41755b6cddfaf10ace3c6ef", "sha256:13f53e08df5a220ab6d13c58b2bf83a59cbdc2e04d0a3f041ddf4b0ba4112d49" ], "type": "layers" }
struct
history
is an array of objects describing the history of
each layer. The array is ordered from bottom-most layer to top-most
layer. The object has the following fields.
created
: Creation time, expressed as a ISO-8601 formatted
combined date and time
author
: The author of the build point
created_by
: The command which created the layer
comment
: A custom message set when creating the layer
empty_layer
: This field is used to mark if the history
item created a filesystem diff. It is set to true if this history
item doesn't correspond to an actual layer in the rootfs section
(for example, a command like ENV which results in no change to the
filesystem).
"history": [ { "created": "2015-10-31T22:22:54.690851953Z", "created_by": "/bin/sh -c #(nop) ADD file:a3bc1e842b69636f9df5256c49c5374fb4eef1e281fe3f282c65fb853ee171c5 in /" }, { "created": "2015-10-31T22:22:55.613815829Z", "created_by": "/bin/sh -c #(nop) CMD [\"sh\"]", "empty_layer": true } ]