deleted file mode 100644

@@ -1,67 +0,0 @@

-:title: Base commands

-:description: Common usage and commands

-:keywords: Examples, Usage

-

-

-Base commands

-=============

-

-

-Running an interactive shell

-

-.. code-block:: bash

-

-  # Download a base image

-  docker pull base

-

-  # Run an interactive shell in the base image,

-  # allocate a tty, attach stdin and stdout

-  docker run -i -t base /bin/bash

-

-

-Starting a long-running worker process

-

-.. code-block:: bash

-

-  # Run docker in daemon mode

-  (sudo docker -d || echo "Docker daemon already running") &

-

-  # Start a very useful long-running process

-  JOB=$(docker run -d base /bin/sh -c "while true; do echo Hello world; sleep 1; done")

-

-  # Collect the output of the job so far

-  docker logs $JOB

-

-  # Kill the job

-  docker kill $JOB

-

-

-Listing all running containers

-

-.. code-block:: bash

-

-  docker ps

-

-Expose a service on a TCP port

-

-.. code-block:: bash

-

-  # Expose port 4444 of this container, and tell netcat to listen on it

-  JOB=$(docker run -d -p 4444 base /bin/nc -l -p 4444)

-

-  # Which public port is NATed to my container?

-  PORT=$(docker port $JOB 4444)

-

-  # Connect to the public port via the host's public address

-  echo hello world | nc $(hostname) $PORT

-

-  # Verify that the network connection worked

-  echo "Daemon received: $(docker logs $JOB)"

-

-Continue to the complete `Command Line Interface`_

-

-.. _Command Line Interface: ../commandline/cli.html

new file mode 100644

@@ -0,0 +1,100 @@

+:title: Base commands

+:description: Common usage and commands

+:keywords: Examples, Usage

+

+

+The basics

+=============

+

+Starting Docker

+---------------

+

+If you have used one of the quick install paths', Docker may have been installed with upstart, Ubuntu's

+system for starting processes at boot time. You should be able to run ``docker help`` and get output.

+

+If you get ``docker: command not found`` or something like ``/var/lib/docker/repositories: permission denied``

+you will need to specify the path to it and manually start it.

+

+.. code-block:: bash

+

+    # Run docker in daemon mode

+    sudo <path to>/docker -d &

+

+

+Running an interactive shell

+----------------------------

+

+.. code-block:: bash

+

+  # Download a base image

+  docker pull base

+

+  # Run an interactive shell in the base image,

+  # allocate a tty, attach stdin and stdout

+  docker run -i -t base /bin/bash

+

+

+Starting a long-running worker process

+--------------------------------------

+

+.. code-block:: bash

+

+  # Start a very useful long-running process

+  JOB=$(docker run -d base /bin/sh -c "while true; do echo Hello world; sleep 1; done")

+

+  # Collect the output of the job so far

+  docker logs $JOB

+

+  # Kill the job

+  docker kill $JOB

+

+

+Listing all running containers

+------------------------------

+

+.. code-block:: bash

+

+  docker ps

+

+Expose a service on a TCP port

+------------------------------

+

+.. code-block:: bash

+

+  # Expose port 4444 of this container, and tell netcat to listen on it

+  JOB=$(docker run -d -p 4444 base /bin/nc -l -p 4444)

+

+  # Which public port is NATed to my container?

+  PORT=$(docker port $JOB 4444)

+

+  # Connect to the public port via the host's public address

+  # Please note that because of how routing works connecting to localhost or 127.0.0.1 $PORT will not work.

+  echo hello world | nc $(hostname) $PORT

+

+  # Verify that the network connection worked

+  echo "Daemon received: $(docker logs $JOB)"

+

+

+Committing (saving) an image

+-----------------------------

+

+Save your containers state to a container image, so the state can be re-used.

+

+When you commit your container only the differences between the image the container was created from

+and the current state of the container will be stored (as a diff). See which images you already have

+using ``docker images``

+

+.. code-block:: bash

+

