Embedded new lines aren't interpreted correctly in markdown renderers (they are treated as preformatted text instead). I removed the embedded newlines in the docker image spec.
Signed-off-by: Alex Goodman <wagoodman@gmail.com>
| ... | ... |
@@ -223,9 +223,7 @@ whitespace. It has been added to this example for clarity. |
| 223 | 223 |
container using the image. This field can be <code>null</code>, in |
| 224 | 224 |
which case any execution parameters should be specified at creation of |
| 225 | 225 |
the container. |
| 226 |
- |
|
| 227 | 226 |
<h4>Container RunConfig Field Descriptions</h4> |
| 228 |
- |
|
| 229 | 227 |
<dl> |
| 230 | 228 |
<dt> |
| 231 | 229 |
User <code>string</code> |
| ... | ... |
@@ -234,9 +232,7 @@ whitespace. It has been added to this example for clarity. |
| 234 | 234 |
<p>The username or UID which the process in the container should |
| 235 | 235 |
run as. This acts as a default value to use when the value is |
| 236 | 236 |
not specified when creating a container.</p> |
| 237 |
- |
|
| 238 | 237 |
<p>All of the following are valid:</p> |
| 239 |
- |
|
| 240 | 238 |
<ul> |
| 241 | 239 |
<li><code>user</code></li> |
| 242 | 240 |
<li><code>uid</code></li> |
| ... | ... |
@@ -245,7 +241,6 @@ whitespace. It has been added to this example for clarity. |
| 245 | 245 |
<li><code>uid:group</code></li> |
| 246 | 246 |
<li><code>user:gid</code></li> |
| 247 | 247 |
</ul> |
| 248 |
- |
|
| 249 | 248 |
<p>If <code>group</code>/<code>gid</code> is not specified, the |
| 250 | 249 |
default group and supplementary groups of the given |
| 251 | 250 |
<code>user</code>/<code>uid</code> in <code>/etc/passwd</code> |
| ... | ... |
@@ -284,13 +279,11 @@ whitespace. It has been added to this example for clarity. |
| 284 | 284 |
<code>map[string]struct{}</code> and is represented in JSON as
|
| 285 | 285 |
an object mapping its keys to an empty object. Here is an |
| 286 | 286 |
example: |
| 287 |
- |
|
| 288 | 287 |
<pre>{
|
| 289 | 288 |
"8080": {},
|
| 290 | 289 |
"53/udp": {},
|
| 291 | 290 |
"2356/tcp": {}
|
| 292 | 291 |
}</pre> |
| 293 |
- |
|
| 294 | 292 |
Its keys can be in the format of: |
| 295 | 293 |
<ul> |
| 296 | 294 |
<li> |
| ... | ... |
@@ -304,10 +297,8 @@ whitespace. It has been added to this example for clarity. |
| 304 | 304 |
</li> |
| 305 | 305 |
</ul> |
| 306 | 306 |
with the default protocol being <code>"tcp"</code> if not |
| 307 |
- specified. |
|
| 308 |
- |
|
| 309 |
- These values act as defaults and are merged with any specified |
|
| 310 |
- when creating a container. |
|
| 307 |
+ specified. These values act as defaults and are merged with any |
|
| 308 |
+ specified when creating a container. |
|
| 311 | 309 |
</dd> |
| 312 | 310 |
<dt> |
| 313 | 311 |
Env <code>array of strings</code> |
| ... | ... |
@@ -367,7 +358,6 @@ whitespace. It has been added to this example for clarity. |
| 367 | 367 |
The rootfs key references the layer content addresses used by the |
| 368 | 368 |
image. This makes the image config hash depend on the filesystem hash. |
| 369 | 369 |
rootfs has two subkeys: |
| 370 |
- |
|
| 371 | 370 |
<ul> |
| 372 | 371 |
<li> |
| 373 | 372 |
<code>type</code> is usually set to <code>layers</code>. |
| ... | ... |
@@ -376,10 +366,7 @@ whitespace. It has been added to this example for clarity. |
| 376 | 376 |
<code>diff_ids</code> is an array of layer content hashes (<code>DiffIDs</code>), in order from bottom-most to top-most. |
| 377 | 377 |
</li> |
| 378 | 378 |
</ul> |
| 379 |
- |
|
| 380 |
- |
|
| 381 | 379 |
Here is an example rootfs section: |
| 382 |
- |
|
| 383 | 380 |
<pre>"rootfs": {
|
| 384 | 381 |
"diff_ids": [ |
| 385 | 382 |
"sha256:c6f988f4874bb0add23a778f753c65efe992244e148a1d2ec2a8b664fb66bbd1", |
| ... | ... |
@@ -396,7 +383,6 @@ whitespace. It has been added to this example for clarity. |
| 396 | 396 |
<code>history</code> is an array of objects describing the history of |
| 397 | 397 |
each layer. The array is ordered from bottom-most layer to top-most |
| 398 | 398 |
layer. The object has the following fields. |
| 399 |
- |
|
| 400 | 399 |
<ul> |
| 401 | 400 |
<li> |
| 402 | 401 |
<code>created</code>: Creation time, expressed as a ISO-8601 formatted |
| ... | ... |
@@ -223,9 +223,7 @@ whitespace. It has been added to this example for clarity. |
| 223 | 223 |
container using the image. This field can be <code>null</code>, in |
| 224 | 224 |
which case any execution parameters should be specified at creation of |
| 225 | 225 |
the container. |
| 226 |
- |
|
| 227 | 226 |
<h4>Container RunConfig Field Descriptions</h4> |
| 228 |
- |
|
| 229 | 227 |
<dl> |
| 230 | 228 |
<dt> |
| 231 | 229 |
User <code>string</code> |
| ... | ... |
@@ -234,9 +232,7 @@ whitespace. It has been added to this example for clarity. |
| 234 | 234 |
<p>The username or UID which the process in the container should |
| 235 | 235 |
run as. This acts as a default value to use when the value is |
| 236 | 236 |
not specified when creating a container.</p> |
| 237 |
- |
|
| 238 | 237 |
<p>All of the following are valid:</p> |
| 239 |
- |
|
| 240 | 238 |
<ul> |
| 241 | 239 |
<li><code>user</code></li> |
| 242 | 240 |
<li><code>uid</code></li> |
| ... | ... |
@@ -245,7 +241,6 @@ whitespace. It has been added to this example for clarity. |
| 245 | 245 |
<li><code>uid:group</code></li> |
| 246 | 246 |
<li><code>user:gid</code></li> |
| 247 | 247 |
</ul> |
| 248 |
- |
|
| 249 | 248 |
<p>If <code>group</code>/<code>gid</code> is not specified, the |
| 250 | 249 |
default group and supplementary groups of the given |
| 251 | 250 |
<code>user</code>/<code>uid</code> in <code>/etc/passwd</code> |
| ... | ... |
@@ -284,13 +279,11 @@ whitespace. It has been added to this example for clarity. |
| 284 | 284 |
<code>map[string]struct{}</code> and is represented in JSON as
|
| 285 | 285 |
an object mapping its keys to an empty object. Here is an |
| 286 | 286 |
example: |
| 287 |
- |
|
| 288 | 287 |
<pre>{
|
| 289 | 288 |
"8080": {},
|
| 290 | 289 |
"53/udp": {},
|
| 291 | 290 |
"2356/tcp": {}
|
| 292 | 291 |
}</pre> |
| 293 |
- |
|
| 294 | 292 |
Its keys can be in the format of: |
| 295 | 293 |
<ul> |
| 296 | 294 |
<li> |
| ... | ... |
@@ -304,10 +297,8 @@ whitespace. It has been added to this example for clarity. |
| 304 | 304 |
</li> |
| 305 | 305 |
</ul> |
| 306 | 306 |
with the default protocol being <code>"tcp"</code> if not |
| 307 |
- specified. |
|
| 308 |
- |
|
| 309 |
- These values act as defaults and are merged with any specified |
|
| 310 |
- when creating a container. |
|
| 307 |
+ specified. These values act as defaults and are merged with |
|
| 308 |
+ any specified when creating a container. |
|
| 311 | 309 |
</dd> |
| 312 | 310 |
<dt> |
| 313 | 311 |
Env <code>array of strings</code> |
| ... | ... |
@@ -364,7 +355,6 @@ whitespace. It has been added to this example for clarity. |
| 364 | 364 |
<li><code>["CMD", arg1, arg2, ...]</code> : exec arguments directly</li> |
| 365 | 365 |
<li><code>["CMD-SHELL", command]</code> : run command with system's default shell</li> |
| 366 | 366 |
</ul> |
| 367 |
- |
|
| 368 | 367 |
The test command should exit with a status of 0 if the container is healthy, |
| 369 | 368 |
or with 1 if it is unhealthy. |
| 370 | 369 |
</dd> |
| ... | ... |
@@ -387,12 +377,10 @@ whitespace. It has been added to this example for clarity. |
| 387 | 387 |
The number of consecutive failures needed to consider a container as unhealthy. |
| 388 | 388 |
</dd> |
| 389 | 389 |
</dl> |
| 390 |
- |
|
| 391 | 390 |
In each case, the field can be omitted to indicate that the |
| 392 |
- value should be inherited from the base layer. |
|
| 393 |
- |
|
| 394 |
- These values act as defaults and are merged with any specified |
|
| 395 |
- when creating a container. |
|
| 391 |
+ value should be inherited from the base layer. These values act |
|
| 392 |
+ as defaults and are merged with any specified when creating a |
|
| 393 |
+ container. |
|
| 396 | 394 |
</dd> |
| 397 | 395 |
<dt> |
| 398 | 396 |
Volumes <code>struct</code> |
| ... | ... |
@@ -426,7 +414,6 @@ whitespace. It has been added to this example for clarity. |
| 426 | 426 |
The rootfs key references the layer content addresses used by the |
| 427 | 427 |
image. This makes the image config hash depend on the filesystem hash. |
| 428 | 428 |
rootfs has two subkeys: |
| 429 |
- |
|
| 430 | 429 |
<ul> |
| 431 | 430 |
<li> |
| 432 | 431 |
<code>type</code> is usually set to <code>layers</code>. |
| ... | ... |
@@ -435,10 +422,7 @@ whitespace. It has been added to this example for clarity. |
| 435 | 435 |
<code>diff_ids</code> is an array of layer content hashes (<code>DiffIDs</code>), in order from bottom-most to top-most. |
| 436 | 436 |
</li> |
| 437 | 437 |
</ul> |
| 438 |
- |
|
| 439 |
- |
|
| 440 | 438 |
Here is an example rootfs section: |
| 441 |
- |
|
| 442 | 439 |
<pre>"rootfs": {
|
| 443 | 440 |
"diff_ids": [ |
| 444 | 441 |
"sha256:c6f988f4874bb0add23a778f753c65efe992244e148a1d2ec2a8b664fb66bbd1", |
| ... | ... |
@@ -455,7 +439,6 @@ whitespace. It has been added to this example for clarity. |
| 455 | 455 |
<code>history</code> is an array of objects describing the history of |
| 456 | 456 |
each layer. The array is ordered from bottom-most layer to top-most |
| 457 | 457 |
layer. The object has the following fields. |
| 458 |
- |
|
| 459 | 458 |
<ul> |
| 460 | 459 |
<li> |
| 461 | 460 |
<code>created</code>: Creation time, expressed as a ISO-8601 formatted |
| ... | ... |
@@ -478,9 +461,7 @@ whitespace. It has been added to this example for clarity. |
| 478 | 478 |
filesystem). |
| 479 | 479 |
</li> |
| 480 | 480 |
</ul> |
| 481 |
- |
|
| 482 |
-Here is an example history section: |
|
| 483 |
- |
|
| 481 |
+ Here is an example history section: |
|
| 484 | 482 |
<pre>"history": [ |
| 485 | 483 |
{
|
| 486 | 484 |
"created": "2015-10-31T22:22:54.690851953Z", |
| ... | ... |
@@ -17,12 +17,10 @@ This specification uses the following terms: |
| 17 | 17 |
<dd> |
| 18 | 18 |
Images are composed of <i>layers</i>. <i>Image layer</i> is a general |
| 19 | 19 |
term which may be used to refer to one or both of the following: |
| 20 |
- |
|
| 21 | 20 |
<ol> |
| 22 | 21 |
<li>The metadata for the layer, described in the JSON format.</li> |
| 23 | 22 |
<li>The filesystem changes described by a layer.</li> |
| 24 | 23 |
</ol> |
| 25 |
- |
|
| 26 | 24 |
To refer to the former you may use the term <i>Layer JSON</i> or |
| 27 | 25 |
<i>Layer Metadata</i>. To refer to the latter you may use the term |
| 28 | 26 |
<i>Image Filesystem Changeset</i> or <i>Image Diff</i>. |
| ... | ... |
@@ -244,9 +242,7 @@ Here is an example image JSON file: |
| 244 | 244 |
container using the image. This field can be <code>null</code>, in |
| 245 | 245 |
which case any execution parameters should be specified at creation of |
| 246 | 246 |
the container. |
| 247 |
- |
|
| 248 | 247 |
<h4>Container RunConfig Field Descriptions</h4> |
| 249 |
- |
|
| 250 | 248 |
<dl> |
| 251 | 249 |
<dt> |
| 252 | 250 |
User <code>string</code> |
| ... | ... |
@@ -255,9 +251,7 @@ Here is an example image JSON file: |
| 255 | 255 |
<p>The username or UID which the process in the container should |
| 256 | 256 |
run as. This acts as a default value to use when the value is |
| 257 | 257 |
not specified when creating a container.</p> |
| 258 |
- |
|
| 259 | 258 |
<p>All of the following are valid:</p> |
| 260 |
- |
|
| 261 | 259 |
<ul> |
| 262 | 260 |
<li><code>user</code></li> |
| 263 | 261 |
<li><code>uid</code></li> |
| ... | ... |
@@ -266,7 +260,6 @@ Here is an example image JSON file: |
| 266 | 266 |
<li><code>uid:group</code></li> |
| 267 | 267 |
<li><code>user:gid</code></li> |
| 268 | 268 |
</ul> |
| 269 |
- |
|
| 270 | 269 |
<p>If <code>group</code>/<code>gid</code> is not specified, the |
| 271 | 270 |
default group and supplementary groups of the given |
| 272 | 271 |
<code>user</code>/<code>uid</code> in <code>/etc/passwd</code> |
| ... | ... |
@@ -305,13 +298,11 @@ Here is an example image JSON file: |
| 305 | 305 |
<code>map[string]struct{}</code> and is represented in JSON as
|
| 306 | 306 |
an object mapping its keys to an empty object. Here is an |
| 307 | 307 |
example: |
| 308 |
- |
|
| 309 | 308 |
<pre>{
|
| 310 | 309 |
"8080": {},
|
| 311 | 310 |
"53/udp": {},
|
| 312 | 311 |
"2356/tcp": {}
|
| 313 | 312 |
}</pre> |
| 314 |
- |
|
| 315 | 313 |
Its keys can be in the format of: |
| 316 | 314 |
<ul> |
| 317 | 315 |
<li> |
| ... | ... |
@@ -325,9 +316,7 @@ Here is an example image JSON file: |
| 325 | 325 |
</li> |
| 326 | 326 |
</ul> |
| 327 | 327 |
with the default protocol being <code>"tcp"</code> if not |
| 328 |
- specified. |
|
| 329 |
- |
|
| 330 |
- These values act as defaults and are merged with any specified |
|
| 328 |
+ specified. These values act as defaults and are merged with any specified |
|
| 331 | 329 |
when creating a container. |
| 332 | 330 |
</dd> |
| 333 | 331 |
<dt> |
| ... | ... |
@@ -502,21 +491,21 @@ For example, here's what the full archive of `library/busybox` is (displayed in |
| 502 | 502 |
``` |
| 503 | 503 |
. |
| 504 | 504 |
├── 5785b62b697b99a5af6cd5d0aabc804d5748abbb6d3d07da5d1d3795f2dcc83e |
| 505 |
-│ ├── VERSION |
|
| 506 |
-│ ├── json |
|
| 507 |
-│ └── layer.tar |
|
| 505 |
+│ ├── VERSION |
|
| 506 |
+│ ├── json |
|
| 507 |
+│ └── layer.tar |
|
| 508 | 508 |
├── a7b8b41220991bfc754d7ad445ad27b7f272ab8b4a2c175b9512b97471d02a8a |
| 509 |
-│ ├── VERSION |
|
| 510 |
-│ ├── json |
|
| 511 |
-│ └── layer.tar |
|
| 509 |
+│ ├── VERSION |
|
| 510 |
+│ ├── json |
|
| 511 |
+│ └── layer.tar |
|
| 512 | 512 |
├── a936027c5ca8bf8f517923169a233e391cbb38469a75de8383b5228dc2d26ceb |
| 513 |
-│ ├── VERSION |
|
| 514 |
-│ ├── json |
|
| 515 |
-│ └── layer.tar |
|
| 513 |
+│ ├── VERSION |
|
| 514 |
+│ ├── json |
|
| 515 |
+│ └── layer.tar |
|
| 516 | 516 |
├── f60c56784b832dd990022afc120b8136ab3da9528094752ae13fe63a2d28dc8c |
| 517 |
-│ ├── VERSION |
|
| 518 |
-│ ├── json |
|
| 519 |
-│ └── layer.tar |
|
| 517 |
+│ ├── VERSION |
|
| 518 |
+│ ├── json |
|
| 519 |
+│ └── layer.tar |
|
| 520 | 520 |
└── repositories |
| 521 | 521 |
``` |
| 522 | 522 |
|