diff --git a/docs/sources/api/docker_remote_api.rst b/docs/sources/api/docker_remote_api.rst index f410183c58..86cacd17d9 100644 --- a/docs/sources/api/docker_remote_api.rst +++ b/docs/sources/api/docker_remote_api.rst @@ -22,7 +22,6 @@ Docker Remote API - Since API version 1.2, the auth configuration is now handled client side, so the client has to send the authConfig as POST in /images/(name)/push -- Known client libraries may be found in :ref:`remote_api_client_libs` 2. Versions =========== diff --git a/docs/sources/api/index.rst b/docs/sources/api/index.rst index 017369143c..d7345e8746 100644 --- a/docs/sources/api/index.rst +++ b/docs/sources/api/index.rst @@ -14,5 +14,5 @@ Your programs and scripts can access Docker's functionality via these interfaces registry_api index_api docker_remote_api - remote_api_client_libraries + diff --git a/docs/sources/api/remote_api_client_libraries.rst b/docs/sources/api/remote_api_client_libraries.rst index f391613ec4..bd8610eaf1 100644 --- a/docs/sources/api/remote_api_client_libraries.rst +++ b/docs/sources/api/remote_api_client_libraries.rst @@ -3,18 +3,14 @@ :keywords: API, Docker, index, registry, REST, documentation, clients, Python, Ruby, Javascript, Erlang, Go -.. _remote_api_client_libs: - ================================== Docker Remote API Client Libraries ================================== These libraries have not been tested by the Docker Maintainers for -compatibility with the :doc:`docker_remote_api`. Please file issues -with the library owners. If you find more library implementations, -please list them in `Docker doc issues -`_ -or make a pull request, and we will add the libraries here. +compatibility. Please file issues with the library owners. If you +find more library implementations, please list them in Docker doc bugs +and we will add the libraries here. +----------------------+----------------+--------------------------------------------+ | Language/Framework | Name | Repository | diff --git a/docs/sources/examples/hello_world.rst b/docs/sources/examples/hello_world.rst index 54ebdacc6a..647a34aa1f 100644 --- a/docs/sources/examples/hello_world.rst +++ b/docs/sources/examples/hello_world.rst @@ -178,4 +178,4 @@ you could skip to any of the other examples: * :ref:`running_ssh_service` * :ref:`running_couchdb_service` * :ref:`postgresql_service` -* :ref:`mongodb_image` +* :ref:`mongodb` diff --git a/docs/sources/installation/archlinux.rst b/docs/sources/installation/archlinux.rst index a593b28f50..a4de066f76 100644 --- a/docs/sources/installation/archlinux.rst +++ b/docs/sources/installation/archlinux.rst @@ -19,10 +19,6 @@ The lxc-docker-git package will build from the current master branch. Dependencies ------------ -.. versionchanged:: v0.7 - This section may need to be updated since Docker no longer depends - on AUFS. Please see :ref:`kernel`. - Docker depends on several packages which are specified as dependencies in either AUR package. diff --git a/docs/sources/installation/gentoolinux.rst b/docs/sources/installation/gentoolinux.rst index 374301e648..c4f2d220f3 100644 --- a/docs/sources/installation/gentoolinux.rst +++ b/docs/sources/installation/gentoolinux.rst @@ -25,11 +25,6 @@ properly installing and using the overlay can be found in `the overlay README Installation ^^^^^^^^^^^^ -.. versionchanged:: v0.7 - This section may need to be updated since Docker no longer depends - on AUFS. Please see :ref:`kernel`. - - The package should properly pull in all the necessary dependencies and prompt for all necessary kernel options. For the most straightforward installation experience, use ``sys-kernel/aufs-sources`` as your kernel sources. If you diff --git a/docs/sources/installation/kernel.rst b/docs/sources/installation/kernel.rst index 6e22677e03..2959fa4fcd 100644 --- a/docs/sources/installation/kernel.rst +++ b/docs/sources/installation/kernel.rst @@ -11,7 +11,7 @@ In short, Docker has the following kernel requirements: - Linux version 3.8 or above. -- `Device Mapper support `_. +- `AUFS support `_. - Cgroups and namespaces must be enabled. @@ -48,17 +48,15 @@ detects something older than 3.8. See issue `#407 `_ for details. -Device Mapper support ---------------------- +AUFS support +------------ -The `Device Mapper `_ replaces the -previous Docker dependency on AUFS and has been in the kernel since -2.6.9, so the device-mapper module is more broadly-supported across -Linux distributions. Docker uses `thin-provisioning -`_ -to provide a :ref:`unioning file system `. If you'd like to -check for the presence of the device-mapper module, please see the -`LVM-HOWTO. `_ +Docker currently relies on AUFS, an unioning filesystem. +While AUFS is included in the kernels built by the Debian and Ubuntu +distributions, is not part of the standard kernel. This means that if +you decide to roll your own kernel, you will have to patch your +kernel tree to add AUFS. The process is documented on +`AUFS webpage `_. Cgroups and namespaces @@ -71,7 +69,7 @@ to run LXC containers. Note that 2.6.32 has some documented issues regarding network namespace setup and teardown; those issues are not a risk if you run containers in a private environment, but can lead to denial-of-service attacks if you want to run untrusted code in your containers. For more details, -see `LP#720095 `_. +see `[LP#720095 `_. Kernels 2.6.38, and every version since 3.2, have been deployed successfully to run containerized production workloads. Feature-wise, there is no huge diff --git a/docs/sources/installation/ubuntulinux.rst b/docs/sources/installation/ubuntulinux.rst index 39a7b4f6bf..e653f704a8 100644 --- a/docs/sources/installation/ubuntulinux.rst +++ b/docs/sources/installation/ubuntulinux.rst @@ -7,6 +7,11 @@ Ubuntu Linux ============ +.. warning:: + + These instructions have changed for 0.6. If you are upgrading from + an earlier version, you will need to follow them again. + .. include:: install_header.inc Right now, the officially supported distribution are: @@ -14,10 +19,10 @@ Right now, the officially supported distribution are: - :ref:`ubuntu_precise` - :ref:`ubuntu_raring` -Docker has the following dependencies (read more in :ref:`kernel`): +Docker has the following dependencies -* Linux kernel 3.8 -* Device-mapper module +* Linux kernel 3.8 (read more about :ref:`kernel`) +* AUFS file system support (we are working on BTRFS support as an alternative) Please read :ref:`ufw`, if you plan to use `UFW (Uncomplicated Firewall) `_ @@ -37,12 +42,12 @@ Dependencies Due to a bug in LXC, docker works best on the 3.8 kernel. Precise comes with a 3.2 kernel, so we need to upgrade it. The kernel you'll -install when following these steps comes with device-mapper built -in. We also include the generic headers to enable packages that depend -on them, like ZFS and the VirtualBox guest additions. If you didn't -install the headers for your "precise" kernel, then you can skip these -headers for the "raring" kernel. But it is safer to include them if -you're not sure. +install when following these steps comes with AUFS built in. We also +include the generic headers to enable packages that depend on them, +like ZFS and the VirtualBox guest additions. If you didn't install the +headers for your "precise" kernel, then you can skip these headers for +the "raring" kernel. But it is safer to include them if you're not +sure. .. code-block:: bash @@ -58,7 +63,8 @@ you're not sure. Installation ------------ -.. versionchanged:: v0.6 +.. warning:: + These instructions have changed for 0.6. If you are upgrading from an earlier version, you will need to follow them again. @@ -100,19 +106,13 @@ Ubuntu Raring 13.04 (64 bit) Dependencies ------------ -.. versionchanged:: v0.7 - Starting in 0.7 you no longer need to add support for AUFS. - We now use the device-mapper module instead, and this module - is included with kernels since kernel version 2.6 +**AUFS filesystem support** -Ubuntu Raring already comes with the 3.8 kernel, so we don't need to -install it. However, not all systems have AUFS filesystem support -enabled, so if you're on a Docker version before 0.7, then we need to -install it. +Ubuntu Raring already comes with the 3.8 kernel, so we don't need to install it. However, not all systems +have AUFS filesystem support enabled, so we need to install it. .. code-block:: bash - # Only required for versions before v0.7 sudo apt-get update sudo apt-get install linux-image-extra-`uname -r` @@ -122,9 +122,8 @@ Installation Docker is available as a Debian package, which makes installation easy. -*Please note that these instructions have changed for 0.6. If you are -upgrading from an earlier version, you will need to follow them -again.* +*Please note that these instructions have changed for 0.6. If you are upgrading from an earlier version, you will need +to follow them again.* .. code-block:: bash @@ -161,8 +160,8 @@ Verify it worked Docker and UFW ^^^^^^^^^^^^^^ -Docker uses a bridge to manage container networking, and by default -UFW drops all `forwarding`. A first step is to enable forwarding: +Docker uses a bridge to manage containers networking, by default UFW +drop all `forwarding`, a first step is to enable forwarding: .. code-block:: bash @@ -180,3 +179,11 @@ Then reload UFW: sudo ufw reload +UFW's default set of rules denied all `incoming`, so if you want to be +able to reach your containers from another host, you should allow +incoming connections on the docker port (default 4243): + +.. code-block:: bash + + sudo ufw allow 4243/tcp + diff --git a/docs/sources/terms/images/docker-filesystems-busyboxrw.png b/docs/sources/terms/images/docker-filesystems-busyboxrw.png index d672083b0d..ad41c940e4 100644 Binary files a/docs/sources/terms/images/docker-filesystems-busyboxrw.png and b/docs/sources/terms/images/docker-filesystems-busyboxrw.png differ diff --git a/docs/sources/terms/images/docker-filesystems-debian.png b/docs/sources/terms/images/docker-filesystems-debian.png index 70badfaa40..823a215d3e 100644 Binary files a/docs/sources/terms/images/docker-filesystems-debian.png and b/docs/sources/terms/images/docker-filesystems-debian.png differ diff --git a/docs/sources/terms/images/docker-filesystems-debianrw.png b/docs/sources/terms/images/docker-filesystems-debianrw.png index c39cbd9d61..97c69a9944 100644 Binary files a/docs/sources/terms/images/docker-filesystems-debianrw.png and b/docs/sources/terms/images/docker-filesystems-debianrw.png differ diff --git a/docs/sources/terms/images/docker-filesystems-generic.png b/docs/sources/terms/images/docker-filesystems-generic.png index a9f04e9129..fb734b75c6 100644 Binary files a/docs/sources/terms/images/docker-filesystems-generic.png and b/docs/sources/terms/images/docker-filesystems-generic.png differ diff --git a/docs/sources/terms/images/docker-filesystems-multilayer.png b/docs/sources/terms/images/docker-filesystems-multilayer.png index fc6fc88597..0b3ae19c2c 100644 Binary files a/docs/sources/terms/images/docker-filesystems-multilayer.png and b/docs/sources/terms/images/docker-filesystems-multilayer.png differ diff --git a/docs/sources/terms/images/docker-filesystems-multiroot.png b/docs/sources/terms/images/docker-filesystems-multiroot.png index f68bd1be7d..5e864273f3 100644 Binary files a/docs/sources/terms/images/docker-filesystems-multiroot.png and b/docs/sources/terms/images/docker-filesystems-multiroot.png differ diff --git a/docs/sources/terms/images/docker-filesystems.svg b/docs/sources/terms/images/docker-filesystems.svg index 06d5ae8b0c..d41aff2522 100644 --- a/docs/sources/terms/images/docker-filesystems.svg +++ b/docs/sources/terms/images/docker-filesystems.svg @@ -9,15 +9,15 @@ xmlns="http://www.w3.org/2000/svg" xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" - inkscape:version="0.48.2 r9819" - version="1.1" - id="svg2" - height="600" - width="800" - sodipodi:docname="docker-filesystems.svg" - inkscape:export-filename="/Users/arothfusz/src/metalivedev/docker/docs/sources/terms/images/docker-filesystems-debianrw.png" + inkscape:export-ydpi="90" inkscape:export-xdpi="90" - inkscape:export-ydpi="90"> + inkscape:export-filename="/Users/arothfusz/src/metalivedev/docker/docs/sources/terms/images/docker-filesystems-multiroot.png" + sodipodi:docname="docker-filesystems.svg" + width="800" + height="600" + id="svg2" + version="1.1" + inkscape:version="0.48.2 r9819"> - - - - - - image/svg+xml - + @@ -321,146 +295,69 @@ inkscape:connector-curvature="0" /> + id="text3655" + style="font-size:40px;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Arial;-inkscape-font-specification:Arial" + transform="matrix(0.67123869,0,0,0.67123869,53.68199,126.56876)"> - - - - - - - - - - - - - - - - - - - @@ -962,37 +859,6 @@ id="path6350" /> -