+    # Commit your container to a new named image

+    docker commit <container_id> <some_name>

+

+    # List your containers

+    docker images

+

+You now have a image state from which you can create new instances.

+

+

+

+Read more about :ref:`working_with_the_repository` or continue to the complete :ref:`cli`

+

@@ -2,6 +2,7 @@

 :description: Docker's CLI command description and usage

 :keywords: Docker, Docker documentation, CLI, command line

+.. _cli:

 Command Line Interface

 ======================

@@ -118,9 +119,9 @@ import

 ::

-Usage: docker import [OPTIONS] URL|- [REPOSITORY [TAG]]

+    Usage: docker import [OPTIONS] URL|- [REPOSITORY [TAG]]

-Create a new filesystem image from the contents of a tarball

+    Create a new filesystem image from the contents of a tarball

 info

@@ -258,7 +259,6 @@ run

   Run a command in a new container

-    -a=false: Attach stdin and stdout

     -c="": Comment

     -i=false: Keep stdin open even if not attached

     -m=0: Memory limit (in bytes)

@@ -11,5 +11,6 @@ Contents:

 .. toctree::

   :maxdepth: 2

-  basecommands

+  basics

+  workingwithrepository

   cli

\ No newline at end of file

new file mode 100644

@@ -0,0 +1,42 @@

+.. _working_with_the_repository:

+

+Working with the repository

+============================

+

+Connecting to the repository

+----------------------------

+

+You create a user on the central docker repository by running

+

+.. code-block:: bash

+

+    docker login

+

+

+If your username does not exist it will prompt you to also enter a password and your e-mail address. It will then

+automatically log you in.

+

+

+Committing a container to a named image

+---------------------------------------

+

+In order to commit to the repository it is required to have committed your container to an image with your namespace.

+

+.. code-block:: bash

+

+    # for example docker commit $CONTAINER_ID dhrp/kickassapp

+    docker commit <container_id> <your username>/<some_name>

+

+

+Pushing a container to the repository

+-----------------------------------------

+

+In order to push an image to the repository you need to have committed your container to a named image (see above)

+

+Now you can commit this image to the repository

+

+.. code-block:: bash

+

+    # for example docker push dhrp/kickassapp

+    docker push <image-name>

+

new file mode 100644

@@ -0,0 +1,25 @@

+:title: Building blocks

+:description: An introduction to docker and standard containers?

+:keywords: containers, lxc, concepts, explanation

+

+

+Building blocks

+===============

+

+.. _images:

+

+Images

+------

+An original container image. These are stored on disk and are comparable with what you normally expect from a stoppped virtual machine image. Images are stored (and retrieved from) repository

+

+Images are stored on your local file system under /var/lib/docker/images

+

+

+.. _containers:

+

+Containers

+----------

+A container is a local version of an image. It can be running or stopped, The equivalent would be a virtual machine instance.

+

+Containers are stored on your local file system under /var/lib/docker/containers

+

@@ -1,11 +1,27 @@

-:title: Containers

-:description: What are standard containers?

+:title: Introduction

+:description: An introduction to docker and standard containers?

 :keywords: containers, lxc, concepts, explanation

+:note: This version of the introduction is temporary, just to make sure we don't break the links from the website when the documentation is updated

+

+

+Introduction

+============

+

+Docker - The Linux container runtime

+------------------------------------

+

+Docker complements LXC with a high-level API which operates at the process level. It runs unix processes with strong guarantees of isolation and repeatability across servers.

+

+Docker is a great building block for automating distributed systems: large-scale web deployments, database clusters, continuous deployment systems, private PaaS, service-oriented architectures, etc.

+

+

+- **Heterogeneous payloads** Any combination of binaries, libraries, configuration files, scripts, virtualenvs, jars, gems, tarballs, you name it. No more juggling between domain-specific tools. Docker can deploy and run them all.

+- **Any server** Docker can run on any x64 machine with a modern linux kernel - whether it's a laptop, a bare metal server or a VM. This makes it perfect for multi-cloud deployments.

