From 10be60a80f68aa179edb04ca8f019fc173bb619d Mon Sep 17 00:00:00 2001 From: Misty Stanley-Jones Date: Thu, 13 Apr 2017 18:58:56 -0700 Subject: [PATCH] Go back to small /edge (#2736) * Go back to small /edge * Update site front page Add info about Editions Reorganize components Update headings * Move logic of fetching content to a script * Add v1.28 API * Add info about versioned API --- Dockerfile | 108 +-- _config-edge.yml | 173 ----- _config.yml | 1 - _data/docsarchive/archives.yaml | 3 - _data/toc.yaml | 343 ++++++++- _includes/cli.md | 3 + _includes/edge_only.md | 19 + _includes/treebuilder.html | 5 - _scripts/fetch-upstream-resources.sh | 43 ++ edge/engine/reference/commandline/README.md | 29 + edge/engine/reference/commandline/attach.md | 18 + edge/engine/reference/commandline/build.md | 16 + .../reference/commandline/checkpoint.md | 16 + .../commandline/checkpoint_create.md | 16 + .../reference/commandline/checkpoint_ls.md | 16 + .../reference/commandline/checkpoint_rm.md | 16 + edge/engine/reference/commandline/commit.md | 16 + .../engine/reference/commandline/container.md | 18 + .../reference/commandline/container_attach.md | 18 + .../reference/commandline/container_commit.md | 18 + .../reference/commandline/container_cp.md | 18 + .../reference/commandline/container_create.md | 18 + .../reference/commandline/container_diff.md | 18 + .../reference/commandline/container_exec.md | 18 + .../reference/commandline/container_export.md | 18 + .../commandline/container_inspect.md | 18 + .../reference/commandline/container_kill.md | 18 + .../reference/commandline/container_logs.md | 18 + .../reference/commandline/container_ls.md | 18 + .../reference/commandline/container_pause.md | 18 + .../reference/commandline/container_port.md | 18 + .../reference/commandline/container_prune.md | 18 + .../reference/commandline/container_rename.md | 18 + .../commandline/container_restart.md | 18 + .../reference/commandline/container_rm.md | 18 + .../reference/commandline/container_run.md | 18 + .../reference/commandline/container_start.md | 18 + .../reference/commandline/container_stats.md | 18 + .../reference/commandline/container_stop.md | 18 + .../reference/commandline/container_top.md | 18 + .../commandline/container_unpause.md | 18 + .../reference/commandline/container_update.md | 18 + .../reference/commandline/container_wait.md | 18 + edge/engine/reference/commandline/cp.md | 16 + edge/engine/reference/commandline/create.md | 16 + edge/engine/reference/commandline/deploy.md | 16 + edge/engine/reference/commandline/diff.md | 16 + edge/engine/reference/commandline/docker.md | 20 + edge/engine/reference/commandline/dockerd.md | 24 + edge/engine/reference/commandline/events.md | 16 + edge/engine/reference/commandline/exec.md | 16 + edge/engine/reference/commandline/export.md | 16 + edge/engine/reference/commandline/history.md | 16 + edge/engine/reference/commandline/image.md | 18 + .../reference/commandline/image_build.md | 18 + .../reference/commandline/image_history.md | 18 + .../reference/commandline/image_import.md | 18 + .../reference/commandline/image_inspect.md | 18 + .../reference/commandline/image_load.md | 18 + edge/engine/reference/commandline/image_ls.md | 18 + .../reference/commandline/image_prune.md | 18 + .../reference/commandline/image_pull.md | 19 + .../reference/commandline/image_push.md | 18 + edge/engine/reference/commandline/image_rm.md | 18 + .../reference/commandline/image_save.md | 18 + .../engine/reference/commandline/image_tag.md | 18 + edge/engine/reference/commandline/images.md | 16 + edge/engine/reference/commandline/import.md | 16 + edge/engine/reference/commandline/info.md | 16 + edge/engine/reference/commandline/inspect.md | 16 + edge/engine/reference/commandline/kill.md | 16 + edge/engine/reference/commandline/load.md | 16 + edge/engine/reference/commandline/login.md | 16 + edge/engine/reference/commandline/logout.md | 16 + edge/engine/reference/commandline/logs.md | 16 + edge/engine/reference/commandline/network.md | 16 + .../reference/commandline/network_connect.md | 16 + .../reference/commandline/network_create.md | 16 + .../commandline/network_disconnect.md | 16 + .../reference/commandline/network_inspect.md | 16 + .../reference/commandline/network_ls.md | 16 + .../reference/commandline/network_prune.md | 16 + .../reference/commandline/network_rm.md | 16 + edge/engine/reference/commandline/node.md | 16 + .../reference/commandline/node_demote.md | 16 + .../reference/commandline/node_inspect.md | 16 + edge/engine/reference/commandline/node_ls.md | 16 + .../reference/commandline/node_promote.md | 16 + edge/engine/reference/commandline/node_ps.md | 16 + edge/engine/reference/commandline/node_rm.md | 16 + .../reference/commandline/node_update.md | 16 + edge/engine/reference/commandline/pause.md | 16 + edge/engine/reference/commandline/plugin.md | 16 + .../reference/commandline/plugin_create.md | 16 + .../reference/commandline/plugin_disable.md | 16 + .../reference/commandline/plugin_enable.md | 16 + .../reference/commandline/plugin_inspect.md | 16 + .../reference/commandline/plugin_install.md | 16 + .../engine/reference/commandline/plugin_ls.md | 16 + .../reference/commandline/plugin_push.md | 16 + .../engine/reference/commandline/plugin_rm.md | 16 + .../reference/commandline/plugin_set.md | 16 + .../reference/commandline/plugin_upgrade.md | 16 + edge/engine/reference/commandline/port.md | 16 + edge/engine/reference/commandline/ps.md | 16 + edge/engine/reference/commandline/pull.md | 16 + edge/engine/reference/commandline/push.md | 16 + edge/engine/reference/commandline/rename.md | 16 + edge/engine/reference/commandline/restart.md | 16 + edge/engine/reference/commandline/rm.md | 16 + edge/engine/reference/commandline/rmi.md | 16 + edge/engine/reference/commandline/run.md | 16 + edge/engine/reference/commandline/save.md | 16 + edge/engine/reference/commandline/search.md | 16 + edge/engine/reference/commandline/secret.md | 16 + .../reference/commandline/secret_create.md | 16 + .../reference/commandline/secret_inspect.md | 16 + .../engine/reference/commandline/secret_ls.md | 16 + .../engine/reference/commandline/secret_rm.md | 16 + edge/engine/reference/commandline/service.md | 18 + .../reference/commandline/service_create.md | 16 + .../reference/commandline/service_inspect.md | 16 + .../reference/commandline/service_logs.md | 18 + .../reference/commandline/service_ls.md | 16 + .../reference/commandline/service_ps.md | 18 + .../reference/commandline/service_rm.md | 18 + .../reference/commandline/service_scale.md | 18 + .../reference/commandline/service_update.md | 18 + edge/engine/reference/commandline/stack.md | 18 + .../reference/commandline/stack_deploy.md | 18 + edge/engine/reference/commandline/stack_ls.md | 18 + edge/engine/reference/commandline/stack_ps.md | 20 + edge/engine/reference/commandline/stack_rm.md | 18 + .../reference/commandline/stack_services.md | 18 + edge/engine/reference/commandline/start.md | 18 + edge/engine/reference/commandline/stats.md | 18 + edge/engine/reference/commandline/stop.md | 18 + edge/engine/reference/commandline/swarm.md | 18 + .../reference/commandline/swarm_init.md | 18 + .../reference/commandline/swarm_join-token.md | 20 + .../reference/commandline/swarm_join.md | 18 + .../reference/commandline/swarm_leave.md | 18 + .../reference/commandline/swarm_unlock-key.md | 18 + .../reference/commandline/swarm_unlock.md | 18 + .../reference/commandline/swarm_update.md | 18 + edge/engine/reference/commandline/system.md | 18 + .../engine/reference/commandline/system_df.md | 18 + .../reference/commandline/system_events.md | 18 + .../reference/commandline/system_info.md | 18 + .../reference/commandline/system_prune.md | 18 + edge/engine/reference/commandline/tag.md | 18 + edge/engine/reference/commandline/top.md | 18 + edge/engine/reference/commandline/unpause.md | 18 + edge/engine/reference/commandline/update.md | 18 + edge/engine/reference/commandline/version.md | 18 + edge/engine/reference/commandline/volume.md | 18 + .../reference/commandline/volume_create.md | 18 + .../reference/commandline/volume_inspect.md | 18 + .../engine/reference/commandline/volume_ls.md | 18 + .../reference/commandline/volume_prune.md | 18 + .../engine/reference/commandline/volume_rm.md | 18 + edge/engine/reference/commandline/wait.md | 18 + edge/index.md | 189 +++++ engine/admin/logging/awslogs.md | 4 +- engine/admin/logging/overview.md | 5 +- engine/api/get-started.md | 698 ++++++++++++++++++ engine/api/getting-started.md | 547 -------------- engine/api/index.md | 47 +- engine/api/v1.28/index.html | 37 + engine/api/v1.28/redoc.1.11.0.min.js | 44 ++ engine/reference/commandline/attach.md | 9 +- engine/reference/commandline/build.md | 9 +- engine/reference/commandline/checkpoint.md | 9 +- .../commandline/checkpoint_create.md | 9 +- engine/reference/commandline/checkpoint_ls.md | 9 +- engine/reference/commandline/checkpoint_rm.md | 9 +- engine/reference/commandline/commit.md | 9 +- engine/reference/commandline/container.md | 9 +- .../reference/commandline/container_attach.md | 9 +- .../reference/commandline/container_commit.md | 9 +- engine/reference/commandline/container_cp.md | 9 +- .../reference/commandline/container_create.md | 9 +- .../reference/commandline/container_diff.md | 9 +- .../reference/commandline/container_exec.md | 9 +- .../reference/commandline/container_export.md | 9 +- .../commandline/container_inspect.md | 9 +- .../reference/commandline/container_kill.md | 9 +- .../reference/commandline/container_logs.md | 9 +- engine/reference/commandline/container_ls.md | 9 +- .../reference/commandline/container_pause.md | 9 +- .../reference/commandline/container_port.md | 9 +- .../reference/commandline/container_prune.md | 9 +- .../reference/commandline/container_rename.md | 9 +- .../commandline/container_restart.md | 9 +- engine/reference/commandline/container_rm.md | 9 +- engine/reference/commandline/container_run.md | 9 +- .../reference/commandline/container_start.md | 9 +- .../reference/commandline/container_stats.md | 9 +- .../reference/commandline/container_stop.md | 9 +- engine/reference/commandline/container_top.md | 9 +- .../commandline/container_unpause.md | 9 +- .../reference/commandline/container_update.md | 9 +- .../reference/commandline/container_wait.md | 9 +- engine/reference/commandline/cp.md | 9 +- engine/reference/commandline/create.md | 9 +- engine/reference/commandline/deploy.md | 9 +- engine/reference/commandline/diff.md | 9 +- engine/reference/commandline/docker.md | 9 +- engine/reference/commandline/dockerd.md | 9 +- engine/reference/commandline/events.md | 9 +- engine/reference/commandline/exec.md | 9 +- engine/reference/commandline/export.md | 9 +- engine/reference/commandline/history.md | 9 +- engine/reference/commandline/image.md | 9 +- engine/reference/commandline/image_build.md | 9 +- engine/reference/commandline/image_history.md | 9 +- engine/reference/commandline/image_import.md | 9 +- engine/reference/commandline/image_inspect.md | 9 +- engine/reference/commandline/image_load.md | 9 +- engine/reference/commandline/image_ls.md | 9 +- engine/reference/commandline/image_prune.md | 9 +- engine/reference/commandline/image_pull.md | 9 +- engine/reference/commandline/image_push.md | 9 +- engine/reference/commandline/image_rm.md | 9 +- engine/reference/commandline/image_save.md | 9 +- engine/reference/commandline/image_tag.md | 9 +- engine/reference/commandline/images.md | 9 +- engine/reference/commandline/import.md | 9 +- engine/reference/commandline/info.md | 9 +- engine/reference/commandline/inspect.md | 9 +- engine/reference/commandline/kill.md | 9 +- engine/reference/commandline/load.md | 9 +- engine/reference/commandline/login.md | 9 +- engine/reference/commandline/logout.md | 9 +- engine/reference/commandline/logs.md | 9 +- engine/reference/commandline/network.md | 9 +- .../reference/commandline/network_connect.md | 9 +- .../reference/commandline/network_create.md | 9 +- .../commandline/network_disconnect.md | 9 +- .../reference/commandline/network_inspect.md | 9 +- engine/reference/commandline/network_ls.md | 9 +- engine/reference/commandline/network_prune.md | 9 +- engine/reference/commandline/network_rm.md | 9 +- engine/reference/commandline/node.md | 9 +- engine/reference/commandline/node_demote.md | 9 +- engine/reference/commandline/node_inspect.md | 9 +- engine/reference/commandline/node_ls.md | 9 +- engine/reference/commandline/node_promote.md | 9 +- engine/reference/commandline/node_ps.md | 9 +- engine/reference/commandline/node_rm.md | 9 +- engine/reference/commandline/node_update.md | 9 +- engine/reference/commandline/pause.md | 9 +- engine/reference/commandline/plugin.md | 9 +- engine/reference/commandline/plugin_create.md | 9 +- .../reference/commandline/plugin_disable.md | 9 +- engine/reference/commandline/plugin_enable.md | 9 +- .../reference/commandline/plugin_inspect.md | 9 +- .../reference/commandline/plugin_install.md | 9 +- engine/reference/commandline/plugin_ls.md | 9 +- engine/reference/commandline/plugin_push.md | 9 +- engine/reference/commandline/plugin_rm.md | 9 +- engine/reference/commandline/plugin_set.md | 9 +- .../reference/commandline/plugin_upgrade.md | 9 +- engine/reference/commandline/port.md | 9 +- engine/reference/commandline/ps.md | 9 +- engine/reference/commandline/pull.md | 9 +- engine/reference/commandline/push.md | 9 +- engine/reference/commandline/rename.md | 9 +- engine/reference/commandline/restart.md | 9 +- engine/reference/commandline/rm.md | 9 +- engine/reference/commandline/rmi.md | 9 +- engine/reference/commandline/run.md | 9 +- engine/reference/commandline/save.md | 9 +- engine/reference/commandline/search.md | 9 +- engine/reference/commandline/secret.md | 9 +- engine/reference/commandline/secret_create.md | 9 +- .../reference/commandline/secret_inspect.md | 9 +- engine/reference/commandline/secret_ls.md | 9 +- engine/reference/commandline/secret_rm.md | 9 +- engine/reference/commandline/service.md | 9 +- .../reference/commandline/service_create.md | 9 +- .../reference/commandline/service_inspect.md | 9 +- engine/reference/commandline/service_logs.md | 9 +- engine/reference/commandline/service_ls.md | 9 +- engine/reference/commandline/service_ps.md | 9 +- engine/reference/commandline/service_rm.md | 9 +- engine/reference/commandline/service_scale.md | 9 +- .../reference/commandline/service_update.md | 9 +- engine/reference/commandline/stack.md | 9 +- engine/reference/commandline/stack_deploy.md | 9 +- engine/reference/commandline/stack_ls.md | 9 +- engine/reference/commandline/stack_ps.md | 9 +- engine/reference/commandline/stack_rm.md | 9 +- .../reference/commandline/stack_services.md | 9 +- engine/reference/commandline/start.md | 9 +- engine/reference/commandline/stats.md | 9 +- engine/reference/commandline/stop.md | 9 +- engine/reference/commandline/swarm.md | 9 +- engine/reference/commandline/swarm_init.md | 9 +- .../reference/commandline/swarm_join-token.md | 9 +- engine/reference/commandline/swarm_join.md | 9 +- engine/reference/commandline/swarm_leave.md | 9 +- .../reference/commandline/swarm_unlock-key.md | 9 +- engine/reference/commandline/swarm_unlock.md | 9 +- engine/reference/commandline/swarm_update.md | 9 +- engine/reference/commandline/system.md | 9 +- engine/reference/commandline/system_df.md | 9 +- engine/reference/commandline/system_events.md | 9 +- engine/reference/commandline/system_info.md | 9 +- engine/reference/commandline/system_prune.md | 9 +- engine/reference/commandline/tag.md | 9 +- engine/reference/commandline/top.md | 9 +- engine/reference/commandline/unpause.md | 9 +- engine/reference/commandline/update.md | 9 +- engine/reference/commandline/version.md | 9 +- engine/reference/commandline/volume.md | 9 +- engine/reference/commandline/volume_create.md | 9 +- .../reference/commandline/volume_inspect.md | 9 +- engine/reference/commandline/volume_ls.md | 9 +- engine/reference/commandline/volume_prune.md | 9 +- engine/reference/commandline/volume_rm.md | 9 +- engine/reference/commandline/wait.md | 9 +- engine/swarm/services.md | 4 +- index.md | 312 +++----- 324 files changed, 4610 insertions(+), 1981 deletions(-) delete mode 100644 _config-edge.yml create mode 100644 _includes/edge_only.md create mode 100755 _scripts/fetch-upstream-resources.sh create mode 100644 edge/engine/reference/commandline/README.md create mode 100644 edge/engine/reference/commandline/attach.md create mode 100644 edge/engine/reference/commandline/build.md create mode 100644 edge/engine/reference/commandline/checkpoint.md create mode 100644 edge/engine/reference/commandline/checkpoint_create.md create mode 100644 edge/engine/reference/commandline/checkpoint_ls.md create mode 100644 edge/engine/reference/commandline/checkpoint_rm.md create mode 100644 edge/engine/reference/commandline/commit.md create mode 100644 edge/engine/reference/commandline/container.md create mode 100644 edge/engine/reference/commandline/container_attach.md create mode 100644 edge/engine/reference/commandline/container_commit.md create mode 100644 edge/engine/reference/commandline/container_cp.md create mode 100644 edge/engine/reference/commandline/container_create.md create mode 100644 edge/engine/reference/commandline/container_diff.md create mode 100644 edge/engine/reference/commandline/container_exec.md create mode 100644 edge/engine/reference/commandline/container_export.md create mode 100644 edge/engine/reference/commandline/container_inspect.md create mode 100644 edge/engine/reference/commandline/container_kill.md create mode 100644 edge/engine/reference/commandline/container_logs.md create mode 100644 edge/engine/reference/commandline/container_ls.md create mode 100644 edge/engine/reference/commandline/container_pause.md create mode 100644 edge/engine/reference/commandline/container_port.md create mode 100644 edge/engine/reference/commandline/container_prune.md create mode 100644 edge/engine/reference/commandline/container_rename.md create mode 100644 edge/engine/reference/commandline/container_restart.md create mode 100644 edge/engine/reference/commandline/container_rm.md create mode 100644 edge/engine/reference/commandline/container_run.md create mode 100644 edge/engine/reference/commandline/container_start.md create mode 100644 edge/engine/reference/commandline/container_stats.md create mode 100644 edge/engine/reference/commandline/container_stop.md create mode 100644 edge/engine/reference/commandline/container_top.md create mode 100644 edge/engine/reference/commandline/container_unpause.md create mode 100644 edge/engine/reference/commandline/container_update.md create mode 100644 edge/engine/reference/commandline/container_wait.md create mode 100644 edge/engine/reference/commandline/cp.md create mode 100644 edge/engine/reference/commandline/create.md create mode 100644 edge/engine/reference/commandline/deploy.md create mode 100644 edge/engine/reference/commandline/diff.md create mode 100644 edge/engine/reference/commandline/docker.md create mode 100644 edge/engine/reference/commandline/dockerd.md create mode 100644 edge/engine/reference/commandline/events.md create mode 100644 edge/engine/reference/commandline/exec.md create mode 100644 edge/engine/reference/commandline/export.md create mode 100644 edge/engine/reference/commandline/history.md create mode 100644 edge/engine/reference/commandline/image.md create mode 100644 edge/engine/reference/commandline/image_build.md create mode 100644 edge/engine/reference/commandline/image_history.md create mode 100644 edge/engine/reference/commandline/image_import.md create mode 100644 edge/engine/reference/commandline/image_inspect.md create mode 100644 edge/engine/reference/commandline/image_load.md create mode 100644 edge/engine/reference/commandline/image_ls.md create mode 100644 edge/engine/reference/commandline/image_prune.md create mode 100644 edge/engine/reference/commandline/image_pull.md create mode 100644 edge/engine/reference/commandline/image_push.md create mode 100644 edge/engine/reference/commandline/image_rm.md create mode 100644 edge/engine/reference/commandline/image_save.md create mode 100644 edge/engine/reference/commandline/image_tag.md create mode 100644 edge/engine/reference/commandline/images.md create mode 100644 edge/engine/reference/commandline/import.md create mode 100644 edge/engine/reference/commandline/info.md create mode 100644 edge/engine/reference/commandline/inspect.md create mode 100644 edge/engine/reference/commandline/kill.md create mode 100644 edge/engine/reference/commandline/load.md create mode 100644 edge/engine/reference/commandline/login.md create mode 100644 edge/engine/reference/commandline/logout.md create mode 100644 edge/engine/reference/commandline/logs.md create mode 100644 edge/engine/reference/commandline/network.md create mode 100644 edge/engine/reference/commandline/network_connect.md create mode 100644 edge/engine/reference/commandline/network_create.md create mode 100644 edge/engine/reference/commandline/network_disconnect.md create mode 100644 edge/engine/reference/commandline/network_inspect.md create mode 100644 edge/engine/reference/commandline/network_ls.md create mode 100644 edge/engine/reference/commandline/network_prune.md create mode 100644 edge/engine/reference/commandline/network_rm.md create mode 100644 edge/engine/reference/commandline/node.md create mode 100644 edge/engine/reference/commandline/node_demote.md create mode 100644 edge/engine/reference/commandline/node_inspect.md create mode 100644 edge/engine/reference/commandline/node_ls.md create mode 100644 edge/engine/reference/commandline/node_promote.md create mode 100644 edge/engine/reference/commandline/node_ps.md create mode 100644 edge/engine/reference/commandline/node_rm.md create mode 100644 edge/engine/reference/commandline/node_update.md create mode 100644 edge/engine/reference/commandline/pause.md create mode 100644 edge/engine/reference/commandline/plugin.md create mode 100644 edge/engine/reference/commandline/plugin_create.md create mode 100644 edge/engine/reference/commandline/plugin_disable.md create mode 100644 edge/engine/reference/commandline/plugin_enable.md create mode 100644 edge/engine/reference/commandline/plugin_inspect.md create mode 100644 edge/engine/reference/commandline/plugin_install.md create mode 100644 edge/engine/reference/commandline/plugin_ls.md create mode 100644 edge/engine/reference/commandline/plugin_push.md create mode 100644 edge/engine/reference/commandline/plugin_rm.md create mode 100644 edge/engine/reference/commandline/plugin_set.md create mode 100644 edge/engine/reference/commandline/plugin_upgrade.md create mode 100644 edge/engine/reference/commandline/port.md create mode 100644 edge/engine/reference/commandline/ps.md create mode 100644 edge/engine/reference/commandline/pull.md create mode 100644 edge/engine/reference/commandline/push.md create mode 100644 edge/engine/reference/commandline/rename.md create mode 100644 edge/engine/reference/commandline/restart.md create mode 100644 edge/engine/reference/commandline/rm.md create mode 100644 edge/engine/reference/commandline/rmi.md create mode 100644 edge/engine/reference/commandline/run.md create mode 100644 edge/engine/reference/commandline/save.md create mode 100644 edge/engine/reference/commandline/search.md create mode 100644 edge/engine/reference/commandline/secret.md create mode 100644 edge/engine/reference/commandline/secret_create.md create mode 100644 edge/engine/reference/commandline/secret_inspect.md create mode 100644 edge/engine/reference/commandline/secret_ls.md create mode 100644 edge/engine/reference/commandline/secret_rm.md create mode 100644 edge/engine/reference/commandline/service.md create mode 100644 edge/engine/reference/commandline/service_create.md create mode 100644 edge/engine/reference/commandline/service_inspect.md create mode 100644 edge/engine/reference/commandline/service_logs.md create mode 100644 edge/engine/reference/commandline/service_ls.md create mode 100644 edge/engine/reference/commandline/service_ps.md create mode 100644 edge/engine/reference/commandline/service_rm.md create mode 100644 edge/engine/reference/commandline/service_scale.md create mode 100644 edge/engine/reference/commandline/service_update.md create mode 100644 edge/engine/reference/commandline/stack.md create mode 100644 edge/engine/reference/commandline/stack_deploy.md create mode 100644 edge/engine/reference/commandline/stack_ls.md create mode 100644 edge/engine/reference/commandline/stack_ps.md create mode 100644 edge/engine/reference/commandline/stack_rm.md create mode 100644 edge/engine/reference/commandline/stack_services.md create mode 100644 edge/engine/reference/commandline/start.md create mode 100644 edge/engine/reference/commandline/stats.md create mode 100644 edge/engine/reference/commandline/stop.md create mode 100644 edge/engine/reference/commandline/swarm.md create mode 100644 edge/engine/reference/commandline/swarm_init.md create mode 100644 edge/engine/reference/commandline/swarm_join-token.md create mode 100644 edge/engine/reference/commandline/swarm_join.md create mode 100644 edge/engine/reference/commandline/swarm_leave.md create mode 100644 edge/engine/reference/commandline/swarm_unlock-key.md create mode 100644 edge/engine/reference/commandline/swarm_unlock.md create mode 100644 edge/engine/reference/commandline/swarm_update.md create mode 100644 edge/engine/reference/commandline/system.md create mode 100644 edge/engine/reference/commandline/system_df.md create mode 100644 edge/engine/reference/commandline/system_events.md create mode 100644 edge/engine/reference/commandline/system_info.md create mode 100644 edge/engine/reference/commandline/system_prune.md create mode 100644 edge/engine/reference/commandline/tag.md create mode 100644 edge/engine/reference/commandline/top.md create mode 100644 edge/engine/reference/commandline/unpause.md create mode 100644 edge/engine/reference/commandline/update.md create mode 100644 edge/engine/reference/commandline/version.md create mode 100644 edge/engine/reference/commandline/volume.md create mode 100644 edge/engine/reference/commandline/volume_create.md create mode 100644 edge/engine/reference/commandline/volume_inspect.md create mode 100644 edge/engine/reference/commandline/volume_ls.md create mode 100644 edge/engine/reference/commandline/volume_prune.md create mode 100644 edge/engine/reference/commandline/volume_rm.md create mode 100644 edge/engine/reference/commandline/wait.md create mode 100644 edge/index.md create mode 100644 engine/api/get-started.md delete mode 100644 engine/api/getting-started.md create mode 100644 engine/api/v1.28/index.html create mode 100755 engine/api/v1.28/redoc.1.11.0.min.js diff --git a/Dockerfile b/Dockerfile index bbdaf6c4f2a..4080248bd0a 100644 --- a/Dockerfile +++ b/Dockerfile @@ -18,115 +18,17 @@ COPY . md_source ## Branch to pull from, per ref doc ## To get master from svn the svn branch needs to be 'trunk'. To get a branch from svn it needs to be 'branches/branchname' + +# Engine ENV ENGINE_SVN_BRANCH="branches/17.03.x" ENV ENGINE_BRANCH="17.03.x" + +# Distribution ENV DISTRIBUTION_SVN_BRANCH="branches/release/2.6" ENV DISTRIBUTION_BRANCH="release/2.6" -RUN svn co https://github.com/docker/docker/$ENGINE_SVN_BRANCH/docs/extend md_source/engine/extend \ - && wget -O md_source/engine/api/v1.18.md https://raw.githubusercontent.com/docker/docker/$ENGINE_BRANCH/docs/api/v1.18.md \ - && wget -O md_source/engine/api/v1.19.md https://raw.githubusercontent.com/docker/docker/$ENGINE_BRANCH/docs/api/v1.19.md \ - && wget -O md_source/engine/api/v1.20.md https://raw.githubusercontent.com/docker/docker/$ENGINE_BRANCH/docs/api/v1.20.md \ - && wget -O md_source/engine/api/v1.21.md https://raw.githubusercontent.com/docker/docker/$ENGINE_BRANCH/docs/api/v1.21.md \ - && wget -O md_source/engine/api/v1.22.md https://raw.githubusercontent.com/docker/docker/$ENGINE_BRANCH/docs/api/v1.22.md \ - && wget -O md_source/engine/api/v1.23.md https://raw.githubusercontent.com/docker/docker/$ENGINE_BRANCH/docs/api/v1.23.md \ - && wget -O md_source/engine/api/v1.24.md https://raw.githubusercontent.com/docker/docker/$ENGINE_BRANCH/docs/api/v1.24.md \ - && wget -O md_source/engine/api/version-history.md https://raw.githubusercontent.com/docker/docker/$ENGINE_BRANCH/docs/api/version-history.md \ - && wget -O md_source/engine/reference/glossary.md https://raw.githubusercontent.com/docker/docker/$ENGINE_BRANCH/docs/reference/glossary.md \ - && wget -O md_source/engine/reference/builder.md https://raw.githubusercontent.com/docker/docker/$ENGINE_BRANCH/docs/reference/builder.md \ - && wget -O md_source/engine/reference/run.md https://raw.githubusercontent.com/docker/docker/$ENGINE_BRANCH/docs/reference/run.md \ - && wget -O md_source/engine/reference/commandline/cli.md https://raw.githubusercontent.com/docker/docker/$ENGINE_BRANCH/docs/reference/commandline/cli.md \ - && wget -O md_source/engine/deprecated.md https://raw.githubusercontent.com/docker/docker/$ENGINE_BRANCH/docs/deprecated.md \ - && svn co https://github.com/docker/distribution/$DISTRIBUTION_SVN_BRANCH/docs/spec md_source/registry/spec \ - && rm md_source/registry/spec/api.md.tmpl \ - && wget -O md_source/registry/configuration.md https://raw.githubusercontent.com/docker/distribution/$DISTRIBUTION_BRANCH/docs/configuration.md \ - && rm -rf md_source/apidocs/cloud-api-source \ - && rm -rf md_source/tests \ - && wget -O md_source/engine/api/v1.25/swagger.yaml https://raw.githubusercontent.com/docker/docker/v1.13.0/api/swagger.yaml \ - && wget -O md_source/engine/api/v1.26/swagger.yaml https://raw.githubusercontent.com/docker/docker/v17.03.0-ce/api/swagger.yaml \ - && wget -O md_source/engine/api/v1.27/swagger.yaml https://raw.githubusercontent.com/docker/docker/$ENGINE_BRANCH/api/swagger.yaml \ +RUN md_source/_scripts/fetch-upstream-resources.sh \ && jekyll build -s md_source -d target --config md_source/_config.yml \ && rm -rf target/apidocs/layouts \ && find target -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="https://docs.docker.com/#href="/#g' \ && rm -rf md_source - - # Next, build edge - - # Copy master into target directory (skipping files / folders in .dockerignore) - # These files represent the current docs - COPY . md_source - - # Move built html into md_source directory so we can reuse the target directory - # to hold the static output. - # Pull reference docs from upstream locations, then build the master docs - # into static HTML in the "target" directory using Jekyll - # then nuke the md_source directory. - - ## Branch to pull from, per ref doc - ## To get master from svn the svn branch needs to be 'trunk'. To get a branch from svn it needs to be 'branches/branchname' - ENV ENGINE_SVN_BRANCH="branches/17.04.x" - ENV ENGINE_BRANCH="17.04.x" - ENV DISTRIBUTION_SVN_BRANCH="branches/release/2.6" - ENV DISTRIBUTION_BRANCH="release/2.6" - - RUN svn co https://github.com/docker/docker/$ENGINE_SVN_BRANCH/docs/extend md_source/engine/extend \ - && wget -O md_source/engine/api/v1.18.md https://raw.githubusercontent.com/docker/docker/$ENGINE_BRANCH/docs/api/v1.18.md \ - && wget -O md_source/engine/api/v1.19.md https://raw.githubusercontent.com/docker/docker/$ENGINE_BRANCH/docs/api/v1.19.md \ - && wget -O md_source/engine/api/v1.20.md https://raw.githubusercontent.com/docker/docker/$ENGINE_BRANCH/docs/api/v1.20.md \ - && wget -O md_source/engine/api/v1.21.md https://raw.githubusercontent.com/docker/docker/$ENGINE_BRANCH/docs/api/v1.21.md \ - && wget -O md_source/engine/api/v1.22.md https://raw.githubusercontent.com/docker/docker/$ENGINE_BRANCH/docs/api/v1.22.md \ - && wget -O md_source/engine/api/v1.23.md https://raw.githubusercontent.com/docker/docker/$ENGINE_BRANCH/docs/api/v1.23.md \ - && wget -O md_source/engine/api/v1.24.md https://raw.githubusercontent.com/docker/docker/$ENGINE_BRANCH/docs/api/v1.24.md \ - && wget -O md_source/engine/api/version-history.md https://raw.githubusercontent.com/docker/docker/$ENGINE_BRANCH/docs/api/version-history.md \ - && wget -O md_source/engine/reference/glossary.md https://raw.githubusercontent.com/docker/docker/$ENGINE_BRANCH/docs/reference/glossary.md \ - && wget -O md_source/engine/reference/builder.md https://raw.githubusercontent.com/docker/docker/$ENGINE_BRANCH/docs/reference/builder.md \ - && wget -O md_source/engine/reference/run.md https://raw.githubusercontent.com/docker/docker/$ENGINE_BRANCH/docs/reference/run.md \ - && wget -O md_source/engine/reference/commandline/cli.md https://raw.githubusercontent.com/docker/docker/$ENGINE_BRANCH/docs/reference/commandline/cli.md \ - && wget -O md_source/engine/deprecated.md https://raw.githubusercontent.com/docker/docker/$ENGINE_BRANCH/docs/deprecated.md \ - && svn co https://github.com/docker/distribution/$DISTRIBUTION_SVN_BRANCH/docs/spec md_source/registry/spec \ - && rm md_source/registry/spec/api.md.tmpl \ - && wget -O md_source/registry/configuration.md https://raw.githubusercontent.com/docker/distribution/$DISTRIBUTION_BRANCH/docs/configuration.md \ - && rm -rf md_source/apidocs/cloud-api-source \ - && rm -rf md_source/tests \ - && wget -O md_source/engine/api/v1.25/swagger.yaml https://raw.githubusercontent.com/docker/docker/v1.13.0/api/swagger.yaml \ - && wget -O md_source/engine/api/v1.26/swagger.yaml https://raw.githubusercontent.com/docker/docker/v17.03.0-ce/api/swagger.yaml \ - && wget -O md_source/engine/api/v1.27/swagger.yaml https://raw.githubusercontent.com/docker/docker/$ENGINE_BRANCH/api/swagger.yaml \ - && jekyll build -s md_source -d target/edge --config md_source/_config-edge.yml \ - && rm -rf target/apidocs/layouts \ - && find target -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="https://docs.docker.com/#href="/#g' \ - # Replace / rewrite some URLs so that links in the edge directory go to the correct - # location. Note that the order in which these replacements are done is - # important. Changing the order may result in replacements being done - # multiple times. - # First, remove the domain from URLs that include the domain - && VER="edge" \ - && BASEURL="$VER/" \ - && find target/${VER} -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="http://docs-stage.docker.com/#href="/#g' \ - && find target/${VER} -type f -name '*.html' -print0 | xargs -0 sed -i 's#src="https://docs-stage.docker.com/#src="/#g' \ - && find target/${VER} -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="https://docs.docker.com/#href="/#g' \ - && find target/${VER} -type f -name '*.html' -print0 | xargs -0 sed -i 's#src="https://docs.docker.com/#src="/#g' \ - && find target/${VER} -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="http://docs.docker.com/#href="/#g' \ - && find target/${VER} -type f -name '*.html' -print0 | xargs -0 sed -i 's#src="http://docs.docker.com/#src="/#g' \ - \ - # Substitute https:// for schema-less resources (src="//analytics.google.com") - # We're replacing them to prevent them being seen as absolute paths below - && find target/${VER} -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="//#href="https://#g' \ - && find target/${VER} -type f -name '*.html' -print0 | xargs -0 sed -i 's#src="//#src="https://#g' \ - \ - # And some archive versions already have URLs starting with '/version/' - && find target/${VER} -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="/'"$BASEURL"'#href="/#g' \ - && find target/${VER} -type f -name '*.html' -print0 | xargs -0 sed -i 's#src="/'"$BASEURL"'#src="/#g' \ - \ - # Archived versions 1.7 and under use some absolute links, and v1.10 uses - # "relative" links to sources (href="./css/"). Remove those to make them - # work :) - && find target/${VER} -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="\./#href="/#g' \ - && find target/${VER} -type f -name '*.html' -print0 | xargs -0 sed -i 's#src="\./#src="/#g' \ - \ - # Create permalinks for archived versions - \ - && find target/${VER} -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="/#href="/'"$BASEURL"'#g' \ - && find target/${VER} -type f -name '*.html' -print0 | xargs -0 sed -i 's#src="/#src="/'"$BASEURL"'#g' \ - # Fix 'Back to Stable Docs' URL - && find target/${VER} -type f -name '*.html' -print0 | xargs -0 sed -i 's#
  • Back to Stable docs
    • #
  • Back to Stable docs
    • #g' \ - && rm -rf md_source \ No newline at end of file diff --git a/_config-edge.yml b/_config-edge.yml deleted file mode 100644 index 718e217a535..00000000000 --- a/_config-edge.yml +++ /dev/null @@ -1,173 +0,0 @@ -name: Docker CE Edge Documentation -markdown: kramdown -kramdown: - input: GFM - html_to_native: true - hard_wrap: false - syntax_highlighter: rouge - toc_levels: 2..3 -incremental: true -permalink: pretty -safe: false -lsi: false -url: https://docs.docker.com/edge/ -keep_files: ["v1.4", "v1.5", "v1.6", "v1.7", "v1.8", "v1.9", "v1.10", "v1.11", "v1.12", "v1.13"] -edge: true # set to true if the next expected release is going to the edge channel - -gems: - - jekyll-redirect-from - - jekyll-seo-tag - - jekyll-relative-links - -webrick: - headers: - Cache-Control: 600 - -defaults: - - - scope: - path: "" - type: "pages" - values: - layout: docs - defaultassignee: johndmulhausen - enginebranch: 1.13.x - toc_min: 2 - toc_max: 3 - tree: true - - scope: - path: "compose" - values: - assignee: "londoncalling" - - scope: - path: "cs-engine" - values: - assignee: "joaofnfernandes" - - scope: - path: "datacenter" - values: - assignee: "joaofnfernandes" - - scope: - path: "docker-cloud" - values: - assignee: "londoncalling" - - scope: - path: "docker-for-mac" - values: - assignee: "londoncalling" - - scope: - path: "docker-for-windows" - values: - assignee: "londoncalling" - - scope: - path: "docker-hub" - values: - assignee: "johndmulhausen" - - scope: - path: "docker-store" - values: - assignee: "johndmulhausen" - - scope: - path: "engine" - values: - assignee: "mstanleyjones" - - scope: - path: "kitematic" - values: - assignee: "londoncalling" - - scope: - path: "machine" - values: - assignee: "londoncalling" - - scope: - path: "notary" - values: - assignee: "johndmulhausen" - - scope: - path: "registry" - values: - assignee: "joaofnfernandes" - - scope: - path: "swarm" - values: - assignee: "mstanleyjones" - - scope: - path: "toolbox" - values: - assignee: "londoncalling" - - - scope: - path: "datacenter" - values: - ucp_latest_image: "docker/ucp:2.1.2" - dtr_latest_image: "docker/dtr:2.2.3" - - - scope: - path: "datacenter/dtr/2.2" - values: - ucp_version: "2.1" - dtr_version: "2.2" - docker_image: "docker/dtr:2.2.3" - - - scope: - path: "datacenter/dtr/2.1" - values: - hide_from_sitemap: true - ucp_version: "2.0" - dtr_version: "2.1" - - - scope: - path: "datacenter/dtr/2.0" - values: - hide_from_sitemap: true - ucp_version: "1.1" - dtr_version: "2.0" - - - scope: - path: "datacenter/ucp/2.1" - values: - ucp_version: "2.1" - dtr_version: "2.2" - docker_image: "docker/ucp:2.1.2" - - - scope: - path: "datacenter/ucp/2.0" - values: - hide_from_sitemap: true - ucp_version: "2.0" - dtr_version: "2.1" - docker_image: "docker/ucp:2.0.3" - - - scope: - path: "datacenter/ucp/1.1" - values: - hide_from_sitemap: true - ucp_version: "1.1" - dtr_version: "2.0" - - - scope: - path: "apidocs/v1.3.3" - values: - hide_from_sitemap: true - - - scope: - path: "apidocs/v1.4.0" - values: - hide_from_sitemap: true - - - scope: - path: "apidocs/v2.0.0" - values: - hide_from_sitemap: true - - - scope: - path: "apidocs/v2.0.1" - values: - hide_from_sitemap: true - -# Assets -# -# We specify the directory for Jekyll so we can use @imports. -sass: - sass_dir: _scss - style: :compressed \ No newline at end of file diff --git a/_config.yml b/_config.yml index 515aa8dd3de..a25e1840447 100644 --- a/_config.yml +++ b/_config.yml @@ -12,7 +12,6 @@ safe: false lsi: false url: https://docs.docker.com keep_files: ["v1.4", "v1.5", "v1.6", "v1.7", "v1.8", "v1.9", "v1.10", "v1.11", "v1.12", "v1.13"] -edge: false # set to true if the next expected release is going to the edge channel gems: - jekyll-redirect-from diff --git a/_data/docsarchive/archives.yaml b/_data/docsarchive/archives.yaml index 7ff5b1f88e5..e1f2f455a00 100644 --- a/_data/docsarchive/archives.yaml +++ b/_data/docsarchive/archives.yaml @@ -1,6 +1,3 @@ -- archive: - name: edge - image: docs/docker.github.io:latest - archive: name: v17.03 image: docs/docker.github.io:latest diff --git a/_data/toc.yaml b/_data/toc.yaml index 840240d2cef..fce84c66350 100644 --- a/_data/toc.yaml +++ b/_data/toc.yaml @@ -22,6 +22,13 @@ guides: section: - path: /engine/installation/ title: Install Docker + - sectiontitle: Docker Edge + section: + - path: /edge/ + title: Overview + - path: /edge/engine/reference/commandline/docker/ + title: Docker Edge CLI reference + nosync: true - path: /docker-for-mac/install/ title: Docker for Mac - path: /docker-for-windows/install/ @@ -482,10 +489,12 @@ reference: section: - path: /engine/api/ title: Overview - - path: /engine/api/getting-started/ - title: Getting started + - path: /engine/api/get-started/ + title: Get started - path: /engine/api/sdks/ title: SDKs + - path: /engine/api/v1.28/ + title: v1.28 Reference - path: /engine/api/v1.27/ title: v1.27 Reference - sectiontitle: Previous API versions @@ -838,6 +847,336 @@ reference: title: docker volume rm - path: /engine/reference/commandline/wait/ title: docker wait +- title: Edge Daemon CLI reference (dockerd) + path: /edge/engine/reference/commandline/dockerd/ +- sectiontitle: Docker Edge Engine (docker) CLI + section: + - path: /edge/engine/reference/run/ + title: Docker run reference + - path: /edge/engine/reference/commandline/cli/ + title: Use the Docker command line + - path: /edge/engine/reference/commandline/docker/ + title: docker (base command) + - path: /edge/engine/reference/commandline/attach/ + title: docker attach + - path: /edge/engine/reference/commandline/build/ + title: docker build + - sectiontitle: docker checkpoint * + section: + - path: /edge/engine/reference/commandline/checkpoint/ + title: docker checkpoint + - path: /edge/engine/reference/commandline/checkpoint_create/ + title: docker checkpoint create + - path: /edge/engine/reference/commandline/checkpoint_create/ + title: docker checkpoint create + - path: /edge/engine/reference/commandline/checkpoint_ls/ + title: docker checkpoint ls + - path: /edge/engine/reference/commandline/checkpoint_rm/ + title: docker checkpoint rm + - path: /edge/engine/reference/commandline/commit/ + title: docker commit + - sectiontitle: docker container * + section: + - path: /edge/engine/reference/commandline/container/ + title: docker container + - path: /edge/engine/reference/commandline/container_attach/ + title: docker container attach + - path: /edge/engine/reference/commandline/container_commit/ + title: docker container commit + - path: /edge/engine/reference/commandline/container_cp/ + title: docker container cp + - path: /edge/engine/reference/commandline/container_create/ + title: docker container create + - path: /edge/engine/reference/commandline/container_diff/ + title: docker container diff + - path: /edge/engine/reference/commandline/container_exec/ + title: docker container exec + - path: /edge/engine/reference/commandline/container_export/ + title: docker container export + - path: /edge/engine/reference/commandline/container_inspect/ + title: docker container inspect + - path: /edge/engine/reference/commandline/container_kill/ + title: docker container kill + - path: /edge/engine/reference/commandline/container_logs/ + title: docker container logs + - path: /edge/engine/reference/commandline/container_ls/ + title: docker container ls + - path: /edge/engine/reference/commandline/container_pause/ + title: docker container pause + - path: /edge/engine/reference/commandline/container_port/ + title: docker container port + - path: /edge/engine/reference/commandline/container_prune/ + title: docker container prune + - path: /edge/engine/reference/commandline/container_rename/ + title: docker container rename + - path: /edge/engine/reference/commandline/container_restart/ + title: docker container restart + - path: /edge/engine/reference/commandline/container_rm/ + title: docker container rm + - path: /edge/engine/reference/commandline/container_run/ + title: docker container run + - path: /edge/engine/reference/commandline/container_start/ + title: docker container start + - path: /edge/engine/reference/commandline/container_stats/ + title: docker container stats + - path: /edge/engine/reference/commandline/container_stop/ + title: docker container stop + - path: /edge/engine/reference/commandline/container_top/ + title: docker container top + - path: /edge/engine/reference/commandline/container_unpause/ + title: docker container unpause + - path: /edge/engine/reference/commandline/container_update/ + title: docker container update + - path: /edge/engine/reference/commandline/container_wait/ + title: docker container wait + - path: /edge/engine/reference/commandline/cp/ + title: docker cp + - path: /edge/engine/reference/commandline/create/ + title: docker create + - path: /edge/engine/reference/commandline/deploy/ + title: docker deploy + - path: /edge/engine/reference/commandline/diff/ + title: docker diff + - path: /edge/engine/reference/commandline/events/ + title: docker events + - path: /edge/engine/reference/commandline/exec/ + title: docker exec + - path: /edge/engine/reference/commandline/export/ + title: docker export + - path: /edge/engine/reference/commandline/history/ + title: docker history + - sectiontitle: docker image * + section: + - path: /edge/engine/reference/commandline/image/ + title: docker image + - path: /edge/engine/reference/commandline/image_build/ + title: docker image build + - path: /edge/engine/reference/commandline/image_history/ + title: docker image history + - path: /edge/engine/reference/commandline/image_import/ + title: docker image import + - path: /edge/engine/reference/commandline/image_inspect/ + title: docker image inspect + - path: /edge/engine/reference/commandline/image_load/ + title: docker image load + - path: /edge/engine/reference/commandline/image_ls/ + title: docker image ls + - path: /edge/engine/reference/commandline/image_prune/ + title: docker image prune + - path: /edge/engine/reference/commandline/image_pull/ + title: docker image pull + - path: /edge/engine/reference/commandline/image_push/ + title: docker image push + - path: /edge/engine/reference/commandline/image_rm/ + title: docker image rm + - path: /edge/engine/reference/commandline/image_save/ + title: docker image save + - path: /edge/engine/reference/commandline/image_tag/ + title: docker image tag + - path: /edge/engine/reference/commandline/images/ + title: docker images + - path: /edge/engine/reference/commandline/import/ + title: docker import + - path: /edge/engine/reference/commandline/info/ + title: docker info + - path: /edge/engine/reference/commandline/inspect/ + title: docker inspect + - path: /edge/engine/reference/commandline/kill/ + title: docker kill + - path: /edge/engine/reference/commandline/load/ + title: docker load + - path: /edge/engine/reference/commandline/login/ + title: docker login + - path: /edge/engine/reference/commandline/logout/ + title: docker logout + - path: /edge/engine/reference/commandline/logs/ + title: docker logs + - sectiontitle: docker network * + section: + - path: /edge/engine/reference/commandline/network/ + title: docker network + - path: /edge/engine/reference/commandline/network_connect/ + title: docker network connect + - path: /edge/engine/reference/commandline/network_create/ + title: docker network create + - path: /edge/engine/reference/commandline/network_disconnect/ + title: docker network disconnect + - path: /edge/engine/reference/commandline/network_inspect/ + title: docker network inspect + - path: /edge/engine/reference/commandline/network_ls/ + title: docker network ls + - path: /edge/engine/reference/commandline/network_prune/ + title: docker network prune + - path: /edge/engine/reference/commandline/network_rm/ + title: docker network rm + - sectiontitle: docker node * + section: + - path: /edge/engine/reference/commandline/node/ + title: docker node + - path: /edge/engine/reference/commandline/node_demote/ + title: docker node demote + - path: /edge/engine/reference/commandline/node_inspect/ + title: docker node inspect + - path: /edge/engine/reference/commandline/node_ls/ + title: docker node ls + - path: /edge/engine/reference/commandline/node_promote/ + title: docker node promote + - path: /edge/engine/reference/commandline/node_ps/ + title: docker node ps + - path: /edge/engine/reference/commandline/node_rm/ + title: docker node rm + - path: /edge/engine/reference/commandline/node_update/ + title: docker node update + - path: /edge/engine/reference/commandline/pause/ + title: docker pause + - sectiontitle: docker plugin * + section: + - path: /edge/engine/reference/commandline/plugin/ + title: docker plugin + - path: /edge/engine/reference/commandline/plugin_create/ + title: docker plugin create + - path: /edge/engine/reference/commandline/plugin_disable/ + title: docker plugin disable + - path: /edge/engine/reference/commandline/plugin_enable/ + title: docker plugin enable + - path: /edge/engine/reference/commandline/plugin_inspect/ + title: docker plugin inspect + - path: /edge/engine/reference/commandline/plugin_install/ + title: docker plugin install + - path: /edge/engine/reference/commandline/plugin_ls/ + title: docker plugin ls + - path: /edge/engine/reference/commandline/plugin_rm/ + title: docker plugin rm + - path: /edge/engine/reference/commandline/plugin_set/ + title: docker plugin set + - path: /edge/engine/reference/commandline/plugin_upgrade/ + title: docker plugin upgrade + - path: /edge/engine/reference/commandline/port/ + title: docker port + - path: /edge/engine/reference/commandline/ps/ + title: docker ps + - path: /edge/engine/reference/commandline/pull/ + title: docker pull + - path: /edge/engine/reference/commandline/push/ + title: docker push + - path: /edge/engine/reference/commandline/rename/ + title: docker rename + - path: /edge/engine/reference/commandline/restart/ + title: docker restart + - path: /edge/engine/reference/commandline/rm/ + title: docker rm + - path: /edge/engine/reference/commandline/rmi/ + title: docker rmi + - path: /edge/engine/reference/commandline/run/ + title: docker run + - path: /edge/engine/reference/commandline/save/ + title: docker save + - path: /edge/engine/reference/commandline/search/ + title: docker search + - sectiontitle: docker secret * + section: + - path: /edge/engine/reference/commandline/secret/ + title: docker secret + - path: /edge/engine/reference/commandline/secret_create/ + title: docker secret create + - path: /edge/engine/reference/commandline/secret_inspect/ + title: docker secret inspect + - path: /edge/engine/reference/commandline/secret_ls/ + title: docker secret ls + - path: /edge/engine/reference/commandline/secret_rm/ + title: docker secret rm + - sectiontitle: docker service * + section: + - path: /edge/engine/reference/commandline/service/ + title: docker service + - path: /edge/engine/reference/commandline/service_create/ + title: docker service create + - path: /edge/engine/reference/commandline/service_inspect/ + title: docker service inspect + - path: /edge/engine/reference/commandline/service_logs/ + title: docker service logs + - path: /edge/engine/reference/commandline/service_ls/ + title: docker service ls + - path: /edge/engine/reference/commandline/service_ps/ + title: docker service ps + - path: /edge/engine/reference/commandline/service_rm/ + title: docker service rm + - path: /edge/engine/reference/commandline/service_scale/ + title: docker service scale + - path: /edge/engine/reference/commandline/service_update/ + title: docker service update + - sectiontitle: docker stack * + section: + - path: /edge/engine/reference/commandline/stack/ + title: docker stack + - path: /edge/engine/reference/commandline/stack_deploy/ + title: docker stack deploy + - path: /edge/engine/reference/commandline/stack_ps/ + title: docker stack ps + - path: /edge/engine/reference/commandline/stack_rm/ + title: docker stack rm + - path: /edge/engine/reference/commandline/stack_services/ + title: docker stack services + - path: /edge/engine/reference/commandline/start/ + title: docker start + - path: /edge/engine/reference/commandline/stats/ + title: docker stats + - path: /edge/engine/reference/commandline/stop/ + title: docker stop + - sectiontitle: docker swarm * + section: + - path: /edge/engine/reference/commandline/swarm/ + title: docker swarm + - path: /edge/engine/reference/commandline/swarm_init/ + title: docker swarm init + - path: /edge/engine/reference/commandline/swarm_join-token/ + title: docker swarm join-token + - path: /edge/engine/reference/commandline/swarm_join/ + title: docker swarm join + - path: /edge/engine/reference/commandline/swarm_leave/ + title: docker swarm leave + - path: /edge/engine/reference/commandline/swarm_unlock-key/ + title: docker swarm unlock-key + - path: /edge/engine/reference/commandline/swarm_unlock/ + title: docker swarm unlock + - path: /edge/engine/reference/commandline/swarm_update/ + title: docker swarm update + - sectiontitle: docker system * + section: + - path: /edge/engine/reference/commandline/system/ + title: docker system + - path: /edge/engine/reference/commandline/system_df/ + title: docker system df + - path: /edge/engine/reference/commandline/system_events/ + title: docker system events + - path: /edge/engine/reference/commandline/system_info/ + title: docker system info + - path: /edge/engine/reference/commandline/system_prune/ + title: docker system prune + - path: /edge/engine/reference/commandline/tag/ + title: docker tag + - path: /edge/engine/reference/commandline/top/ + title: docker top + - path: /edge/engine/reference/commandline/unpause/ + title: docker unpause + - path: /edge/engine/reference/commandline/update/ + title: docker update + - path: /edge/engine/reference/commandline/version/ + title: docker version + - sectiontitle: docker volume * + section: + - path: /edge/engine/reference/commandline/volume_create/ + title: docker volume create + - path: /edge/engine/reference/commandline/volume_inspect/ + title: docker volume inspect + - path: /edge/engine/reference/commandline/volume_ls/ + title: docker volume ls + - path: /edge/engine/reference/commandline/volume_prune/ + title: docker volume prune + - path: /edge/engine/reference/commandline/volume_rm/ + title: docker volume rm + - path: /edge/engine/reference/commandline/wait/ + title: docker wait - title: Machine (docker-machine) CLI path: /machine/reference/ nosync: true diff --git a/_includes/cli.md b/_includes/cli.md index d026488a7af..d680593ca0b 100644 --- a/_includes/cli.md +++ b/_includes/cli.md @@ -83,5 +83,8 @@ {{ site.data[include.datafolder][include.datafile].examples }} {% endif %} +{% else %} + +The include.datafolder or include.datafile was not set. {% endif %} diff --git a/_includes/edge_only.md b/_includes/edge_only.md new file mode 100644 index 00000000000..a680fc48ffd --- /dev/null +++ b/_includes/edge_only.md @@ -0,0 +1,19 @@ +{% assign section = include.section %} + +{% if section == "option" %} +> **Edge only**: This option is only available in Docker CE Edge versions. See [Docker CE Edge](/edge/index.md). + +{% elsif section == "options" %} +> **Edge only**: These options are only available in Docker CE Edge versions. See [Docker CE Edge](/edge/index.md). + +{% elsif section == "page" %} +> **Edge only**: This topic is only applicable to Docker CE Edge versions. See [Docker CE Edge](/edge/index.md). + +{% elsif section == "cliref" %} +> **Edge only**: This is the CLI reference for Docker CE Edge versions. Some of these options may not be available +> to Docker CE stable or Docker EE. You can +> [view the stable version of this CLI reference]({{ page.url | replace:"/edge/", "/"}}) +> or [learn about Docker CE Edge](/edge/index.md). + +{% endif %} + diff --git a/_includes/treebuilder.html b/_includes/treebuilder.html index 857549db662..743e0ffc7a6 100644 --- a/_includes/treebuilder.html +++ b/_includes/treebuilder.html @@ -21,8 +21,3 @@ {% endif %}
  • {{ section.title }}
    • {% endfor %} -{% if site.edge == true %} -
  • Back to Stable docs
    • -{% else %} -
  • Try the CE Edge docs
    • -{% endif %} diff --git a/_scripts/fetch-upstream-resources.sh b/_scripts/fetch-upstream-resources.sh new file mode 100755 index 00000000000..b57a8ce90a9 --- /dev/null +++ b/_scripts/fetch-upstream-resources.sh @@ -0,0 +1,43 @@ +#!/bin/bash + +# Fetches upstream resources from docker/docker and docker/distribution +# before handing off the site to Jekyll to build +# Relies on the following environment variables which are usually set by +# the Dockerfile. Uncomment them here to override for debugging + +# Engine stable +ENGINE_SVN_BRANCH="branches/17.03.x" +ENGINE_BRANCH="17.03.x" + +# Distribution +DISTRIBUTION_SVN_BRANCH="branches/release/2.6" +DISTRIBUTION_BRANCH="release/2.6" + +# Directories to get via SVN. We use this because you can't use git to clone just a portion of a repository +svn co https://github.com/docker/docker/"$ENGINE_SVN_BRANCH"/docs/extend md_source/engine/extend || (echo "Failed engine/extend download" && exit -1) +svn co https://github.com/docker/docker/"$ENGINE_SVN_BRANCH"/docs/api md_source/engine/api || (echo "Failed engine/api download" && exit -1) # This will only get you the old API MD files 1.18 through 1.24 +svn co https://github.com/docker/distribution/"$DISTRIBUTION_SVN_BRANCH"/docs/spec md_source/registry/spec || (echo "Failed registry/spec download" && exit -1) + + +# Get the Engine APIs that are in Swagger +# Be careful with the locations on Github for these +wget -O md_source/engine/api/v1.25/swagger.yaml https://raw.githubusercontent.com/docker/docker/v1.13.0/api/swagger.yaml || (echo "Failed 1.25 swagger download" && exit -1) +wget -O md_source/engine/api/v1.26/swagger.yaml https://raw.githubusercontent.com/docker/docker/v17.03.0-ce/api/swagger.yaml || (echo "Failed 1.26 swagger download" && exit -1) +wget -O md_source/engine/api/v1.27/swagger.yaml https://raw.githubusercontent.com/docker/docker/v17.03.1-ce/api/swagger.yaml || (echo "Failed 1.27 swagger download" && exit -1) + +# Get the Edge API Swagger (we only keep the latest one of these +# When you change this you need to make sure to copy the previous +# directory into a new one in the docs git and change the index.html +wget -O md_source/engine/api/v1.28/swagger.yaml https://raw.githubusercontent.com/docker/docker/v17.04.0-ce/api/swagger.yaml || (echo "Failed 1.28 swagger download or the 1.28 directory doesn't exist" && exit -1) + +# Get a few one-off files that we use directly from upstream +wget -O md_source/engine/reference/builder.md https://raw.githubusercontent.com/docker/docker/"$ENGINE_BRANCH"/docs/reference/builder.md || (echo "Failed engine/reference/builder.md download" && exit -1) +wget -O md_source/engine/reference/run.md https://raw.githubusercontent.com/docker/docker/"$ENGINE_BRANCH"/docs/reference/run.md || (echo "Failed engine/reference/run.md download" && exit -1) +wget -O md_source/engine/reference/commandline/cli.md https://raw.githubusercontent.com/docker/docker/"$ENGINE_BRANCH"/docs/reference/commandline/cli.md || (echo "Failed engine/reference/commandline/cli.md download" && exit -1) +wget -O md_source/engine/deprecated.md https://raw.githubusercontent.com/docker/docker/"$ENGINE_BRANCH"/docs/deprecated.md || (echo "Failed engine/deprecated.md download" && exit -1) +wget -O md_source/registry/configuration.md https://raw.githubusercontent.com/docker/distribution/"$DISTRIBUTION_BRANCH"/docs/configuration.md || (echo "Failed registry/configuration.md download" && exit -1) + +# Remove things we don't want in the build +rm md_source/registry/spec/api.md.tmpl +rm -rf md_source/apidocs/cloud-api-source +rm -rf md_source/tests \ No newline at end of file diff --git a/edge/engine/reference/commandline/README.md b/edge/engine/reference/commandline/README.md new file mode 100644 index 00000000000..32d97bbd649 --- /dev/null +++ b/edge/engine/reference/commandline/README.md @@ -0,0 +1,29 @@ +# About these files + +The files in this directory are stub files which include the file +`/_includes/cli.md`, which parses YAML files generated from the +[`docker/docker`](https://github.com/docker/docker) repository. The YAML files +are parsed into output files like +[https://docs.docker.com/engine/reference/commandline/build/](https://docs.docker.com/engine/reference/commandline/build/). + +## How the output is generated + +The output files are composed from two sources: + +- The **Description** and **Usage** sections comes directly from + the CLI source code in that repository. + +- The **Extended Description** and **Examples** sections are pulled into the + YAML from the files in [https://github.com/docker/docker/tree/master/docs/reference/commandline](https://github.com/docker/docker/tree/master/docs/reference/commandline) + Specifically, the Markdown inside the `## Description` and `## Examples` + headings are parsed. Please submit corrections to the text in that repository. + +# Updating the YAML files + +The process for generating the YAML files is still in flux. Check with +@thajestah or @frenchben. Be sure to generate the YAML files with the correct +branch of `docker/docker` checked out (probably not `master`). + +After generating the YAML files, replace the YAML files in +[https://github.com/docker/docker.github.io/tree/master/_data/engine-cli](https://github.com/docker/docker.github.io/tree/master/_data/engine-cli) +with the newly-generated files. Submit a pull request. diff --git a/edge/engine/reference/commandline/attach.md b/edge/engine/reference/commandline/attach.md new file mode 100644 index 00000000000..73af62ef68d --- /dev/null +++ b/edge/engine/reference/commandline/attach.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_attach +title: docker attach +--- + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} + +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/build.md b/edge/engine/reference/commandline/build.md new file mode 100644 index 00000000000..3c82a276755 --- /dev/null +++ b/edge/engine/reference/commandline/build.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_build +title: docker build +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/checkpoint.md b/edge/engine/reference/commandline/checkpoint.md new file mode 100644 index 00000000000..a50c606ec3e --- /dev/null +++ b/edge/engine/reference/commandline/checkpoint.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_checkpoint +title: docker checkpoint +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/checkpoint_create.md b/edge/engine/reference/commandline/checkpoint_create.md new file mode 100644 index 00000000000..850dc647526 --- /dev/null +++ b/edge/engine/reference/commandline/checkpoint_create.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_checkpoint_create +title: docker checkpoint create +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/checkpoint_ls.md b/edge/engine/reference/commandline/checkpoint_ls.md new file mode 100644 index 00000000000..b1349bd25a2 --- /dev/null +++ b/edge/engine/reference/commandline/checkpoint_ls.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_checkpoint_ls +title: docker checkpoint ls +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/checkpoint_rm.md b/edge/engine/reference/commandline/checkpoint_rm.md new file mode 100644 index 00000000000..3e69c62d2a9 --- /dev/null +++ b/edge/engine/reference/commandline/checkpoint_rm.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_checkpoint_rm +title: docker checkpoint rm +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/commit.md b/edge/engine/reference/commandline/commit.md new file mode 100644 index 00000000000..422d6d874df --- /dev/null +++ b/edge/engine/reference/commandline/commit.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_commit +title: docker commit +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/container.md b/edge/engine/reference/commandline/container.md new file mode 100644 index 00000000000..ceb49c3a351 --- /dev/null +++ b/edge/engine/reference/commandline/container.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_container +title: docker container +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/container_attach.md b/edge/engine/reference/commandline/container_attach.md new file mode 100644 index 00000000000..1d288ae961d --- /dev/null +++ b/edge/engine/reference/commandline/container_attach.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_container_attach +title: docker container attach +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/container_commit.md b/edge/engine/reference/commandline/container_commit.md new file mode 100644 index 00000000000..43423af6557 --- /dev/null +++ b/edge/engine/reference/commandline/container_commit.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_container_commit +title: docker container commit +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/container_cp.md b/edge/engine/reference/commandline/container_cp.md new file mode 100644 index 00000000000..2e300f017d5 --- /dev/null +++ b/edge/engine/reference/commandline/container_cp.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_container_cp +title: docker container cp +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/container_create.md b/edge/engine/reference/commandline/container_create.md new file mode 100644 index 00000000000..adf725c7b94 --- /dev/null +++ b/edge/engine/reference/commandline/container_create.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_container_create +title: docker container create +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/container_diff.md b/edge/engine/reference/commandline/container_diff.md new file mode 100644 index 00000000000..f2a667a2590 --- /dev/null +++ b/edge/engine/reference/commandline/container_diff.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_container_diff +title: docker container diff +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/container_exec.md b/edge/engine/reference/commandline/container_exec.md new file mode 100644 index 00000000000..dff443e36a8 --- /dev/null +++ b/edge/engine/reference/commandline/container_exec.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_container_exec +title: docker container exec +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/container_export.md b/edge/engine/reference/commandline/container_export.md new file mode 100644 index 00000000000..a31990d2396 --- /dev/null +++ b/edge/engine/reference/commandline/container_export.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_container_export +title: docker container export +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/container_inspect.md b/edge/engine/reference/commandline/container_inspect.md new file mode 100644 index 00000000000..8bc76d8adcf --- /dev/null +++ b/edge/engine/reference/commandline/container_inspect.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_container_inspect +title: docker container inspect +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/container_kill.md b/edge/engine/reference/commandline/container_kill.md new file mode 100644 index 00000000000..d635ec909b4 --- /dev/null +++ b/edge/engine/reference/commandline/container_kill.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_container_kill +title: docker container kill +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/container_logs.md b/edge/engine/reference/commandline/container_logs.md new file mode 100644 index 00000000000..330fd6c824a --- /dev/null +++ b/edge/engine/reference/commandline/container_logs.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_container_logs +title: docker container logs +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/container_ls.md b/edge/engine/reference/commandline/container_ls.md new file mode 100644 index 00000000000..0ca0fbf607b --- /dev/null +++ b/edge/engine/reference/commandline/container_ls.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_container_ls +title: docker container ls +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/container_pause.md b/edge/engine/reference/commandline/container_pause.md new file mode 100644 index 00000000000..1d9634cd4dd --- /dev/null +++ b/edge/engine/reference/commandline/container_pause.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_container_pause +title: docker container pause +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/container_port.md b/edge/engine/reference/commandline/container_port.md new file mode 100644 index 00000000000..e7b35555de7 --- /dev/null +++ b/edge/engine/reference/commandline/container_port.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_container_port +title: docker container port +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/container_prune.md b/edge/engine/reference/commandline/container_prune.md new file mode 100644 index 00000000000..3ea285752eb --- /dev/null +++ b/edge/engine/reference/commandline/container_prune.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_container_prune +title: docker container prune +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/container_rename.md b/edge/engine/reference/commandline/container_rename.md new file mode 100644 index 00000000000..24657714504 --- /dev/null +++ b/edge/engine/reference/commandline/container_rename.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_container_rename +title: docker container rename +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/container_restart.md b/edge/engine/reference/commandline/container_restart.md new file mode 100644 index 00000000000..a0437b66bb4 --- /dev/null +++ b/edge/engine/reference/commandline/container_restart.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_container_restart +title: docker container restart +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/container_rm.md b/edge/engine/reference/commandline/container_rm.md new file mode 100644 index 00000000000..52a61384b27 --- /dev/null +++ b/edge/engine/reference/commandline/container_rm.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_container_rm +title: docker container rm +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/container_run.md b/edge/engine/reference/commandline/container_run.md new file mode 100644 index 00000000000..e9138ca56d0 --- /dev/null +++ b/edge/engine/reference/commandline/container_run.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_container_run +title: docker container run +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/container_start.md b/edge/engine/reference/commandline/container_start.md new file mode 100644 index 00000000000..2032991741f --- /dev/null +++ b/edge/engine/reference/commandline/container_start.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_container_start +title: docker container start +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/container_stats.md b/edge/engine/reference/commandline/container_stats.md new file mode 100644 index 00000000000..b2641dd44bf --- /dev/null +++ b/edge/engine/reference/commandline/container_stats.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_container_stats +title: docker container stats +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/container_stop.md b/edge/engine/reference/commandline/container_stop.md new file mode 100644 index 00000000000..fb54ef00a30 --- /dev/null +++ b/edge/engine/reference/commandline/container_stop.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_container_stop +title: docker container stop +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/container_top.md b/edge/engine/reference/commandline/container_top.md new file mode 100644 index 00000000000..631dd395913 --- /dev/null +++ b/edge/engine/reference/commandline/container_top.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_container_top +title: docker container top +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/container_unpause.md b/edge/engine/reference/commandline/container_unpause.md new file mode 100644 index 00000000000..e9786157322 --- /dev/null +++ b/edge/engine/reference/commandline/container_unpause.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_container_unpause +title: docker container unpause +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/container_update.md b/edge/engine/reference/commandline/container_update.md new file mode 100644 index 00000000000..80c51a9acaf --- /dev/null +++ b/edge/engine/reference/commandline/container_update.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_container_update +title: docker container update +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/container_wait.md b/edge/engine/reference/commandline/container_wait.md new file mode 100644 index 00000000000..036441e3de5 --- /dev/null +++ b/edge/engine/reference/commandline/container_wait.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_container_wait +title: docker container wait +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/cp.md b/edge/engine/reference/commandline/cp.md new file mode 100644 index 00000000000..4d93c450f62 --- /dev/null +++ b/edge/engine/reference/commandline/cp.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_cp +title: docker cp +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/create.md b/edge/engine/reference/commandline/create.md new file mode 100644 index 00000000000..ec0781c0ea4 --- /dev/null +++ b/edge/engine/reference/commandline/create.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_create +title: docker create +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/deploy.md b/edge/engine/reference/commandline/deploy.md new file mode 100644 index 00000000000..0b4cc85cb93 --- /dev/null +++ b/edge/engine/reference/commandline/deploy.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_deploy +title: docker deploy +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/diff.md b/edge/engine/reference/commandline/diff.md new file mode 100644 index 00000000000..7b9d6a2721c --- /dev/null +++ b/edge/engine/reference/commandline/diff.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_diff +title: docker diff +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/docker.md b/edge/engine/reference/commandline/docker.md new file mode 100644 index 00000000000..20e5d62c651 --- /dev/null +++ b/edge/engine/reference/commandline/docker.md @@ -0,0 +1,20 @@ +--- +datafolder: engine-cli-edge +datafile: docker +title: docker +redirect_from: +- /engine/reference/commandline/ +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/dockerd.md b/edge/engine/reference/commandline/dockerd.md new file mode 100644 index 00000000000..1d0fe6a1342 --- /dev/null +++ b/edge/engine/reference/commandline/dockerd.md @@ -0,0 +1,24 @@ +--- +redirect_from: +- /reference/commandline/dockerd/ +- /reference/commandline/daemon/ +- /engine/reference/commandline/daemon/ +description: The daemon command description and usage +keywords: container, daemon, runtime +title: dockerd +datafolder: dockerd-cli +datafile: dockerd +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/events.md b/edge/engine/reference/commandline/events.md new file mode 100644 index 00000000000..1f128e7768e --- /dev/null +++ b/edge/engine/reference/commandline/events.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_events +title: docker events +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/exec.md b/edge/engine/reference/commandline/exec.md new file mode 100644 index 00000000000..9d0d8004fc1 --- /dev/null +++ b/edge/engine/reference/commandline/exec.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_exec +title: docker exec +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/export.md b/edge/engine/reference/commandline/export.md new file mode 100644 index 00000000000..57d7ff95e88 --- /dev/null +++ b/edge/engine/reference/commandline/export.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_export +title: docker export +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/history.md b/edge/engine/reference/commandline/history.md new file mode 100644 index 00000000000..18efdb9c3ac --- /dev/null +++ b/edge/engine/reference/commandline/history.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_history +title: docker history +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/image.md b/edge/engine/reference/commandline/image.md new file mode 100644 index 00000000000..e7cf5c26ae8 --- /dev/null +++ b/edge/engine/reference/commandline/image.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_image +title: docker image +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/image_build.md b/edge/engine/reference/commandline/image_build.md new file mode 100644 index 00000000000..793d514ac28 --- /dev/null +++ b/edge/engine/reference/commandline/image_build.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_image_build +title: docker image build +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/image_history.md b/edge/engine/reference/commandline/image_history.md new file mode 100644 index 00000000000..ae58889224a --- /dev/null +++ b/edge/engine/reference/commandline/image_history.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_image_history +title: docker image history +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/image_import.md b/edge/engine/reference/commandline/image_import.md new file mode 100644 index 00000000000..20d217217e2 --- /dev/null +++ b/edge/engine/reference/commandline/image_import.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_image_import +title: docker image import +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/image_inspect.md b/edge/engine/reference/commandline/image_inspect.md new file mode 100644 index 00000000000..375c50541d9 --- /dev/null +++ b/edge/engine/reference/commandline/image_inspect.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_image_inspect +title: docker image inspect +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/image_load.md b/edge/engine/reference/commandline/image_load.md new file mode 100644 index 00000000000..f71b4249211 --- /dev/null +++ b/edge/engine/reference/commandline/image_load.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_image_load +title: docker image load +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/image_ls.md b/edge/engine/reference/commandline/image_ls.md new file mode 100644 index 00000000000..c19b0ea71a7 --- /dev/null +++ b/edge/engine/reference/commandline/image_ls.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_image_ls +title: docker image ls +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/image_prune.md b/edge/engine/reference/commandline/image_prune.md new file mode 100644 index 00000000000..f388da717b0 --- /dev/null +++ b/edge/engine/reference/commandline/image_prune.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_image_prune +title: docker image prune +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/image_pull.md b/edge/engine/reference/commandline/image_pull.md new file mode 100644 index 00000000000..9bfc80bc7a7 --- /dev/null +++ b/edge/engine/reference/commandline/image_pull.md @@ -0,0 +1,19 @@ +--- +datafolder: engine-cli-edge +datafile: docker_image_pull +title: docker image pull +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} + diff --git a/edge/engine/reference/commandline/image_push.md b/edge/engine/reference/commandline/image_push.md new file mode 100644 index 00000000000..bc2af6f6ad0 --- /dev/null +++ b/edge/engine/reference/commandline/image_push.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_image_push +title: docker image push +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/image_rm.md b/edge/engine/reference/commandline/image_rm.md new file mode 100644 index 00000000000..21b931b0f6f --- /dev/null +++ b/edge/engine/reference/commandline/image_rm.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_image_rm +title: docker image rm +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/image_save.md b/edge/engine/reference/commandline/image_save.md new file mode 100644 index 00000000000..f1df140a949 --- /dev/null +++ b/edge/engine/reference/commandline/image_save.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_image_save +title: docker image save +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/image_tag.md b/edge/engine/reference/commandline/image_tag.md new file mode 100644 index 00000000000..3d3eba1ae96 --- /dev/null +++ b/edge/engine/reference/commandline/image_tag.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_image_tag +title: docker image tag +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/images.md b/edge/engine/reference/commandline/images.md new file mode 100644 index 00000000000..93876de842d --- /dev/null +++ b/edge/engine/reference/commandline/images.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_images +title: docker images +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/import.md b/edge/engine/reference/commandline/import.md new file mode 100644 index 00000000000..91a997c77af --- /dev/null +++ b/edge/engine/reference/commandline/import.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_import +title: docker import +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/info.md b/edge/engine/reference/commandline/info.md new file mode 100644 index 00000000000..67b759ed03e --- /dev/null +++ b/edge/engine/reference/commandline/info.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_info +title: docker info +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/inspect.md b/edge/engine/reference/commandline/inspect.md new file mode 100644 index 00000000000..5ec5e307f85 --- /dev/null +++ b/edge/engine/reference/commandline/inspect.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_inspect +title: docker inspect +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/kill.md b/edge/engine/reference/commandline/kill.md new file mode 100644 index 00000000000..94cc50ef04b --- /dev/null +++ b/edge/engine/reference/commandline/kill.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_kill +title: docker kill +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/load.md b/edge/engine/reference/commandline/load.md new file mode 100644 index 00000000000..dd8fe3c2714 --- /dev/null +++ b/edge/engine/reference/commandline/load.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_load +title: docker load +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/login.md b/edge/engine/reference/commandline/login.md new file mode 100644 index 00000000000..b8ec4bd8734 --- /dev/null +++ b/edge/engine/reference/commandline/login.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_login +title: docker login +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/logout.md b/edge/engine/reference/commandline/logout.md new file mode 100644 index 00000000000..97aee6be203 --- /dev/null +++ b/edge/engine/reference/commandline/logout.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_logout +title: docker logout +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/logs.md b/edge/engine/reference/commandline/logs.md new file mode 100644 index 00000000000..13257d55200 --- /dev/null +++ b/edge/engine/reference/commandline/logs.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_logs +title: docker logs +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/network.md b/edge/engine/reference/commandline/network.md new file mode 100644 index 00000000000..4121775f540 --- /dev/null +++ b/edge/engine/reference/commandline/network.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_network +title: docker network +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/network_connect.md b/edge/engine/reference/commandline/network_connect.md new file mode 100644 index 00000000000..707d81afa27 --- /dev/null +++ b/edge/engine/reference/commandline/network_connect.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_network_connect +title: docker network connect +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/network_create.md b/edge/engine/reference/commandline/network_create.md new file mode 100644 index 00000000000..a9f5634a90b --- /dev/null +++ b/edge/engine/reference/commandline/network_create.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_network_create +title: docker network create +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/network_disconnect.md b/edge/engine/reference/commandline/network_disconnect.md new file mode 100644 index 00000000000..8b631a967c0 --- /dev/null +++ b/edge/engine/reference/commandline/network_disconnect.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_network_disconnect +title: docker network disconnect +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/network_inspect.md b/edge/engine/reference/commandline/network_inspect.md new file mode 100644 index 00000000000..04ef37075bd --- /dev/null +++ b/edge/engine/reference/commandline/network_inspect.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_network_inspect +title: docker network inspect +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/network_ls.md b/edge/engine/reference/commandline/network_ls.md new file mode 100644 index 00000000000..2fd4142df0b --- /dev/null +++ b/edge/engine/reference/commandline/network_ls.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_network_ls +title: docker network ls +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/network_prune.md b/edge/engine/reference/commandline/network_prune.md new file mode 100644 index 00000000000..62b8a269f18 --- /dev/null +++ b/edge/engine/reference/commandline/network_prune.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_network_prune +title: docker network prune +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/network_rm.md b/edge/engine/reference/commandline/network_rm.md new file mode 100644 index 00000000000..9c16b38308c --- /dev/null +++ b/edge/engine/reference/commandline/network_rm.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_network_rm +title: docker network rm +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/node.md b/edge/engine/reference/commandline/node.md new file mode 100644 index 00000000000..cecef718e6a --- /dev/null +++ b/edge/engine/reference/commandline/node.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_node +title: docker node +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/node_demote.md b/edge/engine/reference/commandline/node_demote.md new file mode 100644 index 00000000000..cf964f8aa62 --- /dev/null +++ b/edge/engine/reference/commandline/node_demote.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_node_demote +title: docker node demote +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/node_inspect.md b/edge/engine/reference/commandline/node_inspect.md new file mode 100644 index 00000000000..a53dac0271e --- /dev/null +++ b/edge/engine/reference/commandline/node_inspect.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_node_inspect +title: docker node inspect +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/node_ls.md b/edge/engine/reference/commandline/node_ls.md new file mode 100644 index 00000000000..d77a390e8e3 --- /dev/null +++ b/edge/engine/reference/commandline/node_ls.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_node_ls +title: docker node ls +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/node_promote.md b/edge/engine/reference/commandline/node_promote.md new file mode 100644 index 00000000000..5342ec200b8 --- /dev/null +++ b/edge/engine/reference/commandline/node_promote.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_node_promote +title: docker node promote +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/node_ps.md b/edge/engine/reference/commandline/node_ps.md new file mode 100644 index 00000000000..f8521d659a1 --- /dev/null +++ b/edge/engine/reference/commandline/node_ps.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_node_ps +title: docker node ps +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/node_rm.md b/edge/engine/reference/commandline/node_rm.md new file mode 100644 index 00000000000..4ff47bf29d3 --- /dev/null +++ b/edge/engine/reference/commandline/node_rm.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_node_rm +title: docker node rm +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/node_update.md b/edge/engine/reference/commandline/node_update.md new file mode 100644 index 00000000000..8657f0061b4 --- /dev/null +++ b/edge/engine/reference/commandline/node_update.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_node_update +title: docker node update +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/pause.md b/edge/engine/reference/commandline/pause.md new file mode 100644 index 00000000000..fdbf28efeb7 --- /dev/null +++ b/edge/engine/reference/commandline/pause.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_pause +title: docker pause +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/plugin.md b/edge/engine/reference/commandline/plugin.md new file mode 100644 index 00000000000..c013a7d3b4f --- /dev/null +++ b/edge/engine/reference/commandline/plugin.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_plugin +title: docker plugin +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/plugin_create.md b/edge/engine/reference/commandline/plugin_create.md new file mode 100644 index 00000000000..709fe5ace76 --- /dev/null +++ b/edge/engine/reference/commandline/plugin_create.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_plugin_create +title: docker plugin create +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/plugin_disable.md b/edge/engine/reference/commandline/plugin_disable.md new file mode 100644 index 00000000000..f5327b3e39f --- /dev/null +++ b/edge/engine/reference/commandline/plugin_disable.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_plugin_disable +title: docker plugin disable +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/plugin_enable.md b/edge/engine/reference/commandline/plugin_enable.md new file mode 100644 index 00000000000..1c7a622c7a4 --- /dev/null +++ b/edge/engine/reference/commandline/plugin_enable.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_plugin_enable +title: docker plugin enable +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/plugin_inspect.md b/edge/engine/reference/commandline/plugin_inspect.md new file mode 100644 index 00000000000..8117f10ac72 --- /dev/null +++ b/edge/engine/reference/commandline/plugin_inspect.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_plugin_inspect +title: docker plugin inspect +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/plugin_install.md b/edge/engine/reference/commandline/plugin_install.md new file mode 100644 index 00000000000..c47d4d7a2a2 --- /dev/null +++ b/edge/engine/reference/commandline/plugin_install.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_plugin_install +title: docker plugin install +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/plugin_ls.md b/edge/engine/reference/commandline/plugin_ls.md new file mode 100644 index 00000000000..7ca7eebac01 --- /dev/null +++ b/edge/engine/reference/commandline/plugin_ls.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_plugin_ls +title: docker plugin ls +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/plugin_push.md b/edge/engine/reference/commandline/plugin_push.md new file mode 100644 index 00000000000..e8acdf9e625 --- /dev/null +++ b/edge/engine/reference/commandline/plugin_push.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_plugin_push +title: docker plugin push +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/plugin_rm.md b/edge/engine/reference/commandline/plugin_rm.md new file mode 100644 index 00000000000..0c4f947b77b --- /dev/null +++ b/edge/engine/reference/commandline/plugin_rm.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_plugin_rm +title: docker plugin rm +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/plugin_set.md b/edge/engine/reference/commandline/plugin_set.md new file mode 100644 index 00000000000..9da3b252e70 --- /dev/null +++ b/edge/engine/reference/commandline/plugin_set.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_plugin_set +title: docker plugin set +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/plugin_upgrade.md b/edge/engine/reference/commandline/plugin_upgrade.md new file mode 100644 index 00000000000..aa80b62c977 --- /dev/null +++ b/edge/engine/reference/commandline/plugin_upgrade.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_plugin_upgrade +title: docker plugin upgrade +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/port.md b/edge/engine/reference/commandline/port.md new file mode 100644 index 00000000000..dd82deeef88 --- /dev/null +++ b/edge/engine/reference/commandline/port.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_port +title: docker port +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/ps.md b/edge/engine/reference/commandline/ps.md new file mode 100644 index 00000000000..b0b7032a7b4 --- /dev/null +++ b/edge/engine/reference/commandline/ps.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_ps +title: docker ps +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/pull.md b/edge/engine/reference/commandline/pull.md new file mode 100644 index 00000000000..c0658ef1229 --- /dev/null +++ b/edge/engine/reference/commandline/pull.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_pull +title: docker pull +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/push.md b/edge/engine/reference/commandline/push.md new file mode 100644 index 00000000000..3bf0f9078bd --- /dev/null +++ b/edge/engine/reference/commandline/push.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_push +title: docker push +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/rename.md b/edge/engine/reference/commandline/rename.md new file mode 100644 index 00000000000..7a85e5ecbfa --- /dev/null +++ b/edge/engine/reference/commandline/rename.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_rename +title: docker rename +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/restart.md b/edge/engine/reference/commandline/restart.md new file mode 100644 index 00000000000..e60d69512ed --- /dev/null +++ b/edge/engine/reference/commandline/restart.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_restart +title: docker restart +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/rm.md b/edge/engine/reference/commandline/rm.md new file mode 100644 index 00000000000..a69a14b64e6 --- /dev/null +++ b/edge/engine/reference/commandline/rm.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_rm +title: docker rm +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/rmi.md b/edge/engine/reference/commandline/rmi.md new file mode 100644 index 00000000000..a14c3234620 --- /dev/null +++ b/edge/engine/reference/commandline/rmi.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_rmi +title: docker rmi +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/run.md b/edge/engine/reference/commandline/run.md new file mode 100644 index 00000000000..8041f8d8d89 --- /dev/null +++ b/edge/engine/reference/commandline/run.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_run +title: docker run +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/save.md b/edge/engine/reference/commandline/save.md new file mode 100644 index 00000000000..4f77ed16687 --- /dev/null +++ b/edge/engine/reference/commandline/save.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_save +title: docker save +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/search.md b/edge/engine/reference/commandline/search.md new file mode 100644 index 00000000000..2a0138b4e8d --- /dev/null +++ b/edge/engine/reference/commandline/search.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_search +title: docker search +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/secret.md b/edge/engine/reference/commandline/secret.md new file mode 100644 index 00000000000..d81a0d8ebe1 --- /dev/null +++ b/edge/engine/reference/commandline/secret.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_secret +title: docker secret +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/secret_create.md b/edge/engine/reference/commandline/secret_create.md new file mode 100644 index 00000000000..f71476e36b4 --- /dev/null +++ b/edge/engine/reference/commandline/secret_create.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_secret_create +title: docker secret create +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/secret_inspect.md b/edge/engine/reference/commandline/secret_inspect.md new file mode 100644 index 00000000000..e512d5d5160 --- /dev/null +++ b/edge/engine/reference/commandline/secret_inspect.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_secret_inspect +title: docker secret inspect +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/secret_ls.md b/edge/engine/reference/commandline/secret_ls.md new file mode 100644 index 00000000000..2920fa85363 --- /dev/null +++ b/edge/engine/reference/commandline/secret_ls.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_secret_ls +title: docker secret ls +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/secret_rm.md b/edge/engine/reference/commandline/secret_rm.md new file mode 100644 index 00000000000..29f41422702 --- /dev/null +++ b/edge/engine/reference/commandline/secret_rm.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_secret_rm +title: docker secret rm +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/service.md b/edge/engine/reference/commandline/service.md new file mode 100644 index 00000000000..e9115a99cc5 --- /dev/null +++ b/edge/engine/reference/commandline/service.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_service +title: docker service +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/service_create.md b/edge/engine/reference/commandline/service_create.md new file mode 100644 index 00000000000..e4a3e7607af --- /dev/null +++ b/edge/engine/reference/commandline/service_create.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_service_create +title: docker service create +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/service_inspect.md b/edge/engine/reference/commandline/service_inspect.md new file mode 100644 index 00000000000..ac19676b14b --- /dev/null +++ b/edge/engine/reference/commandline/service_inspect.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_service_inspect +title: docker service inspect +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/service_logs.md b/edge/engine/reference/commandline/service_logs.md new file mode 100644 index 00000000000..e2d36e5772b --- /dev/null +++ b/edge/engine/reference/commandline/service_logs.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_service_logs +title: docker service logs +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/service_ls.md b/edge/engine/reference/commandline/service_ls.md new file mode 100644 index 00000000000..f7d651e1b31 --- /dev/null +++ b/edge/engine/reference/commandline/service_ls.md @@ -0,0 +1,16 @@ +--- +datafolder: engine-cli-edge +datafile: docker_service_ls +title: docker service ls +--- + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/service_ps.md b/edge/engine/reference/commandline/service_ps.md new file mode 100644 index 00000000000..faa041288b5 --- /dev/null +++ b/edge/engine/reference/commandline/service_ps.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_service_ps +title: docker service ps +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/service_rm.md b/edge/engine/reference/commandline/service_rm.md new file mode 100644 index 00000000000..ea485017c8f --- /dev/null +++ b/edge/engine/reference/commandline/service_rm.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_service_rm +title: docker service rm +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/service_scale.md b/edge/engine/reference/commandline/service_scale.md new file mode 100644 index 00000000000..5d3c0d82f94 --- /dev/null +++ b/edge/engine/reference/commandline/service_scale.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_service_scale +title: docker service scale +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/service_update.md b/edge/engine/reference/commandline/service_update.md new file mode 100644 index 00000000000..fa1bc4825f6 --- /dev/null +++ b/edge/engine/reference/commandline/service_update.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_service_update +title: docker service update +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/stack.md b/edge/engine/reference/commandline/stack.md new file mode 100644 index 00000000000..e2e01ae89f7 --- /dev/null +++ b/edge/engine/reference/commandline/stack.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_stack +title: docker stack +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/stack_deploy.md b/edge/engine/reference/commandline/stack_deploy.md new file mode 100644 index 00000000000..f388feada84 --- /dev/null +++ b/edge/engine/reference/commandline/stack_deploy.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_stack_deploy +title: docker stack deploy +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/stack_ls.md b/edge/engine/reference/commandline/stack_ls.md new file mode 100644 index 00000000000..cb8ae2e0a04 --- /dev/null +++ b/edge/engine/reference/commandline/stack_ls.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_stack_ls +title: docker stack ls +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/stack_ps.md b/edge/engine/reference/commandline/stack_ps.md new file mode 100644 index 00000000000..1c2541b5dbd --- /dev/null +++ b/edge/engine/reference/commandline/stack_ps.md @@ -0,0 +1,20 @@ +--- +datafolder: engine-cli-edge +datafile: docker_stack_ps +title: docker stack ps +redirect_from: +- /engine/reference/commandline/stack_tasks/ +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/stack_rm.md b/edge/engine/reference/commandline/stack_rm.md new file mode 100644 index 00000000000..89a7ec170eb --- /dev/null +++ b/edge/engine/reference/commandline/stack_rm.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_stack_rm +title: docker stack rm +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/stack_services.md b/edge/engine/reference/commandline/stack_services.md new file mode 100644 index 00000000000..6f7cd88ee00 --- /dev/null +++ b/edge/engine/reference/commandline/stack_services.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_stack_services +title: docker stack services +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/start.md b/edge/engine/reference/commandline/start.md new file mode 100644 index 00000000000..1d7fa1951ec --- /dev/null +++ b/edge/engine/reference/commandline/start.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_start +title: docker start +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/stats.md b/edge/engine/reference/commandline/stats.md new file mode 100644 index 00000000000..a2f33980de2 --- /dev/null +++ b/edge/engine/reference/commandline/stats.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_stats +title: docker stats +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/stop.md b/edge/engine/reference/commandline/stop.md new file mode 100644 index 00000000000..74b6bc4a7bf --- /dev/null +++ b/edge/engine/reference/commandline/stop.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_stop +title: docker stop +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/swarm.md b/edge/engine/reference/commandline/swarm.md new file mode 100644 index 00000000000..e7a34e3e854 --- /dev/null +++ b/edge/engine/reference/commandline/swarm.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_swarm +title: docker swarm +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/swarm_init.md b/edge/engine/reference/commandline/swarm_init.md new file mode 100644 index 00000000000..8fb32e5c810 --- /dev/null +++ b/edge/engine/reference/commandline/swarm_init.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_swarm_init +title: docker swarm init +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/swarm_join-token.md b/edge/engine/reference/commandline/swarm_join-token.md new file mode 100644 index 00000000000..41de6960cf0 --- /dev/null +++ b/edge/engine/reference/commandline/swarm_join-token.md @@ -0,0 +1,20 @@ +--- +datafolder: engine-cli-edge +datafile: docker_swarm_join-token +title: docker swarm join-token +redirect_from: +- /engine/reference/commandline/swarm_join_token/ +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/swarm_join.md b/edge/engine/reference/commandline/swarm_join.md new file mode 100644 index 00000000000..25c5d935c06 --- /dev/null +++ b/edge/engine/reference/commandline/swarm_join.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_swarm_join +title: docker swarm join +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/swarm_leave.md b/edge/engine/reference/commandline/swarm_leave.md new file mode 100644 index 00000000000..78aa2a0318b --- /dev/null +++ b/edge/engine/reference/commandline/swarm_leave.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_swarm_leave +title: docker swarm leave +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/swarm_unlock-key.md b/edge/engine/reference/commandline/swarm_unlock-key.md new file mode 100644 index 00000000000..da554a3ff32 --- /dev/null +++ b/edge/engine/reference/commandline/swarm_unlock-key.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_swarm_unlock-key +title: docker swarm unlock-key +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/swarm_unlock.md b/edge/engine/reference/commandline/swarm_unlock.md new file mode 100644 index 00000000000..8dab475b982 --- /dev/null +++ b/edge/engine/reference/commandline/swarm_unlock.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_swarm_unlock +title: docker swarm unlock +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/swarm_update.md b/edge/engine/reference/commandline/swarm_update.md new file mode 100644 index 00000000000..1f215d5b5d1 --- /dev/null +++ b/edge/engine/reference/commandline/swarm_update.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_swarm_update +title: docker swarm update +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/system.md b/edge/engine/reference/commandline/system.md new file mode 100644 index 00000000000..b29a917b9af --- /dev/null +++ b/edge/engine/reference/commandline/system.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_system +title: docker system +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/system_df.md b/edge/engine/reference/commandline/system_df.md new file mode 100644 index 00000000000..de616aad8eb --- /dev/null +++ b/edge/engine/reference/commandline/system_df.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_system_df +title: docker system df +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/system_events.md b/edge/engine/reference/commandline/system_events.md new file mode 100644 index 00000000000..06d615dda57 --- /dev/null +++ b/edge/engine/reference/commandline/system_events.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_system_events +title: docker system events +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/system_info.md b/edge/engine/reference/commandline/system_info.md new file mode 100644 index 00000000000..565a38ef50b --- /dev/null +++ b/edge/engine/reference/commandline/system_info.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_system_info +title: docker system info +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/system_prune.md b/edge/engine/reference/commandline/system_prune.md new file mode 100644 index 00000000000..48c9a5e35b5 --- /dev/null +++ b/edge/engine/reference/commandline/system_prune.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_system_prune +title: docker system prune +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/tag.md b/edge/engine/reference/commandline/tag.md new file mode 100644 index 00000000000..0f2876cf5f7 --- /dev/null +++ b/edge/engine/reference/commandline/tag.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_tag +title: docker tag +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/top.md b/edge/engine/reference/commandline/top.md new file mode 100644 index 00000000000..646f33fc95b --- /dev/null +++ b/edge/engine/reference/commandline/top.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_top +title: docker top +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/unpause.md b/edge/engine/reference/commandline/unpause.md new file mode 100644 index 00000000000..d43fd2fa006 --- /dev/null +++ b/edge/engine/reference/commandline/unpause.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_unpause +title: docker unpause +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/update.md b/edge/engine/reference/commandline/update.md new file mode 100644 index 00000000000..e76af43a011 --- /dev/null +++ b/edge/engine/reference/commandline/update.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_update +title: docker update +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/version.md b/edge/engine/reference/commandline/version.md new file mode 100644 index 00000000000..3b84c6fdb6e --- /dev/null +++ b/edge/engine/reference/commandline/version.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_version +title: docker version +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/volume.md b/edge/engine/reference/commandline/volume.md new file mode 100644 index 00000000000..d1d1df2b94b --- /dev/null +++ b/edge/engine/reference/commandline/volume.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_volume +title: docker volume +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/volume_create.md b/edge/engine/reference/commandline/volume_create.md new file mode 100644 index 00000000000..19ee4e152b5 --- /dev/null +++ b/edge/engine/reference/commandline/volume_create.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_volume_create +title: docker volume create +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/volume_inspect.md b/edge/engine/reference/commandline/volume_inspect.md new file mode 100644 index 00000000000..b87a6dba29d --- /dev/null +++ b/edge/engine/reference/commandline/volume_inspect.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_volume_inspect +title: docker volume inspect +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/volume_ls.md b/edge/engine/reference/commandline/volume_ls.md new file mode 100644 index 00000000000..bb7b4d9ee75 --- /dev/null +++ b/edge/engine/reference/commandline/volume_ls.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_volume_ls +title: docker volume ls +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/volume_prune.md b/edge/engine/reference/commandline/volume_prune.md new file mode 100644 index 00000000000..ffcb7dbcd84 --- /dev/null +++ b/edge/engine/reference/commandline/volume_prune.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_volume_prune +title: docker volume prune +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/volume_rm.md b/edge/engine/reference/commandline/volume_rm.md new file mode 100644 index 00000000000..6a8d4cff846 --- /dev/null +++ b/edge/engine/reference/commandline/volume_rm.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_volume_rm +title: docker volume rm +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/engine/reference/commandline/wait.md b/edge/engine/reference/commandline/wait.md new file mode 100644 index 00000000000..165c1f508e8 --- /dev/null +++ b/edge/engine/reference/commandline/wait.md @@ -0,0 +1,18 @@ +--- +datafolder: engine-cli-edge +datafile: docker_wait +title: docker wait +--- + + + +{% if page.datafolder contains '-edge' %} + {% include edge_only.md section="cliref" %} +{% endif %} +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/edge/index.md b/edge/index.md new file mode 100644 index 00000000000..0f7a4d803db --- /dev/null +++ b/edge/index.md @@ -0,0 +1,189 @@ +--- +title: Docker CE Edge documentation +description: Information about current Docker Edge releases +keywords: engine, edge, installation +current_edge: 17.04 +--- + +The current Docker CE Edge release is {{ page.current_edge }}. The Docker CE +Edge channel provides monthly releases which allow you to try new features of +Docker and verify bug fixes quickly. Edge releases are only supported for one +month, and a given Edge release will not receive any updates once a new edge +release is available. + +Stable releases are not published to the Edge channel, so Linux repository users +still need to subscribe to the stable channel as well. + +Commercial support is not available for Docker CE. + +For information about all Docker release channels and expectations about +support, see [Docker channels](/engine/installation/#docker-channels). + +This page lists features that are only available in Docker CE Edge releases. +Where applicable, the API and CLI reference documentation has been updated to +reflect these features, but **full documentation for a given feature may not be +available until a Docker CE Stable release incorporates the feature**. + +### Docker CE Edge new features + + +
    +
    + +#### Docker CE Edge 17.04 + +The following major features and changes are included in Docker CE Edge 17.04. +Continue reading, or go straight to [API and CLI](#api-and-cli), +[Daemon](#daemon), [Dockerfile](#dockerfile), [Services](#services), or +[Stacks](#stacks). + +[Read the full release notes](https://github.com/docker/docker/releases/tag/v17.04.0-ce){: target="_blank" class="_" } + +##### API and CLI + +- Add [version 1.28](/edge/engine/reference/api/v1.28/) of the Docker API. + +- Add `--device-cgroup-rule` flag to give containers access to devices that appear + after the container is started. {% include github-pr.md pr="22563" %} + +- Allow swarm nodes to join with `--availability=drain` to prevent them from + taking non-manager workloads. {% include github-pr.md pr="24993" %} + +- Add `publish` and `expose` filters to `docker ps`, so that containers can be + filtered by port or port range for TCP or UDP protocols {% include github-pr.md pr="27557" %} + +- Add `--no-trunc` and `--format` flags to the `docker service ls` command, and + as well as the ability to specify the default format for `docker service ls` + using the `ServicesFormat` option to the Docker CLI. Also add a + `docker stack services` command. {% include github-pr.md pr="28199" %} + +- Add ability to filter plugins by whether they are enabled or disabled in + `docker plugin ls` output. {% include github-pr.md pr="28627" %} + +- Add `mode` option to `--log-opts` flag for both `docker` and `dockerd`. If set + to `non-blocking`, and the log buffer fills up, log messages will be lost, but + the container will not block. The `max-buffer-size` option controls the + maximum size of the ring buffer. Defaults to `blocking`, which will cause the + container to block if messages cannot be logged. See + [Options for all drivers](/engine/admin/logging/overview.md#options-for-all-drivers). + {% include github-pr.md pr="28762" %} + +- It is no longer possible to inadvertently pull images on an architecture where + they will not run. {% include github-pr.md pr="29001" %} + +- It is now possible to create AWS log groups when using the AWS logging driver. + See [`awslogs-create-group`](engine/admin/logging/awslogs.md#awslogs-create-group). + {% include github-pr.md pr="29504" %} + +- Add the ability to filter `docker network ls` output by creation time, using + the `{% raw %}{{CreatedAt}}{% endraw %}` format specifier. + {% include github-pr.md pr="29900" %} + +- Named but untagged images are now removed if you run `docker image prune` if + `--dangling-only` is set to `true`. {% include github-pr.md pr="30330" %} + +- Add `--add-host` flag to `docker build`, which will add entries to the + `/etc/hosts` file of a container created from that image. The `/etc/hosts` + file is not saved within the image itself. {% include github-pr.md pr="30383" %} + +- Prevent `docker network ls` from pulling all the endpoints, to reduce + impact on the network. {% include github-pr.md pr="30673" %} + +- Windows-specific commands and options no longer show in command help text on + non-Windows clients. {% include github-pr.md pr="30780" %} + +- When you specify an IP address when running `docker network connect`, the + IP address is now checked for validity. {% include github-pr.md pr="30807" %} + +- Add the ability to customize bind-mount consistency to be more appropriate + for some platforms and workloads. Options are `consistent` (the default), + `cached`, or `delegated`. {% include github-pr.md pr="31047" %} + +##### Daemon + +- Docker Daemon logging settings no longer affect the `docker build` command. + {% include github-pr.md pr="29552" %} + +- Add a `registry-mirrors` configuration option for the Docker daemon, which + replaces the daemon's registry mirrors with a new set of registry mirrors. + {% include github-pr.md pr="29650" %} + +- Add the ability to specify the default shared memory size for the Docker + daemon, using the `--default-shm-size` or the `default-shm-size` key in + `daemon.json`. {% include github-pr.md pr="29692" %} + +- Add a `no-new-privileges` configuration option for the Docker daemon, which + prevents unprivileged containers from gaining new privileges. + {% include github-pr.md pr="29984" %} + +- If a Docker client communicates with an older daemon and attempts to perform + an operation not supported by the daemon, an error is printed, which shows + the API versions of both the client and daemon. + {% include github-pr.md pr="30187" %} + +- The Docker daemon no longer depends upon `sqlite`. This change means that it + is not possible to upgrade the Docker daemon from version 1.9 directly to the + latest version. It is recommended to upgrade from one major version to the + next, in sequence. {% include github-pr.md pr="30208" %} + +##### Dockerfile + +- Using the pattern `**/` in a Dockerfile now (correctly) behaves the same as + `**`. {% include github-pr.md pr="29043" %} + +- Time values less than 1 second are no longer allowed in health-check options + in the Dockerfile. {% include github-pr.md pr="31177" %} + +##### Services + +- When a service is updated with both `--secret-add` and `--secret-rm` in the + same operation, the order of operations is now changed so that the + `--secret-rm` always occurs first. {% include github-pr.md pr="29802" %} + +- Add the ability to create or update a service to be read-only using the + `--read-only` flag. {% include github-pr.md pr="30162" %} + +- Docker now updates swarm nodes if the swarm configuration is updated. + {% include github-pr.md pr="30259" %} + +- Add topology-aware placement preferences for Swarm services. This feature + allows services to be balanced over nodes based on a particular user-defined + property, such as which datacenter or rack they are located in. + See [Control service scale and placement](/engine/swarm/services.md#control-service-scale-and-placement). + {% include github-pr.md pr="30725" %} + +- Add the ability to customize the stop signal which will be sent to nodes, when + creating or updating a service. {% include github-pr.md pr="30754" %} + +- Add the ability to address a secret by name or prefix, as well as ID, when + updating it. {% include github-pr.md pr="30856" %} + +- Add the ability to roll back to a previous version of a service if an + updated service fails to deploy. Several flags are available at service + creation or update,to control the rollback action, failure threshold, + monitoring delay, rollback delay, and parallelism. + {% include github-pr.md pr="31108" %} + +- Add the ability to specify the stream when using the Docker service logs API. + {% include github-pr.md pr="31313" %} + +- Add `--tail` and `--since` flags to `docker service logs` command, to filter + the logs by time or to show the tail of the logs and show new content as it + is logged. {% include github-pr.md pr="31500" %} + +- Add a `--verbose` flag to the `docker inspect` command. For swarm networks, + this flag shows all nodes and services attached to the network. + {% include github-pr.md pr="31710" %} + +##### Stacks + +- Compose file version 3.2 is now supported. This includes support for different + types of endpoints and expands the options you can use when specifying mounts. + {% include github-pr.md pr="31795" %} + +
    + +
    diff --git a/engine/admin/logging/awslogs.md b/engine/admin/logging/awslogs.md index f95d425a758..c768b90416d 100644 --- a/engine/admin/logging/awslogs.md +++ b/engine/admin/logging/awslogs.md @@ -58,9 +58,10 @@ specified, the container ID is used as the log stream. > at a time. Using the same log stream for multiple containers concurrently > can cause reduced logging performance. -{% if site.edge == true %} ### awslogs-create-group +{% include edge_only.md section="option" %} + Log driver will return an error by default if the log group does not exist. However, you can set the `awslogs-create-group` to `true` to automatically create the log group as needed. The `awslogs-create-group` option defaults to `false`. @@ -76,7 +77,6 @@ $ docker run --log-driver=awslogs \ > **Note:** > Your AWS IAM policy must include the `logs:CreateLogGroup` permission before you attempt to use `awslogs-create-group`. -{% endif %} ### tag diff --git a/engine/admin/logging/overview.md b/engine/admin/logging/overview.md index 91a5872404e..dddd5e7b6d0 100644 --- a/engine/admin/logging/overview.md +++ b/engine/admin/logging/overview.md @@ -123,13 +123,14 @@ This example starts an `alpine` container with the `none` log driver. $ docker run -it --log-driver none alpine ash ``` -{% if site.edge == true %} ### Options for all drivers + +{% include edge_only.md section="options" %} + | Option | Description | Example value | |-------------------|-------------|---------------| | `mode` | Sets the logging mode, accepted values are `blocking` (default), and `non-blocking`. When `non-blocking` is set, if the log buffer fills up, log messages will be lost. How messages are dropped is left undefined. | `--log-opt mode=non-blocking` | `max-buffer-size` | Applicable only when `mode` is set to `non-blocking`, this sets the maxmimum size of the log buffer. Once this size is reach, log messages will be dropped. | `--log-opt max-buffer-size 5m` -{% endif %} ## `json-file` diff --git a/engine/api/get-started.md b/engine/api/get-started.md new file mode 100644 index 00000000000..c88f22c26dd --- /dev/null +++ b/engine/api/get-started.md @@ -0,0 +1,698 @@ +--- +title: Get started with the Docker API +keywords: developing, api, sdk, developers, rest, curl, python, go +redirect_from: +- /engine/api/getting-started.md +--- + +After you +[install Docker](/engine/installation.md), you can try out the Docker API. + +Optionally, install an SDK for the language you are using. Official SDKs are +available for Python and Go, and a number of community maintained +libraries for other languages. + +[Learn more about installing and using Docker SDKs](sdks.md). + +These examples show how to perform the same operation using Python, Go, or +by using `curl` directly. + +## Versioned API + +The Python and Go examples used here do not specify the API version to use, +because they use features that have been part of Docker for a long time. The +Docker API is fully backward compatible. + +To see the highest version of the API your Docker daemon and client support, use +`docker version`: + +```bash +$ docker version + +Client: + Version: 17.04.0-ce + API version: 1.28 + Go version: go1.7.5 + Git commit: 4845c56 + Built: Wed Apr 5 06:06:36 2017 + OS/Arch: darwin/amd64 + +Server: + Version: 17.04.0-ce + API version: 1.28 (minimum version 1.12) + Go version: go1.7.5 + Git commit: 4845c56 + Built: Tue Apr 4 00:37:25 2017 + OS/Arch: linux/amd64 + Experimental: true +``` + +You can specify the API version to use, in one of the following ways: + +- When using `curl` directly, specify the version as the first part of the URL. + For instance, if the endpoint is `/containers/`, you can use + `/v1.27/containers/`. + +- For the SDKs, or to force the Docker CLI to use a specific version of the API, + set the environment variable `DOCKER_API_VERSION` to the correct version. + This works on Linux, Windows, or macOS clients. + + ```bash + DOCKER_API_VERSION='1.27' + ``` + + While the environment variable is set, that version of the API is used, even + if the Docker daemon supports a newer version. + +- For the SDKs, you can also specify the API version programmatically, as a + parameter to the `client` object. See the + [Go constructor](https://github.com/docker/docker/blob/master/client/client.go#L136){: target="_blank" class="_"} + or the + [Python SDK documentation for `client`](https://docker-py.readthedocs.io/en/stable/client.html). + +## API Examples + +### Run a container + +This first example shows how to run a container using the Docker API. On the +command line, you would use the `docker run` command, but this is just as easy +to do from your own apps too. + +This is the equivalent of typing `docker run alpine echo hello world` at the +command prompt: + + + +
    +
    + +```python +import docker +client = docker.from_env() +print client.containers.run("alpine", ["echo", "hello", "world"]) +``` + +
    + +
    + +```go +package main + +import ( + "io" + "os" + + "github.com/docker/engine-api/client" + "github.com/docker/engine-api/types" + "github.com/docker/engine-api/types/container" + "golang.org/x/net/context" +) + +func main() { + ctx := context.Background() + cli, err := client.NewEnvClient() + if err != nil { + panic(err) + } + + _, err = cli.ImagePull(ctx, "alpine", types.ImagePullOptions{}) + if err != nil { + panic(err) + } + + resp, err := cli.ContainerCreate(ctx, &container.Config{ + Image: "alpine", + Cmd: []string{"echo", "hello world"}, + }, nil, nil, "") + if err != nil { + panic(err) + } + + if err := cli.ContainerStart(ctx, resp.ID, types.ContainerStartOptions{}); err != nil { + panic(err) + } + + if _, err = cli.ContainerWait(ctx, resp.ID); err != nil { + panic(err) + } + + out, err := cli.ContainerLogs(ctx, resp.ID, types.ContainerLogsOptions{ShowStdout: true}) + if err != nil { + panic(err) + } + + io.Copy(os.Stdout, out) +} +``` + +
    + +
    + +```bash +$ curl --unix-socket /var/run/docker.sock -H "Content-Type: application/json" \ + -d '{"Image": "alpine", "Cmd": ["echo", "hello world"]}' \ + -X POST http:/v1.24/containers/create +{"Id":"1c6594faf5","Warnings":null} + +$ curl --unix-socket /var/run/docker.sock -X POST http:/v1.24/containers/1c6594faf5/start + +$ curl --unix-socket /var/run/docker.sock -X POST http:/v1.24/containers/1c6594faf5/wait +{"StatusCode":0} + +$ curl --unix-socket /var/run/docker.sock "http:/v1.24/containers/1c6594faf5/logs?stdout=1" +hello world +``` + +
    +
    + +### Run a container in the background + +You can also run containers in the background, the equivalent of typing +`docker run -d bfirsh/reticulate-splines`: + + + +
    +
    + +```python +import docker +client = docker.from_env() +container = client.containers.run("bfirsh/reticulate-splines", detach=True) +print container.id +``` + +
    + +
    + +```go +package main + +import ( + "fmt" + "io" + "os" + + "github.com/docker/docker/api/types" + "github.com/docker/docker/api/types/container" + "github.com/docker/docker/client" + "golang.org/x/net/context" +) + +func main() { + ctx := context.Background() + cli, err := client.NewEnvClient() + if err != nil { + panic(err) + } + + imageName := "bfirsh/reticulate-splines" + + out, err := cli.ImagePull(ctx, imageName, types.ImagePullOptions{}) + if err != nil { + panic(err) + } + io.Copy(os.Stdout, out) + + resp, err := cli.ContainerCreate(ctx, &container.Config{ + Image: imageName, + }, nil, nil, "") + if err != nil { + panic(err) + } + + if err := cli.ContainerStart(ctx, resp.ID, types.ContainerStartOptions{}); err != nil { + panic(err) + } + + fmt.Println(resp.ID) +} +``` + +
    + +
    + +```bash +$ curl --unix-socket /var/run/docker.sock -H "Content-Type: application/json" \ + -d '{"Image": "bfirsh/reticulate-splines"}' \ + -X POST http:/v1.24/containers/create +{"Id":"1c6594faf5","Warnings":null} + +$ curl --unix-socket /var/run/docker.sock -X POST http:/v1.24/containers/1c6594faf5/start +``` + +
    +
    + +### List and manage containers + +You can use the API to list containers that are running, just like using +`docker ps`: + + + +
    +
    + +```python +import docker +client = docker.from_env() +for container in client.containers.list(): + print container.id +``` + +
    + +
    + +```go +package main + +import ( + "context" + "fmt" + + "github.com/docker/docker/api/types" + "github.com/docker/docker/client" +) + +func main() { + cli, err := client.NewEnvClient() + if err != nil { + panic(err) + } + + containers, err := cli.ContainerList(context.Background(), types.ContainerListOptions{}) + if err != nil { + panic(err) + } + + for _, container := range containers { + fmt.Println(container.ID) + } +} +``` + +
    + +
    + +```bash +$ curl --unix-socket /var/run/docker.sock http:/v1.24/containers/json +[{ + "Id":"ae63e8b89a26f01f6b4b2c9a7817c31a1b6196acf560f66586fbc8809ffcd772", + "Names":["/tender_wing"], + "Image":"bfirsh/reticulate-splines", + ... +}] +``` + +
    +
    + +### Stop all running containers + +Now that you know what containers exist, you can perform operations on them. For +example, to stop all running containers: + + + +
    +
    + +```python +import docker +client = docker.from_env() +for container in client.containers.list(): + container.stop() +``` + +
    + +
    + +```go +package main + +import ( + "context" + + "github.com/docker/docker/api/types" + "github.com/docker/docker/client" +) + +func main() { + ctx := context.Background() + cli, err := client.NewEnvClient() + if err != nil { + panic(err) + } + + containers, err := cli.ContainerList(ctx, types.ContainerListOptions{}) + if err != nil { + panic(err) + } + + for _, container := range containers { + if err := cli.ContainerStop(ctx, container.ID, nil); err != nil { + panic(err) + } + } +} +``` + +
    + +
    + +```bash +$ curl --unix-socket /var/run/docker.sock http:/v1.24/containers/json +[{ + "Id":"ae63e8b89a26f01f6b4b2c9a7817c31a1b6196acf560f66586fbc8809ffcd772", + "Names":["/tender_wing"], + "Image":"bfirsh/reticulate-splines", + ... +}] + +$ curl --unix-socket /var/run/docker.sock \ + -X POST http:/v1.24/containers/ae63e8b89a26/stop +``` + +
    +
    + +### Print the logs of a specific container + +You can also perform actions on individual containers. This example prints the +logs of a container given its ID: + + + +
    +
    + +```python +import docker +client = docker.from_env() +container = client.containers.get('f1064a8a4c82') +print container.logs() +``` + +
    +
    + +```go +package main + +import ( + "context" + "io" + "os" + + "github.com/docker/docker/api/types" + "github.com/docker/docker/client" +) + +func main() { + ctx := context.Background() + cli, err := client.NewEnvClient() + if err != nil { + panic(err) + } + + options := types.ContainerLogsOptions{ShowStdout: true} + out, err := cli.ContainerLogs(ctx, "f1064a8a4c82", options) + if err != nil { + panic(err) + } + + io.Copy(os.Stdout, out) +} +``` + +
    + +
    + +```bash +$ curl --unix-socket /var/run/docker.sock "http:/v1.24/containers/ca5f55cdb/logs?stdout=1" +Reticulating spline 1... +Reticulating spline 2... +Reticulating spline 3... +Reticulating spline 4... +Reticulating spline 5... +``` +
    +
    + +### List all images + +List the images on your Engine, similar to `docker images`: + + + +
    +
    + +```python +import docker +client = docker.from_env() +for image in client.images.list(): + print image.id +``` + +
    + +
    + +```go +package main + +import ( + "context" + "fmt" + + "github.com/docker/docker/api/types" + "github.com/docker/docker/client" +) + +func main() { + cli, err := client.NewEnvClient() + if err != nil { + panic(err) + } + + images, err := cli.ImageList(context.Background(), types.ImageListOptions{}) + if err != nil { + panic(err) + } + + for _, image := range images { + fmt.Println(image.ID) + } +} +``` + +
    + +
    + +```bash +$ curl --unix-socket /var/run/docker.sock http:/v1.24/images/json +[{ + "Id":"sha256:31d9a31e1dd803470c5a151b8919ef1988ac3efd44281ac59d43ad623f275dcd", + "ParentId":"sha256:ee4603260daafe1a8c2f3b78fd760922918ab2441cbb2853ed5c439e59c52f96", + ... +}] +``` + +
    +
    + +### Pull images + +Pull images, like `docker pull`: + + + +
    +
    + +```python +import docker +client = docker.from_env() +image = client.images.pull("alpine") +print image.id +``` + +
    + +
    + +```go +package main + +import ( + "io" + "os" + + "github.com/docker/docker/api/types" + "github.com/docker/docker/client" + "golang.org/x/net/context" +) + +func main() { + ctx := context.Background() + cli, err := client.NewEnvClient() + if err != nil { + panic(err) + } + + out, err := cli.ImagePull(ctx, "alpine", types.ImagePullOptions{}) + if err != nil { + panic(err) + } + + io.Copy(os.Stdout, out) +} +``` + +
    + +
    + +```bash +$ curl --unix-socket /var/run/docker.sock \ + -X POST "http:/v1.24/images/create?fromImage=alpine" +{"status":"Pulling from library/alpine","id":"3.1"} +{"status":"Pulling fs layer","progressDetail":{},"id":"8f13703509f7"} +{"status":"Downloading","progressDetail":{"current":32768,"total":2244027},"progress":"[\u003e ] 32.77 kB/2.244 MB","id":"8f13703509f7"} +... +``` + +
    +
    + +### Commit containers + +Commit containers to create images from their contents: + + + +
    +
    + +```python +import docker +client = docker.from_env() +container = client.run("alpine", ["touch", "/helloworld"], detached=True) +container.wait() +image = container.commit("helloworld") +print image.id +``` + +
    + +
    + +```go +package main + +import ( + "fmt" + + "github.com/docker/docker/api/types" + "github.com/docker/docker/api/types/container" + "github.com/docker/docker/client" + "golang.org/x/net/context" +) + +func main() { + ctx := context.Background() + cli, err := client.NewEnvClient() + if err != nil { + panic(err) + } + + createResp, err := cli.ContainerCreate(ctx, &container.Config{ + Image: "alpine", + Cmd: []string{"touch", "/helloworld"}, + }, nil, nil, "") + if err != nil { + panic(err) + } + + if err := cli.ContainerStart(ctx, createResp.ID, types.ContainerStartOptions{}); err != nil { + panic(err) + } + + if _, err = cli.ContainerWait(ctx, createResp.ID); err != nil { + panic(err) + } + + commitResp, err := cli.ContainerCommit(ctx, createResp.ID, types.ContainerCommitOptions{Reference: "helloworld"}) + if err != nil { + panic(err) + } + + fmt.Println(commitResp.ID) +} +``` + +
    + +
    + +```bash +$ docker run -d alpine touch /helloworld +0888269a9d584f0fa8fc96b3c0d8d57969ceea3a64acf47cd34eebb4744dbc52 +$ curl --unix-socket /var/run/docker.sock\ + -X POST "http:/v1.24/commit?container=0888269a9d&repo=helloworld" +{"Id":"sha256:6c86a5cd4b87f2771648ce619e319f3e508394b5bfc2cdbd2d60f59d52acda6c"} +``` + +
    +
    + +## Next steps + + - [Full documentation for the Python SDK](https://docker-py.readthedocs.io) + - [Full documentation for the Go SDK](https://godoc.org/github.com/docker/docker/client) + - [Full documentation for the HTTP API](/engine/api/v1.27/) diff --git a/engine/api/getting-started.md b/engine/api/getting-started.md deleted file mode 100644 index 1860bf1c3d6..00000000000 --- a/engine/api/getting-started.md +++ /dev/null @@ -1,547 +0,0 @@ ---- -title: Getting started with the Engine API ---- - -To try out the Docker Engine API in development, [you first need to install Docker](/engine/installation.md). - -Next, you need to install an SDK for the language you are using. There are official ones available for Python and Go, and a number of community maintained libraries for other languages. [Head to the SDKs page to find and install them.](sdks.md) - -## Running a container - -The most basic thing you can do with Docker is running a container. On the command line, you would use the `docker run` command, but this is just as easy to do from your own apps too. - -This is the equivalent of doing `docker run alpine echo hello world`: - -
    -
    Python
    -
    Go
    -
    curl
    -
    -
    -
    -{% highlight python %} -import docker -client = docker.from_env() -print client.containers.run("alpine", ["echo", "hello", "world"]) -{% endhighlight %} -
    -
    -{% highlight go %} -package main - -import ( - "io" - "os" - - "github.com/docker/engine-api/client" - "github.com/docker/engine-api/types" - "github.com/docker/engine-api/types/container" - "golang.org/x/net/context" -) - -func main() { - ctx := context.Background() - cli, err := client.NewEnvClient() - if err != nil { - panic(err) - } - - _, err = cli.ImagePull(ctx, "alpine", types.ImagePullOptions{}) - if err != nil { - panic(err) - } - - resp, err := cli.ContainerCreate(ctx, &container.Config{ - Image: "alpine", - Cmd: []string{"echo", "hello world"}, - }, nil, nil, "") - if err != nil { - panic(err) - } - - if err := cli.ContainerStart(ctx, resp.ID, types.ContainerStartOptions{}); err != nil { - panic(err) - } - - if _, err = cli.ContainerWait(ctx, resp.ID); err != nil { - panic(err) - } - - out, err := cli.ContainerLogs(ctx, resp.ID, types.ContainerLogsOptions{ShowStdout: true}) - if err != nil { - panic(err) - } - - io.Copy(os.Stdout, out) -} -{% endhighlight %} -
    -
    -{% highlight bash %} -$ curl --unix-socket /var/run/docker.sock -H "Content-Type: application/json" \ - -d '{"Image": "alpine", "Cmd": ["echo", "hello world"]}' \ - -X POST http:/v1.24/containers/create -{"Id":"1c6594faf5","Warnings":null} - -$ curl --unix-socket /var/run/docker.sock -X POST http:/v1.24/containers/1c6594faf5/start - -$ curl --unix-socket /var/run/docker.sock -X POST http:/v1.24/containers/1c6594faf5/wait -{"StatusCode":0} - -$ curl --unix-socket /var/run/docker.sock "http:/v1.24/containers/1c6594faf5/logs?stdout=1" -hello world -{% endhighlight %} -
    -
    - -You can also run containers in the background, the equivalent of `docker run -d bfirsh/reticulate-splines`: - -
    -
    Python
    -
    Go
    -
    curl
    -
    -
    -
    -{% highlight python %} -import docker -client = docker.from_env() -container = client.containers.run("bfirsh/reticulate-splines", detach=True) -print container.id -{% endhighlight %} -
    -
    -{% highlight go %} -package main - -import ( - "fmt" - "io" - "os" - - "github.com/docker/docker/api/types" - "github.com/docker/docker/api/types/container" - "github.com/docker/docker/client" - "golang.org/x/net/context" -) - -func main() { - ctx := context.Background() - cli, err := client.NewEnvClient() - if err != nil { - panic(err) - } - - imageName := "bfirsh/reticulate-splines" - - out, err := cli.ImagePull(ctx, imageName, types.ImagePullOptions{}) - if err != nil { - panic(err) - } - io.Copy(os.Stdout, out) - - resp, err := cli.ContainerCreate(ctx, &container.Config{ - Image: imageName, - }, nil, nil, "") - if err != nil { - panic(err) - } - - if err := cli.ContainerStart(ctx, resp.ID, types.ContainerStartOptions{}); err != nil { - panic(err) - } - - fmt.Println(resp.ID) -} -{% endhighlight %} -
    -
    -{% highlight bash %} -$ curl --unix-socket /var/run/docker.sock -H "Content-Type: application/json" \ - -d '{"Image": "bfirsh/reticulate-splines"}' \ - -X POST http:/v1.24/containers/create -{"Id":"1c6594faf5","Warnings":null} - -$ curl --unix-socket /var/run/docker.sock -X POST http:/v1.24/containers/1c6594faf5/start -{% endhighlight %} -
    -
    - -## Listing and managing containers - -Like `docker ps`, we can use the API to list containers that are running: - -
    -
    Python
    -
    Go
    -
    curl
    -
    -
    -
    -{% highlight python %} -import docker -client = docker.from_env() -for container in client.containers.list(): - print container.id -{% endhighlight %} -
    -
    -{% highlight go %} -package main - -import ( - "context" - "fmt" - - "github.com/docker/docker/api/types" - "github.com/docker/docker/client" -) - -func main() { - cli, err := client.NewEnvClient() - if err != nil { - panic(err) - } - - containers, err := cli.ContainerList(context.Background(), types.ContainerListOptions{}) - if err != nil { - panic(err) - } - - for _, container := range containers { - fmt.Println(container.ID) - } -} -{% endhighlight %} -
    -
    -{% highlight bash %} -$ curl --unix-socket /var/run/docker.sock http:/v1.24/containers/json -[{ - "Id":"ae63e8b89a26f01f6b4b2c9a7817c31a1b6196acf560f66586fbc8809ffcd772", - "Names":["/tender_wing"], - "Image":"bfirsh/reticulate-splines", - ... -}] - -{% endhighlight %} -
    -
    - -Now we know what containers exist, we can perform operations on them. For example, we can stop all running containers: - -
    -
    Python
    -
    Go
    -
    curl
    -
    -
    -
    -{% highlight python %} -import docker -client = docker.from_env() -for container in client.containers.list(): - container.stop() -{% endhighlight %} -
    -
    -{% highlight go %} -package main - -import ( - "context" - - "github.com/docker/docker/api/types" - "github.com/docker/docker/client" -) - -func main() { - ctx := context.Background() - cli, err := client.NewEnvClient() - if err != nil { - panic(err) - } - - containers, err := cli.ContainerList(ctx, types.ContainerListOptions{}) - if err != nil { - panic(err) - } - - for _, container := range containers { - if err := cli.ContainerStop(ctx, container.ID, nil); err != nil { - panic(err) - } - } -} -{% endhighlight %} -
    -
    -{% highlight bash %} -$ curl --unix-socket /var/run/docker.sock http:/v1.24/containers/json -[{ - "Id":"ae63e8b89a26f01f6b4b2c9a7817c31a1b6196acf560f66586fbc8809ffcd772", - "Names":["/tender_wing"], - "Image":"bfirsh/reticulate-splines", - ... -}] - -$ curl --unix-socket /var/run/docker.sock \ - -X POST http:/v1.24/containers/ae63e8b89a26/stop - -{% endhighlight %} -
    -
    - -We can also perform actions on individual containers. For example, to print the logs of a container given its ID: - -
    -
    Python
    -
    Go
    -
    curl
    -
    -
    -
    -{% highlight python %} -import docker -client = docker.from_env() -container = client.containers.get('f1064a8a4c82') -print container.logs() -{% endhighlight %} -
    -
    -{% highlight go %} -package main - -import ( - "context" - "io" - "os" - - "github.com/docker/docker/api/types" - "github.com/docker/docker/client" -) - -func main() { - ctx := context.Background() - cli, err := client.NewEnvClient() - if err != nil { - panic(err) - } - - options := types.ContainerLogsOptions{ShowStdout: true} - out, err := cli.ContainerLogs(ctx, "f1064a8a4c82", options) - if err != nil { - panic(err) - } - - io.Copy(os.Stdout, out) -} -{% endhighlight %} -
    -
    -{% highlight bash %} -$ curl --unix-socket /var/run/docker.sock "http:/v1.24/containers/ca5f55cdb/logs?stdout=1" -Reticulating spline 1... -Reticulating spline 2... -Reticulating spline 3... -Reticulating spline 4... -Reticulating spline 5... -{% endhighlight %} -
    -
    - -## Managing images - -Images are the basis of containers, and can be managed in a similar way. You can list the images on your Engine, similar to `docker images`: - -
    -
    Python
    -
    Go
    -
    curl
    -
    -
    -
    -{% highlight python %} -import docker -client = docker.from_env() -for image in client.images.list(): - print image.id -{% endhighlight %} -
    -
    -{% highlight go %} -package main - -import ( - "context" - "fmt" - - "github.com/docker/docker/api/types" - "github.com/docker/docker/client" -) - -func main() { - cli, err := client.NewEnvClient() - if err != nil { - panic(err) - } - - images, err := cli.ImageList(context.Background(), types.ImageListOptions{}) - if err != nil { - panic(err) - } - - for _, image := range images { - fmt.Println(image.ID) - } -} -{% endhighlight %} -
    -
    -{% highlight bash %} -$ curl --unix-socket /var/run/docker.sock http:/v1.24/images/json -[{ - "Id":"sha256:31d9a31e1dd803470c5a151b8919ef1988ac3efd44281ac59d43ad623f275dcd", - "ParentId":"sha256:ee4603260daafe1a8c2f3b78fd760922918ab2441cbb2853ed5c439e59c52f96", - ... -}] -{% endhighlight %} -
    -
    - -You can pull images, like `docker pull`: - -
    -
    Python
    -
    Go
    -
    curl
    -
    -
    -
    -{% highlight python %} -import docker -client = docker.from_env() -image = client.images.pull("alpine") -print image.id -{% endhighlight %} -
    -
    -{% highlight go %} -package main - -import ( - "io" - "os" - - "github.com/docker/docker/api/types" - "github.com/docker/docker/client" - "golang.org/x/net/context" -) - -func main() { - ctx := context.Background() - cli, err := client.NewEnvClient() - if err != nil { - panic(err) - } - - out, err := cli.ImagePull(ctx, "alpine", types.ImagePullOptions{}) - if err != nil { - panic(err) - } - - io.Copy(os.Stdout, out) -} -{% endhighlight %} -
    -
    -{% highlight bash %} -$ curl --unix-socket /var/run/docker.sock \ - -X POST "http:/v1.24/images/create?fromImage=alpine" -{"status":"Pulling from library/alpine","id":"3.1"} -{"status":"Pulling fs layer","progressDetail":{},"id":"8f13703509f7"} -{"status":"Downloading","progressDetail":{"current":32768,"total":2244027},"progress":"[\u003e ] 32.77 kB/2.244 MB","id":"8f13703509f7"} -... -{% endhighlight %} -
    -
    - -And commit containers to create images from their contents: - -
    -
    Python
    -
    Go
    -
    curl
    -
    -
    -
    -{% highlight python %} -import docker -client = docker.from_env() -container = client.run("alpine", ["touch", "/helloworld"], detached=True) -container.wait() -image = container.commit("helloworld") -print image.id -{% endhighlight %} -
    -
    -{% highlight go %} -package main - -import ( - "fmt" - - "github.com/docker/docker/api/types" - "github.com/docker/docker/api/types/container" - "github.com/docker/docker/client" - "golang.org/x/net/context" -) - -func main() { - ctx := context.Background() - cli, err := client.NewEnvClient() - if err != nil { - panic(err) - } - - createResp, err := cli.ContainerCreate(ctx, &container.Config{ - Image: "alpine", - Cmd: []string{"touch", "/helloworld"}, - }, nil, nil, "") - if err != nil { - panic(err) - } - - if err := cli.ContainerStart(ctx, createResp.ID, types.ContainerStartOptions{}); err != nil { - panic(err) - } - - if _, err = cli.ContainerWait(ctx, createResp.ID); err != nil { - panic(err) - } - - commitResp, err := cli.ContainerCommit(ctx, createResp.ID, types.ContainerCommitOptions{Reference: "helloworld"}) - if err != nil { - panic(err) - } - - fmt.Println(commitResp.ID) -} -{% endhighlight %} -
    -
    -{% highlight bash %} -$ docker run -d alpine touch /helloworld -0888269a9d584f0fa8fc96b3c0d8d57969ceea3a64acf47cd34eebb4744dbc52 -$ curl --unix-socket /var/run/docker.sock\ - -X POST "http:/v1.24/commit?container=0888269a9d&repo=helloworld" -{"Id":"sha256:6c86a5cd4b87f2771648ce619e319f3e508394b5bfc2cdbd2d60f59d52acda6c"} -{% endhighlight %} -
    -
    - -## Next steps - - - [Full documentation for the Python SDK](https://docker-py.readthedocs.io) - - [Full documentation for the Go SDK](https://godoc.org/github.com/docker/docker/client) - - [Full documentation for the HTTP API](/engine/api/v1.27/) diff --git a/engine/api/index.md b/engine/api/index.md index 87332b5fc14..5afb485be0e 100644 --- a/engine/api/index.md +++ b/engine/api/index.md @@ -7,9 +7,13 @@ redirect_from: - /reference/api/docker_remote_api/ --- -The Engine API is the API served by Docker Engine. It allows you to control every aspect of Docker from within your own applications, build tools to manage and monitor applications running on Docker, and even use it to build apps on Docker itself. +The Engine API is the API served by Docker Engine. It allows you to control +every aspect of Docker from within your own applications, build tools to manage +and monitor applications running on Docker, and even use it to build apps on +Docker itself. -It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. For example: +It is the API the Docker client uses to communicate with the Engine, so +everything the Docker client can do can be done with the API. For example: * Running and managing containers * Managing Swarm nodes and services @@ -18,9 +22,44 @@ It is the API the Docker client uses to communicate with the Engine, so everythi * Pulling and managing images * Managing networks and volumes -The API can be accessed with any HTTP client, but we also provide [SDKs](sdks.md) in Python and Go to make it easier to use from programming languages. +The API can be accessed with any HTTP client, but we also provide +Python and Go [SDKs](sdks.md). -As an example, the `docker run` command can be easily implemented in various programming languages and by hitting the API directly with `curl`: +## Versioned API + +The version of the API you should use depends upon the version of your Docker +daemon. A new version of the API is released when new features are added. The +Docker API is backward-compatible, so you do not need to update code that uses +the API unless you need to take advantage of new features. + +To see the highest version of the API your Docker daemon and client support, use +`docker version`: + +```bash +$ docker version + +Client: + Version: 17.04.0-ce + API version: 1.28 + Go version: go1.7.5 + Git commit: 4845c56 + Built: Wed Apr 5 06:06:36 2017 + OS/Arch: darwin/amd64 + +Server: + Version: 17.04.0-ce + API version: 1.28 (minimum version 1.12) + Go version: go1.7.5 + Git commit: 4845c56 + Built: Tue Apr 4 00:37:25 2017 + OS/Arch: linux/amd64 + Experimental: true +``` + +## API example + +As an example, the `docker run` command can be easily implemented in various +programming languages and by hitting the API directly with `curl`: