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

bump master

Browse Source
This commit is contained in:
Victor Vieux
2013-06-03 12:37:51 +00:00
parent 9060b5c2f5 e42eb7fa8c
commit ca902b6be4
48 changed files with 949 additions and 392 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/sources/api/docker_remote_api.rst
+52 -7
View File
@@ -15,10 +15,17 @@ Docker Remote API
- Default port in the docker deamon is 4243
- The API tends to be REST, but for some complex commands, like attach or pull, the HTTP connection is hijacked to transport stdout stdin and stderr
2. Endpoints
2. Version
==========
The current verson of the API is 1.1
Calling /images/<name>/insert is the same as calling /v1.1/images/<name>/insert
You can still call an old version of the api using /v1.0/images/<name>/insert
3. Endpoints
============
2.1 Containers
3.1 Containers
--------------
List containers
@@ -132,6 +139,7 @@ Create a container
:jsonparam config: the container's configuration
:statuscode 201: no error
:statuscode 404: no such container
:statuscode 406: impossible to attach (container not running)
:statuscode 500: server error
@@ -459,7 +467,7 @@ Remove a container
:statuscode 500: server error
2.2 Images
3.2 Images
----------
List Images
@@ -548,7 +556,19 @@ Create an image
POST /images/create?fromImage=base HTTP/1.1
**Example response**:
**Example response v1.1**:
.. sourcecode:: http
HTTP/1.1 200 OK
Content-Type: application/json
{"status":"Pulling..."}
{"progress":"1/? (n/a)"}
{"error":"Invalid..."}
...
**Example response v1.0**:
.. sourcecode:: http
@@ -579,7 +599,19 @@ Insert a file in a image
POST /images/test/insert?path=/usr&url=myurl HTTP/1.1
**Example response**:
**Example response v1.1**:
.. sourcecode:: http
HTTP/1.1 200 OK
Content-Type: application/json
{"status":"Inserting..."}
{"progress":"1/? (n/a)"}
{"error":"Invalid..."}
...
**Example response v1.0**:
.. sourcecode:: http
@@ -694,7 +726,19 @@ Push an image on the registry
POST /images/test/push HTTP/1.1
**Example response**:
**Example response v1.1**:
.. sourcecode:: http
HTTP/1.1 200 OK
Content-Type: application/json
{"status":"Pushing..."}
{"progress":"1/? (n/a)"}
{"error":"Invalid..."}
...
**Example response v1.0**:
.. sourcecode:: http
@@ -817,7 +861,7 @@ Search images
:statuscode 500: server error
2.3 Misc
3.3 Misc
--------
Build an image from Dockerfile via stdin
@@ -843,6 +887,7 @@ Build an image from Dockerfile via stdin
{{ STREAM }}
:query t: tag to be applied to the resulting image in case of success
:statuscode 200: no error
:statuscode 500: server error
docs/sources/api/index.rst
+2 -2
View File
@@ -2,8 +2,8 @@
:description: docker documentation
:keywords: docker, ipa, documentation
API's
=============
APIs
====
This following :
docs/sources/api/registry_api.rst
-1
View File
@@ -246,7 +246,6 @@ The Index has two main purposes (along with its fancy social features):
- Resolve short names (to avoid passing absolute URLs all the time)
- username/projectname -> \https://registry.docker.io/users/<username>/repositories/<projectname>/
- team/projectname -> \https://registry.docker.io/team/<team>/repositories/<projectname>/
- Authenticate a user as a repos owner (for a central referenced repository)
3.1 Without an Index
docs/sources/commandline/command/build.rst
+21 -6
View File
@@ -2,12 +2,27 @@
:description: Build a new image from the Dockerfile passed via stdin
:keywords: build, docker, container, documentation
========================================================
``build`` -- Build a container from Dockerfile via stdin
========================================================
================================================
``build`` -- Build a container from a Dockerfile
================================================
::
Usage: docker build -
Example: cat Dockerfile | docker build -
Build a new image from the Dockerfile passed via stdin
Usage: docker build [OPTIONS] PATH | -
Build a new container image from the source code at PATH
-t="": Tag to be applied to the resulting image in case of success.
Examples
--------
.. code-block:: bash
docker build .
This will take the local Dockerfile
.. code-block:: bash
docker build -
This will read a Dockerfile form Stdin without context
docs/sources/concepts/buildingblocks.rst
-25
View File
@@ -1,25 +0,0 @@
: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 stopped virtual machine image. Images are stored (and retrieved from) repository
Images are stored on your local file system under /var/lib/docker/graph
.. _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
docs/sources/concepts/index.rst
-1
View File
@@ -13,5 +13,4 @@ Contents:
:maxdepth: 1
../index
buildingblocks
docs/sources/concepts/introduction.rst
+2 -2
View File
@@ -5,8 +5,8 @@
Introduction
============
Docker - The Linux container runtime
------------------------------------
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.
docs/sources/contributing/devenvironment.rst
+2 -2
View File
@@ -1,8 +1,8 @@
:title: Setting up a dev environment
:title: Setting Up a Dev Environment
:description: Guides on how to contribute to docker
:keywords: Docker, documentation, developers, contributing, dev environment
Setting up a dev environment
Setting Up a Dev Environment
============================
Instructions that have been verified to work on Ubuntu 12.10,
docs/sources/examples/couchdb_data_volumes.rst
+2 -2
View File
@@ -4,8 +4,8 @@
.. _running_couchdb_service:
Create a CouchDB service
========================
CouchDB Service
===============
.. include:: example_header.inc
docs/sources/examples/index.rst
+2 -1
View File
@@ -1,6 +1,6 @@
:title: Docker Examples
:description: Examples on how to use Docker
:keywords: docker, hello world, examples
:keywords: docker, hello world, node, nodejs, python, couch, couchdb, redis, ssh, sshd, examples
@@ -16,6 +16,7 @@ Contents:
hello_world
hello_world_daemon
python_web_app
nodejs_web_app
running_redis_service
running_ssh_service
couchdb_data_volumes
docs/sources/examples/nodejs_web_app.rst
+236
View File
@@ -0,0 +1,236 @@
:title: Running a Node.js app on CentOS
:description: Installing and running a Node.js app on CentOS
:keywords: docker, example, package installation, node, centos
.. _nodejs_web_app:
Node.js Web App
===============
.. include:: example_header.inc
The goal of this example is to show you how you can build your own docker images
from a parent image using a ``Dockerfile`` . We will do that by making a simple
Node.js hello world web application running on CentOS. You can get the full
source code at https://github.com/gasi/docker-node-hello.
Create Node.js app
++++++++++++++++++
First, create a ``package.json`` file that describes your app and its
dependencies:
.. code-block:: json
{
"name": "docker-centos-hello",
"private": true,
"version": "0.0.1",
"description": "Node.js Hello World app on CentOS using docker",
"author": "Daniel Gasienica <daniel@gasienica.ch>",
"dependencies": {
"express": "3.2.4"
}
}
Then, create an ``index.js`` file that defines a web app using the
`Express.js <http://expressjs.com/>`_ framework:
.. code-block:: javascript
var express = require('express');
// Constants
var PORT = 8080;
// App
var app = express();
app.get('/', function (req, res) {
res.send('Hello World\n');
});
app.listen(PORT)
console.log('Running on http://localhost:' + PORT);
In the next steps, we’ll look at how you can run this app inside a CentOS
container using docker. First, you’ll need to build a docker image of your app.
Creating a ``Dockerfile``
+++++++++++++++++++++++++
Create an empty file called ``Dockerfile``:
.. code-block:: bash
touch Dockerfile
Open the ``Dockerfile`` in your favorite text editor and add the following line
that defines the version of docker the image requires to build
(this example uses docker 0.3.4):
.. code-block:: bash
# DOCKER-VERSION 0.3.4
Next, define the parent image you want to use to build your own image on top of.
Here, we’ll use `CentOS <https://index.docker.io/_/centos/>`_ (tag: ``6.4``)
available on the `docker index`_:
.. code-block:: bash
FROM centos:6.4
Since we’re building a Node.js app, you’ll have to install Node.js as well as
npm on your CentOS image. Node.js is required to run your app and npm to install
your app’s dependencies defined in ``package.json``.
To install the right package for CentOS, we’ll use the instructions from the
`Node.js wiki`_:
.. code-block:: bash
# Enable EPEL for Node.js
RUN rpm -Uvh http://download.fedoraproject.org/pub/epel/6/i386/epel-release-6-8.noarch.rpm
# Install Node.js and npm
RUN yum install -y npm-1.2.17-5.el6
To bundle your app’s source code inside the docker image, use the ``ADD``
command:
.. code-block:: bash
# Bundle app source
ADD . /src
Install your app dependencies using npm:
.. code-block:: bash
# Install app dependencies
RUN cd /src; npm install
Your app binds to port ``8080`` so you’ll use the ``EXPOSE`` command to have it
mapped by the docker daemon:
.. code-block:: bash
EXPOSE 8080
Last but not least, define the command to run your app using ``CMD`` which
defines your runtime, i.e. ``node``, and the path to our app, i.e.
``src/index.js`` (see the step where we added the source to the container):
.. code-block:: bash
CMD ["node", "/src/index.js"]
Your ``Dockerfile`` should now look like this:
.. code-block:: bash
# DOCKER-VERSION 0.3.4
FROM centos:6.4
# Enable EPEL for Node.js
RUN rpm -Uvh http://download.fedoraproject.org/pub/epel/6/i386/epel-release-6-8.noarch.rpm
# Install Node.js and npm
RUN yum install -y npm-1.2.17-5.el6
# Bundle app source
ADD . /src
# Install app dependencies
RUN cd /src; npm install
EXPOSE 8080
CMD ["node", "/src/index.js"]
Building your image
+++++++++++++++++++
Go to the directory that has your ``Dockerfile`` and run the following command
to build a docker image. The ``-t`` flag let’s you tag your image so it’s easier
to find later using the ``docker images`` command:
.. code-block:: bash
docker build -t <your username>/centos-node-hello .
Your image will now be listed by docker:
.. code-block:: bash
docker images
> # Example
> REPOSITORY TAG ID CREATED
> centos 6.4 539c0211cd76 8 weeks ago
> gasi/centos-node-hello latest d64d3505b0d2 2 hours ago
Run the image
+++++++++++++
Running your image with ``-d`` runs the container in detached mode, leaving the
container running in the background. Run the image you previously built:
.. code-block:: bash
docker run -d <your username>/centos-node-hello
Print the output of your app:
.. code-block:: bash
# Get container ID
docker ps
# Print app output
docker logs <container id>
> # Example
> Running on http://localhost:8080
Test
++++
To test your app, get the the port of your app that docker mapped:
.. code-block:: bash
docker ps
> # Example
> ID IMAGE COMMAND ... PORTS
> ecce33b30ebf gasi/centos-node-hello:latest node /src/index.js 49160->8080
In the example above, docker mapped the ``8080`` port of the container to
``49160``.
Now you can call your app using ``curl`` (install if needed via:
``sudo apt-get install curl``):
.. code-block:: bash
curl -i localhost:49160
> HTTP/1.1 200 OK
> X-Powered-By: Express
> Content-Type: text/html; charset=utf-8
> Content-Length: 12
> Date: Sun, 02 Jun 2013 03:53:22 GMT
> Connection: keep-alive
>
> Hello World
We hope this tutorial helped you get up and running with Node.js and CentOS on
docker. You can get the full source code at
https://github.com/gasi/docker-node-hello.
Continue to :ref:`running_redis_service`.
.. _Node.js wiki: https://github.com/joyent/node/wiki/Installing-Node.js-via-package-manager#rhelcentosscientific-linux-6
.. _docker index: https://index.docker.io/
docs/sources/examples/python_web_app.rst
+2 -2
View File
@@ -4,8 +4,8 @@
.. _python_web_app:
Building a python web app
=========================
Python Web App
==============
.. include:: example_header.inc
docs/sources/examples/running_examples.rst
+1 -1
View File
@@ -4,7 +4,7 @@
.. _running_examples:
Running The 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:
docs/sources/examples/running_redis_service.rst
+3 -3
View File
@@ -4,8 +4,8 @@
.. _running_redis_service:
Create a redis service
======================
Redis Service
=============
.. include:: example_header.inc
@@ -34,7 +34,7 @@ Snapshot the installation
.. code-block:: bash
docker ps -a # grab the container id (this will be the last one in the list)
docker ps -a # grab the container id (this will be the first one in the list)
docker commit <container_id> <your username>/redis
Run the service
docs/sources/examples/running_ssh_service.rst
+49 -4
View File
@@ -4,8 +4,8 @@
.. _running_ssh_service:
Create an ssh daemon service
============================
SSH Daemon Service
==================
.. include:: example_header.inc
@@ -20,8 +20,7 @@ minutes and not entirely smooth, but gives you a good idea.
<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
::
@@ -30,3 +29,49 @@ You can also get this sshd container by using
The password is 'screencast'
**Video's Transcription:**
.. code-block:: bash
# Hello! We are going to try and install openssh on a container and run it as a servic
# let's pull base to get a base ubuntu image.
$ docker pull base
# I had it so it was quick
# now let's connect using -i for interactive and with -t for terminal
# we execute /bin/bash to get a prompt.
$ docker run -i -t base /bin/bash
# now let's commit it
# which container was it?
$ docker ps -a |more
$ docker commit a30a3a2f2b130749995f5902f079dc6ad31ea0621fac595128ec59c6da07feea dhrp/sshd
# I gave the name dhrp/sshd for the container
# now we can run it again
$ docker run -d dhrp/sshd /usr/sbin/sshd -D # D for daemon mode
# is it running?
$ docker ps
# yes!
# let's stop it
$ docker stop 0ebf7cec294755399d063f4b1627980d4cbff7d999f0bc82b59c300f8536a562
$ docker ps
# and reconnect, but now open a port to it
$ docker run -d -p 22 dhrp/sshd /usr/sbin/sshd -D
$ docker port b2b407cf22cf8e7fa3736fa8852713571074536b1d31def3fdfcd9fa4fd8c8c5 22
# it has now given us a port to connect to
# we have to connect using a public ip of our host
$ hostname
$ ifconfig
$ ssh root@192.168.33.10 -p 49153
# Ah! forgot to set root passwd
$ docker commit b2b407cf22cf8e7fa3736fa8852713571074536b1d31def3fdfcd9fa4fd8c8c5 dhrp/sshd
$ docker ps -a
$ docker run -i -t dhrp/sshd /bin/bash
$ passwd
$ exit
$ docker commit 9e863f0ca0af31c8b951048ba87641d67c382d08d655c2e4879c51410e0fedc1 dhrp/sshd
$ docker run -d -p 22 dhrp/sshd /usr/sbin/sshd -D
$ docker port a0aaa9558c90cf5c7782648df904a82365ebacce523e4acc085ac1213bfe2206 22
$ ifconfig
$ ssh root@192.168.33.10 -p 49154
# Thanks for watching, Thatcher thatcher@dotcloud.com
docs/sources/index.rst
+2 -2
View File
@@ -7,8 +7,8 @@
Introduction
============
Docker - The Linux container runtime
------------------------------------
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.
docs/sources/installation/archlinux.rst
+18
View File
@@ -67,3 +67,21 @@ To start on system boot:
::
sudo systemctl enable docker
Network Configuration
---------------------
IPv4 packet forwarding is disabled by default on Arch, so internet access from inside
the container may not work.
To enable the forwarding, run as root on the host system:
::
sysctl net.ipv4.ip_forward=1
And, to make it persistent across reboots, enable it on the host's **/etc/sysctl.conf**:
::
net.ipv4.ip_forward=1
docs/sources/use/basics.rst
+2 -2
View File
@@ -3,8 +3,8 @@
:keywords: Examples, Usage, basic commands, docker, documentation, examples
The basics
=============
The Basics
==========
Starting Docker
---------------
docs/sources/use/builder.rst
+8 -2
View File
@@ -125,8 +125,14 @@ curl was installed within the image.
.. note::
The path must include the file name.
.. note::
This instruction has temporarily disabled
2.8 ADD
-------
``ADD <src> <dest>``
The `ADD` instruction will insert the files from the `<src>` path of the context into `<dest>` path
of the container.
The context must be set in order to use this instruction. (see examples)
3. Dockerfile Examples
======================
docs/sources/use/workingwithrepository.rst
+4 -4
View File
@@ -4,8 +4,8 @@
.. _working_with_the_repository:
Working with the repository
============================
Working with the Repository
===========================
Top-level repositories and user repositories
@@ -14,9 +14,9 @@ Top-level repositories and user repositories
Generally, there are two types of repositories: Top-level repositories which are controlled by the people behind
Docker, and user repositories.
* Top-level repositories can easily be recognized by not having a / (slash) in their name. These repositories can
* Top-level repositories can easily be recognized by not having a ``/`` (slash) in their name. These repositories can
generally be trusted.
* User repositories always come in the form of <username>/<repo_name>. This is what your published images will look like.
* User repositories always come in the form of ``<username>/<repo_name>``. This is what your published images will look like.
* User images are not checked, it is therefore up to you whether or not you trust the creator of this image.