+- **Isolation** docker isolates processes from each other and from the underlying host, using lightweight containers.

+- **Repeatability** Because containers are isolated in their own filesystem, they behave the same regardless of where, when, and alongside what they run.

-Standard Containers

-===================

 What is a Standard Container?

@@ -19,25 +35,25 @@ The spec for Standard Containers is currently work in progress, but it is very s

 A great analogy for this is the shipping container. Just like Standard Containers are a fundamental unit of software delivery, shipping containers (http://bricks.argz.com/ins/7823-1/12) are a fundamental unit of physical delivery.

 Standard operations

+~~~~~~~~~~~~~~~~~~~

 Just like shipping containers, Standard Containers define a set of STANDARD OPERATIONS. Shipping containers can be lifted, stacked, locked, loaded, unloaded and labelled. Similarly, standard containers can be started, stopped, copied, snapshotted, downloaded, uploaded and tagged.

 Content-agnostic

+~~~~~~~~~~~~~~~~~~~

 Just like shipping containers, Standard Containers are CONTENT-AGNOSTIC: all standard operations have the same effect regardless of the contents. A shipping container will be stacked in exactly the same way whether it contains Vietnamese powder coffee or spare Maserati parts. Similarly, Standard Containers are started or uploaded in the same way whether they contain a postgres database, a php application with its dependencies and application server, or Java build artifacts.

 Infrastructure-agnostic

+~~~~~~~~~~~~~~~~~~~~~~~~~~

 Both types of containers are INFRASTRUCTURE-AGNOSTIC: they can be transported to thousands of facilities around the world, and manipulated by a wide variety of equipment. A shipping container can be packed in a factory in Ukraine, transported by truck to the nearest routing center, stacked onto a train, loaded into a German boat by an Australian-built crane, stored in a warehouse at a US facility, etc. Similarly, a standard container can be bundled on my laptop, uploaded to S3, downloaded, run and snapshotted by a build server at Equinix in Virginia, uploaded to 10 staging servers in a home-made Openstack cluster, then sent to 30 production instances across 3 EC2 regions.

 Designed for automation

+~~~~~~~~~~~~~~~~~~~~~~~~~~

 Because they offer the same standard operations regardless of content and infrastructure, Standard Containers, just like their physical counterpart, are extremely well-suited for automation. In fact, you could say automation is their secret weapon.

@@ -47,7 +63,7 @@ Similarly, before Standard Containers, by the time a software component ran in p

 Industrial-grade delivery

+~~~~~~~~~~~~~~~~~~~~~~~~~~

 There are 17 million shipping containers in existence, packed with every physical good imaginable. Every single one of them can be loaded on the same boats, by the same cranes, in the same facilities, and sent anywhere in the World with incredible efficiency. It is embarrassing to think that a 30 ton shipment of coffee can safely travel half-way across the World in *less time* than it takes a software team to deliver its code from one datacenter to another sitting 10 miles away.

@@ -55,7 +71,7 @@ With Standard Containers we can put an end to that embarrassment, by making INDU

 Standard Container Specification

+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

 (TODO)

@@ -12,5 +12,6 @@ Contents:

 .. toctree::

    :maxdepth: 1

-   containers

+   introduction

+   buildingblocks

new file mode 100644

@@ -0,0 +1,127 @@

+:title: Introduction

+:description: An introduction to docker and standard containers?

+:keywords: containers, lxc, concepts, explanation

+

+

+

+Introduction

+============

+

+Docker - The Linux container runtime

+------------------------------------

+

+Docker complements LXC with a high-level API which operates at the process level. It runs unix processes with strong guarantees of isolation and repeatability across servers.

+

+Docker is a great building block for automating distributed systems: large-scale web deployments, database clusters, continuous deployment systems, private PaaS, service-oriented architectures, etc.

+

+

+- **Heterogeneous payloads** Any combination of binaries, libraries, configuration files, scripts, virtualenvs, jars, gems, tarballs, you name it. No more juggling between domain-specific tools. Docker can deploy and run them all.

+- **Any server** Docker can run on any x64 machine with a modern linux kernel - whether it's a laptop, a bare metal server or a VM. This makes it perfect for multi-cloud deployments.

+- **Isolation** docker isolates processes from each other and from the underlying host, using lightweight containers.

+- **Repeatability** Because containers are isolated in their own filesystem, they behave the same regardless of where, when, and alongside what they run.

+

+.. image:: http://www.docker.io/_static/lego_docker.jpg

+

+

+What is a Standard Container?

+-----------------------------

+

+Docker defines a unit of software delivery called a Standard Container. The goal of a Standard Container is to encapsulate a software component and all its dependencies in

+a format that is self-describing and portable, so that any compliant runtime can run it without extra dependency, regardless of the underlying machine and the contents of the container.

+

+The spec for Standard Containers is currently work in progress, but it is very straightforward. It mostly defines 1) an image format, 2) a set of standard operations, and 3) an execution environment.

