diff --git a/_data/toc.yaml b/_data/toc.yaml index 71db1d60e0..72e013f2c5 100644 --- a/_data/toc.yaml +++ b/_data/toc.yaml @@ -1,6 +1,21 @@ -toc: -- title: Welcome to the Docs - path: / +horizontalnav: + - title: Guides + path: / + node: guides + - title: Product Manuals + path: /manuals/ + node: manuals + - title: Glossary + path: /glossary/ + node: glossary + - title: Reference + path: /reference/ + node: reference + - title: Samples + path: /samples/ + node: samples + +guides: - sectiontitle: Get Docker section: - path: /engine/installation/ @@ -123,6 +138,8 @@ toc: title: Known Issues - path: /toolbox/faqs/troubleshoot/ title: Troubleshooting + - path: /release-notes/ + title: Docker Release Notes - sectiontitle: Get Started section: - path: /learn/ @@ -165,700 +182,749 @@ toc: title: Network containers - path: /engine/tutorials/dockervolumes/ title: Manage data in containers - -- sectiontitle: Docker ID +- sectiontitle: User Guide section: - - path: /docker-id/ - title: Docker ID accounts - - path: /docker-id/api-reference/ - title: API Reference - -- sectiontitle: Docker Engine + - path: /engine/userguide/intro/ + title: Introduction + - sectiontitle: Work with images + section: + - path: /engine/userguide/eng-image/dockerfile_best-practices/ + title: Best practices for writing Dockerfiles + - path: /engine/userguide/eng-image/baseimages/ + title: Create a base image + - path: /engine/userguide/eng-image/image_management/ + title: Image management + - sectiontitle: Docker storage drivers + section: + - path: /engine/userguide/storagedriver/imagesandcontainers/ + title: Understand images, containers, and storage drivers + - path: /engine/userguide/storagedriver/selectadriver/ + title: Select a storage driver + - path: /engine/userguide/storagedriver/aufs-driver/ + title: AUFS storage driver in practice + - path: /engine/userguide/storagedriver/btrfs-driver/ + title: Btrfs storage in practice + - path: /engine/userguide/storagedriver/device-mapper-driver/ + title: Device mapper storage in practice + - path: /engine/userguide/storagedriver/overlayfs-driver/ + title: OverlayFS storage in practice + - path: /engine/userguide/storagedriver/zfs-driver/ + title: ZFS storage in practice + - sectiontitle: Network configuration + section: + - path: /engine/userguide/networking/ + title: Docker container networking + - path: /engine/userguide/networking/work-with-networks/ + title: Work with network commands + - path: /engine/userguide/networking/get-started-overlay/ + title: Get started with multi-host networking + - path: /engine/userguide/networking/get-started-macvlan/ + title: Get started with macvlan network driver + - path: /engine/userguide/networking/overlay-security-model/ + title: Swarm mode overlay network security model + - path: /engine/userguide/networking/configure-dns/ + title: Configure container DNS in user-defined networks + - sectiontitle: Default bridge network + section: + - path: /engine/userguide/networking/default_network/dockerlinks/ + title: Legacy container links + - path: /engine/userguide/networking/default_network/binding/ + title: Bind container ports to the host + - path: /engine/userguide/networking/default_network/build-bridges/ + title: Build your own bridge + - path: /engine/userguide/networking/default_network/configure-dns/ + title: Configure container DNS + - path: /engine/userguide/networking/default_network/custom-docker0/ + title: Customize the docker0 bridge + - path: /engine/userguide/networking/default_network/container-communication/ + title: Understand container communication + - path: /engine/userguide/networking/default_network/ipv6/ + title: IPv6 with Docker + - path: /engine/userguide/labels-custom-metadata/ + title: Apply custom metadata +- sectiontitle: Admin Guide section: - - sectiontitle: User Guide + - path: /engine/admin/ + title: Configuring and running Docker + - path: /engine/admin/host_integration/ + title: Automatically start containers + - path: /engine/admin/resource_constraints/ + title: Limit a container's resources + - path: /engine/admin/live-restore/ + title: Keep containers alive during daemon downtime + - path: /engine/admin/systemd/ + title: Control and configure Docker with systemd + - path: /engine/admin/formatting/ + title: Format command and log output + - path: /engine/admin/registry_mirror/ + title: Run a local registry mirror + - sectiontitle: Logging section: - - path: /engine/userguide/intro/ - title: Introduction - - sectiontitle: Work with images - section: - - path: /engine/userguide/eng-image/dockerfile_best-practices/ - title: Best practices for writing Dockerfiles - - path: /engine/userguide/eng-image/baseimages/ - title: Create a base image - - path: /engine/userguide/eng-image/image_management/ - title: Image management - - sectiontitle: Docker storage drivers - section: - - path: /engine/userguide/storagedriver/imagesandcontainers/ - title: Understand images, containers, and storage drivers - - path: /engine/userguide/storagedriver/selectadriver/ - title: Select a storage driver - - path: /engine/userguide/storagedriver/aufs-driver/ - title: AUFS storage driver in practice - - path: /engine/userguide/storagedriver/btrfs-driver/ - title: Btrfs storage in practice - - path: /engine/userguide/storagedriver/device-mapper-driver/ - title: Device mapper storage in practice - - path: /engine/userguide/storagedriver/overlayfs-driver/ - title: OverlayFS storage in practice - - path: /engine/userguide/storagedriver/zfs-driver/ - title: ZFS storage in practice - - sectiontitle: Network configuration - section: - - path: /engine/userguide/networking/ - title: Docker container networking - - path: /engine/userguide/networking/work-with-networks/ - title: Work with network commands - - path: /engine/userguide/networking/get-started-overlay/ - title: Get started with multi-host networking - - path: /engine/userguide/networking/get-started-macvlan/ - title: Get started with macvlan network driver - - path: /engine/userguide/networking/overlay-security-model/ - title: Swarm mode overlay network security model - - path: /engine/userguide/networking/configure-dns/ - title: Configure container DNS in user-defined networks - - sectiontitle: Default bridge network - section: - - path: /engine/userguide/networking/default_network/dockerlinks/ - title: Legacy container links - - path: /engine/userguide/networking/default_network/binding/ - title: Bind container ports to the host - - path: /engine/userguide/networking/default_network/build-bridges/ - title: Build your own bridge - - path: /engine/userguide/networking/default_network/configure-dns/ - title: Configure container DNS - - path: /engine/userguide/networking/default_network/custom-docker0/ - title: Customize the docker0 bridge - - path: /engine/userguide/networking/default_network/container-communication/ - title: Understand container communication - - path: /engine/userguide/networking/default_network/ipv6/ - title: IPv6 with Docker - - path: /engine/userguide/labels-custom-metadata/ - title: Apply custom metadata - - sectiontitle: Admin Guide + - path: /engine/admin/logging/view_container_logs/ + title: View a container's logs + - path: /engine/admin/logging/overview/ + title: Configuring Logging Drivers + - path: /engine/admin/logging/log_tags/ + title: Log tags for logging driver + - path: /engine/admin/logging/logentries/ + title: Logentries logging driver + - path: /engine/admin/logging/awslogs/ + title: Amazon CloudWatch Logs logging driver + - path: /engine/admin/logging/etwlogs/ + title: ETW logging driver + - path: /engine/admin/logging/fluentd/ + title: Fluentd logging driver + - path: /engine/admin/logging/gcplogs/ + title: Google Cloud Logging driver + - path: /engine/admin/logging/journald/ + title: Journald logging driver + - path: /engine/admin/logging/splunk/ + title: Splunk logging driver + - path: /engine/admin/dsc/ + title: PowerShell DSC Usage + - path: /engine/admin/ansible/ + title: Using Ansible + - path: /engine/admin/chef/ + title: Using Chef + - path: /engine/admin/puppet/ + title: Using Puppet + - path: /engine/admin/using_supervisord/ + title: Using Supervisor with Docker + - path: /engine/admin/runmetrics/ + title: Runtime metrics + - path: /engine/admin/ambassador_pattern_linking/ + title: Link via an ambassador container +- sectiontitle: Troubleshoot Docker Engine + section: + - path: /engine/admin/troubleshooting_volume_errors.md + title: Troubleshoot volume problems +- sectiontitle: Manage a swarm + section: + - path: /engine/swarm/ + title: Swarm mode overview + - path: /engine/swarm/key-concepts/ + title: Swarm mode key concepts + - sectiontitle: Get started with swarm mode section: - - path: /engine/admin/ - title: Configuring and running Docker - - path: /engine/admin/host_integration/ - title: Automatically start containers - - path: /engine/admin/resource_constraints/ - title: Limit a container's resources - - path: /engine/admin/live-restore/ - title: Keep containers alive during daemon downtime - - path: /engine/admin/systemd/ - title: Control and configure Docker with systemd - - path: /engine/admin/formatting/ - title: Format command and log output - - path: /engine/admin/registry_mirror/ - title: Run a local registry mirror - - sectiontitle: Logging + - path: /engine/swarm/swarm-tutorial/ + title: Set up for the tutorial + - path: /engine/swarm/swarm-tutorial/create-swarm/ + title: Create a swarm + - path: /engine/swarm/swarm-tutorial/add-nodes/ + title: Add nodes to the swarm + - path: /engine/swarm/swarm-tutorial/deploy-service/ + title: Deploy a service + - path: /engine/swarm/swarm-tutorial/inspect-service/ + title: Inspect the service + - path: /engine/swarm/swarm-tutorial/scale-service/ + title: Scale the service + - path: /engine/swarm/swarm-tutorial/delete-service/ + title: Delete the service + - path: /engine/swarm/swarm-tutorial/rolling-update/ + title: Apply rolling updates + - path: /engine/swarm/swarm-tutorial/drain-node/ + title: Drain a node + - path: /engine/swarm/ingress/ + title: Use swarm mode routing mesh + - sectiontitle: How swarm mode works + section: + - path: /engine/swarm/how-swarm-mode-works/nodes/ + title: How nodes work + - path: /engine/swarm/how-swarm-mode-works/services/ + title: How services work + - path: /engine/swarm/swarm-mode/ + title: Run Docker Engine in swarm mode + - path: /engine/swarm/join-nodes/ + title: Join nodes to a swarm + - path: /engine/swarm/manage-nodes/ + title: Manage nodes in a swarm + - path: /engine/swarm/services/ + title: Deploy services to a swarm + - path: /engine/swarm/secrets/ + title: Manage sensitive data with Docker secrets + - path: /engine/swarm/swarm_manager_locking.md + title: Lock your swarm + - path: /engine/swarm/networking/ + title: Attach services to an overlay network + - path: /engine/swarm/admin_guide/ + title: Swarm administration guide + - path: /engine/swarm/raft/ + title: Raft consensus in swarm mode +- sectiontitle: Secure Engine + section: + - path: /engine/security/security/ + title: Docker security + - path: /engine/security/non-events/ + title: Docker Security Non-events + - path: /engine/security/https/ + title: Protect the Docker daemon socket + - path: /engine/security/certificates/ + title: Using certificates for repository client verification + - sectiontitle: Use trusted images + section: + - path: /engine/security/trust/content_trust/ + title: Content trust in Docker + - path: /engine/security/trust/trust_automation/ + title: Automation with content trust + - path: /engine/security/trust/trust_delegation/ + title: Delegations for content trust + - path: /engine/security/trust/deploying_notary/ + title: Deploying Notary + - path: /engine/security/trust/trust_key_mng/ + title: Manage keys for content trust + - path: /engine/security/trust/trust_sandbox/ + title: Play in a content trust sandbox + - path: /engine/security/apparmor/ + title: AppArmor security profiles for Docker + - path: /engine/security/seccomp/ + title: Seccomp security profiles for Docker +- sectiontitle: Extend Engine + section: + - path: /engine/extend/ + title: Managed plugin system + - path: /engine/extend/plugins_authorization/ + title: Access authorization plugin + - path: /engine/extend/legacy_plugins/ + title: Extending Engine with plugins + - path: /engine/extend/plugins_network/ + title: Docker network driver plugins + - path: /engine/extend/plugins_volume/ + title: Volume plugins + - path: /engine/extend/plugin_api/ + title: Plugins API +- sectiontitle: Open Source at Docker + section: + - path: /opensource/code/ + title: Quickstart contribution + - sectiontitle: Set up for Engine Development + section: + - path: /opensource/project/who-written-for/ + title: README first + - path: /opensource/project/software-required/ + title: Get the required software + - path: /opensource/project/software-req-win/ + title: Set up for development on Windows + - path: /opensource/project/set-up-git/ + title: Configure Git for contributing + - path: /opensource/project/set-up-dev-env/ + title: Work with a development container + - path: /opensource/project/test-and-docs/ + title: Run tests and test documentation + - sectiontitle: Contribution workflow section: - - path: /engine/admin/logging/view_container_logs/ - title: View a container's logs - - path: /engine/admin/logging/overview/ - title: Configuring Logging Drivers - - path: /engine/admin/logging/log_tags/ - title: Log tags for logging driver - - path: /engine/admin/logging/logentries/ - title: Logentries logging driver - - path: /engine/admin/logging/awslogs/ - title: Amazon CloudWatch Logs logging driver - - path: /engine/admin/logging/etwlogs/ - title: ETW logging driver - - path: /engine/admin/logging/fluentd/ - title: Fluentd logging driver - - path: /engine/admin/logging/gcplogs/ - title: Google Cloud Logging driver - - path: /engine/admin/logging/journald/ - title: Journald logging driver - - path: /engine/admin/logging/splunk/ - title: Splunk logging driver - - path: /engine/admin/dsc/ - title: PowerShell DSC Usage - - path: /engine/admin/ansible/ - title: Using Ansible - - path: /engine/admin/chef/ - title: Using Chef - - path: /engine/admin/puppet/ - title: Using Puppet - - path: /engine/admin/using_supervisord/ - title: Using Supervisor with Docker - - path: /engine/admin/runmetrics/ - title: Runtime metrics - - path: /engine/admin/ambassador_pattern_linking/ - title: Link via an ambassador container - - sectiontitle: Troubleshoot Docker Engine - section: - - path: /engine/admin/troubleshooting_volume_errors/ - title: Troubleshoot volume problems - - sectiontitle: Manage a swarm - section: - - path: /engine/swarm/ - title: Swarm mode overview - - path: /engine/swarm/key-concepts/ - title: Swarm mode key concepts - - sectiontitle: Get started with swarm mode + - path: /opensource/workflow/make-a-contribution/ + title: Understand how to contribute + - path: /opensource/workflow/find-an-issue/ + title: Find and claim an issue + - path: /opensource/workflow/work-issue/ + title: Work on your issue + - path: /opensource/workflow/create-pr/ + title: Create a pull request (PR) + - path: /opensource/workflow/review-pr/ + title: Participate in the PR review + - path: /opensource/workflow/advanced-contributing/ + title: Advanced contributing + - path: /opensource/workflow/coding-style/ + title: Coding style checklist + - sectiontitle: Other ways to contribute section: - - path: /engine/swarm/swarm-tutorial/ - title: Set up for the tutorial - - path: /engine/swarm/swarm-tutorial/create-swarm/ - title: Create a swarm - - path: /engine/swarm/swarm-tutorial/add-nodes/ - title: Add nodes to the swarm - - path: /engine/swarm/swarm-tutorial/deploy-service/ - title: Deploy a service - - path: /engine/swarm/swarm-tutorial/inspect-service/ - title: Inspect the service - - path: /engine/swarm/swarm-tutorial/scale-service/ - title: Scale the service - - path: /engine/swarm/swarm-tutorial/delete-service/ - title: Delete the service - - path: /engine/swarm/swarm-tutorial/rolling-update/ - title: Apply rolling updates - - path: /engine/swarm/swarm-tutorial/drain-node/ - title: Drain a node - - path: /engine/swarm/ingress/ - title: Use swarm mode routing mesh - - sectiontitle: How swarm mode works + - path: /opensource/ways/meetups/ + title: Organize a Docker Meetup + - path: /opensource/ways/issues/ + title: Organize our issues + - path: /opensource/ways/community/ + title: Support the community + - path: /opensource/ways/test/ + title: Testing contributions + - sectiontitle: Contribute to Kitematic section: - - path: /engine/swarm/how-swarm-mode-works/nodes/ - title: How nodes work - - path: /engine/swarm/how-swarm-mode-works/services/ - title: How services work - - path: /engine/swarm/swarm-mode/ - title: Run Docker Engine in swarm mode - - path: /engine/swarm/join-nodes/ - title: Join nodes to a swarm - - path: /engine/swarm/manage-nodes/ - title: Manage nodes in a swarm - - path: /engine/swarm/services/ - title: Deploy services to a swarm - - path: /engine/swarm/secrets/ - title: Manage sensitive data with Docker secrets - - path: /engine/swarm/swarm_manager_locking/ - title: Lock your swarm - - path: /engine/swarm/networking/ - title: Attach services to an overlay network - - path: /engine/swarm/admin_guide/ - title: Swarm administration guide - - path: /engine/swarm/raft/ - title: Raft consensus in swarm mode - - sectiontitle: Secure Engine - section: - - path: /engine/security/security/ - title: Docker security - - path: /engine/security/non-events/ - title: Docker Security Non-events - - path: /engine/security/https/ - title: Protect the Docker daemon socket - - path: /engine/security/certificates/ - title: Using certificates for repository client verification - - sectiontitle: Use trusted images + - path: /opensource/kitematic/get_started/ + title: Get started + - path: /opensource/kitematic/find_issue/ + title: Find an issue + - path: /opensource/kitematic/set_up_dev/ + title: Set up for Kitematic development + - path: /opensource/kitematic/work_issue/ + title: Develop in Kitematic (work on an issue) + - path: /opensource/kitematic/create_pr/ + title: Create a pull request (PR) + - path: /opensource/kitematic/next_steps/ + title: Where to learn more + - sectiontitle: Governance section: - - path: /engine/security/trust/content_trust/ - title: Content trust in Docker - - path: /engine/security/trust/trust_automation/ - title: Automation with content trust - - path: /engine/security/trust/trust_delegation/ - title: Delegations for content trust - - path: /engine/security/trust/deploying_notary/ - title: Deploying Notary - - path: /engine/security/trust/trust_key_mng/ - title: Manage keys for content trust - - path: /engine/security/trust/trust_sandbox/ - title: Play in a content trust sandbox - - path: /engine/security/apparmor/ - title: AppArmor security profiles for Docker - - path: /engine/security/seccomp/ - title: Seccomp security profiles for Docker - - sectiontitle: Extend Engine - section: - - path: /engine/extend/ - title: Managed plugin system - - path: /engine/extend/plugins_authorization/ - title: Access authorization plugin - - path: /engine/extend/legacy_plugins/ - title: Extending Engine with plugins - - path: /engine/extend/plugins_network/ - title: Docker network driver plugins - - path: /engine/extend/plugins_volume/ - title: Volume plugins - - path: /engine/extend/plugin_api/ - title: Plugins API - - sectiontitle: Dockerize an application - section: - - path: /engine/examples/mongodb/ - title: Dockerizing MongoDB - - path: /engine/examples/postgresql_service/ - title: Dockerizing PostgreSQL - - path: /engine/examples/couchdb_data_volumes/ - title: Dockerizing a CouchDB service - - path: /engine/examples/couchbase/ - title: Dockerizing a Couchbase service - - path: /engine/examples/running_redis_service/ - title: Dockerizing a Redis service - - path: /engine/examples/running_riak_service/ - title: Dockerizing a Riak service - - path: /engine/examples/running_ssh_service/ - title: Dockerizing an SSH service - - path: /engine/examples/apt-cacher-ng/ - title: Dockerizing an apt-cacher-ng service - - path: /engine/reference/builder/ - title: Dockerfile reference + - path: /opensource/governance/dgab-info/ + title: Docker Governance Advisory Board + - path: /opensource/governance/board-profiles/ + title: Board member profiles + - path: /opensource/governance/conduct-code/ + title: Code of conduct + - path: /opensource/FAQ/ + title: FAQ for contributors + - path: /opensource/get-help/ + title: Where to chat or get help + - path: /opensource/doc-style/ + title: Style guide for Docker documentation +- sectiontitle: Docs archive + section: + - path: /docsarchive/ + title: View the docs archives + - path: /v1.4 + title: v1.4 + - path: /v1.5 + title: v1.5 + - path: /v1.6 + title: v1.6 + - path: /v1.7 + title: v1.7 + - path: /v1.8 + title: v1.8 + - path: /v1.9 + title: v1.9 + - path: /v1.10 + title: v1.10 + - path: /v1.11 + title: v1.11 + +reference: +- path: /engine/reference/builder/ + title: Dockerfile reference +- path: /compose/compose-file/ + title: Compose file reference +- sectiontitle: Engine (docker) CLI reference + section: - path: /engine/reference/run/ title: Docker run reference - path: /engine/reference/commandline/cli/ title: Use the Docker command line - - path: /engine/reference/commandline/dockerd/ - title: Daemon CLI reference (dockerd) - - sectiontitle: Engine CLI reference + - path: /engine/reference/commandline/docker/ + title: docker (base command) + - path: /engine/reference/commandline/attach/ + title: docker attach + - path: /engine/reference/commandline/build/ + title: docker build + - path: /engine/reference/commandline/commit/ + title: docker commit + - sectiontitle: docker container * section: - - path: /engine/reference/commandline/docker/ - title: docker (base command) - - path: /engine/reference/commandline/attach/ - title: docker attach - - path: /engine/reference/commandline/build/ - title: docker build - - sectiontitle: docker checkpoint * + - path: /engine/reference/commandline/container/ + title: docker container + - path: /engine/reference/commandline/container_attach/ + title: docker container attach + - path: /engine/reference/commandline/container_commit/ + title: docker container commit + - path: /engine/reference/commandline/container_cp/ + title: docker container cp + - path: /engine/reference/commandline/container_create/ + title: docker container create + - path: /engine/reference/commandline/container_diff/ + title: docker container diff + - path: /engine/reference/commandline/container_exec/ + title: docker container exec + - path: /engine/reference/commandline/container_export/ + title: docker container export + - path: /engine/reference/commandline/container_inspect/ + title: docker container inspect + - path: /engine/reference/commandline/container_kill/ + title: docker container kill + - path: /engine/reference/commandline/container_logs/ + title: docker container logs + - path: /engine/reference/commandline/container_ls/ + title: docker container ls + - path: /engine/reference/commandline/container_pause/ + title: docker container pause + - path: /engine/reference/commandline/container_port/ + title: docker container port + - path: /engine/reference/commandline/container_prune/ + title: docker container prune + - path: /engine/reference/commandline/container_rename/ + title: docker container rename + - path: /engine/reference/commandline/container_restart/ + title: docker container restart + - path: /engine/reference/commandline/container_rm/ + title: docker container rm + - path: /engine/reference/commandline/container_run/ + title: docker container run + - path: /engine/reference/commandline/container_start/ + title: docker container start + - path: /engine/reference/commandline/container_stats/ + title: docker container stats + - path: /engine/reference/commandline/container_stop/ + title: docker container stop + - path: /engine/reference/commandline/container_top/ + title: docker container top + - path: /engine/reference/commandline/container_unpause/ + title: docker container unpause + - path: /engine/reference/commandline/container_update/ + title: docker container update + - path: /engine/reference/commandline/container_wait/ + title: docker container wait + - path: /engine/reference/commandline/cp/ + title: docker cp + - path: /engine/reference/commandline/create/ + title: docker create + - path: /engine/reference/commandline/deploy/ + title: docker deploy + - path: /engine/reference/commandline/diff/ + title: docker diff + - path: /engine/reference/commandline/events/ + title: docker events + - path: /engine/reference/commandline/exec/ + title: docker exec + - path: /engine/reference/commandline/export/ + title: docker export + - path: /engine/reference/commandline/history/ + title: docker history + - sectiontitle: docker image * section: - - path: /engine/reference/commandline/checkpoint/ - title: docker checkpoint - - path: /engine/reference/commandline/checkpoint_create/ - title: docker checkpoint create - - path: /engine/reference/commandline/checkpoint_create/ - title: docker checkpoint create - - path: /engine/reference/commandline/checkpoint_ls/ - title: docker checkpoint ls - - path: /engine/reference/commandline/checkpoint_rm/ - title: docker checkpoint rm - - path: /engine/reference/commandline/commit/ - title: docker commit - - sectiontitle: docker container * - section: - - path: /engine/reference/commandline/container/ - title: docker container - - path: /engine/reference/commandline/container_attach/ - title: docker container attach - - path: /engine/reference/commandline/container_commit/ - title: docker container commit - - path: /engine/reference/commandline/container_cp/ - title: docker container cp - - path: /engine/reference/commandline/container_create/ - title: docker container create - - path: /engine/reference/commandline/container_diff/ - title: docker container diff - - path: /engine/reference/commandline/container_exec/ - title: docker container exec - - path: /engine/reference/commandline/container_export/ - title: docker container export - - path: /engine/reference/commandline/container_inspect/ - title: docker container inspect - - path: /engine/reference/commandline/container_kill/ - title: docker container kill - - path: /engine/reference/commandline/container_logs/ - title: docker container logs - - path: /engine/reference/commandline/container_ls/ - title: docker container ls - - path: /engine/reference/commandline/container_pause/ - title: docker container pause - - path: /engine/reference/commandline/container_port/ - title: docker container port - - path: /engine/reference/commandline/container_prune/ - title: docker container prune - - path: /engine/reference/commandline/container_rename/ - title: docker container rename - - path: /engine/reference/commandline/container_restart/ - title: docker container restart - - path: /engine/reference/commandline/container_rm/ - title: docker container rm - - path: /engine/reference/commandline/container_run/ - title: docker container run - - path: /engine/reference/commandline/container_start/ - title: docker container start - - path: /engine/reference/commandline/container_stats/ - title: docker container stats - - path: /engine/reference/commandline/container_stop/ - title: docker container stop - - path: /engine/reference/commandline/container_top/ - title: docker container top - - path: /engine/reference/commandline/container_unpause/ - title: docker container unpause - - path: /engine/reference/commandline/container_update/ - title: docker container update - - path: /engine/reference/commandline/container_wait/ - title: docker container wait - - path: /engine/reference/commandline/cp/ - title: docker cp - - path: /engine/reference/commandline/create/ - title: docker create - - path: /engine/reference/commandline/deploy/ - title: docker deploy - - path: /engine/reference/commandline/diff/ - title: docker diff - - path: /engine/reference/commandline/events/ - title: docker events - - path: /engine/reference/commandline/exec/ - title: docker exec - - path: /engine/reference/commandline/export/ - title: docker export - - path: /engine/reference/commandline/history/ - title: docker history - - sectiontitle: docker image * - section: - - path: /engine/reference/commandline/image/ - title: docker image - - path: /engine/reference/commandline/image_build/ - title: docker image build - - path: /engine/reference/commandline/image_history/ - title: docker image history - - path: /engine/reference/commandline/image_import/ - title: docker image import - - path: /engine/reference/commandline/image_inspect/ - title: docker image inspect - - path: /engine/reference/commandline/image_load/ - title: docker image load - - path: /engine/reference/commandline/image_ls/ - title: docker image ls - - path: /engine/reference/commandline/image_prune/ - title: docker image prune - - path: /engine/reference/commandline/image_pull/ - title: docker image pull - - path: /engine/reference/commandline/image_push/ - title: docker image push - - path: /engine/reference/commandline/image_rm/ - title: docker image rm - - path: /engine/reference/commandline/image_save/ - title: docker image save - - path: /engine/reference/commandline/image_tag/ - title: docker image tag - - path: /engine/reference/commandline/images/ - title: docker images - - path: /engine/reference/commandline/import/ - title: docker import - - path: /engine/reference/commandline/info/ - title: docker info - - path: /engine/reference/commandline/inspect/ - title: docker inspect - - path: /engine/reference/commandline/kill/ - title: docker kill - - path: /engine/reference/commandline/load/ - title: docker load - - path: /engine/reference/commandline/login/ - title: docker login - - path: /engine/reference/commandline/logout/ - title: docker logout - - path: /engine/reference/commandline/logs/ - title: docker logs - - sectiontitle: docker network * - section: - - path: /engine/reference/commandline/network/ - title: docker network - - path: /engine/reference/commandline/network_connect/ - title: docker network connect - - path: /engine/reference/commandline/network_create/ - title: docker network create - - path: /engine/reference/commandline/network_disconnect/ - title: docker network disconnect - - path: /engine/reference/commandline/network_inspect/ - title: docker network inspect - - path: /engine/reference/commandline/network_ls/ - title: docker network ls - - path: /engine/reference/commandline/network_prune/ - title: docker network prune - - path: /engine/reference/commandline/network_rm/ - title: docker network rm - - sectiontitle: docker node * - section: - - path: /engine/reference/commandline/node/ - title: docker node - - path: /engine/reference/commandline/node_demote/ - title: docker node demote - - path: /engine/reference/commandline/node_inspect/ - title: docker node inspect - - path: /engine/reference/commandline/node_ls/ - title: docker node ls - - path: /engine/reference/commandline/node_promote/ - title: docker node promote - - path: /engine/reference/commandline/node_ps/ - title: docker node ps - - path: /engine/reference/commandline/node_rm/ - title: docker node rm - - path: /engine/reference/commandline/node_update/ - title: docker node update - - path: /engine/reference/commandline/pause/ - title: docker pause - - sectiontitle: docker plugin * - section: - - path: /engine/reference/commandline/plugin/ - title: docker plugin - - path: /engine/reference/commandline/plugin_create/ - title: docker plugin disable - - path: /engine/reference/commandline/plugin_disable/ - title: docker plugin disable - - path: /engine/reference/commandline/plugin_enable/ - title: docker plugin enable - - path: /engine/reference/commandline/plugin_inspect/ - title: docker plugin inspect - - path: /engine/reference/commandline/plugin_install/ - title: docker plugin install - - path: /engine/reference/commandline/plugin_ls/ - title: docker plugin ls - - path: /engine/reference/commandline/plugin_rm/ - title: docker plugin rm - - path: /engine/reference/commandline/plugin_set/ - title: docker plugin set - - path: /engine/reference/commandline/port/ - title: docker port - - path: /engine/reference/commandline/ps/ - title: docker ps - - path: /engine/reference/commandline/pull/ - title: docker pull - - path: /engine/reference/commandline/push/ - title: docker push - - path: /engine/reference/commandline/rename/ - title: docker rename - - path: /engine/reference/commandline/restart/ - title: docker restart - - path: /engine/reference/commandline/rm/ - title: docker rm - - path: /engine/reference/commandline/rmi/ - title: docker rmi - - path: /engine/reference/commandline/run/ - title: docker run - - path: /engine/reference/commandline/save/ - title: docker save - - path: /engine/reference/commandline/search/ - title: docker search - - sectiontitle: docker secret * - section: - - path: /engine/reference/commandline/secret/ - title: docker secret - - path: /engine/reference/commandline/secret_create/ - title: docker secret create - - path: /engine/reference/commandline/secret_inspect/ - title: docker secret inspect - - path: /engine/reference/commandline/secret_ls/ - title: docker secret ls - - path: /engine/reference/commandline/secret_rm/ - title: docker secret rm - - sectiontitle: docker service * - section: - - path: /engine/reference/commandline/service/ - title: docker service - - path: /engine/reference/commandline/service_create/ - title: docker service create - - path: /engine/reference/commandline/service_inspect/ - title: docker service inspect - - path: /engine/reference/commandline/service_logs/ - title: docker service logs - - path: /engine/reference/commandline/service_ls/ - title: docker service ls - - path: /engine/reference/commandline/service_ps/ - title: docker service ps - - path: /engine/reference/commandline/service_rm/ - title: docker service rm - - path: /engine/reference/commandline/service_scale/ - title: docker service scale - - path: /engine/reference/commandline/service_update/ - title: docker service update - - sectiontitle: docker stack * - section: - - path: /engine/reference/commandline/stack/ - title: docker stack - - path: /engine/reference/commandline/stack_deploy/ - title: docker stack deploy - - path: /engine/reference/commandline/stack_ps/ - title: docker stack ps - - path: /engine/reference/commandline/stack_rm/ - title: docker stack rm - - path: /engine/reference/commandline/stack_services/ - title: docker stack services - - path: /engine/reference/commandline/start/ - title: docker start - - path: /engine/reference/commandline/stats/ - title: docker stats - - path: /engine/reference/commandline/stop/ - title: docker stop - - sectiontitle: docker swarm * - section: - - path: /engine/reference/commandline/swarm/ - title: docker swarm - - path: /engine/reference/commandline/swarm_init/ - title: docker swarm init - - path: /engine/reference/commandline/swarm_join-token/ - title: docker swarm join-token - - path: /engine/reference/commandline/swarm_join/ - title: docker swarm join - - path: /engine/reference/commandline/swarm_leave/ - title: docker swarm leave - - path: /engine/reference/commandline/swarm_unlock-key/ - title: docker swarm unlock-key - - path: /engine/reference/commandline/swarm_unlock/ - title: docker swarm unlock - - path: /engine/reference/commandline/swarm_update/ - title: docker swarm update - - sectiontitle: docker system * - section: - - path: /engine/reference/commandline/system/ - title: docker system - - path: /engine/reference/commandline/system_df/ - title: docker system df - - path: /engine/reference/commandline/system_events/ - title: docker system events - - path: /engine/reference/commandline/system_info/ - title: docker system info - - path: /engine/reference/commandline/system_prune/ - title: docker system prune - - path: /engine/reference/commandline/tag/ - title: docker tag - - path: /engine/reference/commandline/top/ - title: docker top - - path: /engine/reference/commandline/unpause/ - title: docker unpause - - path: /engine/reference/commandline/update/ - title: docker update - - path: /engine/reference/commandline/version/ - title: docker version - - sectiontitle: docker volume * - section: - - path: /engine/reference/commandline/volume_create/ - title: docker volume create - - path: /engine/reference/commandline/volume_inspect/ - title: docker volume inspect - - path: /engine/reference/commandline/volume_ls/ - title: docker volume ls - - path: /engine/reference/commandline/volume_prune/ - title: docker volume ls - - path: /engine/reference/commandline/volume_rm/ - title: docker volume rm - - path: /engine/reference/commandline/wait/ - title: docker wait - - sectiontitle: Engine API section: - - path: /engine/api/ - title: Overview - - path: /engine/api/getting-started/ - title: Getting started - - path: /engine/api/sdks/ - title: SDKs - - path: /engine/api/v1.25/ - title: Reference - - sectiontitle: Version history - section: - - path: /engine/api/version-history/ - title: Overview - - path: /engine/api/v1.24/ - title: v1.24 reference - - path: /engine/api/v1.23/ - title: v1.23 reference - - path: /engine/api/v1.22/ - title: v1.22 reference - - path: /engine/api/v1.21/ - title: v1.21 reference - - path: /engine/api/v1.20/ - title: v1.20 reference - - path: /engine/api/v1.19/ - title: v1.19 reference - - path: /engine/api/v1.18/ - title: v1.18 reference - - path: /engine/migration/ - title: Migrate to Engine 1.10 - - path: /engine/breaking_changes/ - title: Breaking changes - - path: /engine/deprecated/ - title: Deprecated Engine Features - - path: /engine/faq/ - title: FAQ -- sectiontitle: Docker Compose + - path: /engine/reference/commandline/image/ + title: docker image + - path: /engine/reference/commandline/image_build/ + title: docker image build + - path: /engine/reference/commandline/image_history/ + title: docker image history + - path: /engine/reference/commandline/image_import/ + title: docker image import + - path: /engine/reference/commandline/image_inspect/ + title: docker image inspect + - path: /engine/reference/commandline/image_load/ + title: docker image load + - path: /engine/reference/commandline/image_ls/ + title: docker image ls + - path: /engine/reference/commandline/image_prune/ + title: docker image prune + - path: /engine/reference/commandline/image_pull/ + title: docker image pull + - path: /engine/reference/commandline/image_push/ + title: docker image push + - path: /engine/reference/commandline/image_rm/ + title: docker image rm + - path: /engine/reference/commandline/image_save/ + title: docker image save + - path: /engine/reference/commandline/image_tag/ + title: docker image tag + - path: /engine/reference/commandline/images/ + title: docker images + - path: /engine/reference/commandline/import/ + title: docker import + - path: /engine/reference/commandline/info/ + title: docker info + - path: /engine/reference/commandline/inspect/ + title: docker inspect + - path: /engine/reference/commandline/kill/ + title: docker kill + - path: /engine/reference/commandline/load/ + title: docker load + - path: /engine/reference/commandline/login/ + title: docker login + - path: /engine/reference/commandline/logout/ + title: docker logout + - path: /engine/reference/commandline/logs/ + title: docker logs + - sectiontitle: docker network * + section: + - path: /engine/reference/commandline/network/ + title: docker network + - path: /engine/reference/commandline/network_connect/ + title: docker network connect + - path: /engine/reference/commandline/network_create/ + title: docker network create + - path: /engine/reference/commandline/network_disconnect/ + title: docker network disconnect + - path: /engine/reference/commandline/network_inspect/ + title: docker network inspect + - path: /engine/reference/commandline/network_ls/ + title: docker network ls + - path: /engine/reference/commandline/network_prune/ + title: docker network prune + - path: /engine/reference/commandline/network_rm/ + title: docker network rm + - sectiontitle: docker node * + section: + - path: /engine/reference/commandline/node/ + title: docker node + - path: /engine/reference/commandline/node_demote/ + title: docker node demote + - path: /engine/reference/commandline/node_inspect/ + title: docker node inspect + - path: /engine/reference/commandline/node_ls/ + title: docker node ls + - path: /engine/reference/commandline/node_promote/ + title: docker node promote + - path: /engine/reference/commandline/node_ps/ + title: docker node ps + - path: /engine/reference/commandline/node_rm/ + title: docker node rm + - path: /engine/reference/commandline/node_update/ + title: docker node update + - path: /engine/reference/commandline/pause/ + title: docker pause + - sectiontitle: docker plugin * + section: + - path: /engine/reference/commandline/plugin/ + title: docker plugin + - path: /engine/reference/commandline/plugin_create/ + title: docker plugin disable + - path: /engine/reference/commandline/plugin_disable/ + title: docker plugin disable + - path: /engine/reference/commandline/plugin_enable/ + title: docker plugin enable + - path: /engine/reference/commandline/plugin_inspect/ + title: docker plugin inspect + - path: /engine/reference/commandline/plugin_install/ + title: docker plugin install + - path: /engine/reference/commandline/plugin_ls/ + title: docker plugin ls + - path: /engine/reference/commandline/plugin_rm/ + title: docker plugin rm + - path: /engine/reference/commandline/plugin_set/ + title: docker plugin set + - path: /engine/reference/commandline/port/ + title: docker port + - path: /engine/reference/commandline/ps/ + title: docker ps + - path: /engine/reference/commandline/pull/ + title: docker pull + - path: /engine/reference/commandline/push/ + title: docker push + - path: /engine/reference/commandline/rename/ + title: docker rename + - path: /engine/reference/commandline/restart/ + title: docker restart + - path: /engine/reference/commandline/rm/ + title: docker rm + - path: /engine/reference/commandline/rmi/ + title: docker rmi + - path: /engine/reference/commandline/run/ + title: docker run + - path: /engine/reference/commandline/save/ + title: docker save + - path: /engine/reference/commandline/search/ + title: docker search + - sectiontitle: docker secret * + section: + - path: /engine/reference/commandline/secret/ + title: docker secret + - path: /engine/reference/commandline/secret_create/ + title: docker secret create + - path: /engine/reference/commandline/secret_inspect/ + title: docker secret inspect + - path: /engine/reference/commandline/secret_ls/ + title: docker secret ls + - path: /engine/reference/commandline/secret_rm/ + title: docker secret rm + - sectiontitle: docker service * + section: + - path: /engine/reference/commandline/service/ + title: docker service + - path: /engine/reference/commandline/service_create/ + title: docker service create + - path: /engine/reference/commandline/service_inspect/ + title: docker service inspect + - path: /engine/reference/commandline/service_logs/ + title: docker service logs + - path: /engine/reference/commandline/service_ls/ + title: docker service ls + - path: /engine/reference/commandline/service_ps/ + title: docker service ps + - path: /engine/reference/commandline/service_rm/ + title: docker service rm + - path: /engine/reference/commandline/service_scale/ + title: docker service scale + - path: /engine/reference/commandline/service_update/ + title: docker service update + - sectiontitle: docker stack * + section: + - path: /engine/reference/commandline/stack/ + title: docker stack + - path: /engine/reference/commandline/stack_deploy/ + title: docker stack deploy + - path: /engine/reference/commandline/stack_ps/ + title: docker stack ps + - path: /engine/reference/commandline/stack_rm/ + title: docker stack rm + - path: /engine/reference/commandline/stack_services/ + title: docker stack services + - path: /engine/reference/commandline/start/ + title: docker start + - path: /engine/reference/commandline/stats/ + title: docker stats + - path: /engine/reference/commandline/stop/ + title: docker stop + - sectiontitle: docker swarm * + setcion: + - path: /engine/reference/commandline/swarm/ + title: docker swarm + - path: /engine/reference/commandline/swarm_init/ + title: docker swarm init + - path: /engine/reference/commandline/swarm_join-token/ + title: docker swarm join-token + - path: /engine/reference/commandline/swarm_join/ + title: docker swarm join + - path: /engine/reference/commandline/swarm_leave/ + title: docker swarm leave + - path: /engine/reference/commandline/swarm_unlock-key/ + title: docker swarm unlock-key + - path: /engine/reference/commandline/swarm_unlock/ + title: docker swarm unlock + - path: /engine/reference/commandline/swarm_update/ + title: docker swarm update + - sectiontitle: docker system * + section: + - path: /engine/reference/commandline/system/ + title: docker system + - path: /engine/reference/commandline/system_df/ + title: docker system df + - path: /engine/reference/commandline/system_events/ + title: docker system events + - path: /engine/reference/commandline/system_info/ + title: docker system info + - path: /engine/reference/commandline/system_prune/ + title: docker system prune + - path: /engine/reference/commandline/tag/ + title: docker tag + - path: /engine/reference/commandline/top/ + title: docker top + - path: /engine/reference/commandline/unpause/ + title: docker unpause + - path: /engine/reference/commandline/update/ + title: docker update + - path: /engine/reference/commandline/version/ + title: docker version + - sectiontitle: docker volume * + section: + - path: /engine/reference/commandline/volume_create/ + title: docker volume create + - path: /engine/reference/commandline/volume_inspect/ + title: docker volume inspect + - path: /engine/reference/commandline/volume_ls/ + title: docker volume ls + - path: /engine/reference/commandline/volume_prune/ + title: docker volume ls + - path: /engine/reference/commandline/volume_rm/ + title: docker volume rm + - path: /engine/reference/commandline/wait/ + title: docker wait +- path: /engine/reference/commandline/dockerd/ + title: Daemon (dockerd) CLI reference +- sectiontitle: Compose (docker-compose) CLI reference section: - - path: /compose/overview/ - title: Overview of Docker Compose - - path: /compose/install/ - title: Install Compose - - path: /compose/gettingstarted/ - title: Getting Started - - path: /compose/bundles/ - title: Docker Stacks and Distributed Application Bundles - - path: /compose/swarm/ - title: Using Compose with Swarm - - path: /compose/django/ - title: "Quickstart: Compose and Django" - - path: /compose/rails/ - title: "Quickstart: Compose and Rails" - - path: /compose/wordpress/ - title: "Quickstart: Compose and WordPress" - - path: /compose/env-file/ - title: Environment file - - path: /compose/environment-variables/ - title: Environment variables in Compose - - path: /compose/extends/ - title: Extending Services in Compose - - path: /compose/networking/ - title: Networking in Compose - - path: /compose/production/ - title: Using Compose in Production - - path: /compose/compose-file/ - title: Compose File Reference - - sectiontitle: Command-line Reference - section: - - path: /compose/reference/overview/ - title: Overview of docker-compose CLI - - path: /compose/reference/envvars/ - title: CLI Environment Variables - - path: /compose/reference/build/ - title: build - - path: /compose/reference/bundle/ - title: bundle - - path: /compose/reference/config/ - title: config - - path: /compose/reference/create/ - title: create - - path: /compose/reference/down/ - title: down - - path: /compose/reference/events/ - title: events - - path: /compose/reference/exec/ - title: exec - - path: /compose/reference/help/ - title: help - - path: /compose/reference/kill/ - title: kill - - path: /compose/reference/logs/ - title: logs - - path: /compose/reference/pause/ - title: pause - - path: /compose/reference/port/ - title: port - - path: /compose/reference/ps/ - title: ps - - path: /compose/reference/pull/ - title: pull - - path: /compose/reference/push/ - title: push - - path: /compose/reference/restart/ - title: restart - - path: /compose/reference/rm/ - title: rm - - path: /compose/reference/run/ - title: run - - path: /compose/reference/scale/ - title: scale - - path: /compose/reference/start/ - title: start - - path: /compose/reference/stop/ - title: stop - - path: /compose/reference/unpause/ - title: unpause - - path: /compose/reference/up/ - title: up + - path: /compose/reference/overview/ + title: Overview of docker-compose CLI + - path: /compose/reference/envvars/ + title: CLI Environment Variables + - path: /compose/reference/build/ + title: build + - path: /compose/reference/bundle/ + title: bundle + - path: /compose/reference/config/ + title: config + - path: /compose/reference/create/ + title: create + - path: /compose/reference/down/ + title: down + - path: /compose/reference/events/ + title: events + - path: /compose/reference/exec/ + title: exec + - path: /compose/reference/help/ + title: help + - path: /compose/reference/kill/ + title: kill + - path: /compose/reference/logs/ + title: logs + - path: /compose/reference/pause/ + title: pause + - path: /compose/reference/port/ + title: port + - path: /compose/reference/ps/ + title: ps + - path: /compose/reference/pull/ + title: pull + - path: /compose/reference/push/ + title: push + - path: /compose/reference/restart/ + title: restart + - path: /compose/reference/rm/ + title: rm + - path: /compose/reference/run/ + title: run + - path: /compose/reference/scale/ + title: scale + - path: /compose/reference/start/ + title: start + - path: /compose/reference/stop/ + title: stop + - path: /compose/reference/unpause/ + title: unpause + - path: /compose/reference/up/ + title: up - path: /compose/completion/ title: Command-line Completion - - path: /compose/link-env-deprecated/ - title: Link Environment Variables - - path: /compose/startup-order/ - title: Controlling startup order - - path: /compose/faq/ - title: Frequently Asked Questions +- sectiontitle: Engine API reference + section: + - path: /engine/api/ + title: Overview + - path: /engine/api/getting-started/ + title: Getting started + - path: /engine/api/sdks/ + title: SDKs + - path: /engine/api/v1.25/ + title: Reference + - sectiontitle: Version history + section: + - path: /engine/api/version-history/ + title: Overview + - path: /engine/api/v1.24/ + title: v1.24 reference + - path: /engine/api/v1.23/ + title: v1.23 reference + - path: /engine/api/v1.22/ + title: v1.22 reference + - path: /engine/api/v1.21/ + title: v1.21 reference + - path: /engine/api/v1.20/ + title: v1.20 reference + - path: /engine/api/v1.19/ + title: v1.19 reference + - path: /engine/api/v1.18/ + title: v1.18 reference + - path: /engine/migration/ + title: Migrate to Engine 1.10 + - path: /engine/breaking_changes/ + title: Breaking changes + - path: /engine/deprecated/ + title: Deprecated Engine Features + - path: /engine/faq/ + title: FAQ + +samples: +- path: /samples/#tutorial-labs + title: Tutorial labs +- path: /engine/examples/apt-cacher-ng/ + title: apt-cacher-ng +- path: /engine/examples/couchdb_data_volumes/ + title: CouchDB +- path: /engine/examples/couchbase/ + title: Couchbase +- path: /compose/django/ + title: Django and PostgreSQL +- path: /engine/examples/mongodb/ + title: MongoDB +- path: /engine/examples/postgresql_service/ + title: PostgreSQL +- path: /compose/rails/ + title: Rails and PostgreSQL +- path: /engine/examples/running_redis_service/ + title: Redis +- path: /engine/examples/running_riak_service/ + title: Riak +- path: /engine/examples/running_ssh_service/ + title: SSHd +- path: /compose/wordpress/ + title: WordPress + +manuals: - sectiontitle: CS Docker Engine section: - path: /cs-engine/install/ @@ -1441,26 +1507,108 @@ toc: title: API reference - path: /docker-cloud/release-notes/ title: Release Notes -- sectiontitle: Docker Hub +- sectiontitle: Docker Store section: - - path: /docker-hub/ - title: Overview of Docker Hub - - path: /docker-hub/accounts/ - title: Use Docker Hub with Docker ID - - path: /docker-hub/orgs/ - title: Teams & Organizations - - path: /docker-hub/repos/ - title: Repositories on Docker Hub - - path: /docker-hub/builds/ - title: Automated Builds - - path: /docker-hub/webhooks/ - title: Webhooks for automated builds - - path: /docker-hub/bitbucket/ - title: Automated Builds with Bitbucket - - path: /docker-hub/github/ - title: Automated Builds from GitHub - - path: /docker-hub/official_repos/ - title: Official Repositories on Docker Hub + - path: /docker-store/ + title: Docker Store Overview + - path: /docker-store/publish/ + title: Submit a product to Docker Store + - path: /docker-store/faq/ + title: Docker Store FAQs +- sectiontitle: Docker Registry + section: + - path: /registry/ + title: Registry Overview + - path: /registry/introduction/ + title: Understanding the Registry + - path: /registry/deploying/ + title: Deploying a registry server + - path: /registry/configuration/ + title: Configuring a registry + - path: /registry/notifications/ + title: Working with notifications + - sectiontitle: Recipes + section: + - path: /registry/recipes/ + title: Recipes Overview + - path: /registry/recipes/apache/ + title: Authenticating proxy with apache + - path: /registry/recipes/nginx/ + title: Authenticating proxy with nginx + - path: /registry/recipes/mirror/ + title: Mirroring Docker Hub + - path: /registry/recipes/osx-setup-guide/ + title: Running on macOS + - sectiontitle: Reference + section: + - path: /registry/spec/ + title: Reference Overview + - path: /registry/spec/api/ + title: HTTP API V2 + - path: /registry/spec/manifest-v2-1/ + title: Image Manifest V 2, Schema 1 + - path: /registry/spec/manifest-v2-2/ + title: Image Manifest V 2, Schema 2 + - path: /registry/garbage-collection/ + title: Garbage Collection + - path: /registry/insecure/ + title: Testing an insecure registry + - path: /registry/deprecated/ + title: Deprecated Features + - path: /registry/compatibility/ + title: Compatibility + - path: /registry/spec/auth/ + title: Docker Registry Token Authentication + - path: /registry/spec/auth/jwt/ + title: Token Authentication Implementation + - path: /registry/spec/auth/oauth/ + title: Oauth2 Token Authentication + - path: /registry/spec/auth/scope/ + title: Token Scope Documentation + - path: /registry/spec/auth/token/ + title: Token Authentication Specification + - sectiontitle: Storage Drivers + section: + - path: /registry/storage-drivers/ + title: Storage Driver overview + - path: /registry/storage-drivers/oss/ + title: Aliyun OSS storage driver + - path: /registry/storage-drivers/filesystem/ + title: Filesystem storage driver + - path: /registry/storage-drivers/gcs/ + title: GCS storage driver + - path: /registry/storage-drivers/inmemory/ + title: In-memory storage driver + - path: /registry/storage-drivers/azure/ + title: Microsoft Azure storage driver + - path: /registry/storage-drivers/s3/ + title: S3 storage driver + - path: /registry/storage-drivers/swift/ + title: Swift storage driver + - path: /registry/help/ + title: Getting help +- sectiontitle: Docker Notary + section: + - path: /notary/getting_started/ + title: Getting started with Notary + - path: /notary/advanced_usage/ + title: Use the Notary client + - path: /notary/service_architecture/ + title: Understand the service architecture + - path: /notary/running_a_service/ + title: Running a Notary service + - sectiontitle: Notary Configuration + section: + - path: /notary/reference/server-config/ + title: Server Configuration + - path: /notary/reference/signer-config/ + title: Signer Configuration + - path: /notary/reference/client-config/ + title: Client Configuration + - path: /notary/reference/common-configs/ + title: Common Server and Signer Configurations + - path: /notary/changelog/ + title: Notary Changelog - sectiontitle: Docker Machine section: - path: /machine/overview/ @@ -1557,268 +1705,193 @@ toc: title: VMware vSphere - path: /machine/completion/ title: Command-line Completion -- sectiontitle: Docker Store +- sectiontitle: Docker Compose section: - - path: /docker-store/ - title: Docker Store Overview - - path: /docker-store/publish/ - title: Submit a product to Docker Store - - path: /docker-store/faq/ - title: Docker Store FAQs -- sectiontitle: Component Projects + - path: /compose/overview/ + title: Overview of Docker Compose + - path: /compose/install/ + title: Install Compose + - path: /compose/gettingstarted/ + title: Getting Started + - path: /compose/bundles/ + title: Docker Stacks and Distributed Application Bundles + - path: /compose/swarm/ + title: Using Compose with Swarm + - path: /compose/env-file/ + title: Environment file + - path: /compose/environment-variables/ + title: Environment variables in Compose + - path: /compose/extends/ + title: Extend services in Compose + - path: /compose/networking/ + title: Networking in Compose + - path: /compose/production/ + title: Using Compose in production + - path: /compose/link-env-deprecated/ + title: Link Environment Variables (deprecated) + - path: /compose/startup-order/ + title: Control startup order + - path: /compose/faq/ + title: Frequently Asked Questions +- sectiontitle: Docker Hub section: - - sectiontitle: Docker Swarm - section: - - path: /swarm/overview/ - title: Swarm Overview - - path: /swarm/get-swarm/ - title: How to get Swarm - - path: /swarm/install-w-machine/ - title: Evaluate Swarm in a sandbox - - path: /swarm/plan-for-production/ - title: Plan for Swarm in production - - path: /swarm/install-manual/ - title: Build a Swarm cluster for production - - sectiontitle: Try Swarm at scale - section: - - path: /swarm/swarm_at_scale/about/ - title: Learn the application architecture - - path: /swarm/swarm_at_scale/deploy-infra/ - title: Deploy application infrastructure - - path: /swarm/swarm_at_scale/deploy-app/ - title: Deploy the application - - path: /swarm/swarm_at_scale/troubleshoot/ - title: Troubleshoot the application - - path: /swarm/multi-manager-setup/ - title: High availability in Swarm - - path: /swarm/networking/ - title: Swarm and container networks - - path: /swarm/discovery/ - title: Discovery - - path: /swarm/provision-with-machine/ - title: Provision with Machine - - sectiontitle: Scheduling - section: - - path: /swarm/scheduler/filter/ - title: Filters - - path: /swarm/scheduler/rescheduling/ - title: Rescheduling - - path: /swarm/scheduler/strategy/ - title: Strategies - - path: /swarm/secure-swarm-tls/ - title: Overview Docker Swarm with TLS - - path: /swarm/configure-tls/ - title: Configure Docker Swarm for TLS - - sectiontitle: Command line reference - section: - - path: /swarm/reference/create/ - title: create - - path: /swarm/reference/help/ - title: help - - path: /swarm/reference/join/ - title: join - - path: /swarm/reference/list/ - title: list - - path: /swarm/reference/manage/ - title: manage - - path: /swarm/reference/swarm/ - title: swarm - - path: /swarm/status-code-comparison-to-docker/ - title: API response codes - - path: /swarm/swarm-api/ - title: Docker Swarm API - - sectiontitle: Docker Registry - section: - - path: /registry/ - title: Registry Overview - - path: /registry/introduction/ - title: Understanding the Registry - - path: /registry/deploying/ - title: Deploying a registry server - - path: /registry/configuration/ - title: Configuring a registry - - path: /registry/notifications/ - title: Working with notifications - - sectiontitle: Recipes - section: - - path: /registry/recipes/ - title: Recipes Overview - - path: /registry/recipes/apache/ - title: Authenticating proxy with apache - - path: /registry/recipes/nginx/ - title: Authenticating proxy with nginx - - path: /registry/recipes/mirror/ - title: Mirroring Docker Hub - - path: /registry/recipes/osx-setup-guide/ - title: Running on macOS - - sectiontitle: Reference - section: - - path: /registry/spec/ - title: Reference Overview - - path: /registry/spec/api/ - title: HTTP API V2 - - path: /registry/spec/manifest-v2-1/ - title: Image Manifest V 2, Schema 1 - - path: /registry/spec/manifest-v2-2/ - title: Image Manifest V 2, Schema 2 - - path: /registry/garbage-collection/ - title: Garbage Collection - - path: /registry/insecure/ - title: Testing an insecure registry - - path: /registry/deprecated/ - title: Deprecated Features - - path: /registry/compatibility/ - title: Compatibility - - path: /registry/spec/auth/ - title: Docker Registry Token Authentication - - path: /registry/spec/auth/jwt/ - title: Token Authentication Implementation - - path: /registry/spec/auth/oauth/ - title: Oauth2 Token Authentication - - path: /registry/spec/auth/scope/ - title: Token Scope Documentation - - path: /registry/spec/auth/token/ - title: Token Authentication Specification - - sectiontitle: Storage Drivers - section: - - path: /registry/storage-drivers/ - title: Storage Driver overview - - path: /registry/storage-drivers/oss/ - title: Aliyun OSS storage driver - - path: /registry/storage-drivers/filesystem/ - title: Filesystem storage driver - - path: /registry/storage-drivers/gcs/ - title: GCS storage driver - - path: /registry/storage-drivers/inmemory/ - title: In-memory storage driver - - path: /registry/storage-drivers/azure/ - title: Microsoft Azure storage driver - - path: /registry/storage-drivers/s3/ - title: S3 storage driver - - path: /registry/storage-drivers/swift/ - title: Swift storage driver - - path: /registry/help/ - title: Getting help - - sectiontitle: Docker Notary - section: - - path: /notary/getting_started/ - title: Getting started with Notary - - path: /notary/advanced_usage/ - title: Use the Notary client - - path: /notary/service_architecture/ - title: Understand the service architecture - - path: /notary/running_a_service/ - title: Running a Notary service - - sectiontitle: Notary Configuration - section: - - path: /notary/reference/server-config/ - title: Server Configuration - - path: /notary/reference/signer-config/ - title: Signer Configuration - - path: /notary/reference/client-config/ - title: Client Configuration - - path: /notary/reference/common-configs/ - title: Common Server and Signer Configurations - - path: /notary/changelog/ - title: Notary Changelog -- sectiontitle: Open Source at Docker + - path: /docker-hub/ + title: Overview of Docker Hub + - path: /docker-hub/accounts/ + title: Use Docker Hub with Docker ID + - path: /docker-hub/orgs/ + title: Teams & Organizations + - path: /docker-hub/repos/ + title: Repositories on Docker Hub + - path: /docker-hub/builds/ + title: Automated Builds + - path: /docker-hub/webhooks/ + title: Webhooks for automated builds + - path: /docker-hub/bitbucket/ + title: Automated Builds with Bitbucket + - path: /docker-hub/github/ + title: Automated Builds from GitHub + - path: /docker-hub/official_repos/ + title: Official Repositories on Docker Hub +- sectiontitle: Docker ID section: - - path: /opensource/code/ - title: Quickstart contribution - - sectiontitle: Set up for Engine Development + - path: /docker-id/ + title: Docker ID accounts + - path: /docker-id/api-reference/ + title: API Reference +- sectiontitle: Superseded products and tools + section: + - sectiontitle: Docker Swarm section: - - path: /opensource/project/who-written-for/ - title: README first - - path: /opensource/project/software-required/ - title: Get the required software - - path: /opensource/project/software-req-win/ - title: Set up for development on Windows - - path: /opensource/project/set-up-git/ - title: Configure Git for contributing - - path: /opensource/project/set-up-dev-env/ - title: Work with a development container - - path: /opensource/project/test-and-docs/ - title: Run tests and test documentation - - sectiontitle: Contribution workflow + - path: /swarm/overview/ + title: Swarm Overview + - path: /swarm/get-swarm/ + title: How to get Swarm + - path: /swarm/install-w-machine/ + title: Evaluate Swarm in a sandbox + - path: /swarm/plan-for-production/ + title: Plan for Swarm in production + - path: /swarm/install-manual/ + title: Build a Swarm cluster for production + - sectiontitle: Try Swarm at scale section: - - path: /opensource/workflow/make-a-contribution/ - title: Understand how to contribute - - path: /opensource/workflow/find-an-issue/ - title: Find and claim an issue - - path: /opensource/workflow/work-issue/ - title: Work on your issue - - path: /opensource/workflow/create-pr/ - title: Create a pull request (PR) - - path: /opensource/workflow/review-pr/ - title: Participate in the PR review - - path: /opensource/workflow/advanced-contributing/ - title: Advanced contributing - - path: /opensource/workflow/coding-style/ - title: Coding style checklist - - sectiontitle: Other ways to contribute + - path: /swarm/swarm_at_scale/about/ + title: Learn the application architecture + - path: /swarm/swarm_at_scale/deploy-infra/ + title: Deploy application infrastructure + - path: /swarm/swarm_at_scale/deploy-app/ + title: Deploy the application + - path: /swarm/swarm_at_scale/troubleshoot/ + title: Troubleshoot the application + - path: /swarm/multi-manager-setup/ + title: High availability in Swarm + - path: /swarm/networking/ + title: Swarm and container networks + - path: /swarm/discovery/ + title: Discovery + - path: /swarm/provision-with-machine/ + title: Provision with Machine + - sectiontitle: Scheduling section: - - path: /opensource/ways/meetups/ - title: Organize a Docker Meetup - - path: /opensource/ways/issues/ - title: Organize our issues - - path: /opensource/ways/community/ - title: Support the community - - path: /opensource/ways/test/ - title: Testing contributions - - sectiontitle: Contribute to Kitematic + - path: /swarm/scheduler/filter/ + title: Filters + - path: /swarm/scheduler/rescheduling/ + title: Rescheduling + - path: /swarm/scheduler/strategy/ + title: Strategies + - path: /swarm/secure-swarm-tls/ + title: Overview Docker Swarm with TLS + - path: /swarm/configure-tls/ + title: Configure Docker Swarm for TLS + - sectiontitle: Command line reference section: - - path: /opensource/kitematic/get_started/ - title: Get started - - path: /opensource/kitematic/find_issue/ - title: Find an issue - - path: /opensource/kitematic/set_up_dev/ - title: Set up for Kitematic development - - path: /opensource/kitematic/work_issue/ - title: Develop in Kitematic (work on an issue) - - path: /opensource/kitematic/create_pr/ - title: Create a pull request (PR) - - path: /opensource/kitematic/next_steps/ - title: Where to learn more - - sectiontitle: Governance - section: - - path: /opensource/governance/dgab-info/ - title: Docker Governance Advisory Board - - path: /opensource/governance/board-profiles/ - title: Board member profiles - - path: /opensource/governance/conduct-code/ - title: Code of conduct - - path: /opensource/FAQ/ - title: FAQ for contributors - - path: /opensource/get-help/ - title: Where to chat or get help - - path: /opensource/doc-style/ - title: Style guide for Docker documentation -- sectiontitle: About - section: - - path: /release-notes/ - title: Docker Release Notes - - path: /engine/reference/glossary/ - title: Docker Glossary -- sectiontitle: Docs archive - section: - - path: /docsarchive/ - title: View the docs archives - - path: /v1.4 - title: v1.4 - - path: /v1.5 - title: v1.5 - - path: /v1.6 - title: v1.6 - - path: /v1.7 - title: v1.7 - - path: /v1.8 - title: v1.8 - - path: /v1.9 - title: v1.9 - - path: /v1.10 - title: v1.10 - - path: /v1.11 - title: v1.11 - - path: /v1.12 - title: v1.12 - path: /docsarchive/ + - path: /swarm/reference/create/ + title: create + - path: /swarm/reference/help/ + title: help + - path: /swarm/reference/join/ + title: join + - path: /swarm/reference/list/ + title: list + - path: /swarm/reference/manage/ + title: manage + - path: /swarm/reference/swarm/ + title: swarm + - path: /swarm/status-code-comparison-to-docker/ + title: API response codes + - path: /swarm/swarm-api/ + title: Docker Swarm API + +glossary: +- path: /glossary/#aufs + title: aufs +- path: /glossary/#base-image + title: base image +- path: /glossary/#boot2docker + title: boot2docker +- path: /glossary/#btrfs + title: btrfs +- path: /glossary/#build + title: build +- path: /glossary/#cgroups + title: cgroups +- path: /glossary/#compose + title: Compose +- path: /glossary/#copy-on-write + title: copy-on-write +- path: /glossary/#container + title: container +- path: /glossary/#data-volume + title: data volume +- path: /glossary/#docker + title: Docker +- path: /glossary/#docker-for-mac + title: Docker for Mac +- path: /glossary/#docker-for-windows + title: Docker for Windows +- path: /glossary/#docker-hub + title: Docker Hub +- path: /glossary/#dockerfile + title: Dockerfile +- path: /glossary/#filesystem + title: filesystem +- path: /glossary/#image + title: image +- path: /glossary/#libcontainer + title: libcontainer +- path: /glossary/#libnetwork + title: libnetwork +- path: /glossary/#link + title: link +- path: /glossary/#machine + title: Machine +- path: /glossary/#node + title: node +- path: /glossary/#overlay-network-driver + title: overlay network driver +- path: /glossary/#overlay-storage-driver + title: overlay storage driver +- path: /glossary/#registry + title: registry +- path: /glossary/#repository + title: repository +- path: /glossary/#service + title: service +- path: /glossary/#service-discovery + title: service discovery +- path: /glossary/#swarm + title: swarm +- path: /glossary/#docker-swarm + title: Docker Swarm +- path: /glossary/#swarm-mode + title: swarm mode +- path: /glossary/#tag + title: tag +- path: /glossary/#task + title: task +- path: /glossary/#toolbox + title: Toolbox +- path: /glossary/#union-file-system + title: Union file system +- path: /glossary/#virtual-machine + title: virtual machine diff --git a/_includes/treebuilder.html b/_includes/treebuilder.html new file mode 100644 index 0000000000..d7bb4c2cf3 --- /dev/null +++ b/_includes/treebuilder.html @@ -0,0 +1,11 @@ +{% for section in site.data.toc.horizontalnav %} + {% assign topicFound="false" %} + {% assign tree = site.data.toc[section.node] %} + + {% capture thisSection %}{% include tree.html %}{% endcapture %} + {% if section.path == page.url or thisSection contains "active currentPage" %} + + {{ thisSection }} + {% break %} + {% endif %} +{% endfor %} diff --git a/_layouts/docs.html b/_layouts/docs.html index 72e6b51cb4..4942276041 100644 --- a/_layouts/docs.html +++ b/_layouts/docs.html @@ -191,19 +191,23 @@ ng\:form {
+
+ + +
-
- {% if page.tree == false %} - - {% else %} - - {% endif %} +
diff --git a/css/documentation.css b/css/documentation.css index 490bf1ae2f..fc7005f383 100644 --- a/css/documentation.css +++ b/css/documentation.css @@ -1,6 +1,43 @@ /* FIXUP allcss.css */ /* @media screen and (max-width: 1199px) */ +/* +* +* Tabs *********************************************************************** +* +*/ + +.tabs { + border-bottom: 0; + padding: 10px 0px 0px 0px; +} + +.tabs>li { + float: left; + list-style: none; +} + +.tabs>li>a { + color: #fff; + line-height: 3; + border: 0; + border-radius: 0; + padding: 0 20px 0px 20px; + float: left; + opacity: .8; +} + +.tabs>li.active>a, .tabs>li>a:hover { + color: #fff; + border-bottom: 4px solid #fff; + opacity: 1; + -webkit-transition: all 0.2s ease; + -moz-transition: all 0.2s ease; + -o-transition: all 0.2s ease; + transition: all 0.2s ease; +} + + .logo { margin-top: 1px !important; width: auto !important; diff --git a/glossary.md b/glossary.md new file mode 100644 index 0000000000..68dba62f48 --- /dev/null +++ b/glossary.md @@ -0,0 +1,340 @@ +--- +title: "Docker Glossary" +description: "Glossary of terms used around Docker" +keywords: "glossary, docker, terms, definitions" +skip-right-nav: true +--- + +## aufs + +aufs (advanced multi layered unification filesystem) is a Linux [filesystem](#filesystem) that +Docker supports as a storage backend. It implements the +[union mount](http://en.wikipedia.org/wiki/Union_mount) for Linux file systems. + +## base image + +An image that has no parent is a **base image**. + +## boot2docker + +[boot2docker](http://boot2docker.io/) is a lightweight Linux distribution made +specifically to run Docker containers. The boot2docker management tool for Mac and Windows was deprecated and replaced by [`docker-machine`](#machine) which you can install with the Docker Toolbox. + +## btrfs + +btrfs (B-tree file system) is a Linux [filesystem](#filesystem) that Docker +supports as a storage backend. It is a [copy-on-write](http://en.wikipedia.org/wiki/Copy-on-write) +filesystem. + +## build + +build is the process of building Docker images using a [Dockerfile](#dockerfile). +The build uses a Dockerfile and a "context". The context is the set of files in the +directory in which the image is built. + +## cgroups + +cgroups is a Linux kernel feature that limits, accounts for, and isolates +the resource usage (CPU, memory, disk I/O, network, etc.) of a collection +of processes. Docker relies on cgroups to control and isolate resource limits. + +*Also known as : control groups* + +## Compose + +[Compose](https://github.com/docker/compose) is a tool for defining and +running complex applications with Docker. With compose, you define a +multi-container application in a single file, then spin your +application up in a single command which does everything that needs to +be done to get it running. + +*Also known as : docker-compose, fig* + +## copy-on-write + +Docker uses a +[copy-on-write](https://docs.docker.com/engine/userguide/storagedriver/imagesandcontainers/#/the-copy-on-write-strategy) +technique and a [union file system](#union-file-system) for both images and +containers to optimize resources and speed performance. Multiple copies of an +entity share the same instance and each one makes only specific changes to its +unique layer. + +Multiple containers can share access to the same image, and make +container-specific changes on a writable layer which is deleted when +the container is removed. This speeds up container start times and performance. + +Images are essentially layers of filesystems typically predicated on a base +image under a writable layer, and built up with layers of differences from the +base image. This minimizes the footprint of the image and enables shared +development. + +For more about copy-on-write in the context of Docker, see [Understand images, +containers, and storage +drivers](https://docs.docker.com/engine/userguide/storagedriver/imagesandcontainers/). + +## container + +A container is a runtime instance of a [docker image](#image). + +A Docker container consists of + +- A Docker image +- Execution environment +- A standard set of instructions + +The concept is borrowed from Shipping Containers, which define a standard to ship +goods globally. Docker defines a standard to ship software. + +## data volume + +A data volume is a specially-designated directory within one or more containers +that bypasses the Union File System. Data volumes are designed to persist data, +independent of the container's life cycle. Docker therefore never automatically +delete volumes when you remove a container, nor will it "garbage collect" +volumes that are no longer referenced by a container. + + +## Docker + +The term Docker can refer to + +- The Docker project as a whole, which is a platform for developers and sysadmins to +develop, ship, and run applications +- The docker daemon process running on the host which manages images and containers + + +## Docker for Mac + +[Docker for Mac](https://docs.docker.com/docker-for-mac/) is an easy-to-install, +lightweight Docker development environment designed specifically for the Mac. A +native Mac application, Docker for Mac uses the macOS Hypervisor framework, +networking, and filesystem. It's the best solution if you want to build, debug, +test, package, and ship Dockerized applications on a Mac. Docker for Mac +supersedes [Docker Toolbox](#toolbox) as state-of-the-art Docker on macOS. + + +## Docker for Windows + +[Docker for Windows](https://docs.docker.com/docker-for-windows/) is an +easy-to-install, lightweight Docker development environment designed +specifically for Windows 10 systems that support Microsoft Hyper-V +(Professional, Enterprise and Education). Docker for Windows uses Hyper-V for +virtualization, and runs as a native Windows app. It works with Windows Server +2016, and gives you the ability to set up and run Windows containers as well as +the standard Linux containers, with an option to switch between the two. Docker +for Windows is the best solution if you want to build, debug, test, package, and +ship Dockerized applications from Windows machines. Docker for Windows +supersedes [Docker Toolbox](#toolbox) as state-of-the-art Docker on Windows. + +## Docker Hub + +The [Docker Hub](https://hub.docker.com/) is a centralized resource for working with +Docker and its components. It provides the following services: + +- Docker image hosting +- User authentication +- Automated image builds and work-flow tools such as build triggers and web hooks +- Integration with GitHub and Bitbucket + + +## Dockerfile + +A Dockerfile is a text document that contains all the commands you would +normally execute manually in order to build a Docker image. Docker can +build images automatically by reading the instructions from a Dockerfile. + +## filesystem + +A file system is the method an operating system uses to name files +and assign them locations for efficient storage and retrieval. + +Examples : + +- Linux : ext4, aufs, btrfs, zfs +- Windows : NTFS +- macOS : HFS+ + +## image + +Docker images are the basis of [containers](#container). An Image is an +ordered collection of root filesystem changes and the corresponding +execution parameters for use within a container runtime. An image typically +contains a union of layered filesystems stacked on top of each other. An image +does not have state and it never changes. + +## libcontainer + +libcontainer provides a native Go implementation for creating containers with +namespaces, cgroups, capabilities, and filesystem access controls. It allows +you to manage the lifecycle of the container performing additional operations +after the container is created. + +## libnetwork + +libnetwork provides a native Go implementation for creating and managing container +network namespaces and other network resources. It manage the networking lifecycle +of the container performing additional operations after the container is created. + +## link + +links provide a legacy interface to connect Docker containers running on the +same host to each other without exposing the hosts' network ports. Use the +Docker networks feature instead. + +## Machine + +[Machine](https://github.com/docker/machine) is a Docker tool which +makes it really easy to create Docker hosts on your computer, on +cloud providers and inside your own data center. It creates servers, +installs Docker on them, then configures the Docker client to talk to them. + +*Also known as : docker-machine* + +## node + +A [node](https://docs.docker.com/engine/swarm/how-swarm-mode-works/nodes/) is a physical or virtual +machine running an instance of the Docker Engine in swarm mode. + +**Manager nodes** perform swarm management and orchestration duties. By default +manager nodes are also worker nodes. + +**Worker nodes** execute tasks. + +## overlay network driver + +Overlay network driver provides out of the box multi-host network connectivity +for docker containers in a cluster. + +## overlay storage driver + +OverlayFS is a [filesystem](#filesystem) service for Linux which implements a +[union mount](http://en.wikipedia.org/wiki/Union_mount) for other file systems. +It is supported by the Docker daemon as a storage driver. + +## registry + +A Registry is a hosted service containing [repositories](#repository) of [images](#image) +which responds to the Registry API. + +The default registry can be accessed using a browser at [Docker Hub](#docker-hub) +or using the `docker search` command. + +## repository + +A repository is a set of Docker images. A repository can be shared by pushing it +to a [registry](#registry) server. The different images in the repository can be +labeled using [tags](#tag). + +Here is an example of the shared [nginx repository](https://hub.docker.com/_/nginx/) +and its [tags](https://hub.docker.com/r/library/nginx/tags/) + + +## service + +A [service](https://docs.docker.com/engine/swarm/how-swarm-mode-works/services/) is the definition of how +you want to run your application containers in a swarm. At the most basic level +a service defines which container image to run in the swarm and which commands +to run in the container. For orchestration purposes, the service defines the +"desired state", meaning how many containers to run as tasks and constraints for +deploying the containers. + +Frequently a service is a microservice within the context of some larger +application. Examples of services might include an HTTP server, a database, or +any other type of executable program that you wish to run in a distributed +environment. + +## service discovery + +Swarm mode [service discovery](https://docs.docker.com/engine/swarm/networking/#use-swarm-mode-service-discovery) is a DNS component +internal to the swarm that automatically assigns each service on an overlay +network in the swarm a VIP and DNS entry. Containers on the network share DNS +mappings for the service via gossip so any container on the network can access +the service via its service name. + +You don’t need to expose service-specific ports to make the service available to +other services on the same overlay network. The swarm’s internal load balancer +automatically distributes requests to the service VIP among the active tasks. + +## swarm + +A [swarm](https://docs.docker.com/engine/swarm/) is a cluster of one or more Docker Engines running in [swarm mode](#swarm-mode). + +## Docker Swarm + +Do not confuse [Docker Swarm](https://github.com/docker/swarm) with the [swarm mode](#swarm-mode) features in Docker Engine. + +Docker Swarm is the name of a standalone native clustering tool for Docker. +Docker Swarm pools together several Docker hosts and exposes them as a single +virtual Docker host. It serves the standard Docker API, so any tool that already +works with Docker can now transparently scale up to multiple hosts. + +*Also known as : docker-swarm* + +## swarm mode + +[Swarm mode](https://docs.docker.com/engine/swarm/) refers to cluster management and orchestration +features embedded in Docker Engine. When you initialize a new swarm (cluster) or +join nodes to a swarm, the Docker Engine runs in swarm mode. + +## tag + +A tag is a label applied to a Docker image in a [repository](#repository). +tags are how various images in a repository are distinguished from each other. + +*Note : This label is not related to the key=value labels set for docker daemon* + +## task + +A [task](https://docs.docker.com/engine/swarm/how-swarm-mode-works/services/#/tasks-and-scheduling) is the +atomic unit of scheduling within a swarm. A task carries a Docker container and +the commands to run inside the container. Manager nodes assign tasks to worker +nodes according to the number of replicas set in the service scale. + +The diagram below illustrates the relationship of services to tasks and +containers. + +![services diagram](https://docs.docker.com/engine/swarm/images/services-diagram.png) + +## Toolbox + +[Docker Toolbox](https://docs.docker.com/toolbox/overview/) is a legacy +installer for Mac and Windows users. It uses Oracle VirtualBox for +virtualization. + +For Macs running OS X El Capitan 10.11 and newer macOS releases, [Docker for +Mac](https://docs.docker.com/docker-for-mac/) is the better solution. + +For Windows 10 systems that support Microsoft Hyper-V (Professional, Enterprise +and Education), [Docker for +Windows](https://docs.docker.com/docker-for-windows/) is the better solution. + +## Union file system + +Union file systems implement a [union +mount](https://en.wikipedia.org/wiki/Union_mount) and operate by creating +layers. Docker uses union file systems in conjunction with +[copy-on-write](#copy-on-write) techniques to provide the building blocks for +containers, making them very lightweight and fast. + +For more on Docker and union file systems, see [Docker and AUFS in +practice](https://docs.docker.com/engine/userguide/storagedriver/aufs-driver/), +[Docker and Btrfs in +practice](https://docs.docker.com/engine/userguide/storagedriver/btrfs-driver/), +and [Docker and OverlayFS in +practice](https://docs.docker.com/engine/userguide/storagedriver/overlayfs-driver/) + +Example implementations of union file systems are +[UnionFS](https://en.wikipedia.org/wiki/UnionFS), +[AUFS](https://en.wikipedia.org/wiki/Aufs), and +[Btrfs](https://btrfs.wiki.kernel.org/index.php/Main_Page). + +## virtual machine + +A virtual machine is a program that emulates a complete computer and imitates dedicated hardware. +It shares physical hardware resources with other users but isolates the operating system. The +end user has the same experience on a Virtual Machine as they would have on dedicated hardware. + +Compared to containers, a virtual machine is heavier to run, provides more isolation, +gets its own set of resources and does minimal sharing. + +*Also known as : VM* diff --git a/images/angles.png b/images/angles.png new file mode 100644 index 0000000000..7f7fa64bc5 Binary files /dev/null and b/images/angles.png differ diff --git a/images/docker-docs-logo.svg b/images/docker-docs-logo.svg new file mode 100644 index 0000000000..b8c04779d6 --- /dev/null +++ b/images/docker-docs-logo.svg @@ -0,0 +1,14 @@ + + + + docs + Created with Sketch. + + + + + + + + + \ No newline at end of file diff --git a/js/menu.js b/js/menu.js index 337bc2f105..bb0c1ee351 100644 --- a/js/menu.js +++ b/js/menu.js @@ -1,3 +1,6 @@ +--- +layout: null +--- var metadata; var autoCompleteShowing = false; var displayingAutcompleteResults = new Array(); diff --git a/manuals.md b/manuals.md new file mode 100644 index 0000000000..d1165101bb --- /dev/null +++ b/manuals.md @@ -0,0 +1,35 @@ +--- +title: Product and tool manuals +skip-right-nav: true +--- + +The Docker platform is comprised of a family of tools and products. After +learning the general principles of the Docker workflow under [Guides](/), you +can find the documentation for these tools and products here. + +## Products + +| Product | Description | +| ------- | ----------- | +| [Docker Cloud](/docker-cloud/overview) | Manages multi-container applications and host resources running on a cloud provider (such as Amazon Web Services) | +| [Universal Control Plane (UCP)](/ucp/overview/) | Manages multi-container applications on a custom host installation (on-premise, on a cloud provider) | +| [Docker Trusted Registry (DTR)](/docker-trusted-registry/) | Runs a private repository of container images and makes them available to a UCP instance | +| [Docker Hub](/docker-hub/) and [Docker Store](/docker-store/) | Public, Docker-hosted registries that distribute free and paid container images (respectively) | +| [CS Docker Engine](/cs-engine/install) | The commercially-supported version of Docker that excludes experimental features and includes customer support | + +## Tools + +| Tool | Description | +| ---- | ----------- | +| [Docker for Mac](/docker-for-mac/) and [Docker for Windows](/docker-for-windows) | Desktop installation packages that include everything a developer needs to create and test applications | +| [Docker Compose](/compose/) | Enables you to define, build, and run multi-container applications | +| [Docker Notary](/notary/) | Allows the signing of container images to enable Docker Content Trust | +| [Docker Registry](/registry/) | The software that powers Docker Hub and Docker Store, Registry stores and distributes container images | + + +## Superseded tools + +> Note: These tools have had their functionality replaced by recent releases, as noted. + +* [Docker Toolbox](/toolbox/overview/) - Superseded by Docker for Mac/Windows +* [Docker Swarm](/swarm/) - Functionality folded directly into native Docker, no longer a standalone tool diff --git a/reference.md b/reference.md new file mode 100644 index 0000000000..b10a177f21 --- /dev/null +++ b/reference.md @@ -0,0 +1,34 @@ +--- +title: Reference documentation +skip-right-nav: true +--- + +This section includes the reference documentation for the Docker platform's +various APIs, CLIs, and file formats. + +## File formats + +| File format | Description | +| ----------- | ----------- | +| [Dockerfile](/engine/reference/builder/) | Defines the contents and startup behavior of a single container | +| [Compose file](/compose/compose-file/) | Defines a multi-container application | + +## Application programming interfaces (APIs) + +| API | Description | +| --- | ----------- | +| [Remote API](/engine/reference/api/docker_remote_api/) | The main API for Docker, provides programmatic access to a [daemon](/glossary/#daemon) | +| [Trusted Registry API](/apidocs/overview/) | Provides programmatic access to +a trusted registry | +| [Cloud API](/apidocs/docker-cloud/) | Enables programmatic management of your Docker application running on a cloud provider | + + +## Command-line interfaces (CLIs) + +| CLI | Description | +| --- | ----------- | +| [Docker CLI](/engine/reference/commandline/) | The main CLI for Docker, includes all `docker` commands | +| [Compose CLI](/compose/reference/overview/) | The CLI for Docker Compose, which allows you to build and run multi-container applications | +| [Machine CLI](/machine/reference/) | Manages virtual machines that are pre-configured to run Docker | +| [UCP Tool](/ucp/reference/) | Manages a Universal Control Plane instance | +| [Trusted Registry CLI](/docker-trusted-registry/reference/) | Manages a trusted registry diff --git a/samples.md b/samples.md new file mode 100644 index 0000000000..93512d2ecd --- /dev/null +++ b/samples.md @@ -0,0 +1,48 @@ +--- +title: Samples +skip-right-nav: true +--- + +## Docker samples + +The following samples were developed by Docker and the Docker community. + +{% assign labsbase = "https://github.com/docker/labs/tree/master" %} + +## Tutorial labs + +Tutorial labs demonstrate how to develop and ship containerized applications, by +walking through a sample that exhibits canonical practices. These labs are being +from the [Docker Labs repository]({{ labsbase }}). + +| Sample | Description | +| ------ | ----------- | +| [Docker for Beginners]({{ labsbase }}/beginner/){: target="_blank"} | A good "Docker 101" course. | +| [Building a 12-factor application with Docker]({{ labsbase}}/12factor){: target="_blank"} | Use Docker to create an app that conforms to Heroku's "12 factors for cloud-native applications." | +| [Docker Swarm mode]({{ labsbase}}/swarm-mode){: target="_blank"} | Use Docker for natively managing a cluster of Docker Engines called a swarm. | +| [Service deployment in the cloud]({{ labsbase}}/swarm-mode/cloud-quick-start){: target="_blank"} | This script creates a swarm cluster and deploy a simple service on a cloud provider. | +| [Configuring developer tools and programming languages]({{ labsbase }}/developer-tools/README.md){: target="_blank"} | How to set-up and use common developer tools and programming languages with Docker. | +| [Live Debugging Java with Docker]({{ labsbase }}/developer-tools/java-debugging){: target="_blank"} | Java developers can use Docker to build a development environment where they can run, test, and live debug code running within a container. | +| [Docker for Java Developers]({{ labsbase }}/developer-tools/java/){: target="_blank"} | Offers Java developers an intro-level and self-paced hands-on workshop with Docker. | +| [Live Debugging a Node.js application in Docker]({{ labsbase }}/developer-tools/nodejs-debugging){: target="_blank"} | Node developers can use Docker to build a development environment where they can run, test, and live debug code running within a container. | +| [Dockerizing a Node.js application]({{ labsbase }}/developer-tools/nodejs/porting/){: target="_blank"} | This tutorial starts with a simple Node.js application and details the steps needed to Dockerize it and ensure its scalability. | +| [Docker for ASP.NET and Windows containers]({{ labsbase }}/windows/readme.md){: target="_blank"} | Docker supports Windows containers, too! Learn how to run ASP.NET, SQL Server, and more in these tutorials. | +| [Docker Security]({{ labsbase }}/security/README.md){: target="_blank"} | How to take advantage of a Docker security features. | + +## Sample applications + +Sample applications demonstrate how to run popular software using Docker. + +| Sample | Description | +| ------ | ----------- | +| [apt-cacher-ng](/engine/examples/apt-cacher-ng) | Run a Dockerized apt-cacher-ng instance. | +| [CouchDB](/engine/examples/couchdb_data_volumes) | Run a Dockerized CouchDB instance. | +| [Couchbase](/engine/examples/couchbase) | Run a Dockerized Couchbase instance. | +| [Django + PostgreSQL](/compose/django/) | Run a Dockerized Django + PostgreSQL environment. | +| [MongoDB](/engine/examples/mongodb) | Run a Dockerized MongoDB instance. | +| [PostgreSQL](/engine/examples/postgresql_service) | Run a Dockerized PosgreSQL instance. | +| [Rails + PostgreSQL](/compose/rails/) | Run a Dockerized Rails + PostgreSQL environment. | +| [Redis](/engine/examples/running_redis_service) | Run a Dockerized Redis instance. | +| [Riak](/engine/examples/running_riak_service) | Run a Dockerized Riak instance. | +| [SSHd](/engine/examples/running_ssh_service) | Run a Dockerized SSHd instance. | +| [WordPress](/compose/wordpress/) | Run a Dockerized WordPress instance. |