Signed-off-by: Misty Stanley-Jones <misty@docker.com>
| ... | ... |
@@ -1,5 +1,14 @@ |
| 1 | 1 |
# The non-reference docs have been moved! |
| 2 | 2 |
|
| 3 |
+<!-- This file is maintained within the docker/docker Github |
|
| 4 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 5 |
+ pull requests against that repo. If you see this file in |
|
| 6 |
+ another repository, consider it read-only there, as it will |
|
| 7 |
+ periodically be overwritten by the definitive file. Pull |
|
| 8 |
+ requests which include edits to this file in other repositories |
|
| 9 |
+ will be rejected. |
|
| 10 |
+--> |
|
| 11 |
+ |
|
| 3 | 12 |
The documentation for Docker Engine has been merged into |
| 4 | 13 |
[the general documentation repo](https://github.com/docker/docker.github.io). |
| 5 | 14 |
|
| ... | ... |
@@ -5,6 +5,15 @@ description: "Deprecated Features." |
| 5 | 5 |
keywords: ["docker, documentation, about, technology, deprecate"] |
| 6 | 6 |
--- |
| 7 | 7 |
|
| 8 |
+<!-- This file is maintained within the docker/docker Github |
|
| 9 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 10 |
+ pull requests against that repo. If you see this file in |
|
| 11 |
+ another repository, consider it read-only there, as it will |
|
| 12 |
+ periodically be overwritten by the definitive file. Pull |
|
| 13 |
+ requests which include edits to this file in other repositories |
|
| 14 |
+ will be rejected. |
|
| 15 |
+--> |
|
| 16 |
+ |
|
| 8 | 17 |
# Deprecated Engine Features |
| 9 | 18 |
|
| 10 | 19 |
The following list of features are deprecated in Engine. |
| ... | ... |
@@ -8,6 +8,15 @@ keywords: ["API, Usage, plugins, documentation, developer"] |
| 8 | 8 |
advisory: "experimental" |
| 9 | 9 |
--- |
| 10 | 10 |
|
| 11 |
+<!-- This file is maintained within the docker/docker Github |
|
| 12 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 13 |
+ pull requests against that repo. If you see this file in |
|
| 14 |
+ another repository, consider it read-only there, as it will |
|
| 15 |
+ periodically be overwritten by the definitive file. Pull |
|
| 16 |
+ requests which include edits to this file in other repositories |
|
| 17 |
+ will be rejected. |
|
| 18 |
+--> |
|
| 19 |
+ |
|
| 11 | 20 |
# Docker Engine managed plugin system |
| 12 | 21 |
|
| 13 | 22 |
This document describes the plugin system available today in the **experimental |
| ... | ... |
@@ -5,6 +5,15 @@ description: "How to add additional functionality to Docker with plugins extensi |
| 5 | 5 |
keywords: ["Examples, Usage, plugins, docker, documentation, user guide"] |
| 6 | 6 |
--- |
| 7 | 7 |
|
| 8 |
+<!-- This file is maintained within the docker/docker Github |
|
| 9 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 10 |
+ pull requests against that repo. If you see this file in |
|
| 11 |
+ another repository, consider it read-only there, as it will |
|
| 12 |
+ periodically be overwritten by the definitive file. Pull |
|
| 13 |
+ requests which include edits to this file in other repositories |
|
| 14 |
+ will be rejected. |
|
| 15 |
+--> |
|
| 16 |
+ |
|
| 8 | 17 |
# Use Docker Engine plugins |
| 9 | 18 |
|
| 10 | 19 |
This document describes the Docker Engine plugins generally available in Docker |
| ... | ... |
@@ -8,6 +8,15 @@ keywords: ["API, Usage, plugins, documentation, developer"] |
| 8 | 8 |
advisory: "experimental" |
| 9 | 9 |
--- |
| 10 | 10 |
|
| 11 |
+<!-- This file is maintained within the docker/docker Github |
|
| 12 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 13 |
+ pull requests against that repo. If you see this file in |
|
| 14 |
+ another repository, consider it read-only there, as it will |
|
| 15 |
+ periodically be overwritten by the definitive file. Pull |
|
| 16 |
+ requests which include edits to this file in other repositories |
|
| 17 |
+ will be rejected. |
|
| 18 |
+--> |
|
| 19 |
+ |
|
| 11 | 20 |
# Plugin Manifest Version 0 of Plugin V2 |
| 12 | 21 |
|
| 13 | 22 |
This document outlines the format of the V0 plugin manifest. The plugin |
| ... | ... |
@@ -6,5 +6,13 @@ type: "menu" |
| 6 | 6 |
identifier: "engine_extend" |
| 7 | 7 |
--- |
| 8 | 8 |
|
| 9 |
+<!-- This file is maintained within the docker/docker Github |
|
| 10 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 11 |
+ pull requests against that repo. If you see this file in |
|
| 12 |
+ another repository, consider it read-only there, as it will |
|
| 13 |
+ periodically be overwritten by the definitive file. Pull |
|
| 14 |
+ requests which include edits to this file in other repositories |
|
| 15 |
+ will be rejected. |
|
| 16 |
+--> |
|
| 9 | 17 |
|
| 10 | 18 |
<!--menu page not rendered--> |
| ... | ... |
@@ -4,6 +4,15 @@ description: "How to write Docker plugins extensions " |
| 4 | 4 |
keywords: ["API, Usage, plugins, documentation, developer"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# Docker Plugin API |
| 8 | 17 |
|
| 9 | 18 |
Docker plugins are out-of-process extensions which add capabilities to the |
| ... | ... |
@@ -5,6 +5,14 @@ keywords: ["security, authorization, authentication, docker, documentation, plug |
| 5 | 5 |
aliases: ["/engine/extend/authorization/"] |
| 6 | 6 |
--- |
| 7 | 7 |
|
| 8 |
+<!-- This file is maintained within the docker/docker Github |
|
| 9 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 10 |
+ pull requests against that repo. If you see this file in |
|
| 11 |
+ another repository, consider it read-only there, as it will |
|
| 12 |
+ periodically be overwritten by the definitive file. Pull |
|
| 13 |
+ requests which include edits to this file in other repositories |
|
| 14 |
+ will be rejected. |
|
| 15 |
+--> |
|
| 8 | 16 |
|
| 9 | 17 |
# Create an authorization plugin |
| 10 | 18 |
|
| ... | ... |
@@ -4,6 +4,15 @@ description: "Network driver plugins." |
| 4 | 4 |
keywords: ["Examples, Usage, plugins, docker, documentation, user guide"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# Engine network driver plugins |
| 8 | 17 |
|
| 9 | 18 |
This document describes Docker Engine network driver plugins generally |
| ... | ... |
@@ -4,6 +4,15 @@ description: "How to manage data with external volume plugins" |
| 4 | 4 |
keywords: ["Examples, Usage, volume, docker, data, volumes, plugin, api"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# Write a volume plugin |
| 8 | 17 |
|
| 9 | 18 |
Docker Engine volume plugins enable Engine deployments to be integrated with |
| ... | ... |
@@ -2,6 +2,15 @@ |
| 2 | 2 |
published: false |
| 3 | 3 |
--- |
| 4 | 4 |
|
| 5 |
+<!-- This file is maintained within the docker/docker Github |
|
| 6 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 7 |
+ pull requests against that repo. If you see this file in |
|
| 8 |
+ another repository, consider it read-only there, as it will |
|
| 9 |
+ periodically be overwritten by the definitive file. Pull |
|
| 10 |
+ requests which include edits to this file in other repositories |
|
| 11 |
+ will be rejected. |
|
| 12 |
+--> |
|
| 13 |
+ |
|
| 5 | 14 |
This directory holds the authoritative specifications of APIs defined and implemented by Docker. Currently this includes: |
| 6 | 15 |
|
| 7 | 16 |
* The remote API by which a docker node can be queried over HTTP |
| ... | ... |
@@ -5,6 +5,15 @@ description: "API Documentation for the Docker Hub API" |
| 5 | 5 |
keywords: ["API, Docker, index, REST, documentation, Docker Hub, registry"] |
| 6 | 6 |
--- |
| 7 | 7 |
|
| 8 |
+<!-- This file is maintained within the docker/docker Github |
|
| 9 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 10 |
+ pull requests against that repo. If you see this file in |
|
| 11 |
+ another repository, consider it read-only there, as it will |
|
| 12 |
+ periodically be overwritten by the definitive file. Pull |
|
| 13 |
+ requests which include edits to this file in other repositories |
|
| 14 |
+ will be rejected. |
|
| 15 |
+--> |
|
| 16 |
+ |
|
| 8 | 17 |
# Docker Hub API |
| 9 | 18 |
|
| 10 | 19 |
This API is deprecated as of 1.7. To view the old version, see the [Docker Hub |
| ... | ... |
@@ -4,6 +4,15 @@ description: "API Documentation for docker.io accounts." |
| 4 | 4 |
keywords: ["API, Docker, accounts, REST, documentation"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# docker.io accounts API |
| 8 | 17 |
|
| 9 | 18 |
## Get a single user |
| ... | ... |
@@ -4,6 +4,15 @@ description: "API Documentation for Docker" |
| 4 | 4 |
keywords: ["API, Docker, rcli, REST, documentation"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# Docker Remote API |
| 8 | 17 |
|
| 9 | 18 |
Docker's Remote API uses an open schema model. In this model, unknown |
| ... | ... |
@@ -4,6 +4,15 @@ description: "API Documentation for Docker" |
| 4 | 4 |
keywords: ["API, Docker, rcli, REST, documentation"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# Docker Remote API v1.18 |
| 8 | 17 |
|
| 9 | 18 |
## 1. Brief introduction |
| ... | ... |
@@ -518,7 +527,9 @@ Get `stdout` and `stderr` logs from the container ``id`` |
| 518 | 518 |
Connection: Upgrade |
| 519 | 519 |
Upgrade: tcp |
| 520 | 520 |
|
| 521 |
+ {% raw %}
|
|
| 521 | 522 |
{{ STREAM }}
|
| 523 |
+ {% endraw %}
|
|
| 522 | 524 |
|
| 523 | 525 |
**Query parameters**: |
| 524 | 526 |
|
| ... | ... |
@@ -593,7 +604,9 @@ Export the contents of container `id` |
| 593 | 593 |
HTTP/1.1 200 OK |
| 594 | 594 |
Content-Type: application/octet-stream |
| 595 | 595 |
|
| 596 |
+ {% raw %}
|
|
| 596 | 597 |
{{ TAR STREAM }}
|
| 598 |
+ {% endraw %}
|
|
| 597 | 599 |
|
| 598 | 600 |
**Status codes**: |
| 599 | 601 |
|
| ... | ... |
@@ -897,7 +910,9 @@ Attach to the container `id` |
| 897 | 897 |
Connection: Upgrade |
| 898 | 898 |
Upgrade: tcp |
| 899 | 899 |
|
| 900 |
+ {% raw %}
|
|
| 900 | 901 |
{{ STREAM }}
|
| 902 |
+ {% endraw %}
|
|
| 901 | 903 |
|
| 902 | 904 |
**Query parameters**: |
| 903 | 905 |
|
| ... | ... |
@@ -977,7 +992,9 @@ Implements websocket protocol handshake according to [RFC 6455](http://tools.iet |
| 977 | 977 |
|
| 978 | 978 |
**Example response** |
| 979 | 979 |
|
| 980 |
+ {% raw %}
|
|
| 980 | 981 |
{{ STREAM }}
|
| 982 |
+ {% endraw %}
|
|
| 981 | 983 |
|
| 982 | 984 |
**Query parameters**: |
| 983 | 985 |
|
| ... | ... |
@@ -1070,7 +1087,9 @@ Copy files or folders of container `id` |
| 1070 | 1070 |
HTTP/1.1 200 OK |
| 1071 | 1071 |
Content-Type: application/x-tar |
| 1072 | 1072 |
|
| 1073 |
+ {% raw %}
|
|
| 1073 | 1074 |
{{ TAR STREAM }}
|
| 1075 |
+ {% endraw %}
|
|
| 1074 | 1076 |
|
| 1075 | 1077 |
**Status codes**: |
| 1076 | 1078 |
|
| ... | ... |
@@ -1176,7 +1195,9 @@ Build an image from a Dockerfile |
| 1176 | 1176 |
|
| 1177 | 1177 |
POST /build HTTP/1.1 |
| 1178 | 1178 |
|
| 1179 |
+ {% raw %}
|
|
| 1179 | 1180 |
{{ TAR STREAM }}
|
| 1181 |
+ {% endraw %}
|
|
| 1180 | 1182 |
|
| 1181 | 1183 |
**Example response**: |
| 1182 | 1184 |
|
| ... | ... |
@@ -1941,7 +1962,9 @@ interactive session with the `exec` command. |
| 1941 | 1941 |
HTTP/1.1 200 OK |
| 1942 | 1942 |
Content-Type: application/vnd.docker.raw-stream |
| 1943 | 1943 |
|
| 1944 |
+ {% raw %}
|
|
| 1944 | 1945 |
{{ STREAM }}
|
| 1946 |
+ {% endraw %}
|
|
| 1945 | 1947 |
|
| 1946 | 1948 |
**JSON parameters**: |
| 1947 | 1949 |
|
| ... | ... |
@@ -4,6 +4,15 @@ description: "API Documentation for Docker" |
| 4 | 4 |
keywords: ["API, Docker, rcli, REST, documentation"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# Docker Remote API v1.19 |
| 8 | 17 |
|
| 9 | 18 |
## 1. Brief introduction |
| ... | ... |
@@ -532,7 +541,9 @@ Get `stdout` and `stderr` logs from the container ``id`` |
| 532 | 532 |
Connection: Upgrade |
| 533 | 533 |
Upgrade: tcp |
| 534 | 534 |
|
| 535 |
+ {% raw %}
|
|
| 535 | 536 |
{{ STREAM }}
|
| 537 |
+ {% endraw %}
|
|
| 536 | 538 |
|
| 537 | 539 |
**Query parameters**: |
| 538 | 540 |
|
| ... | ... |
@@ -609,7 +620,9 @@ Export the contents of container `id` |
| 609 | 609 |
HTTP/1.1 200 OK |
| 610 | 610 |
Content-Type: application/octet-stream |
| 611 | 611 |
|
| 612 |
+ {% raw %}
|
|
| 612 | 613 |
{{ TAR STREAM }}
|
| 614 |
+ {% endraw %}
|
|
| 613 | 615 |
|
| 614 | 616 |
**Status codes**: |
| 615 | 617 |
|
| ... | ... |
@@ -934,7 +947,9 @@ Attach to the container `id` |
| 934 | 934 |
Connection: Upgrade |
| 935 | 935 |
Upgrade: tcp |
| 936 | 936 |
|
| 937 |
+ {% raw %}
|
|
| 937 | 938 |
{{ STREAM }}
|
| 939 |
+ {% endraw %}
|
|
| 938 | 940 |
|
| 939 | 941 |
**Query parameters**: |
| 940 | 942 |
|
| ... | ... |
@@ -1014,7 +1029,9 @@ Implements websocket protocol handshake according to [RFC 6455](http://tools.iet |
| 1014 | 1014 |
|
| 1015 | 1015 |
**Example response** |
| 1016 | 1016 |
|
| 1017 |
+ {% raw %}
|
|
| 1017 | 1018 |
{{ STREAM }}
|
| 1019 |
+ {% endraw %}
|
|
| 1018 | 1020 |
|
| 1019 | 1021 |
**Query parameters**: |
| 1020 | 1022 |
|
| ... | ... |
@@ -1107,7 +1124,9 @@ Copy files or folders of container `id` |
| 1107 | 1107 |
HTTP/1.1 200 OK |
| 1108 | 1108 |
Content-Type: application/x-tar |
| 1109 | 1109 |
|
| 1110 |
+ {% raw %}
|
|
| 1110 | 1111 |
{{ TAR STREAM }}
|
| 1112 |
+ {% endraw %}
|
|
| 1111 | 1113 |
|
| 1112 | 1114 |
**Status codes**: |
| 1113 | 1115 |
|
| ... | ... |
@@ -1218,7 +1237,9 @@ Build an image from a Dockerfile |
| 1218 | 1218 |
|
| 1219 | 1219 |
POST /build HTTP/1.1 |
| 1220 | 1220 |
|
| 1221 |
+ {% raw %}
|
|
| 1221 | 1222 |
{{ TAR STREAM }}
|
| 1223 |
+ {% endraw %}
|
|
| 1222 | 1224 |
|
| 1223 | 1225 |
**Example response**: |
| 1224 | 1226 |
|
| ... | ... |
@@ -2022,7 +2043,9 @@ interactive session with the `exec` command. |
| 2022 | 2022 |
HTTP/1.1 200 OK |
| 2023 | 2023 |
Content-Type: application/vnd.docker.raw-stream |
| 2024 | 2024 |
|
| 2025 |
+ {% raw %}
|
|
| 2025 | 2026 |
{{ STREAM }}
|
| 2027 |
+ {% endraw %}
|
|
| 2026 | 2028 |
|
| 2027 | 2029 |
**JSON parameters**: |
| 2028 | 2030 |
|
| ... | ... |
@@ -4,6 +4,15 @@ description: "API Documentation for Docker" |
| 4 | 4 |
keywords: ["API, Docker, rcli, REST, documentation"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# Docker Remote API v1.20 |
| 8 | 17 |
|
| 9 | 18 |
## 1. Brief introduction |
| ... | ... |
@@ -541,7 +550,9 @@ Get `stdout` and `stderr` logs from the container ``id`` |
| 541 | 541 |
Connection: Upgrade |
| 542 | 542 |
Upgrade: tcp |
| 543 | 543 |
|
| 544 |
+ {% raw %}
|
|
| 544 | 545 |
{{ STREAM }}
|
| 546 |
+ {% endraw %}
|
|
| 545 | 547 |
|
| 546 | 548 |
**Query parameters**: |
| 547 | 549 |
|
| ... | ... |
@@ -618,7 +629,9 @@ Export the contents of container `id` |
| 618 | 618 |
HTTP/1.1 200 OK |
| 619 | 619 |
Content-Type: application/octet-stream |
| 620 | 620 |
|
| 621 |
+ {% raw %}
|
|
| 621 | 622 |
{{ TAR STREAM }}
|
| 623 |
+ {% endraw %}
|
|
| 622 | 624 |
|
| 623 | 625 |
**Status codes**: |
| 624 | 626 |
|
| ... | ... |
@@ -943,7 +956,9 @@ Attach to the container `id` |
| 943 | 943 |
Connection: Upgrade |
| 944 | 944 |
Upgrade: tcp |
| 945 | 945 |
|
| 946 |
+ {% raw %}
|
|
| 946 | 947 |
{{ STREAM }}
|
| 948 |
+ {% endraw %}
|
|
| 947 | 949 |
|
| 948 | 950 |
**Query parameters**: |
| 949 | 951 |
|
| ... | ... |
@@ -1023,7 +1038,9 @@ Implements websocket protocol handshake according to [RFC 6455](http://tools.iet |
| 1023 | 1023 |
|
| 1024 | 1024 |
**Example response** |
| 1025 | 1025 |
|
| 1026 |
+ {% raw %}
|
|
| 1026 | 1027 |
{{ STREAM }}
|
| 1028 |
+ {% endraw %}
|
|
| 1027 | 1029 |
|
| 1028 | 1030 |
**Query parameters**: |
| 1029 | 1031 |
|
| ... | ... |
@@ -1118,7 +1135,9 @@ Copy files or folders of container `id` |
| 1118 | 1118 |
HTTP/1.1 200 OK |
| 1119 | 1119 |
Content-Type: application/x-tar |
| 1120 | 1120 |
|
| 1121 |
+ {% raw %}
|
|
| 1121 | 1122 |
{{ TAR STREAM }}
|
| 1123 |
+ {% endraw %}
|
|
| 1122 | 1124 |
|
| 1123 | 1125 |
**Status codes**: |
| 1124 | 1126 |
|
| ... | ... |
@@ -1164,7 +1183,9 @@ Get a tar archive of a resource in the filesystem of container `id`. |
| 1164 | 1164 |
Content-Type: application/x-tar |
| 1165 | 1165 |
X-Docker-Container-Path-Stat: eyJuYW1lIjoicm9vdCIsInNpemUiOjQwOTYsIm1vZGUiOjIxNDc0ODQwOTYsIm10aW1lIjoiMjAxNC0wMi0yN1QyMDo1MToyM1oiLCJsaW5rVGFyZ2V0IjoiIn0= |
| 1166 | 1166 |
|
| 1167 |
+ {% raw %}
|
|
| 1167 | 1168 |
{{ TAR STREAM }}
|
| 1169 |
+ {% endraw %}
|
|
| 1168 | 1170 |
|
| 1169 | 1171 |
On success, a response header `X-Docker-Container-Path-Stat` will be set to a |
| 1170 | 1172 |
base64-encoded JSON object containing some filesystem header information about |
| ... | ... |
@@ -1219,7 +1240,9 @@ Upload a tar archive to be extracted to a path in the filesystem of container |
| 1219 | 1219 |
PUT /containers/8cce319429b2/archive?path=/vol1 HTTP/1.1 |
| 1220 | 1220 |
Content-Type: application/x-tar |
| 1221 | 1221 |
|
| 1222 |
+ {% raw %}
|
|
| 1222 | 1223 |
{{ TAR STREAM }}
|
| 1224 |
+ {% endraw %}
|
|
| 1223 | 1225 |
|
| 1224 | 1226 |
**Example response**: |
| 1225 | 1227 |
|
| ... | ... |
@@ -1345,7 +1368,9 @@ Build an image from a Dockerfile |
| 1345 | 1345 |
|
| 1346 | 1346 |
POST /build HTTP/1.1 |
| 1347 | 1347 |
|
| 1348 |
+ {% raw %}
|
|
| 1348 | 1349 |
{{ TAR STREAM }}
|
| 1350 |
+ {% endraw %}
|
|
| 1349 | 1351 |
|
| 1350 | 1352 |
**Example response**: |
| 1351 | 1353 |
|
| ... | ... |
@@ -2175,7 +2200,9 @@ interactive session with the `exec` command. |
| 2175 | 2175 |
HTTP/1.1 200 OK |
| 2176 | 2176 |
Content-Type: application/vnd.docker.raw-stream |
| 2177 | 2177 |
|
| 2178 |
+ {% raw %}
|
|
| 2178 | 2179 |
{{ STREAM }}
|
| 2180 |
+ {% endraw %}
|
|
| 2179 | 2181 |
|
| 2180 | 2182 |
**JSON parameters**: |
| 2181 | 2183 |
|
| ... | ... |
@@ -4,6 +4,15 @@ description: "API Documentation for Docker" |
| 4 | 4 |
keywords: ["API, Docker, rcli, REST, documentation"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# Docker Remote API v1.21 |
| 8 | 17 |
|
| 9 | 18 |
## 1. Brief introduction |
| ... | ... |
@@ -610,7 +619,9 @@ Get `stdout` and `stderr` logs from the container ``id`` |
| 610 | 610 |
Connection: Upgrade |
| 611 | 611 |
Upgrade: tcp |
| 612 | 612 |
|
| 613 |
+ {% raw %}
|
|
| 613 | 614 |
{{ STREAM }}
|
| 615 |
+ {% endraw %}
|
|
| 614 | 616 |
|
| 615 | 617 |
**Query parameters**: |
| 616 | 618 |
|
| ... | ... |
@@ -687,7 +698,9 @@ Export the contents of container `id` |
| 687 | 687 |
HTTP/1.1 200 OK |
| 688 | 688 |
Content-Type: application/octet-stream |
| 689 | 689 |
|
| 690 |
+ {% raw %}
|
|
| 690 | 691 |
{{ TAR STREAM }}
|
| 692 |
+ {% endraw %}
|
|
| 691 | 693 |
|
| 692 | 694 |
**Status codes**: |
| 693 | 695 |
|
| ... | ... |
@@ -1024,7 +1037,9 @@ Attach to the container `id` |
| 1024 | 1024 |
Connection: Upgrade |
| 1025 | 1025 |
Upgrade: tcp |
| 1026 | 1026 |
|
| 1027 |
+ {% raw %}
|
|
| 1027 | 1028 |
{{ STREAM }}
|
| 1029 |
+ {% endraw %}
|
|
| 1028 | 1030 |
|
| 1029 | 1031 |
**Query parameters**: |
| 1030 | 1032 |
|
| ... | ... |
@@ -1104,7 +1119,9 @@ Implements websocket protocol handshake according to [RFC 6455](http://tools.iet |
| 1104 | 1104 |
|
| 1105 | 1105 |
**Example response** |
| 1106 | 1106 |
|
| 1107 |
+ {% raw %}
|
|
| 1107 | 1108 |
{{ STREAM }}
|
| 1109 |
+ {% endraw %}
|
|
| 1108 | 1110 |
|
| 1109 | 1111 |
**Query parameters**: |
| 1110 | 1112 |
|
| ... | ... |
@@ -1199,7 +1216,9 @@ Copy files or folders of container `id` |
| 1199 | 1199 |
HTTP/1.1 200 OK |
| 1200 | 1200 |
Content-Type: application/x-tar |
| 1201 | 1201 |
|
| 1202 |
+ {% raw %}
|
|
| 1202 | 1203 |
{{ TAR STREAM }}
|
| 1204 |
+ {% endraw %}
|
|
| 1203 | 1205 |
|
| 1204 | 1206 |
**Status codes**: |
| 1205 | 1207 |
|
| ... | ... |
@@ -1245,7 +1264,9 @@ Get a tar archive of a resource in the filesystem of container `id`. |
| 1245 | 1245 |
Content-Type: application/x-tar |
| 1246 | 1246 |
X-Docker-Container-Path-Stat: eyJuYW1lIjoicm9vdCIsInNpemUiOjQwOTYsIm1vZGUiOjIxNDc0ODQwOTYsIm10aW1lIjoiMjAxNC0wMi0yN1QyMDo1MToyM1oiLCJsaW5rVGFyZ2V0IjoiIn0= |
| 1247 | 1247 |
|
| 1248 |
+ {% raw %}
|
|
| 1248 | 1249 |
{{ TAR STREAM }}
|
| 1250 |
+ {% endraw %}
|
|
| 1249 | 1251 |
|
| 1250 | 1252 |
On success, a response header `X-Docker-Container-Path-Stat` will be set to a |
| 1251 | 1253 |
base64-encoded JSON object containing some filesystem header information about |
| ... | ... |
@@ -1300,7 +1321,9 @@ Upload a tar archive to be extracted to a path in the filesystem of container |
| 1300 | 1300 |
PUT /containers/8cce319429b2/archive?path=/vol1 HTTP/1.1 |
| 1301 | 1301 |
Content-Type: application/x-tar |
| 1302 | 1302 |
|
| 1303 |
+ {% raw %}
|
|
| 1303 | 1304 |
{{ TAR STREAM }}
|
| 1305 |
+ {% endraw %}
|
|
| 1304 | 1306 |
|
| 1305 | 1307 |
**Example response**: |
| 1306 | 1308 |
|
| ... | ... |
@@ -1426,7 +1449,9 @@ Build an image from a Dockerfile |
| 1426 | 1426 |
|
| 1427 | 1427 |
POST /build HTTP/1.1 |
| 1428 | 1428 |
|
| 1429 |
+ {% raw %}
|
|
| 1429 | 1430 |
{{ TAR STREAM }}
|
| 1431 |
+ {% endraw %}
|
|
| 1430 | 1432 |
|
| 1431 | 1433 |
**Example response**: |
| 1432 | 1434 |
|
| ... | ... |
@@ -2333,7 +2358,9 @@ interactive session with the `exec` command. |
| 2333 | 2333 |
HTTP/1.1 200 OK |
| 2334 | 2334 |
Content-Type: application/vnd.docker.raw-stream |
| 2335 | 2335 |
|
| 2336 |
+ {% raw %}
|
|
| 2336 | 2337 |
{{ STREAM }}
|
| 2338 |
+ {% endraw %}
|
|
| 2337 | 2339 |
|
| 2338 | 2340 |
**JSON parameters**: |
| 2339 | 2341 |
|
| ... | ... |
@@ -4,6 +4,15 @@ description: "API Documentation for Docker" |
| 4 | 4 |
keywords: ["API, Docker, rcli, REST, documentation"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# Docker Remote API v1.22 |
| 8 | 17 |
|
| 9 | 18 |
## 1. Brief introduction |
| ... | ... |
@@ -735,7 +744,9 @@ Get `stdout` and `stderr` logs from the container ``id`` |
| 735 | 735 |
Connection: Upgrade |
| 736 | 736 |
Upgrade: tcp |
| 737 | 737 |
|
| 738 |
+ {% raw %}
|
|
| 738 | 739 |
{{ STREAM }}
|
| 740 |
+ {% endraw %}
|
|
| 739 | 741 |
|
| 740 | 742 |
**Query parameters**: |
| 741 | 743 |
|
| ... | ... |
@@ -812,7 +823,9 @@ Export the contents of container `id` |
| 812 | 812 |
HTTP/1.1 200 OK |
| 813 | 813 |
Content-Type: application/octet-stream |
| 814 | 814 |
|
| 815 |
+ {% raw %}
|
|
| 815 | 816 |
{{ TAR STREAM }}
|
| 817 |
+ {% endraw %}
|
|
| 816 | 818 |
|
| 817 | 819 |
**Status codes**: |
| 818 | 820 |
|
| ... | ... |
@@ -1195,7 +1208,9 @@ Attach to the container `id` |
| 1195 | 1195 |
Connection: Upgrade |
| 1196 | 1196 |
Upgrade: tcp |
| 1197 | 1197 |
|
| 1198 |
+ {% raw %}
|
|
| 1198 | 1199 |
{{ STREAM }}
|
| 1200 |
+ {% endraw %}
|
|
| 1199 | 1201 |
|
| 1200 | 1202 |
**Query parameters**: |
| 1201 | 1203 |
|
| ... | ... |
@@ -1279,7 +1294,9 @@ Implements websocket protocol handshake according to [RFC 6455](http://tools.iet |
| 1279 | 1279 |
|
| 1280 | 1280 |
**Example response** |
| 1281 | 1281 |
|
| 1282 |
+ {% raw %}
|
|
| 1282 | 1283 |
{{ STREAM }}
|
| 1284 |
+ {% endraw %}
|
|
| 1283 | 1285 |
|
| 1284 | 1286 |
**Query parameters**: |
| 1285 | 1287 |
|
| ... | ... |
@@ -1377,7 +1394,9 @@ Copy files or folders of container `id` |
| 1377 | 1377 |
HTTP/1.1 200 OK |
| 1378 | 1378 |
Content-Type: application/x-tar |
| 1379 | 1379 |
|
| 1380 |
+ {% raw %}
|
|
| 1380 | 1381 |
{{ TAR STREAM }}
|
| 1382 |
+ {% endraw %}
|
|
| 1381 | 1383 |
|
| 1382 | 1384 |
**Status codes**: |
| 1383 | 1385 |
|
| ... | ... |
@@ -1423,7 +1442,9 @@ Get a tar archive of a resource in the filesystem of container `id`. |
| 1423 | 1423 |
Content-Type: application/x-tar |
| 1424 | 1424 |
X-Docker-Container-Path-Stat: eyJuYW1lIjoicm9vdCIsInNpemUiOjQwOTYsIm1vZGUiOjIxNDc0ODQwOTYsIm10aW1lIjoiMjAxNC0wMi0yN1QyMDo1MToyM1oiLCJsaW5rVGFyZ2V0IjoiIn0= |
| 1425 | 1425 |
|
| 1426 |
+ {% raw %}
|
|
| 1426 | 1427 |
{{ TAR STREAM }}
|
| 1428 |
+ {% endraw %}
|
|
| 1427 | 1429 |
|
| 1428 | 1430 |
On success, a response header `X-Docker-Container-Path-Stat` will be set to a |
| 1429 | 1431 |
base64-encoded JSON object containing some filesystem header information about |
| ... | ... |
@@ -1478,7 +1499,9 @@ Upload a tar archive to be extracted to a path in the filesystem of container |
| 1478 | 1478 |
PUT /containers/8cce319429b2/archive?path=/vol1 HTTP/1.1 |
| 1479 | 1479 |
Content-Type: application/x-tar |
| 1480 | 1480 |
|
| 1481 |
+ {% raw %}
|
|
| 1481 | 1482 |
{{ TAR STREAM }}
|
| 1483 |
+ {% endraw %}
|
|
| 1482 | 1484 |
|
| 1483 | 1485 |
**Example response**: |
| 1484 | 1486 |
|
| ... | ... |
@@ -1604,7 +1627,9 @@ Build an image from a Dockerfile |
| 1604 | 1604 |
|
| 1605 | 1605 |
POST /build HTTP/1.1 |
| 1606 | 1606 |
|
| 1607 |
+ {% raw %}
|
|
| 1607 | 1608 |
{{ TAR STREAM }}
|
| 1609 |
+ {% endraw %}
|
|
| 1608 | 1610 |
|
| 1609 | 1611 |
**Example response**: |
| 1610 | 1612 |
|
| ... | ... |
@@ -2727,7 +2752,9 @@ interactive session with the `exec` command. |
| 2727 | 2727 |
HTTP/1.1 200 OK |
| 2728 | 2728 |
Content-Type: application/vnd.docker.raw-stream |
| 2729 | 2729 |
|
| 2730 |
+ {% raw %}
|
|
| 2730 | 2731 |
{{ STREAM }}
|
| 2732 |
+ {% endraw %}
|
|
| 2731 | 2733 |
|
| 2732 | 2734 |
**JSON parameters**: |
| 2733 | 2735 |
|
| ... | ... |
@@ -4,6 +4,15 @@ description: "API Documentation for Docker" |
| 4 | 4 |
keywords: ["API, Docker, rcli, REST, documentation"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# Docker Remote API v1.23 |
| 8 | 17 |
|
| 9 | 18 |
## 1. Brief introduction |
| ... | ... |
@@ -761,7 +770,9 @@ Get `stdout` and `stderr` logs from the container ``id`` |
| 761 | 761 |
Connection: Upgrade |
| 762 | 762 |
Upgrade: tcp |
| 763 | 763 |
|
| 764 |
+ {% raw %}
|
|
| 764 | 765 |
{{ STREAM }}
|
| 766 |
+ {% endraw %}
|
|
| 765 | 767 |
|
| 766 | 768 |
**Query parameters**: |
| 767 | 769 |
|
| ... | ... |
@@ -838,7 +849,9 @@ Export the contents of container `id` |
| 838 | 838 |
HTTP/1.1 200 OK |
| 839 | 839 |
Content-Type: application/octet-stream |
| 840 | 840 |
|
| 841 |
+ {% raw %}
|
|
| 841 | 842 |
{{ TAR STREAM }}
|
| 843 |
+ {% endraw %}
|
|
| 842 | 844 |
|
| 843 | 845 |
**Status codes**: |
| 844 | 846 |
|
| ... | ... |
@@ -1228,7 +1241,9 @@ Attach to the container `id` |
| 1228 | 1228 |
Connection: Upgrade |
| 1229 | 1229 |
Upgrade: tcp |
| 1230 | 1230 |
|
| 1231 |
+ {% raw %}
|
|
| 1231 | 1232 |
{{ STREAM }}
|
| 1233 |
+ {% endraw %}
|
|
| 1232 | 1234 |
|
| 1233 | 1235 |
**Query parameters**: |
| 1234 | 1236 |
|
| ... | ... |
@@ -1312,7 +1327,9 @@ Implements websocket protocol handshake according to [RFC 6455](http://tools.iet |
| 1312 | 1312 |
|
| 1313 | 1313 |
**Example response** |
| 1314 | 1314 |
|
| 1315 |
+ {% raw %}
|
|
| 1315 | 1316 |
{{ STREAM }}
|
| 1317 |
+ {% endraw %}
|
|
| 1316 | 1318 |
|
| 1317 | 1319 |
**Query parameters**: |
| 1318 | 1320 |
|
| ... | ... |
@@ -1410,7 +1427,9 @@ Copy files or folders of container `id` |
| 1410 | 1410 |
HTTP/1.1 200 OK |
| 1411 | 1411 |
Content-Type: application/x-tar |
| 1412 | 1412 |
|
| 1413 |
+ {% raw %}
|
|
| 1413 | 1414 |
{{ TAR STREAM }}
|
| 1415 |
+ {% endraw %}
|
|
| 1414 | 1416 |
|
| 1415 | 1417 |
**Status codes**: |
| 1416 | 1418 |
|
| ... | ... |
@@ -1456,7 +1475,9 @@ Get a tar archive of a resource in the filesystem of container `id`. |
| 1456 | 1456 |
Content-Type: application/x-tar |
| 1457 | 1457 |
X-Docker-Container-Path-Stat: eyJuYW1lIjoicm9vdCIsInNpemUiOjQwOTYsIm1vZGUiOjIxNDc0ODQwOTYsIm10aW1lIjoiMjAxNC0wMi0yN1QyMDo1MToyM1oiLCJsaW5rVGFyZ2V0IjoiIn0= |
| 1458 | 1458 |
|
| 1459 |
+ {% raw %}
|
|
| 1459 | 1460 |
{{ TAR STREAM }}
|
| 1461 |
+ {% endraw %}
|
|
| 1460 | 1462 |
|
| 1461 | 1463 |
On success, a response header `X-Docker-Container-Path-Stat` will be set to a |
| 1462 | 1464 |
base64-encoded JSON object containing some filesystem header information about |
| ... | ... |
@@ -1511,7 +1532,9 @@ Upload a tar archive to be extracted to a path in the filesystem of container |
| 1511 | 1511 |
PUT /containers/8cce319429b2/archive?path=/vol1 HTTP/1.1 |
| 1512 | 1512 |
Content-Type: application/x-tar |
| 1513 | 1513 |
|
| 1514 |
+ {% raw %}
|
|
| 1514 | 1515 |
{{ TAR STREAM }}
|
| 1516 |
+ {% endraw %}
|
|
| 1515 | 1517 |
|
| 1516 | 1518 |
**Example response**: |
| 1517 | 1519 |
|
| ... | ... |
@@ -1637,7 +1660,9 @@ Build an image from a Dockerfile |
| 1637 | 1637 |
|
| 1638 | 1638 |
POST /build HTTP/1.1 |
| 1639 | 1639 |
|
| 1640 |
+ {% raw %}
|
|
| 1640 | 1641 |
{{ TAR STREAM }}
|
| 1642 |
+ {% endraw %}
|
|
| 1641 | 1643 |
|
| 1642 | 1644 |
**Example response**: |
| 1643 | 1645 |
|
| ... | ... |
@@ -2801,7 +2826,9 @@ interactive session with the `exec` command. |
| 2801 | 2801 |
HTTP/1.1 200 OK |
| 2802 | 2802 |
Content-Type: application/vnd.docker.raw-stream |
| 2803 | 2803 |
|
| 2804 |
+ {% raw %}
|
|
| 2804 | 2805 |
{{ STREAM }}
|
| 2806 |
+ {% endraw %}
|
|
| 2805 | 2807 |
|
| 2806 | 2808 |
**JSON parameters**: |
| 2807 | 2809 |
|
| ... | ... |
@@ -4,6 +4,15 @@ description: "API Documentation for Docker" |
| 4 | 4 |
keywords: ["API, Docker, rcli, REST, documentation"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# Docker Remote API v1.24 |
| 8 | 17 |
|
| 9 | 18 |
# 1. Brief introduction |
| ... | ... |
@@ -793,7 +802,9 @@ Get `stdout` and `stderr` logs from the container ``id`` |
| 793 | 793 |
Connection: Upgrade |
| 794 | 794 |
Upgrade: tcp |
| 795 | 795 |
|
| 796 |
+ {% raw %}
|
|
| 796 | 797 |
{{ STREAM }}
|
| 798 |
+ {% endraw %}
|
|
| 797 | 799 |
|
| 798 | 800 |
**Query parameters**: |
| 799 | 801 |
|
| ... | ... |
@@ -871,7 +882,9 @@ Export the contents of container `id` |
| 871 | 871 |
HTTP/1.1 200 OK |
| 872 | 872 |
Content-Type: application/octet-stream |
| 873 | 873 |
|
| 874 |
+ {% raw %}
|
|
| 874 | 875 |
{{ TAR STREAM }}
|
| 876 |
+ {% endraw %}
|
|
| 875 | 877 |
|
| 876 | 878 |
**Status codes**: |
| 877 | 879 |
|
| ... | ... |
@@ -1257,7 +1270,9 @@ Attach to the container `id` |
| 1257 | 1257 |
Connection: Upgrade |
| 1258 | 1258 |
Upgrade: tcp |
| 1259 | 1259 |
|
| 1260 |
+ {% raw %}
|
|
| 1260 | 1261 |
{{ STREAM }}
|
| 1262 |
+ {% endraw %}
|
|
| 1261 | 1263 |
|
| 1262 | 1264 |
**Query parameters**: |
| 1263 | 1265 |
|
| ... | ... |
@@ -1341,7 +1356,9 @@ Implements websocket protocol handshake according to [RFC 6455](http://tools.iet |
| 1341 | 1341 |
|
| 1342 | 1342 |
**Example response** |
| 1343 | 1343 |
|
| 1344 |
+ {% raw %}
|
|
| 1344 | 1345 |
{{ STREAM }}
|
| 1346 |
+ {% endraw %}
|
|
| 1345 | 1347 |
|
| 1346 | 1348 |
**Query parameters**: |
| 1347 | 1349 |
|
| ... | ... |
@@ -1455,7 +1472,9 @@ Get a tar archive of a resource in the filesystem of container `id`. |
| 1455 | 1455 |
Content-Type: application/x-tar |
| 1456 | 1456 |
X-Docker-Container-Path-Stat: eyJuYW1lIjoicm9vdCIsInNpemUiOjQwOTYsIm1vZGUiOjIxNDc0ODQwOTYsIm10aW1lIjoiMjAxNC0wMi0yN1QyMDo1MToyM1oiLCJsaW5rVGFyZ2V0IjoiIn0= |
| 1457 | 1457 |
|
| 1458 |
+ {% raw %}
|
|
| 1458 | 1459 |
{{ TAR STREAM }}
|
| 1460 |
+ {% endraw %}
|
|
| 1459 | 1461 |
|
| 1460 | 1462 |
On success, a response header `X-Docker-Container-Path-Stat` will be set to a |
| 1461 | 1463 |
base64-encoded JSON object containing some filesystem header information about |
| ... | ... |
@@ -1510,7 +1529,9 @@ Upload a tar archive to be extracted to a path in the filesystem of container |
| 1510 | 1510 |
PUT /containers/8cce319429b2/archive?path=/vol1 HTTP/1.1 |
| 1511 | 1511 |
Content-Type: application/x-tar |
| 1512 | 1512 |
|
| 1513 |
+ {% raw %}
|
|
| 1513 | 1514 |
{{ TAR STREAM }}
|
| 1515 |
+ {% endraw %}
|
|
| 1514 | 1516 |
|
| 1515 | 1517 |
**Example response**: |
| 1516 | 1518 |
|
| ... | ... |
@@ -1638,7 +1659,9 @@ Build an image from a Dockerfile |
| 1638 | 1638 |
|
| 1639 | 1639 |
POST /build HTTP/1.1 |
| 1640 | 1640 |
|
| 1641 |
+ {% raw %}
|
|
| 1641 | 1642 |
{{ TAR STREAM }}
|
| 1643 |
+ {% endraw %}
|
|
| 1642 | 1644 |
|
| 1643 | 1645 |
**Example response**: |
| 1644 | 1646 |
|
| ... | ... |
@@ -2815,7 +2838,9 @@ interactive session with the `exec` command. |
| 2815 | 2815 |
HTTP/1.1 200 OK |
| 2816 | 2816 |
Content-Type: application/vnd.docker.raw-stream |
| 2817 | 2817 |
|
| 2818 |
+ {% raw %}
|
|
| 2818 | 2819 |
{{ STREAM }}
|
| 2820 |
+ {% endraw %}
|
|
| 2819 | 2821 |
|
| 2820 | 2822 |
**JSON parameters**: |
| 2821 | 2823 |
|
| ... | ... |
@@ -4,6 +4,15 @@ description: "API Documentation for Docker" |
| 4 | 4 |
keywords: ["API, Docker, rcli, REST, documentation"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# Docker Remote API v1.25 |
| 8 | 17 |
|
| 9 | 18 |
# 1. Brief introduction |
| ... | ... |
@@ -825,7 +834,9 @@ Get `stdout` and `stderr` logs from the container ``id`` |
| 825 | 825 |
Connection: Upgrade |
| 826 | 826 |
Upgrade: tcp |
| 827 | 827 |
|
| 828 |
+ {% raw %}
|
|
| 828 | 829 |
{{ STREAM }}
|
| 830 |
+ {% endraw %}
|
|
| 829 | 831 |
|
| 830 | 832 |
**Query parameters**: |
| 831 | 833 |
|
| ... | ... |
@@ -903,7 +914,9 @@ Export the contents of container `id` |
| 903 | 903 |
HTTP/1.1 200 OK |
| 904 | 904 |
Content-Type: application/octet-stream |
| 905 | 905 |
|
| 906 |
+ {% raw %}
|
|
| 906 | 907 |
{{ TAR STREAM }}
|
| 908 |
+ {% endraw %}
|
|
| 907 | 909 |
|
| 908 | 910 |
**Status codes**: |
| 909 | 911 |
|
| ... | ... |
@@ -1289,7 +1302,9 @@ Attach to the container `id` |
| 1289 | 1289 |
Connection: Upgrade |
| 1290 | 1290 |
Upgrade: tcp |
| 1291 | 1291 |
|
| 1292 |
+ {% raw %}
|
|
| 1292 | 1293 |
{{ STREAM }}
|
| 1294 |
+ {% endraw %}
|
|
| 1293 | 1295 |
|
| 1294 | 1296 |
**Query parameters**: |
| 1295 | 1297 |
|
| ... | ... |
@@ -1373,7 +1388,9 @@ Implements websocket protocol handshake according to [RFC 6455](http://tools.iet |
| 1373 | 1373 |
|
| 1374 | 1374 |
**Example response** |
| 1375 | 1375 |
|
| 1376 |
+ {% raw %}
|
|
| 1376 | 1377 |
{{ STREAM }}
|
| 1378 |
+ {% endraw %}
|
|
| 1377 | 1379 |
|
| 1378 | 1380 |
**Query parameters**: |
| 1379 | 1381 |
|
| ... | ... |
@@ -1487,7 +1504,9 @@ Get a tar archive of a resource in the filesystem of container `id`. |
| 1487 | 1487 |
Content-Type: application/x-tar |
| 1488 | 1488 |
X-Docker-Container-Path-Stat: eyJuYW1lIjoicm9vdCIsInNpemUiOjQwOTYsIm1vZGUiOjIxNDc0ODQwOTYsIm10aW1lIjoiMjAxNC0wMi0yN1QyMDo1MToyM1oiLCJsaW5rVGFyZ2V0IjoiIn0= |
| 1489 | 1489 |
|
| 1490 |
+ {% raw %}
|
|
| 1490 | 1491 |
{{ TAR STREAM }}
|
| 1492 |
+ {% endraw %}
|
|
| 1491 | 1493 |
|
| 1492 | 1494 |
On success, a response header `X-Docker-Container-Path-Stat` will be set to a |
| 1493 | 1495 |
base64-encoded JSON object containing some filesystem header information about |
| ... | ... |
@@ -1542,7 +1561,9 @@ Upload a tar archive to be extracted to a path in the filesystem of container |
| 1542 | 1542 |
PUT /containers/8cce319429b2/archive?path=/vol1 HTTP/1.1 |
| 1543 | 1543 |
Content-Type: application/x-tar |
| 1544 | 1544 |
|
| 1545 |
+ {% raw %}
|
|
| 1545 | 1546 |
{{ TAR STREAM }}
|
| 1547 |
+ {% endraw %}
|
|
| 1546 | 1548 |
|
| 1547 | 1549 |
**Example response**: |
| 1548 | 1550 |
|
| ... | ... |
@@ -1702,7 +1723,9 @@ Build an image from a Dockerfile |
| 1702 | 1702 |
|
| 1703 | 1703 |
POST /build HTTP/1.1 |
| 1704 | 1704 |
|
| 1705 |
+ {% raw %}
|
|
| 1705 | 1706 |
{{ TAR STREAM }}
|
| 1707 |
+ {% endraw %}
|
|
| 1706 | 1708 |
|
| 1707 | 1709 |
**Example response**: |
| 1708 | 1710 |
|
| ... | ... |
@@ -3217,7 +3240,9 @@ interactive session with the `exec` command. |
| 3217 | 3217 |
HTTP/1.1 200 OK |
| 3218 | 3218 |
Content-Type: application/vnd.docker.raw-stream |
| 3219 | 3219 |
|
| 3220 |
+ {% raw %}
|
|
| 3220 | 3221 |
{{ STREAM }}
|
| 3222 |
+ {% endraw %}
|
|
| 3221 | 3223 |
|
| 3222 | 3224 |
**JSON parameters**: |
| 3223 | 3225 |
|
| ... | ... |
@@ -5,6 +5,15 @@ description: "Documentation for docker Registry and Registry API" |
| 5 | 5 |
keywords: ["docker, registry, api, hub"] |
| 6 | 6 |
--- |
| 7 | 7 |
|
| 8 |
+<!-- This file is maintained within the docker/docker Github |
|
| 9 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 10 |
+ pull requests against that repo. If you see this file in |
|
| 11 |
+ another repository, consider it read-only there, as it will |
|
| 12 |
+ periodically be overwritten by the definitive file. Pull |
|
| 13 |
+ requests which include edits to this file in other repositories |
|
| 14 |
+ will be rejected. |
|
| 15 |
+--> |
|
| 16 |
+ |
|
| 8 | 17 |
# The Docker Hub and the Registry v1 |
| 9 | 18 |
|
| 10 | 19 |
This API is deprecated as of 1.7. To view the old version, see the [go |
| ... | ... |
@@ -5,6 +5,14 @@ keywords: ["Engine"] |
| 5 | 5 |
identifier: "engine_remoteapi" |
| 6 | 6 |
--- |
| 7 | 7 |
|
| 8 |
+<!-- This file is maintained within the docker/docker Github |
|
| 9 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 10 |
+ pull requests against that repo. If you see this file in |
|
| 11 |
+ another repository, consider it read-only there, as it will |
|
| 12 |
+ periodically be overwritten by the definitive file. Pull |
|
| 13 |
+ requests which include edits to this file in other repositories |
|
| 14 |
+ will be rejected. |
|
| 15 |
+--> |
|
| 8 | 16 |
|
| 9 | 17 |
# API Reference |
| 10 | 18 |
|
| ... | ... |
@@ -4,6 +4,15 @@ description: "Various client libraries available to use with the Docker remote A |
| 4 | 4 |
keywords: ["API, Docker, index, registry, REST, documentation, clients, C#, Erlang, Go, Groovy, Java, JavaScript, Perl, PHP, Python, Ruby, Rust, Scala"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# Docker Remote API client libraries |
| 8 | 17 |
|
| 9 | 18 |
These libraries make it easier to build applications on top of the Docker |
| ... | ... |
@@ -46,6 +55,11 @@ with the library maintainers. |
| 46 | 46 |
<td><a class="reference external" href="https://github.com/bwu-dart/bwu_docker">https://github.com/bwu-dart/bwu_docker</a></td> |
| 47 | 47 |
</tr> |
| 48 | 48 |
<tr> |
| 49 |
+ <td>Go</td> |
|
| 50 |
+ <td>Docker Go client</td> |
|
| 51 |
+ <td><a class="reference external" href="https://godoc.org/github.com/docker/docker/client">https://godoc.org/github.com/docker/docker/client</a></td> |
|
| 52 |
+ </tr> |
|
| 53 |
+ <tr> |
|
| 49 | 54 |
<td>Gradle</td> |
| 50 | 55 |
<td>gradle-docker-plugin</td> |
| 51 | 56 |
<td><a class="reference external" href="https://github.com/gesellix/gradle-docker-plugin">https://github.com/gesellix/gradle-docker-plugin</a></td> |
| ... | ... |
@@ -4,6 +4,15 @@ description: "Dockerfiles use a simple DSL which allows you to automate the step |
| 4 | 4 |
keywords: ["builder, docker, Dockerfile, automation, image creation"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# Dockerfile reference |
| 8 | 17 |
|
| 9 | 18 |
Docker can build images automatically by reading the instructions from a |
| ... | ... |
@@ -129,7 +138,7 @@ instruction must be \`FROM\`** in order to specify the [*Base |
| 129 | 129 |
Image*](glossary.md#base-image) from which you are building. |
| 130 | 130 |
|
| 131 | 131 |
Docker treats lines that *begin* with `#` as a comment, unless the line is |
| 132 |
-a valid [parser directive](builder.md#parser-directives). A `#` marker anywhere |
|
| 132 |
+a valid [parser directive](#parser-directives). A `#` marker anywhere |
|
| 133 | 133 |
else in a line is treated as an argument. This allows statements like: |
| 134 | 134 |
|
| 135 | 135 |
```Dockerfile |
| ... | ... |
@@ -1265,9 +1274,9 @@ The output of the final `pwd` command in this `Dockerfile` would be |
| 1265 | 1265 |
ARG <name>[=<default value>] |
| 1266 | 1266 |
|
| 1267 | 1267 |
The `ARG` instruction defines a variable that users can pass at build-time to |
| 1268 |
-the builder with the `docker build` command using the `--build-arg |
|
| 1269 |
-<varname>=<value>` flag. If a user specifies a build argument that was not |
|
| 1270 |
-defined in the Dockerfile, the build outputs an error. |
|
| 1268 |
+the builder with the `docker build` command using the |
|
| 1269 |
+`--build-arg <varname>=<value>` flag. If a user specifies a build argument |
|
| 1270 |
+that was not defined in the Dockerfile, the build outputs an error. |
|
| 1271 | 1271 |
|
| 1272 | 1272 |
``` |
| 1273 | 1273 |
One or more build-args were not consumed, failing build. |
| ... | ... |
@@ -1380,8 +1389,11 @@ corresponding `ARG` instruction in the Dockerfile. |
| 1380 | 1380 |
* `NO_PROXY` |
| 1381 | 1381 |
* `no_proxy` |
| 1382 | 1382 |
|
| 1383 |
-To use these, simply pass them on the command line using the `--build-arg |
|
| 1384 |
-<varname>=<value>` flag. |
|
| 1383 |
+To use these, simply pass them on the command line using the flag: |
|
| 1384 |
+ |
|
| 1385 |
+``` |
|
| 1386 |
+--build-arg <varname>=<value> |
|
| 1387 |
+``` |
|
| 1385 | 1388 |
|
| 1386 | 1389 |
### Impact on build caching |
| 1387 | 1390 |
|
| ... | ... |
@@ -4,6 +4,15 @@ description: "The attach command description and usage" |
| 4 | 4 |
keywords: ["attach, running, container"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# attach |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -38,13 +47,13 @@ the container. You can detach from a container and leave it running using the |
| 38 | 38 |
It is forbidden to redirect the standard input of a `docker attach` command |
| 39 | 39 |
while attaching to a tty-enabled container (i.e.: launched with `-t`). |
| 40 | 40 |
|
| 41 |
-While a client is connected to container's stdio using `docker attach`, Docker |
|
| 42 |
-uses a ~1MB memory buffer to maximize the throughput of the application. If |
|
| 43 |
-this buffer is filled, the speed of the API connection will start to have an |
|
| 44 |
-effect on the process output writing speed. This is similar to other |
|
| 45 |
-applications like SSH. Because of this, it is not recommended to run |
|
| 46 |
-performance critical applications that generate a lot of output in the |
|
| 47 |
-foreground over a slow client connection. Instead, users should use the |
|
| 41 |
+While a client is connected to container's stdio using `docker attach`, Docker |
|
| 42 |
+uses a ~1MB memory buffer to maximize the throughput of the application. If |
|
| 43 |
+this buffer is filled, the speed of the API connection will start to have an |
|
| 44 |
+effect on the process output writing speed. This is similar to other |
|
| 45 |
+applications like SSH. Because of this, it is not recommended to run |
|
| 46 |
+performance critical applications that generate a lot of output in the |
|
| 47 |
+foreground over a slow client connection. Instead, users should use the |
|
| 48 | 48 |
`docker logs` command to get access to the logs. |
| 49 | 49 |
|
| 50 | 50 |
|
| ... | ... |
@@ -4,6 +4,15 @@ description: "The build command description and usage" |
| 4 | 4 |
keywords: ["build, docker, image"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# build |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -397,9 +406,9 @@ For detailed information on using `ARG` and `ENV` instructions, see the |
| 397 | 397 |
|
| 398 | 398 |
### Optional security options (--security-opt) |
| 399 | 399 |
|
| 400 |
-This flag is only supported on a daemon running on Windows, and only supports |
|
| 400 |
+This flag is only supported on a daemon running on Windows, and only supports |
|
| 401 | 401 |
the `credentialspec` option. The `credentialspec` must be in the format |
| 402 |
-`file://spec.txt` or `registry://keyname`. |
|
| 402 |
+`file://spec.txt` or `registry://keyname`. |
|
| 403 | 403 |
|
| 404 | 404 |
### Specify isolation technology for container (--isolation) |
| 405 | 405 |
|
| ... | ... |
@@ -4,6 +4,15 @@ description: "Docker's CLI command description and usage" |
| 4 | 4 |
keywords: ["Docker, Docker documentation, CLI, command line"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# Use the Docker command line |
| 8 | 17 |
|
| 9 | 18 |
To list available commands, either run `docker` with no parameters |
| ... | ... |
@@ -147,6 +156,7 @@ list of supported formatting directives, see the |
| 147 | 147 |
|
| 148 | 148 |
Following is a sample `config.json` file: |
| 149 | 149 |
|
| 150 |
+ {% raw %}
|
|
| 150 | 151 |
{
|
| 151 | 152 |
"HttpHeaders": {
|
| 152 | 153 |
"MyHeader": "MyValue" |
| ... | ... |
@@ -156,6 +166,7 @@ Following is a sample `config.json` file: |
| 156 | 156 |
"serviceInspectFormat": "pretty", |
| 157 | 157 |
"detachKeys": "ctrl-e,e" |
| 158 | 158 |
} |
| 159 |
+ {% endraw %}
|
|
| 159 | 160 |
|
| 160 | 161 |
### Notary |
| 161 | 162 |
|
| ... | ... |
@@ -4,6 +4,15 @@ description: "The commit command description and usage" |
| 4 | 4 |
keywords: ["commit, file, changes"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# commit |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -51,6 +60,7 @@ created. Supported `Dockerfile` instructions: |
| 51 | 51 |
|
| 52 | 52 |
## Commit a container with new configurations |
| 53 | 53 |
|
| 54 |
+ {% raw %}
|
|
| 54 | 55 |
$ docker ps |
| 55 | 56 |
ID IMAGE COMMAND CREATED STATUS PORTS |
| 56 | 57 |
c3f279d17e0a ubuntu:12.04 /bin/bash 7 days ago Up 25 hours |
| ... | ... |
@@ -61,8 +71,9 @@ created. Supported `Dockerfile` instructions: |
| 61 | 61 |
f5283438590d |
| 62 | 62 |
$ docker inspect -f "{{ .Config.Env }}" f5283438590d
|
| 63 | 63 |
[HOME=/ PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin DEBUG=true] |
| 64 |
+ {% endraw %}
|
|
| 64 | 65 |
|
| 65 |
-## Commit a container with new `CMD` and `EXPOSE` instructions |
|
| 66 |
+## Commit a container with new `CMD` and `EXPOSE` instructions |
|
| 66 | 67 |
|
| 67 | 68 |
$ docker ps |
| 68 | 69 |
ID IMAGE COMMAND CREATED STATUS PORTS |
| ... | ... |
@@ -71,7 +82,7 @@ created. Supported `Dockerfile` instructions: |
| 71 | 71 |
|
| 72 | 72 |
$ docker commit --change='CMD ["apachectl", "-DFOREGROUND"]' -c "EXPOSE 80" c3f279d17e0a svendowideit/testimage:version4 |
| 73 | 73 |
f5283438590d |
| 74 |
- |
|
| 74 |
+ |
|
| 75 | 75 |
$ docker run -d svendowideit/testimage:version4 |
| 76 | 76 |
89373736e2e7f00bc149bd783073ac43d0507da250e999f3f1036e0db60817c0 |
| 77 | 77 |
|
| ... | ... |
@@ -4,6 +4,15 @@ description: "Remove all stopped containers" |
| 4 | 4 |
keywords: [container, prune, delete, remove] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# container prune |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -4,6 +4,15 @@ description: "The cp command description and usage" |
| 4 | 4 |
keywords: ["copy, container, files, folders"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# cp |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -29,7 +38,7 @@ either the `SRC_PATH` or `DEST_PATH`, you can also stream a tar archive from |
| 29 | 29 |
`STDIN` or to `STDOUT`. The `CONTAINER` can be a running or stopped container. |
| 30 | 30 |
The `SRC_PATH` or `DEST_PATH` can be a file or directory. |
| 31 | 31 |
|
| 32 |
-The `docker cp` command assumes container paths are relative to the container's |
|
| 32 |
+The `docker cp` command assumes container paths are relative to the container's |
|
| 33 | 33 |
`/` (root) directory. This means supplying the initial forward slash is optional; |
| 34 | 34 |
The command sees `compassionate_darwin:/tmp/foo/myfile.txt` and |
| 35 | 35 |
`compassionate_darwin:tmp/foo/myfile.txt` as identical. Local machine paths can |
| ... | ... |
@@ -74,7 +83,7 @@ argument of `DEST_PATH`, the behavior is as follows: |
| 74 | 74 |
|
| 75 | 75 |
The command requires `SRC_PATH` and `DEST_PATH` to exist according to the above |
| 76 | 76 |
rules. If `SRC_PATH` is local and is a symbolic link, the symbolic link, not |
| 77 |
-the target, is copied by default. To copy the link target and not the link, specify |
|
| 77 |
+the target, is copied by default. To copy the link target and not the link, specify |
|
| 78 | 78 |
the `-L` option. |
| 79 | 79 |
|
| 80 | 80 |
A colon (`:`) is used as a delimiter between `CONTAINER` and its path. You can |
| ... | ... |
@@ -4,6 +4,15 @@ description: "The create command description and usage" |
| 4 | 4 |
keywords: ["docker, create, container"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# create |
| 8 | 17 |
|
| 9 | 18 |
Creates a new container. |
| ... | ... |
@@ -167,7 +176,7 @@ Set storage driver options per container. |
| 167 | 167 |
|
| 168 | 168 |
$ docker create -it --storage-opt size=120G fedora /bin/bash |
| 169 | 169 |
|
| 170 |
-This (size) will allow to set the container rootfs size to 120G at creation time. |
|
| 170 |
+This (size) will allow to set the container rootfs size to 120G at creation time. |
|
| 171 | 171 |
This option is only available for the `devicemapper`, `btrfs`, `overlay2`, |
| 172 | 172 |
`windowsfilter` and `zfs` graph drivers. |
| 173 | 173 |
For the `devicemapper`, `btrfs`, `windowsfilter` and `zfs` graph drivers, |
| ... | ... |
@@ -5,6 +5,15 @@ keywords: ["stack, deploy"] |
| 5 | 5 |
advisory: "experimental" |
| 6 | 6 |
--- |
| 7 | 7 |
|
| 8 |
+<!-- This file is maintained within the docker/docker Github |
|
| 9 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 10 |
+ pull requests against that repo. If you see this file in |
|
| 11 |
+ another repository, consider it read-only there, as it will |
|
| 12 |
+ periodically be overwritten by the definitive file. Pull |
|
| 13 |
+ requests which include edits to this file in other repositories |
|
| 14 |
+ will be rejected. |
|
| 15 |
+--> |
|
| 16 |
+ |
|
| 8 | 17 |
# stack deploy (experimental) |
| 9 | 18 |
|
| 10 | 19 |
```markdown |
| ... | ... |
@@ -4,6 +4,15 @@ description: "The diff command description and usage" |
| 4 | 4 |
keywords: ["list, changed, files, container"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# diff |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -5,6 +5,15 @@ description: "The daemon command description and usage" |
| 5 | 5 |
keywords: ["container, daemon, runtime"] |
| 6 | 6 |
--- |
| 7 | 7 |
|
| 8 |
+<!-- This file is maintained within the docker/docker Github |
|
| 9 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 10 |
+ pull requests against that repo. If you see this file in |
|
| 11 |
+ another repository, consider it read-only there, as it will |
|
| 12 |
+ periodically be overwritten by the definitive file. Pull |
|
| 13 |
+ requests which include edits to this file in other repositories |
|
| 14 |
+ will be rejected. |
|
| 15 |
+--> |
|
| 16 |
+ |
|
| 8 | 17 |
# daemon |
| 9 | 18 |
|
| 10 | 19 |
```markdown |
| ... | ... |
@@ -279,7 +288,7 @@ options for `zfs` start with `zfs` and options for `btrfs` start with `btrfs`. |
| 279 | 279 |
|
| 280 | 280 |
#### Devicemapper options |
| 281 | 281 |
|
| 282 |
-* `dm.thinpooldev` |
|
| 282 |
+* `dm.thinpooldev` |
|
| 283 | 283 |
|
| 284 | 284 |
Specifies a custom block storage device to use for the thin pool. |
| 285 | 285 |
|
| ... | ... |
@@ -306,7 +315,7 @@ options for `zfs` start with `zfs` and options for `btrfs` start with `btrfs`. |
| 306 | 306 |
$ sudo dockerd --storage-opt dm.thinpooldev=/dev/mapper/thin-pool |
| 307 | 307 |
``` |
| 308 | 308 |
|
| 309 |
-* `dm.basesize` |
|
| 309 |
+* `dm.basesize` |
|
| 310 | 310 |
|
| 311 | 311 |
Specifies the size to use when creating the base device, which limits the |
| 312 | 312 |
size of images and containers. The default value is 10G. Note, thin devices |
| ... | ... |
@@ -324,7 +333,6 @@ options for `zfs` start with `zfs` and options for `btrfs` start with `btrfs`. |
| 324 | 324 |
$ sudo dockerd --storage-opt dm.basesize=50G |
| 325 | 325 |
``` |
| 326 | 326 |
|
| 327 |
- |
|
| 328 | 327 |
This will increase the base device size to 50G. The Docker daemon will throw an |
| 329 | 328 |
error if existing base device size is larger than 50G. A user can use |
| 330 | 329 |
this option to expand the base device size however shrinking is not permitted. |
| ... | ... |
@@ -345,7 +353,7 @@ options for `zfs` start with `zfs` and options for `btrfs` start with `btrfs`. |
| 345 | 345 |
$ sudo dockerd --storage-opt dm.basesize=20G |
| 346 | 346 |
``` |
| 347 | 347 |
|
| 348 |
-* `dm.loopdatasize` |
|
| 348 |
+* `dm.loopdatasize` |
|
| 349 | 349 |
|
| 350 | 350 |
> **Note**: |
| 351 | 351 |
> This option configures devicemapper loopback, which should not |
| ... | ... |
@@ -362,7 +370,7 @@ options for `zfs` start with `zfs` and options for `btrfs` start with `btrfs`. |
| 362 | 362 |
$ sudo dockerd --storage-opt dm.loopdatasize=200G |
| 363 | 363 |
``` |
| 364 | 364 |
|
| 365 |
-* `dm.loopmetadatasize` |
|
| 365 |
+* `dm.loopmetadatasize` |
|
| 366 | 366 |
|
| 367 | 367 |
> **Note**: |
| 368 | 368 |
> This option configures devicemapper loopback, which should not |
| ... | ... |
@@ -379,7 +387,7 @@ options for `zfs` start with `zfs` and options for `btrfs` start with `btrfs`. |
| 379 | 379 |
$ sudo dockerd --storage-opt dm.loopmetadatasize=4G |
| 380 | 380 |
``` |
| 381 | 381 |
|
| 382 |
-* `dm.fs` |
|
| 382 |
+* `dm.fs` |
|
| 383 | 383 |
|
| 384 | 384 |
Specifies the filesystem type to use for the base device. The supported |
| 385 | 385 |
options are "ext4" and "xfs". The default is "xfs" |
| ... | ... |
@@ -390,7 +398,7 @@ options for `zfs` start with `zfs` and options for `btrfs` start with `btrfs`. |
| 390 | 390 |
$ sudo dockerd --storage-opt dm.fs=ext4 |
| 391 | 391 |
``` |
| 392 | 392 |
|
| 393 |
-* `dm.mkfsarg` |
|
| 393 |
+* `dm.mkfsarg` |
|
| 394 | 394 |
|
| 395 | 395 |
Specifies extra mkfs arguments to be used when creating the base device. |
| 396 | 396 |
|
| ... | ... |
@@ -400,7 +408,7 @@ options for `zfs` start with `zfs` and options for `btrfs` start with `btrfs`. |
| 400 | 400 |
$ sudo dockerd --storage-opt "dm.mkfsarg=-O ^has_journal" |
| 401 | 401 |
``` |
| 402 | 402 |
|
| 403 |
-* `dm.mountopt` |
|
| 403 |
+* `dm.mountopt` |
|
| 404 | 404 |
|
| 405 | 405 |
Specifies extra mount options used when mounting the thin devices. |
| 406 | 406 |
|
| ... | ... |
@@ -410,7 +418,7 @@ options for `zfs` start with `zfs` and options for `btrfs` start with `btrfs`. |
| 410 | 410 |
$ sudo dockerd --storage-opt dm.mountopt=nodiscard |
| 411 | 411 |
``` |
| 412 | 412 |
|
| 413 |
-* `dm.datadev` |
|
| 413 |
+* `dm.datadev` |
|
| 414 | 414 |
|
| 415 | 415 |
(Deprecated, use `dm.thinpooldev`) |
| 416 | 416 |
|
| ... | ... |
@@ -428,7 +436,7 @@ options for `zfs` start with `zfs` and options for `btrfs` start with `btrfs`. |
| 428 | 428 |
--storage-opt dm.metadatadev=/dev/sdc1 |
| 429 | 429 |
``` |
| 430 | 430 |
|
| 431 |
-* `dm.metadatadev` |
|
| 431 |
+* `dm.metadatadev` |
|
| 432 | 432 |
|
| 433 | 433 |
(Deprecated, use `dm.thinpooldev`) |
| 434 | 434 |
|
| ... | ... |
@@ -452,7 +460,7 @@ options for `zfs` start with `zfs` and options for `btrfs` start with `btrfs`. |
| 452 | 452 |
--storage-opt dm.metadatadev=/dev/sdc1 |
| 453 | 453 |
``` |
| 454 | 454 |
|
| 455 |
-* `dm.blocksize` |
|
| 455 |
+* `dm.blocksize` |
|
| 456 | 456 |
|
| 457 | 457 |
Specifies a custom blocksize to use for the thin pool. The default |
| 458 | 458 |
blocksize is 64K. |
| ... | ... |
@@ -463,7 +471,7 @@ options for `zfs` start with `zfs` and options for `btrfs` start with `btrfs`. |
| 463 | 463 |
$ sudo dockerd --storage-opt dm.blocksize=512K |
| 464 | 464 |
``` |
| 465 | 465 |
|
| 466 |
-* `dm.blkdiscard` |
|
| 466 |
+* `dm.blkdiscard` |
|
| 467 | 467 |
|
| 468 | 468 |
Enables or disables the use of blkdiscard when removing devicemapper |
| 469 | 469 |
devices. This is enabled by default (only) if using loopback devices and is |
| ... | ... |
@@ -479,7 +487,7 @@ options for `zfs` start with `zfs` and options for `btrfs` start with `btrfs`. |
| 479 | 479 |
$ sudo dockerd --storage-opt dm.blkdiscard=false |
| 480 | 480 |
``` |
| 481 | 481 |
|
| 482 |
-* `dm.override_udev_sync_check` |
|
| 482 |
+* `dm.override_udev_sync_check` |
|
| 483 | 483 |
|
| 484 | 484 |
Overrides the `udev` synchronization checks between `devicemapper` and `udev`. |
| 485 | 485 |
`udev` is the device manager for the Linux kernel. |
| ... | ... |
@@ -519,7 +527,7 @@ options for `zfs` start with `zfs` and options for `btrfs` start with `btrfs`. |
| 519 | 519 |
> Otherwise, set this flag for migrating existing Docker daemons to |
| 520 | 520 |
> a daemon with a supported environment. |
| 521 | 521 |
|
| 522 |
-* `dm.use_deferred_removal` |
|
| 522 |
+* `dm.use_deferred_removal` |
|
| 523 | 523 |
|
| 524 | 524 |
Enables use of deferred device removal if `libdm` and the kernel driver |
| 525 | 525 |
support the mechanism. |
| ... | ... |
@@ -541,7 +549,7 @@ options for `zfs` start with `zfs` and options for `btrfs` start with `btrfs`. |
| 541 | 541 |
$ sudo dockerd --storage-opt dm.use_deferred_removal=true |
| 542 | 542 |
``` |
| 543 | 543 |
|
| 544 |
-* `dm.use_deferred_deletion` |
|
| 544 |
+* `dm.use_deferred_deletion` |
|
| 545 | 545 |
|
| 546 | 546 |
Enables use of deferred device deletion for thin pool devices. By default, |
| 547 | 547 |
thin pool device deletion is synchronous. Before a container is deleted, |
| ... | ... |
@@ -567,7 +575,7 @@ options for `zfs` start with `zfs` and options for `btrfs` start with `btrfs`. |
| 567 | 567 |
when unintentional leaking of mount point happens across multiple mount |
| 568 | 568 |
namespaces. |
| 569 | 569 |
|
| 570 |
-* `dm.min_free_space` |
|
| 570 |
+* `dm.min_free_space` |
|
| 571 | 571 |
|
| 572 | 572 |
Specifies the min free space percent in a thin pool require for new device |
| 573 | 573 |
creation to succeed. This check applies to both free data space as well |
| ... | ... |
@@ -615,7 +623,7 @@ options for `zfs` start with `zfs` and options for `btrfs` start with `btrfs`. |
| 615 | 615 |
|
| 616 | 616 |
#### ZFS options |
| 617 | 617 |
|
| 618 |
-* `zfs.fsname` |
|
| 618 |
+* `zfs.fsname` |
|
| 619 | 619 |
|
| 620 | 620 |
Set zfs filesystem under which docker will create its own datasets. |
| 621 | 621 |
By default docker will pick up the zfs filesystem where docker graph |
| ... | ... |
@@ -629,9 +637,9 @@ options for `zfs` start with `zfs` and options for `btrfs` start with `btrfs`. |
| 629 | 629 |
|
| 630 | 630 |
#### Btrfs options |
| 631 | 631 |
|
| 632 |
-* `btrfs.min_space` |
|
| 632 |
+* `btrfs.min_space` |
|
| 633 | 633 |
|
| 634 |
- Specifies the mininum size to use when creating the subvolume which is used |
|
| 634 |
+ Specifies the minimum size to use when creating the subvolume which is used |
|
| 635 | 635 |
for containers. If user uses disk quota for btrfs when creating or running |
| 636 | 636 |
a container with **--storage-opt size** option, docker should ensure the |
| 637 | 637 |
**size** cannot be smaller than **btrfs.min_space**. |
| ... | ... |
@@ -644,7 +652,7 @@ options for `zfs` start with `zfs` and options for `btrfs` start with `btrfs`. |
| 644 | 644 |
|
| 645 | 645 |
#### Overlay2 options |
| 646 | 646 |
|
| 647 |
-* `overlay2.override_kernel_check` |
|
| 647 |
+* `overlay2.override_kernel_check` |
|
| 648 | 648 |
|
| 649 | 649 |
Overrides the Linux kernel version check allowing overlay2. Support for |
| 650 | 650 |
specifying multiple lower directories needed by overlay2 was added to the |
| ... | ... |
@@ -672,19 +680,20 @@ Runtimes can be registered with the daemon either via the |
| 672 | 672 |
configuration file or using the `--add-runtime` command line argument. |
| 673 | 673 |
|
| 674 | 674 |
The following is an example adding 2 runtimes via the configuration: |
| 675 |
+ |
|
| 675 | 676 |
```json |
| 676 |
- "default-runtime": "runc", |
|
| 677 |
- "runtimes": {
|
|
| 678 |
- "runc": {
|
|
| 679 |
- "path": "runc" |
|
| 680 |
- }, |
|
| 681 |
- "custom": {
|
|
| 682 |
- "path": "/usr/local/bin/my-runc-replacement", |
|
| 683 |
- "runtimeArgs": [ |
|
| 684 |
- "--debug" |
|
| 685 |
- ] |
|
| 686 |
- } |
|
| 677 |
+"default-runtime": "runc", |
|
| 678 |
+"runtimes": {
|
|
| 679 |
+ "runc": {
|
|
| 680 |
+ "path": "runc" |
|
| 681 |
+ }, |
|
| 682 |
+ "custom": {
|
|
| 683 |
+ "path": "/usr/local/bin/my-runc-replacement", |
|
| 684 |
+ "runtimeArgs": [ |
|
| 685 |
+ "--debug" |
|
| 686 |
+ ] |
|
| 687 | 687 |
} |
| 688 |
+} |
|
| 688 | 689 |
``` |
| 689 | 690 |
|
| 690 | 691 |
This is the same example via the command line: |
| ... | ... |
@@ -844,35 +853,35 @@ $ sudo dockerd \ |
| 844 | 844 |
|
| 845 | 845 |
The currently supported cluster store options are: |
| 846 | 846 |
|
| 847 |
-* `discovery.heartbeat` |
|
| 847 |
+* `discovery.heartbeat` |
|
| 848 | 848 |
|
| 849 | 849 |
Specifies the heartbeat timer in seconds which is used by the daemon as a |
| 850 | 850 |
keepalive mechanism to make sure discovery module treats the node as alive |
| 851 | 851 |
in the cluster. If not configured, the default value is 20 seconds. |
| 852 | 852 |
|
| 853 |
-* `discovery.ttl` |
|
| 853 |
+* `discovery.ttl` |
|
| 854 | 854 |
|
| 855 | 855 |
Specifies the ttl (time-to-live) in seconds which is used by the discovery |
| 856 | 856 |
module to timeout a node if a valid heartbeat is not received within the |
| 857 | 857 |
configured ttl value. If not configured, the default value is 60 seconds. |
| 858 | 858 |
|
| 859 |
-* `kv.cacertfile` |
|
| 859 |
+* `kv.cacertfile` |
|
| 860 | 860 |
|
| 861 | 861 |
Specifies the path to a local file with PEM encoded CA certificates to trust |
| 862 | 862 |
|
| 863 |
-* `kv.certfile` |
|
| 863 |
+* `kv.certfile` |
|
| 864 | 864 |
|
| 865 | 865 |
Specifies the path to a local file with a PEM encoded certificate. This |
| 866 | 866 |
certificate is used as the client cert for communication with the |
| 867 | 867 |
Key/Value store. |
| 868 | 868 |
|
| 869 |
-* `kv.keyfile` |
|
| 869 |
+* `kv.keyfile` |
|
| 870 | 870 |
|
| 871 | 871 |
Specifies the path to a local file with a PEM encoded private key. This |
| 872 | 872 |
private key is used as the client key for communication with the |
| 873 | 873 |
Key/Value store. |
| 874 | 874 |
|
| 875 |
-* `kv.path` |
|
| 875 |
+* `kv.path` |
|
| 876 | 876 |
|
| 877 | 877 |
Specifies the path in the Key/Value store. If not configured, the default value is 'docker/nodes'. |
| 878 | 878 |
|
| ... | ... |
@@ -4,6 +4,15 @@ description: "The events command description and usage" |
| 4 | 4 |
keywords: ["events, container, report"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# events |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -4,6 +4,15 @@ description: "The exec command description and usage" |
| 4 | 4 |
keywords: ["command, container, run, execute"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# exec |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -4,6 +4,15 @@ description: "The export command description and usage" |
| 4 | 4 |
keywords: ["export, file, system, container"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# export |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -4,6 +4,15 @@ description: "The history command description and usage" |
| 4 | 4 |
keywords: ["docker, image, history"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# history |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -4,6 +4,15 @@ description: "Remove all stopped images" |
| 4 | 4 |
keywords: [image, prune, delete, remove] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# image prune |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -4,6 +4,15 @@ description: "The images command description and usage" |
| 4 | 4 |
keywords: ["list, docker, images"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# images |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -245,6 +254,7 @@ output the data exactly as the template declares or, when using the |
| 245 | 245 |
The following example uses a template without headers and outputs the |
| 246 | 246 |
`ID` and `Repository` entries separated by a colon for all images: |
| 247 | 247 |
|
| 248 |
+ {% raw %}
|
|
| 248 | 249 |
$ docker images --format "{{.ID}}: {{.Repository}}"
|
| 249 | 250 |
77af4d6b9913: <none> |
| 250 | 251 |
b6fa739cedf5: committ |
| ... | ... |
@@ -255,10 +265,12 @@ The following example uses a template without headers and outputs the |
| 255 | 255 |
746b819f315e: postgres |
| 256 | 256 |
746b819f315e: postgres |
| 257 | 257 |
746b819f315e: postgres |
| 258 |
+ {% endraw %}
|
|
| 258 | 259 |
|
| 259 | 260 |
To list all images with their repository and tag in a table format you |
| 260 | 261 |
can use: |
| 261 | 262 |
|
| 263 |
+ {% raw %}
|
|
| 262 | 264 |
$ docker images --format "table {{.ID}}\t{{.Repository}}\t{{.Tag}}"
|
| 263 | 265 |
IMAGE ID REPOSITORY TAG |
| 264 | 266 |
77af4d6b9913 <none> <none> |
| ... | ... |
@@ -270,3 +282,4 @@ can use: |
| 270 | 270 |
746b819f315e postgres 9.3 |
| 271 | 271 |
746b819f315e postgres 9.3.5 |
| 272 | 272 |
746b819f315e postgres latest |
| 273 |
+ {% endraw %}
|
| ... | ... |
@@ -4,6 +4,15 @@ description: "The import command description and usage" |
| 4 | 4 |
keywords: ["import, file, system, container"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# import |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -5,7 +5,14 @@ keywords: ["Docker, Docker documentation, CLI, command line"] |
| 5 | 5 |
identifier: "smn_cli_guide" |
| 6 | 6 |
--- |
| 7 | 7 |
|
| 8 |
- |
|
| 8 |
+<!-- This file is maintained within the docker/docker Github |
|
| 9 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 10 |
+ pull requests against that repo. If you see this file in |
|
| 11 |
+ another repository, consider it read-only there, as it will |
|
| 12 |
+ periodically be overwritten by the definitive file. Pull |
|
| 13 |
+ requests which include edits to this file in other repositories |
|
| 14 |
+ will be rejected. |
|
| 15 |
+--> |
|
| 9 | 16 |
|
| 10 | 17 |
# The Docker commands |
| 11 | 18 |
|
| ... | ... |
@@ -4,6 +4,15 @@ description: "The info command description and usage" |
| 4 | 4 |
keywords: ["display, docker, information"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# info |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -55,7 +64,7 @@ storage driver and a node that is part of a 2-node swarm: |
| 55 | 55 |
Plugins: |
| 56 | 56 |
Volume: local |
| 57 | 57 |
Network: bridge null host overlay |
| 58 |
- Swarm: |
|
| 58 |
+ Swarm: |
|
| 59 | 59 |
NodeID: 0gac67oclbxq7 |
| 60 | 60 |
Is Manager: true |
| 61 | 61 |
Managers: 2 |
| ... | ... |
@@ -182,4 +191,4 @@ Here is a sample output for a daemon running on Windows Server 2016: |
| 182 | 182 |
Registry: https://index.docker.io/v1/ |
| 183 | 183 |
Insecure Registries: |
| 184 | 184 |
127.0.0.0/8 |
| 185 |
- Live Restore Enabled: false |
|
| 186 | 185 |
\ No newline at end of file |
| 186 |
+ Live Restore Enabled: false |
| ... | ... |
@@ -4,6 +4,15 @@ description: "The inspect command description and usage" |
| 4 | 4 |
keywords: ["inspect, container, json"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# inspect |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -34,29 +43,39 @@ describes all the details of the format. |
| 34 | 34 |
For the most part, you can pick out any field from the JSON in a fairly |
| 35 | 35 |
straightforward manner. |
| 36 | 36 |
|
| 37 |
+ {% raw %}
|
|
| 37 | 38 |
$ docker inspect --format='{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' $INSTANCE_ID
|
| 39 |
+ {% endraw %}
|
|
| 38 | 40 |
|
| 39 | 41 |
**Get an instance's MAC address:** |
| 40 | 42 |
|
| 41 | 43 |
For the most part, you can pick out any field from the JSON in a fairly |
| 42 | 44 |
straightforward manner. |
| 43 | 45 |
|
| 46 |
+ {% raw %}
|
|
| 44 | 47 |
$ docker inspect --format='{{range .NetworkSettings.Networks}}{{.MacAddress}}{{end}}' $INSTANCE_ID
|
| 48 |
+ {% endraw %}
|
|
| 45 | 49 |
|
| 46 | 50 |
**Get an instance's log path:** |
| 47 | 51 |
|
| 52 |
+ {% raw %}
|
|
| 48 | 53 |
$ docker inspect --format='{{.LogPath}}' $INSTANCE_ID
|
| 54 |
+ {% endraw %}
|
|
| 49 | 55 |
|
| 50 | 56 |
**Get a Task's image name:** |
| 51 | 57 |
|
| 58 |
+ {% raw %}
|
|
| 52 | 59 |
$ docker inspect --format='{{.Container.Spec.Image}}' $INSTANCE_ID
|
| 60 |
+ {% endraw %}
|
|
| 53 | 61 |
|
| 54 | 62 |
**List all port bindings:** |
| 55 | 63 |
|
| 56 | 64 |
One can loop over arrays and maps in the results to produce simple text |
| 57 | 65 |
output: |
| 58 | 66 |
|
| 67 |
+ {% raw %}
|
|
| 59 | 68 |
$ docker inspect --format='{{range $p, $conf := .NetworkSettings.Ports}} {{$p}} -> {{(index $conf 0).HostPort}} {{end}}' $INSTANCE_ID
|
| 69 |
+ {% endraw %}
|
|
| 60 | 70 |
|
| 61 | 71 |
**Find a specific port mapping:** |
| 62 | 72 |
|
| ... | ... |
@@ -68,7 +87,9 @@ numeric public port, you use `index` to find the specific port map, and |
| 68 | 68 |
then `index` 0 contains the first object inside of that. Then we ask for |
| 69 | 69 |
the `HostPort` field to get the public address. |
| 70 | 70 |
|
| 71 |
+ {% raw %}
|
|
| 71 | 72 |
$ docker inspect --format='{{(index (index .NetworkSettings.Ports "8787/tcp") 0).HostPort}}' $INSTANCE_ID
|
| 73 |
+ {% endraw %}
|
|
| 72 | 74 |
|
| 73 | 75 |
**Get a subsection in JSON format:** |
| 74 | 76 |
|
| ... | ... |
@@ -77,4 +98,6 @@ fields, by default you get a Go-style dump of the inner values. |
| 77 | 77 |
Docker adds a template function, `json`, which can be applied to get |
| 78 | 78 |
results in JSON format. |
| 79 | 79 |
|
| 80 |
+ {% raw %}
|
|
| 80 | 81 |
$ docker inspect --format='{{json .Config}}' $INSTANCE_ID
|
| 82 |
+ {% endraw %}
|
| ... | ... |
@@ -4,6 +4,15 @@ description: "The kill command description and usage" |
| 4 | 4 |
keywords: ["container, kill, signal"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# kill |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -4,6 +4,15 @@ description: "The load command description and usage" |
| 4 | 4 |
keywords: ["stdin, tarred, repository"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# load |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -4,6 +4,15 @@ description: "The login command description and usage" |
| 4 | 4 |
keywords: ["registry, login, image"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# login |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -48,12 +57,12 @@ This is the list of currently available credentials helpers and where |
| 48 | 48 |
you can download them from: |
| 49 | 49 |
|
| 50 | 50 |
- D-Bus Secret Service: https://github.com/docker/docker-credential-helpers/releases |
| 51 |
-- Apple OS X keychain: https://github.com/docker/docker-credential-helpers/releases |
|
| 51 |
+- Apple macOS keychain: https://github.com/docker/docker-credential-helpers/releases |
|
| 52 | 52 |
- Microsoft Windows Credential Manager: https://github.com/docker/docker-credential-helpers/releases |
| 53 | 53 |
|
| 54 | 54 |
### Usage |
| 55 | 55 |
|
| 56 |
-You need to speficy the credentials store in `$HOME/.docker/config.json` |
|
| 56 |
+You need to specify the credentials store in `$HOME/.docker/config.json` |
|
| 57 | 57 |
to tell the docker engine to use it: |
| 58 | 58 |
|
| 59 | 59 |
```json |
| ... | ... |
@@ -4,6 +4,15 @@ description: "The logout command description and usage" |
| 4 | 4 |
keywords: ["logout, docker, registry"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# logout |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -4,6 +4,15 @@ description: "The logs command description and usage" |
| 4 | 4 |
keywords: ["logs, retrieve, docker"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# logs |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -5,7 +5,14 @@ keywords: ["Docker, Docker documentation, CLI, command line"] |
| 5 | 5 |
identifier: "smn_cli" |
| 6 | 6 |
--- |
| 7 | 7 |
|
| 8 |
- |
|
| 8 |
+<!-- This file is maintained within the docker/docker Github |
|
| 9 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 10 |
+ pull requests against that repo. If you see this file in |
|
| 11 |
+ another repository, consider it read-only there, as it will |
|
| 12 |
+ periodically be overwritten by the definitive file. Pull |
|
| 13 |
+ requests which include edits to this file in other repositories |
|
| 14 |
+ will be rejected. |
|
| 15 |
+--> |
|
| 9 | 16 |
|
| 10 | 17 |
# The Docker commands |
| 11 | 18 |
|
| ... | ... |
@@ -4,6 +4,15 @@ description: "The network connect command description and usage" |
| 4 | 4 |
keywords: ["network, connect, user-defined"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# network connect |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -4,6 +4,15 @@ description: "The network create command description and usage" |
| 4 | 4 |
keywords: ["network, create"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# network create |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -129,7 +138,7 @@ support it you can create multiple subnetworks. |
| 129 | 129 |
$ docker network create -d overlay \ |
| 130 | 130 |
--subnet=192.168.0.0/16 \ |
| 131 | 131 |
--subnet=192.170.0.0/16 \ |
| 132 |
- --gateway=192.168.0.100 \ |
|
| 132 |
+ --gateway=192.168.0.100 \ |
|
| 133 | 133 |
--gateway=192.170.0.100 \ |
| 134 | 134 |
--ip-range=192.168.1.0/24 \ |
| 135 | 135 |
--aux-address="my-router=192.168.1.5" --aux-address="my-switch=192.168.1.6" \ |
| ... | ... |
@@ -4,6 +4,15 @@ description: "The network disconnect command description and usage" |
| 4 | 4 |
keywords: ["network, disconnect, user-defined"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# network disconnect |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -4,6 +4,15 @@ description: "The network inspect command description and usage" |
| 4 | 4 |
keywords: ["network, inspect, user-defined"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# network inspect |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -4,6 +4,15 @@ description: "The network ls command description and usage" |
| 4 | 4 |
keywords: ["network, list, user-defined"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# docker network ls |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -175,7 +184,7 @@ Valid placeholders for the Go template are listed below: |
| 175 | 175 |
|
| 176 | 176 |
Placeholder | Description |
| 177 | 177 |
------------|------------------------------------------------------------------------------------------ |
| 178 |
-`.ID` | Network ID |
|
| 178 |
+`.ID` | Network ID |
|
| 179 | 179 |
`.Name` | Network name |
| 180 | 180 |
`.Driver` | Network driver |
| 181 | 181 |
`.Scope` | Network scope (local, global) |
| ... | ... |
@@ -4,6 +4,15 @@ description: "the network rm command description and usage" |
| 4 | 4 |
keywords: ["network, rm, user-defined"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# network rm |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -4,6 +4,15 @@ description: "The node demote command description and usage" |
| 4 | 4 |
keywords: ["node, demote"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# node demote |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -4,6 +4,15 @@ description: "The node inspect command description and usage" |
| 4 | 4 |
keywords: ["node, inspect"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# node inspect |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -89,8 +98,10 @@ Example output: |
| 89 | 89 |
} |
| 90 | 90 |
] |
| 91 | 91 |
|
| 92 |
+ {% raw %}
|
|
| 92 | 93 |
$ docker node inspect --format '{{ .ManagerStatus.Leader }}' self
|
| 93 | 94 |
false |
| 95 |
+ {% endraw %}
|
|
| 94 | 96 |
|
| 95 | 97 |
$ docker node inspect --pretty self |
| 96 | 98 |
ID: e216jshn25ckzbvmwlnh5jr3g |
| ... | ... |
@@ -4,6 +4,15 @@ description: "The node ls command description and usage" |
| 4 | 4 |
keywords: ["node, list"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# node ls |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -4,6 +4,15 @@ description: "The node promote command description and usage" |
| 4 | 4 |
keywords: ["node, promote"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# node promote |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -5,6 +5,15 @@ keywords: ["node, tasks", "ps"] |
| 5 | 5 |
aliases: ["/engine/reference/commandline/node_tasks/"] |
| 6 | 6 |
--- |
| 7 | 7 |
|
| 8 |
+<!-- This file is maintained within the docker/docker Github |
|
| 9 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 10 |
+ pull requests against that repo. If you see this file in |
|
| 11 |
+ another repository, consider it read-only there, as it will |
|
| 12 |
+ periodically be overwritten by the definitive file. Pull |
|
| 13 |
+ requests which include edits to this file in other repositories |
|
| 14 |
+ will be rejected. |
|
| 15 |
+--> |
|
| 16 |
+ |
|
| 8 | 17 |
# node ps |
| 9 | 18 |
|
| 10 | 19 |
```markdown |
| ... | ... |
@@ -4,6 +4,15 @@ description: "The node rm command description and usage" |
| 4 | 4 |
keywords: ["node, remove"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# node rm |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -4,6 +4,15 @@ description: "The node update command description and usage" |
| 4 | 4 |
keywords: ["resources, update, dynamically"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
## update |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -4,6 +4,15 @@ description: "The pause command description and usage" |
| 4 | 4 |
keywords: ["cgroups, container, suspend, SIGSTOP"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# pause |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -5,6 +5,15 @@ keywords: ["plugin, disable"] |
| 5 | 5 |
advisory: "experimental" |
| 6 | 6 |
--- |
| 7 | 7 |
|
| 8 |
+<!-- This file is maintained within the docker/docker Github |
|
| 9 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 10 |
+ pull requests against that repo. If you see this file in |
|
| 11 |
+ another repository, consider it read-only there, as it will |
|
| 12 |
+ periodically be overwritten by the definitive file. Pull |
|
| 13 |
+ requests which include edits to this file in other repositories |
|
| 14 |
+ will be rejected. |
|
| 15 |
+--> |
|
| 16 |
+ |
|
| 8 | 17 |
# plugin disable (experimental) |
| 9 | 18 |
|
| 10 | 19 |
```markdown |
| ... | ... |
@@ -5,6 +5,15 @@ keywords: ["plugin, enable"] |
| 5 | 5 |
advisory: "experimental" |
| 6 | 6 |
--- |
| 7 | 7 |
|
| 8 |
+<!-- This file is maintained within the docker/docker Github |
|
| 9 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 10 |
+ pull requests against that repo. If you see this file in |
|
| 11 |
+ another repository, consider it read-only there, as it will |
|
| 12 |
+ periodically be overwritten by the definitive file. Pull |
|
| 13 |
+ requests which include edits to this file in other repositories |
|
| 14 |
+ will be rejected. |
|
| 15 |
+--> |
|
| 16 |
+ |
|
| 8 | 17 |
# plugin enable (experimental) |
| 9 | 18 |
|
| 10 | 19 |
```markdown |
| ... | ... |
@@ -5,6 +5,15 @@ keywords: ["plugin, inspect"] |
| 5 | 5 |
advisory: "experimental" |
| 6 | 6 |
--- |
| 7 | 7 |
|
| 8 |
+<!-- This file is maintained within the docker/docker Github |
|
| 9 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 10 |
+ pull requests against that repo. If you see this file in |
|
| 11 |
+ another repository, consider it read-only there, as it will |
|
| 12 |
+ periodically be overwritten by the definitive file. Pull |
|
| 13 |
+ requests which include edits to this file in other repositories |
|
| 14 |
+ will be rejected. |
|
| 15 |
+--> |
|
| 16 |
+ |
|
| 8 | 17 |
# plugin inspect (experimental) |
| 9 | 18 |
|
| 10 | 19 |
```markdown |
| ... | ... |
@@ -5,6 +5,15 @@ keywords: ["plugin, install"] |
| 5 | 5 |
advisory: "experimental" |
| 6 | 6 |
--- |
| 7 | 7 |
|
| 8 |
+<!-- This file is maintained within the docker/docker Github |
|
| 9 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 10 |
+ pull requests against that repo. If you see this file in |
|
| 11 |
+ another repository, consider it read-only there, as it will |
|
| 12 |
+ periodically be overwritten by the definitive file. Pull |
|
| 13 |
+ requests which include edits to this file in other repositories |
|
| 14 |
+ will be rejected. |
|
| 15 |
+--> |
|
| 16 |
+ |
|
| 8 | 17 |
# plugin install (experimental) |
| 9 | 18 |
|
| 10 | 19 |
```markdown |
| ... | ... |
@@ -5,6 +5,15 @@ keywords: ["plugin, list"] |
| 5 | 5 |
advisory: "experimental" |
| 6 | 6 |
--- |
| 7 | 7 |
|
| 8 |
+<!-- This file is maintained within the docker/docker Github |
|
| 9 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 10 |
+ pull requests against that repo. If you see this file in |
|
| 11 |
+ another repository, consider it read-only there, as it will |
|
| 12 |
+ periodically be overwritten by the definitive file. Pull |
|
| 13 |
+ requests which include edits to this file in other repositories |
|
| 14 |
+ will be rejected. |
|
| 15 |
+--> |
|
| 16 |
+ |
|
| 8 | 17 |
# plugin ls (experimental) |
| 9 | 18 |
|
| 10 | 19 |
```markdown |
| ... | ... |
@@ -5,6 +5,15 @@ keywords: ["plugin, rm"] |
| 5 | 5 |
advisory: "experimental" |
| 6 | 6 |
--- |
| 7 | 7 |
|
| 8 |
+<!-- This file is maintained within the docker/docker Github |
|
| 9 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 10 |
+ pull requests against that repo. If you see this file in |
|
| 11 |
+ another repository, consider it read-only there, as it will |
|
| 12 |
+ periodically be overwritten by the definitive file. Pull |
|
| 13 |
+ requests which include edits to this file in other repositories |
|
| 14 |
+ will be rejected. |
|
| 15 |
+--> |
|
| 16 |
+ |
|
| 8 | 17 |
# plugin rm (experimental) |
| 9 | 18 |
|
| 10 | 19 |
```markdown |
| ... | ... |
@@ -4,6 +4,15 @@ description: "The port command description and usage" |
| 4 | 4 |
keywords: ["port, mapping, container"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# port |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -4,6 +4,15 @@ description: "The ps command description and usage" |
| 4 | 4 |
keywords: ["container, running, list"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# ps |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -145,6 +154,7 @@ $ docker ps -a --filter 'exited=137' |
| 145 | 145 |
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES |
| 146 | 146 |
b3e1c0ed5bfe ubuntu:latest "sleep 1000" 12 seconds ago Exited (137) 5 seconds ago grave_kowalevski |
| 147 | 147 |
a2eb5558d669 redis:latest "/entrypoint.sh redi 2 hours ago Exited (137) 2 hours ago sharp_lalande |
| 148 |
+``` |
|
| 148 | 149 |
|
| 149 | 150 |
Any of these events result in a `137` status: |
| 150 | 151 |
|
| ... | ... |
@@ -271,7 +281,7 @@ CONTAINER ID IMAGE COMMAND CREATED STATUS |
| 271 | 271 |
The `volume` filter shows only containers that mount a specific volume or have |
| 272 | 272 |
a volume mounted in a specific path: |
| 273 | 273 |
|
| 274 |
-```bash |
|
| 274 |
+```bash{% raw %}
|
|
| 275 | 275 |
$ docker ps --filter volume=remote-volume --format "table {{.ID}}\t{{.Mounts}}"
|
| 276 | 276 |
CONTAINER ID MOUNTS |
| 277 | 277 |
9c3527ed70ce remote-volume |
| ... | ... |
@@ -279,7 +289,7 @@ CONTAINER ID MOUNTS |
| 279 | 279 |
$ docker ps --filter volume=/data --format "table {{.ID}}\t{{.Mounts}}"
|
| 280 | 280 |
CONTAINER ID MOUNTS |
| 281 | 281 |
9c3527ed70ce remote-volume |
| 282 |
-``` |
|
| 282 |
+{% endraw %}```
|
|
| 283 | 283 |
|
| 284 | 284 |
#### Network |
| 285 | 285 |
|
| ... | ... |
@@ -304,7 +314,9 @@ example shows all containers that are attached to the `net1` network, using |
| 304 | 304 |
the network id as a filter; |
| 305 | 305 |
|
| 306 | 306 |
```bash |
| 307 |
+{% raw %}
|
|
| 307 | 308 |
$ docker network inspect --format "{{.ID}}" net1
|
| 309 |
+{% endraw %}
|
|
| 308 | 310 |
|
| 309 | 311 |
8c0b4110ae930dbe26b258de9bc34a03f98056ed6f27f991d32919bfe401d7c5 |
| 310 | 312 |
|
| ... | ... |
@@ -333,7 +345,7 @@ Placeholder | Description |
| 333 | 333 |
`.Size` | Container disk size. |
| 334 | 334 |
`.Names` | Container names. |
| 335 | 335 |
`.Labels` | All labels assigned to the container. |
| 336 |
-`.Label` | Value of a specific label for this container. For example `'{{.Label "com.docker.swarm.cpu"}}'`
|
|
| 336 |
+`.Label` | Value of a specific label for this container. For example `'{% raw %}{{.Label "com.docker.swarm.cpu"}}{% endraw %}'`
|
|
| 337 | 337 |
`.Mounts` | Names of the volumes mounted in this container. |
| 338 | 338 |
|
| 339 | 339 |
When using the `--format` option, the `ps` command will either output the data |
| ... | ... |
@@ -344,7 +356,9 @@ The following example uses a template without headers and outputs the `ID` and |
| 344 | 344 |
`Command` entries separated by a colon for all running containers: |
| 345 | 345 |
|
| 346 | 346 |
```bash |
| 347 |
+{% raw %}
|
|
| 347 | 348 |
$ docker ps --format "{{.ID}}: {{.Command}}"
|
| 349 |
+{% endraw %}
|
|
| 348 | 350 |
|
| 349 | 351 |
a87ecb4f327c: /bin/sh -c #(nop) MA |
| 350 | 352 |
01946d9d34d8: /bin/sh -c #(nop) MA |
| ... | ... |
@@ -355,7 +369,9 @@ c1d3b0166030: /bin/sh -c yum -y up |
| 355 | 355 |
To list all running containers with their labels in a table format you can use: |
| 356 | 356 |
|
| 357 | 357 |
```bash |
| 358 |
+{% raw %}
|
|
| 358 | 359 |
$ docker ps --format "table {{.ID}}\t{{.Labels}}"
|
| 360 |
+{% endraw %}
|
|
| 359 | 361 |
|
| 360 | 362 |
CONTAINER ID LABELS |
| 361 | 363 |
a87ecb4f327c com.docker.swarm.node=ubuntu,com.docker.swarm.storage=ssd |
| ... | ... |
@@ -4,6 +4,15 @@ description: "The pull command description and usage" |
| 4 | 4 |
keywords: ["pull, image, hub, docker"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# pull |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -131,7 +140,7 @@ above, the digest of the image is: |
| 131 | 131 |
Docker also prints the digest of an image when *pushing* to a registry. This |
| 132 | 132 |
may be useful if you want to pin to a version of the image you just pushed. |
| 133 | 133 |
|
| 134 |
-A digest takes the place of the tag when pulling an image, for example, to |
|
| 134 |
+A digest takes the place of the tag when pulling an image, for example, to |
|
| 135 | 135 |
pull the above image by digest, run the following command: |
| 136 | 136 |
|
| 137 | 137 |
```bash |
| ... | ... |
@@ -154,7 +163,7 @@ MAINTAINER some maintainer <maintainer@example.com> |
| 154 | 154 |
``` |
| 155 | 155 |
|
| 156 | 156 |
> **Note**: Using this feature "pins" an image to a specific version in time. |
| 157 |
-> Docker will therefore not pull updated versions of an image, which may include |
|
| 157 |
+> Docker will therefore not pull updated versions of an image, which may include |
|
| 158 | 158 |
> security updates. If you want to pull an updated image, you need to change the |
| 159 | 159 |
> digest accordingly. |
| 160 | 160 |
|
| ... | ... |
@@ -4,6 +4,15 @@ description: "The push command description and usage" |
| 4 | 4 |
keywords: ["share, push, image"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# push |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -4,6 +4,15 @@ description: "The rename command description and usage" |
| 4 | 4 |
keywords: ["rename, docker, container"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# rename |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -4,6 +4,15 @@ description: "The restart command description and usage" |
| 4 | 4 |
keywords: ["restart, container, Docker"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# restart |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -4,6 +4,15 @@ description: "The rm command description and usage" |
| 4 | 4 |
keywords: ["remove, Docker, container"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# rm |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -4,6 +4,15 @@ description: "The rmi command description and usage" |
| 4 | 4 |
keywords: ["remove, image, Docker"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# rmi |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -4,6 +4,15 @@ description: "The run command description and usage" |
| 4 | 4 |
keywords: ["run, command, container"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# run |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -618,8 +627,8 @@ or a signal name in the format SIGNAME, for instance SIGKILL. |
| 618 | 618 |
|
| 619 | 619 |
### Optional security options (--security-opt) |
| 620 | 620 |
|
| 621 |
-On Windows, this flag can be used to specify the `credentialspec` option. |
|
| 622 |
-The `credentialspec` must be in the format `file://spec.txt` or `registry://keyname`. |
|
| 621 |
+On Windows, this flag can be used to specify the `credentialspec` option. |
|
| 622 |
+The `credentialspec` must be in the format `file://spec.txt` or `registry://keyname`. |
|
| 623 | 623 |
|
| 624 | 624 |
### Stop container with timeout (--stop-timeout) |
| 625 | 625 |
|
| ... | ... |
@@ -673,7 +682,7 @@ network namespace, run this command: |
| 673 | 673 |
|
| 674 | 674 |
|
| 675 | 675 |
> **Note**: Not all sysctls are namespaced. Docker does not support changing sysctls |
| 676 |
-> inside of a container that also modify the host system. As the kernel |
|
| 676 |
+> inside of a container that also modify the host system. As the kernel |
|
| 677 | 677 |
> evolves we expect to see more sysctls become namespaced. |
| 678 | 678 |
|
| 679 | 679 |
#### Currently supported sysctls |
| ... | ... |
@@ -4,6 +4,15 @@ description: "The save command description and usage" |
| 4 | 4 |
keywords: ["tarred, repository, backup"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# save |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -4,6 +4,15 @@ description: "The search command description and usage" |
| 4 | 4 |
keywords: ["search, hub, images"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# search |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -76,7 +85,7 @@ at least 3 stars and the description isn't truncated in the output: |
| 76 | 76 |
|
| 77 | 77 |
## Limit search results (--limit) |
| 78 | 78 |
|
| 79 |
-The flag `--limit` is the maximium number of results returned by a search. This value could |
|
| 79 |
+The flag `--limit` is the maximum number of results returned by a search. This value could |
|
| 80 | 80 |
be in the range between 1 and 100. The default value of `--limit` is 25. |
| 81 | 81 |
|
| 82 | 82 |
|
| ... | ... |
@@ -4,6 +4,15 @@ description: "The service create command description and usage" |
| 4 | 4 |
keywords: ["service, create"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# service create |
| 8 | 17 |
|
| 9 | 18 |
```Markdown |
| ... | ... |
@@ -4,6 +4,15 @@ description: "The service inspect command description and usage" |
| 4 | 4 |
keywords: ["service, inspect"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# service inspect |
| 8 | 17 |
|
| 9 | 18 |
```Markdown |
| ... | ... |
@@ -136,10 +145,10 @@ The `--format` option can be used to obtain specific information about a |
| 136 | 136 |
service. For example, the following command outputs the number of replicas |
| 137 | 137 |
of the "redis" service. |
| 138 | 138 |
|
| 139 |
-```bash |
|
| 139 |
+```bash{% raw %}
|
|
| 140 | 140 |
$ docker service inspect --format='{{.Spec.Mode.Replicated.Replicas}}' redis
|
| 141 | 141 |
10 |
| 142 |
-``` |
|
| 142 |
+{% endraw %}```
|
|
| 143 | 143 |
|
| 144 | 144 |
|
| 145 | 145 |
## Related information |
| ... | ... |
@@ -4,6 +4,15 @@ description: "The service ls command description and usage" |
| 4 | 4 |
keywords: ["service, ls"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# service ls |
| 8 | 17 |
|
| 9 | 18 |
```Markdown |
| ... | ... |
@@ -5,6 +5,15 @@ keywords: ["service, tasks", "ps"] |
| 5 | 5 |
aliases: ["/engine/reference/commandline/service_tasks/"] |
| 6 | 6 |
--- |
| 7 | 7 |
|
| 8 |
+<!-- This file is maintained within the docker/docker Github |
|
| 9 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 10 |
+ pull requests against that repo. If you see this file in |
|
| 11 |
+ another repository, consider it read-only there, as it will |
|
| 12 |
+ periodically be overwritten by the definitive file. Pull |
|
| 13 |
+ requests which include edits to this file in other repositories |
|
| 14 |
+ will be rejected. |
|
| 15 |
+--> |
|
| 16 |
+ |
|
| 8 | 17 |
# service ps |
| 9 | 18 |
|
| 10 | 19 |
```Markdown |
| ... | ... |
@@ -4,6 +4,15 @@ description: "The service rm command description and usage" |
| 4 | 4 |
keywords: ["service, rm"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# service rm |
| 8 | 17 |
|
| 9 | 18 |
```Markdown |
| ... | ... |
@@ -4,6 +4,15 @@ description: "The service scale command description and usage" |
| 4 | 4 |
keywords: ["service, scale"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# service scale |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -19,8 +28,10 @@ Options: |
| 19 | 19 |
|
| 20 | 20 |
### Scale a service |
| 21 | 21 |
|
| 22 |
-If you scale a service, you set the *desired* number of replicas. Even though |
|
| 23 |
-the command returns directly, actual scaling of the service may take some time. |
|
| 22 |
+The scale command enables you to scale one or more services either up or down to |
|
| 23 |
+the desired number of replicas. The command will return immediately, but the |
|
| 24 |
+actual scaling of the service may take some time. To stop all replicas of a |
|
| 25 |
+service while keeping the service active in the swarm you can set the scale to 0. |
|
| 24 | 26 |
|
| 25 | 27 |
For example, the following command scales the "frontend" service to 50 tasks. |
| 26 | 28 |
|
| ... | ... |
@@ -30,7 +41,7 @@ frontend scaled to 50 |
| 30 | 30 |
``` |
| 31 | 31 |
|
| 32 | 32 |
Directly afterwards, run `docker service ls`, to see the actual number of |
| 33 |
-replicas |
|
| 33 |
+replicas. |
|
| 34 | 34 |
|
| 35 | 35 |
```bash |
| 36 | 36 |
$ docker service ls --filter name=frontend |
| ... | ... |
@@ -40,7 +51,7 @@ ID NAME REPLICAS IMAGE COMMAND |
| 40 | 40 |
``` |
| 41 | 41 |
|
| 42 | 42 |
You can also scale a service using the [`docker service update`](service_update.md) |
| 43 |
-command. The following commands are therefore equivalent: |
|
| 43 |
+command. The following commands are equivalent: |
|
| 44 | 44 |
|
| 45 | 45 |
```bash |
| 46 | 46 |
$ docker service scale frontend=50 |
| ... | ... |
@@ -4,6 +4,15 @@ description: "The service update command description and usage" |
| 4 | 4 |
keywords: ["service, update"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# service update |
| 8 | 17 |
|
| 9 | 18 |
```Markdown |
| ... | ... |
@@ -5,6 +5,15 @@ keywords: ["stack, config"] |
| 5 | 5 |
advisory: "experimental" |
| 6 | 6 |
--- |
| 7 | 7 |
|
| 8 |
+<!-- This file is maintained within the docker/docker Github |
|
| 9 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 10 |
+ pull requests against that repo. If you see this file in |
|
| 11 |
+ another repository, consider it read-only there, as it will |
|
| 12 |
+ periodically be overwritten by the definitive file. Pull |
|
| 13 |
+ requests which include edits to this file in other repositories |
|
| 14 |
+ will be rejected. |
|
| 15 |
+--> |
|
| 16 |
+ |
|
| 8 | 17 |
# stack config (experimental) |
| 9 | 18 |
|
| 10 | 19 |
```markdown |
| ... | ... |
@@ -5,6 +5,15 @@ keywords: ["stack, deploy, up"] |
| 5 | 5 |
advisory: "experimental" |
| 6 | 6 |
--- |
| 7 | 7 |
|
| 8 |
+<!-- This file is maintained within the docker/docker Github |
|
| 9 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 10 |
+ pull requests against that repo. If you see this file in |
|
| 11 |
+ another repository, consider it read-only there, as it will |
|
| 12 |
+ periodically be overwritten by the definitive file. Pull |
|
| 13 |
+ requests which include edits to this file in other repositories |
|
| 14 |
+ will be rejected. |
|
| 15 |
+--> |
|
| 16 |
+ |
|
| 8 | 17 |
# stack deploy (experimental) |
| 9 | 18 |
|
| 10 | 19 |
```markdown |
| ... | ... |
@@ -5,6 +5,15 @@ keywords: ["stack, ls"] |
| 5 | 5 |
advisory: "experimental" |
| 6 | 6 |
--- |
| 7 | 7 |
|
| 8 |
+<!-- This file is maintained within the docker/docker Github |
|
| 9 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 10 |
+ pull requests against that repo. If you see this file in |
|
| 11 |
+ another repository, consider it read-only there, as it will |
|
| 12 |
+ periodically be overwritten by the definitive file. Pull |
|
| 13 |
+ requests which include edits to this file in other repositories |
|
| 14 |
+ will be rejected. |
|
| 15 |
+--> |
|
| 16 |
+ |
|
| 8 | 17 |
# stack ls (experimental) |
| 9 | 18 |
|
| 10 | 19 |
```markdown |
| ... | ... |
@@ -5,6 +5,15 @@ keywords: ["stack, ps"] |
| 5 | 5 |
advisory: "experimental" |
| 6 | 6 |
--- |
| 7 | 7 |
|
| 8 |
+<!-- This file is maintained within the docker/docker Github |
|
| 9 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 10 |
+ pull requests against that repo. If you see this file in |
|
| 11 |
+ another repository, consider it read-only there, as it will |
|
| 12 |
+ periodically be overwritten by the definitive file. Pull |
|
| 13 |
+ requests which include edits to this file in other repositories |
|
| 14 |
+ will be rejected. |
|
| 15 |
+--> |
|
| 16 |
+ |
|
| 8 | 17 |
# stack ps (experimental) |
| 9 | 18 |
|
| 10 | 19 |
```markdown |
| ... | ... |
@@ -3,10 +3,17 @@ title: "stack rm" |
| 3 | 3 |
description: "The stack rm command description and usage" |
| 4 | 4 |
keywords: ["stack, rm, remove, down"] |
| 5 | 5 |
advisory: "experimental" |
| 6 |
- |
|
| 7 |
- |
|
| 8 | 6 |
--- |
| 9 | 7 |
|
| 8 |
+<!-- This file is maintained within the docker/docker Github |
|
| 9 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 10 |
+ pull requests against that repo. If you see this file in |
|
| 11 |
+ another repository, consider it read-only there, as it will |
|
| 12 |
+ periodically be overwritten by the definitive file. Pull |
|
| 13 |
+ requests which include edits to this file in other repositories |
|
| 14 |
+ will be rejected. |
|
| 15 |
+--> |
|
| 16 |
+ |
|
| 10 | 17 |
# stack rm (experimental) |
| 11 | 18 |
|
| 12 | 19 |
```markdown |
| ... | ... |
@@ -5,6 +5,15 @@ keywords: ["stack, services"] |
| 5 | 5 |
advisory: "experimental" |
| 6 | 6 |
--- |
| 7 | 7 |
|
| 8 |
+<!-- This file is maintained within the docker/docker Github |
|
| 9 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 10 |
+ pull requests against that repo. If you see this file in |
|
| 11 |
+ another repository, consider it read-only there, as it will |
|
| 12 |
+ periodically be overwritten by the definitive file. Pull |
|
| 13 |
+ requests which include edits to this file in other repositories |
|
| 14 |
+ will be rejected. |
|
| 15 |
+--> |
|
| 16 |
+ |
|
| 8 | 17 |
# stack services (experimental) |
| 9 | 18 |
|
| 10 | 19 |
```markdown |
| ... | ... |
@@ -4,6 +4,15 @@ description: "The start command description and usage" |
| 4 | 4 |
keywords: ["Start, container, stopped"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# start |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -4,6 +4,15 @@ description: "The stats command description and usage" |
| 4 | 4 |
keywords: ["container, resource, statistics"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# stats |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -4,6 +4,15 @@ description: "The stop command description and usage" |
| 4 | 4 |
keywords: ["stop, SIGKILL, SIGTERM"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# stop |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -4,6 +4,15 @@ description: "The swarm init command description and usage" |
| 4 | 4 |
keywords: ["swarm, init"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# swarm init |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -4,6 +4,15 @@ description: "The swarm join command description and usage" |
| 4 | 4 |
keywords: ["swarm, join"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# swarm join |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -4,6 +4,15 @@ description: "The swarm join-token command description and usage" |
| 4 | 4 |
keywords: ["swarm, join-token"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# swarm join-token |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -4,6 +4,15 @@ description: "The swarm leave command description and usage" |
| 4 | 4 |
keywords: ["swarm, leave"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# swarm leave |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -4,6 +4,15 @@ description: "The swarm update command description and usage" |
| 4 | 4 |
keywords: ["swarm, update"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# swarm update |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -4,6 +4,15 @@ description: "The system df command description and usage" |
| 4 | 4 |
keywords: [system, data, usage, disk] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# system df |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -4,6 +4,15 @@ description: "Remove unused data" |
| 4 | 4 |
keywords: [system, prune, delete, remove] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# system prune |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -4,6 +4,15 @@ description: "The tag command description and usage" |
| 4 | 4 |
keywords: ["tag, name, image"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# tag |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -4,6 +4,15 @@ description: "The top command description and usage" |
| 4 | 4 |
keywords: ["container, running, processes"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# top |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -4,6 +4,15 @@ description: "The unpause command description and usage" |
| 4 | 4 |
keywords: ["cgroups, suspend, container"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# unpause |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -4,6 +4,15 @@ description: "The update command description and usage" |
| 4 | 4 |
keywords: ["resources, update, dynamically"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
## update |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -4,6 +4,15 @@ description: "The version command description and usage" |
| 4 | 4 |
keywords: ["version, architecture, api"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# version |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -45,10 +54,14 @@ describes all the details of the format. |
| 45 | 45 |
|
| 46 | 46 |
**Get server version:** |
| 47 | 47 |
|
| 48 |
+ {% raw %}
|
|
| 48 | 49 |
$ docker version --format '{{.Server.Version}}'
|
| 49 | 50 |
1.8.0 |
| 51 |
+ {% endraw %}
|
|
| 50 | 52 |
|
| 51 | 53 |
**Dump raw data:** |
| 52 | 54 |
|
| 55 |
+ {% raw %}
|
|
| 53 | 56 |
$ docker version --format '{{json .}}'
|
| 54 | 57 |
{"Client":{"Version":"1.8.0","ApiVersion":"1.20","GitCommit":"f5bae0a","GoVersion":"go1.4.2","Os":"linux","Arch":"amd64","BuildTime":"Tue Jun 23 17:56:00 UTC 2015"},"ServerOK":true,"Server":{"Version":"1.8.0","ApiVersion":"1.20","GitCommit":"f5bae0a","GoVersion":"go1.4.2","Os":"linux","Arch":"amd64","KernelVersion":"3.13.2-gentoo","BuildTime":"Tue Jun 23 17:56:00 UTC 2015"}}
|
| 58 |
+ {% endraw %}
|
| ... | ... |
@@ -4,6 +4,15 @@ description: "The volume create command description and usage" |
| 4 | 4 |
keywords: ["volume, create"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# volume create |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -4,6 +4,15 @@ description: "The volume inspect command description and usage" |
| 4 | 4 |
keywords: ["volume, inspect"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# volume inspect |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -36,8 +45,10 @@ Example output: |
| 36 | 36 |
} |
| 37 | 37 |
] |
| 38 | 38 |
|
| 39 |
+ {% raw %}
|
|
| 39 | 40 |
$ docker volume inspect --format '{{ .Mountpoint }}' 85bffb0677236974f93955d8ecc4df55ef5070117b0e53333cc1b443777be24d
|
| 40 | 41 |
/var/lib/docker/volumes/85bffb0677236974f93955d8ecc4df55ef5070117b0e53333cc1b443777be24d/_data |
| 42 |
+ {% endraw %}
|
|
| 41 | 43 |
|
| 42 | 44 |
## Related information |
| 43 | 45 |
|
| ... | ... |
@@ -4,6 +4,15 @@ description: "The volume ls command description and usage" |
| 4 | 4 |
keywords: ["volume, list"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# volume ls |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -4,6 +4,15 @@ description: "Remove unused volumes" |
| 4 | 4 |
keywords: [volume, prune, delete] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# volume prune |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -4,6 +4,14 @@ description: "the volume rm command description and usage" |
| 4 | 4 |
keywords: ["volume, rm"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 7 | 15 |
|
| 8 | 16 |
# volume rm |
| 9 | 17 |
|
| ... | ... |
@@ -4,6 +4,15 @@ description: "The wait command description and usage" |
| 4 | 4 |
keywords: ["container, stop, wait"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# wait |
| 8 | 17 |
|
| 9 | 18 |
```markdown |
| ... | ... |
@@ -4,6 +4,15 @@ description: "Glossary of terms used around Docker" |
| 4 | 4 |
keywords: ["glossary, docker, terms, definitions"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# Glossary |
| 8 | 17 |
|
| 9 | 18 |
A list of terms used around the Docker project. |
| ... | ... |
@@ -110,7 +119,7 @@ Examples : |
| 110 | 110 |
|
| 111 | 111 |
- Linux : ext4, aufs, btrfs, zfs |
| 112 | 112 |
- Windows : NTFS |
| 113 |
-- OS X : HFS+ |
|
| 113 |
+- macOS : HFS+ |
|
| 114 | 114 |
|
| 115 | 115 |
## image |
| 116 | 116 |
|
| ... | ... |
@@ -4,6 +4,15 @@ description: "Docker Engine reference" |
| 4 | 4 |
keywords: ["Engine"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# Engine reference |
| 8 | 17 |
|
| 9 | 18 |
* [Dockerfile reference](builder.md) |
| ... | ... |
@@ -4,6 +4,15 @@ description: "Configure containers at runtime" |
| 4 | 4 |
keywords: ["docker, run, configure, runtime"] |
| 5 | 5 |
--- |
| 6 | 6 |
|
| 7 |
+<!-- This file is maintained within the docker/docker Github |
|
| 8 |
+ repository at https://github.com/docker/docker/. Make all |
|
| 9 |
+ pull requests against that repo. If you see this file in |
|
| 10 |
+ another repository, consider it read-only there, as it will |
|
| 11 |
+ periodically be overwritten by the definitive file. Pull |
|
| 12 |
+ requests which include edits to this file in other repositories |
|
| 13 |
+ will be rejected. |
|
| 14 |
+--> |
|
| 15 |
+ |
|
| 7 | 16 |
# Docker run reference |
| 8 | 17 |
|
| 9 | 18 |
Docker runs processes in isolated containers. A container is a process |
| ... | ... |
@@ -415,7 +424,7 @@ running the `redis-cli` command and connecting to the Redis server over the |
| 415 | 415 |
You can create a network using a Docker network driver or an external network |
| 416 | 416 |
driver plugin. You can connect multiple containers to the same network. Once |
| 417 | 417 |
connected to a user-defined network, the containers can communicate easily using |
| 418 |
-only another container's IP address or name. |
|
| 418 |
+only another container's IP address or name. |
|
| 419 | 419 |
|
| 420 | 420 |
For `overlay` networks or custom plugins that support multi-host connectivity, |
| 421 | 421 |
containers connected to the same multi-host network but launched from different |
| ... | ... |
@@ -532,13 +541,17 @@ will try forever to restart the container. The number of (attempted) restarts |
| 532 | 532 |
for a container can be obtained via [`docker inspect`](commandline/inspect.md). For example, to get the number of restarts |
| 533 | 533 |
for container "my-container"; |
| 534 | 534 |
|
| 535 |
+ {% raw %}
|
|
| 535 | 536 |
$ docker inspect -f "{{ .RestartCount }}" my-container
|
| 536 | 537 |
# 2 |
| 538 |
+ {% endraw %}
|
|
| 537 | 539 |
|
| 538 | 540 |
Or, to get the last time the container was (re)started; |
| 539 | 541 |
|
| 542 |
+ {% raw %}
|
|
| 540 | 543 |
$ docker inspect -f "{{ .State.StartedAt }}" my-container
|
| 541 | 544 |
# 2015-03-04T23:47:07.691840179Z |
| 545 |
+ {% endraw %}
|
|
| 542 | 546 |
|
| 543 | 547 |
|
| 544 | 548 |
Combining `--restart` (restart policy) with the `--rm` (clean up) flag results |
| ... | ... |
@@ -1369,34 +1382,12 @@ it will provide a named alias for the container being linked to. |
| 1369 | 1369 |
When a new container is created, Docker will set the following environment |
| 1370 | 1370 |
variables automatically: |
| 1371 | 1371 |
|
| 1372 |
-<table> |
|
| 1373 |
- <tr> |
|
| 1374 |
- <th>Variable</th> |
|
| 1375 |
- <th>Value</th> |
|
| 1376 |
- </tr> |
|
| 1377 |
- <tr> |
|
| 1378 |
- <td><code>HOME</code></td> |
|
| 1379 |
- <td> |
|
| 1380 |
- Set based on the value of <code>USER</code> |
|
| 1381 |
- </td> |
|
| 1382 |
- </tr> |
|
| 1383 |
- <tr> |
|
| 1384 |
- <td><code>HOSTNAME</code></td> |
|
| 1385 |
- <td> |
|
| 1386 |
- The hostname associated with the container |
|
| 1387 |
- </td> |
|
| 1388 |
- </tr> |
|
| 1389 |
- <tr> |
|
| 1390 |
- <td><code>PATH</code></td> |
|
| 1391 |
- <td> |
|
| 1392 |
- Includes popular directories, such as :<br> |
|
| 1393 |
- <code>/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin</code> |
|
| 1394 |
- </td> |
|
| 1395 |
- <tr> |
|
| 1396 |
- <td><code>TERM</code></td> |
|
| 1397 |
- <td><code>xterm</code> if the container is allocated a pseudo-TTY</td> |
|
| 1398 |
- </tr> |
|
| 1399 |
-</table> |
|
| 1372 |
+| Variable | Value | |
|
| 1373 |
+| -------- | ----- | |
|
| 1374 |
+| `HOME` | Set based on the value of `USER` | |
|
| 1375 |
+| `HOSTNAME` | The hostname associated with the container | |
|
| 1376 |
+| `PATH` | Includes popular directories, such as `:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin` | |
|
| 1377 |
+| `TERM` | `xterm` if the container is allocated a pseudo-TTY | |
|
| 1400 | 1378 |
|
| 1401 | 1379 |
Additionally, the operator can **set any environment variable** in the |
| 1402 | 1380 |
container by using one or more `-e` flags, even overriding those mentioned |
| ... | ... |
@@ -1425,6 +1416,7 @@ Similarly the operator can set the **hostname** with `-h`. |
| 1425 | 1425 |
|
| 1426 | 1426 |
Example: |
| 1427 | 1427 |
|
| 1428 |
+ {% raw %}
|
|
| 1428 | 1429 |
$ docker run --name=test -d \ |
| 1429 | 1430 |
--health-cmd='stat /etc/passwd || exit 1' \ |
| 1430 | 1431 |
--health-interval=2s \ |
| ... | ... |
@@ -1469,6 +1461,7 @@ Example: |
| 1469 | 1469 |
} |
| 1470 | 1470 |
] |
| 1471 | 1471 |
} |
| 1472 |
+ {% endraw %}
|
|
| 1472 | 1473 |
|
| 1473 | 1474 |
The health status is also displayed in the `docker ps` output. |
| 1474 | 1475 |
|