diff --git a/docs/examples/index.md b/docs/examples/index.md index c3c67f7330..5a6cd78ce6 100644 --- a/docs/examples/index.md +++ b/docs/examples/index.md @@ -19,4 +19,4 @@ This section contains the following: * [Dockerizing a CouchDB service](couchdb_data_volumes.md) * [Dockerizing a Redis service](running_redis_service.md) * [Dockerizing an apt-cacher-ng service](apt-cacher-ng.md) -* [Dockerizing applications: A 'Hello world'](../userguide/containers/dockerizing.md) +* [Dockerizing applications: A 'Hello world'](../tutorials/dockerizing.md) diff --git a/docs/reference/builder.md b/docs/reference/builder.md index 9635bddfa9..f26143e777 100644 --- a/docs/reference/builder.md +++ b/docs/reference/builder.md @@ -100,7 +100,7 @@ the `Using cache` message in the console output. Successfully built 7ea8aef582cc When you're done with your build, you're ready to look into [*Pushing a -repository to its registry*](../userguide/containers/dockerrepos.md#contributing-to-docker-hub). +repository to its registry*](../tutorials/dockerrepos.md#contributing-to-docker-hub). ## Format @@ -474,7 +474,7 @@ Or The `FROM` instruction sets the [*Base Image*](glossary.md#base-image) for subsequent instructions. As such, a valid `Dockerfile` must have `FROM` as its first instruction. The image can be any valid image – it is especially easy -to start by **pulling an image** from the [*Public Repositories*](../userguide/containers/dockerrepos.md). +to start by **pulling an image** from the [*Public Repositories*](../tutorials/dockerrepos.md). - `FROM` must be the first non-comment instruction in the `Dockerfile`. @@ -1171,7 +1171,7 @@ containers. The value can be a JSON array, `VOLUME ["/var/log/"]`, or a plain string with multiple arguments, such as `VOLUME /var/log` or `VOLUME /var/log /var/db`. For more information/examples and mounting instructions via the Docker client, refer to -[*Share Directories via Volumes*](../userguide/containers/dockervolumes.md#mount-a-host-directory-as-a-data-volume) +[*Share Directories via Volumes*](../tutorials/dockervolumes.md#mount-a-host-directory-as-a-data-volume) documentation. The `docker run` command initializes the newly created volume with any data diff --git a/docs/reference/commandline/export.md b/docs/reference/commandline/export.md index 604ceab189..90ffec62be 100644 --- a/docs/reference/commandline/export.md +++ b/docs/reference/commandline/export.md @@ -23,7 +23,7 @@ the container, `docker export` will export the contents of the *underlying* directory, not the contents of the volume. Refer to [Backup, restore, or migrate data -volumes](../../userguide/containers/dockervolumes.md#backup-restore-or-migrate-data-volumes) in +volumes](../../tutorials/dockervolumes.md#backup-restore-or-migrate-data-volumes) in the user guide for examples on exporting data in a volume. ## Examples diff --git a/docs/reference/commandline/search.md b/docs/reference/commandline/search.md index 6d3984de13..fff426d38d 100644 --- a/docs/reference/commandline/search.md +++ b/docs/reference/commandline/search.md @@ -24,7 +24,7 @@ parent = "smn_cli" Search [Docker Hub](https://hub.docker.com) for images -See [*Find Public Images on Docker Hub*](../../userguide/containers/dockerrepos.md#searching-for-images) for +See [*Find Public Images on Docker Hub*](../../tutorials/dockerrepos.md#searching-for-images) for more details on finding shared images from the command line. > **Note:** @@ -124,5 +124,3 @@ This example displays images with a name containing 'busybox', at least NAME DESCRIPTION STARS OFFICIAL AUTOMATED progrium/busybox 50 [OK] radial/busyboxplus Full-chain, Internet enabled, busybox made... 8 [OK] - - diff --git a/docs/reference/commandline/tag.md b/docs/reference/commandline/tag.md index e8d802a834..47cc58c4e5 100644 --- a/docs/reference/commandline/tag.md +++ b/docs/reference/commandline/tag.md @@ -19,10 +19,10 @@ parent = "smn_cli" An image name is made up of slash-separated name components, optionally prefixed by a registry hostname. The hostname must comply with standard DNS rules, but may not contain underscores. If a hostname is present, it may optionally be -followed by a port number in the format `:8080`. If not present, the command -uses Docker's public registry located at `registry-1.docker.io` by default. Name -components may contain lowercase characters, digits and separators. A separator -is defined as a period, one or two underscores, or one or more dashes. A name +followed by a port number in the format `:8080`. If not present, the command +uses Docker's public registry located at `registry-1.docker.io` by default. Name +components may contain lowercase characters, digits and separators. A separator +is defined as a period, one or two underscores, or one or more dashes. A name component may not start or end with a separator. A tag name may contain lowercase and uppercase characters, digits, underscores, @@ -30,20 +30,20 @@ periods and dashes. A tag name may not start with a period or a dash and may contain a maximum of 128 characters. You can group your images together using names and tags, and then upload them -to [*Share Images via Repositories*](../../userguide/containers/dockerrepos.md#contributing-to-docker-hub). +to [*Share Images via Repositories*](../../tutorials/dockerrepos.md#contributing-to-docker-hub). # Examples ## Tagging an image referenced by ID -To tag a local image with ID "0e5574283393" into the "fedora" repository with +To tag a local image with ID "0e5574283393" into the "fedora" repository with "version1.0": docker tag 0e5574283393 fedora/httpd:version1.0 ## Tagging an image referenced by Name -To tag a local image with name "httpd" into the "fedora" repository with +To tag a local image with name "httpd" into the "fedora" repository with "version1.0": docker tag httpd fedora/httpd:version1.0 diff --git a/docs/reference/commandline/volume_create.md b/docs/reference/commandline/volume_create.md index 112c260a8b..3e69b79864 100644 --- a/docs/reference/commandline/volume_create.md +++ b/docs/reference/commandline/volume_create.md @@ -73,4 +73,4 @@ $ docker volume create --driver local --opt type=btrfs --opt device=/dev/sda2 * [volume inspect](volume_inspect.md) * [volume ls](volume_ls.md) * [volume rm](volume_rm.md) -* [Understand Data Volumes](../../userguide/containers/dockervolumes.md) +* [Understand Data Volumes](../../tutorials/dockervolumes.md) diff --git a/docs/reference/commandline/volume_inspect.md b/docs/reference/commandline/volume_inspect.md index 7359c2b5a4..c19d60fe48 100644 --- a/docs/reference/commandline/volume_inspect.md +++ b/docs/reference/commandline/volume_inspect.md @@ -45,4 +45,4 @@ Example output: * [volume create](volume_create.md) * [volume ls](volume_ls.md) * [volume rm](volume_rm.md) -* [Understand Data Volumes](../../userguide/containers/dockervolumes.md) +* [Understand Data Volumes](../../tutorials/dockervolumes.md) diff --git a/docs/reference/commandline/volume_ls.md b/docs/reference/commandline/volume_ls.md index 9774c7b834..12ed40c401 100644 --- a/docs/reference/commandline/volume_ls.md +++ b/docs/reference/commandline/volume_ls.md @@ -81,4 +81,4 @@ The following filter matches all volumes with a name containing the `rose` strin * [volume create](volume_create.md) * [volume inspect](volume_inspect.md) * [volume rm](volume_rm.md) -* [Understand Data Volumes](../../userguide/containers/dockervolumes.md) +* [Understand Data Volumes](../../tutorials/dockervolumes.md) diff --git a/docs/reference/commandline/volume_rm.md b/docs/reference/commandline/volume_rm.md index ff5ce24a4b..c163ddf680 100644 --- a/docs/reference/commandline/volume_rm.md +++ b/docs/reference/commandline/volume_rm.md @@ -26,4 +26,4 @@ Removes one or more volumes. You cannot remove a volume that is in use by a cont * [volume create](volume_create.md) * [volume inspect](volume_inspect.md) * [volume ls](volume_ls.md) -* [Understand Data Volumes](../../userguide/containers/dockervolumes.md) \ No newline at end of file +* [Understand Data Volumes](../../tutorials/dockervolumes.md) diff --git a/docs/reference/run.md b/docs/reference/run.md index a7c5267f45..e82829278f 100644 --- a/docs/reference/run.md +++ b/docs/reference/run.md @@ -1073,7 +1073,7 @@ Both flags take limits in the `:` format. Both read and write rates must be a positive integer. ## Additional groups - --group-add: Add additional groups to run as + --group-add: Add additional groups to run as By default, the docker container process runs with the supplementary groups looked up for the specified user. If one wants to add more to that list of groups, then @@ -1497,8 +1497,8 @@ The example below mounts an empty tmpfs into the container with the `rw`, > a volume. The volumes commands are complex enough to have their own documentation -in section [*Managing data in -containers*](../userguide/containers/dockervolumes.md). A developer can define +in section [*Manage data in +containers*](../tutorials/dockervolumes.md). A developer can define one or more `VOLUME`'s associated with an image, but only the operator can give access from one container to another (or from a container to a volume mounted on the host). @@ -1527,7 +1527,7 @@ Dockerfile `USER` instruction. When starting a container, the operator can overr the `USER` instruction by passing the `-u` option. -u="", --user="": Sets the username or UID used and optionally the groupname or GID for the specified command. - + The followings examples are all valid: --user=[ user | user:group | uid | uid:gid | user:gid | uid:group ] diff --git a/docs/userguide/containers/dockerimages.md b/docs/tutorials/dockerimages.md similarity index 98% rename from docs/userguide/containers/dockerimages.md rename to docs/tutorials/dockerimages.md index 7a8b96569e..487671bb86 100644 --- a/docs/userguide/containers/dockerimages.md +++ b/docs/tutorials/dockerimages.md @@ -1,6 +1,9 @@ diff --git a/docs/userguide/containers/dockerrepos.md b/docs/tutorials/dockerrepos.md similarity index 98% rename from docs/userguide/containers/dockerrepos.md rename to docs/tutorials/dockerrepos.md index 8274adb85d..d3b0ec0797 100644 --- a/docs/userguide/containers/dockerrepos.md +++ b/docs/tutorials/dockerrepos.md @@ -1,6 +1,9 @@ diff --git a/docs/userguide/containers/networkingcontainers.md b/docs/tutorials/networkingcontainers.md similarity index 98% rename from docs/userguide/containers/networkingcontainers.md rename to docs/tutorials/networkingcontainers.md index 9355e756f6..0f4a305a53 100644 --- a/docs/userguide/containers/networkingcontainers.md +++ b/docs/tutorials/networkingcontainers.md @@ -1,6 +1,9 @@ @@ -76,7 +79,7 @@ To see usage for a specific command, specify the command with the `--help` flag: > **Note:** > For further details and examples of each command, see the -> [command reference](../../reference/commandline/cli.md) in this guide. +> [command reference](../reference/commandline/cli.md) in this guide. ## Running a web application in Docker @@ -104,8 +107,8 @@ Lastly, you've specified a command for our container to run: `python app.py`. Th > **Note:** > You can see more detail on the `docker run` command in the [command -> reference](../../reference/commandline/run.md) and the [Docker Run -> Reference](../../reference/run.md). +> reference](../reference/commandline/run.md) and the [Docker Run +> Reference](../reference/run.md). ## Viewing our web application container diff --git a/docs/userguide/containers/webapp1.png b/docs/tutorials/webapp1.png similarity index 100% rename from docs/userguide/containers/webapp1.png rename to docs/tutorials/webapp1.png diff --git a/docs/userguide/index.md b/docs/userguide/index.md index 2509997518..90a6be2d22 100644 --- a/docs/userguide/index.md +++ b/docs/userguide/index.md @@ -6,7 +6,7 @@ keywords = ["engine, introduction, documentation, about, technology, docker, use [menu.main] parent="engine_use" identifier = "engine_guide" -weight="-80" +weight="-79" +++ @@ -18,12 +18,12 @@ This guide helps users learn how to use Docker Engine. ## Learn by example -- [Hello world in a container](containers/dockerizing.md) -- [Build your own images](containers/dockerimages.md) -- [Network containers](containers/networkingcontainers.md) -- [Run a simple application](containers/usingdocker.md) -- [Manage data in containers](containers/dockervolumes.md) -- [Store images on Docker Hub](containers/dockerrepos.md) +- [Hello world in a container](../tutorials/dockerizing.md) +- [Build your own images](../tutorials/dockerimages.md) +- [Network containers](../tutorials/networkingcontainers.md) +- [Run a simple application](../tutorials/usingdocker.md) +- [Manage data in containers](../tutorials/dockervolumes.md) +- [Store images on Docker Hub](../tutorials/dockerrepos.md) ## Work with images diff --git a/docs/userguide/intro.md b/docs/userguide/intro.md index 45084fb41a..715c3b1330 100644 --- a/docs/userguide/intro.md +++ b/docs/userguide/intro.md @@ -28,7 +28,7 @@ This guide is broken into major sections that take you through learning the basi Docker Engine offers a containerization platform to power your applications. To learn how to Dockerize applications and run them: -Go to [Dockerizing Applications](containers/dockerizing.md). +Go to [Dockerizing Applications](../tutorials/dockerizing.md). ## Working with containers @@ -38,7 +38,7 @@ Go to [Dockerizing Applications](containers/dockerizing.md). Once you get a grip on running your applications in Docker containers, you'll learn how to manage those containers. To find out about how to inspect, monitor and manage containers: -Go to [Working with Containers](containers/usingdocker.md). +Go to [Working with Containers](../tutorials/usingdocker.md). ## Working with Docker images @@ -47,7 +47,7 @@ Go to [Working with Containers](containers/usingdocker.md). Once you've learnt how to use Docker it's time to take the next step and learn how to build your own application images with Docker. -Go to [Working with Docker Images](containers/dockerimages.md). +Go to [Working with Docker Images](../tutorials/dockerimages.md). ## Networking containers @@ -55,14 +55,14 @@ Until now we've seen how to build individual applications inside Docker containers. Now learn how to build whole application stacks with Docker networking. -Go to [Networking Containers](containers/networkingcontainers.md). +Go to [Networking Containers](../tutorials/networkingcontainers.md). ## Managing data in containers Now we know how to link Docker containers together the next step is learning how to manage data, volumes and mounts inside our containers. -Go to [Managing Data in Containers](containers/dockervolumes.md). +Go to [Managing Data in Containers](../tutorials/dockervolumes.md). ## Docker products that complement Engine diff --git a/docs/userguide/networking/default_network/dockerlinks.md b/docs/userguide/networking/default_network/dockerlinks.md index cee84cbd0b..66299002e7 100644 --- a/docs/userguide/networking/default_network/dockerlinks.md +++ b/docs/userguide/networking/default_network/dockerlinks.md @@ -11,7 +11,7 @@ weight=-2 # Legacy container links -The information in this section explains legacy container links within the Docker default bridge. This is a `bridge` network named `bridge` created automatically when you install Docker. +The information in this section explains legacy container links within the Docker default bridge. This is a `bridge` network named `bridge` created automatically when you install Docker. Before the [Docker networks feature](../dockernetworks.md), you could use the Docker link feature to allow containers to discover each other and securely @@ -25,7 +25,7 @@ detail on container linking in default `bridge` network. ## Connect using network port mapping -In [the Using Docker section](../../containers/usingdocker.md), you created a +In [Run a simple application](../../../tutorials/usingdocker.md), you created a container that ran a Python Flask application: $ docker run -d -P training/webapp python app.py @@ -33,7 +33,7 @@ container that ran a Python Flask application: > **Note:** > Containers have an internal network and an IP address > (as we saw when we used the `docker inspect` command to show the container's -> IP address in the [Using Docker](../../containers/usingdocker.md) section). +> IP address in [Run a simple application](../../../tutorials/usingdocker.md) section). > Docker can have a variety of network configurations. You can see more > information on Docker networking [here](../index.md). diff --git a/docs/userguide/networking/dockernetworks.md b/docs/userguide/networking/dockernetworks.md index 22b8b346a3..eff2a87b36 100644 --- a/docs/userguide/networking/dockernetworks.md +++ b/docs/userguide/networking/dockernetworks.md @@ -95,7 +95,7 @@ worth looking at the default `bridge` network a bit. ### The default bridge network in detail -The default `bridge` network is present on all Docker hosts. The `docker network inspect` +The default `bridge` network is present on all Docker hosts. The `docker network inspect` command returns information about a network: ``` @@ -519,7 +519,7 @@ functionality in user-defined networks. - [Work with network commands](work-with-networks.md) - [Get started with multi-host networking](get-started-overlay.md) -- [Managing Data in Containers](../containers/dockervolumes.md) +- [Managing Data in Containers](../../tutorials/dockervolumes.md) - [Docker Machine overview](https://docs.docker.com/machine) - [Docker Swarm overview](https://docs.docker.com/swarm) - [Investigate the LibNetwork project](https://github.com/docker/libnetwork)