mirror of https://github.com/docker/docs.git
Created a little landing page for the examples, combined first two.
This commit is contained in:
parent
2d4ac06426
commit
fe99e51634
|
@ -2,6 +2,28 @@
|
||||||
:description: A simple hello world example with Docker
|
:description: A simple hello world example with Docker
|
||||||
:keywords: docker, example, hello world
|
:keywords: docker, example, hello world
|
||||||
|
|
||||||
|
.. _running_examples:
|
||||||
|
|
||||||
|
Running the Examples
|
||||||
|
====================
|
||||||
|
|
||||||
|
All the examples assume your machine is running the docker daemon. To
|
||||||
|
run the docker daemon in the background, simply type:
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
|
sudo docker -d &
|
||||||
|
|
||||||
|
Now you can run docker in client mode: by defalt all commands will be
|
||||||
|
forwarded to the ``docker`` daemon via a protected Unix socket, so you
|
||||||
|
must run as root.
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
|
sudo docker help
|
||||||
|
|
||||||
|
----
|
||||||
|
|
||||||
.. _hello_world:
|
.. _hello_world:
|
||||||
|
|
||||||
Hello World
|
Hello World
|
||||||
|
@ -49,4 +71,108 @@ See the example in action
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
Continue to the :ref:`hello_world_daemon` example.
|
----
|
||||||
|
|
||||||
|
.. _hello_world_daemon:
|
||||||
|
|
||||||
|
Hello World Daemon
|
||||||
|
==================
|
||||||
|
|
||||||
|
.. include:: example_header.inc
|
||||||
|
|
||||||
|
And now for the most boring daemon ever written!
|
||||||
|
|
||||||
|
This example assumes you have Docker installed and the Ubuntu
|
||||||
|
image already imported with ``docker pull ubuntu``. We will use the Ubuntu
|
||||||
|
image to run a simple hello world daemon that will just print hello
|
||||||
|
world to standard out every second. It will continue to do this until
|
||||||
|
we stop it.
|
||||||
|
|
||||||
|
**Steps:**
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
|
CONTAINER_ID=$(sudo docker run -d ubuntu /bin/sh -c "while true; do echo hello world; sleep 1; done")
|
||||||
|
|
||||||
|
We are going to run a simple hello world daemon in a new container
|
||||||
|
made from the *ubuntu* image.
|
||||||
|
|
||||||
|
- **"docker run -d "** run a command in a new container. We pass "-d"
|
||||||
|
so it runs as a daemon.
|
||||||
|
- **"ubuntu"** is the image we want to run the command inside of.
|
||||||
|
- **"/bin/sh -c"** is the command we want to run in the container
|
||||||
|
- **"while true; do echo hello world; sleep 1; done"** is the mini
|
||||||
|
script we want to run, that will just print hello world once a
|
||||||
|
second until we stop it.
|
||||||
|
- **$CONTAINER_ID** the output of the run command will return a
|
||||||
|
container id, we can use in future commands to see what is going on
|
||||||
|
with this process.
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
|
sudo docker logs $CONTAINER_ID
|
||||||
|
|
||||||
|
Check the logs make sure it is working correctly.
|
||||||
|
|
||||||
|
- **"docker logs**" This will return the logs for a container
|
||||||
|
- **$CONTAINER_ID** The Id of the container we want the logs for.
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
|
sudo docker attach $CONTAINER_ID
|
||||||
|
|
||||||
|
Attach to the container to see the results in realtime.
|
||||||
|
|
||||||
|
- **"docker attach**" This will allow us to attach to a background
|
||||||
|
process to see what is going on.
|
||||||
|
- **$CONTAINER_ID** The Id of the container we want to attach too.
|
||||||
|
|
||||||
|
Exit from the container attachment by pressing Control-C.
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
|
sudo docker ps
|
||||||
|
|
||||||
|
Check the process list to make sure it is running.
|
||||||
|
|
||||||
|
- **"docker ps"** this shows all running process managed by docker
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
|
sudo docker stop $CONTAINER_ID
|
||||||
|
|
||||||
|
Stop the container, since we don't need it anymore.
|
||||||
|
|
||||||
|
- **"docker stop"** This stops a container
|
||||||
|
- **$CONTAINER_ID** The Id of the container we want to stop.
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
|
sudo docker ps
|
||||||
|
|
||||||
|
Make sure it is really stopped.
|
||||||
|
|
||||||
|
|
||||||
|
**Video:**
|
||||||
|
|
||||||
|
See the example in action
|
||||||
|
|
||||||
|
.. raw:: html
|
||||||
|
|
||||||
|
<div style="margin-top:10px;">
|
||||||
|
<iframe width="560" height="350" src="http://ascii.io/a/2562/raw" frameborder="0"></iframe>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
The next example in the series is a :ref:`python_web_app` example, or
|
||||||
|
you could skip to any of the other examples:
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
python_web_app
|
||||||
|
nodejs_web_app
|
||||||
|
running_redis_service
|
||||||
|
running_ssh_service
|
||||||
|
couchdb_data_volumes
|
||||||
|
postgresql_service
|
||||||
|
mongodb
|
||||||
|
|
|
@ -1,95 +0,0 @@
|
||||||
:title: Hello world daemon example
|
|
||||||
:description: A simple hello world daemon example with Docker
|
|
||||||
:keywords: docker, example, hello world, daemon
|
|
||||||
|
|
||||||
.. _hello_world_daemon:
|
|
||||||
|
|
||||||
Hello World Daemon
|
|
||||||
==================
|
|
||||||
|
|
||||||
.. include:: example_header.inc
|
|
||||||
|
|
||||||
The most boring daemon ever written.
|
|
||||||
|
|
||||||
This example assumes you have Docker installed and the Ubuntu
|
|
||||||
image already imported with ``docker pull ubuntu``. We will use the Ubuntu
|
|
||||||
image to run a simple hello world daemon that will just print hello
|
|
||||||
world to standard out every second. It will continue to do this until
|
|
||||||
we stop it.
|
|
||||||
|
|
||||||
**Steps:**
|
|
||||||
|
|
||||||
.. code-block:: bash
|
|
||||||
|
|
||||||
CONTAINER_ID=$(sudo docker run -d ubuntu /bin/sh -c "while true; do echo hello world; sleep 1; done")
|
|
||||||
|
|
||||||
We are going to run a simple hello world daemon in a new container
|
|
||||||
made from the *ubuntu* image.
|
|
||||||
|
|
||||||
- **"docker run -d "** run a command in a new container. We pass "-d"
|
|
||||||
so it runs as a daemon.
|
|
||||||
- **"ubuntu"** is the image we want to run the command inside of.
|
|
||||||
- **"/bin/sh -c"** is the command we want to run in the container
|
|
||||||
- **"while true; do echo hello world; sleep 1; done"** is the mini
|
|
||||||
script we want to run, that will just print hello world once a
|
|
||||||
second until we stop it.
|
|
||||||
- **$CONTAINER_ID** the output of the run command will return a
|
|
||||||
container id, we can use in future commands to see what is going on
|
|
||||||
with this process.
|
|
||||||
|
|
||||||
.. code-block:: bash
|
|
||||||
|
|
||||||
sudo docker logs $CONTAINER_ID
|
|
||||||
|
|
||||||
Check the logs make sure it is working correctly.
|
|
||||||
|
|
||||||
- **"docker logs**" This will return the logs for a container
|
|
||||||
- **$CONTAINER_ID** The Id of the container we want the logs for.
|
|
||||||
|
|
||||||
.. code-block:: bash
|
|
||||||
|
|
||||||
sudo docker attach $CONTAINER_ID
|
|
||||||
|
|
||||||
Attach to the container to see the results in realtime.
|
|
||||||
|
|
||||||
- **"docker attach**" This will allow us to attach to a background
|
|
||||||
process to see what is going on.
|
|
||||||
- **$CONTAINER_ID** The Id of the container we want to attach too.
|
|
||||||
|
|
||||||
Exit from the container attachment by pressing Control-C.
|
|
||||||
|
|
||||||
.. code-block:: bash
|
|
||||||
|
|
||||||
sudo docker ps
|
|
||||||
|
|
||||||
Check the process list to make sure it is running.
|
|
||||||
|
|
||||||
- **"docker ps"** this shows all running process managed by docker
|
|
||||||
|
|
||||||
.. code-block:: bash
|
|
||||||
|
|
||||||
sudo docker stop $CONTAINER_ID
|
|
||||||
|
|
||||||
Stop the container, since we don't need it anymore.
|
|
||||||
|
|
||||||
- **"docker stop"** This stops a container
|
|
||||||
- **$CONTAINER_ID** The Id of the container we want to stop.
|
|
||||||
|
|
||||||
.. code-block:: bash
|
|
||||||
|
|
||||||
sudo docker ps
|
|
||||||
|
|
||||||
Make sure it is really stopped.
|
|
||||||
|
|
||||||
|
|
||||||
**Video:**
|
|
||||||
|
|
||||||
See the example in action
|
|
||||||
|
|
||||||
.. raw:: html
|
|
||||||
|
|
||||||
<div style="margin-top:10px;">
|
|
||||||
<iframe width="560" height="350" src="http://ascii.io/a/2562/raw" frameborder="0"></iframe>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
Continue to the :ref:`python_web_app` example.
|
|
|
@ -5,16 +5,16 @@
|
||||||
|
|
||||||
|
|
||||||
Examples
|
Examples
|
||||||
============
|
========
|
||||||
|
|
||||||
Contents:
|
Here are some examples of how to use Docker to create running
|
||||||
|
processes, starting from a very simple *Hello World* and progressing
|
||||||
|
to more substantial services like you might find in production.
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
|
||||||
running_examples
|
|
||||||
hello_world
|
hello_world
|
||||||
hello_world_daemon
|
|
||||||
python_web_app
|
python_web_app
|
||||||
nodejs_web_app
|
nodejs_web_app
|
||||||
running_redis_service
|
running_redis_service
|
||||||
|
|
|
@ -1,23 +0,0 @@
|
||||||
:title: Running the Examples
|
|
||||||
:description: An overview on how to run the docker examples
|
|
||||||
:keywords: docker, examples, how to
|
|
||||||
|
|
||||||
.. _running_examples:
|
|
||||||
|
|
||||||
Running the Examples
|
|
||||||
--------------------
|
|
||||||
|
|
||||||
All the examples assume your machine is running the docker daemon. To
|
|
||||||
run the docker daemon in the background, simply type:
|
|
||||||
|
|
||||||
.. code-block:: bash
|
|
||||||
|
|
||||||
sudo docker -d &
|
|
||||||
|
|
||||||
Now you can run docker in client mode: by defalt all commands will be
|
|
||||||
forwarded to the ``docker`` daemon via a protected Unix socket, so you
|
|
||||||
must run as root.
|
|
||||||
|
|
||||||
.. code-block:: bash
|
|
||||||
|
|
||||||
sudo docker help
|
|
|
@ -113,10 +113,6 @@
|
||||||
<form>
|
<form>
|
||||||
<input type="text" id="st-search-input" class="st-search-input span3" style="width:160px;" />
|
<input type="text" id="st-search-input" class="st-search-input span3" style="width:160px;" />
|
||||||
</form>
|
</form>
|
||||||
<a href="http://swiftype.com?ref=pb">
|
|
||||||
<img id="swiftype-img" src="http://swiftype.com/assets/media/swiftype-logo-lightbg-small.png"
|
|
||||||
alt="Search by Swiftype" />
|
|
||||||
</a>
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<!-- body block -->
|
<!-- body block -->
|
||||||
|
|
Loading…
Reference in New Issue