clearlinux/docker
2
0
Fork 0
mirror of https://github.com/clearlinux/docker.git synced 2026-09-07 22:42:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

Enabled GitHub Flavored Markdown

Browse Source 
GitHub flavored markdown is now supported for links and images. Also, ran LinkChecker and FileResolver. Yay!
Fixes from Spider check
Output for docker/docker now goes into engine directory

Signed-off-by: Mary Anthony <mary@docker.com>
This commit is contained in:
Mary Anthony
2015-10-11 07:49:54 -07:00
parent fb8217ee62
commit 8fee1c2020
112 changed files with 502 additions and 630 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/userguide/dockerimages.md
+11 -12
View File
@@ -11,9 +11,9 @@ weight = 1
# Get started with images
In the [introduction](/introduction/understanding-docker/) we've discovered that Docker
In the [introduction](../introduction/understanding-docker.md) we've discovered that Docker
images are the basis of containers. In the
[previous](/userguide/dockerizing/) [sections](/userguide/usingdocker/)
[previous](dockerizing.md) [sections](usingdocker.md)
we've used Docker images that already exist, for example the `ubuntu`
image and the `training/webapp` image.
@@ -51,7 +51,7 @@ do this using the `docker images` command like so:
ubuntu 10.04 3db9c44f4520 4 weeks ago 183 MB
ubuntu lucid 3db9c44f4520 4 weeks ago 183 MB
We can see the images we've previously used in our [user guide](/userguide/).
We can see the images we've previously used in our user guide.
Each has been downloaded from [Docker Hub](https://hub.docker.com) when we
launched a container using that image.
@@ -123,7 +123,7 @@ images for a variety of purposes. Many of these have been uploaded to
[Docker Hub](https://hub.docker.com). We can search these images on the
[Docker Hub](https://hub.docker.com) website.
![indexsearch](/userguide/search.png)
![indexsearch](search.png)
We can also search for images on the command line using the `docker search`
command. Let's say our team wants an image with Ruby and Sinatra installed on
@@ -146,9 +146,9 @@ We can see we've returned a lot of images that use the term `sinatra`. We've
returned a list of image names, descriptions, Stars (which measure the social
popularity of images - if a user likes an image then they can "star" it), and
the Official and Automated build statuses.
[Official Repositories](/docker-hub/official_repos) are a carefully curated set
[Official Repositories](https://docs.docker.com/docker-hub/official_repos) are a carefully curated set
of Docker repositories supported by Docker, Inc. Automated repositories are
[Automated Builds](/userguide/dockerrepos/#automated-builds) that allow you to
[Automated Builds](dockerrepos.md#automated-builds) that allow you to
validate the source and content of an image.
We've reviewed the images available to use and we decided to use the
@@ -286,7 +286,7 @@ updating our APT cache, installing Ruby and RubyGems and then installing the
Sinatra gem.
> **Note:**
> There are [a lot more instructions available to us in a Dockerfile](/reference/builder).
> There are [a lot more instructions available to us in a Dockerfile](../reference/builder.md).
Now let's take our `Dockerfile` and use the `docker build` command to build an image.
@@ -491,10 +491,10 @@ We can then create a container from our new image.
> This is just a brief introduction to creating images. We've
> skipped a whole bunch of other instructions that you can use. We'll see more of
> those instructions in later sections of the Guide or you can refer to the
> [`Dockerfile`](/reference/builder/) reference for a
> [`Dockerfile`](../reference/builder.md) reference for a
> detailed description and examples of every instruction.
> To help you write a clear, readable, maintainable `Dockerfile`, we've also
> written a [`Dockerfile` Best Practices guide](/articles/dockerfile_best-practices).
> written a [`Dockerfile` Best Practices guide](../articles/dockerfile_best-practices.md).
## Setting tags on an image
@@ -551,8 +551,7 @@ private repository](https://registry.hub.docker.com/plans/).
## Remove an image from the host
You can also remove images on your Docker host in a way [similar to
containers](
/userguide/usingdocker) using the `docker rmi` command.
containers](usingdocker.md) using the `docker rmi` command.
Let's delete the `training/sinatra` image as we don't need it anymore.
@@ -571,4 +570,4 @@ Until now we've seen how to build individual applications inside Docker
containers. Now learn how to build whole application stacks with Docker
by linking together multiple Docker containers.
Go to [Linking Containers Together](/userguide/dockerlinks).
Go to [Linking Containers Together](dockerlinks.md).
docs/userguide/dockerizing.md
+1 -1
View File
@@ -199,5 +199,5 @@ Excellent. Our container has been stopped.
Now we've seen how simple it is to get started with Docker. Let's learn how to
do some more advanced tasks.
Go to [Working With Containers](/userguide/usingdocker).
Go to [Working With Containers](usingdocker.md).
docs/userguide/dockerlinks.md
+5 -5
View File
@@ -11,7 +11,7 @@ weight = 4
# Linking containers together
In [the Using Docker section](/userguide/usingdocker), you saw how you can
In [the Using Docker section](usingdocker.md), you saw how you can
connect to a service running inside a Docker container via a network
port. But a port connection is only one way you can interact with services and
applications running inside Docker containers. In this section, we'll briefly revisit
@@ -20,7 +20,7 @@ container linking.
## Connect using network port mapping
In [the Using Docker section](/userguide/usingdocker), you created a
In [the Using Docker section](usingdocker.md), you created a
container that ran a Python Flask application:
$ docker run -d -P training/webapp python app.py
@@ -28,9 +28,9 @@ 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](/userguide/usingdocker/) section).
> IP address in the [Using Docker](usingdocker.md) section).
> Docker can have a variety of network configurations. You can see more
> information on Docker networking [here](/articles/networking/).
> information on Docker networking [here](../articles/networking.md).
When that container was created, the `-P` flag was used to automatically map
any network port inside it to a random high port within an *ephemeral port
@@ -349,5 +349,5 @@ allowing linked communication to continue.
Now that you know how to link Docker containers together, the next step is
learning how to take complete control over docker networking.
Go to [Docker Networking](/userguide/dockernetworks.md).
Go to [Docker Networking](dockernetworks.md).
docs/userguide/dockernetworks.md
+4 -4
View File
@@ -12,9 +12,9 @@ weight = 3
# Docker container networking
So far we've been introduced to some [basic Docker
concepts](/userguide/usingdocker/), seen how to work with [Docker
images](/userguide/dockerimages/) as well as learned about basic [networking
and links between containers](/userguide/dockerlinks/). In this section
concepts](usingdocker.md), seen how to work with [Docker
images](dockerimages.md) as well as learned about basic [networking
and links between containers](dockerlinks.md). In this section
we're going to discuss how you can take control over more advanced
container networking.
@@ -516,4 +516,4 @@ Example : `docker daemon --cluster-store=consul://localhost:8500`
Now that you know how to link Docker containers together, the next step is
learning how to manage data, volumes and mounts inside your containers.
Go to [Managing Data in Containers](/userguide/dockervolumes.md).
Go to [Managing Data in Containers](dockervolumes.md).
docs/userguide/dockerrepos.md
+5 -5
View File
@@ -12,8 +12,8 @@ weight = 2
# Get started with Docker Hub
So far you've learned how to use the command line to run Docker on your local host.
You've learned how to [pull down images](/userguide/usingdocker/) to build containers
from existing images and you've learned how to [create your own images](/userguide/dockerimages).
You've learned how to [pull down images](usingdocker.md) to build containers
from existing images and you've learned how to [create your own images](dockerimages.md).
Next, you're going to learn how to use the [Docker Hub](https://hub.docker.com) to
simplify and enhance your Docker workflows.
@@ -62,7 +62,7 @@ There you can see two example results: `centos` and `tianon/centos`. The second
result shows that it comes from the public repository of a user, named
`tianon/`, while the first result, `centos`, doesn't explicitly list a
repository which means that it comes from the trusted top-level namespace for
[Official Repositories](/docker-hub/official_repos). The `/` character separates
[Official Repositories](https://docs.docker.com/docker-hub/official_repos/). The `/` character separates
a user's repository from the image name.
Once you've found the image you want, you can download it with `docker pull <imagename>`:
@@ -94,13 +94,13 @@ see the [Docker Hub](https://hub.docker.com) registry.
Anyone can pull public images from the [Docker Hub](https://hub.docker.com)
registry, but if you would like to share your own images, then you must
[register first](/docker-hub/accounts).
[register first](https://docs.docker.com/docker-hub/accounts).
## Pushing a repository to Docker Hub
In order to push a repository to its registry, you need to have named an image
or committed your container to a named image as we saw
[here](/userguide/dockerimages).
[here](dockerimages.md).
Now you can push this repository to the registry designated by its name or tag.
docs/userguide/dockervolumes.md
+6 -6
View File
@@ -12,9 +12,9 @@ weight = 3
# Managing data in containers
So far we've been introduced to some [basic Docker
concepts](/userguide/usingdocker/), seen how to work with [Docker
images](/userguide/dockerimages/) as well as learned about [networking
and links between containers](/userguide/dockerlinks/). In this section
concepts](usingdocker.md), seen how to work with [Docker
images](dockerimages.md) as well as learned about [networking
and links between containers](dockerlinks.md). In this section
we're going to discuss how you can manage data inside and between your
Docker containers.
@@ -28,7 +28,7 @@ Docker.
A *data volume* is a specially-designated directory within one or more
containers that bypasses the [*Union File
System*](/reference/glossary#union-file-system). Data volumes provide several
System*](../reference/glossary.md#union-file-system). Data volumes provide several
useful features for persistent or shared data:
- Volumes are initialized when a container is created. If the container's
@@ -142,7 +142,7 @@ Mounting a host directory can be useful for testing. For example, you can mount
source code inside a container. Then, change the source code and see its effect
on the application in real time. The directory on the host must be specified as
an absolute path and if the directory doesn't exist Docker will automatically
create it for you. This auto-creation of the host path has been [*deprecated*](/userguide/dockervolumes/#auto-creating-missing-host-paths-for-bind-mounts).
create it for you. This auto-creation of the host path has been [*deprecated*](#auto-creating-missing-host-paths-for-bind-mounts).
Docker volumes default to mount in read-write mode, but you can also set it to
be mounted read-only.
@@ -281,4 +281,4 @@ combine Docker with the services available on
[Docker Hub](https://hub.docker.com) including Automated Builds and private
repositories.
Go to [Working with Docker Hub](/userguide/dockerrepos).
Go to [Working with Docker Hub](dockerrepos.md).
docs/userguide/image_management.md
+1 -1
View File
@@ -48,6 +48,6 @@ operates on. You use Docker to push and pull images (data) to a registry.
Content trust gives you the ability to both verify the integrity and the
publisher of all the data received from a registry over any channel.
[Content trust](/security/trust) is currently only available for users of the
[Content trust](../security/trust/) is currently only available for users of the
public Docker Hub. It is currently not available for the Docker Trusted Registry
or for private registries.
docs/userguide/index.md
+12 -12
View File
@@ -10,7 +10,7 @@ parent = "mn_fun_docker"
# Welcome to the Docker user guide
In the [Introduction](/misc) you got a taste of what Docker is and how it
In the [Introduction](../misc) you got a taste of what Docker is and how it
works. In this guide we're going to take you through the fundamentals of
using Docker and integrating it into your environment.
@@ -33,7 +33,7 @@ Docker Hub is the central hub for Docker. It hosts public Docker images
and provides services to help you build and manage your Docker
environment. To learn more:
Go to [Using Docker Hub](/docker-hub).
Go to [Using Docker Hub](https://docs.docker.com/docker-hub).
## Dockerizing applications: A "Hello world"
@@ -42,7 +42,7 @@ Go to [Using Docker Hub](/docker-hub).
Docker offers a *container-based* virtualization platform to power your
applications. To learn how to Dockerize applications and run them:
Go to [Dockerizing Applications](/docs/userguide/dockerizing.md).
Go to [Dockerizing Applications](dockerizing.md).
## Working with containers
@@ -52,7 +52,7 @@ Once you get a grip on running your applications in Docker containers
we're going to show you how to manage those containers. To find out
about how to inspect, monitor and manage containers:
Go to [Working With Containers](/docs/userguide/usingdocker.md).
Go to [Working With Containers](usingdocker.md).
## Working with Docker images
@@ -61,7 +61,7 @@ Go to [Working With Containers](/docs/userguide/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](/docs/userguide/dockerimages.md).
Go to [Working with Docker Images](dockerimages.md).
## Linking containers together
@@ -69,7 +69,7 @@ Until now we've seen how to build individual applications inside Docker
containers. Now learn how to build whole application stacks with Docker
by linking together multiple Docker containers.
Go to [Linking Containers Together](/docs/userguide/dockerlinks.md).
Go to [Linking Containers Together](dockerlinks.md).
## Docker container networking
@@ -79,14 +79,14 @@ choice to the end-users. Now, lets learn about a flexible way to connect
containers together within a host or across multiple hosts in a cluster
using various networking technologies, with the help of extensible plugins.
Go to [Docker Networking](/docs/userguide/dockernetworks.md).
Go to [Docker Networking](dockernetworks.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](/docs/userguide/dockervolumes.md).
Go to [Managing Data in Containers](dockervolumes.md).
## Working with Docker Hub
@@ -94,7 +94,7 @@ Now we've learned a bit more about how to use Docker we're going to see
how to combine Docker with the services available on Docker Hub including
Trusted Builds and private repositories.
Go to [Working with Docker Hub](/docs/userguide/dockerrepos.md).
Go to [Working with Docker Hub](dockerrepos.md).
## Docker Compose
@@ -102,7 +102,7 @@ Docker Compose allows you to define a application's components -- their containe
configuration, links and volumes -- in a single file. Then a single command
will set everything up and start your application running.
Go to [Docker Compose user guide](/compose/).
Go to [Docker Compose user guide](https://docs.docker.com/compose/).
## Docker Machine
@@ -111,7 +111,7 @@ can set up hosts for Docker Engines on your computer, on cloud providers,
and/or in your data center, and then configure your Docker client to securely
talk to them.
Go to [Docker Machine user guide](/machine/).
Go to [Docker Machine user guide](https://docs.docker.com/machine/).
## Docker Swarm
@@ -119,7 +119,7 @@ Docker Swarm pools several Docker Engines together and exposes them as a single
virtual Docker Engine. It serves the standard Docker API, so any tool that already
works with Docker can now transparently scale up to multiple hosts.
Go to [Docker Swarm user guide](/swarm/).
Go to [Docker Swarm user guide](https://docs.docker.com/swarm/).
## Getting help
docs/userguide/usingdocker.md
+9 -9
View File
@@ -10,7 +10,7 @@ parent="smn_containers"
# Working with containers
In the [last section of the Docker User Guide](/userguide/dockerizing)
In the [last section of the Docker User Guide](dockerizing.md)
we launched our first containers. We launched containers using the
`docker run` command:
@@ -82,7 +82,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/) in this guide.
> [command reference](../reference/commandline/cli.md) in this guide.
## Running a web application in Docker
@@ -110,8 +110,8 @@ Lastly, we've specified a command for our container to run: `python app.py`. Thi
> **Note:**
> You can see more detail on the `docker run` command in the [command
> reference](/reference/commandline/run) and the [Docker Run
> Reference](/reference/run/).
> reference](../reference/commandline/run.md) and the [Docker Run
> Reference](../reference/run.md).
## Viewing our web application container
@@ -130,7 +130,7 @@ command. This tells the `docker ps` command to return the details of the
> containers. If you want to see stopped containers too use the `-a` flag.
We can see the same details we saw [when we first Dockerized a
container](/userguide/dockerizing) with one important addition in the `PORTS`
container](dockerizing.md) with one important addition in the `PORTS`
column.
PORTS
@@ -141,7 +141,7 @@ ports exposed in our image to our host.
> **Note:**
> We'll learn more about how to expose ports in Docker images when
> [we learn how to build images](/userguide/dockerimages).
> [we learn how to build images](dockerimages.md).
In this case Docker has exposed port 5000 (the default Python Flask
port) on port 49155.
@@ -166,7 +166,7 @@ Docker host.
So let's now browse to port 49155 in a web browser to
see the application.
![Viewing the web application](/userguide/webapp1.png).
![Viewing the web application](webapp1.png).
Our Python application is live!
@@ -178,7 +178,7 @@ Our Python application is live!
> $ docker-machine ip my-docker-vm
> 192.168.99.100
>
> In this case you'd browse to http://192.168.99.100:49155 for the above example.
> In this case you'd browse to `http://192.168.99.100:49155` for the above example.
## A network port shortcut
@@ -309,5 +309,5 @@ Until now we've only used images that we've downloaded from
[Docker Hub](https://hub.docker.com). Next, let's get introduced to
building and sharing our own images.
Go to [Working with Docker Images](/userguide/dockerimages).
Go to [Working with Docker Images](dockerimages.md).