+

+A great analogy for this is the shipping container. Just like Standard Containers are a fundamental unit of software delivery, shipping containers (http://bricks.argz.com/ins/7823-1/12) are a fundamental unit of physical delivery.

+

+Standard operations

+~~~~~~~~~~~~~~~~~~~

+

+Just like shipping containers, Standard Containers define a set of STANDARD OPERATIONS. Shipping containers can be lifted, stacked, locked, loaded, unloaded and labelled. Similarly, standard containers can be started, stopped, copied, snapshotted, downloaded, uploaded and tagged.

+

+

+Content-agnostic

+~~~~~~~~~~~~~~~~~~~

+

+Just like shipping containers, Standard Containers are CONTENT-AGNOSTIC: all standard operations have the same effect regardless of the contents. A shipping container will be stacked in exactly the same way whether it contains Vietnamese powder coffee or spare Maserati parts. Similarly, Standard Containers are started or uploaded in the same way whether they contain a postgres database, a php application with its dependencies and application server, or Java build artifacts.

+

+

+Infrastructure-agnostic

+~~~~~~~~~~~~~~~~~~~~~~~~~~

+

+Both types of containers are INFRASTRUCTURE-AGNOSTIC: they can be transported to thousands of facilities around the world, and manipulated by a wide variety of equipment. A shipping container can be packed in a factory in Ukraine, transported by truck to the nearest routing center, stacked onto a train, loaded into a German boat by an Australian-built crane, stored in a warehouse at a US facility, etc. Similarly, a standard container can be bundled on my laptop, uploaded to S3, downloaded, run and snapshotted by a build server at Equinix in Virginia, uploaded to 10 staging servers in a home-made Openstack cluster, then sent to 30 production instances across 3 EC2 regions.

+

+

+Designed for automation

+~~~~~~~~~~~~~~~~~~~~~~~~~~

+

+Because they offer the same standard operations regardless of content and infrastructure, Standard Containers, just like their physical counterpart, are extremely well-suited for automation. In fact, you could say automation is their secret weapon.

+

+Many things that once required time-consuming and error-prone human effort can now be programmed. Before shipping containers, a bag of powder coffee was hauled, dragged, dropped, rolled and stacked by 10 different people in 10 different locations by the time it reached its destination. 1 out of 50 disappeared. 1 out of 20 was damaged. The process was slow, inefficient and cost a fortune - and was entirely different depending on the facility and the type of goods.

+

+Similarly, before Standard Containers, by the time a software component ran in production, it had been individually built, configured, bundled, documented, patched, vendored, templated, tweaked and instrumented by 10 different people on 10 different computers. Builds failed, libraries conflicted, mirrors crashed, post-it notes were lost, logs were misplaced, cluster updates were half-broken. The process was slow, inefficient and cost a fortune - and was entirely different depending on the language and infrastructure provider.

+

+

+Industrial-grade delivery

+~~~~~~~~~~~~~~~~~~~~~~~~~~

+

+There are 17 million shipping containers in existence, packed with every physical good imaginable. Every single one of them can be loaded on the same boats, by the same cranes, in the same facilities, and sent anywhere in the World with incredible efficiency. It is embarrassing to think that a 30 ton shipment of coffee can safely travel half-way across the World in *less time* than it takes a software team to deliver its code from one datacenter to another sitting 10 miles away.

+

+With Standard Containers we can put an end to that embarrassment, by making INDUSTRIAL-GRADE DELIVERY of software a reality.

+

+

+Standard Container Specification

+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

+

+(TODO)

+

+Image format

+~~~~~~~~~~~~

+

+Standard operations

+~~~~~~~~~~~~~~~~~~~

+

+-  Copy

+-  Run

+-  Stop

+-  Wait

+-  Commit

+-  Attach standard streams

+-  List filesystem changes

+-  ...

+

+Execution environment

+~~~~~~~~~~~~~~~~~~~~~

+

+Root filesystem

+^^^^^^^^^^^^^^^

+

+Environment variables

+^^^^^^^^^^^^^^^^^^^^^

+

+Process arguments

+^^^^^^^^^^^^^^^^^

+

+Networking

+^^^^^^^^^^

+

+Process namespacing

+^^^^^^^^^^^^^^^^^^^

+

+Resource limits

+^^^^^^^^^^^^^^^

+

+Process monitoring

+^^^^^^^^^^^^^^^^^^

+

+Logging

+^^^^^^^

+

+Signals

+^^^^^^^

+

+Pseudo-terminal allocation

+^^^^^^^^^^^^^^^^^^^^^^^^^^

+

+Security

+^^^^^^^^

+

@@ -22,10 +22,12 @@ Instructions that have been verified to work on Ubuntu 12.10,

     go get -v github.com/dotcloud/docker/...

     go install -v github.com/dotcloud/docker/...

+

 Then run the docker daemon,

 .. code-block:: bash

     sudo $GOPATH/bin/docker -d

+

 Run the ``go install`` command (above) to recompile docker.

@@ -6,9 +6,7 @@

 Hello World

 ===========

-This is the most basic example available for using docker

-

-This example assumes you have Docker installed.

+This is the most basic example available for using Docker. The example assumes you have Docker installed.

 Download the base container

@@ -79,11 +79,3 @@ See the example in action

     </div>

 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``

@@ -15,3 +15,4 @@ Contents:

    hello_world

    hello_world_daemon

    python_web_app

+   runningsshservice

new file mode 100644

@@ -0,0 +1,27 @@

+

+Create an ssh daemon service

+============================

+

+

+

+

+**Video:**

+

+I've create a little screencast to show how to create a sshd service and connect to it. It is something like 11

+minutes and not entirely smooth, but gives you a good idea.

+

+.. raw:: html

+

+    <div style="margin-top:10px;">

+      <iframe width="800" height="400" src="http://ascii.io/a/2637/raw" frameborder="0"></iframe>

+    </div>

+

+

+You can also get this sshd container by using

+::

+

+    docker pull dhrp/sshd

+

+

+The password is 'screencast'

+

@@ -5,43 +5,43 @@ FAQ

 Most frequently asked questions.

 --------------------------------

-**1. How much does Docker cost?**

+1. **How much does Docker cost?**

-Docker is 100% free, it is open source, so you can use it without paying.

+   Docker is 100% free, it is open source, so you can use it without paying.

-**2. What open source license are you using?**

+2. **What open source license are you using?**

-We are using the Apache License Version 2.0, see it here: https://github.com/dotcloud/docker/blob/master/LICENSE

+   We are using the Apache License Version 2.0, see it here: https://github.com/dotcloud/docker/blob/master/LICENSE

-**3. Does Docker run on Mac OS X or Windows?**

+3. **Does Docker run on Mac OS X or Windows?**

-Not at this time, Docker currently only runs on Linux, but you can use VirtualBox to run Docker in a virtual machine on your box, and get the best of both worlds. Check out the MacOSX_ and Windows_ intallation guides.

+   Not at this time, Docker currently only runs on Linux, but you can use VirtualBox to run Docker in a virtual machine on your box, and get the best of both worlds. Check out the MacOSX_ and Windows_ intallation guides.

-**4. How do containers compare to virtual machines?**

+4. **How do containers compare to virtual machines?**

-They are complementary. VMs are best used to allocate chunks of hardware resources. Containers operate at the process level, which makes them very lightweight and perfect as a unit of software delivery.

+   They are complementary. VMs are best used to allocate chunks of hardware resources. Containers operate at the process level, which makes them very lightweight and perfect as a unit of software delivery.

-**5. Can I help by adding some questions and answers?**

+5. **Can I help by adding some questions and answers?**

-Definitely! You can fork `the repo`_ and edit the documentation sources.

+   Definitely! You can fork `the repo`_ and edit the documentation sources.

-**42. Where can I find more answers?**

+42. **Where can I find more answers?**

-You can find more answers on:

+    You can find more answers on:

-* `IRC: docker on freenode`_

-* `Github`_

-* `Ask questions on Stackoverflow`_

-* `Join the conversation on Twitter`_

+    * `IRC: docker on freenode`_

+    * `Github`_

+    * `Ask questions on Stackoverflow`_

+    * `Join the conversation on Twitter`_

-.. _Windows: ../documentation/installation/windows.html

-.. _MacOSX: ../documentation/installation/macos.html

-.. _the repo: http://www.github.com/dotcloud/docker

-.. _IRC\: docker on freenode: irc://chat.freenode.net#docker

-.. _Github: http://www.github.com/dotcloud/docker

-.. _Ask questions on Stackoverflow: http://stackoverflow.com/search?q=docker

-.. _Join the conversation on Twitter: http://twitter.com/getdocker

+    .. _Windows: ../documentation/installation/windows.html

+    .. _MacOSX: ../documentation/installation/macos.html

+    .. _the repo: http://www.github.com/dotcloud/docker

+    .. _IRC\: docker on freenode: irc://chat.freenode.net#docker

+    .. _Github: http://www.github.com/dotcloud/docker

+    .. _Ask questions on Stackoverflow: http://stackoverflow.com/search?q=docker

+    .. _Join the conversation on Twitter: http://twitter.com/getdocker

 Looking for something else to read? Checkout the :ref:`hello_world` example.

@@ -16,3 +16,4 @@ Contents:

    macos

    windows

    amazon

+   upgrading

@@ -42,7 +42,15 @@ Run your first container!

     sudo ./docker run -i -t base /bin/bash

-Consider adding docker to your PATH for simplicity.

+To run docker as a daemon, in the background, and allow non-root users to run ``docker`` start

+docker -d

+

+::

+

+    sudo ./docker -d &

+

+

+Consider adding docker to your PATH for simplicity.

 Continue with the :ref:`hello_world` example.

\ No newline at end of file

new file mode 100644

@@ -0,0 +1,40 @@

+.. _upgrading:

+

+Upgrading

+============

+

+   We assume you are upgrading from within the operating system which runs your docker daemon.

+

+

+Get the latest docker binary:

+

+::

+

+  wget http://get.docker.io/builds/$(uname -s)/$(uname -m)/docker-master.tgz

+

+

+

+Unpack it to your current dir

+

+::

+

+   tar -xf docker-master.tgz

+

+

+Stop your current daemon. How you stop your daemon depends on how you started it.

+

+- If you started the daemon manually (``sudo docker -d``), you can just kill the process: ``killall docker``

+- If the process was started using upstart (the ubuntu startup daemon), you may need to use that to stop it

+

+

+Start docker in daemon mode (-d) and disconnect (&) starting ./docker will start the version in your current dir rather

+than the one in your PATH.

+

+Now start the daemon

+

+::

+

+   sudo ./docker -d &

+

+

+Alternatively you can replace the docker binary in ``/usr/local/bin``

\ No newline at end of file