From f87aa7e336ea4eba16042d17304cca146d75ebb7 Mon Sep 17 00:00:00 2001 From: Thatcher Peskens Date: Tue, 26 Mar 2013 12:00:46 -0700 Subject: [PATCH 1/4] Added files REQUIRED to have succesfull gh-pages deploy (i.c.w. sphinx) --- docs/Makefile | 2 ++ docs/sources/.nojekyll | 0 docs/sources/CNAME | 1 + docs/sources/documentation/installation/macos.rst | 2 +- docs/sources/documentation/installation/windows.rst | 2 +- 5 files changed, 5 insertions(+), 2 deletions(-) create mode 100644 docs/sources/.nojekyll create mode 100644 docs/sources/CNAME diff --git a/docs/Makefile b/docs/Makefile index f58854dcdb..a9006a062d 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -49,6 +49,8 @@ docs: cp sources/index.html $(BUILDDIR)/html/ cp sources/gettingstarted.html $(BUILDDIR)/html/ cp sources/dotcloud.yml $(BUILDDIR)/html/ + cp sources/CNAME $(BUILDDIR)/html/ + cp sources/.nojekyll $(BUILDDIR)/html/ @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." diff --git a/docs/sources/.nojekyll b/docs/sources/.nojekyll new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/sources/CNAME b/docs/sources/CNAME new file mode 100644 index 0000000000..243e482261 --- /dev/null +++ b/docs/sources/CNAME @@ -0,0 +1 @@ +docker.io diff --git a/docs/sources/documentation/installation/macos.rst b/docs/sources/documentation/installation/macos.rst index 1f46b838a5..199c37b746 100644 --- a/docs/sources/documentation/installation/macos.rst +++ b/docs/sources/documentation/installation/macos.rst @@ -2,7 +2,7 @@ Mac OS X and other linux ======================== - Please note the only 'official' installation is using the :ref:`ubuntu_linux` installation path. This version + Please note this is a community contributed installation path. The only 'official' installation is using the :ref:`ubuntu_linux` installation path. This version may be out of date because it depends on some binaries to be updated and published diff --git a/docs/sources/documentation/installation/windows.rst b/docs/sources/documentation/installation/windows.rst index 7c0b15be4b..105fb7aaff 100644 --- a/docs/sources/documentation/installation/windows.rst +++ b/docs/sources/documentation/installation/windows.rst @@ -6,7 +6,7 @@ Windows ========= - Please note the only 'official' installation is using the :ref:`ubuntu_linux` installation path. This version + Please note this is a community contributed installation path. The only 'official' installation is using the :ref:`ubuntu_linux` installation path. This version may be out of date because it depends on some binaries to be updated and published From 84df72222d82fe5530da8f9c42156169519037d8 Mon Sep 17 00:00:00 2001 From: Thatcher Peskens Date: Tue, 26 Mar 2013 14:31:45 -0700 Subject: [PATCH 2/4] Typo in macosx tutorial --- docs/sources/documentation/installation/macos.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sources/documentation/installation/macos.rst b/docs/sources/documentation/installation/macos.rst index 199c37b746..09eca22b92 100644 --- a/docs/sources/documentation/installation/macos.rst +++ b/docs/sources/documentation/installation/macos.rst @@ -32,7 +32,7 @@ Installation .. code-block:: bash - vagant up + vagrant up Vagrant will: From 8cfaf658ccae041400f142227d0813ceb0f263db Mon Sep 17 00:00:00 2001 From: Thatcher Peskens Date: Tue, 26 Mar 2013 18:21:52 -0700 Subject: [PATCH 3/4] Updated hello world examples --- .../documentation/examples/hello_world.rst | 24 +++++++++++++++---- .../examples/hello_world_daemon.rst | 24 +++++++++++++------ 2 files changed, 37 insertions(+), 11 deletions(-) diff --git a/docs/sources/documentation/examples/hello_world.rst b/docs/sources/documentation/examples/hello_world.rst index b6c07a2b91..581608488e 100644 --- a/docs/sources/documentation/examples/hello_world.rst +++ b/docs/sources/documentation/examples/hello_world.rst @@ -8,19 +8,34 @@ Hello World =========== This is the most basic example available for using docker -This example assumes you have Docker installed and it will download the busybox image and then use that image to run a simple echo command, that will echo hello world back to the console over standard out. +This example assumes you have Docker installed. + + +Download the base container .. code-block:: bash - $ docker run busybox /bin/echo hello world + # Download a base image + docker pull base + +The *base* image is a minimal Debian based container, alternatively you can select *busybox*, a bare +minimal linux system. The images are retrieved from the docker repository. + + +.. code-block:: bash + + #run a simple echo command, that will echo hello world back to the console over standard out. + docker run base /bin/echo hello world **Explanation:** - **"docker run"** run a command in a new container -- **"busybox"** is the image we want to run the command inside of. +- **"base"** is the image we want to run the command inside of. - **"/bin/echo"** is the command we want to run in the container - **"hello world"** is the input for the echo command + + **Video:** See the example in action @@ -28,7 +43,8 @@ See the example in action .. raw:: html
- +
+ Continue to the :ref:`hello_world_daemon` example. \ No newline at end of file diff --git a/docs/sources/documentation/examples/hello_world_daemon.rst b/docs/sources/documentation/examples/hello_world_daemon.rst index 8abe0e735a..fc3095e1e0 100644 --- a/docs/sources/documentation/examples/hello_world_daemon.rst +++ b/docs/sources/documentation/examples/hello_world_daemon.rst @@ -8,18 +8,20 @@ Hello World Daemon ================== The most boring daemon ever written. -This example assumes you have Docker installed and with the busybox image already imported. We will use the busybox 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. +This example assumes you have Docker installed and with the base image already imported ``docker pull base``. +We will use the base 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=$(docker run -d busybox /bin/sh -c "while true; do echo hello world; sleep 1; done") + $ CONTAINER_ID=$(docker run -d base /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 busybox daemon. - **"docker run -d "** run a command in a new container. We pass "-d" so it runs as a daemon. -- **"busybox"** is the image we want to run the command inside of. +- **"base"** 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. @@ -35,7 +37,7 @@ Check the logs make sure it is working correctly. .. code-block:: bash - $ docker attach $CONTAINER_ID + docker attach $CONTAINER_ID Attach to the container to see the results in realtime. @@ -44,7 +46,7 @@ Attach to the container to see the results in realtime. .. code-block:: bash - $ docker ps + docker ps Check the process list to make sure it is running. @@ -61,7 +63,7 @@ Stop the container, since we don't need it anymore. .. code-block:: bash - $ docker ps + docker ps Make sure it is really stopped. @@ -76,4 +78,12 @@ See the example in action -Continue to the :ref:`python_web_app` example. \ No newline at end of file +Continue to the :ref:`python_web_app` example. + + +Notes: +------ + +- **Docker daemon** The docker daemon is started by ``sudo docker -d``, Vagrant may have started + the Docker daemon for you, but you will need to restart it this way if it was terminated. Otherwise + it may give you ``Couldn't create Tag store: open /var/lib/docker/repositories: permission denied`` From 502f772839859823639aef1add8d5463e5be11fc Mon Sep 17 00:00:00 2001 From: Thatcher Peskens Date: Tue, 26 Mar 2013 18:28:46 -0700 Subject: [PATCH 4/4] not debian, but ubuntu is in base image --- docs/sources/documentation/examples/hello_world.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sources/documentation/examples/hello_world.rst b/docs/sources/documentation/examples/hello_world.rst index 581608488e..9e3988960d 100644 --- a/docs/sources/documentation/examples/hello_world.rst +++ b/docs/sources/documentation/examples/hello_world.rst @@ -18,7 +18,7 @@ Download the base container # Download a base image docker pull base -The *base* image is a minimal Debian based container, alternatively you can select *busybox*, a bare +The *base* image is a minimal *ubuntu* based container, alternatively you can select *busybox*, a bare minimal linux system. The images are retrieved from the docker repository.