diff --git a/Dockerfile b/Dockerfile index ec95bad293..ab82dfa700 100644 --- a/Dockerfile +++ b/Dockerfile @@ -82,6 +82,9 @@ RUN go get code.google.com/p/go.tools/cmd/cover # TODO replace FPM with some very minimal debhelper stuff RUN gem install --no-rdoc --no-ri fpm --version 1.0.2 +# Get the "busybox" image source so we can build locally instead of pulling +RUN git clone https://github.com/jpetazzo/docker-busybox.git /docker-busybox + # Setup s3cmd config RUN /bin/echo -e '[default]\naccess_key=$AWS_ACCESS_KEY\nsecret_key=$AWS_SECRET_KEY' > /.s3cfg diff --git a/Makefile b/Makefile index d49aa3b667..b29d21746e 100644 --- a/Makefile +++ b/Makefile @@ -1,4 +1,4 @@ -.PHONY: all binary build cross default docs docs-build docs-shell shell test test-integration test-integration-cli +.PHONY: all binary build cross default docs docs-build docs-shell shell test test-integration test-integration-cli validate # to allow `make BINDDIR=. shell` or `make BINDDIR= test` BINDDIR := bundles @@ -11,7 +11,8 @@ DOCKER_DOCS_IMAGE := docker-docs$(if $(GIT_BRANCH),:$(GIT_BRANCH)) DOCKER_MOUNT := $(if $(BINDDIR),-v "$(CURDIR)/$(BINDDIR):/go/src/github.com/dotcloud/docker/$(BINDDIR)") DOCKER_RUN_DOCKER := docker run --rm -it --privileged -e TESTFLAGS -e DOCKER_GRAPHDRIVER -e DOCKER_EXECDRIVER $(DOCKER_MOUNT) "$(DOCKER_IMAGE)" -DOCKER_RUN_DOCS := docker run --rm -it -p $(if $(DOCSPORT),$(DOCSPORT):)8000 "$(DOCKER_DOCS_IMAGE)" +# to allow `make DOCSDIR=docs docs-shell` +DOCKER_RUN_DOCS := docker run --rm -it -p $(if $(DOCSPORT),$(DOCSPORT):)8000 $(if $(DOCSDIR),-v $(CURDIR)/$(DOCSDIR):/$(DOCSDIR)) -e AWS_S3_BUCKET default: binary @@ -25,10 +26,13 @@ cross: build $(DOCKER_RUN_DOCKER) hack/make.sh binary cross docs: docs-build - $(DOCKER_RUN_DOCS) + $(DOCKER_RUN_DOCS) "$(DOCKER_DOCS_IMAGE)" mkdocs serve docs-shell: docs-build - $(DOCKER_RUN_DOCS) bash + $(DOCKER_RUN_DOCS) "$(DOCKER_DOCS_IMAGE)" bash + +docs-release: docs-build + $(DOCKER_RUN_DOCS) "$(DOCKER_DOCS_IMAGE)" ./release.sh test: build $(DOCKER_RUN_DOCKER) hack/make.sh binary test test-integration test-integration-cli @@ -39,6 +43,9 @@ test-integration: build test-integration-cli: build $(DOCKER_RUN_DOCKER) hack/make.sh binary test-integration-cli +validate: build + $(DOCKER_RUN_DOCKER) hack/make.sh validate-gofmt validate-dco + shell: build $(DOCKER_RUN_DOCKER) bash diff --git a/builtins/builtins.go b/builtins/builtins.go index 109bc5b913..374bd48701 100644 --- a/builtins/builtins.go +++ b/builtins/builtins.go @@ -2,8 +2,8 @@ package builtins import ( api "github.com/dotcloud/docker/api/server" + "github.com/dotcloud/docker/daemon/networkdriver/bridge" "github.com/dotcloud/docker/engine" - "github.com/dotcloud/docker/runtime/networkdriver/bridge" "github.com/dotcloud/docker/server" ) diff --git a/contrib/docker-device-tool/device_tool.go b/contrib/docker-device-tool/device_tool.go index 12c762a7f3..a9327f9de1 100644 --- a/contrib/docker-device-tool/device_tool.go +++ b/contrib/docker-device-tool/device_tool.go @@ -3,7 +3,7 @@ package main import ( "flag" "fmt" - "github.com/dotcloud/docker/runtime/graphdriver/devmapper" + "github.com/dotcloud/docker/daemon/graphdriver/devmapper" "os" "path" "sort" diff --git a/contrib/mkimage-alpine.sh b/contrib/mkimage-alpine.sh new file mode 100755 index 0000000000..7444ffafb9 --- /dev/null +++ b/contrib/mkimage-alpine.sh @@ -0,0 +1,82 @@ +#!/bin/sh + +set -e + +[ $(id -u) -eq 0 ] || { + printf >&2 '%s requires root\n' "$0" + exit 1 +} + +usage() { + printf >&2 '%s: [-r release] [-m mirror] [-s]\n' "$0" + exit 1 +} + +tmp() { + TMP=$(mktemp -d /tmp/alpine-docker-XXXXXXXXXX) + ROOTFS=$(mktemp -d /tmp/alpine-docker-rootfs-XXXXXXXXXX) + trap "rm -rf $TMP $ROOTFS" EXIT TERM INT +} + +apkv() { + curl -s $REPO/$ARCH/APKINDEX.tar.gz | tar -Oxz | + grep '^P:apk-tools-static$' -A1 | tail -n1 | cut -d: -f2 +} + +getapk() { + curl -s $REPO/$ARCH/apk-tools-static-$(apkv).apk | + tar -xz -C $TMP sbin/apk.static +} + +mkbase() { + $TMP/sbin/apk.static --repository $REPO --update-cache --allow-untrusted \ + --root $ROOTFS --initdb add alpine-base +} + +conf() { + printf '%s\n' $REPO > $ROOTFS/etc/apk/repositories +} + +pack() { + local id + id=$(tar --numeric-owner -C $ROOTFS -c . | docker import - alpine:$REL) + + docker tag $id alpine:latest + docker run -i -t alpine printf 'alpine:%s with id=%s created!\n' $REL $id +} + +save() { + [ $SAVE -eq 1 ] || return + + tar --numeric-owner -C $ROOTFS -c . | xz > rootfs.tar.xz +} + +while getopts "hr:m:s" opt; do + case $opt in + r) + REL=$OPTARG + ;; + m) + MIRROR=$OPTARG + ;; + s) + SAVE=1 + ;; + *) + usage + ;; + esac +done + +REL=${REL:-edge} +MIRROR=${MIRROR:-http://nl.alpinelinux.org/alpine} +SAVE=${SAVE:-0} +REPO=$MIRROR/$REL/main +ARCH=$(uname -m) + +tmp +getapk +mkbase +conf +pack +save diff --git a/contrib/mkimage-arch.sh b/contrib/mkimage-arch.sh index 73a4173b11..dc21067473 100755 --- a/contrib/mkimage-arch.sh +++ b/contrib/mkimage-arch.sh @@ -57,6 +57,7 @@ mknod -m 666 $DEV/tty0 c 4 0 mknod -m 666 $DEV/full c 1 7 mknod -m 600 $DEV/initctl p mknod -m 666 $DEV/ptmx c 5 2 +ln -sf /proc/self/fd $DEV/fd tar --numeric-owner -C $ROOTFS -c . | docker import - archlinux docker run -i -t archlinux echo Success. diff --git a/runtime/container.go b/daemon/container.go similarity index 82% rename from runtime/container.go rename to daemon/container.go index c8053b146c..6f63d565f2 100644 --- a/runtime/container.go +++ b/daemon/container.go @@ -1,17 +1,17 @@ -package runtime +package daemon import ( "encoding/json" "errors" "fmt" "github.com/dotcloud/docker/archive" + "github.com/dotcloud/docker/daemon/execdriver" + "github.com/dotcloud/docker/daemon/graphdriver" "github.com/dotcloud/docker/engine" "github.com/dotcloud/docker/image" "github.com/dotcloud/docker/links" "github.com/dotcloud/docker/nat" "github.com/dotcloud/docker/runconfig" - "github.com/dotcloud/docker/runtime/execdriver" - "github.com/dotcloud/docker/runtime/graphdriver" "github.com/dotcloud/docker/utils" "io" "io/ioutil" @@ -64,7 +64,7 @@ type Container struct { stdin io.ReadCloser stdinPipe io.WriteCloser - runtime *Runtime + daemon *Daemon waitLock chan struct{} Volumes map[string]string @@ -76,42 +76,6 @@ type Container struct { activeLinks map[string]*links.Link } -// FIXME: move deprecated port stuff to nat to clean up the core. -type PortMapping map[string]string // Deprecated - -type NetworkSettings struct { - IPAddress string - IPPrefixLen int - Gateway string - Bridge string - PortMapping map[string]PortMapping // Deprecated - Ports nat.PortMap -} - -func (settings *NetworkSettings) PortMappingAPI() *engine.Table { - var outs = engine.NewTable("", 0) - for port, bindings := range settings.Ports { - p, _ := nat.ParsePort(port.Port()) - if len(bindings) == 0 { - out := &engine.Env{} - out.SetInt("PublicPort", p) - out.Set("Type", port.Proto()) - outs.Add(out) - continue - } - for _, binding := range bindings { - out := &engine.Env{} - h, _ := nat.ParsePort(binding.HostPort) - out.SetInt("PrivatePort", p) - out.SetInt("PublicPort", h) - out.Set("Type", port.Proto()) - out.Set("IP", binding.HostIp) - outs.Add(out) - } - } - return outs -} - // Inject the io.Reader at the given path. Note: do not close the reader func (container *Container) Inject(file io.Reader, pth string) error { if err := container.Mount(); err != nil { @@ -148,10 +112,6 @@ func (container *Container) Inject(file io.Reader, pth string) error { return nil } -func (container *Container) When() time.Time { - return container.Created -} - func (container *Container) FromDisk() error { data, err := ioutil.ReadFile(container.jsonPath()) if err != nil { @@ -358,14 +318,14 @@ func (container *Container) Attach(stdin io.ReadCloser, stdinCloser io.Closer, s }) } -func populateCommand(c *Container) { +func populateCommand(c *Container, env []string) { var ( en *execdriver.Network driverConfig = make(map[string][]string) ) en = &execdriver.Network{ - Mtu: c.runtime.config.Mtu, + Mtu: c.daemon.config.Mtu, Interface: nil, } @@ -402,18 +362,7 @@ func populateCommand(c *Container) { Resources: resources, } c.command.SysProcAttr = &syscall.SysProcAttr{Setsid: true} -} - -func (container *Container) ArgsAsString() string { - var args []string - for _, arg := range container.Args { - if strings.Contains(arg, " ") { - args = append(args, fmt.Sprintf("'%s'", arg)) - } else { - args = append(args, arg) - } - } - return strings.Join(args, " ") + c.command.Env = env } func (container *Container) Start() (err error) { @@ -423,186 +372,50 @@ func (container *Container) Start() (err error) { if container.State.IsRunning() { return nil } - + // if we encounter and error during start we need to ensure that any other + // setup has been cleaned up properly defer func() { if err != nil { container.cleanup() } }() - if container.ResolvConfPath == "" { - if err := container.setupContainerDns(); err != nil { - return err - } + if err := container.setupContainerDns(); err != nil { + return err } - if err := container.Mount(); err != nil { return err } - - if container.runtime.config.DisableNetwork { - container.Config.NetworkDisabled = true - container.buildHostnameAndHostsFiles("127.0.1.1") - } else { - if err := container.allocateNetwork(); err != nil { - return err - } - container.buildHostnameAndHostsFiles(container.NetworkSettings.IPAddress) + if err := container.initializeNetworking(); err != nil { + return err } - - // Make sure the config is compatible with the current kernel - if container.Config.Memory > 0 && !container.runtime.sysInfo.MemoryLimit { - log.Printf("WARNING: Your kernel does not support memory limit capabilities. Limitation discarded.\n") - container.Config.Memory = 0 - } - if container.Config.Memory > 0 && !container.runtime.sysInfo.SwapLimit { - log.Printf("WARNING: Your kernel does not support swap limit capabilities. Limitation discarded.\n") - container.Config.MemorySwap = -1 - } - - if container.runtime.sysInfo.IPv4ForwardingDisabled { - log.Printf("WARNING: IPv4 forwarding is disabled. Networking will not work") - } - + container.verifyDaemonSettings() if err := prepareVolumesForContainer(container); err != nil { return err } - - // Setup environment - env := []string{ - "HOME=/", - "PATH=" + DefaultPathEnv, - "HOSTNAME=" + container.Config.Hostname, - } - - if container.Config.Tty { - env = append(env, "TERM=xterm") - } - - // Init any links between the parent and children - runtime := container.runtime - - children, err := runtime.Children(container.Name) + linkedEnv, err := container.setupLinkedContainers() if err != nil { return err } - - if len(children) > 0 { - container.activeLinks = make(map[string]*links.Link, len(children)) - - // If we encounter an error make sure that we rollback any network - // config and ip table changes - rollback := func() { - for _, link := range container.activeLinks { - link.Disable() - } - container.activeLinks = nil - } - - for linkAlias, child := range children { - if !child.State.IsRunning() { - return fmt.Errorf("Cannot link to a non running container: %s AS %s", child.Name, linkAlias) - } - - link, err := links.NewLink( - container.NetworkSettings.IPAddress, - child.NetworkSettings.IPAddress, - linkAlias, - child.Config.Env, - child.Config.ExposedPorts, - runtime.eng) - - if err != nil { - rollback() - return err - } - - container.activeLinks[link.Alias()] = link - if err := link.Enable(); err != nil { - rollback() - return err - } - - for _, envVar := range link.ToEnv() { - env = append(env, envVar) - } - } - } - - // because the env on the container can override certain default values - // we need to replace the 'env' keys where they match and append anything - // else. - env = utils.ReplaceOrAppendEnvValues(env, container.Config.Env) + env := container.createDaemonEnvironment(linkedEnv) + // TODO: This is only needed for lxc so we should look for a way to + // remove this dep if err := container.generateEnvConfig(env); err != nil { return err } - - if container.Config.WorkingDir != "" { - container.Config.WorkingDir = path.Clean(container.Config.WorkingDir) - - pthInfo, err := os.Stat(path.Join(container.basefs, container.Config.WorkingDir)) - if err != nil { - if !os.IsNotExist(err) { - return err - } - if err := os.MkdirAll(path.Join(container.basefs, container.Config.WorkingDir), 0755); err != nil { - return err - } - } - if pthInfo != nil && !pthInfo.IsDir() { - return fmt.Errorf("Cannot mkdir: %s is not a directory", container.Config.WorkingDir) - } - } - - envPath, err := container.EnvConfigPath() - if err != nil { + if err := container.setupWorkingDirectory(); err != nil { return err } - - populateCommand(container) - container.command.Env = env - - if err := setupMountsForContainer(container, envPath); err != nil { + populateCommand(container, env) + if err := setupMountsForContainer(container); err != nil { return err } - - // Setup logging of stdout and stderr to disk - if err := container.runtime.LogToDisk(container.stdout, container.logPath("json"), "stdout"); err != nil { - return err - } - if err := container.runtime.LogToDisk(container.stderr, container.logPath("json"), "stderr"); err != nil { + if err := container.startLoggingToDisk(); err != nil { return err } container.waitLock = make(chan struct{}) - callbackLock := make(chan struct{}) - callback := func(command *execdriver.Command) { - container.State.SetRunning(command.Pid()) - if command.Tty { - // The callback is called after the process Start() - // so we are in the parent process. In TTY mode, stdin/out/err is the PtySlace - // which we close here. - if c, ok := command.Stdout.(io.Closer); ok { - c.Close() - } - } - if err := container.ToDisk(); err != nil { - utils.Debugf("%s", err) - } - close(callbackLock) - } - - // We use a callback here instead of a goroutine and an chan for - // syncronization purposes - cErr := utils.Go(func() error { return container.monitor(callback) }) - - // Start should not return until the process is actually running - select { - case <-callbackLock: - case err := <-cErr: - return err - } - return nil + return container.waitForStart() } func (container *Container) Run() error { @@ -683,42 +496,18 @@ func (container *Container) allocateNetwork() error { var ( env *engine.Env err error - eng = container.runtime.eng + eng = container.daemon.eng ) - if container.State.IsGhost() { - if container.runtime.config.DisableNetwork { - env = &engine.Env{} - } else { - currentIP := container.NetworkSettings.IPAddress - - job := eng.Job("allocate_interface", container.ID) - if currentIP != "" { - job.Setenv("RequestIP", currentIP) - } - - env, err = job.Stdout.AddEnv() - if err != nil { - return err - } - - if err := job.Run(); err != nil { - return err - } - } - } else { - job := eng.Job("allocate_interface", container.ID) - env, err = job.Stdout.AddEnv() - if err != nil { - return err - } - if err := job.Run(); err != nil { - return err - } + job := eng.Job("allocate_interface", container.ID) + if env, err = job.Stdout.AddEnv(); err != nil { + return err + } + if err := job.Run(); err != nil { + return err } if container.Config.PortSpecs != nil { - utils.Debugf("Migrating port mappings for container: %s", strings.Join(container.Config.PortSpecs, ", ")) if err := migratePortMappings(container.Config, container.hostConfig); err != nil { return err } @@ -733,58 +522,23 @@ func (container *Container) allocateNetwork() error { bindings = make(nat.PortMap) ) - if !container.State.IsGhost() { - if container.Config.ExposedPorts != nil { - portSpecs = container.Config.ExposedPorts - } - if container.hostConfig.PortBindings != nil { - bindings = container.hostConfig.PortBindings - } - } else { - if container.NetworkSettings.Ports != nil { - for port, binding := range container.NetworkSettings.Ports { - portSpecs[port] = struct{}{} - bindings[port] = binding - } - } + if container.Config.ExposedPorts != nil { + portSpecs = container.Config.ExposedPorts + } + if container.hostConfig.PortBindings != nil { + bindings = container.hostConfig.PortBindings } container.NetworkSettings.PortMapping = nil for port := range portSpecs { - binding := bindings[port] - if container.hostConfig.PublishAllPorts && len(binding) == 0 { - binding = append(binding, nat.PortBinding{}) + if err := container.allocatePort(eng, port, bindings); err != nil { + return err } - - for i := 0; i < len(binding); i++ { - b := binding[i] - - portJob := eng.Job("allocate_port", container.ID) - portJob.Setenv("HostIP", b.HostIp) - portJob.Setenv("HostPort", b.HostPort) - portJob.Setenv("Proto", port.Proto()) - portJob.Setenv("ContainerPort", port.Port()) - - portEnv, err := portJob.Stdout.AddEnv() - if err != nil { - return err - } - if err := portJob.Run(); err != nil { - eng.Job("release_interface", container.ID).Run() - return err - } - b.HostIp = portEnv.Get("HostIP") - b.HostPort = portEnv.Get("HostPort") - - binding[i] = b - } - bindings[port] = binding } container.WriteHostConfig() container.NetworkSettings.Ports = bindings - container.NetworkSettings.Bridge = env.Get("Bridge") container.NetworkSettings.IPAddress = env.Get("IP") container.NetworkSettings.IPPrefixLen = env.GetInt("IPPrefixLen") @@ -797,7 +551,7 @@ func (container *Container) releaseNetwork() { if container.Config.NetworkDisabled { return } - eng := container.runtime.eng + eng := container.daemon.eng eng.Job("release_interface", container.ID).Run() container.NetworkSettings = &NetworkSettings{} @@ -810,12 +564,12 @@ func (container *Container) monitor(callback execdriver.StartCallback) error { ) pipes := execdriver.NewPipes(container.stdin, container.stdout, container.stderr, container.Config.OpenStdin) - exitCode, err = container.runtime.Run(container, pipes, callback) + exitCode, err = container.daemon.Run(container, pipes, callback) if err != nil { utils.Errorf("Error running container: %s", err) } - if container.runtime != nil && container.runtime.srv != nil && container.runtime.srv.IsRunning() { + if container.daemon != nil && container.daemon.srv != nil && container.daemon.srv.IsRunning() { container.State.SetStopped(exitCode) // FIXME: there is a race condition here which causes this to fail during the unit tests. @@ -838,8 +592,8 @@ func (container *Container) monitor(callback execdriver.StartCallback) error { container.stdin, container.stdinPipe = io.Pipe() } - if container.runtime != nil && container.runtime.srv != nil { - container.runtime.srv.LogEvent("die", container.ID, container.runtime.repositories.ImageName(container.Image)) + if container.daemon != nil && container.daemon.srv != nil { + container.daemon.srv.LogEvent("die", container.ID, container.daemon.repositories.ImageName(container.Image)) } close(container.waitLock) @@ -885,7 +639,7 @@ func (container *Container) KillSig(sig int) error { if !container.State.IsRunning() { return nil } - return container.runtime.Kill(container, sig) + return container.daemon.Kill(container, sig) } func (container *Container) Kill() error { @@ -962,10 +716,10 @@ func (container *Container) ExportRw() (archive.Archive, error) { if err := container.Mount(); err != nil { return nil, err } - if container.runtime == nil { + if container.daemon == nil { return nil, fmt.Errorf("Can't load storage driver for unregistered container %s", container.ID) } - archive, err := container.runtime.Diff(container) + archive, err := container.daemon.Diff(container) if err != nil { container.Unmount() return nil, err @@ -1012,22 +766,22 @@ func (container *Container) WaitTimeout(timeout time.Duration) error { } func (container *Container) Mount() error { - return container.runtime.Mount(container) + return container.daemon.Mount(container) } func (container *Container) Changes() ([]archive.Change, error) { - return container.runtime.Changes(container) + return container.daemon.Changes(container) } func (container *Container) GetImage() (*image.Image, error) { - if container.runtime == nil { + if container.daemon == nil { return nil, fmt.Errorf("Can't get image of unregistered container") } - return container.runtime.graph.Get(container.Image) + return container.daemon.graph.Get(container.Image) } func (container *Container) Unmount() error { - return container.runtime.Unmount(container) + return container.daemon.Unmount(container) } func (container *Container) logPath(name string) string { @@ -1080,7 +834,7 @@ func (container *Container) GetSize() (int64, int64) { var ( sizeRw, sizeRootfs int64 err error - driver = container.runtime.driver + driver = container.daemon.driver ) if err := container.Mount(); err != nil { @@ -1089,7 +843,7 @@ func (container *Container) GetSize() (int64, int64) { } defer container.Unmount() - if differ, ok := container.runtime.driver.(graphdriver.Differ); ok { + if differ, ok := container.daemon.driver.(graphdriver.Differ); ok { sizeRw, err = differ.DiffSize(container.ID) if err != nil { utils.Errorf("Warning: driver %s couldn't return diff size of container %s: %s", driver, container.ID, err) @@ -1182,29 +936,32 @@ func (container *Container) DisableLink(name string) { } func (container *Container) setupContainerDns() error { + if container.ResolvConfPath != "" { + return nil + } var ( - config = container.hostConfig - runtime = container.runtime + config = container.hostConfig + daemon = container.daemon ) resolvConf, err := utils.GetResolvConf() if err != nil { return err } // If custom dns exists, then create a resolv.conf for the container - if len(config.Dns) > 0 || len(runtime.config.Dns) > 0 || len(config.DnsSearch) > 0 || len(runtime.config.DnsSearch) > 0 { + if len(config.Dns) > 0 || len(daemon.config.Dns) > 0 || len(config.DnsSearch) > 0 || len(daemon.config.DnsSearch) > 0 { var ( dns = utils.GetNameservers(resolvConf) dnsSearch = utils.GetSearchDomains(resolvConf) ) if len(config.Dns) > 0 { dns = config.Dns - } else if len(runtime.config.Dns) > 0 { - dns = runtime.config.Dns + } else if len(daemon.config.Dns) > 0 { + dns = daemon.config.Dns } if len(config.DnsSearch) > 0 { dnsSearch = config.DnsSearch - } else if len(runtime.config.DnsSearch) > 0 { - dnsSearch = runtime.config.DnsSearch + } else if len(daemon.config.DnsSearch) > 0 { + dnsSearch = daemon.config.DnsSearch } container.ResolvConfPath = path.Join(container.root, "resolv.conf") f, err := os.Create(container.ResolvConfPath) @@ -1227,3 +984,198 @@ func (container *Container) setupContainerDns() error { } return nil } + +func (container *Container) initializeNetworking() error { + if container.daemon.config.DisableNetwork { + container.Config.NetworkDisabled = true + container.buildHostnameAndHostsFiles("127.0.1.1") + } else { + if err := container.allocateNetwork(); err != nil { + return err + } + container.buildHostnameAndHostsFiles(container.NetworkSettings.IPAddress) + } + return nil +} + +// Make sure the config is compatible with the current kernel +func (container *Container) verifyDaemonSettings() { + if container.Config.Memory > 0 && !container.daemon.sysInfo.MemoryLimit { + log.Printf("WARNING: Your kernel does not support memory limit capabilities. Limitation discarded.\n") + container.Config.Memory = 0 + } + if container.Config.Memory > 0 && !container.daemon.sysInfo.SwapLimit { + log.Printf("WARNING: Your kernel does not support swap limit capabilities. Limitation discarded.\n") + container.Config.MemorySwap = -1 + } + if container.daemon.sysInfo.IPv4ForwardingDisabled { + log.Printf("WARNING: IPv4 forwarding is disabled. Networking will not work") + } +} + +func (container *Container) setupLinkedContainers() ([]string, error) { + var ( + env []string + daemon = container.daemon + ) + children, err := daemon.Children(container.Name) + if err != nil { + return nil, err + } + + if len(children) > 0 { + container.activeLinks = make(map[string]*links.Link, len(children)) + + // If we encounter an error make sure that we rollback any network + // config and ip table changes + rollback := func() { + for _, link := range container.activeLinks { + link.Disable() + } + container.activeLinks = nil + } + + for linkAlias, child := range children { + if !child.State.IsRunning() { + return nil, fmt.Errorf("Cannot link to a non running container: %s AS %s", child.Name, linkAlias) + } + + link, err := links.NewLink( + container.NetworkSettings.IPAddress, + child.NetworkSettings.IPAddress, + linkAlias, + child.Config.Env, + child.Config.ExposedPorts, + daemon.eng) + + if err != nil { + rollback() + return nil, err + } + + container.activeLinks[link.Alias()] = link + if err := link.Enable(); err != nil { + rollback() + return nil, err + } + + for _, envVar := range link.ToEnv() { + env = append(env, envVar) + } + } + } + return env, nil +} + +func (container *Container) createDaemonEnvironment(linkedEnv []string) []string { + // Setup environment + env := []string{ + "HOME=/", + "PATH=" + DefaultPathEnv, + "HOSTNAME=" + container.Config.Hostname, + } + if container.Config.Tty { + env = append(env, "TERM=xterm") + } + env = append(env, linkedEnv...) + // because the env on the container can override certain default values + // we need to replace the 'env' keys where they match and append anything + // else. + env = utils.ReplaceOrAppendEnvValues(env, container.Config.Env) + + return env +} + +func (container *Container) setupWorkingDirectory() error { + if container.Config.WorkingDir != "" { + container.Config.WorkingDir = path.Clean(container.Config.WorkingDir) + + pthInfo, err := os.Stat(path.Join(container.basefs, container.Config.WorkingDir)) + if err != nil { + if !os.IsNotExist(err) { + return err + } + if err := os.MkdirAll(path.Join(container.basefs, container.Config.WorkingDir), 0755); err != nil { + return err + } + } + if pthInfo != nil && !pthInfo.IsDir() { + return fmt.Errorf("Cannot mkdir: %s is not a directory", container.Config.WorkingDir) + } + } + return nil +} + +func (container *Container) startLoggingToDisk() error { + // Setup logging of stdout and stderr to disk + if err := container.daemon.LogToDisk(container.stdout, container.logPath("json"), "stdout"); err != nil { + return err + } + if err := container.daemon.LogToDisk(container.stderr, container.logPath("json"), "stderr"); err != nil { + return err + } + return nil +} + +func (container *Container) waitForStart() error { + callbackLock := make(chan struct{}) + callback := func(command *execdriver.Command) { + container.State.SetRunning(command.Pid()) + if command.Tty { + // The callback is called after the process Start() + // so we are in the parent process. In TTY mode, stdin/out/err is the PtySlace + // which we close here. + if c, ok := command.Stdout.(io.Closer); ok { + c.Close() + } + } + if err := container.ToDisk(); err != nil { + utils.Debugf("%s", err) + } + close(callbackLock) + } + + // We use a callback here instead of a goroutine and an chan for + // syncronization purposes + cErr := utils.Go(func() error { return container.monitor(callback) }) + + // Start should not return until the process is actually running + select { + case <-callbackLock: + case err := <-cErr: + return err + } + return nil +} + +func (container *Container) allocatePort(eng *engine.Engine, port nat.Port, bindings nat.PortMap) error { + binding := bindings[port] + if container.hostConfig.PublishAllPorts && len(binding) == 0 { + binding = append(binding, nat.PortBinding{}) + } + + for i := 0; i < len(binding); i++ { + b := binding[i] + + job := eng.Job("allocate_port", container.ID) + job.Setenv("HostIP", b.HostIp) + job.Setenv("HostPort", b.HostPort) + job.Setenv("Proto", port.Proto()) + job.Setenv("ContainerPort", port.Port()) + + portEnv, err := job.Stdout.AddEnv() + if err != nil { + return err + } + if err := job.Run(); err != nil { + eng.Job("release_interface", container.ID).Run() + return err + } + b.HostIp = portEnv.Get("HostIP") + b.HostPort = portEnv.Get("HostPort") + + binding[i] = b + } + bindings[port] = binding + return nil +} diff --git a/runtime/container_unit_test.go b/daemon/container_unit_test.go similarity index 99% rename from runtime/container_unit_test.go rename to daemon/container_unit_test.go index fba036ca50..0a8e69ab00 100644 --- a/runtime/container_unit_test.go +++ b/daemon/container_unit_test.go @@ -1,4 +1,4 @@ -package runtime +package daemon import ( "github.com/dotcloud/docker/nat" diff --git a/runtime/runtime.go b/daemon/daemon.go similarity index 67% rename from runtime/runtime.go rename to daemon/daemon.go index d612b48de0..5ed1ea3c16 100644 --- a/runtime/runtime.go +++ b/daemon/daemon.go @@ -1,9 +1,16 @@ -package runtime +package daemon import ( "container/list" "fmt" "github.com/dotcloud/docker/archive" + "github.com/dotcloud/docker/daemon/execdriver" + "github.com/dotcloud/docker/daemon/execdriver/execdrivers" + "github.com/dotcloud/docker/daemon/execdriver/lxc" + "github.com/dotcloud/docker/daemon/graphdriver" + _ "github.com/dotcloud/docker/daemon/graphdriver/vfs" + _ "github.com/dotcloud/docker/daemon/networkdriver/bridge" + "github.com/dotcloud/docker/daemon/networkdriver/portallocator" "github.com/dotcloud/docker/daemonconfig" "github.com/dotcloud/docker/dockerversion" "github.com/dotcloud/docker/engine" @@ -14,13 +21,6 @@ import ( "github.com/dotcloud/docker/pkg/selinux" "github.com/dotcloud/docker/pkg/sysinfo" "github.com/dotcloud/docker/runconfig" - "github.com/dotcloud/docker/runtime/execdriver" - "github.com/dotcloud/docker/runtime/execdriver/execdrivers" - "github.com/dotcloud/docker/runtime/execdriver/lxc" - "github.com/dotcloud/docker/runtime/graphdriver" - _ "github.com/dotcloud/docker/runtime/graphdriver/vfs" - _ "github.com/dotcloud/docker/runtime/networkdriver/bridge" - "github.com/dotcloud/docker/runtime/networkdriver/portallocator" "github.com/dotcloud/docker/utils" "io" "io/ioutil" @@ -44,7 +44,7 @@ var ( validContainerNamePattern = regexp.MustCompile(`^/?` + validContainerNameChars + `+$`) ) -type Runtime struct { +type Daemon struct { repository string sysInitPath string containers *list.List @@ -76,17 +76,17 @@ func remountPrivate(mountPoint string) error { return mount.ForceMount("", mountPoint, "none", "private") } -// List returns an array of all containers registered in the runtime. -func (runtime *Runtime) List() []*Container { +// List returns an array of all containers registered in the daemon. +func (daemon *Daemon) List() []*Container { containers := new(History) - for e := runtime.containers.Front(); e != nil; e = e.Next() { + for e := daemon.containers.Front(); e != nil; e = e.Next() { containers.Add(e.Value.(*Container)) } return *containers } -func (runtime *Runtime) getContainerElement(id string) *list.Element { - for e := runtime.containers.Front(); e != nil; e = e.Next() { +func (daemon *Daemon) getContainerElement(id string) *list.Element { + for e := daemon.containers.Front(); e != nil; e = e.Next() { container := e.Value.(*Container) if container.ID == id { return e @@ -97,17 +97,17 @@ func (runtime *Runtime) getContainerElement(id string) *list.Element { // Get looks for a container by the specified ID or name, and returns it. // If the container is not found, or if an error occurs, nil is returned. -func (runtime *Runtime) Get(name string) *Container { - if c, _ := runtime.GetByName(name); c != nil { +func (daemon *Daemon) Get(name string) *Container { + if c, _ := daemon.GetByName(name); c != nil { return c } - id, err := runtime.idIndex.Get(name) + id, err := daemon.idIndex.Get(name) if err != nil { return nil } - e := runtime.getContainerElement(id) + e := daemon.getContainerElement(id) if e == nil { return nil } @@ -116,18 +116,18 @@ func (runtime *Runtime) Get(name string) *Container { // Exists returns a true if a container of the specified ID or name exists, // false otherwise. -func (runtime *Runtime) Exists(id string) bool { - return runtime.Get(id) != nil +func (daemon *Daemon) Exists(id string) bool { + return daemon.Get(id) != nil } -func (runtime *Runtime) containerRoot(id string) string { - return path.Join(runtime.repository, id) +func (daemon *Daemon) containerRoot(id string) string { + return path.Join(daemon.repository, id) } // Load reads the contents of a container from disk // This is typically done at startup. -func (runtime *Runtime) load(id string) (*Container, error) { - container := &Container{root: runtime.containerRoot(id)} +func (daemon *Daemon) load(id string) (*Container, error) { + container := &Container{root: daemon.containerRoot(id)} if err := container.FromDisk(); err != nil { return nil, err } @@ -140,19 +140,19 @@ func (runtime *Runtime) load(id string) (*Container, error) { return container, nil } -// Register makes a container object usable by the runtime as -func (runtime *Runtime) Register(container *Container) error { - if container.runtime != nil || runtime.Exists(container.ID) { +// Register makes a container object usable by the daemon as +func (daemon *Daemon) Register(container *Container) error { + if container.daemon != nil || daemon.Exists(container.ID) { return fmt.Errorf("Container is already loaded") } if err := validateID(container.ID); err != nil { return err } - if err := runtime.ensureName(container); err != nil { + if err := daemon.ensureName(container); err != nil { return err } - container.runtime = runtime + container.daemon = daemon // Attach to stdout and stderr container.stderr = utils.NewWriteBroadcaster() @@ -164,8 +164,8 @@ func (runtime *Runtime) Register(container *Container) error { container.stdinPipe = utils.NopWriteCloser(ioutil.Discard) // Silently drop stdin } // done - runtime.containers.PushBack(container) - runtime.idIndex.Add(container.ID) + daemon.containers.PushBack(container) + daemon.idIndex.Add(container.ID) // FIXME: if the container is supposed to be running but is not, auto restart it? // if so, then we need to restart monitor and init a new lock @@ -192,7 +192,7 @@ func (runtime *Runtime) Register(container *Container) error { if err != nil { utils.Debugf("cannot find existing process for %d", existingPid) } - runtime.execDriver.Terminate(cmd) + daemon.execDriver.Terminate(cmd) } if err := container.Unmount(); err != nil { utils.Debugf("ghost unmount error %s", err) @@ -202,10 +202,10 @@ func (runtime *Runtime) Register(container *Container) error { } } - info := runtime.execDriver.Info(container.ID) + info := daemon.execDriver.Info(container.ID) if !info.IsRunning() { utils.Debugf("Container %s was supposed to be running but is not.", container.ID) - if runtime.config.AutoRestart { + if daemon.config.AutoRestart { utils.Debugf("Restarting") if err := container.Unmount(); err != nil { utils.Debugf("restart unmount error %s", err) @@ -234,9 +234,9 @@ func (runtime *Runtime) Register(container *Container) error { return nil } -func (runtime *Runtime) ensureName(container *Container) error { +func (daemon *Daemon) ensureName(container *Container) error { if container.Name == "" { - name, err := generateRandomName(runtime) + name, err := generateRandomName(daemon) if err != nil { name = utils.TruncateID(container.ID) } @@ -245,8 +245,8 @@ func (runtime *Runtime) ensureName(container *Container) error { if err := container.ToDisk(); err != nil { utils.Debugf("Error saving container name %s", err) } - if !runtime.containerGraph.Exists(name) { - if _, err := runtime.containerGraph.Set(name, container.ID); err != nil { + if !daemon.containerGraph.Exists(name) { + if _, err := daemon.containerGraph.Set(name, container.ID); err != nil { utils.Debugf("Setting default id - %s", err) } } @@ -254,7 +254,7 @@ func (runtime *Runtime) ensureName(container *Container) error { return nil } -func (runtime *Runtime) LogToDisk(src *utils.WriteBroadcaster, dst, stream string) error { +func (daemon *Daemon) LogToDisk(src *utils.WriteBroadcaster, dst, stream string) error { log, err := os.OpenFile(dst, os.O_RDWR|os.O_APPEND|os.O_CREATE, 0600) if err != nil { return err @@ -263,13 +263,13 @@ func (runtime *Runtime) LogToDisk(src *utils.WriteBroadcaster, dst, stream strin return nil } -// Destroy unregisters a container from the runtime and cleanly removes its contents from the filesystem. -func (runtime *Runtime) Destroy(container *Container) error { +// Destroy unregisters a container from the daemon and cleanly removes its contents from the filesystem. +func (daemon *Daemon) Destroy(container *Container) error { if container == nil { return fmt.Errorf("The given container is ") } - element := runtime.getContainerElement(container.ID) + element := daemon.getContainerElement(container.ID) if element == nil { return fmt.Errorf("Container %v not found - maybe it was already destroyed?", container.ID) } @@ -278,42 +278,42 @@ func (runtime *Runtime) Destroy(container *Container) error { return err } - if err := runtime.driver.Remove(container.ID); err != nil { - return fmt.Errorf("Driver %s failed to remove root filesystem %s: %s", runtime.driver, container.ID, err) + if err := daemon.driver.Remove(container.ID); err != nil { + return fmt.Errorf("Driver %s failed to remove root filesystem %s: %s", daemon.driver, container.ID, err) } initID := fmt.Sprintf("%s-init", container.ID) - if err := runtime.driver.Remove(initID); err != nil { - return fmt.Errorf("Driver %s failed to remove init filesystem %s: %s", runtime.driver, initID, err) + if err := daemon.driver.Remove(initID); err != nil { + return fmt.Errorf("Driver %s failed to remove init filesystem %s: %s", daemon.driver, initID, err) } - if _, err := runtime.containerGraph.Purge(container.ID); err != nil { + if _, err := daemon.containerGraph.Purge(container.ID); err != nil { utils.Debugf("Unable to remove container from link graph: %s", err) } // Deregister the container before removing its directory, to avoid race conditions - runtime.idIndex.Delete(container.ID) - runtime.containers.Remove(element) + daemon.idIndex.Delete(container.ID) + daemon.containers.Remove(element) if err := os.RemoveAll(container.root); err != nil { return fmt.Errorf("Unable to remove filesystem for %v: %v", container.ID, err) } return nil } -func (runtime *Runtime) restore() error { +func (daemon *Daemon) restore() error { if os.Getenv("DEBUG") == "" && os.Getenv("TEST") == "" { fmt.Printf("Loading containers: ") } - dir, err := ioutil.ReadDir(runtime.repository) + dir, err := ioutil.ReadDir(daemon.repository) if err != nil { return err } containers := make(map[string]*Container) - currentDriver := runtime.driver.String() + currentDriver := daemon.driver.String() for _, v := range dir { id := v.Name() - container, err := runtime.load(id) + container, err := daemon.load(id) if os.Getenv("DEBUG") == "" && os.Getenv("TEST") == "" { fmt.Print(".") } @@ -332,12 +332,12 @@ func (runtime *Runtime) restore() error { } register := func(container *Container) { - if err := runtime.Register(container); err != nil { + if err := daemon.Register(container); err != nil { utils.Debugf("Failed to register container %s: %s", container.ID, err) } } - if entities := runtime.containerGraph.List("/", -1); entities != nil { + if entities := daemon.containerGraph.List("/", -1); entities != nil { for _, p := range entities.Paths() { if os.Getenv("DEBUG") == "" && os.Getenv("TEST") == "" { fmt.Print(".") @@ -353,12 +353,12 @@ func (runtime *Runtime) restore() error { // Any containers that are left over do not exist in the graph for _, container := range containers { // Try to set the default name for a container if it exists prior to links - container.Name, err = generateRandomName(runtime) + container.Name, err = generateRandomName(daemon) if err != nil { container.Name = utils.TruncateID(container.ID) } - if _, err := runtime.containerGraph.Set(container.Name, container.ID); err != nil { + if _, err := daemon.containerGraph.Set(container.Name, container.ID); err != nil { utils.Debugf("Setting default id - %s", err) } register(container) @@ -372,38 +372,38 @@ func (runtime *Runtime) restore() error { } // Create creates a new container from the given configuration with a given name. -func (runtime *Runtime) Create(config *runconfig.Config, name string) (*Container, []string, error) { +func (daemon *Daemon) Create(config *runconfig.Config, name string) (*Container, []string, error) { var ( container *Container warnings []string ) - img, err := runtime.repositories.LookupImage(config.Image) + img, err := daemon.repositories.LookupImage(config.Image) if err != nil { return nil, nil, err } - if err := runtime.checkImageDepth(img); err != nil { + if err := daemon.checkImageDepth(img); err != nil { return nil, nil, err } - if warnings, err = runtime.mergeAndVerifyConfig(config, img); err != nil { + if warnings, err = daemon.mergeAndVerifyConfig(config, img); err != nil { return nil, nil, err } - if container, err = runtime.newContainer(name, config, img); err != nil { + if container, err = daemon.newContainer(name, config, img); err != nil { return nil, nil, err } - if err := runtime.createRootfs(container, img); err != nil { + if err := daemon.createRootfs(container, img); err != nil { return nil, nil, err } if err := container.ToDisk(); err != nil { return nil, nil, err } - if err := runtime.Register(container); err != nil { + if err := daemon.Register(container); err != nil { return nil, nil, err } return container, warnings, nil } -func (runtime *Runtime) checkImageDepth(img *image.Image) error { +func (daemon *Daemon) checkImageDepth(img *image.Image) error { // We add 2 layers to the depth because the container's rw and // init layer add to the restriction depth, err := img.Depth() @@ -416,7 +416,7 @@ func (runtime *Runtime) checkImageDepth(img *image.Image) error { return nil } -func (runtime *Runtime) checkDeprecatedExpose(config *runconfig.Config) bool { +func (daemon *Daemon) checkDeprecatedExpose(config *runconfig.Config) bool { if config != nil { if config.PortSpecs != nil { for _, p := range config.PortSpecs { @@ -429,9 +429,9 @@ func (runtime *Runtime) checkDeprecatedExpose(config *runconfig.Config) bool { return false } -func (runtime *Runtime) mergeAndVerifyConfig(config *runconfig.Config, img *image.Image) ([]string, error) { +func (daemon *Daemon) mergeAndVerifyConfig(config *runconfig.Config, img *image.Image) ([]string, error) { warnings := []string{} - if runtime.checkDeprecatedExpose(img.Config) || runtime.checkDeprecatedExpose(config) { + if daemon.checkDeprecatedExpose(img.Config) || daemon.checkDeprecatedExpose(config) { warnings = append(warnings, "The mapping to public ports on your host via Dockerfile EXPOSE (host:port:port) has been deprecated. Use -p to publish the ports.") } if img.Config != nil { @@ -445,14 +445,14 @@ func (runtime *Runtime) mergeAndVerifyConfig(config *runconfig.Config, img *imag return warnings, nil } -func (runtime *Runtime) generateIdAndName(name string) (string, string, error) { +func (daemon *Daemon) generateIdAndName(name string) (string, string, error) { var ( err error id = utils.GenerateRandomID() ) if name == "" { - name, err = generateRandomName(runtime) + name, err = generateRandomName(daemon) if err != nil { name = utils.TruncateID(id) } @@ -465,19 +465,19 @@ func (runtime *Runtime) generateIdAndName(name string) (string, string, error) { name = "/" + name } // Set the enitity in the graph using the default name specified - if _, err := runtime.containerGraph.Set(name, id); err != nil { + if _, err := daemon.containerGraph.Set(name, id); err != nil { if !graphdb.IsNonUniqueNameError(err) { return "", "", err } - conflictingContainer, err := runtime.GetByName(name) + conflictingContainer, err := daemon.GetByName(name) if err != nil { if strings.Contains(err.Error(), "Could not find entity") { return "", "", err } // Remove name and continue starting the container - if err := runtime.containerGraph.Delete(name); err != nil { + if err := daemon.containerGraph.Delete(name); err != nil { return "", "", err } } else { @@ -490,7 +490,7 @@ func (runtime *Runtime) generateIdAndName(name string) (string, string, error) { return id, name, nil } -func (runtime *Runtime) generateHostname(id string, config *runconfig.Config) { +func (daemon *Daemon) generateHostname(id string, config *runconfig.Config) { // Generate default hostname // FIXME: the lxc template no longer needs to set a default hostname if config.Hostname == "" { @@ -498,7 +498,7 @@ func (runtime *Runtime) generateHostname(id string, config *runconfig.Config) { } } -func (runtime *Runtime) getEntrypointAndArgs(config *runconfig.Config) (string, []string) { +func (daemon *Daemon) getEntrypointAndArgs(config *runconfig.Config) (string, []string) { var ( entrypoint string args []string @@ -513,18 +513,18 @@ func (runtime *Runtime) getEntrypointAndArgs(config *runconfig.Config) (string, return entrypoint, args } -func (runtime *Runtime) newContainer(name string, config *runconfig.Config, img *image.Image) (*Container, error) { +func (daemon *Daemon) newContainer(name string, config *runconfig.Config, img *image.Image) (*Container, error) { var ( id string err error ) - id, name, err = runtime.generateIdAndName(name) + id, name, err = daemon.generateIdAndName(name) if err != nil { return nil, err } - runtime.generateHostname(id, config) - entrypoint, args := runtime.getEntrypointAndArgs(config) + daemon.generateHostname(id, config) + entrypoint, args := daemon.getEntrypointAndArgs(config) container := &Container{ // FIXME: we should generate the ID here instead of receiving it as an argument @@ -537,34 +537,34 @@ func (runtime *Runtime) newContainer(name string, config *runconfig.Config, img Image: img.ID, // Always use the resolved image id NetworkSettings: &NetworkSettings{}, Name: name, - Driver: runtime.driver.String(), - ExecDriver: runtime.execDriver.Name(), + Driver: daemon.driver.String(), + ExecDriver: daemon.execDriver.Name(), } - container.root = runtime.containerRoot(container.ID) + container.root = daemon.containerRoot(container.ID) return container, nil } -func (runtime *Runtime) createRootfs(container *Container, img *image.Image) error { +func (daemon *Daemon) createRootfs(container *Container, img *image.Image) error { // Step 1: create the container directory. // This doubles as a barrier to avoid race conditions. if err := os.Mkdir(container.root, 0700); err != nil { return err } initID := fmt.Sprintf("%s-init", container.ID) - if err := runtime.driver.Create(initID, img.ID, ""); err != nil { + if err := daemon.driver.Create(initID, img.ID, ""); err != nil { return err } - initPath, err := runtime.driver.Get(initID) + initPath, err := daemon.driver.Get(initID) if err != nil { return err } - defer runtime.driver.Put(initID) + defer daemon.driver.Put(initID) if err := graph.SetupInitLayer(initPath); err != nil { return err } - if err := runtime.driver.Create(container.ID, initID, ""); err != nil { + if err := daemon.driver.Create(container.ID, initID, ""); err != nil { return err } return nil @@ -572,7 +572,7 @@ func (runtime *Runtime) createRootfs(container *Container, img *image.Image) err // Commit creates a new filesystem image from the current state of a container. // The image can optionally be tagged into a repository -func (runtime *Runtime) Commit(container *Container, repository, tag, comment, author string, config *runconfig.Config) (*image.Image, error) { +func (daemon *Daemon) Commit(container *Container, repository, tag, comment, author string, config *runconfig.Config) (*image.Image, error) { // FIXME: freeze the container before copying it to avoid data corruption? if err := container.Mount(); err != nil { return nil, err @@ -595,13 +595,13 @@ func (runtime *Runtime) Commit(container *Container, repository, tag, comment, a containerImage = container.Image containerConfig = container.Config } - img, err := runtime.graph.Create(rwTar, containerID, containerImage, comment, author, containerConfig, config) + img, err := daemon.graph.Create(rwTar, containerID, containerImage, comment, author, containerConfig, config) if err != nil { return nil, err } // Register the image if needed if repository != "" { - if err := runtime.repositories.Set(repository, tag, img.ID, true); err != nil { + if err := daemon.repositories.Set(repository, tag, img.ID, true); err != nil { return img, err } } @@ -618,31 +618,31 @@ func GetFullContainerName(name string) (string, error) { return name, nil } -func (runtime *Runtime) GetByName(name string) (*Container, error) { +func (daemon *Daemon) GetByName(name string) (*Container, error) { fullName, err := GetFullContainerName(name) if err != nil { return nil, err } - entity := runtime.containerGraph.Get(fullName) + entity := daemon.containerGraph.Get(fullName) if entity == nil { return nil, fmt.Errorf("Could not find entity for %s", name) } - e := runtime.getContainerElement(entity.ID()) + e := daemon.getContainerElement(entity.ID()) if e == nil { return nil, fmt.Errorf("Could not find container for entity id %s", entity.ID()) } return e.Value.(*Container), nil } -func (runtime *Runtime) Children(name string) (map[string]*Container, error) { +func (daemon *Daemon) Children(name string) (map[string]*Container, error) { name, err := GetFullContainerName(name) if err != nil { return nil, err } children := make(map[string]*Container) - err = runtime.containerGraph.Walk(name, func(p string, e *graphdb.Entity) error { - c := runtime.Get(e.ID()) + err = daemon.containerGraph.Walk(name, func(p string, e *graphdb.Entity) error { + c := daemon.Get(e.ID()) if c == nil { return fmt.Errorf("Could not get container for name %s and id %s", e.ID(), p) } @@ -656,25 +656,25 @@ func (runtime *Runtime) Children(name string) (map[string]*Container, error) { return children, nil } -func (runtime *Runtime) RegisterLink(parent, child *Container, alias string) error { +func (daemon *Daemon) RegisterLink(parent, child *Container, alias string) error { fullName := path.Join(parent.Name, alias) - if !runtime.containerGraph.Exists(fullName) { - _, err := runtime.containerGraph.Set(fullName, child.ID) + if !daemon.containerGraph.Exists(fullName) { + _, err := daemon.containerGraph.Set(fullName, child.ID) return err } return nil } // FIXME: harmonize with NewGraph() -func NewRuntime(config *daemonconfig.Config, eng *engine.Engine) (*Runtime, error) { - runtime, err := NewRuntimeFromDirectory(config, eng) +func NewDaemon(config *daemonconfig.Config, eng *engine.Engine) (*Daemon, error) { + daemon, err := NewDaemonFromDirectory(config, eng) if err != nil { return nil, err } - return runtime, nil + return daemon, nil } -func NewRuntimeFromDirectory(config *daemonconfig.Config, eng *engine.Engine) (*Runtime, error) { +func NewDaemonFromDirectory(config *daemonconfig.Config, eng *engine.Engine) (*Daemon, error) { if !config.EnableSelinuxSupport { selinux.SetDisabled() } @@ -693,9 +693,9 @@ func NewRuntimeFromDirectory(config *daemonconfig.Config, eng *engine.Engine) (* return nil, err } - runtimeRepo := path.Join(config.Root, "containers") + daemonRepo := path.Join(config.Root, "containers") - if err := os.MkdirAll(runtimeRepo, 0700); err != nil && !os.IsExist(err) { + if err := os.MkdirAll(daemonRepo, 0700); err != nil && !os.IsExist(err) { return nil, err } @@ -774,8 +774,8 @@ func NewRuntimeFromDirectory(config *daemonconfig.Config, eng *engine.Engine) (* return nil, err } - runtime := &Runtime{ - repository: runtimeRepo, + daemon := &Daemon{ + repository: daemonRepo, containers: list.New(), graph: g, repositories: repositories, @@ -790,19 +790,19 @@ func NewRuntimeFromDirectory(config *daemonconfig.Config, eng *engine.Engine) (* eng: eng, } - if err := runtime.checkLocaldns(); err != nil { + if err := daemon.checkLocaldns(); err != nil { return nil, err } - if err := runtime.restore(); err != nil { + if err := daemon.restore(); err != nil { return nil, err } - return runtime, nil + return daemon, nil } -func (runtime *Runtime) shutdown() error { +func (daemon *Daemon) shutdown() error { group := sync.WaitGroup{} utils.Debugf("starting clean shutdown of all containers...") - for _, container := range runtime.List() { + for _, container := range daemon.List() { c := container if c.State.IsRunning() { utils.Debugf("stopping %s", c.ID) @@ -823,22 +823,22 @@ func (runtime *Runtime) shutdown() error { return nil } -func (runtime *Runtime) Close() error { +func (daemon *Daemon) Close() error { errorsStrings := []string{} - if err := runtime.shutdown(); err != nil { - utils.Errorf("runtime.shutdown(): %s", err) + if err := daemon.shutdown(); err != nil { + utils.Errorf("daemon.shutdown(): %s", err) errorsStrings = append(errorsStrings, err.Error()) } if err := portallocator.ReleaseAll(); err != nil { utils.Errorf("portallocator.ReleaseAll(): %s", err) errorsStrings = append(errorsStrings, err.Error()) } - if err := runtime.driver.Cleanup(); err != nil { - utils.Errorf("runtime.driver.Cleanup(): %s", err.Error()) + if err := daemon.driver.Cleanup(); err != nil { + utils.Errorf("daemon.driver.Cleanup(): %s", err.Error()) errorsStrings = append(errorsStrings, err.Error()) } - if err := runtime.containerGraph.Close(); err != nil { - utils.Errorf("runtime.containerGraph.Close(): %s", err.Error()) + if err := daemon.containerGraph.Close(); err != nil { + utils.Errorf("daemon.containerGraph.Close(): %s", err.Error()) errorsStrings = append(errorsStrings, err.Error()) } if len(errorsStrings) > 0 { @@ -847,55 +847,55 @@ func (runtime *Runtime) Close() error { return nil } -func (runtime *Runtime) Mount(container *Container) error { - dir, err := runtime.driver.Get(container.ID) +func (daemon *Daemon) Mount(container *Container) error { + dir, err := daemon.driver.Get(container.ID) if err != nil { - return fmt.Errorf("Error getting container %s from driver %s: %s", container.ID, runtime.driver, err) + return fmt.Errorf("Error getting container %s from driver %s: %s", container.ID, daemon.driver, err) } if container.basefs == "" { container.basefs = dir } else if container.basefs != dir { return fmt.Errorf("Error: driver %s is returning inconsistent paths for container %s ('%s' then '%s')", - runtime.driver, container.ID, container.basefs, dir) + daemon.driver, container.ID, container.basefs, dir) } return nil } -func (runtime *Runtime) Unmount(container *Container) error { - runtime.driver.Put(container.ID) +func (daemon *Daemon) Unmount(container *Container) error { + daemon.driver.Put(container.ID) return nil } -func (runtime *Runtime) Changes(container *Container) ([]archive.Change, error) { - if differ, ok := runtime.driver.(graphdriver.Differ); ok { +func (daemon *Daemon) Changes(container *Container) ([]archive.Change, error) { + if differ, ok := daemon.driver.(graphdriver.Differ); ok { return differ.Changes(container.ID) } - cDir, err := runtime.driver.Get(container.ID) + cDir, err := daemon.driver.Get(container.ID) if err != nil { - return nil, fmt.Errorf("Error getting container rootfs %s from driver %s: %s", container.ID, container.runtime.driver, err) + return nil, fmt.Errorf("Error getting container rootfs %s from driver %s: %s", container.ID, container.daemon.driver, err) } - defer runtime.driver.Put(container.ID) - initDir, err := runtime.driver.Get(container.ID + "-init") + defer daemon.driver.Put(container.ID) + initDir, err := daemon.driver.Get(container.ID + "-init") if err != nil { - return nil, fmt.Errorf("Error getting container init rootfs %s from driver %s: %s", container.ID, container.runtime.driver, err) + return nil, fmt.Errorf("Error getting container init rootfs %s from driver %s: %s", container.ID, container.daemon.driver, err) } - defer runtime.driver.Put(container.ID + "-init") + defer daemon.driver.Put(container.ID + "-init") return archive.ChangesDirs(cDir, initDir) } -func (runtime *Runtime) Diff(container *Container) (archive.Archive, error) { - if differ, ok := runtime.driver.(graphdriver.Differ); ok { +func (daemon *Daemon) Diff(container *Container) (archive.Archive, error) { + if differ, ok := daemon.driver.(graphdriver.Differ); ok { return differ.Diff(container.ID) } - changes, err := runtime.Changes(container) + changes, err := daemon.Changes(container) if err != nil { return nil, err } - cDir, err := runtime.driver.Get(container.ID) + cDir, err := daemon.driver.Get(container.ID) if err != nil { - return nil, fmt.Errorf("Error getting container rootfs %s from driver %s: %s", container.ID, container.runtime.driver, err) + return nil, fmt.Errorf("Error getting container rootfs %s from driver %s: %s", container.ID, container.daemon.driver, err) } archive, err := archive.ExportChanges(cDir, changes) @@ -904,26 +904,26 @@ func (runtime *Runtime) Diff(container *Container) (archive.Archive, error) { } return utils.NewReadCloserWrapper(archive, func() error { err := archive.Close() - runtime.driver.Put(container.ID) + daemon.driver.Put(container.ID) return err }), nil } -func (runtime *Runtime) Run(c *Container, pipes *execdriver.Pipes, startCallback execdriver.StartCallback) (int, error) { - return runtime.execDriver.Run(c.command, pipes, startCallback) +func (daemon *Daemon) Run(c *Container, pipes *execdriver.Pipes, startCallback execdriver.StartCallback) (int, error) { + return daemon.execDriver.Run(c.command, pipes, startCallback) } -func (runtime *Runtime) Kill(c *Container, sig int) error { - return runtime.execDriver.Kill(c.command, sig) +func (daemon *Daemon) Kill(c *Container, sig int) error { + return daemon.execDriver.Kill(c.command, sig) } // Nuke kills all containers then removes all content // from the content root, including images, volumes and // container filesystems. -// Again: this will remove your entire docker runtime! -func (runtime *Runtime) Nuke() error { +// Again: this will remove your entire docker daemon! +func (daemon *Daemon) Nuke() error { var wg sync.WaitGroup - for _, container := range runtime.List() { + for _, container := range daemon.List() { wg.Add(1) go func(c *Container) { c.Kill() @@ -931,63 +931,63 @@ func (runtime *Runtime) Nuke() error { }(container) } wg.Wait() - runtime.Close() + daemon.Close() - return os.RemoveAll(runtime.config.Root) + return os.RemoveAll(daemon.config.Root) } // FIXME: this is a convenience function for integration tests -// which need direct access to runtime.graph. +// which need direct access to daemon.graph. // Once the tests switch to using engine and jobs, this method // can go away. -func (runtime *Runtime) Graph() *graph.Graph { - return runtime.graph +func (daemon *Daemon) Graph() *graph.Graph { + return daemon.graph } -func (runtime *Runtime) Repositories() *graph.TagStore { - return runtime.repositories +func (daemon *Daemon) Repositories() *graph.TagStore { + return daemon.repositories } -func (runtime *Runtime) Config() *daemonconfig.Config { - return runtime.config +func (daemon *Daemon) Config() *daemonconfig.Config { + return daemon.config } -func (runtime *Runtime) SystemConfig() *sysinfo.SysInfo { - return runtime.sysInfo +func (daemon *Daemon) SystemConfig() *sysinfo.SysInfo { + return daemon.sysInfo } -func (runtime *Runtime) SystemInitPath() string { - return runtime.sysInitPath +func (daemon *Daemon) SystemInitPath() string { + return daemon.sysInitPath } -func (runtime *Runtime) GraphDriver() graphdriver.Driver { - return runtime.driver +func (daemon *Daemon) GraphDriver() graphdriver.Driver { + return daemon.driver } -func (runtime *Runtime) ExecutionDriver() execdriver.Driver { - return runtime.execDriver +func (daemon *Daemon) ExecutionDriver() execdriver.Driver { + return daemon.execDriver } -func (runtime *Runtime) Volumes() *graph.Graph { - return runtime.volumes +func (daemon *Daemon) Volumes() *graph.Graph { + return daemon.volumes } -func (runtime *Runtime) ContainerGraph() *graphdb.Database { - return runtime.containerGraph +func (daemon *Daemon) ContainerGraph() *graphdb.Database { + return daemon.containerGraph } -func (runtime *Runtime) SetServer(server Server) { - runtime.srv = server +func (daemon *Daemon) SetServer(server Server) { + daemon.srv = server } -func (runtime *Runtime) checkLocaldns() error { +func (daemon *Daemon) checkLocaldns() error { resolvConf, err := utils.GetResolvConf() if err != nil { return err } - if len(runtime.config.Dns) == 0 && utils.CheckLocalDns(resolvConf) { + if len(daemon.config.Dns) == 0 && utils.CheckLocalDns(resolvConf) { log.Printf("Local (127.0.0.1) DNS resolver found in resolv.conf and containers can't use it. Using default external servers : %v\n", DefaultDns) - runtime.config.Dns = DefaultDns + daemon.config.Dns = DefaultDns } return nil } diff --git a/runtime/runtime_aufs.go b/daemon/daemon_aufs.go similarity index 80% rename from runtime/runtime_aufs.go rename to daemon/daemon_aufs.go index 5a32615df5..ee3e1d1a58 100644 --- a/runtime/runtime_aufs.go +++ b/daemon/daemon_aufs.go @@ -1,11 +1,11 @@ // +build !exclude_graphdriver_aufs -package runtime +package daemon import ( + "github.com/dotcloud/docker/daemon/graphdriver" + "github.com/dotcloud/docker/daemon/graphdriver/aufs" "github.com/dotcloud/docker/graph" - "github.com/dotcloud/docker/runtime/graphdriver" - "github.com/dotcloud/docker/runtime/graphdriver/aufs" "github.com/dotcloud/docker/utils" ) diff --git a/daemon/daemon_btrfs.go b/daemon/daemon_btrfs.go new file mode 100644 index 0000000000..f343d699c4 --- /dev/null +++ b/daemon/daemon_btrfs.go @@ -0,0 +1,7 @@ +// +build !exclude_graphdriver_btrfs + +package daemon + +import ( + _ "github.com/dotcloud/docker/daemon/graphdriver/btrfs" +) diff --git a/daemon/daemon_devicemapper.go b/daemon/daemon_devicemapper.go new file mode 100644 index 0000000000..ddf8107414 --- /dev/null +++ b/daemon/daemon_devicemapper.go @@ -0,0 +1,7 @@ +// +build !exclude_graphdriver_devicemapper + +package daemon + +import ( + _ "github.com/dotcloud/docker/daemon/graphdriver/devmapper" +) diff --git a/runtime/runtime_no_aufs.go b/daemon/daemon_no_aufs.go similarity index 66% rename from runtime/runtime_no_aufs.go rename to daemon/daemon_no_aufs.go index 05a01fe151..2d9fed29b9 100644 --- a/runtime/runtime_no_aufs.go +++ b/daemon/daemon_no_aufs.go @@ -1,9 +1,9 @@ // +build exclude_graphdriver_aufs -package runtime +package daemon import ( - "github.com/dotcloud/docker/runtime/graphdriver" + "github.com/dotcloud/docker/daemon/graphdriver" ) func migrateIfAufs(driver graphdriver.Driver, root string) error { diff --git a/runtime/execdriver/MAINTAINERS b/daemon/execdriver/MAINTAINERS similarity index 100% rename from runtime/execdriver/MAINTAINERS rename to daemon/execdriver/MAINTAINERS diff --git a/runtime/execdriver/driver.go b/daemon/execdriver/driver.go similarity index 100% rename from runtime/execdriver/driver.go rename to daemon/execdriver/driver.go diff --git a/runtime/execdriver/execdrivers/execdrivers.go b/daemon/execdriver/execdrivers/execdrivers.go similarity index 79% rename from runtime/execdriver/execdrivers/execdrivers.go rename to daemon/execdriver/execdrivers/execdrivers.go index 9e277c86df..18db1f8026 100644 --- a/runtime/execdriver/execdrivers/execdrivers.go +++ b/daemon/execdriver/execdrivers/execdrivers.go @@ -2,10 +2,10 @@ package execdrivers import ( "fmt" + "github.com/dotcloud/docker/daemon/execdriver" + "github.com/dotcloud/docker/daemon/execdriver/lxc" + "github.com/dotcloud/docker/daemon/execdriver/native" "github.com/dotcloud/docker/pkg/sysinfo" - "github.com/dotcloud/docker/runtime/execdriver" - "github.com/dotcloud/docker/runtime/execdriver/lxc" - "github.com/dotcloud/docker/runtime/execdriver/native" "path" ) diff --git a/runtime/execdriver/lxc/driver.go b/daemon/execdriver/lxc/driver.go similarity index 99% rename from runtime/execdriver/lxc/driver.go rename to daemon/execdriver/lxc/driver.go index ef16dcc380..1ebb73e807 100644 --- a/runtime/execdriver/lxc/driver.go +++ b/daemon/execdriver/lxc/driver.go @@ -2,9 +2,9 @@ package lxc import ( "fmt" + "github.com/dotcloud/docker/daemon/execdriver" "github.com/dotcloud/docker/pkg/cgroups" "github.com/dotcloud/docker/pkg/label" - "github.com/dotcloud/docker/runtime/execdriver" "github.com/dotcloud/docker/utils" "io/ioutil" "log" diff --git a/runtime/execdriver/lxc/info.go b/daemon/execdriver/lxc/info.go similarity index 100% rename from runtime/execdriver/lxc/info.go rename to daemon/execdriver/lxc/info.go diff --git a/runtime/execdriver/lxc/info_test.go b/daemon/execdriver/lxc/info_test.go similarity index 100% rename from runtime/execdriver/lxc/info_test.go rename to daemon/execdriver/lxc/info_test.go diff --git a/runtime/execdriver/lxc/init.go b/daemon/execdriver/lxc/init.go similarity index 98% rename from runtime/execdriver/lxc/init.go rename to daemon/execdriver/lxc/init.go index c1933a5e43..324bd5eff7 100644 --- a/runtime/execdriver/lxc/init.go +++ b/daemon/execdriver/lxc/init.go @@ -3,9 +3,9 @@ package lxc import ( "encoding/json" "fmt" + "github.com/dotcloud/docker/daemon/execdriver" "github.com/dotcloud/docker/pkg/netlink" "github.com/dotcloud/docker/pkg/user" - "github.com/dotcloud/docker/runtime/execdriver" "github.com/syndtr/gocapability/capability" "io/ioutil" "net" diff --git a/runtime/execdriver/lxc/lxc_init_linux.go b/daemon/execdriver/lxc/lxc_init_linux.go similarity index 100% rename from runtime/execdriver/lxc/lxc_init_linux.go rename to daemon/execdriver/lxc/lxc_init_linux.go diff --git a/runtime/execdriver/lxc/lxc_init_unsupported.go b/daemon/execdriver/lxc/lxc_init_unsupported.go similarity index 100% rename from runtime/execdriver/lxc/lxc_init_unsupported.go rename to daemon/execdriver/lxc/lxc_init_unsupported.go diff --git a/runtime/execdriver/lxc/lxc_template.go b/daemon/execdriver/lxc/lxc_template.go similarity index 98% rename from runtime/execdriver/lxc/lxc_template.go rename to daemon/execdriver/lxc/lxc_template.go index c49753c6aa..f4cb3d19eb 100644 --- a/runtime/execdriver/lxc/lxc_template.go +++ b/daemon/execdriver/lxc/lxc_template.go @@ -1,8 +1,8 @@ package lxc import ( + "github.com/dotcloud/docker/daemon/execdriver" "github.com/dotcloud/docker/pkg/label" - "github.com/dotcloud/docker/runtime/execdriver" "strings" "text/template" ) diff --git a/runtime/execdriver/lxc/lxc_template_unit_test.go b/daemon/execdriver/lxc/lxc_template_unit_test.go similarity index 98% rename from runtime/execdriver/lxc/lxc_template_unit_test.go rename to daemon/execdriver/lxc/lxc_template_unit_test.go index 7f473a0502..96d11b204b 100644 --- a/runtime/execdriver/lxc/lxc_template_unit_test.go +++ b/daemon/execdriver/lxc/lxc_template_unit_test.go @@ -3,7 +3,7 @@ package lxc import ( "bufio" "fmt" - "github.com/dotcloud/docker/runtime/execdriver" + "github.com/dotcloud/docker/daemon/execdriver" "io/ioutil" "math/rand" "os" diff --git a/runtime/execdriver/native/configuration/parse.go b/daemon/execdriver/native/configuration/parse.go similarity index 100% rename from runtime/execdriver/native/configuration/parse.go rename to daemon/execdriver/native/configuration/parse.go diff --git a/runtime/execdriver/native/configuration/parse_test.go b/daemon/execdriver/native/configuration/parse_test.go similarity index 98% rename from runtime/execdriver/native/configuration/parse_test.go rename to daemon/execdriver/native/configuration/parse_test.go index 8001358766..9034867b7b 100644 --- a/runtime/execdriver/native/configuration/parse_test.go +++ b/daemon/execdriver/native/configuration/parse_test.go @@ -1,7 +1,7 @@ package configuration import ( - "github.com/dotcloud/docker/runtime/execdriver/native/template" + "github.com/dotcloud/docker/daemon/execdriver/native/template" "testing" ) diff --git a/runtime/execdriver/native/create.go b/daemon/execdriver/native/create.go similarity index 94% rename from runtime/execdriver/native/create.go rename to daemon/execdriver/native/create.go index ac67839e4b..ef17ce7042 100644 --- a/runtime/execdriver/native/create.go +++ b/daemon/execdriver/native/create.go @@ -4,12 +4,12 @@ import ( "fmt" "os" + "github.com/dotcloud/docker/daemon/execdriver" + "github.com/dotcloud/docker/daemon/execdriver/native/configuration" + "github.com/dotcloud/docker/daemon/execdriver/native/template" "github.com/dotcloud/docker/pkg/apparmor" "github.com/dotcloud/docker/pkg/label" "github.com/dotcloud/docker/pkg/libcontainer" - "github.com/dotcloud/docker/runtime/execdriver" - "github.com/dotcloud/docker/runtime/execdriver/native/configuration" - "github.com/dotcloud/docker/runtime/execdriver/native/template" ) // createContainer populates and configures the container type with the diff --git a/runtime/execdriver/native/driver.go b/daemon/execdriver/native/driver.go similarity index 99% rename from runtime/execdriver/native/driver.go rename to daemon/execdriver/native/driver.go index c99cae31dd..ab82cdcc65 100644 --- a/runtime/execdriver/native/driver.go +++ b/daemon/execdriver/native/driver.go @@ -3,12 +3,6 @@ package native import ( "encoding/json" "fmt" - "github.com/dotcloud/docker/pkg/apparmor" - "github.com/dotcloud/docker/pkg/cgroups" - "github.com/dotcloud/docker/pkg/libcontainer" - "github.com/dotcloud/docker/pkg/libcontainer/nsinit" - "github.com/dotcloud/docker/pkg/system" - "github.com/dotcloud/docker/runtime/execdriver" "io" "io/ioutil" "log" @@ -18,6 +12,13 @@ import ( "strconv" "strings" "syscall" + + "github.com/dotcloud/docker/daemon/execdriver" + "github.com/dotcloud/docker/pkg/apparmor" + "github.com/dotcloud/docker/pkg/cgroups" + "github.com/dotcloud/docker/pkg/libcontainer" + "github.com/dotcloud/docker/pkg/libcontainer/nsinit" + "github.com/dotcloud/docker/pkg/system" ) const ( diff --git a/runtime/execdriver/native/info.go b/daemon/execdriver/native/info.go similarity index 100% rename from runtime/execdriver/native/info.go rename to daemon/execdriver/native/info.go diff --git a/runtime/execdriver/native/template/default_template.go b/daemon/execdriver/native/template/default_template.go similarity index 100% rename from runtime/execdriver/native/template/default_template.go rename to daemon/execdriver/native/template/default_template.go diff --git a/runtime/execdriver/native/term.go b/daemon/execdriver/native/term.go similarity index 94% rename from runtime/execdriver/native/term.go rename to daemon/execdriver/native/term.go index 0d5298d388..f60351c609 100644 --- a/runtime/execdriver/native/term.go +++ b/daemon/execdriver/native/term.go @@ -5,7 +5,7 @@ package native import ( - "github.com/dotcloud/docker/runtime/execdriver" + "github.com/dotcloud/docker/daemon/execdriver" "io" "os" "os/exec" diff --git a/runtime/execdriver/pipes.go b/daemon/execdriver/pipes.go similarity index 100% rename from runtime/execdriver/pipes.go rename to daemon/execdriver/pipes.go diff --git a/runtime/execdriver/termconsole.go b/daemon/execdriver/termconsole.go similarity index 100% rename from runtime/execdriver/termconsole.go rename to daemon/execdriver/termconsole.go diff --git a/runtime/graphdriver/aufs/aufs.go b/daemon/graphdriver/aufs/aufs.go similarity index 99% rename from runtime/graphdriver/aufs/aufs.go rename to daemon/graphdriver/aufs/aufs.go index 401bbd8c86..8363c24a5e 100644 --- a/runtime/graphdriver/aufs/aufs.go +++ b/daemon/graphdriver/aufs/aufs.go @@ -24,8 +24,8 @@ import ( "bufio" "fmt" "github.com/dotcloud/docker/archive" + "github.com/dotcloud/docker/daemon/graphdriver" mountpk "github.com/dotcloud/docker/pkg/mount" - "github.com/dotcloud/docker/runtime/graphdriver" "github.com/dotcloud/docker/utils" "os" "os/exec" diff --git a/runtime/graphdriver/aufs/aufs_test.go b/daemon/graphdriver/aufs/aufs_test.go similarity index 99% rename from runtime/graphdriver/aufs/aufs_test.go rename to daemon/graphdriver/aufs/aufs_test.go index 9cfdebd160..9e01a945aa 100644 --- a/runtime/graphdriver/aufs/aufs_test.go +++ b/daemon/graphdriver/aufs/aufs_test.go @@ -5,7 +5,7 @@ import ( "encoding/hex" "fmt" "github.com/dotcloud/docker/archive" - "github.com/dotcloud/docker/runtime/graphdriver" + "github.com/dotcloud/docker/daemon/graphdriver" "io/ioutil" "os" "path" diff --git a/runtime/graphdriver/aufs/dirs.go b/daemon/graphdriver/aufs/dirs.go similarity index 100% rename from runtime/graphdriver/aufs/dirs.go rename to daemon/graphdriver/aufs/dirs.go diff --git a/runtime/graphdriver/aufs/migrate.go b/daemon/graphdriver/aufs/migrate.go similarity index 100% rename from runtime/graphdriver/aufs/migrate.go rename to daemon/graphdriver/aufs/migrate.go diff --git a/runtime/graphdriver/aufs/mount.go b/daemon/graphdriver/aufs/mount.go similarity index 100% rename from runtime/graphdriver/aufs/mount.go rename to daemon/graphdriver/aufs/mount.go diff --git a/runtime/graphdriver/aufs/mount_linux.go b/daemon/graphdriver/aufs/mount_linux.go similarity index 100% rename from runtime/graphdriver/aufs/mount_linux.go rename to daemon/graphdriver/aufs/mount_linux.go diff --git a/runtime/graphdriver/aufs/mount_unsupported.go b/daemon/graphdriver/aufs/mount_unsupported.go similarity index 100% rename from runtime/graphdriver/aufs/mount_unsupported.go rename to daemon/graphdriver/aufs/mount_unsupported.go diff --git a/runtime/graphdriver/btrfs/btrfs.go b/daemon/graphdriver/btrfs/btrfs.go similarity index 98% rename from runtime/graphdriver/btrfs/btrfs.go rename to daemon/graphdriver/btrfs/btrfs.go index 2a94a4089f..494a375817 100644 --- a/runtime/graphdriver/btrfs/btrfs.go +++ b/daemon/graphdriver/btrfs/btrfs.go @@ -11,7 +11,7 @@ import "C" import ( "fmt" - "github.com/dotcloud/docker/runtime/graphdriver" + "github.com/dotcloud/docker/daemon/graphdriver" "os" "path" "syscall" diff --git a/runtime/graphdriver/btrfs/dummy_unsupported.go b/daemon/graphdriver/btrfs/dummy_unsupported.go similarity index 100% rename from runtime/graphdriver/btrfs/dummy_unsupported.go rename to daemon/graphdriver/btrfs/dummy_unsupported.go diff --git a/runtime/graphdriver/devmapper/attach_loopback.go b/daemon/graphdriver/devmapper/attach_loopback.go similarity index 100% rename from runtime/graphdriver/devmapper/attach_loopback.go rename to daemon/graphdriver/devmapper/attach_loopback.go diff --git a/runtime/graphdriver/devmapper/deviceset.go b/daemon/graphdriver/devmapper/deviceset.go similarity index 100% rename from runtime/graphdriver/devmapper/deviceset.go rename to daemon/graphdriver/devmapper/deviceset.go diff --git a/runtime/graphdriver/devmapper/devmapper.go b/daemon/graphdriver/devmapper/devmapper.go similarity index 100% rename from runtime/graphdriver/devmapper/devmapper.go rename to daemon/graphdriver/devmapper/devmapper.go diff --git a/runtime/graphdriver/devmapper/devmapper_doc.go b/daemon/graphdriver/devmapper/devmapper_doc.go similarity index 100% rename from runtime/graphdriver/devmapper/devmapper_doc.go rename to daemon/graphdriver/devmapper/devmapper_doc.go diff --git a/runtime/graphdriver/devmapper/devmapper_log.go b/daemon/graphdriver/devmapper/devmapper_log.go similarity index 100% rename from runtime/graphdriver/devmapper/devmapper_log.go rename to daemon/graphdriver/devmapper/devmapper_log.go diff --git a/runtime/graphdriver/devmapper/devmapper_test.go b/daemon/graphdriver/devmapper/devmapper_test.go similarity index 100% rename from runtime/graphdriver/devmapper/devmapper_test.go rename to daemon/graphdriver/devmapper/devmapper_test.go diff --git a/runtime/graphdriver/devmapper/devmapper_wrapper.go b/daemon/graphdriver/devmapper/devmapper_wrapper.go similarity index 100% rename from runtime/graphdriver/devmapper/devmapper_wrapper.go rename to daemon/graphdriver/devmapper/devmapper_wrapper.go diff --git a/runtime/graphdriver/devmapper/driver.go b/daemon/graphdriver/devmapper/driver.go similarity index 98% rename from runtime/graphdriver/devmapper/driver.go rename to daemon/graphdriver/devmapper/driver.go index 35fe883f26..e958ef3e59 100644 --- a/runtime/graphdriver/devmapper/driver.go +++ b/daemon/graphdriver/devmapper/driver.go @@ -4,7 +4,7 @@ package devmapper import ( "fmt" - "github.com/dotcloud/docker/runtime/graphdriver" + "github.com/dotcloud/docker/daemon/graphdriver" "github.com/dotcloud/docker/utils" "io/ioutil" "os" diff --git a/runtime/graphdriver/devmapper/driver_test.go b/daemon/graphdriver/devmapper/driver_test.go similarity index 99% rename from runtime/graphdriver/devmapper/driver_test.go rename to daemon/graphdriver/devmapper/driver_test.go index 4ca72db0ca..d431f942aa 100644 --- a/runtime/graphdriver/devmapper/driver_test.go +++ b/daemon/graphdriver/devmapper/driver_test.go @@ -4,7 +4,7 @@ package devmapper import ( "fmt" - "github.com/dotcloud/docker/runtime/graphdriver" + "github.com/dotcloud/docker/daemon/graphdriver" "io/ioutil" "path" "runtime" diff --git a/runtime/graphdriver/devmapper/ioctl.go b/daemon/graphdriver/devmapper/ioctl.go similarity index 100% rename from runtime/graphdriver/devmapper/ioctl.go rename to daemon/graphdriver/devmapper/ioctl.go diff --git a/runtime/graphdriver/devmapper/mount.go b/daemon/graphdriver/devmapper/mount.go similarity index 100% rename from runtime/graphdriver/devmapper/mount.go rename to daemon/graphdriver/devmapper/mount.go diff --git a/runtime/graphdriver/devmapper/sys.go b/daemon/graphdriver/devmapper/sys.go similarity index 100% rename from runtime/graphdriver/devmapper/sys.go rename to daemon/graphdriver/devmapper/sys.go diff --git a/runtime/graphdriver/driver.go b/daemon/graphdriver/driver.go similarity index 100% rename from runtime/graphdriver/driver.go rename to daemon/graphdriver/driver.go diff --git a/runtime/graphdriver/vfs/driver.go b/daemon/graphdriver/vfs/driver.go similarity index 97% rename from runtime/graphdriver/vfs/driver.go rename to daemon/graphdriver/vfs/driver.go index fe09560f24..40acde7b75 100644 --- a/runtime/graphdriver/vfs/driver.go +++ b/daemon/graphdriver/vfs/driver.go @@ -2,7 +2,7 @@ package vfs import ( "fmt" - "github.com/dotcloud/docker/runtime/graphdriver" + "github.com/dotcloud/docker/daemon/graphdriver" "os" "os/exec" "path" diff --git a/runtime/history.go b/daemon/history.go similarity index 87% rename from runtime/history.go rename to daemon/history.go index 835ac9c11e..57a00a2090 100644 --- a/runtime/history.go +++ b/daemon/history.go @@ -1,4 +1,4 @@ -package runtime +package daemon import ( "sort" @@ -14,7 +14,7 @@ func (history *History) Len() int { func (history *History) Less(i, j int) bool { containers := *history - return containers[j].When().Before(containers[i].When()) + return containers[j].Created.Before(containers[i].Created) } func (history *History) Swap(i, j int) { diff --git a/daemon/network_settings.go b/daemon/network_settings.go new file mode 100644 index 0000000000..762270362b --- /dev/null +++ b/daemon/network_settings.go @@ -0,0 +1,42 @@ +package daemon + +import ( + "github.com/dotcloud/docker/engine" + "github.com/dotcloud/docker/nat" +) + +// FIXME: move deprecated port stuff to nat to clean up the core. +type PortMapping map[string]string // Deprecated + +type NetworkSettings struct { + IPAddress string + IPPrefixLen int + Gateway string + Bridge string + PortMapping map[string]PortMapping // Deprecated + Ports nat.PortMap +} + +func (settings *NetworkSettings) PortMappingAPI() *engine.Table { + var outs = engine.NewTable("", 0) + for port, bindings := range settings.Ports { + p, _ := nat.ParsePort(port.Port()) + if len(bindings) == 0 { + out := &engine.Env{} + out.SetInt("PublicPort", p) + out.Set("Type", port.Proto()) + outs.Add(out) + continue + } + for _, binding := range bindings { + out := &engine.Env{} + h, _ := nat.ParsePort(binding.HostPort) + out.SetInt("PrivatePort", p) + out.SetInt("PublicPort", h) + out.Set("Type", port.Proto()) + out.Set("IP", binding.HostIp) + outs.Add(out) + } + } + return outs +} diff --git a/runtime/networkdriver/bridge/driver.go b/daemon/networkdriver/bridge/driver.go similarity index 97% rename from runtime/networkdriver/bridge/driver.go rename to daemon/networkdriver/bridge/driver.go index b8568c7c40..90782a5824 100644 --- a/runtime/networkdriver/bridge/driver.go +++ b/daemon/networkdriver/bridge/driver.go @@ -2,13 +2,13 @@ package bridge import ( "fmt" + "github.com/dotcloud/docker/daemon/networkdriver" + "github.com/dotcloud/docker/daemon/networkdriver/ipallocator" + "github.com/dotcloud/docker/daemon/networkdriver/portallocator" + "github.com/dotcloud/docker/daemon/networkdriver/portmapper" "github.com/dotcloud/docker/engine" "github.com/dotcloud/docker/pkg/iptables" "github.com/dotcloud/docker/pkg/netlink" - "github.com/dotcloud/docker/runtime/networkdriver" - "github.com/dotcloud/docker/runtime/networkdriver/ipallocator" - "github.com/dotcloud/docker/runtime/networkdriver/portallocator" - "github.com/dotcloud/docker/runtime/networkdriver/portmapper" "github.com/dotcloud/docker/utils" "io/ioutil" "log" @@ -32,7 +32,7 @@ var ( // This is to use the same gateway IPs as the /24 ranges, which predate the /16 ranges. // In theory this shouldn't matter - in practice there's bound to be a few scripts relying // on the internal addressing or other stupid things like that. - // The shouldn't, but hey, let's not break them unless we really have to. + // They shouldn't, but hey, let's not break them unless we really have to. "172.17.42.1/16", // Don't use 172.16.0.0/16, it conflicts with EC2 DNS 172.16.0.23 "10.0.42.1/16", // Don't even try using the entire /8, that's too intrusive "10.1.42.1/16", diff --git a/runtime/networkdriver/ipallocator/allocator.go b/daemon/networkdriver/ipallocator/allocator.go similarity index 98% rename from runtime/networkdriver/ipallocator/allocator.go rename to daemon/networkdriver/ipallocator/allocator.go index 70a7028bbe..914df34942 100644 --- a/runtime/networkdriver/ipallocator/allocator.go +++ b/daemon/networkdriver/ipallocator/allocator.go @@ -3,8 +3,8 @@ package ipallocator import ( "encoding/binary" "errors" + "github.com/dotcloud/docker/daemon/networkdriver" "github.com/dotcloud/docker/pkg/collections" - "github.com/dotcloud/docker/runtime/networkdriver" "net" "sync" ) diff --git a/runtime/networkdriver/ipallocator/allocator_test.go b/daemon/networkdriver/ipallocator/allocator_test.go similarity index 100% rename from runtime/networkdriver/ipallocator/allocator_test.go rename to daemon/networkdriver/ipallocator/allocator_test.go diff --git a/runtime/networkdriver/network.go b/daemon/networkdriver/network.go similarity index 100% rename from runtime/networkdriver/network.go rename to daemon/networkdriver/network.go diff --git a/runtime/networkdriver/network_test.go b/daemon/networkdriver/network_test.go similarity index 100% rename from runtime/networkdriver/network_test.go rename to daemon/networkdriver/network_test.go diff --git a/runtime/networkdriver/portallocator/portallocator.go b/daemon/networkdriver/portallocator/portallocator.go similarity index 100% rename from runtime/networkdriver/portallocator/portallocator.go rename to daemon/networkdriver/portallocator/portallocator.go diff --git a/runtime/networkdriver/portallocator/portallocator_test.go b/daemon/networkdriver/portallocator/portallocator_test.go similarity index 100% rename from runtime/networkdriver/portallocator/portallocator_test.go rename to daemon/networkdriver/portallocator/portallocator_test.go diff --git a/runtime/networkdriver/portmapper/mapper.go b/daemon/networkdriver/portmapper/mapper.go similarity index 100% rename from runtime/networkdriver/portmapper/mapper.go rename to daemon/networkdriver/portmapper/mapper.go diff --git a/runtime/networkdriver/portmapper/mapper_test.go b/daemon/networkdriver/portmapper/mapper_test.go similarity index 100% rename from runtime/networkdriver/portmapper/mapper_test.go rename to daemon/networkdriver/portmapper/mapper_test.go diff --git a/runtime/networkdriver/utils.go b/daemon/networkdriver/utils.go similarity index 100% rename from runtime/networkdriver/utils.go rename to daemon/networkdriver/utils.go diff --git a/runtime/server.go b/daemon/server.go similarity index 92% rename from runtime/server.go rename to daemon/server.go index a74c4d1200..dbe6a8ebe8 100644 --- a/runtime/server.go +++ b/daemon/server.go @@ -1,4 +1,4 @@ -package runtime +package daemon import ( "github.com/dotcloud/docker/utils" diff --git a/runtime/sorter.go b/daemon/sorter.go similarity index 97% rename from runtime/sorter.go rename to daemon/sorter.go index c5af772dae..c1525aa350 100644 --- a/runtime/sorter.go +++ b/daemon/sorter.go @@ -1,4 +1,4 @@ -package runtime +package daemon import "sort" diff --git a/runtime/state.go b/daemon/state.go similarity index 98% rename from runtime/state.go rename to daemon/state.go index 316b8a40f1..aabb5e43ba 100644 --- a/runtime/state.go +++ b/daemon/state.go @@ -1,4 +1,4 @@ -package runtime +package daemon import ( "fmt" diff --git a/runtime/utils.go b/daemon/utils.go similarity index 87% rename from runtime/utils.go rename to daemon/utils.go index b983e67d41..15b62e2a06 100644 --- a/runtime/utils.go +++ b/daemon/utils.go @@ -1,4 +1,4 @@ -package runtime +package daemon import ( "fmt" @@ -51,14 +51,14 @@ func mergeLxcConfIntoOptions(hostConfig *runconfig.HostConfig, driverConfig map[ } type checker struct { - runtime *Runtime + daemon *Daemon } func (c *checker) Exists(name string) bool { - return c.runtime.containerGraph.Exists("/" + name) + return c.daemon.containerGraph.Exists("/" + name) } // Generate a random and unique name -func generateRandomName(runtime *Runtime) (string, error) { - return namesgenerator.GenerateRandomName(&checker{runtime}) +func generateRandomName(daemon *Daemon) (string, error) { + return namesgenerator.GenerateRandomName(&checker{daemon}) } diff --git a/runtime/utils_test.go b/daemon/utils_test.go similarity index 97% rename from runtime/utils_test.go rename to daemon/utils_test.go index bdf3543a49..22b52d1699 100644 --- a/runtime/utils_test.go +++ b/daemon/utils_test.go @@ -1,4 +1,4 @@ -package runtime +package daemon import ( "testing" diff --git a/runtime/volumes.go b/daemon/volumes.go similarity index 94% rename from runtime/volumes.go rename to daemon/volumes.go index 004f1bb024..4a5c4475b7 100644 --- a/runtime/volumes.go +++ b/daemon/volumes.go @@ -1,9 +1,9 @@ -package runtime +package daemon import ( "fmt" "github.com/dotcloud/docker/archive" - "github.com/dotcloud/docker/runtime/execdriver" + "github.com/dotcloud/docker/daemon/execdriver" "github.com/dotcloud/docker/utils" "io/ioutil" "os" @@ -33,9 +33,14 @@ func prepareVolumesForContainer(container *Container) error { return nil } -func setupMountsForContainer(container *Container, envPath string) error { +func setupMountsForContainer(container *Container) error { + envPath, err := container.EnvConfigPath() + if err != nil { + return err + } + mounts := []execdriver.Mount{ - {container.runtime.sysInitPath, "/.dockerinit", false, true}, + {container.daemon.sysInitPath, "/.dockerinit", false, true}, {envPath, "/.dockerenv", false, true}, {container.ResolvConfPath, "/etc/resolv.conf", false, true}, } @@ -80,7 +85,7 @@ func applyVolumesFrom(container *Container) error { } } - c := container.runtime.Get(specParts[0]) + c := container.daemon.Get(specParts[0]) if c == nil { return fmt.Errorf("Container %s not found. Impossible to mount its volumes", specParts[0]) } @@ -162,7 +167,7 @@ func createVolumes(container *Container) error { return err } - volumesDriver := container.runtime.volumes.Driver() + volumesDriver := container.daemon.volumes.Driver() // Create the requested volumes if they don't exist for volPath := range container.Config.Volumes { volPath = filepath.Clean(volPath) @@ -195,7 +200,7 @@ func createVolumes(container *Container) error { // Do not pass a container as the parameter for the volume creation. // The graph driver using the container's information ( Image ) to // create the parent. - c, err := container.runtime.volumes.Create(nil, "", "", "", "", nil, nil) + c, err := container.daemon.volumes.Create(nil, "", "", "", "", nil, nil) if err != nil { return err } diff --git a/daemonconfig/config.go b/daemonconfig/config.go index 146916d79a..2803f827f4 100644 --- a/daemonconfig/config.go +++ b/daemonconfig/config.go @@ -1,8 +1,8 @@ package daemonconfig import ( + "github.com/dotcloud/docker/daemon/networkdriver" "github.com/dotcloud/docker/engine" - "github.com/dotcloud/docker/runtime/networkdriver" "net" ) diff --git a/docs/Dockerfile b/docs/Dockerfile index 69aa5cb409..d832dcb798 100644 --- a/docs/Dockerfile +++ b/docs/Dockerfile @@ -1,19 +1,45 @@ -FROM ubuntu:12.04 -MAINTAINER Nick Stinemates # -# docker build -t docker:docs . && docker run -p 8000:8000 docker:docs +# See the top level Makefile in https://github.com/dotcloud/docker for usage. # +FROM debian:jessie +MAINTAINER Sven Dowideit (@SvenDowideit) -# TODO switch to http://packages.ubuntu.com/trusty/python-sphinxcontrib-httpdomain once trusty is released +RUN apt-get update && apt-get install -yq make python-pip python-setuptools vim-tiny git pandoc -RUN apt-get update && DEBIAN_FRONTEND=noninteractive apt-get install -yq make python-pip python-setuptools +RUN pip install mkdocs + +# installing sphinx for the rst->md conversion only - will be removed after May release # pip installs from docs/requirements.txt, but here to increase cacheability -RUN pip install Sphinx==1.2.1 -RUN pip install sphinxcontrib-httpdomain==1.2.0 -ADD . /docs -RUN make -C /docs clean docs +RUN pip install Sphinx==1.2.1 +RUN pip install sphinxcontrib-httpdomain==1.2.0 + +# add MarkdownTools to get transclusion +# (future development) +#RUN easy_install -U setuptools +#RUN pip install MarkdownTools2 + +# this week I seem to need the latest dev release of awscli too +# awscli 1.3.6 does --error-document correctly +# https://github.com/aws/aws-cli/commit/edc2290e173dfaedc70b48cfa3624d58c533c6c3 +RUN pip install awscli + +# get my sitemap.xml branch of mkdocs and use that for now +RUN git clone https://github.com/SvenDowideit/mkdocs &&\ + cd mkdocs/ &&\ + git checkout docker-markdown-merge &&\ + ./setup.py install + +ADD . /docs +ADD MAINTAINERS /docs/sources/humans.txt +WORKDIR /docs + +#build the sphinx html +#RUN make -C /docs clean docs + +#convert to markdown +#RUN ./convert.sh -WORKDIR /docs/_build/html -CMD ["python", "-m", "SimpleHTTPServer"] # note, EXPOSE is only last because of https://github.com/dotcloud/docker/issues/3525 -EXPOSE 8000 +EXPOSE 8000 + +CMD ["mkdocs", "serve"] diff --git a/docs/MAINTAINERS b/docs/MAINTAINERS index 52505fab00..afbbde4099 100644 --- a/docs/MAINTAINERS +++ b/docs/MAINTAINERS @@ -1,2 +1,3 @@ James Turnbull (@jamtur01) Sven Dowideit (@SvenDowideit) +O.S. Tezer (@OSTezer) diff --git a/docs/README.md b/docs/README.md old mode 100644 new mode 100755 index 9379d86870..a113cb9edd --- a/docs/README.md +++ b/docs/README.md @@ -4,77 +4,49 @@ Docker Documentation Overview -------- -The source for Docker documentation is here under ``sources/`` in the -form of .rst files. These files use -[reStructuredText](http://docutils.sourceforge.net/rst.html) -formatting with [Sphinx](http://sphinx-doc.org/) extensions for -structure, cross-linking and indexing. +The source for Docker documentation is here under ``sources/`` and uses +extended Markdown, as implemented by [mkdocs](http://mkdocs.org). -The HTML files are built and hosted on -[readthedocs.org](https://readthedocs.org/projects/docker/), appearing -via proxy on https://docs.docker.io. The HTML files update +The HTML files are built and hosted on https://docs.docker.io, and update automatically after each change to the master or release branch of the [docker files on GitHub](https://github.com/dotcloud/docker) thanks to post-commit hooks. The "release" branch maps to the "latest" -documentation and the "master" branch maps to the "master" +documentation and the "master" (unreleased development) branch maps to the "master" documentation. ## Branches **There are two branches related to editing docs**: ``master`` and a -``doc*`` branch (currently ``doc0.8.1``). You should normally edit -docs on the ``master`` branch. That way your fixes will automatically -get included in later releases, and docs maintainers can easily -cherry-pick your changes to bring over to the current docs branch. In -the rare case where your change is not forward-compatible, then you -could base your change on the appropriate ``doc*`` branch. +``docs`` branch. You should always edit +docs on a local branch of the ``master`` branch, and send a PR against ``master``. +That way your fixes +will automatically get included in later releases, and docs maintainers +can easily cherry-pick your changes into the ``docs`` release branch. +In the rare case where your change is not forward-compatible, +you may need to base your changes on the ``docs`` branch. -Now that we have a ``doc*`` branch, we can keep the ``latest`` docs +Now that we have a ``docs`` branch, we can keep the [http://docs.docker.io](http://docs.docker.io) docs up to date with any bugs found between ``docker`` code releases. -**Warning**: When *reading* the docs, the ``master`` documentation may +**Warning**: When *reading* the docs, the [http://beta-docs.docker.io](http://beta-docs.docker.io) documentation may include features not yet part of any official docker -release. ``Master`` docs should be used only for understanding -bleeding-edge development and ``latest`` (which points to the ``doc*`` +release. The ``beta-docs`` site should be used only for understanding +bleeding-edge development and ``docs.docker.io`` (which points to the ``docs`` branch``) should be used for the latest official release. -If you need to manually trigger a build of an existing branch, then -you can do that through the [readthedocs -interface](https://readthedocs.org/builds/docker/). If you would like -to add new build targets, including new branches or tags, then you -must contact one of the existing maintainers and get your -readthedocs.org account added to the maintainers list, or just file an -issue on GitHub describing the branch/tag and why it needs to be added -to the docs, and one of the maintainers will add it for you. - Getting Started --------------- -To edit and test the docs, you'll need to install the Sphinx tool and -its dependencies. There are two main ways to install this tool: - -### Native Installation - -Install dependencies from `requirements.txt` file in your `docker/docs` -directory: - -* Linux: `pip install -r docs/requirements.txt` - -* Mac OS X: `[sudo] pip-2.7 install -r docs/requirements.txt` - -### Alternative Installation: Docker Container - -If you're running ``docker`` on your development machine then you may -find it easier and cleaner to use the docs Dockerfile. This installs Sphinx -in a container, adds the local ``docs/`` directory and builds the HTML -docs inside the container, even starting a simple HTTP server on port -8000 so that you can connect and see your changes. +Docker documentation builds are done in a docker container, which installs all +the required tools, adds the local ``docs/`` directory and builds the HTML +docs. It then starts a HTTP server on port 8000 so that you can connect +and see your changes. In the ``docker`` source directory, run: ```make docs``` -This is the equivalent to ``make clean server`` since each container -starts clean. +If you have any issues you need to debug, you can use ``make docs-shell`` and +then run ``mkdocs serve`` # Contributing @@ -84,8 +56,8 @@ starts clean. ``../CONTRIBUTING.md``](../CONTRIBUTING.md)). * [Remember to sign your work!](../CONTRIBUTING.md#sign-your-work) * Work in your own fork of the code, we accept pull requests. -* Change the ``.rst`` files with your favorite editor -- try to keep the - lines short and respect RST and Sphinx conventions. +* Change the ``.md`` files with your favorite editor -- try to keep the + lines short (80 chars) and respect Markdown conventions. * Run ``make clean docs`` to clean up old files and generate new ones, or just ``make docs`` to update after small changes. * Your static website can now be found in the ``_build`` directory. @@ -94,27 +66,13 @@ starts clean. ``make clean docs`` must complete without any warnings or errors. -## Special Case for RST Newbies: - -If you want to write a new doc or make substantial changes to an -existing doc, but **you don't know RST syntax**, we will accept pull -requests in Markdown and plain text formats. We really want to -encourage people to share their knowledge and don't want the markup -syntax to be the obstacle. So when you make the Pull Request, please -note in your comment that you need RST markup assistance, and we'll -make the changes for you, and then we will make a pull request to your -pull request so that you can get all the changes and learn about the -markup. You still need to follow the -[``CONTRIBUTING``](../CONTRIBUTING) guidelines, so please sign your -commits. - Working using GitHub's file editor ---------------------------------- Alternatively, for small changes and typos you might want to use GitHub's built in file editor. It allows you to preview your changes right online (though there can be some differences between GitHub -markdown and Sphinx RST). Just be careful not to create many commits. +Markdown and mkdocs Markdown). Just be careful not to create many commits. And you must still [sign your work!](../CONTRIBUTING.md#sign-your-work) Images @@ -122,62 +80,25 @@ Images When you need to add images, try to make them as small as possible (e.g. as gif). Usually images should go in the same directory as the -.rst file which references them, or in a subdirectory if one already +.md file which references them, or in a subdirectory if one already exists. -Notes ------ +Publishing Documentation +------------------------ -* For the template the css is compiled from less. When changes are - needed they can be compiled using +To publish a copy of the documentation you need a ``docs/awsconfig`` +file containing AWS settings to deploy to. The release script will +create an s3 if needed, and will then push the files to it. - lessc ``lessc main.less`` or watched using watch-lessc ``watch-lessc -i main.less -o main.css`` +``` +[profile dowideit-docs] +aws_access_key_id = IHOIUAHSIDH234rwf.... +aws_secret_access_key = OIUYSADJHLKUHQWIUHE...... +region = ap-southeast-2 +``` -Guides on using sphinx ----------------------- -* To make links to certain sections create a link target like so: +The ``profile`` name must be the same as the name of the bucket you are +deploying to - which you call from the docker directory: - ``` - .. _hello_world: - - Hello world - =========== - - This is a reference to :ref:`hello_world` and will work even if we - move the target to another file or change the title of the section. - ``` - - The ``_hello_world:`` will make it possible to link to this position - (page and section heading) from all other pages. See the [Sphinx - docs](http://sphinx-doc.org/markup/inline.html#role-ref) for more - information and examples. - -* Notes, warnings and alarms - - ``` - # a note (use when something is important) - .. note:: - - # a warning (orange) - .. warning:: - - # danger (red, use sparsely) - .. danger:: - -* Code examples - - * Start typed commands with ``$ `` (dollar space) so that they - are easily differentiated from program output. - * Use "sudo" with docker to ensure that your command is runnable - even if they haven't [used the *docker* - group](http://docs.docker.io/en/latest/use/basics/#why-sudo). - -Manpages --------- - -* To make the manpages, run ``make man``. Please note there is a bug - in Sphinx 1.1.3 which makes this fail. Upgrade to the latest version - of Sphinx. -* Then preview the manpage by running ``man _build/man/docker.1``, - where ``_build/man/docker.1`` is the path to the generated manfile +``make AWS_S3_BUCKET=dowideit-docs docs-release`` diff --git a/docs/asciinema.patch b/docs/asciinema.patch new file mode 100644 index 0000000000..297c535815 --- /dev/null +++ b/docs/asciinema.patch @@ -0,0 +1,86 @@ +diff --git a/docs/sources/examples/hello_world.md b/docs/sources/examples/hello_world.md +index 6e072f6..5a4537d 100644 +--- a/docs/sources/examples/hello_world.md ++++ b/docs/sources/examples/hello_world.md +@@ -59,6 +59,9 @@ standard out. + + See the example in action + ++ ++ ++ + ## Hello World Daemon + + Note +@@ -142,6 +145,8 @@ Make sure it is really stopped. + + See the example in action + ++ ++ + The next example in the series is a [*Node.js Web + App*](../nodejs_web_app/#nodejs-web-app) example, or you could skip to + any of the other examples: +diff --git a/docs/asciinema.patch b/docs/asciinema.patch +index e240bf3..e69de29 100644 +--- a/docs/asciinema.patch ++++ b/docs/asciinema.patch +@@ -1,23 +0,0 @@ +-diff --git a/docs/sources/examples/hello_world.md b/docs/sources/examples/hello_world.md +-index 6e072f6..5a4537d 100644 +---- a/docs/sources/examples/hello_world.md +-+++ b/docs/sources/examples/hello_world.md +-@@ -59,6 +59,9 @@ standard out. +- +- See the example in action +- +-+ +-+ +-+ +- ## Hello World Daemon +- +- Note +-@@ -142,6 +145,8 @@ Make sure it is really stopped. +- +- See the example in action +- +-+ +-+ +- The next example in the series is a [*Node.js Web +- App*](../nodejs_web_app/#nodejs-web-app) example, or you could skip to +- any of the other examples: +diff --git a/docs/sources/examples/hello_world.md b/docs/sources/examples/hello_world.md +index 6e072f6..c277f38 100644 +--- a/docs/sources/examples/hello_world.md ++++ b/docs/sources/examples/hello_world.md +@@ -59,6 +59,8 @@ standard out. + + See the example in action + ++ ++ + ## Hello World Daemon + + Note +@@ -142,6 +144,8 @@ Make sure it is really stopped. + + See the example in action + ++ ++ + The next example in the series is a [*Node.js Web + App*](../nodejs_web_app/#nodejs-web-app) example, or you could skip to + any of the other examples: +diff --git a/docs/sources/use/workingwithrepository.md b/docs/sources/use/workingwithrepository.md +index 2122b8d..49edbc8 100644 +--- a/docs/sources/use/workingwithrepository.md ++++ b/docs/sources/use/workingwithrepository.md +@@ -199,6 +199,8 @@ searchable (or indexed at all) in the Central Index, and there will be + no user name checking performed. Your registry will function completely + independently from the Central Index. + ++ ++ + See also + + [Docker Blog: How to use your own diff --git a/docs/convert.sh b/docs/convert.sh new file mode 100755 index 0000000000..2316923f6d --- /dev/null +++ b/docs/convert.sh @@ -0,0 +1,53 @@ +#!/bin/sh + +cd / + +#run the sphinx build first +make -C /docs clean docs + +cd /docs + +#find sources -name '*.md*' -exec rm '{}' \; + +# convert from rst to md for mkdocs.org +# TODO: we're using a sphinx specific rst thing to do between docs links, which we then need to convert to mkdocs specific markup (and pandoc loses it when converting to html / md) +HTML_FILES=$(find _build -name '*.html' | sed 's/_build\/html\/\(.*\)\/index.html/\1/') + +for name in ${HTML_FILES} +do + echo $name + # lets not use gratuitious unicode quotes that cause terrible copy and paste issues + sed -i 's/“/"/g' _build/html/${name}/index.html + sed -i 's/”/"/g' _build/html/${name}/index.html + pandoc -f html -t markdown --atx-headers -o sources/${name}.md1 _build/html/${name}/index.html + + #add the meta-data from the rst + egrep ':(title|description|keywords):' sources/${name}.rst | sed 's/^:/page_/' > sources/${name}.md + echo >> sources/${name}.md + #cat sources/${name}.md1 >> sources/${name}.md + # remove the paragraph links from the source + cat sources/${name}.md1 | sed 's/\[..\](#.*)//' >> sources/${name}.md + + rm sources/${name}.md1 + + sed -i 's/{.docutils .literal}//g' sources/${name}.md + sed -i 's/{.docutils$//g' sources/${name}.md + sed -i 's/^.literal} //g' sources/${name}.md + sed -i 's/`{.descname}`//g' sources/${name}.md + sed -i 's/{.descname}//g' sources/${name}.md + sed -i 's/{.xref}//g' sources/${name}.md + sed -i 's/{.xref .doc .docutils .literal}//g' sources/${name}.md + sed -i 's/{.xref .http .http-post .docutils$//g' sources/${name}.md + sed -i 's/^ .literal}//g' sources/${name}.md + + sed -i 's/\\\$container\\_id/\$container_id/' sources/examples/hello_world.md + sed -i 's/\\\$TESTFLAGS/\$TESTFLAGS/' sources/contributing/devenvironment.md + sed -i 's/\\\$MYVAR1/\$MYVAR1/g' sources/reference/commandline/cli.md + + # git it all so we can test +# git add ${name}.md +done + +#annoyingly, there are lots of failures +patch --fuzz 50 -t -p2 < pr4923.patch || true +patch --fuzz 50 -t -p2 < asciinema.patch || true diff --git a/docs/convert_with_sphinx.patch b/docs/convert_with_sphinx.patch new file mode 100644 index 0000000000..995c9afeca --- /dev/null +++ b/docs/convert_with_sphinx.patch @@ -0,0 +1,197 @@ +diff --git a/docs/Dockerfile b/docs/Dockerfile +index bc2b73b..b9808b2 100644 +--- a/docs/Dockerfile ++++ b/docs/Dockerfile +@@ -4,14 +4,24 @@ MAINTAINER SvenDowideit@docker.com + # docker build -t docker:docs . && docker run -p 8000:8000 docker:docs + # + +-RUN apt-get update && apt-get install -yq make python-pip python-setuptools +- ++RUN apt-get update && apt-get install -yq make python-pip python-setuptools + RUN pip install mkdocs + ++RUN apt-get install -yq vim-tiny git pandoc ++ ++# pip installs from docs/requirements.txt, but here to increase cacheability ++RUN pip install Sphinx==1.2.1 ++RUN pip install sphinxcontrib-httpdomain==1.2.0 ++ + ADD . /docs ++ ++#build the sphinx html ++RUN make -C /docs clean docs ++ + WORKDIR /docs + +-CMD ["mkdocs", "serve"] ++#CMD ["mkdocs", "serve"] ++CMD bash + + # note, EXPOSE is only last because of https://github.com/dotcloud/docker/issues/3525 + EXPOSE 8000 +diff --git a/docs/theme/docker/layout.html b/docs/theme/docker/layout.html +index 7d78fb9..0dac9e0 100755 +--- a/docs/theme/docker/layout.html ++++ b/docs/theme/docker/layout.html +@@ -63,48 +63,6 @@ + + + +-
+-
+-
+-
+- +-
+- +-
+- +- +-
+-
+-
+- +-
+- +- +-
+- +-
+-
+-

DOCUMENTATION

+-
+- +- {{ toctree(collapse=False, maxdepth=3) }} +-
+- +-
+-
+-
+- + +
+ +@@ -114,111 +72,7 @@ + {% block body %}{% endblock %} + + +-
Edit this article on GitHub
+
+-
+-
+- +- +-
+- +- +- +- +- +- +- +- +- +- +- +- +- + + + diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml new file mode 100755 index 0000000000..38cec6ac14 --- /dev/null +++ b/docs/mkdocs.yml @@ -0,0 +1,126 @@ +site_name: Docker Documentation +#site_url: http://docs.docker.io/ +site_url: / +site_description: Documentation for fast and lightweight Docker container based virtualization framework. +site_favicon: img/favicon.png + +dev_addr: '0.0.0.0:8000' + +repo_url: https://github.com/dotcloud/docker/ + +docs_dir: sources + +include_search: true + +use_absolute_urls: true + +# theme: docker +theme_dir: ./theme/mkdocs/ +theme_center_lead: false +include_search: true + +copyright: Copyright © 2014, Docker, Inc. +google_analytics: ['UA-6096819-11', 'docker.io'] + +pages: + +# Introduction: +- ['index.md', 'About', 'Docker'] +- ['introduction/index.md', '**HIDDEN**'] +- ['introduction/understanding-docker.md', 'About', 'Understanding Docker'] +- ['introduction/technology.md', 'About', 'The Technology'] +- ['introduction/working-with-docker.md', 'About', 'Working with Docker'] +- ['introduction/get-docker.md', 'About', 'Get Docker'] + +# Installation: +- ['installation/index.md', '**HIDDEN**'] +- ['installation/mac.md', 'Installation', 'Mac OS X'] +- ['installation/ubuntulinux.md', 'Installation', 'Ubuntu'] +- ['installation/rhel.md', 'Installation', 'Red Hat Enterprise Linux'] +- ['installation/gentoolinux.md', 'Installation', 'Gentoo'] +- ['installation/google.md', 'Installation', 'Google Cloud Platform'] +- ['installation/rackspace.md', 'Installation', 'Rackspace Cloud'] +- ['installation/amazon.md', 'Installation', 'Amazon EC2'] +- ['installation/softlayer.md', 'Installation', 'IBM Softlayer'] +- ['installation/archlinux.md', 'Installation', 'Arch Linux'] +- ['installation/frugalware.md', 'Installation', 'FrugalWare'] +- ['installation/fedora.md', 'Installation', 'Fedora'] +- ['installation/openSUSE.md', 'Installation', 'openSUSE'] +- ['installation/cruxlinux.md', 'Installation', 'CRUX Linux'] +- ['installation/windows.md', 'Installation', 'Microsoft Windows'] +- ['installation/binaries.md', 'Installation', 'Binaries'] + +# Examples: +- ['use/index.md', '**HIDDEN**'] +- ['use/basics.md', 'Examples', 'First steps with Docker'] +- ['examples/index.md', '**HIDDEN**'] +- ['examples/hello_world.md', 'Examples', 'Hello World'] +- ['examples/nodejs_web_app.md', 'Examples', 'Node.js web application'] +- ['examples/python_web_app.md', 'Examples', 'Python web application'] +- ['examples/mongodb.md', 'Examples', 'MongoDB service'] +- ['examples/running_redis_service.md', 'Examples', 'Redis service'] +- ['examples/postgresql_service.md', 'Examples', 'PostgreSQL service'] +- ['examples/running_riak_service.md', 'Examples', 'Running a Riak service'] +- ['examples/running_ssh_service.md', 'Examples', 'Running an SSH service'] +- ['examples/couchdb_data_volumes.md', 'Examples', 'CouchDB service'] +- ['examples/apt-cacher-ng.md', 'Examples', 'Apt-Cacher-ng service'] +- ['examples/https.md', 'Examples', 'Running Docker with HTTPS'] +- ['examples/using_supervisord.md', 'Examples', 'Using Supervisor'] +- ['examples/cfengine_process_management.md', 'Examples', 'Process management with CFEngine'] +- ['use/working_with_links_names.md', 'Examples', 'Linking containers together'] +- ['use/working_with_volumes.md', 'Examples', 'Sharing Directories using volumes'] +- ['use/puppet.md', 'Examples', 'Using Puppet'] +- ['use/chef.md', 'Examples', 'Using Chef'] +- ['use/workingwithrepository.md', 'Examples', 'Working with a Docker Repository'] +- ['use/port_redirection.md', 'Examples', 'Redirect ports'] +- ['use/ambassador_pattern_linking.md', 'Examples', 'Cross-Host linking using Ambassador Containers'] +- ['use/host_integration.md', 'Examples', 'Automatically starting Containers'] + +#- ['user-guide/index.md', '**HIDDEN**'] +# - ['user-guide/writing-your-docs.md', 'User Guide', 'Writing your docs'] +# - ['user-guide/styling-your-docs.md', 'User Guide', 'Styling your docs'] +# - ['user-guide/configuration.md', 'User Guide', 'Configuration'] +# ./faq.md + +# Docker Index docs: +- ['index/index.md', '**HIDDEN**'] +# - ['index/home.md', 'Docker Index', 'Help'] +- ['index/accounts.md', 'Docker Index', 'Accounts'] +- ['index/repos.md', 'Docker Index', 'Repositories'] +- ['index/builds.md', 'Docker Index', 'Trusted Builds'] + +# Reference +- ['reference/index.md', '**HIDDEN**'] +- ['reference/commandline/cli.md', 'Reference', 'Command line'] +- ['reference/builder.md', 'Reference', 'Dockerfile'] +- ['reference/run.md', 'Reference', 'Run Reference'] +- ['articles/index.md', '**HIDDEN**'] +- ['articles/runmetrics.md', 'Reference', 'Runtime metrics'] +- ['articles/security.md', 'Reference', 'Security'] +- ['articles/baseimages.md', 'Reference', 'Creating a Base Image'] +- ['use/networking.md', 'Reference', 'Advanced networking'] +- ['reference/api/index_api.md', 'Reference', 'Docker Index API'] +- ['reference/api/registry_api.md', 'Reference', 'Docker Registry API'] +- ['reference/api/registry_index_spec.md', 'Reference', 'Registry & Index Spec'] +- ['reference/api/docker_remote_api.md', 'Reference', 'Docker Remote API'] +- ['reference/api/docker_remote_api_v1.10.md', 'Reference', 'Docker Remote API v1.10'] +- ['reference/api/docker_remote_api_v1.9.md', 'Reference', 'Docker Remote API v1.9'] +- ['reference/api/remote_api_client_libraries.md', 'Reference', 'Docker Remote API Client Libraries'] + +# Contribute: +- ['contributing/index.md', '**HIDDEN**'] +- ['contributing/contributing.md', 'Contribute', 'Contributing'] +- ['contributing/devenvironment.md', 'Contribute', 'Development environment'] +# - ['about/license.md', 'About', 'License'] + +- ['jsearch.md', '**HIDDEN**'] + +# - ['static_files/README.md', 'static_files', 'README'] +#- ['terms/index.md', '**HIDDEN**'] +# - ['terms/layer.md', 'terms', 'layer'] +# - ['terms/index.md', 'terms', 'Home'] +# - ['terms/registry.md', 'terms', 'registry'] +# - ['terms/container.md', 'terms', 'container'] +# - ['terms/repository.md', 'terms', 'repository'] +# - ['terms/filesystem.md', 'terms', 'filesystem'] +# - ['terms/image.md', 'terms', 'image'] diff --git a/docs/pr4923.patch b/docs/pr4923.patch new file mode 100644 index 0000000000..ef420520f7 --- /dev/null +++ b/docs/pr4923.patch @@ -0,0 +1,12836 @@ +diff --git a/docs/sources/articles.md b/docs/sources/articles.md +index da5a2d2..48654b0 100644 +--- a/docs/sources/articles.md ++++ b/docs/sources/articles.md +@@ -1,8 +1,7 @@ +-# Articles + +-## Contents: ++# Articles + +-- [Docker Security](security/) +-- [Create a Base Image](baseimages/) +-- [Runtime Metrics](runmetrics/) ++- [Docker Security](security/) ++- [Create a Base Image](baseimages/) ++- [Runtime Metrics](runmetrics/) + +diff --git a/docs/sources/articles/runmetrics.md b/docs/sources/articles/runmetrics.md +index 1a832d1..2372282 100644 +--- a/docs/sources/articles/runmetrics.md ++++ b/docs/sources/articles/runmetrics.md +@@ -56,7 +56,7 @@ ID or long ID of the container. If a container shows up as ae836c95b4c3 + in `docker ps`, its long ID might be something like + `ae836c95b4c3c9e9179e0e91015512da89fdec91612f63cebae57df9a5444c79`{.docutils + .literal}. You can look it up with `docker inspect` +-or `docker ps -notrunc`. ++or `docker ps --no-trunc`. + + Putting everything together to look at the memory metrics for a Docker + container, take a look at +diff --git a/docs/sources/articles/security.md b/docs/sources/articles/security.md +index 23d595f..13917f0 100644 +--- a/docs/sources/articles/security.md ++++ b/docs/sources/articles/security.md +@@ -5,7 +5,7 @@ page_keywords: Docker, Docker documentation, security + # Docker Security + + > *Adapted from* [Containers & Docker: How Secure are +-> They?](blogsecurity) ++> They?](http://blog.docker.io/2013/08/containers-docker-how-secure-are-they/) + + There are three major areas to consider when reviewing Docker security: + +@@ -255,4 +255,4 @@ with Docker, since everything is provided by the kernel anyway. + + For more context and especially for comparisons with VMs and other + container systems, please also see the [original blog +-post](blogsecurity). ++post](http://blog.docker.io/2013/08/containers-docker-how-secure-are-they/). +diff --git a/docs/sources/contributing.md b/docs/sources/contributing.md +index b311d13..0a31cb2 100644 +--- a/docs/sources/contributing.md ++++ b/docs/sources/contributing.md +@@ -1,7 +1,6 @@ +-# Contributing + +-## Contents: ++# Contributing + +-- [Contributing to Docker](contributing/) +-- [Setting Up a Dev Environment](devenvironment/) ++- [Contributing to Docker](contributing/) ++- [Setting Up a Dev Environment](devenvironment/) + +diff --git a/docs/sources/contributing/devenvironment.md b/docs/sources/contributing/devenvironment.md +index 3b77acf..76df680 100644 +--- a/docs/sources/contributing/devenvironment.md ++++ b/docs/sources/contributing/devenvironment.md +@@ -10,7 +10,7 @@ used for all tests, builds and releases. The standard development + environment defines all build dependencies: system libraries and + binaries, go environment, go dependencies, etc. + +-## Install Docker ++## Step 1: Install Docker + + Docker’s build environment itself is a Docker container, so the first + step is to install Docker on your system. +@@ -20,7 +20,7 @@ system](https://docs.docker.io/en/latest/installation/). Make sure you + have a working, up-to-date docker installation, then continue to the + next step. + +-## Install tools used for this tutorial ++## Step 2: Install tools used for this tutorial + + Install `git`; honest, it’s very good. You can use + other ways to get the Docker source, but they’re not anywhere near as +@@ -30,7 +30,7 @@ Install `make`. This tutorial uses our base Makefile + to kick off the docker containers in a repeatable and consistent way. + Again, you can do it in other ways but you need to do more work. + +-## Check out the Source ++## Step 3: Check out the Source + + git clone http://git@github.com/dotcloud/docker + cd docker +@@ -38,7 +38,7 @@ Again, you can do it in other ways but you need to do more work. + To checkout a different revision just use `git checkout`{.docutils + .literal} with the name of branch or revision number. + +-## Build the Environment ++## Step 4: Build the Environment + + This following command will build a development environment using the + Dockerfile in the current directory. Essentially, it will install all +@@ -50,7 +50,7 @@ This command will take some time to complete when you first execute it. + If the build is successful, congratulations! You have produced a clean + build of docker, neatly encapsulated in a standard build environment. + +-## Build the Docker Binary ++## Step 5: Build the Docker Binary + + To create the Docker binary, run this command: + +@@ -73,7 +73,7 @@ Note + Its safer to run the tests below before swapping your hosts docker + binary. + +-## Run the Tests ++## Step 5: Run the Tests + + To execute the test cases, run this command: + +@@ -114,7 +114,7 @@ eg. + + > TESTFLAGS=’-run \^TestBuild\$’ make test + +-## Use Docker ++## Step 6: Use Docker + + You can run an interactive session in the newly built container: + +@@ -122,7 +122,7 @@ You can run an interactive session in the newly built container: + + # type 'exit' or Ctrl-D to exit + +-## Build And View The Documentation ++## Extra Step: Build and view the Documentation + + If you want to read the documentation from a local website, or are + making changes to it, you can build the documentation and then serve it +diff --git a/docs/sources/examples.md b/docs/sources/examples.md +index 98b3d25..81ad1de 100644 +--- a/docs/sources/examples.md ++++ b/docs/sources/examples.md +@@ -1,25 +1,23 @@ + + # Examples + +-## Introduction: +- + 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 those which you might find in production. + +-## Contents: +- +-- [Check your Docker install](hello_world/) +-- [Hello World](hello_world/#hello-world) +-- [Hello World Daemon](hello_world/#hello-world-daemon) +-- [Node.js Web App](nodejs_web_app/) +-- [Redis Service](running_redis_service/) +-- [SSH Daemon Service](running_ssh_service/) +-- [CouchDB Service](couchdb_data_volumes/) +-- [PostgreSQL Service](postgresql_service/) +-- [Building an Image with MongoDB](mongodb/) +-- [Riak Service](running_riak_service/) +-- [Using Supervisor with Docker](using_supervisord/) +-- [Process Management with CFEngine](cfengine_process_management/) +-- [Python Web App](python_web_app/) ++- [Check your Docker install](hello_world/) ++- [Hello World](hello_world/#hello-world) ++- [Hello World Daemon](hello_world/#hello-world-daemon) ++- [Node.js Web App](nodejs_web_app/) ++- [Redis Service](running_redis_service/) ++- [SSH Daemon Service](running_ssh_service/) ++- [CouchDB Service](couchdb_data_volumes/) ++- [PostgreSQL Service](postgresql_service/) ++- [Building an Image with MongoDB](mongodb/) ++- [Riak Service](running_riak_service/) ++- [Using Supervisor with Docker](using_supervisord/) ++- [Process Management with CFEngine](cfengine_process_management/) ++- [Python Web App](python_web_app/) ++- [Apt-Cacher-ng Service](apt-cacher-ng/) ++- [Running Docker with https](https/) + +diff --git a/docs/sources/examples/couchdb_data_volumes.md b/docs/sources/examples/couchdb_data_volumes.md +index c4d478e..9665bb0 100644 +--- a/docs/sources/examples/couchdb_data_volumes.md ++++ b/docs/sources/examples/couchdb_data_volumes.md +@@ -11,6 +11,8 @@ Note + install*](../hello_world/#running-examples). + - **If you don’t like sudo** then see [*Giving non-root + access*](../../installation/binaries/#dockergroup) ++- **If you’re using OS X or docker via TCP** then you shouldn’t use ++ sudo + + Here’s an example of using data volumes to share the same data between + two CouchDB containers. This could be used for hot upgrades, testing +diff --git a/docs/sources/examples/hello_world.md b/docs/sources/examples/hello_world.md +index 8f2ae58..a9b0d7d 100644 +--- a/docs/sources/examples/hello_world.md ++++ b/docs/sources/examples/hello_world.md +@@ -2,7 +2,7 @@ page_title: Hello world example + page_description: A simple hello world example with Docker + page_keywords: docker, example, hello world + +-# Check your Docker installation ++# Check your Docker install + + This guide assumes you have a working installation of Docker. To check + your Docker install, run the following command: +@@ -18,7 +18,7 @@ privileges to access docker on your machine. + Please refer to [*Installation*](../../installation/#installation-list) + for installation instructions. + +-## Hello World ++# Hello World + + Note + +@@ -27,6 +27,8 @@ Note + install*](#running-examples). + - **If you don’t like sudo** then see [*Giving non-root + access*](../../installation/binaries/#dockergroup) ++- **If you’re using OS X or docker via TCP** then you shouldn’t use ++ sudo + + This is the most basic example available for using Docker. + +@@ -59,7 +61,9 @@ standard out. + + See the example in action + +-## Hello World Daemon ++* * * * * ++ ++# Hello World Daemon + + Note + +@@ -68,6 +72,8 @@ Note + install*](#running-examples). + - **If you don’t like sudo** then see [*Giving non-root + access*](../../installation/binaries/#dockergroup) ++- **If you’re using OS X or docker via TCP** then you shouldn’t use ++ sudo + + And now for the most boring daemon ever written! + +@@ -77,7 +83,7 @@ continue to do this until we stop it. + + **Steps:** + +- CONTAINER_ID=$(sudo docker run -d ubuntu /bin/sh -c "while true; do echo hello world; sleep 1; done") ++ 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. +@@ -89,31 +95,31 @@ from the `ubuntu` image. + - **“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** 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. + + + +- sudo docker logs $CONTAINER_ID ++ 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. ++- **\$container\_id** The Id of the container we want the logs for. + + + +- sudo docker attach -sig-proxy=false $CONTAINER_ID ++ sudo docker attach --sig-proxy=false $container_id + + Attach to the container to see the results in real-time. + + - **“docker attach**” This will allow us to attach to a background + process to see what is going on. +-- **“-sig-proxy=false”** Do not forward signals to the container; ++- **“–sig-proxy=false”** Do not forward signals to the container; + allows us to exit the attachment using Control-C without stopping + the container. +-- **\$CONTAINER\_ID** The Id of the container we want to attach too. ++- **\$container\_id** The Id of the container we want to attach too. + + Exit from the container attachment by pressing Control-C. + +@@ -125,12 +131,12 @@ Check the process list to make sure it is running. + + + +- sudo docker stop $CONTAINER_ID ++ 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. ++- **\$container\_id** The Id of the container we want to stop. + + + +diff --git a/docs/sources/examples/mongodb.md b/docs/sources/examples/mongodb.md +index 6612bf3..3708c18 100644 +--- a/docs/sources/examples/mongodb.md ++++ b/docs/sources/examples/mongodb.md +@@ -11,6 +11,8 @@ Note + install*](../hello_world/#running-examples). + - **If you don’t like sudo** then see [*Giving non-root + access*](../../installation/binaries/#dockergroup) ++- **If you’re using OS X or docker via TCP** then you shouldn’t use ++ sudo + + The goal of this example is to show how you can build your own Docker + images with MongoDB pre-installed. We will do that by constructing a +@@ -43,7 +45,7 @@ we’ll divert `/sbin/initctl` to + + # Hack for initctl not being available in Ubuntu + RUN dpkg-divert --local --rename --add /sbin/initctl +- RUN ln -s /bin/true /sbin/initctl ++ RUN ln -sf /bin/true /sbin/initctl + + Afterwards we’ll be able to update our apt repositories and install + MongoDB +@@ -75,10 +77,10 @@ Now you should be able to run `mongod` as a daemon + and be able to connect on the local port! + + # Regular style +- MONGO_ID=$(sudo docker run -d /mongodb) ++ MONGO_ID=$(sudo docker run -P -d /mongodb) + + # Lean and mean +- MONGO_ID=$(sudo docker run -d /mongodb --noprealloc --smallfiles) ++ MONGO_ID=$(sudo docker run -P -d /mongodb --noprealloc --smallfiles) + + # Check the logs out + sudo docker logs $MONGO_ID +diff --git a/docs/sources/examples/nodejs_web_app.md b/docs/sources/examples/nodejs_web_app.md +index 8d692d8..59e6c77 100644 +--- a/docs/sources/examples/nodejs_web_app.md ++++ b/docs/sources/examples/nodejs_web_app.md +@@ -11,6 +11,8 @@ Note + install*](../hello_world/#running-examples). + - **If you don’t like sudo** then see [*Giving non-root + access*](../../installation/binaries/#dockergroup) ++- **If you’re using OS X or docker via TCP** then you shouldn’t use ++ sudo + + The goal of this example is to show you how you can build your own + Docker images from a parent image using a `Dockerfile`{.docutils +@@ -82,7 +84,7 @@ CentOS, we’ll use the instructions from the [Node.js + wiki](https://github.com/joyent/node/wiki/Installing-Node.js-via-package-manager#rhelcentosscientific-linux-6): + + # Enable EPEL for Node.js +- RUN rpm -Uvh http://download.fedoraproject.org/pub/epel/6/i386/epel-release-6-8.noarch.rpm ++ RUN rpm -Uvh http://dl.fedoraproject.org/pub/epel/6/i386/epel-release-6-8.noarch.rpm + # Install Node.js and npm + RUN yum install -y npm + +diff --git a/docs/sources/examples/postgresql_service.md b/docs/sources/examples/postgresql_service.md +index 211dcb2..b87d121 100644 +--- a/docs/sources/examples/postgresql_service.md ++++ b/docs/sources/examples/postgresql_service.md +@@ -11,6 +11,8 @@ Note + install*](../hello_world/#running-examples). + - **If you don’t like sudo** then see [*Giving non-root + access*](../../installation/binaries/#dockergroup) ++- **If you’re using OS X or docker via TCP** then you shouldn’t use ++ sudo + + ## Installing PostgreSQL on Docker + +@@ -34,7 +36,7 @@ suitably secure. + + # Add the PostgreSQL PGP key to verify their Debian packages. + # It should be the same key as https://www.postgresql.org/media/keys/ACCC4CF8.asc +- RUN apt-key adv --keyserver keyserver.ubuntu.com --recv-keys B97B0AFCAA1A47F044F244A07FCC7D46ACCC4CF8 ++ RUN apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys B97B0AFCAA1A47F044F244A07FCC7D46ACCC4CF8 + + # Add PostgreSQL's repository. It contains the most recent stable release + # of PostgreSQL, ``9.3``. +@@ -85,7 +87,7 @@ Build an image from the Dockerfile assign it a name. + + And run the PostgreSQL server container (in the foreground): + +- $ sudo docker run -rm -P -name pg_test eg_postgresql ++ $ sudo docker run --rm -P --name pg_test eg_postgresql + + There are 2 ways to connect to the PostgreSQL server. We can use [*Link + Containers*](../../use/working_with_links_names/#working-with-links-names), +@@ -93,17 +95,17 @@ or we can access it from our host (or the network). + + Note + +-The `-rm` removes the container and its image when ++The `--rm` removes the container and its image when + the container exists successfully. + + ### Using container linking + + Containers can be linked to another container’s ports directly using +-`-link remote_name:local_alias` in the client’s ++`--link remote_name:local_alias` in the client’s + `docker run`. This will set a number of environment + variables that can then be used to connect: + +- $ sudo docker run -rm -t -i -link pg_test:pg eg_postgresql bash ++ $ sudo docker run --rm -t -i --link pg_test:pg eg_postgresql bash + + postgres@7ef98b1b7243:/$ psql -h $PG_PORT_5432_TCP_ADDR -p $PG_PORT_5432_TCP_PORT -d docker -U docker --password + +@@ -145,7 +147,7 @@ prompt, you can create a table and populate it. + You can use the defined volumes to inspect the PostgreSQL log files and + to backup your configuration and data: + +- docker run -rm --volumes-from pg_test -t -i busybox sh ++ docker run --rm --volumes-from pg_test -t -i busybox sh + + / # ls + bin etc lib linuxrc mnt proc run sys usr +diff --git a/docs/sources/examples/python_web_app.md b/docs/sources/examples/python_web_app.md +index b5854a4..8c0d783 100644 +--- a/docs/sources/examples/python_web_app.md ++++ b/docs/sources/examples/python_web_app.md +@@ -11,6 +11,8 @@ Note + install*](../hello_world/#running-examples). + - **If you don’t like sudo** then see [*Giving non-root + access*](../../installation/binaries/#dockergroup) ++- **If you’re using OS X or docker via TCP** then you shouldn’t use ++ sudo + + While using Dockerfiles is the preferred way to create maintainable and + repeatable images, its useful to know how you can try things out and +@@ -52,7 +54,7 @@ the `$URL` variable. The container is given a name + While this example is simple, you could run any number of interactive + commands, try things out, and then exit when you’re done. + +- $ sudo docker run -i -t -name pybuilder_run shykes/pybuilder bash ++ $ sudo docker run -i -t --name pybuilder_run shykes/pybuilder bash + + $$ URL=http://github.com/shykes/helloflask/archive/master.tar.gz + $$ /usr/local/bin/buildapp $URL +diff --git a/docs/sources/examples/running_redis_service.md b/docs/sources/examples/running_redis_service.md +index 81114e6..c0511a9 100644 +--- a/docs/sources/examples/running_redis_service.md ++++ b/docs/sources/examples/running_redis_service.md +@@ -11,6 +11,8 @@ Note + install*](../hello_world/#running-examples). + - **If you don’t like sudo** then see [*Giving non-root + access*](../../installation/binaries/#dockergroup) ++- **If you’re using OS X or docker via TCP** then you shouldn’t use ++ sudo + + Very simple, no frills, Redis service attached to a web application + using a link. +@@ -20,11 +22,11 @@ using a link. + Firstly, we create a `Dockerfile` for our new Redis + image. + +- FROM ubuntu:12.10 +- RUN apt-get update +- RUN apt-get -y install redis-server ++ FROM debian:jessie ++ RUN apt-get update && apt-get install -y redis-server + EXPOSE 6379 + ENTRYPOINT ["/usr/bin/redis-server"] ++ CMD ["--bind", "0.0.0.0"] + + Next we build an image from our `Dockerfile`. + Replace `` with your own user name. +@@ -48,7 +50,7 @@ database. + ## Create your web application container + + Next we can create a container for our application. We’re going to use +-the `-link` flag to create a link to the ++the `--link` flag to create a link to the + `redis` container we’ve just created with an alias + of `db`. This will create a secure tunnel to the + `redis` container and expose the Redis instance +diff --git a/docs/sources/examples/running_riak_service.md b/docs/sources/examples/running_riak_service.md +index e7171d8..c1b95e7 100644 +--- a/docs/sources/examples/running_riak_service.md ++++ b/docs/sources/examples/running_riak_service.md +@@ -11,6 +11,8 @@ Note + install*](../hello_world/#running-examples). + - **If you don’t like sudo** then see [*Giving non-root + access*](../../installation/binaries/#dockergroup) ++- **If you’re using OS X or docker via TCP** then you shouldn’t use ++ sudo + + The goal of this example is to show you how to build a Docker image with + Riak pre-installed. +@@ -85,7 +87,7 @@ Almost there. Next, we add a hack to get us by the lack of + # Hack for initctl + # See: https://github.com/dotcloud/docker/issues/1024 + RUN dpkg-divert --local --rename --add /sbin/initctl +- RUN ln -s /bin/true /sbin/initctl ++ RUN ln -sf /bin/true /sbin/initctl + + Then, we expose the Riak Protocol Buffers and HTTP interfaces, along + with SSH: +diff --git a/docs/sources/examples/running_ssh_service.md b/docs/sources/examples/running_ssh_service.md +index 112b9fa..2a0acfa 100644 +--- a/docs/sources/examples/running_ssh_service.md ++++ b/docs/sources/examples/running_ssh_service.md +@@ -4,12 +4,15 @@ page_keywords: docker, example, package installation, networking + + # SSH Daemon Service + +-> **Note:** +-> - This example assumes you have Docker running in daemon mode. For +-> more information please see [*Check your Docker +-> install*](../hello_world/#running-examples). +-> - **If you don’t like sudo** then see [*Giving non-root +-> access*](../../installation/binaries/#dockergroup) ++Note ++ ++- This example assumes you have Docker running in daemon mode. For ++ more information please see [*Check your Docker ++ install*](../hello_world/#running-examples). ++- **If you don’t like sudo** then see [*Giving non-root ++ access*](../../installation/binaries/#dockergroup) ++- **If you’re using OS X or docker via TCP** then you shouldn’t use ++ sudo + + The following Dockerfile sets up an sshd service in a container that you + can use to connect to and inspect other container’s volumes, or to get +@@ -35,12 +38,12 @@ quick access to a test container. + + Build the image using: + +- $ sudo docker build -rm -t eg_sshd . ++ $ sudo docker build -t eg_sshd . + + Then run it. You can then use `docker port` to find + out what host port the container’s port 22 is mapped to: + +- $ sudo docker run -d -P -name test_sshd eg_sshd ++ $ sudo docker run -d -P --name test_sshd eg_sshd + $ sudo docker port test_sshd 22 + 0.0.0.0:49154 + +diff --git a/docs/sources/examples/using_supervisord.md b/docs/sources/examples/using_supervisord.md +index d64b300..8d6e796 100644 +--- a/docs/sources/examples/using_supervisord.md ++++ b/docs/sources/examples/using_supervisord.md +@@ -11,6 +11,8 @@ Note + install*](../hello_world/#running-examples). + - **If you don’t like sudo** then see [*Giving non-root + access*](../../installation/binaries/#dockergroup) ++- **If you’re using OS X or docker via TCP** then you shouldn’t use ++ sudo + + Traditionally a Docker container runs a single process when it is + launched, for example an Apache daemon or a SSH server daemon. Often +diff --git a/docs/sources/faq.md b/docs/sources/faq.md +index 06da238..4977f73 100644 +--- a/docs/sources/faq.md ++++ b/docs/sources/faq.md +@@ -1,122 +1,128 @@ ++page_title: FAQ ++page_description: Most frequently asked questions. ++page_keywords: faq, questions, documentation, docker ++ + # FAQ + + ## Most frequently asked questions. + + ### 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. + + ### What open source license are you using? + +-We are using the Apache License Version 2.0. +-You can 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](https://github.com/dotcloud/docker/blob/master/LICENSE) + + ### 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 [*Mac OSX*](../installation/mac/#macosx) and +-[*Windows*](../installation/windows/#windows) installation guides. The +-small Linux distribution *boot2docker* can be run inside virtual +-machines on these two operating systems. ++> 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 [*Mac OS ++> X*](../installation/mac/#macosx) and [*Microsoft ++> Windows*](../installation/windows/#windows) installation guides. The ++> small Linux distribution boot2docker can be run inside virtual ++> machines on these two operating systems. + + ### 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. + + ### What does Docker add to just plain LXC? + +-Docker is not a replacement for LXC. “LXC” refers to capabilities of +-the Linux kernel (specifically namespaces and control groups) which +-allow sandboxing processes from one another, and controlling their +-resource allocations. On top of this low-level foundation of kernel +-features, Docker offers a high-level tool with several powerful +-functionalities: +- +- - **Portable deployment across machines:** +- Docker defines a format for bundling an application and all +- its dependencies into a single object which can be transferred +- to any Docker-enabled machine, and executed there with the +- guarantee that the execution environment exposed to the +- application will be the same. LXC implements process +- sandboxing, which is an important pre-requisite for portable +- deployment, but that alone is not enough for portable +- deployment. If you sent me a copy of your application +- installed in a custom LXC configuration, it would almost +- certainly not run on my machine the way it does on yours, +- because it is tied to your machine’s specific configuration: +- networking, storage, logging, distro, etc. Docker defines an +- abstraction for these machine-specific settings, so that the +- exact same Docker container can run - unchanged - on many +- different machines, with many different configurations. +- +- - **Application-centric:** +- Docker is optimized for the deployment of applications, as +- opposed to machines. This is reflected in its API, user +- interface, design philosophy and documentation. By contrast, +- the `lxc` helper scripts focus on +- containers as lightweight machines - basically servers that +- boot faster and need less RAM. We think there’s more to +- containers than just that. +- +- - **Automatic build:** +- Docker includes [*a tool for developers to automatically +- assemble a container from their source +- code*](../reference/builder/#dockerbuilder), with full control +- over application dependencies, build tools, packaging etc. +- They are free to use +- `make, maven, chef, puppet, salt,` Debian +- packages, RPMs, source tarballs, or any combination of the +- above, regardless of the configuration of the machines. +- +- - **Versioning:** +- Docker includes git-like capabilities for tracking successive +- versions of a container, inspecting the diff between versions, +- committing new versions, rolling back etc. The history also +- includes how a container was assembled and by whom, so you get +- full traceability from the production server all the way back +- to the upstream developer. Docker also implements incremental +- uploads and downloads, similar to `git pull`{.docutils +- .literal}, so new versions of a container can be transferred +- by only sending diffs. +- +- - **Component re-use:** +- Any container can be used as a [*“base +- image”*](../terms/image/#base-image-def) to create more +- specialized components. This can be done manually or as part +- of an automated build. For example you can prepare the ideal +- Python environment, and use it as a base for 10 different +- applications. Your ideal Postgresql setup can be re-used for +- all your future projects. And so on. +- +- - **Sharing:** +- Docker has access to a [public registry](http://index.docker.io) +- where thousands of people have uploaded useful containers: anything +- from Redis, CouchDB, Postgres to IRC bouncers to Rails app servers to +- Hadoop to base images for various Linux distros. The +- [*registry*](../reference/api/registry_index_spec/#registryindexspec) +- also includes an official “standard library” of useful +- containers maintained by the Docker team. The registry itself +- is open-source, so anyone can deploy their own registry to +- store and transfer private containers, for internal server +- deployments for example. +- +- - **Tool ecosystem:** +- Docker defines an API for automating and customizing the +- creation and deployment of containers. There are a huge number +- of tools integrating with Docker to extend its capabilities. +- PaaS-like deployment (Dokku, Deis, Flynn), multi-node +- orchestration (Maestro, Salt, Mesos, Openstack Nova), +- management dashboards (docker-ui, Openstack Horizon, +- Shipyard), configuration management (Chef, Puppet), continuous +- integration (Jenkins, Strider, Travis), etc. Docker is rapidly +- establishing itself as the standard for container-based +- tooling. +- ++> Docker is not a replacement for LXC. “LXC” refers to capabilities of ++> the Linux kernel (specifically namespaces and control groups) which ++> allow sandboxing processes from one another, and controlling their ++> resource allocations. On top of this low-level foundation of kernel ++> features, Docker offers a high-level tool with several powerful ++> functionalities: ++> ++> - *Portable deployment across machines.* ++> : Docker defines a format for bundling an application and all ++> its dependencies into a single object which can be transferred ++> to any Docker-enabled machine, and executed there with the ++> guarantee that the execution environment exposed to the ++> application will be the same. LXC implements process ++> sandboxing, which is an important pre-requisite for portable ++> deployment, but that alone is not enough for portable ++> deployment. If you sent me a copy of your application ++> installed in a custom LXC configuration, it would almost ++> certainly not run on my machine the way it does on yours, ++> because it is tied to your machine’s specific configuration: ++> networking, storage, logging, distro, etc. Docker defines an ++> abstraction for these machine-specific settings, so that the ++> exact same Docker container can run - unchanged - on many ++> different machines, with many different configurations. ++> ++> - *Application-centric.* ++> : Docker is optimized for the deployment of applications, as ++> opposed to machines. This is reflected in its API, user ++> interface, design philosophy and documentation. By contrast, ++> the `lxc` helper scripts focus on ++> containers as lightweight machines - basically servers that ++> boot faster and need less RAM. We think there’s more to ++> containers than just that. ++> ++> - *Automatic build.* ++> : Docker includes [*a tool for developers to automatically ++> assemble a container from their source ++> code*](../reference/builder/#dockerbuilder), with full control ++> over application dependencies, build tools, packaging etc. ++> They are free to use ++> `make, maven, chef, puppet, salt,` Debian ++> packages, RPMs, source tarballs, or any combination of the ++> above, regardless of the configuration of the machines. ++> ++> - *Versioning.* ++> : Docker includes git-like capabilities for tracking successive ++> versions of a container, inspecting the diff between versions, ++> committing new versions, rolling back etc. The history also ++> includes how a container was assembled and by whom, so you get ++> full traceability from the production server all the way back ++> to the upstream developer. Docker also implements incremental ++> uploads and downloads, similar to `git pull`{.docutils ++> .literal}, so new versions of a container can be transferred ++> by only sending diffs. ++> ++> - *Component re-use.* ++> : Any container can be used as a [*“base ++> image”*](../terms/image/#base-image-def) to create more ++> specialized components. This can be done manually or as part ++> of an automated build. For example you can prepare the ideal ++> Python environment, and use it as a base for 10 different ++> applications. Your ideal Postgresql setup can be re-used for ++> all your future projects. And so on. ++> ++> - *Sharing.* ++> : Docker has access to a [public ++> registry](http://index.docker.io) where thousands of people ++> have uploaded useful containers: anything from Redis, CouchDB, ++> Postgres to IRC bouncers to Rails app servers to Hadoop to ++> base images for various Linux distros. The ++> [*registry*](../reference/api/registry_index_spec/#registryindexspec) ++> also includes an official “standard library” of useful ++> containers maintained by the Docker team. The registry itself ++> is open-source, so anyone can deploy their own registry to ++> store and transfer private containers, for internal server ++> deployments for example. ++> ++> - *Tool ecosystem.* ++> : Docker defines an API for automating and customizing the ++> creation and deployment of containers. There are a huge number ++> of tools integrating with Docker to extend its capabilities. ++> PaaS-like deployment (Dokku, Deis, Flynn), multi-node ++> orchestration (Maestro, Salt, Mesos, Openstack Nova), ++> management dashboards (docker-ui, Openstack Horizon, ++> Shipyard), configuration management (Chef, Puppet), continuous ++> integration (Jenkins, Strider, Travis), etc. Docker is rapidly ++> establishing itself as the standard for container-based ++> tooling. ++> + ### What is different between a Docker container and a VM? + + There’s a great StackOverflow answer [showing the +@@ -159,22 +165,22 @@ here](http://docs.docker.io/en/latest/examples/using_supervisord/). + + ### What platforms does Docker run on? + +-**Linux:** ++Linux: + +-- Ubuntu 12.04, 13.04 et al +-- Fedora 19/20+ +-- RHEL 6.5+ +-- Centos 6+ +-- Gentoo +-- ArchLinux +-- openSUSE 12.3+ +-- CRUX 3.0+ ++- Ubuntu 12.04, 13.04 et al ++- Fedora 19/20+ ++- RHEL 6.5+ ++- Centos 6+ ++- Gentoo ++- ArchLinux ++- openSUSE 12.3+ ++- CRUX 3.0+ + +-**Cloud:** ++Cloud: + +-- Amazon EC2 +-- Google Compute Engine +-- Rackspace ++- Amazon EC2 ++- Google Compute Engine ++- Rackspace + + ### How do I report a security issue with Docker? + +@@ -196,14 +202,17 @@ sources. + + ### Where can I find more answers? + +-You can find more answers on: +- +-- [Docker user mailinglist](https://groups.google.com/d/forum/docker-user) +-- [Docker developer mailinglist](https://groups.google.com/d/forum/docker-dev) +-- [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/docker) ++> You can find more answers on: ++> ++> - [Docker user ++> mailinglist](https://groups.google.com/d/forum/docker-user) ++> - [Docker developer ++> mailinglist](https://groups.google.com/d/forum/docker-dev) ++> - [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/docker) + + Looking for something else to read? Checkout the [*Hello + World*](../examples/hello_world/#hello-world) example. +diff --git a/docs/sources/genindex.md b/docs/sources/genindex.md +index 8b013d6..e9bcd34 100644 +--- a/docs/sources/genindex.md ++++ b/docs/sources/genindex.md +@@ -1 +1,2 @@ ++ + # Index +diff --git a/docs/sources/http-routingtable.md b/docs/sources/http-routingtable.md +index 2a06fdb..4ca4116 100644 +--- a/docs/sources/http-routingtable.md ++++ b/docs/sources/http-routingtable.md +@@ -1,3 +1,4 @@ ++ + # HTTP Routing Table + + [**/api**](#cap-/api) | [**/auth**](#cap-/auth) | +diff --git a/docs/sources/index.md b/docs/sources/index.md +index c5a5b6f..dd9e272 100644 +--- a/docs/sources/index.md ++++ b/docs/sources/index.md +@@ -1,3 +1 @@ +-# Docker Documentation +- +-## Introduction +\ No newline at end of file ++# Docker documentation +diff --git a/docs/sources/installation.md b/docs/sources/installation.md +index 0ee7b2f..4fdd102 100644 +--- a/docs/sources/installation.md ++++ b/docs/sources/installation.md +@@ -1,25 +1,26 @@ +-# Installation + +-## Introduction ++# Installation + + There are a number of ways to install Docker, depending on where you + want to run the daemon. The [*Ubuntu*](ubuntulinux/#ubuntu-linux) + installation is the officially-tested version. The community adds more + techniques for installing Docker all the time. + +-## Contents: ++Contents: ++ ++- [Ubuntu](ubuntulinux/) ++- [Red Hat Enterprise Linux](rhel/) ++- [Fedora](fedora/) ++- [Arch Linux](archlinux/) ++- [CRUX Linux](cruxlinux/) ++- [Gentoo](gentoolinux/) ++- [openSUSE](openSUSE/) ++- [FrugalWare](frugalware/) ++- [Mac OS X](mac/) ++- [Microsoft Windows](windows/) ++- [Amazon EC2](amazon/) ++- [Rackspace Cloud](rackspace/) ++- [Google Cloud Platform](google/) ++- [IBM SoftLayer](softlayer/) ++- [Binaries](binaries/) + +-- [Ubuntu](ubuntulinux/) +-- [Red Hat Enterprise Linux](rhel/) +-- [Fedora](fedora/) +-- [Arch Linux](archlinux/) +-- [CRUX Linux](cruxlinux/) +-- [Gentoo](gentoolinux/) +-- [openSUSE](openSUSE/) +-- [FrugalWare](frugalware/) +-- [Mac OS X](mac/) +-- [Windows](windows/) +-- [Amazon EC2](amazon/) +-- [Rackspace Cloud](rackspace/) +-- [Google Cloud Platform](google/) +-- [Binaries](binaries/) +\ No newline at end of file +diff --git a/docs/sources/installation/binaries.md b/docs/sources/installation/binaries.md +index 5d761de..0aa22ca 100644 +--- a/docs/sources/installation/binaries.md ++++ b/docs/sources/installation/binaries.md +@@ -23,14 +23,15 @@ packages for many distributions, and more keep showing up all the time! + To run properly, docker needs the following software to be installed at + runtime: + +-- iproute2 version 3.5 or later (build after 2012-05-21), and +- specifically the “ip” utility + - iptables version 1.4 or later +-- The LXC utility scripts +- ([http://lxc.sourceforge.net](http://lxc.sourceforge.net)) version +- 0.8 or later + - Git version 1.7 or later + - XZ Utils 4.9 or later ++- a [properly ++ mounted](https://github.com/tianon/cgroupfs-mount/blob/master/cgroupfs-mount) ++ cgroupfs hierarchy (having a single, all-encompassing “cgroup” mount ++ point [is](https://github.com/dotcloud/docker/issues/2683) ++ [not](https://github.com/dotcloud/docker/issues/3485) ++ [sufficient](https://github.com/dotcloud/docker/issues/4568)) + + ## Check kernel dependencies + +@@ -38,7 +39,7 @@ Docker in daemon mode has specific kernel requirements. For details, + check your distribution in [*Installation*](../#installation-list). + + Note that Docker also has a client mode, which can run on virtually any +-linux kernel (it even builds on OSX!). ++Linux kernel (it even builds on OSX!). + + ## Get the docker binary: + +@@ -69,7 +70,9 @@ all the client commands. + + Warning + +-The *docker* group is root-equivalent. ++The *docker* group (or the group specified with `-G`{.docutils ++.literal}) is root-equivalent; see [*Docker Daemon Attack ++Surface*](../../articles/security/#dockersecurity-daemon) details. + + ## Upgrades + +diff --git a/docs/sources/installation/fedora.md b/docs/sources/installation/fedora.md +index 545e523..32f4fd2 100644 +--- a/docs/sources/installation/fedora.md ++++ b/docs/sources/installation/fedora.md +@@ -31,13 +31,14 @@ installed already, it will conflict with `docker-io`{.docutils + .literal}. There’s a [bug + report](https://bugzilla.redhat.com/show_bug.cgi?id=1043676) filed for + it. To proceed with `docker-io` installation on +-Fedora 19, please remove `docker` first. ++Fedora 19 or Fedora 20, please remove `docker` ++first. + + sudo yum -y remove docker + +-For Fedora 20 and later, the `wmdocker` package will +-provide the same functionality as `docker` and will +-also not conflict with `docker-io`. ++For Fedora 21 and later, the `wmdocker` package will ++provide the same functionality as the old `docker` ++and will also not conflict with `docker-io`. + + sudo yum -y install wmdocker + sudo yum -y remove docker +diff --git a/docs/sources/installation/ubuntulinux.md b/docs/sources/installation/ubuntulinux.md +index 8c83e87..b6e9889 100644 +--- a/docs/sources/installation/ubuntulinux.md ++++ b/docs/sources/installation/ubuntulinux.md +@@ -56,13 +56,13 @@ These instructions have changed for 0.6. If you are upgrading from an + earlier version, you will need to follow them again. + + Docker is available as a Debian package, which makes installation easy. +-**See the :ref:\`installmirrors\` section below if you are not in the +-United States.** Other sources of the Debian packages may be faster for +-you to install. ++**See the** [*Docker and local DNS server warnings*](#installmirrors) ++**section below if you are not in the United States.** Other sources of ++the Debian packages may be faster for you to install. + + First add the Docker repository key to your local keychain. + +- sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 36A1D7869245C8950F966E92D8576A8BA88D21E9 ++ sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys 36A1D7869245C8950F966E92D8576A8BA88D21E9 + + Add the Docker repository to your apt sources list, update and install + the `lxc-docker` package. +@@ -121,7 +121,7 @@ upgrading from an earlier version, you will need to follow them again. + + First add the Docker repository key to your local keychain. + +- sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 36A1D7869245C8950F966E92D8576A8BA88D21E9 ++ sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys 36A1D7869245C8950F966E92D8576A8BA88D21E9 + + Add the Docker repository to your apt sources list, update and install + the `lxc-docker` package. +@@ -156,11 +156,15 @@ socket read/writable by the *docker* group when the daemon starts. The + `docker` daemon must always run as the root user, + but if you run the `docker` client as a user in the + *docker* group then you don’t need to add `sudo` to +-all the client commands. ++all the client commands. As of 0.9.0, you can specify that a group other ++than `docker` should own the Unix socket with the ++`-G` option. + + Warning + +-The *docker* group is root-equivalent. ++The *docker* group (or the group specified with `-G`{.docutils ++.literal}) is root-equivalent; see [*Docker Daemon Attack ++Surface*](../../articles/security/#dockersecurity-daemon) details. + + **Example:** + +@@ -259,9 +263,9 @@ Docker daemon for the containers: + sudo nano /etc/default/docker + --- + # Add: +- DOCKER_OPTS="-dns 8.8.8.8" ++ DOCKER_OPTS="--dns 8.8.8.8" + # 8.8.8.8 could be replaced with a local DNS server, such as 192.168.1.1 +- # multiple DNS servers can be specified: -dns 8.8.8.8 -dns 192.168.1.1 ++ # multiple DNS servers can be specified: --dns 8.8.8.8 --dns 192.168.1.1 + + The Docker daemon has to be restarted: + +diff --git a/docs/sources/installation/windows.md b/docs/sources/installation/windows.md +index ec3e706..ad367d9 100644 +--- a/docs/sources/installation/windows.md ++++ b/docs/sources/installation/windows.md +@@ -2,7 +2,7 @@ page_title: Installation on Windows + page_description: Please note this project is currently under heavy development. It should not be used in production. + page_keywords: Docker, Docker documentation, Windows, requirements, virtualbox, boot2docker + +-# Windows ++# Microsoft Windows + + Docker can run on Windows using a virtualization platform like + VirtualBox. A Linux distribution is run inside a virtual machine and +@@ -17,7 +17,7 @@ production yet, but we’re getting closer with each release. Please see + our blog post, [“Getting to Docker + 1.0”](http://blog.docker.io/2013/08/getting-to-docker-1-0/) + +-1. Install virtualbox from ++1. Install VirtualBox from + [https://www.virtualbox.org](https://www.virtualbox.org) - or follow + this + [tutorial](http://www.slideshare.net/julienbarbier42/install-virtualbox-on-windows-7). +diff --git a/docs/sources/reference.md b/docs/sources/reference.md +index 3cd720c..1c4022e 100644 +--- a/docs/sources/reference.md ++++ b/docs/sources/reference.md +@@ -1,9 +1,10 @@ ++ + # Reference Manual + +-## Contents: ++Contents: + +-- [Commands](commandline/) +-- [Dockerfile Reference](builder/) +-- [Docker Run Reference](run/) +-- [APIs](api/) ++- [Commands](commandline/) ++- [Dockerfile Reference](builder/) ++- [Docker Run Reference](run/) ++- [APIs](api/) + +diff --git a/docs/sources/reference/api.md b/docs/sources/reference/api.md +index ae55e6a..ce571bc 100644 +--- a/docs/sources/reference/api.md ++++ b/docs/sources/reference/api.md +@@ -1,3 +1,4 @@ ++ + # APIs + + Your programs and scripts can access Docker’s functionality via these +@@ -8,34 +9,28 @@ interfaces: + - [1.1 Index](registry_index_spec/#index) + - [1.2 Registry](registry_index_spec/#registry) + - [1.3 Docker](registry_index_spec/#docker) +- + - [2. Workflow](registry_index_spec/#workflow) + - [2.1 Pull](registry_index_spec/#pull) + - [2.2 Push](registry_index_spec/#push) + - [2.3 Delete](registry_index_spec/#delete) +- + - [3. How to use the Registry in standalone + mode](registry_index_spec/#how-to-use-the-registry-in-standalone-mode) + - [3.1 Without an + Index](registry_index_spec/#without-an-index) + - [3.2 With an Index](registry_index_spec/#with-an-index) +- + - [4. The API](registry_index_spec/#the-api) + - [4.1 Images](registry_index_spec/#images) + - [4.2 Users](registry_index_spec/#users) + - [4.3 Tags (Registry)](registry_index_spec/#tags-registry) + - [4.4 Images (Index)](registry_index_spec/#images-index) + - [4.5 Repositories](registry_index_spec/#repositories) +- + - [5. Chaining + Registries](registry_index_spec/#chaining-registries) + - [6. Authentication & + Authorization](registry_index_spec/#authentication-authorization) + - [6.1 On the Index](registry_index_spec/#on-the-index) + - [6.2 On the Registry](registry_index_spec/#on-the-registry) +- + - [7 Document Version](registry_index_spec/#document-version) +- + - [Docker Registry API](registry_api/) + - [1. Brief introduction](registry_api/#brief-introduction) + - [2. Endpoints](registry_api/#endpoints) +@@ -43,16 +38,13 @@ interfaces: + - [2.2 Tags](registry_api/#tags) + - [2.3 Repositories](registry_api/#repositories) + - [2.4 Status](registry_api/#status) +- + - [3 Authorization](registry_api/#authorization) +- + - [Docker Index API](index_api/) + - [1. Brief introduction](index_api/#brief-introduction) + - [2. Endpoints](index_api/#endpoints) + - [2.1 Repository](index_api/#repository) + - [2.2 Users](index_api/#users) + - [2.3 Search](index_api/#search) +- + - [Docker Remote API](docker_remote_api/) + - [1. Brief introduction](docker_remote_api/#brief-introduction) + - [2. Versions](docker_remote_api/#versions) +@@ -67,7 +59,6 @@ interfaces: + - [v1.2](docker_remote_api/#v1-2) + - [v1.1](docker_remote_api/#v1-1) + - [v1.0](docker_remote_api/#v1-0) +- + - [Docker Remote API Client Libraries](remote_api_client_libraries/) + - [docker.io OAuth API](docker_io_oauth_api/) + - [1. Brief introduction](docker_io_oauth_api/#brief-introduction) +@@ -79,10 +70,8 @@ interfaces: + - [3.2 Get an Access + Token](docker_io_oauth_api/#get-an-access-token) + - [3.3 Refresh a Token](docker_io_oauth_api/#refresh-a-token) +- + - [4. Use an Access Token with the + API](docker_io_oauth_api/#use-an-access-token-with-the-api) +- + - [docker.io Accounts API](docker_io_accounts_api/) + - [1. Endpoints](docker_io_accounts_api/#endpoints) + - [1.1 Get a single +@@ -96,4 +85,5 @@ interfaces: + - [1.5 Update an email address for a + user](docker_io_accounts_api/#update-an-email-address-for-a-user) + - [1.6 Delete email address for a +- user](docker_io_accounts_api/#delete-email-address-for-a-user) +\ No newline at end of file ++ user](docker_io_accounts_api/#delete-email-address-for-a-user) ++ +diff --git a/docs/sources/reference/api/docker_io_accounts_api.md b/docs/sources/reference/api/docker_io_accounts_api.md +index 6ad5361..dc78076 100644 +--- a/docs/sources/reference/api/docker_io_accounts_api.md ++++ b/docs/sources/reference/api/docker_io_accounts_api.md +@@ -2,35 +2,50 @@ page_title: docker.io Accounts API + page_description: API Documentation for docker.io accounts. + page_keywords: API, Docker, accounts, REST, documentation + +-# Docker IO Accounts API ++# [docker.io Accounts API](#id1) + +-## Endpoints ++Table of Contents + +-### Get A Single User ++- [docker.io Accounts API](#docker-io-accounts-api) ++ - [1. Endpoints](#endpoints) ++ - [1.1 Get a single user](#get-a-single-user) ++ - [1.2 Update a single user](#update-a-single-user) ++ - [1.3 List email addresses for a ++ user](#list-email-addresses-for-a-user) ++ - [1.4 Add email address for a ++ user](#add-email-address-for-a-user) ++ - [1.5 Update an email address for a ++ user](#update-an-email-address-for-a-user) ++ - [1.6 Delete email address for a ++ user](#delete-email-address-for-a-user) ++ ++## [1. Endpoints](#id2) ++ ++### [1.1 Get a single user](#id3) + + `GET `{.descname}`/api/v1.1/users/:username/`{.descname} + : Get profile info for the specified user. + + Parameters: + +- - **username** – username of the user whose profile info is being ++ - **username** – username of the user whose profile info is being + requested. + + Request Headers: + +   + +- - **Authorization** – required authentication credentials of ++ - **Authorization** – required authentication credentials of + either type HTTP Basic or OAuth Bearer Token. + + Status Codes: + +- - **200** – success, user data returned. +- - **401** – authentication error. +- - **403** – permission error, authenticated user must be the user ++ - **200** – success, user data returned. ++ - **401** – authentication error. ++ - **403** – permission error, authenticated user must be the user + whose data is being requested, OAuth access tokens must have + `profile_read` scope. +- - **404** – the specified username does not exist. ++ - **404** – the specified username does not exist. + + **Example request**: + +@@ -59,45 +74,45 @@ page_keywords: API, Docker, accounts, REST, documentation + "is_active": true + } + +-### Update A Single User ++### [1.2 Update a single user](#id4) + + `PATCH `{.descname}`/api/v1.1/users/:username/`{.descname} + : Update profile info for the specified user. + + Parameters: + +- - **username** – username of the user whose profile info is being ++ - **username** – username of the user whose profile info is being + updated. + + Json Parameters: + +   + +- - **full\_name** (*string*) – (optional) the new name of the user. +- - **location** (*string*) – (optional) the new location. +- - **company** (*string*) – (optional) the new company of the user. +- - **profile\_url** (*string*) – (optional) the new profile url. +- - **gravatar\_email** (*string*) – (optional) the new Gravatar ++ - **full\_name** (*string*) – (optional) the new name of the user. ++ - **location** (*string*) – (optional) the new location. ++ - **company** (*string*) – (optional) the new company of the user. ++ - **profile\_url** (*string*) – (optional) the new profile url. ++ - **gravatar\_email** (*string*) – (optional) the new Gravatar + email address. + + Request Headers: + +   + +- - **Authorization** – required authentication credentials of ++ - **Authorization** – required authentication credentials of + either type HTTP Basic or OAuth Bearer Token. +- - **Content-Type** – MIME Type of post data. JSON, url-encoded ++ - **Content-Type** – MIME Type of post data. JSON, url-encoded + form data, etc. + + Status Codes: + +- - **200** – success, user data updated. +- - **400** – post data validation error. +- - **401** – authentication error. +- - **403** – permission error, authenticated user must be the user ++ - **200** – success, user data updated. ++ - **400** – post data validation error. ++ - **401** – authentication error. ++ - **403** – permission error, authenticated user must be the user + whose data is being updated, OAuth access tokens must have + `profile_write` scope. +- - **404** – the specified username does not exist. ++ - **404** – the specified username does not exist. + + **Example request**: + +@@ -132,31 +147,31 @@ page_keywords: API, Docker, accounts, REST, documentation + "is_active": true + } + +-### List Email Addresses For A User ++### [1.3 List email addresses for a user](#id5) + + `GET `{.descname}`/api/v1.1/users/:username/emails/`{.descname} + : List email info for the specified user. + + Parameters: + +- - **username** – username of the user whose profile info is being ++ - **username** – username of the user whose profile info is being + updated. + + Request Headers: + +   + +- - **Authorization** – required authentication credentials of ++ - **Authorization** – required authentication credentials of + either type HTTP Basic or OAuth Bearer Token + + Status Codes: + +- - **200** – success, user data updated. +- - **401** – authentication error. +- - **403** – permission error, authenticated user must be the user ++ - **200** – success, user data updated. ++ - **401** – authentication error. ++ - **403** – permission error, authenticated user must be the user + whose data is being requested, OAuth access tokens must have + `email_read` scope. +- - **404** – the specified username does not exist. ++ - **404** – the specified username does not exist. + + **Example request**: + +@@ -170,7 +185,7 @@ page_keywords: API, Docker, accounts, REST, documentation + HTTP/1.1 200 OK + Content-Type: application/json + +- ++ [ + { + "email": "jane.doe@example.com", + "verified": true, +@@ -178,7 +193,7 @@ page_keywords: API, Docker, accounts, REST, documentation + } + ] + +-### Add Email Address For A User ++### [1.4 Add email address for a user](#id6) + + `POST `{.descname}`/api/v1.1/users/:username/emails/`{.descname} + : Add a new email address to the specified user’s account. The email +@@ -189,26 +204,26 @@ page_keywords: API, Docker, accounts, REST, documentation + +   + +- - **email** (*string*) – email address to be added. ++ - **email** (*string*) – email address to be added. + + Request Headers: + +   + +- - **Authorization** – required authentication credentials of ++ - **Authorization** – required authentication credentials of + either type HTTP Basic or OAuth Bearer Token. +- - **Content-Type** – MIME Type of post data. JSON, url-encoded ++ - **Content-Type** – MIME Type of post data. JSON, url-encoded + form data, etc. + + Status Codes: + +- - **201** – success, new email added. +- - **400** – data validation error. +- - **401** – authentication error. +- - **403** – permission error, authenticated user must be the user ++ - **201** – success, new email added. ++ - **400** – data validation error. ++ - **401** – authentication error. ++ - **403** – permission error, authenticated user must be the user + whose data is being requested, OAuth access tokens must have + `email_write` scope. +- - **404** – the specified username does not exist. ++ - **404** – the specified username does not exist. + + **Example request**: + +@@ -233,7 +248,7 @@ page_keywords: API, Docker, accounts, REST, documentation + "primary": false + } + +-### Update An Email Address For A User ++### [1.5 Update an email address for a user](#id7) + + `PATCH `{.descname}`/api/v1.1/users/:username/emails/`{.descname} + : Update an email address for the specified user to either verify an +@@ -244,17 +259,17 @@ page_keywords: API, Docker, accounts, REST, documentation + + Parameters: + +- - **username** – username of the user whose email info is being ++ - **username** – username of the user whose email info is being + updated. + + Json Parameters: + +   + +- - **email** (*string*) – the email address to be updated. +- - **verified** (*boolean*) – (optional) whether the email address ++ - **email** (*string*) – the email address to be updated. ++ - **verified** (*boolean*) – (optional) whether the email address + is verified, must be `true` or absent. +- - **primary** (*boolean*) – (optional) whether to set the email ++ - **primary** (*boolean*) – (optional) whether to set the email + address as the primary email, must be `true` + or absent. + +@@ -262,20 +277,20 @@ page_keywords: API, Docker, accounts, REST, documentation + +   + +- - **Authorization** – required authentication credentials of ++ - **Authorization** – required authentication credentials of + either type HTTP Basic or OAuth Bearer Token. +- - **Content-Type** – MIME Type of post data. JSON, url-encoded ++ - **Content-Type** – MIME Type of post data. JSON, url-encoded + form data, etc. + + Status Codes: + +- - **200** – success, user’s email updated. +- - **400** – data validation error. +- - **401** – authentication error. +- - **403** – permission error, authenticated user must be the user ++ - **200** – success, user’s email updated. ++ - **400** – data validation error. ++ - **401** – authentication error. ++ - **403** – permission error, authenticated user must be the user + whose data is being updated, OAuth access tokens must have + `email_write` scope. +- - **404** – the specified username or email address does not ++ - **404** – the specified username or email address does not + exist. + + **Example request**: +@@ -303,7 +318,7 @@ page_keywords: API, Docker, accounts, REST, documentation + "primary": false + } + +-### Delete Email Address For A User ++### [1.6 Delete email address for a user](#id8) + + `DELETE `{.descname}`/api/v1.1/users/:username/emails/`{.descname} + : Delete an email address from the specified user’s account. You +@@ -313,26 +328,26 @@ page_keywords: API, Docker, accounts, REST, documentation + +   + +- - **email** (*string*) – email address to be deleted. ++ - **email** (*string*) – email address to be deleted. + + Request Headers: + +   + +- - **Authorization** – required authentication credentials of ++ - **Authorization** – required authentication credentials of + either type HTTP Basic or OAuth Bearer Token. +- - **Content-Type** – MIME Type of post data. JSON, url-encoded ++ - **Content-Type** – MIME Type of post data. JSON, url-encoded + form data, etc. + + Status Codes: + +- - **204** – success, email address removed. +- - **400** – validation error. +- - **401** – authentication error. +- - **403** – permission error, authenticated user must be the user ++ - **204** – success, email address removed. ++ - **400** – validation error. ++ - **401** – authentication error. ++ - **403** – permission error, authenticated user must be the user + whose data is being requested, OAuth access tokens must have + `email_write` scope. +- - **404** – the specified username or email address does not ++ - **404** – the specified username or email address does not + exist. + + **Example request**: +@@ -350,4 +365,6 @@ page_keywords: API, Docker, accounts, REST, documentation + **Example response**: + + HTTP/1.1 204 NO CONTENT +- Content-Length: 0 +\ No newline at end of file ++ Content-Length: 0 ++ ++ +diff --git a/docs/sources/reference/api/docker_io_oauth_api.md b/docs/sources/reference/api/docker_io_oauth_api.md +index 85f3a22..c39ab56 100644 +--- a/docs/sources/reference/api/docker_io_oauth_api.md ++++ b/docs/sources/reference/api/docker_io_oauth_api.md +@@ -2,9 +2,21 @@ page_title: docker.io OAuth API + page_description: API Documentation for docker.io's OAuth flow. + page_keywords: API, Docker, oauth, REST, documentation + +-# Docker IO OAuth API ++# [docker.io OAuth API](#id1) + +-## Introduction ++Table of Contents ++ ++- [docker.io OAuth API](#docker-io-oauth-api) ++ - [1. Brief introduction](#brief-introduction) ++ - [2. Register Your Application](#register-your-application) ++ - [3. Endpoints](#endpoints) ++ - [3.1 Get an Authorization Code](#get-an-authorization-code) ++ - [3.2 Get an Access Token](#get-an-access-token) ++ - [3.3 Refresh a Token](#refresh-a-token) ++ - [4. Use an Access Token with the ++ API](#use-an-access-token-with-the-api) ++ ++## [1. Brief introduction](#id2) + + Some docker.io API requests will require an access token to + authenticate. To get an access token for a user, that user must first +@@ -12,13 +24,13 @@ grant your application access to their docker.io account. In order for + them to grant your application access you must first register your + application. + +-Before continuing, we encourage you to familiarize yourself with The +-OAuth 2.0 Authorization Framework](http://tools.ietf.org/c6749). ++Before continuing, we encourage you to familiarize yourself with [The ++OAuth 2.0 Authorization Framework](http://tools.ietf.org/html/rfc6749). + + *Also note that all OAuth interactions must take place over https + connections* + +-## Registering Your Application ++## [2. Register Your Application](#id3) + + You will need to register your application with docker.io before users + will be able to grant your application access to their account +@@ -27,10 +39,10 @@ request registration of your application send an email to + [support-accounts@docker.com](mailto:support-accounts%40docker.com) with + the following information: + +-- The name of your application +-- A description of your application and the service it will provide to ++- The name of your application ++- A description of your application and the service it will provide to + docker.io users. +-- A callback URI that we will use for redirecting authorization ++- A callback URI that we will use for redirecting authorization + requests to your application. These are used in the step of getting + an Authorization Code. The domain name of the callback URI will be + visible to the user when they are requested to authorize your +@@ -41,9 +53,9 @@ docker.io team with your `client_id` and + `client_secret` which your application will use in + the steps of getting an Authorization Code and getting an Access Token. + +-## Endpoints ++## [3. Endpoints](#id4) + +-### Get an Authorization Code ++### [3.1 Get an Authorization Code](#id5) + + Once You have registered you are ready to start integrating docker.io + accounts into your application! The process is usually started by a user +@@ -61,24 +73,24 @@ following a link in your application to an OAuth Authorization endpoint. + +   + +- - **client\_id** – The `client_id` given to ++ - **client\_id** – The `client_id` given to + your application at registration. +- - **response\_type** – MUST be set to `code`. ++ - **response\_type** – MUST be set to `code`. + This specifies that you would like an Authorization Code + returned. +- - **redirect\_uri** – The URI to redirect back to after the user ++ - **redirect\_uri** – The URI to redirect back to after the user + has authorized your application. If omitted, the first of your + registered `response_uris` is used. If + included, it must be one of the URIs which were submitted when + registering your application. +- - **scope** – The extent of access permissions you are requesting. ++ - **scope** – The extent of access permissions you are requesting. + Currently, the scope options are `profile_read`{.docutils + .literal}, `profile_write`, + `email_read`, and `email_write`{.docutils + .literal}. Scopes must be separated by a space. If omitted, the + default scopes `profile_read email_read` are + used. +- - **state** – (Recommended) Used by your application to maintain ++ - **state** – (Recommended) Used by your application to maintain + state between the authorization request and callback to protect + against CSRF attacks. + +@@ -115,7 +127,7 @@ following a link in your application to an OAuth Authorization endpoint. + : An error message in the event of the user denying the + authorization or some other kind of error with the request. + +-### Get an Access Token ++### [3.2 Get an Access Token](#id6) + + Once the user has authorized your application, a request will be made to + your application’s specified `redirect_uri` which +@@ -131,7 +143,7 @@ to get an Access Token. + +   + +- - **Authorization** – HTTP basic authentication using your ++ - **Authorization** – HTTP basic authentication using your + application’s `client_id` and + `client_secret` + +@@ -139,11 +151,11 @@ to get an Access Token. + +   + +- - **grant\_type** – MUST be set to `authorization_code`{.docutils ++ - **grant\_type** – MUST be set to `authorization_code`{.docutils + .literal} +- - **code** – The authorization code received from the user’s ++ - **code** – The authorization code received from the user’s + redirect request. +- - **redirect\_uri** – The same `redirect_uri` ++ - **redirect\_uri** – The same `redirect_uri` + used in the authentication request. + + **Example Request** +@@ -180,7 +192,7 @@ to get an Access Token. + In the case of an error, there will be a non-200 HTTP Status and and + data detailing the error. + +-### Refresh a Token ++### [3.3 Refresh a Token](#id7) + + Once the Access Token expires you can use your `refresh_token`{.docutils + .literal} to have docker.io issue your application a new Access Token, +@@ -195,7 +207,7 @@ if the user has not revoked access from your application. + +   + +- - **Authorization** – HTTP basic authentication using your ++ - **Authorization** – HTTP basic authentication using your + application’s `client_id` and + `client_secret` + +@@ -203,11 +215,11 @@ if the user has not revoked access from your application. + +   + +- - **grant\_type** – MUST be set to `refresh_token`{.docutils ++ - **grant\_type** – MUST be set to `refresh_token`{.docutils + .literal} +- - **refresh\_token** – The `refresh_token` ++ - **refresh\_token** – The `refresh_token` + which was issued to your application. +- - **scope** – (optional) The scope of the access token to be ++ - **scope** – (optional) The scope of the access token to be + returned. Must not include any scope not originally granted by + the user and if omitted is treated as equal to the scope + originally granted. +@@ -245,7 +257,7 @@ if the user has not revoked access from your application. + In the case of an error, there will be a non-200 HTTP Status and and + data detailing the error. + +-## Use an Access Token with the API ++## [4. Use an Access Token with the API](#id8) + + Many of the docker.io API requests will require a Authorization request + header field. Simply ensure you add this header with “Bearer +diff --git a/docs/sources/reference/api/docker_remote_api.md b/docs/sources/reference/api/docker_remote_api.md +index 35dd858..8a2e456 100644 +--- a/docs/sources/reference/api/docker_remote_api.md ++++ b/docs/sources/reference/api/docker_remote_api.md +@@ -4,21 +4,21 @@ page_keywords: API, Docker, rcli, REST, documentation + + # Docker Remote API + +-## Introduction +- +-- The Remote API is replacing rcli +-- By default the Docker daemon listens on unix:///var/run/docker.sock +- and the client must have root access to interact with the daemon +-- If a group named *docker* exists on your system, docker will apply +- ownership of the socket to the group +-- 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 +-- 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`. +- +-## Docker Remote API Versions ++## 1. Brief introduction ++ ++- The Remote API is replacing rcli ++- By default the Docker daemon listens on unix:///var/run/docker.sock ++ and the client must have root access to interact with the daemon ++- If a group named *docker* exists on your system, docker will apply ++ ownership of the socket to the group ++- 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 ++- 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 ++ ++## 2. Versions + + The current version of the API is 1.10 + +@@ -28,25 +28,31 @@ Calling /images/\/insert is the same as calling + You can still call an old version of the api using + /v1.0/images/\/insert + +-## Docker Remote API v1.10 ++### v1.10 + +-### Full Documentation ++#### Full Documentation + + [*Docker Remote API v1.10*](../docker_remote_api_v1.10/) + +-### What’s new ++#### What’s new + + `DELETE `{.descname}`/images/`{.descname}(*name*) + : **New!** You can now use the force parameter to force delete of an +- image, even if it’s tagged in multiple repositories. ++ image, even if it’s tagged in multiple repositories. **New!** You ++ can now use the noprune parameter to prevent the deletion of parent ++ images + +-## Docker Remote API v1.9 ++ `DELETE `{.descname}`/containers/`{.descname}(*id*) ++: **New!** You can now use the force paramter to force delete a ++ container, even if it is currently running + +-### Full Documentation ++### v1.9 ++ ++#### Full Documentation + + [*Docker Remote API v1.9*](../docker_remote_api_v1.9/) + +-### What’s New ++#### What’s new + + `POST `{.descname}`/build`{.descname} + : **New!** This endpoint now takes a serialized ConfigFile which it +@@ -54,13 +60,13 @@ You can still call an old version of the api using + base image. Clients which previously implemented the version + accepting an AuthConfig object must be updated. + +-## Docker Remote API v1.8 ++### v1.8 + +-### Full Documentation ++#### Full Documentation + + [*Docker Remote API v1.8*](../docker_remote_api_v1.8/) + +-### What’s New ++#### What’s new + + `POST `{.descname}`/build`{.descname} + : **New!** This endpoint now returns build status as json stream. In +@@ -82,13 +88,13 @@ You can still call an old version of the api using + possible to get the current value and the total of the progress + without having to parse the string. + +-## Docker Remote API v1.7 ++### v1.7 + +-### Full Documentation ++#### Full Documentation + + [*Docker Remote API v1.7*](../docker_remote_api_v1.7/) + +-### What’s New ++#### What’s new + + `GET `{.descname}`/images/json`{.descname} + : The format of the json returned from this uri changed. Instead of an +@@ -175,17 +181,17 @@ You can still call an old version of the api using + ] + + `GET `{.descname}`/images/viz`{.descname} +-: This URI no longer exists. The `images -viz` ++: This URI no longer exists. The `images --viz` + output is now generated in the client, using the + `/images/json` data. + +-## Docker Remote API v1.6 ++### v1.6 + +-### Full Documentation ++#### Full Documentation + + [*Docker Remote API v1.6*](../docker_remote_api_v1.6/) + +-### What’s New ++#### What’s new + + `POST `{.descname}`/containers/`{.descname}(*id*)`/attach`{.descname} + : **New!** You can now split stderr from stdout. This is done by +@@ -195,13 +201,13 @@ You can still call an old version of the api using + The WebSocket attach is unchanged. Note that attach calls on the + previous API version didn’t change. Stdout and stderr are merged. + +-## Docker Remote API v1.5 ++### v1.5 + +-### Full Documentation ++#### Full Documentation + + [*Docker Remote API v1.5*](../docker_remote_api_v1.5/) + +-### What’s New ++#### What’s new + + `POST `{.descname}`/images/create`{.descname} + : **New!** You can now pass registry credentials (via an AuthConfig +@@ -216,13 +222,13 @@ You can still call an old version of the api using + dicts each containing PublicPort, PrivatePort and Type describing a + port mapping. + +-## Docker Remote API v1.4 ++### v1.4 + +-### Full Documentation ++#### Full Documentation + + [*Docker Remote API v1.4*](../docker_remote_api_v1.4/) + +-### What’s New ++#### What’s new + + `POST `{.descname}`/images/create`{.descname} + : **New!** When pulling a repo, all images are now downloaded in +@@ -235,16 +241,16 @@ You can still call an old version of the api using + `GET `{.descname}`/events:`{.descname} + : **New!** Image’s name added in the events + +-## Docker Remote API v1.3 ++### v1.3 + + docker v0.5.0 + [51f6c4a](https://github.com/dotcloud/docker/commit/51f6c4a7372450d164c61e0054daf0223ddbd909) + +-### Full Documentation ++#### Full Documentation + + [*Docker Remote API v1.3*](../docker_remote_api_v1.3/) + +-### What’s New ++#### What’s new + + `GET `{.descname}`/containers/`{.descname}(*id*)`/top`{.descname} + : List the processes running inside a container. +@@ -254,10 +260,10 @@ docker v0.5.0 + + Builder (/build): + +-- Simplify the upload of the build context +-- Simply stream a tarball instead of multipart upload with 4 +- intermediary buffers +-- Simpler, less memory usage, less disk usage and faster ++- Simplify the upload of the build context ++- Simply stream a tarball instead of multipart upload with 4 ++ intermediary buffers ++- Simpler, less memory usage, less disk usage and faster + + Warning + +@@ -266,23 +272,23 @@ break on /build. + + List containers (/containers/json): + +-- You can use size=1 to get the size of the containers ++- You can use size=1 to get the size of the containers + + Start containers (/containers/\/start): + +-- You can now pass host-specific configuration (e.g. bind mounts) in +- the POST body for start calls ++- You can now pass host-specific configuration (e.g. bind mounts) in ++ the POST body for start calls + +-## Docker Remote API v1.2 ++### v1.2 + + docker v0.4.2 + [2e7649b](https://github.com/dotcloud/docker/commit/2e7649beda7c820793bd46766cbc2cfeace7b168) + +-### Full Documentation ++#### Full Documentation + + [*Docker Remote API v1.2*](../docker_remote_api_v1.2/) + +-### What’s New ++#### What’s new + + The auth configuration is now handled by the client. + +@@ -302,16 +308,16 @@ The client should send it’s authConfig as POST on each call of + : Now returns a JSON structure with the list of images + deleted/untagged. + +-## Docker Remote API v1.1 ++### v1.1 + + docker v0.4.0 + [a8ae398](https://github.com/dotcloud/docker/commit/a8ae398bf52e97148ee7bd0d5868de2e15bd297f) + +-### Full Documentation ++#### Full Documentation + + [*Docker Remote API v1.1*](../docker_remote_api_v1.1/) + +-### What’s New ++#### What’s new + + `POST `{.descname}`/images/create`{.descname} + : +@@ -330,15 +336,15 @@ docker v0.4.0 + > {"error":"Invalid..."} + > ... + +-## Docker Remote API v1.0 ++### v1.0 + + docker v0.3.4 + [8d73740](https://github.com/dotcloud/docker/commit/8d73740343778651c09160cde9661f5f387b36f4) + +-### Full Documentation ++#### Full Documentation + + [*Docker Remote API v1.0*](../docker_remote_api_v1.0/) + +-### What’s New ++#### What’s new + + Initial version +diff --git a/docs/sources/reference/api/docker_remote_api_v1.0.md b/docs/sources/reference/api/docker_remote_api_v1.0.md +index 6bb0fcb..30b1718 100644 +--- a/docs/sources/reference/api/docker_remote_api_v1.0.md ++++ b/docs/sources/reference/api/docker_remote_api_v1.0.md +@@ -2,21 +2,70 @@ page_title: Remote API v1.0 + page_description: API Documentation for Docker + page_keywords: API, Docker, rcli, REST, documentation + +-# Docker Remote API v1.0 +- +-## Introduction +- +-- The Remote API is replacing rcli +-- Default port in the docker daemon is 4243 +-- The API tends to be REST, but for some complex commands, like attach ++# [Docker Remote API v1.0](#id1) ++ ++Table of Contents ++ ++- [Docker Remote API v1.0](#docker-remote-api-v1-0) ++ - [1. Brief introduction](#brief-introduction) ++ - [2. Endpoints](#endpoints) ++ - [2.1 Containers](#containers) ++ - [List containers](#list-containers) ++ - [Create a container](#create-a-container) ++ - [Inspect a container](#inspect-a-container) ++ - [Inspect changes on a container’s ++ filesystem](#inspect-changes-on-a-container-s-filesystem) ++ - [Export a container](#export-a-container) ++ - [Start a container](#start-a-container) ++ - [Stop a container](#stop-a-container) ++ - [Restart a container](#restart-a-container) ++ - [Kill a container](#kill-a-container) ++ - [Attach to a container](#attach-to-a-container) ++ - [Wait a container](#wait-a-container) ++ - [Remove a container](#remove-a-container) ++ - [2.2 Images](#images) ++ - [List Images](#list-images) ++ - [Create an image](#create-an-image) ++ - [Insert a file in an image](#insert-a-file-in-an-image) ++ - [Inspect an image](#inspect-an-image) ++ - [Get the history of an ++ image](#get-the-history-of-an-image) ++ - [Push an image on the ++ registry](#push-an-image-on-the-registry) ++ - [Tag an image into a ++ repository](#tag-an-image-into-a-repository) ++ - [Remove an image](#remove-an-image) ++ - [Search images](#search-images) ++ - [2.3 Misc](#misc) ++ - [Build an image from Dockerfile via ++ stdin](#build-an-image-from-dockerfile-via-stdin) ++ - [Get default username and ++ email](#get-default-username-and-email) ++ - [Check auth configuration and store ++ it](#check-auth-configuration-and-store-it) ++ - [Display system-wide ++ information](#display-system-wide-information) ++ - [Show the docker version ++ information](#show-the-docker-version-information) ++ - [Create a new image from a container’s ++ changes](#create-a-new-image-from-a-container-s-changes) ++ - [3. Going further](#going-further) ++ - [3.1 Inside ‘docker run’](#inside-docker-run) ++ - [3.2 Hijacking](#hijacking) ++ ++## [1. Brief introduction](#id2) ++ ++- The Remote API is replacing rcli ++- Default port in the docker daemon 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 + +-## Endpoints ++## [2. Endpoints](#id3) + +-### Containers ++### [2.1 Containers](#id4) + +-### List containers: ++#### [List containers](#id5) + + `GET `{.descname}`/containers/json`{.descname} + : List containers +@@ -65,22 +114,22 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **all** – 1/True/true or 0/False/false, Show all containers. ++ - **all** – 1/True/true or 0/False/false, Show all containers. + Only running containers are shown by default +- - **limit** – Show `limit` last created ++ - **limit** – Show `limit` last created + containers, include non-running ones. +- - **since** – Show only containers created since Id, include ++ - **since** – Show only containers created since Id, include + non-running ones. +- - **before** – Show only containers created before Id, include ++ - **before** – Show only containers created before Id, include + non-running ones. + + Status Codes: + +- - **200** – no error +- - **400** – bad parameter +- - **500** – server error ++ - **200** – no error ++ - **400** – bad parameter ++ - **500** – server error + +-### Create a container: ++#### [Create a container](#id6) + + `POST `{.descname}`/containers/create`{.descname} + : Create a container +@@ -126,16 +175,16 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **config** – the container’s configuration ++ - **config** – the container’s configuration + + Status Codes: + +- - **201** – no error +- - **404** – no such container +- - **406** – impossible to attach (container not running) +- - **500** – server error ++ - **201** – no error ++ - **404** – no such container ++ - **406** – impossible to attach (container not running) ++ - **500** – server error + +-### Inspect a container: ++#### [Inspect a container](#id7) + + `GET `{.descname}`/containers/`{.descname}(*id*)`/json`{.descname} + : Return low-level information on the container `id`{.docutils +@@ -198,11 +247,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Inspect changes on a container’s filesystem:] ++#### [Inspect changes on a container’s filesystem](#id8) + + `GET `{.descname}`/containers/`{.descname}(*id*)`/changes`{.descname} + : Inspect changes on container `id` ‘s filesystem +@@ -233,11 +282,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Export a container: ++#### [Export a container](#id9) + + `GET `{.descname}`/containers/`{.descname}(*id*)`/export`{.descname} + : Export the contents of container `id` +@@ -255,11 +304,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Start a container: ++#### [Start a container](#id10) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/start`{.descname} + : Start the container `id` +@@ -274,11 +323,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Stop a container: ++#### [Stop a container](#id11) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/stop`{.descname} + : Stop the container `id` +@@ -295,15 +344,15 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **t** – number of seconds to wait before killing the container ++ - **t** – number of seconds to wait before killing the container + + Status Codes: + +- - **204** – no error +- - **404** – no such container +- - **500** – server error ++ - **204** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Restart a container: ++#### [Restart a container](#id12) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/restart`{.descname} + : Restart the container `id` +@@ -320,15 +369,15 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **t** – number of seconds to wait before killing the container ++ - **t** – number of seconds to wait before killing the container + + Status Codes: + +- - **204** – no error +- - **404** – no such container +- - **500** – server error ++ - **204** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Kill a container: ++#### [Kill a container](#id13) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/kill`{.descname} + : Kill the container `id` +@@ -343,11 +392,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **204** – no error +- - **404** – no such container +- - **500** – server error ++ - **204** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Attach to a container: ++#### [Attach to a container](#id14) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/attach`{.descname} + : Attach to the container `id` +@@ -367,25 +416,25 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **logs** – 1/True/true or 0/False/false, return logs. Default ++ - **logs** – 1/True/true or 0/False/false, return logs. Default + false +- - **stream** – 1/True/true or 0/False/false, return stream. ++ - **stream** – 1/True/true or 0/False/false, return stream. + Default false +- - **stdin** – 1/True/true or 0/False/false, if stream=true, attach ++ - **stdin** – 1/True/true or 0/False/false, if stream=true, attach + to stdin. Default false +- - **stdout** – 1/True/true or 0/False/false, if logs=true, return ++ - **stdout** – 1/True/true or 0/False/false, if logs=true, return + stdout log, if stream=true, attach to stdout. Default false +- - **stderr** – 1/True/true or 0/False/false, if logs=true, return ++ - **stderr** – 1/True/true or 0/False/false, if logs=true, return + stderr log, if stream=true, attach to stderr. Default false + + Status Codes: + +- - **200** – no error +- - **400** – bad parameter +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **400** – bad parameter ++ - **404** – no such container ++ - **500** – server error + +-### Wait a container: ++#### [Wait a container](#id15) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/wait`{.descname} + : Block until container `id` stops, then returns +@@ -404,11 +453,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Remove a container: ++#### [Remove a container](#id16) + + `DELETE `{.descname}`/containers/`{.descname}(*id*) + : Remove the container `id` from the filesystem +@@ -425,19 +474,19 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **v** – 1/True/true or 0/False/false, Remove the volumes ++ - **v** – 1/True/true or 0/False/false, Remove the volumes + associated to the container. Default false + + Status Codes: + +- - **204** – no error +- - **400** – bad parameter +- - **404** – no such container +- - **500** – server error ++ - **204** – no error ++ - **400** – bad parameter ++ - **404** – no such container ++ - **500** – server error + +-## Images ++### [2.2 Images](#id17) + +-### List images: ++#### [List Images](#id18) + + `GET `{.descname}`/images/`{.descname}(*format*) + : List images `format` could be json or viz (json +@@ -498,16 +547,16 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **all** – 1/True/true or 0/False/false, Show all containers. ++ - **all** – 1/True/true or 0/False/false, Show all containers. + Only running containers are shown by default + + Status Codes: + +- - **200** – no error +- - **400** – bad parameter +- - **500** – server error ++ - **200** – no error ++ - **400** – bad parameter ++ - **500** – server error + +-### Create an image: ++#### [Create an image](#id19) + + `POST `{.descname}`/images/create`{.descname} + : Create an image, either by pull it from the registry or by importing +@@ -528,18 +577,18 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **fromImage** – name of the image to pull +- - **fromSrc** – source to import, - means stdin +- - **repo** – repository +- - **tag** – tag +- - **registry** – the registry to pull from ++ - **fromImage** – name of the image to pull ++ - **fromSrc** – source to import, - means stdin ++ - **repo** – repository ++ - **tag** – tag ++ - **registry** – the registry to pull from + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Insert a file in an image: ++#### [Insert a file in an image](#id20) + + `POST `{.descname}`/images/`{.descname}(*name*)`/insert`{.descname} + : Insert a file from `url` in the image +@@ -557,10 +606,10 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Inspect an image: ++#### [Inspect an image](#id21) + + `GET `{.descname}`/images/`{.descname}(*name*)`/json`{.descname} + : Return low-level information on the image `name` +@@ -603,11 +652,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such image +- - **500** – server error ++ - **200** – no error ++ - **404** – no such image ++ - **500** – server error + +-### Get the history of an image: ++#### [Get the history of an image](#id22) + + `GET `{.descname}`/images/`{.descname}(*name*)`/history`{.descname} + : Return the history of the image `name` +@@ -636,11 +685,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such image +- - **500** – server error ++ - **200** – no error ++ - **404** – no such image ++ - **500** – server error + +-### Push an image on the registry: ++#### [Push an image on the registry](#id23) + + `POST `{.descname}`/images/`{.descname}(*name*)`/push`{.descname} + : Push the image `name` on the registry +@@ -660,15 +709,15 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **registry** – the registry you wan to push, optional ++ - **registry** – the registry you wan to push, optional + + Status Codes: + +- - **200** – no error +- - **404** – no such image +- - **500** – server error ++ - **200** – no error ++ - **404** – no such image ++ - **500** – server error + +-### Tag an image into a repository: ++#### [Tag an image into a repository](#id24) + + `POST `{.descname}`/images/`{.descname}(*name*)`/tag`{.descname} + : Tag the image `name` into a repository +@@ -685,17 +734,17 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **repo** – The repository to tag in +- - **force** – 1/True/true or 0/False/false, default false ++ - **repo** – The repository to tag in ++ - **force** – 1/True/true or 0/False/false, default false + + Status Codes: + +- - **201** – no error +- - **400** – bad parameter +- - **404** – no such image +- - **500** – server error ++ - **201** – no error ++ - **400** – bad parameter ++ - **404** – no such image ++ - **500** – server error + +-### Remove an image: ++#### [Remove an image](#id25) + + `DELETE `{.descname}`/images/`{.descname}(*name*) + : Remove the image `name` from the filesystem +@@ -710,11 +759,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **204** – no error +- - **404** – no such image +- - **500** – server error ++ - **204** – no error ++ - **404** – no such image ++ - **500** – server error + +-### Search images: ++#### [Search images](#id26) + + `GET `{.descname}`/images/search`{.descname} + : Search for an image in the docker index +@@ -747,9 +796,9 @@ page_keywords: API, Docker, rcli, REST, documentation + :statuscode 200: no error + :statuscode 500: server error + +-## Misc ++### [2.3 Misc](#id27) + +-### Build an image from Dockerfile via stdin: ++#### [Build an image from Dockerfile via stdin](#id28) + + `POST `{.descname}`/build`{.descname} + : Build an image from Dockerfile via stdin +@@ -770,15 +819,15 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **t** – repository name to be applied to the resulting image in ++ - **t** – repository name to be applied to the resulting image in + case of success + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-#### [Get default username and email ++#### [Get default username and email](#id29) + + `GET `{.descname}`/auth`{.descname} + : Get the default username and email +@@ -799,10 +848,10 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Check auth configuration: and store it ++#### [Check auth configuration and store it](#id30) + + `POST `{.descname}`/auth`{.descname} + : Get the default username and email +@@ -824,11 +873,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **204** – no error +- - **500** – server error ++ - **200** – no error ++ - **204** – no error ++ - **500** – server error + +-### Display system-wide information: ++#### [Display system-wide information](#id31) + + `GET `{.descname}`/info`{.descname} + : Display system-wide information +@@ -854,10 +903,10 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Show the docker version information: ++#### [Show the docker version information](#id32) + + `GET `{.descname}`/version`{.descname} + : Show the docker version information +@@ -879,10 +928,10 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Create a new image from a container’s changes: ++#### [Create a new image from a container’s changes](#id33) + + `POST `{.descname}`/commit`{.descname} + : Create a new image from a container’s changes +@@ -908,41 +957,41 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **container** – source container +- - **repo** – repository +- - **tag** – tag +- - **m** – commit message +- - **author** – author (eg. “John Hannibal Smith ++ - **container** – source container ++ - **repo** – repository ++ - **tag** – tag ++ - **m** – commit message ++ - **author** – author (eg. “John Hannibal Smith + \<[hannibal@a-team.com](mailto:hannibal%40a-team.com)\>”) + + Status Codes: + +- - **201** – no error +- - **404** – no such container +- - **500** – server error ++ - **201** – no error ++ - **404** – no such container ++ - **500** – server error + +-## Going Further ++## [3. Going further](#id34) + +-### Inside ‘docker run’ ++### [3.1 Inside ‘docker run’](#id35) + + Here are the steps of ‘docker run’ : + +-- Create the container ++- Create the container + +-- If the status code is 404, it means the image doesn’t exists: +- : - Try to pull it +- - Then retry to create the container ++- If the status code is 404, it means the image doesn’t exists: ++ : - Try to pull it ++ - Then retry to create the container + +-- Start the container ++- Start the container + +-- If you are not in detached mode: +- : - Attach to the container, using logs=1 (to have stdout and ++- If you are not in detached mode: ++ : - Attach to the container, using logs=1 (to have stdout and + stderr from the container’s start) and stream=1 + +-- If in detached mode or only stdin is attached: +- : - Display the container’s id ++- If in detached mode or only stdin is attached: ++ : - Display the container’s id + +-### Hijacking ++### [3.2 Hijacking](#id36) + + In this first version of the API, some of the endpoints, like /attach, + /pull or /push uses hijacking to transport stdin, stdout and stderr on +diff --git a/docs/sources/reference/api/docker_remote_api_v1.1.md b/docs/sources/reference/api/docker_remote_api_v1.1.md +index 476b942..2d510f4 100644 +--- a/docs/sources/reference/api/docker_remote_api_v1.1.md ++++ b/docs/sources/reference/api/docker_remote_api_v1.1.md +@@ -2,21 +2,70 @@ page_title: Remote API v1.1 + page_description: API Documentation for Docker + page_keywords: API, Docker, rcli, REST, documentation + +-# Docker Remote API v1.1 +- +-## Introduction +- +-- The Remote API is replacing rcli +-- Default port in the docker daemon is 4243 +-- The API tends to be REST, but for some complex commands, like attach ++# [Docker Remote API v1.1](#id1) ++ ++Table of Contents ++ ++- [Docker Remote API v1.1](#docker-remote-api-v1-1) ++ - [1. Brief introduction](#brief-introduction) ++ - [2. Endpoints](#endpoints) ++ - [2.1 Containers](#containers) ++ - [List containers](#list-containers) ++ - [Create a container](#create-a-container) ++ - [Inspect a container](#inspect-a-container) ++ - [Inspect changes on a container’s ++ filesystem](#inspect-changes-on-a-container-s-filesystem) ++ - [Export a container](#export-a-container) ++ - [Start a container](#start-a-container) ++ - [Stop a container](#stop-a-container) ++ - [Restart a container](#restart-a-container) ++ - [Kill a container](#kill-a-container) ++ - [Attach to a container](#attach-to-a-container) ++ - [Wait a container](#wait-a-container) ++ - [Remove a container](#remove-a-container) ++ - [2.2 Images](#images) ++ - [List Images](#list-images) ++ - [Create an image](#create-an-image) ++ - [Insert a file in an image](#insert-a-file-in-an-image) ++ - [Inspect an image](#inspect-an-image) ++ - [Get the history of an ++ image](#get-the-history-of-an-image) ++ - [Push an image on the ++ registry](#push-an-image-on-the-registry) ++ - [Tag an image into a ++ repository](#tag-an-image-into-a-repository) ++ - [Remove an image](#remove-an-image) ++ - [Search images](#search-images) ++ - [2.3 Misc](#misc) ++ - [Build an image from Dockerfile via ++ stdin](#build-an-image-from-dockerfile-via-stdin) ++ - [Get default username and ++ email](#get-default-username-and-email) ++ - [Check auth configuration and store ++ it](#check-auth-configuration-and-store-it) ++ - [Display system-wide ++ information](#display-system-wide-information) ++ - [Show the docker version ++ information](#show-the-docker-version-information) ++ - [Create a new image from a container’s ++ changes](#create-a-new-image-from-a-container-s-changes) ++ - [3. Going further](#going-further) ++ - [3.1 Inside ‘docker run’](#inside-docker-run) ++ - [3.2 Hijacking](#hijacking) ++ ++## [1. Brief introduction](#id2) ++ ++- The Remote API is replacing rcli ++- Default port in the docker daemon 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 + +-## Endpoints ++## [2. Endpoints](#id3) + +-### Containers ++### [2.1 Containers](#id4) + +-### List containers: ++#### [List containers](#id5) + + `GET `{.descname}`/containers/json`{.descname} + : List containers +@@ -65,22 +114,22 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **all** – 1/True/true or 0/False/false, Show all containers. ++ - **all** – 1/True/true or 0/False/false, Show all containers. + Only running containers are shown by default +- - **limit** – Show `limit` last created ++ - **limit** – Show `limit` last created + containers, include non-running ones. +- - **since** – Show only containers created since Id, include ++ - **since** – Show only containers created since Id, include + non-running ones. +- - **before** – Show only containers created before Id, include ++ - **before** – Show only containers created before Id, include + non-running ones. + + Status Codes: + +- - **200** – no error +- - **400** – bad parameter +- - **500** – server error ++ - **200** – no error ++ - **400** – bad parameter ++ - **500** – server error + +-### Create a container: ++#### [Create a container](#id6) + + `POST `{.descname}`/containers/create`{.descname} + : Create a container +@@ -126,16 +175,16 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **config** – the container’s configuration ++ - **config** – the container’s configuration + + Status Codes: + +- - **201** – no error +- - **404** – no such container +- - **406** – impossible to attach (container not running) +- - **500** – server error ++ - **201** – no error ++ - **404** – no such container ++ - **406** – impossible to attach (container not running) ++ - **500** – server error + +-### Inspect a container: ++#### [Inspect a container](#id7) + + `GET `{.descname}`/containers/`{.descname}(*id*)`/json`{.descname} + : Return low-level information on the container `id`{.docutils +@@ -198,11 +247,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Inspect changes on a container’s filesystem:] ++#### [Inspect changes on a container’s filesystem](#id8) + + `GET `{.descname}`/containers/`{.descname}(*id*)`/changes`{.descname} + : Inspect changes on container `id` ‘s filesystem +@@ -233,11 +282,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Export a container: ++#### [Export a container](#id9) + + `GET `{.descname}`/containers/`{.descname}(*id*)`/export`{.descname} + : Export the contents of container `id` +@@ -255,11 +304,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Start a container: ++#### [Start a container](#id10) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/start`{.descname} + : Start the container `id` +@@ -274,11 +323,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Stop a container: ++#### [Stop a container](#id11) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/stop`{.descname} + : Stop the container `id` +@@ -295,15 +344,15 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **t** – number of seconds to wait before killing the container ++ - **t** – number of seconds to wait before killing the container + + Status Codes: + +- - **204** – no error +- - **404** – no such container +- - **500** – server error ++ - **204** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Restart a container: ++#### [Restart a container](#id12) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/restart`{.descname} + : Restart the container `id` +@@ -320,15 +369,15 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **t** – number of seconds to wait before killing the container ++ - **t** – number of seconds to wait before killing the container + + Status Codes: + +- - **204** – no error +- - **404** – no such container +- - **500** – server error ++ - **204** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Kill a container: ++#### [Kill a container](#id13) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/kill`{.descname} + : Kill the container `id` +@@ -343,11 +392,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **204** – no error +- - **404** – no such container +- - **500** – server error ++ - **204** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Attach to a container: ++#### [Attach to a container](#id14) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/attach`{.descname} + : Attach to the container `id` +@@ -367,25 +416,25 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **logs** – 1/True/true or 0/False/false, return logs. Default ++ - **logs** – 1/True/true or 0/False/false, return logs. Default + false +- - **stream** – 1/True/true or 0/False/false, return stream. ++ - **stream** – 1/True/true or 0/False/false, return stream. + Default false +- - **stdin** – 1/True/true or 0/False/false, if stream=true, attach ++ - **stdin** – 1/True/true or 0/False/false, if stream=true, attach + to stdin. Default false +- - **stdout** – 1/True/true or 0/False/false, if logs=true, return ++ - **stdout** – 1/True/true or 0/False/false, if logs=true, return + stdout log, if stream=true, attach to stdout. Default false +- - **stderr** – 1/True/true or 0/False/false, if logs=true, return ++ - **stderr** – 1/True/true or 0/False/false, if logs=true, return + stderr log, if stream=true, attach to stderr. Default false + + Status Codes: + +- - **200** – no error +- - **400** – bad parameter +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **400** – bad parameter ++ - **404** – no such container ++ - **500** – server error + +-### Wait a container: ++#### [Wait a container](#id15) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/wait`{.descname} + : Block until container `id` stops, then returns +@@ -404,11 +453,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Remove a container: ++#### [Remove a container](#id16) + + `DELETE `{.descname}`/containers/`{.descname}(*id*) + : Remove the container `id` from the filesystem +@@ -425,19 +474,19 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **v** – 1/True/true or 0/False/false, Remove the volumes ++ - **v** – 1/True/true or 0/False/false, Remove the volumes + associated to the container. Default false + + Status Codes: + +- - **204** – no error +- - **400** – bad parameter +- - **404** – no such container +- - **500** – server error ++ - **204** – no error ++ - **400** – bad parameter ++ - **404** – no such container ++ - **500** – server error + +-## Images ++### [2.2 Images](#id17) + +-### List images: ++#### [List Images](#id18) + + `GET `{.descname}`/images/`{.descname}(*format*) + : List images `format` could be json or viz (json +@@ -498,16 +547,16 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **all** – 1/True/true or 0/False/false, Show all containers. ++ - **all** – 1/True/true or 0/False/false, Show all containers. + Only running containers are shown by default + + Status Codes: + +- - **200** – no error +- - **400** – bad parameter +- - **500** – server error ++ - **200** – no error ++ - **400** – bad parameter ++ - **500** – server error + +-### Create an image: ++#### [Create an image](#id19) + + `POST `{.descname}`/images/create`{.descname} + : Create an image, either by pull it from the registry or by importing +@@ -531,18 +580,18 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **fromImage** – name of the image to pull +- - **fromSrc** – source to import, - means stdin +- - **repo** – repository +- - **tag** – tag +- - **registry** – the registry to pull from ++ - **fromImage** – name of the image to pull ++ - **fromSrc** – source to import, - means stdin ++ - **repo** – repository ++ - **tag** – tag ++ - **registry** – the registry to pull from + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Insert a file in an image: ++#### [Insert a file in an image](#id20) + + `POST `{.descname}`/images/`{.descname}(*name*)`/insert`{.descname} + : Insert a file from `url` in the image +@@ -564,10 +613,10 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Inspect an image: ++#### [Inspect an image](#id21) + + `GET `{.descname}`/images/`{.descname}(*name*)`/json`{.descname} + : Return low-level information on the image `name` +@@ -610,11 +659,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such image +- - **500** – server error ++ - **200** – no error ++ - **404** – no such image ++ - **500** – server error + +-### Get the history of an image: ++#### [Get the history of an image](#id22) + + `GET `{.descname}`/images/`{.descname}(*name*)`/history`{.descname} + : Return the history of the image `name` +@@ -643,11 +692,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such image +- - **500** – server error ++ - **200** – no error ++ - **404** – no such image ++ - **500** – server error + +-### Push an image on the registry: ++#### [Push an image on the registry](#id23) + + `POST `{.descname}`/images/`{.descname}(*name*)`/push`{.descname} + : Push the image `name` on the registry +@@ -670,15 +719,15 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **registry** – the registry you wan to push, optional ++ - **registry** – the registry you wan to push, optional + + Status Codes: + +- - **200** – no error +- - **404** – no such image +- - **500** – server error ++ - **200** – no error ++ - **404** – no such image ++ - **500** – server error + +-### Tag an image into a repository: ++#### [Tag an image into a repository](#id24) + + `POST `{.descname}`/images/`{.descname}(*name*)`/tag`{.descname} + : Tag the image `name` into a repository +@@ -695,18 +744,18 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **repo** – The repository to tag in +- - **force** – 1/True/true or 0/False/false, default false ++ - **repo** – The repository to tag in ++ - **force** – 1/True/true or 0/False/false, default false + + Status Codes: + +- - **201** – no error +- - **400** – bad parameter +- - **404** – no such image +- - **409** – conflict +- - **500** – server error ++ - **201** – no error ++ - **400** – bad parameter ++ - **404** – no such image ++ - **409** – conflict ++ - **500** – server error + +-### Remove an image: ++#### [Remove an image](#id25) + + `DELETE `{.descname}`/images/`{.descname}(*name*) + : Remove the image `name` from the filesystem +@@ -721,11 +770,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **204** – no error +- - **404** – no such image +- - **500** – server error ++ - **204** – no error ++ - **404** – no such image ++ - **500** – server error + +-### Search images: ++#### [Search images](#id26) + + `GET `{.descname}`/images/search`{.descname} + : Search for an image in the docker index +@@ -758,9 +807,9 @@ page_keywords: API, Docker, rcli, REST, documentation + :statuscode 200: no error + :statuscode 500: server error + +-## Misc ++### [2.3 Misc](#id27) + +-### Build an image from Dockerfile via stdin: ++#### [Build an image from Dockerfile via stdin](#id28) + + `POST `{.descname}`/build`{.descname} + : Build an image from Dockerfile via stdin +@@ -781,15 +830,15 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **t** – tag to be applied to the resulting image in case of ++ - **t** – tag to be applied to the resulting image in case of + success + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-#### [Get default username and email ++#### [Get default username and email](#id29) + + `GET `{.descname}`/auth`{.descname} + : Get the default username and email +@@ -810,10 +859,10 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Check auth configuration: and store it ++#### [Check auth configuration and store it](#id30) + + `POST `{.descname}`/auth`{.descname} + : Get the default username and email +@@ -835,11 +884,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **204** – no error +- - **500** – server error ++ - **200** – no error ++ - **204** – no error ++ - **500** – server error + +-### Display system-wide information: ++#### [Display system-wide information](#id31) + + `GET `{.descname}`/info`{.descname} + : Display system-wide information +@@ -865,10 +914,10 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Show the docker version information: ++#### [Show the docker version information](#id32) + + `GET `{.descname}`/version`{.descname} + : Show the docker version information +@@ -890,10 +939,10 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Create a new image from a container’s changes: ++#### [Create a new image from a container’s changes](#id33) + + `POST `{.descname}`/commit`{.descname} + : Create a new image from a container’s changes +@@ -919,41 +968,41 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **container** – source container +- - **repo** – repository +- - **tag** – tag +- - **m** – commit message +- - **author** – author (eg. “John Hannibal Smith ++ - **container** – source container ++ - **repo** – repository ++ - **tag** – tag ++ - **m** – commit message ++ - **author** – author (eg. “John Hannibal Smith + \<[hannibal@a-team.com](mailto:hannibal%40a-team.com)\>”) + + Status Codes: + +- - **201** – no error +- - **404** – no such container +- - **500** – server error ++ - **201** – no error ++ - **404** – no such container ++ - **500** – server error + +-## Going Further ++## [3. Going further](#id34) + +-### Inside ‘docker run’ ++### [3.1 Inside ‘docker run’](#id35) + + Here are the steps of ‘docker run’ : + +-- Create the container ++- Create the container + +-- If the status code is 404, it means the image doesn’t exists: +- : - Try to pull it +- - Then retry to create the container ++- If the status code is 404, it means the image doesn’t exists: ++ : - Try to pull it ++ - Then retry to create the container + +-- Start the container ++- Start the container + +-- If you are not in detached mode: +- : - Attach to the container, using logs=1 (to have stdout and ++- If you are not in detached mode: ++ : - Attach to the container, using logs=1 (to have stdout and + stderr from the container’s start) and stream=1 + +-- If in detached mode or only stdin is attached: +- : - Display the container’s id ++- If in detached mode or only stdin is attached: ++ : - Display the container’s id + +-### Hijacking ++### [3.2 Hijacking](#id36) + + In this version of the API, /attach uses hijacking to transport stdin, + stdout and stderr on the same socket. This might change in the future. +diff --git a/docs/sources/reference/api/docker_remote_api_v1.10.md b/docs/sources/reference/api/docker_remote_api_v1.10.md +index b6aa5bc..2a99f72 100644 +--- a/docs/sources/reference/api/docker_remote_api_v1.10.md ++++ b/docs/sources/reference/api/docker_remote_api_v1.10.md +@@ -2,24 +2,80 @@ page_title: Remote API v1.10 + page_description: API Documentation for Docker + page_keywords: API, Docker, rcli, REST, documentation + +-# Docker Remote API v1.10 +- +-## Introduction +- +-- The Remote API has replaced rcli +-- The daemon listens on `unix:///var/run/docker.sock`{.docutils ++# [Docker Remote API v1.10](#id1) ++ ++Table of Contents ++ ++- [Docker Remote API v1.10](#docker-remote-api-v1-10) ++ - [1. Brief introduction](#brief-introduction) ++ - [2. Endpoints](#endpoints) ++ - [2.1 Containers](#containers) ++ - [List containers](#list-containers) ++ - [Create a container](#create-a-container) ++ - [Inspect a container](#inspect-a-container) ++ - [List processes running inside a ++ container](#list-processes-running-inside-a-container) ++ - [Inspect changes on a container’s ++ filesystem](#inspect-changes-on-a-container-s-filesystem) ++ - [Export a container](#export-a-container) ++ - [Start a container](#start-a-container) ++ - [Stop a container](#stop-a-container) ++ - [Restart a container](#restart-a-container) ++ - [Kill a container](#kill-a-container) ++ - [Attach to a container](#attach-to-a-container) ++ - [Wait a container](#wait-a-container) ++ - [Remove a container](#remove-a-container) ++ - [Copy files or folders from a ++ container](#copy-files-or-folders-from-a-container) ++ - [2.2 Images](#images) ++ - [List Images](#list-images) ++ - [Create an image](#create-an-image) ++ - [Insert a file in an image](#insert-a-file-in-an-image) ++ - [Inspect an image](#inspect-an-image) ++ - [Get the history of an ++ image](#get-the-history-of-an-image) ++ - [Push an image on the ++ registry](#push-an-image-on-the-registry) ++ - [Tag an image into a ++ repository](#tag-an-image-into-a-repository) ++ - [Remove an image](#remove-an-image) ++ - [Search images](#search-images) ++ - [2.3 Misc](#misc) ++ - [Build an image from Dockerfile via ++ stdin](#build-an-image-from-dockerfile-via-stdin) ++ - [Check auth configuration](#check-auth-configuration) ++ - [Display system-wide ++ information](#display-system-wide-information) ++ - [Show the docker version ++ information](#show-the-docker-version-information) ++ - [Create a new image from a container’s ++ changes](#create-a-new-image-from-a-container-s-changes) ++ - [Monitor Docker’s events](#monitor-docker-s-events) ++ - [Get a tarball containing all images and tags in a ++ repository](#get-a-tarball-containing-all-images-and-tags-in-a-repository) ++ - [Load a tarball with a set of images and tags into ++ docker](#load-a-tarball-with-a-set-of-images-and-tags-into-docker) ++ - [3. Going further](#going-further) ++ - [3.1 Inside ‘docker run’](#inside-docker-run) ++ - [3.2 Hijacking](#hijacking) ++ - [3.3 CORS Requests](#cors-requests) ++ ++## [1. Brief introduction](#id2) ++ ++- The Remote API has replaced rcli ++- The daemon listens on `unix:///var/run/docker.sock`{.docutils + .literal}, but you can [*Bind Docker to another host/port or a Unix + socket*](../../../use/basics/#bind-docker). +-- The API tends to be REST, but for some complex commands, like ++- The API tends to be REST, but for some complex commands, like + `attach` or `pull`{.docutils .literal}, the HTTP + connection is hijacked to transport `stdout, stdin`{.docutils + .literal} and `stderr` + +-## Endpoints ++## [2. Endpoints](#id3) + +-### Containers ++### [2.1 Containers](#id4) + +-### List containers: ++#### [List containers](#id5) + + `GET `{.descname}`/containers/json`{.descname} + : List containers +@@ -80,24 +136,24 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **all** – 1/True/true or 0/False/false, Show all containers. ++ - **all** – 1/True/true or 0/False/false, Show all containers. + Only running containers are shown by default +- - **limit** – Show `limit` last created ++ - **limit** – Show `limit` last created + containers, include non-running ones. +- - **since** – Show only containers created since Id, include ++ - **since** – Show only containers created since Id, include + non-running ones. +- - **before** – Show only containers created before Id, include ++ - **before** – Show only containers created before Id, include + non-running ones. +- - **size** – 1/True/true or 0/False/false, Show the containers ++ - **size** – 1/True/true or 0/False/false, Show the containers + sizes + + Status Codes: + +- - **200** – no error +- - **400** – bad parameter +- - **500** – server error ++ - **200** – no error ++ - **400** – bad parameter ++ - **500** – server error + +-### Create a container: ++#### [Create a container](#id6) + + `POST `{.descname}`/containers/create`{.descname} + : Create a container +@@ -130,6 +186,7 @@ page_keywords: API, Docker, rcli, REST, documentation + }, + "VolumesFrom":"", + "WorkingDir":"", ++ "DisableNetwork": false, + "ExposedPorts":{ + "22/tcp": {} + } +@@ -149,23 +206,23 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **config** – the container’s configuration ++ - **config** – the container’s configuration + + Query Parameters: + +   + +- - **name** – Assign the specified name to the container. Must ++ - **name** – Assign the specified name to the container. Must + match `/?[a-zA-Z0-9_-]+`. + + Status Codes: + +- - **201** – no error +- - **404** – no such container +- - **406** – impossible to attach (container not running) +- - **500** – server error ++ - **201** – no error ++ - **404** – no such container ++ - **406** – impossible to attach (container not running) ++ - **500** – server error + +-### Inspect a container: ++#### [Inspect a container](#id7) + + `GET `{.descname}`/containers/`{.descname}(*id*)`/json`{.descname} + : Return low-level information on the container `id`{.docutils +@@ -246,11 +303,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-### List processes running inside a container: ++#### [List processes running inside a container](#id8) + + `GET `{.descname}`/containers/`{.descname}(*id*)`/top`{.descname} + : List processes running inside the container `id` +@@ -288,15 +345,15 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **ps\_args** – ps arguments to use (eg. aux) ++ - **ps\_args** – ps arguments to use (eg. aux) + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Inspect changes on a container’s filesystem: ++#### [Inspect changes on a container’s filesystem](#id9) + + `GET `{.descname}`/containers/`{.descname}(*id*)`/changes`{.descname} + : Inspect changes on container `id` ‘s filesystem +@@ -327,11 +384,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Export a container: ++#### [Export a container](#id10) + + `GET `{.descname}`/containers/`{.descname}(*id*)`/export`{.descname} + : Export the contents of container `id` +@@ -349,11 +406,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Start a container: ++#### [Start a container](#id11) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/start`{.descname} + : Start the container `id` +@@ -380,15 +437,15 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **hostConfig** – the container’s host configuration (optional) ++ - **hostConfig** – the container’s host configuration (optional) + + Status Codes: + +- - **204** – no error +- - **404** – no such container +- - **500** – server error ++ - **204** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Stop a container: ++#### [Stop a container](#id12) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/stop`{.descname} + : Stop the container `id` +@@ -405,15 +462,15 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **t** – number of seconds to wait before killing the container ++ - **t** – number of seconds to wait before killing the container + + Status Codes: + +- - **204** – no error +- - **404** – no such container +- - **500** – server error ++ - **204** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Restart a container: ++#### [Restart a container](#id13) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/restart`{.descname} + : Restart the container `id` +@@ -430,15 +487,15 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **t** – number of seconds to wait before killing the container ++ - **t** – number of seconds to wait before killing the container + + Status Codes: + +- - **204** – no error +- - **404** – no such container +- - **500** – server error ++ - **204** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Kill a container: ++#### [Kill a container](#id14) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/kill`{.descname} + : Kill the container `id` +@@ -453,11 +510,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **204** – no error +- - **404** – no such container +- - **500** – server error ++ - **204** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Attach to a container: ++#### [Attach to a container](#id15) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/attach`{.descname} + : Attach to the container `id` +@@ -477,23 +534,23 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **logs** – 1/True/true or 0/False/false, return logs. Default ++ - **logs** – 1/True/true or 0/False/false, return logs. Default + false +- - **stream** – 1/True/true or 0/False/false, return stream. ++ - **stream** – 1/True/true or 0/False/false, return stream. + Default false +- - **stdin** – 1/True/true or 0/False/false, if stream=true, attach ++ - **stdin** – 1/True/true or 0/False/false, if stream=true, attach + to stdin. Default false +- - **stdout** – 1/True/true or 0/False/false, if logs=true, return ++ - **stdout** – 1/True/true or 0/False/false, if logs=true, return + stdout log, if stream=true, attach to stdout. Default false +- - **stderr** – 1/True/true or 0/False/false, if logs=true, return ++ - **stderr** – 1/True/true or 0/False/false, if logs=true, return + stderr log, if stream=true, attach to stderr. Default false + + Status Codes: + +- - **200** – no error +- - **400** – bad parameter +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **400** – bad parameter ++ - **404** – no such container ++ - **500** – server error + + **Stream details**: + +@@ -518,9 +575,9 @@ page_keywords: API, Docker, rcli, REST, documentation + + `STREAM_TYPE` can be: + +- - 0: stdin (will be writen on stdout) +- - 1: stdout +- - 2: stderr ++ - 0: stdin (will be writen on stdout) ++ - 1: stdout ++ - 2: stderr + + `SIZE1, SIZE2, SIZE3, SIZE4` are the 4 bytes of + the uint32 size encoded as big endian. +@@ -539,7 +596,7 @@ page_keywords: API, Docker, rcli, REST, documentation + 4. Read the extracted size and output it on the correct output + 5. Goto 1) + +-### Wait a container: ++#### [Wait a container](#id16) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/wait`{.descname} + : Block until container `id` stops, then returns +@@ -558,11 +615,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Remove a container: ++#### [Remove a container](#id17) + + `DELETE `{.descname}`/containers/`{.descname}(*id*) + : Remove the container `id` from the filesystem +@@ -579,17 +636,19 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **v** – 1/True/true or 0/False/false, Remove the volumes ++ - **v** – 1/True/true or 0/False/false, Remove the volumes + associated to the container. Default false ++ - **force** – 1/True/true or 0/False/false, Removes the container ++ even if it was running. Default false + + Status Codes: + +- - **204** – no error +- - **400** – bad parameter +- - **404** – no such container +- - **500** – server error ++ - **204** – no error ++ - **400** – bad parameter ++ - **404** – no such container ++ - **500** – server error + +-### Copy files or folders from a container: ++#### [Copy files or folders from a container](#id18) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/copy`{.descname} + : Copy files or folders of container `id` +@@ -612,13 +671,13 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-## Images ++### [2.2 Images](#id19) + +-### List images: ++#### [List Images](#id20) + + `GET `{.descname}`/images/json`{.descname} + : **Example request**: +@@ -655,7 +714,7 @@ page_keywords: API, Docker, rcli, REST, documentation + } + ] + +-### Create an image: ++#### [Create an image](#id21) + + `POST `{.descname}`/images/create`{.descname} + : Create an image, either by pull it from the registry or by importing +@@ -683,24 +742,24 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **fromImage** – name of the image to pull +- - **fromSrc** – source to import, - means stdin +- - **repo** – repository +- - **tag** – tag +- - **registry** – the registry to pull from ++ - **fromImage** – name of the image to pull ++ - **fromSrc** – source to import, - means stdin ++ - **repo** – repository ++ - **tag** – tag ++ - **registry** – the registry to pull from + + Request Headers: + +   + +- - **X-Registry-Auth** – base64-encoded AuthConfig object ++ - **X-Registry-Auth** – base64-encoded AuthConfig object + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Insert a file in an image: ++#### [Insert a file in an image](#id22) + + `POST `{.descname}`/images/`{.descname}(*name*)`/insert`{.descname} + : Insert a file from `url` in the image +@@ -722,10 +781,10 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Inspect an image: ++#### [Inspect an image](#id23) + + `GET `{.descname}`/images/`{.descname}(*name*)`/json`{.descname} + : Return low-level information on the image `name` +@@ -770,11 +829,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such image +- - **500** – server error ++ - **200** – no error ++ - **404** – no such image ++ - **500** – server error + +-### Get the history of an image: ++#### [Get the history of an image](#id24) + + `GET `{.descname}`/images/`{.descname}(*name*)`/history`{.descname} + : Return the history of the image `name` +@@ -803,11 +862,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such image +- - **500** – server error ++ - **200** – no error ++ - **404** – no such image ++ - **500** – server error + +-### Push an image on the registry: ++#### [Push an image on the registry](#id25) + + `POST `{.descname}`/images/`{.descname}(*name*)`/push`{.descname} + : Push the image `name` on the registry +@@ -830,22 +889,22 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **registry** – the registry you wan to push, optional ++ - **registry** – the registry you wan to push, optional + + Request Headers: + +   + +- - **X-Registry-Auth** – include a base64-encoded AuthConfig ++ - **X-Registry-Auth** – include a base64-encoded AuthConfig + object. + + Status Codes: + +- - **200** – no error +- - **404** – no such image +- - **500** – server error ++ - **200** – no error ++ - **404** – no such image ++ - **500** – server error + +-### Tag an image into a repository: ++#### [Tag an image into a repository](#id26) + + `POST `{.descname}`/images/`{.descname}(*name*)`/tag`{.descname} + : Tag the image `name` into a repository +@@ -862,18 +921,18 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **repo** – The repository to tag in +- - **force** – 1/True/true or 0/False/false, default false ++ - **repo** – The repository to tag in ++ - **force** – 1/True/true or 0/False/false, default false + + Status Codes: + +- - **201** – no error +- - **400** – bad parameter +- - **404** – no such image +- - **409** – conflict +- - **500** – server error ++ - **201** – no error ++ - **400** – bad parameter ++ - **404** – no such image ++ - **409** – conflict ++ - **500** – server error + +-### Remove an image: ++#### [Remove an image](#id27) + + `DELETE `{.descname}`/images/`{.descname}(*name*) + : Remove the image `name` from the filesystem +@@ -897,16 +956,17 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **force** – 1/True/true or 0/False/false, default false ++ - **force** – 1/True/true or 0/False/false, default false ++ - **noprune** – 1/True/true or 0/False/false, default false + + Status Codes: + +- - **200** – no error +- - **404** – no such image +- - **409** – conflict +- - **500** – server error ++ - **200** – no error ++ - **404** – no such image ++ - **409** – conflict ++ - **500** – server error + +-### Search images: ++#### [Search images](#id28) + + `GET `{.descname}`/images/search`{.descname} + : Search for an image in the docker index. +@@ -954,16 +1014,16 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **term** – term to search ++ - **term** – term to search + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-## Misc ++### [2.3 Misc](#id29) + +-### Build an image from Dockerfile via stdin: ++#### [Build an image from Dockerfile via stdin](#id30) + + `POST `{.descname}`/build`{.descname} + : Build an image from Dockerfile via stdin +@@ -995,25 +1055,25 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **t** – repository name (and optionally a tag) to be applied to ++ - **t** – repository name (and optionally a tag) to be applied to + the resulting image in case of success +- - **q** – suppress verbose build output +- - **nocache** – do not use the cache when building the image ++ - **q** – suppress verbose build output ++ - **nocache** – do not use the cache when building the image + + Request Headers: + +   + +- - **Content-type** – should be set to ++ - **Content-type** – should be set to + `"application/tar"`. +- - **X-Registry-Config** – base64-encoded ConfigFile object ++ - **X-Registry-Config** – base64-encoded ConfigFile object + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Check auth configuration: ++#### [Check auth configuration](#id31) + + `POST `{.descname}`/auth`{.descname} + : Get the default username and email +@@ -1036,11 +1096,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **204** – no error +- - **500** – server error ++ - **200** – no error ++ - **204** – no error ++ - **500** – server error + +-### Display system-wide information: ++#### [Display system-wide information](#id32) + + `GET `{.descname}`/info`{.descname} + : Display system-wide information +@@ -1067,10 +1127,10 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Show the docker version information: ++#### [Show the docker version information](#id33) + + `GET `{.descname}`/version`{.descname} + : Show the docker version information +@@ -1092,10 +1152,10 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Create a new image from a container’s changes: ++#### [Create a new image from a container’s changes](#id34) + + `POST `{.descname}`/commit`{.descname} + : Create a new image from a container’s changes +@@ -1115,22 +1175,22 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **container** – source container +- - **repo** – repository +- - **tag** – tag +- - **m** – commit message +- - **author** – author (eg. “John Hannibal Smith ++ - **container** – source container ++ - **repo** – repository ++ - **tag** – tag ++ - **m** – commit message ++ - **author** – author (eg. “John Hannibal Smith + \<[hannibal@a-team.com](mailto:hannibal%40a-team.com)\>”) +- - **run** – config automatically applied when the image is run. ++ - **run** – config automatically applied when the image is run. + (ex: {“Cmd”: [“cat”, “/world”], “PortSpecs”:[“22”]}) + + Status Codes: + +- - **201** – no error +- - **404** – no such container +- - **500** – server error ++ - **201** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Monitor Docker’s events: ++#### [Monitor Docker’s events](#id35) + + `GET `{.descname}`/events`{.descname} + : Get events from docker, either in real time via streaming, or via +@@ -1154,14 +1214,14 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **since** – timestamp used for polling ++ - **since** – timestamp used for polling + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Get a tarball containing all images and tags in a repository: ++#### [Get a tarball containing all images and tags in a repository](#id36) + + `GET `{.descname}`/images/`{.descname}(*name*)`/get`{.descname} + : Get a tarball containing all images and metadata for the repository +@@ -1180,10 +1240,10 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Load a tarball with a set of images and tags into docker: ++#### [Load a tarball with a set of images and tags into docker](#id37) + + `POST `{.descname}`/images/load`{.descname} + : Load a set of images and tags into the docker repository. +@@ -1200,38 +1260,38 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-## Going Further ++## [3. Going further](#id38) + +-### Inside ‘docker run’ ++### [3.1 Inside ‘docker run’](#id39) + + Here are the steps of ‘docker run’ : + +-- Create the container ++- Create the container + +-- If the status code is 404, it means the image doesn’t exists: +- : - Try to pull it +- - Then retry to create the container ++- If the status code is 404, it means the image doesn’t exists: ++ : - Try to pull it ++ - Then retry to create the container + +-- Start the container ++- Start the container + +-- If you are not in detached mode: +- : - Attach to the container, using logs=1 (to have stdout and ++- If you are not in detached mode: ++ : - Attach to the container, using logs=1 (to have stdout and + stderr from the container’s start) and stream=1 + +-- If in detached mode or only stdin is attached: +- : - Display the container’s id ++- If in detached mode or only stdin is attached: ++ : - Display the container’s id + +-### Hijacking ++### [3.2 Hijacking](#id40) + + In this version of the API, /attach, uses hijacking to transport stdin, + stdout and stderr on the same socket. This might change in the future. + +-### CORS Requests ++### [3.3 CORS Requests](#id41) + + To enable cross origin requests to the remote api add the flag +-“-api-enable-cors” when running docker in daemon mode. ++“–api-enable-cors” when running docker in daemon mode. + +- docker -d -H="192.168.1.9:4243" -api-enable-cors ++ docker -d -H="192.168.1.9:4243" --api-enable-cors +diff --git a/docs/sources/reference/api/docker_remote_api_v1.2.md b/docs/sources/reference/api/docker_remote_api_v1.2.md +index 5a70c94..b11bce6 100644 +--- a/docs/sources/reference/api/docker_remote_api_v1.2.md ++++ b/docs/sources/reference/api/docker_remote_api_v1.2.md +@@ -2,21 +2,68 @@ page_title: Remote API v1.2 + page_description: API Documentation for Docker + page_keywords: API, Docker, rcli, REST, documentation + +-# Docker Remote API v1.2 +- +-## Introduction +- +-- The Remote API is replacing rcli +-- Default port in the docker daemon is 4243 +-- The API tends to be REST, but for some complex commands, like attach ++# [Docker Remote API v1.2](#id1) ++ ++Table of Contents ++ ++- [Docker Remote API v1.2](#docker-remote-api-v1-2) ++ - [1. Brief introduction](#brief-introduction) ++ - [2. Endpoints](#endpoints) ++ - [2.1 Containers](#containers) ++ - [List containers](#list-containers) ++ - [Create a container](#create-a-container) ++ - [Inspect a container](#inspect-a-container) ++ - [Inspect changes on a container’s ++ filesystem](#inspect-changes-on-a-container-s-filesystem) ++ - [Export a container](#export-a-container) ++ - [Start a container](#start-a-container) ++ - [Stop a container](#stop-a-container) ++ - [Restart a container](#restart-a-container) ++ - [Kill a container](#kill-a-container) ++ - [Attach to a container](#attach-to-a-container) ++ - [Wait a container](#wait-a-container) ++ - [Remove a container](#remove-a-container) ++ - [2.2 Images](#images) ++ - [List Images](#list-images) ++ - [Create an image](#create-an-image) ++ - [Insert a file in an image](#insert-a-file-in-an-image) ++ - [Inspect an image](#inspect-an-image) ++ - [Get the history of an ++ image](#get-the-history-of-an-image) ++ - [Push an image on the ++ registry](#push-an-image-on-the-registry) ++ - [Tag an image into a ++ repository](#tag-an-image-into-a-repository) ++ - [Remove an image](#remove-an-image) ++ - [Search images](#search-images) ++ - [2.3 Misc](#misc) ++ - [Build an image from Dockerfile via ++ stdin](#build-an-image-from-dockerfile-via-stdin) ++ - [Check auth configuration](#check-auth-configuration) ++ - [Display system-wide ++ information](#display-system-wide-information) ++ - [Show the docker version ++ information](#show-the-docker-version-information) ++ - [Create a new image from a container’s ++ changes](#create-a-new-image-from-a-container-s-changes) ++ - [3. Going further](#going-further) ++ - [3.1 Inside ‘docker run’](#inside-docker-run) ++ - [3.2 Hijacking](#hijacking) ++ - [3.3 CORS Requests](#cors-requests) ++ ++## [1. Brief introduction](#id2) ++ ++- The Remote API is replacing rcli ++- Default port in the docker daemon 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 + +-## Endpoints ++## [2. Endpoints](#id3) + +-### Containers ++### [2.1 Containers](#id4) + +-### List containers: ++#### [List containers](#id5) + + `GET `{.descname}`/containers/json`{.descname} + : List containers +@@ -77,22 +124,22 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **all** – 1/True/true or 0/False/false, Show all containers. ++ - **all** – 1/True/true or 0/False/false, Show all containers. + Only running containers are shown by default +- - **limit** – Show `limit` last created ++ - **limit** – Show `limit` last created + containers, include non-running ones. +- - **since** – Show only containers created since Id, include ++ - **since** – Show only containers created since Id, include + non-running ones. +- - **before** – Show only containers created before Id, include ++ - **before** – Show only containers created before Id, include + non-running ones. + + Status Codes: + +- - **200** – no error +- - **400** – bad parameter +- - **500** – server error ++ - **200** – no error ++ - **400** – bad parameter ++ - **500** – server error + +-### Create a container: ++#### [Create a container](#id6) + + `POST `{.descname}`/containers/create`{.descname} + : Create a container +@@ -138,16 +185,16 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **config** – the container’s configuration ++ - **config** – the container’s configuration + + Status Codes: + +- - **201** – no error +- - **404** – no such container +- - **406** – impossible to attach (container not running) +- - **500** – server error ++ - **201** – no error ++ - **404** – no such container ++ - **406** – impossible to attach (container not running) ++ - **500** – server error + +-### Inspect a container: ++#### [Inspect a container](#id7) + + `GET `{.descname}`/containers/`{.descname}(*id*)`/json`{.descname} + : Return low-level information on the container `id`{.docutils +@@ -210,11 +257,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Inspect changes on a container’s filesystem:] ++#### [Inspect changes on a container’s filesystem](#id8) + + `GET `{.descname}`/containers/`{.descname}(*id*)`/changes`{.descname} + : Inspect changes on container `id` ‘s filesystem +@@ -245,11 +292,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Export a container: ++#### [Export a container](#id9) + + `GET `{.descname}`/containers/`{.descname}(*id*)`/export`{.descname} + : Export the contents of container `id` +@@ -267,11 +314,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Start a container: ++#### [Start a container](#id10) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/start`{.descname} + : Start the container `id` +@@ -286,11 +333,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Stop a container: ++#### [Stop a container](#id11) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/stop`{.descname} + : Stop the container `id` +@@ -307,15 +354,15 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **t** – number of seconds to wait before killing the container ++ - **t** – number of seconds to wait before killing the container + + Status Codes: + +- - **204** – no error +- - **404** – no such container +- - **500** – server error ++ - **204** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Restart a container: ++#### [Restart a container](#id12) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/restart`{.descname} + : Restart the container `id` +@@ -332,15 +379,15 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **t** – number of seconds to wait before killing the container ++ - **t** – number of seconds to wait before killing the container + + Status Codes: + +- - **204** – no error +- - **404** – no such container +- - **500** – server error ++ - **204** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Kill a container: ++#### [Kill a container](#id13) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/kill`{.descname} + : Kill the container `id` +@@ -355,11 +402,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **204** – no error +- - **404** – no such container +- - **500** – server error ++ - **204** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Attach to a container: ++#### [Attach to a container](#id14) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/attach`{.descname} + : Attach to the container `id` +@@ -379,25 +426,25 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **logs** – 1/True/true or 0/False/false, return logs. Default ++ - **logs** – 1/True/true or 0/False/false, return logs. Default + false +- - **stream** – 1/True/true or 0/False/false, return stream. ++ - **stream** – 1/True/true or 0/False/false, return stream. + Default false +- - **stdin** – 1/True/true or 0/False/false, if stream=true, attach ++ - **stdin** – 1/True/true or 0/False/false, if stream=true, attach + to stdin. Default false +- - **stdout** – 1/True/true or 0/False/false, if logs=true, return ++ - **stdout** – 1/True/true or 0/False/false, if logs=true, return + stdout log, if stream=true, attach to stdout. Default false +- - **stderr** – 1/True/true or 0/False/false, if logs=true, return ++ - **stderr** – 1/True/true or 0/False/false, if logs=true, return + stderr log, if stream=true, attach to stderr. Default false + + Status Codes: + +- - **200** – no error +- - **400** – bad parameter +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **400** – bad parameter ++ - **404** – no such container ++ - **500** – server error + +-### Wait a container: ++#### [Wait a container](#id15) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/wait`{.descname} + : Block until container `id` stops, then returns +@@ -416,11 +463,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Remove a container: ++#### [Remove a container](#id16) + + `DELETE `{.descname}`/containers/`{.descname}(*id*) + : Remove the container `id` from the filesystem +@@ -437,19 +484,19 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **v** – 1/True/true or 0/False/false, Remove the volumes ++ - **v** – 1/True/true or 0/False/false, Remove the volumes + associated to the container. Default false + + Status Codes: + +- - **204** – no error +- - **400** – bad parameter +- - **404** – no such container +- - **500** – server error ++ - **204** – no error ++ - **400** – bad parameter ++ - **404** – no such container ++ - **500** – server error + +-## Images ++### [2.2 Images](#id17) + +-### List images: ++#### [List Images](#id18) + + `GET `{.descname}`/images/`{.descname}(*format*) + : List images `format` could be json or viz (json +@@ -514,16 +561,16 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **all** – 1/True/true or 0/False/false, Show all containers. ++ - **all** – 1/True/true or 0/False/false, Show all containers. + Only running containers are shown by default + + Status Codes: + +- - **200** – no error +- - **400** – bad parameter +- - **500** – server error ++ - **200** – no error ++ - **400** – bad parameter ++ - **500** – server error + +-### Create an image: ++#### [Create an image](#id19) + + `POST `{.descname}`/images/create`{.descname} + : Create an image, either by pull it from the registry or by importing +@@ -547,18 +594,18 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **fromImage** – name of the image to pull +- - **fromSrc** – source to import, - means stdin +- - **repo** – repository +- - **tag** – tag +- - **registry** – the registry to pull from ++ - **fromImage** – name of the image to pull ++ - **fromSrc** – source to import, - means stdin ++ - **repo** – repository ++ - **tag** – tag ++ - **registry** – the registry to pull from + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Insert a file in an image: ++#### [Insert a file in an image](#id20) + + `POST `{.descname}`/images/`{.descname}(*name*)`/insert`{.descname} + : Insert a file from `url` in the image +@@ -580,10 +627,10 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Inspect an image: ++#### [Inspect an image](#id21) + + `GET `{.descname}`/images/`{.descname}(*name*)`/json`{.descname} + : Return low-level information on the image `name` +@@ -627,11 +674,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such image +- - **500** – server error ++ - **200** – no error ++ - **404** – no such image ++ - **500** – server error + +-### Get the history of an image: ++#### [Get the history of an image](#id22) + + `GET `{.descname}`/images/`{.descname}(*name*)`/history`{.descname} + : Return the history of the image `name` +@@ -661,11 +708,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such image +- - **500** – server error ++ - **200** – no error ++ - **404** – no such image ++ - **500** – server error + +-### Push an image on the registry: ++#### [Push an image on the registry](#id23) + + `POST `{.descname}`/images/`{.descname}(*name*)`/push`{.descname} + : Push the image `name` on the registry +@@ -689,15 +736,15 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **registry** – the registry you wan to push, optional ++ - **registry** – the registry you wan to push, optional + + Status Codes: + +- - **200** – no error +- - **404** – no such image +- - **500** – server error ++ - **200** – no error ++ - **404** – no such image ++ - **500** – server error + +-### Tag an image into a repository: ++#### [Tag an image into a repository](#id24) + + `POST `{.descname}`/images/`{.descname}(*name*)`/tag`{.descname} + : Tag the image `name` into a repository +@@ -714,18 +761,18 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **repo** – The repository to tag in +- - **force** – 1/True/true or 0/False/false, default false ++ - **repo** – The repository to tag in ++ - **force** – 1/True/true or 0/False/false, default false + + Status Codes: + +- - **201** – no error +- - **400** – bad parameter +- - **404** – no such image +- - **409** – conflict +- - **500** – server error ++ - **201** – no error ++ - **400** – bad parameter ++ - **404** – no such image ++ - **409** – conflict ++ - **500** – server error + +-### Remove an image: ++#### [Remove an image](#id25) + + `DELETE `{.descname}`/images/`{.descname}(*name*) + : Remove the image `name` from the filesystem +@@ -747,12 +794,12 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **204** – no error +- - **404** – no such image +- - **409** – conflict +- - **500** – server error ++ - **204** – no error ++ - **404** – no such image ++ - **409** – conflict ++ - **500** – server error + +-### Search images: ++#### [Search images](#id26) + + `GET `{.descname}`/images/search`{.descname} + : Search for an image in the docker index +@@ -785,9 +832,9 @@ page_keywords: API, Docker, rcli, REST, documentation + :statuscode 200: no error + :statuscode 500: server error + +-## Misc ++### [2.3 Misc](#id27) + +-### Build an image from Dockerfile via stdin: ++#### [Build an image from Dockerfile via stdin](#id28) + + `POST `{.descname}`/build`{.descname} + : Build an image from Dockerfile +@@ -808,19 +855,19 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **t** – repository name to be applied to the resulting image in ++ - **t** – repository name to be applied to the resulting image in + case of success +- - **remote** – resource to fetch, as URI ++ - **remote** – resource to fetch, as URI + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + + {{ STREAM }} is the raw text output of the build command. It uses the + HTTP Hijack method in order to stream. + +-### Check auth configuration: ++#### [Check auth configuration](#id29) + + `POST `{.descname}`/auth`{.descname} + : Get the default username and email +@@ -847,13 +894,13 @@ HTTP Hijack method in order to stream. + + Status Codes: + +- - **200** – no error +- - **204** – no error +- - **401** – unauthorized +- - **403** – forbidden +- - **500** – server error ++ - **200** – no error ++ - **204** – no error ++ - **401** – unauthorized ++ - **403** – forbidden ++ - **500** – server error + +-### Display system-wide information: ++#### [Display system-wide information](#id30) + + `GET `{.descname}`/info`{.descname} + : Display system-wide information +@@ -879,10 +926,10 @@ HTTP Hijack method in order to stream. + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Show the docker version information: ++#### [Show the docker version information](#id31) + + `GET `{.descname}`/version`{.descname} + : Show the docker version information +@@ -904,10 +951,10 @@ HTTP Hijack method in order to stream. + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Create a new image from a container’s changes: ++#### [Create a new image from a container’s changes](#id32) + + `POST `{.descname}`/commit`{.descname} + : Create a new image from a container’s changes +@@ -933,49 +980,49 @@ HTTP Hijack method in order to stream. + +   + +- - **container** – source container +- - **repo** – repository +- - **tag** – tag +- - **m** – commit message +- - **author** – author (eg. “John Hannibal Smith ++ - **container** – source container ++ - **repo** – repository ++ - **tag** – tag ++ - **m** – commit message ++ - **author** – author (eg. “John Hannibal Smith + \<[hannibal@a-team.com](mailto:hannibal%40a-team.com)\>”) + + Status Codes: + +- - **201** – no error +- - **404** – no such container +- - **500** – server error ++ - **201** – no error ++ - **404** – no such container ++ - **500** – server error + +-## Going Further ++## [3. Going further](#id33) + +-### Inside ‘docker run’ ++### [3.1 Inside ‘docker run’](#id34) + + Here are the steps of ‘docker run’ : + +-- Create the container ++- Create the container + +-- If the status code is 404, it means the image doesn’t exists: +- : - Try to pull it +- - Then retry to create the container ++- If the status code is 404, it means the image doesn’t exists: ++ : - Try to pull it ++ - Then retry to create the container + +-- Start the container ++- Start the container + +-- If you are not in detached mode: +- : - Attach to the container, using logs=1 (to have stdout and ++- If you are not in detached mode: ++ : - Attach to the container, using logs=1 (to have stdout and + stderr from the container’s start) and stream=1 + +-- If in detached mode or only stdin is attached: +- : - Display the container’s id ++- If in detached mode or only stdin is attached: ++ : - Display the container’s id + +-### Hijacking ++### [3.2 Hijacking](#id35) + + In this version of the API, /attach, uses hijacking to transport stdin, + stdout and stderr on the same socket. This might change in the future. + +-### CORS Requests ++### [3.3 CORS Requests](#id36) + + To enable cross origin requests to the remote api add the flag +-“-api-enable-cors” when running docker in daemon mode. ++“–api-enable-cors” when running docker in daemon mode. + + > docker -d -H=”[tcp://192.168.1.9:4243](tcp://192.168.1.9:4243)” +-> -api-enable-cors ++> –api-enable-cors +diff --git a/docs/sources/reference/api/docker_remote_api_v1.3.md b/docs/sources/reference/api/docker_remote_api_v1.3.md +index 7e0e6bd..4203699 100644 +--- a/docs/sources/reference/api/docker_remote_api_v1.3.md ++++ b/docs/sources/reference/api/docker_remote_api_v1.3.md +@@ -2,74 +2,71 @@ page_title: Remote API v1.3 + page_description: API Documentation for Docker + page_keywords: API, Docker, rcli, REST, documentation + +-# Docker Remote API v1.3 ++# [Docker Remote API v1.3](#id1) + + Table of Contents + +-- [Docker Remote API v1.3](#docker-remote-api-v1-3) +- - [1. Brief introduction](#brief-introduction) +- - [2. Endpoints](#endpoints) +- - [2.1 Containers](#containers) +- - [List containers](#list-containers) +- - [Create a container](#create-a-container) +- - [Inspect a container](#inspect-a-container) +- - [List processes running inside a ++- [Docker Remote API v1.3](#docker-remote-api-v1-3) ++ - [1. Brief introduction](#brief-introduction) ++ - [2. Endpoints](#endpoints) ++ - [2.1 Containers](#containers) ++ - [List containers](#list-containers) ++ - [Create a container](#create-a-container) ++ - [Inspect a container](#inspect-a-container) ++ - [List processes running inside a + container](#list-processes-running-inside-a-container) +- - [Inspect changes on a container’s ++ - [Inspect changes on a container’s + filesystem](#inspect-changes-on-a-container-s-filesystem) +- - [Export a container](#export-a-container) +- - [Start a container](#start-a-container) +- - [Stop a container](#stop-a-container) +- - [Restart a container](#restart-a-container) +- - [Kill a container](#kill-a-container) +- - [Attach to a container](#attach-to-a-container) +- - [Wait a container](#wait-a-container) +- - [Remove a container](#remove-a-container) +- +- - [2.2 Images](#images) +- - [List Images](#list-images) +- - [Create an image](#create-an-image) +- - [Insert a file in an image](#insert-a-file-in-an-image) +- - [Inspect an image](#inspect-an-image) +- - [Get the history of an ++ - [Export a container](#export-a-container) ++ - [Start a container](#start-a-container) ++ - [Stop a container](#stop-a-container) ++ - [Restart a container](#restart-a-container) ++ - [Kill a container](#kill-a-container) ++ - [Attach to a container](#attach-to-a-container) ++ - [Wait a container](#wait-a-container) ++ - [Remove a container](#remove-a-container) ++ - [2.2 Images](#images) ++ - [List Images](#list-images) ++ - [Create an image](#create-an-image) ++ - [Insert a file in an image](#insert-a-file-in-an-image) ++ - [Inspect an image](#inspect-an-image) ++ - [Get the history of an + image](#get-the-history-of-an-image) +- - [Push an image on the ++ - [Push an image on the + registry](#push-an-image-on-the-registry) +- - [Tag an image into a ++ - [Tag an image into a + repository](#tag-an-image-into-a-repository) +- - [Remove an image](#remove-an-image) +- - [Search images](#search-images) +- +- - [2.3 Misc](#misc) +- - [Build an image from Dockerfile via ++ - [Remove an image](#remove-an-image) ++ - [Search images](#search-images) ++ - [2.3 Misc](#misc) ++ - [Build an image from Dockerfile via + stdin](#build-an-image-from-dockerfile-via-stdin) +- - [Check auth configuration](#check-auth-configuration) +- - [Display system-wide ++ - [Check auth configuration](#check-auth-configuration) ++ - [Display system-wide + information](#display-system-wide-information) +- - [Show the docker version ++ - [Show the docker version + information](#show-the-docker-version-information) +- - [Create a new image from a container’s ++ - [Create a new image from a container’s + changes](#create-a-new-image-from-a-container-s-changes) +- - [Monitor Docker’s events](#monitor-docker-s-events) +- +- - [3. Going further](#going-further) +- - [3.1 Inside ‘docker run’](#inside-docker-run) +- - [3.2 Hijacking](#hijacking) +- - [3.3 CORS Requests](#cors-requests) ++ - [Monitor Docker’s events](#monitor-docker-s-events) ++ - [3. Going further](#going-further) ++ - [3.1 Inside ‘docker run’](#inside-docker-run) ++ - [3.2 Hijacking](#hijacking) ++ - [3.3 CORS Requests](#cors-requests) + +-## Introduction ++## [1. Brief introduction](#id2) + +-- The Remote API is replacing rcli +-- Default port in the docker daemon is 4243 +-- The API tends to be REST, but for some complex commands, like attach ++- The Remote API is replacing rcli ++- Default port in the docker daemon 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 + +-## Endpoints ++## [2. Endpoints](#id3) + +-### Containers ++### [2.1 Containers](#id4) + +-### List containers: ++#### [List containers](#id5) + + `GET `{.descname}`/containers/json`{.descname} + : List containers +@@ -130,24 +127,24 @@ Table of Contents + +   + +- - **all** – 1/True/true or 0/False/false, Show all containers. ++ - **all** – 1/True/true or 0/False/false, Show all containers. + Only running containers are shown by default +- - **limit** – Show `limit` last created ++ - **limit** – Show `limit` last created + containers, include non-running ones. +- - **since** – Show only containers created since Id, include ++ - **since** – Show only containers created since Id, include + non-running ones. +- - **before** – Show only containers created before Id, include ++ - **before** – Show only containers created before Id, include + non-running ones. +- - **size** – 1/True/true or 0/False/false, Show the containers ++ - **size** – 1/True/true or 0/False/false, Show the containers + sizes + + Status Codes: + +- - **200** – no error +- - **400** – bad parameter +- - **500** – server error ++ - **200** – no error ++ - **400** – bad parameter ++ - **500** – server error + +-### Create a container: ++#### [Create a container](#id6) + + `POST `{.descname}`/containers/create`{.descname} + : Create a container +@@ -193,16 +190,16 @@ Table of Contents + +   + +- - **config** – the container’s configuration ++ - **config** – the container’s configuration + + Status Codes: + +- - **201** – no error +- - **404** – no such container +- - **406** – impossible to attach (container not running) +- - **500** – server error ++ - **201** – no error ++ - **404** – no such container ++ - **406** – impossible to attach (container not running) ++ - **500** – server error + +-### Inspect a container: ++#### [Inspect a container](#id7) + + `GET `{.descname}`/containers/`{.descname}(*id*)`/json`{.descname} + : Return low-level information on the container `id`{.docutils +@@ -265,11 +262,11 @@ Table of Contents + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-### List processes running inside a container: ++#### [List processes running inside a container](#id8) + + `GET `{.descname}`/containers/`{.descname}(*id*)`/top`{.descname} + : List processes running inside the container `id` +@@ -300,11 +297,11 @@ Table of Contents + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Inspect changes on a container’s filesystem: ++#### [Inspect changes on a container’s filesystem](#id9) + + `GET `{.descname}`/containers/`{.descname}(*id*)`/changes`{.descname} + : Inspect changes on container `id` ‘s filesystem +@@ -335,11 +332,11 @@ Table of Contents + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Export a container: ++#### [Export a container](#id10) + + `GET `{.descname}`/containers/`{.descname}(*id*)`/export`{.descname} + : Export the contents of container `id` +@@ -357,11 +354,11 @@ Table of Contents + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Start a container: ++#### [Start a container](#id11) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/start`{.descname} + : Start the container `id` +@@ -384,15 +381,15 @@ Table of Contents + +   + +- - **hostConfig** – the container’s host configuration (optional) ++ - **hostConfig** – the container’s host configuration (optional) + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Stop a container: ++#### [Stop a container](#id12) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/stop`{.descname} + : Stop the container `id` +@@ -409,15 +406,15 @@ Table of Contents + +   + +- - **t** – number of seconds to wait before killing the container ++ - **t** – number of seconds to wait before killing the container + + Status Codes: + +- - **204** – no error +- - **404** – no such container +- - **500** – server error ++ - **204** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Restart a container: ++#### [Restart a container](#id13) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/restart`{.descname} + : Restart the container `id` +@@ -434,15 +431,15 @@ Table of Contents + +   + +- - **t** – number of seconds to wait before killing the container ++ - **t** – number of seconds to wait before killing the container + + Status Codes: + +- - **204** – no error +- - **404** – no such container +- - **500** – server error ++ - **204** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Kill a container: ++#### [Kill a container](#id14) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/kill`{.descname} + : Kill the container `id` +@@ -457,11 +454,11 @@ Table of Contents + + Status Codes: + +- - **204** – no error +- - **404** – no such container +- - **500** – server error ++ - **204** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Attach to a container: ++#### [Attach to a container](#id15) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/attach`{.descname} + : Attach to the container `id` +@@ -481,25 +478,25 @@ Table of Contents + +   + +- - **logs** – 1/True/true or 0/False/false, return logs. Default ++ - **logs** – 1/True/true or 0/False/false, return logs. Default + false +- - **stream** – 1/True/true or 0/False/false, return stream. ++ - **stream** – 1/True/true or 0/False/false, return stream. + Default false +- - **stdin** – 1/True/true or 0/False/false, if stream=true, attach ++ - **stdin** – 1/True/true or 0/False/false, if stream=true, attach + to stdin. Default false +- - **stdout** – 1/True/true or 0/False/false, if logs=true, return ++ - **stdout** – 1/True/true or 0/False/false, if logs=true, return + stdout log, if stream=true, attach to stdout. Default false +- - **stderr** – 1/True/true or 0/False/false, if logs=true, return ++ - **stderr** – 1/True/true or 0/False/false, if logs=true, return + stderr log, if stream=true, attach to stderr. Default false + + Status Codes: + +- - **200** – no error +- - **400** – bad parameter +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **400** – bad parameter ++ - **404** – no such container ++ - **500** – server error + +-### Wait a container: ++#### [Wait a container](#id16) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/wait`{.descname} + : Block until container `id` stops, then returns +@@ -518,11 +515,11 @@ Table of Contents + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Remove a container: ++#### [Remove a container](#id17) + + `DELETE `{.descname}`/containers/`{.descname}(*id*) + : Remove the container `id` from the filesystem +@@ -539,19 +536,19 @@ Table of Contents + +   + +- - **v** – 1/True/true or 0/False/false, Remove the volumes ++ - **v** – 1/True/true or 0/False/false, Remove the volumes + associated to the container. Default false + + Status Codes: + +- - **204** – no error +- - **400** – bad parameter +- - **404** – no such container +- - **500** – server error ++ - **204** – no error ++ - **400** – bad parameter ++ - **404** – no such container ++ - **500** – server error + +-## Images ++### [2.2 Images](#id18) + +-### List images: ++#### [List Images](#id19) + + `GET `{.descname}`/images/`{.descname}(*format*) + : List images `format` could be json or viz (json +@@ -616,16 +613,16 @@ Table of Contents + +   + +- - **all** – 1/True/true or 0/False/false, Show all containers. ++ - **all** – 1/True/true or 0/False/false, Show all containers. + Only running containers are shown by default + + Status Codes: + +- - **200** – no error +- - **400** – bad parameter +- - **500** – server error ++ - **200** – no error ++ - **400** – bad parameter ++ - **500** – server error + +-### Create an image: ++#### [Create an image](#id20) + + `POST `{.descname}`/images/create`{.descname} + : Create an image, either by pull it from the registry or by importing +@@ -649,18 +646,18 @@ Table of Contents + +   + +- - **fromImage** – name of the image to pull +- - **fromSrc** – source to import, - means stdin +- - **repo** – repository +- - **tag** – tag +- - **registry** – the registry to pull from ++ - **fromImage** – name of the image to pull ++ - **fromSrc** – source to import, - means stdin ++ - **repo** – repository ++ - **tag** – tag ++ - **registry** – the registry to pull from + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Insert a file in an image: ++#### [Insert a file in an image](#id21) + + `POST `{.descname}`/images/`{.descname}(*name*)`/insert`{.descname} + : Insert a file from `url` in the image +@@ -682,10 +679,10 @@ Table of Contents + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Inspect an image: ++#### [Inspect an image](#id22) + + `GET `{.descname}`/images/`{.descname}(*name*)`/json`{.descname} + : Return low-level information on the image `name` +@@ -729,11 +726,11 @@ Table of Contents + + Status Codes: + +- - **200** – no error +- - **404** – no such image +- - **500** – server error ++ - **200** – no error ++ - **404** – no such image ++ - **500** – server error + +-### Get the history of an image: ++#### [Get the history of an image](#id23) + + `GET `{.descname}`/images/`{.descname}(*name*)`/history`{.descname} + : Return the history of the image `name` +@@ -762,11 +759,11 @@ Table of Contents + + Status Codes: + +- - **200** – no error +- - **404** – no such image +- - **500** – server error ++ - **200** – no error ++ - **404** – no such image ++ - **500** – server error + +-### Push an image on the registry: ++#### [Push an image on the registry](#id24) + + `POST `{.descname}`/images/`{.descname}(*name*)`/push`{.descname} + : Push the image `name` on the registry +@@ -790,15 +787,15 @@ Table of Contents + +   + +- - **registry** – the registry you wan to push, optional ++ - **registry** – the registry you wan to push, optional + + Status Codes: + +- - **200** – no error +- - **404** – no such image +- - **500** – server error ++ - **200** – no error ++ - **404** – no such image ++ - **500** – server error + +-### Tag an image into a repository: ++#### [Tag an image into a repository](#id25) + + `POST `{.descname}`/images/`{.descname}(*name*)`/tag`{.descname} + : Tag the image `name` into a repository +@@ -815,18 +812,18 @@ Table of Contents + +   + +- - **repo** – The repository to tag in +- - **force** – 1/True/true or 0/False/false, default false ++ - **repo** – The repository to tag in ++ - **force** – 1/True/true or 0/False/false, default false + + Status Codes: + +- - **201** – no error +- - **400** – bad parameter +- - **404** – no such image +- - **409** – conflict +- - **500** – server error ++ - **201** – no error ++ - **400** – bad parameter ++ - **404** – no such image ++ - **409** – conflict ++ - **500** – server error + +-### Remove an image: ++#### [Remove an image](#id26) + + `DELETE `{.descname}`/images/`{.descname}(*name*) + : Remove the image `name` from the filesystem +@@ -848,12 +845,12 @@ Table of Contents + + Status Codes: + +- - **200** – no error +- - **404** – no such image +- - **409** – conflict +- - **500** – server error ++ - **200** – no error ++ - **404** – no such image ++ - **409** – conflict ++ - **500** – server error + +-### Search images: ++#### [Search images](#id27) + + `GET `{.descname}`/images/search`{.descname} + : Search for an image in the docker index +@@ -886,9 +883,9 @@ Table of Contents + :statuscode 200: no error + :statuscode 500: server error + +-## Misc ++### [2.3 Misc](#id28) + +-### Build an image from Dockerfile via stdin: ++#### [Build an image from Dockerfile via stdin](#id29) + + `POST `{.descname}`/build`{.descname} + : Build an image from Dockerfile via stdin +@@ -917,16 +914,16 @@ Table of Contents + +   + +- - **t** – repository name (and optionally a tag) to be applied to ++ - **t** – repository name (and optionally a tag) to be applied to + the resulting image in case of success +- - **q** – suppress verbose build output ++ - **q** – suppress verbose build output + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Check auth configuration: ++#### [Check auth configuration](#id30) + + `POST `{.descname}`/auth`{.descname} + : Get the default username and email +@@ -948,11 +945,11 @@ Table of Contents + + Status Codes: + +- - **200** – no error +- - **204** – no error +- - **500** – server error ++ - **200** – no error ++ - **204** – no error ++ - **500** – server error + +-### Display system-wide information: ++#### [Display system-wide information](#id31) + + `GET `{.descname}`/info`{.descname} + : Display system-wide information +@@ -981,10 +978,10 @@ Table of Contents + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Show the docker version information: ++#### [Show the docker version information](#id32) + + `GET `{.descname}`/version`{.descname} + : Show the docker version information +@@ -1006,10 +1003,10 @@ Table of Contents + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Create a new image from a container’s changes: ++#### [Create a new image from a container’s changes](#id33) + + `POST `{.descname}`/commit`{.descname} + : Create a new image from a container’s changes +@@ -1035,20 +1032,20 @@ Table of Contents + +   + +- - **container** – source container +- - **repo** – repository +- - **tag** – tag +- - **m** – commit message +- - **author** – author (eg. “John Hannibal Smith ++ - **container** – source container ++ - **repo** – repository ++ - **tag** – tag ++ - **m** – commit message ++ - **author** – author (eg. “John Hannibal Smith + \<[hannibal@a-team.com](mailto:hannibal%40a-team.com)\>”) + + Status Codes: + +- - **201** – no error +- - **404** – no such container +- - **500** – server error ++ - **201** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Monitor Docker’s events: ++#### [Monitor Docker’s events](#id34) + + `GET `{.descname}`/events`{.descname} + : Get events from docker, either in real time via streaming, or via +@@ -1072,42 +1069,42 @@ Table of Contents + +   + +- - **since** – timestamp used for polling ++ - **since** – timestamp used for polling + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-## Going Further ++## [3. Going further](#id35) + +-### Inside ‘docker run’ ++### [3.1 Inside ‘docker run’](#id36) + + Here are the steps of ‘docker run’ : + +-- Create the container ++- Create the container + +-- If the status code is 404, it means the image doesn’t exists: +- : - Try to pull it +- - Then retry to create the container ++- If the status code is 404, it means the image doesn’t exists: ++ : - Try to pull it ++ - Then retry to create the container + +-- Start the container ++- Start the container + +-- If you are not in detached mode: +- : - Attach to the container, using logs=1 (to have stdout and ++- If you are not in detached mode: ++ : - Attach to the container, using logs=1 (to have stdout and + stderr from the container’s start) and stream=1 + +-- If in detached mode or only stdin is attached: +- : - Display the container’s id ++- If in detached mode or only stdin is attached: ++ : - Display the container’s id + +-### Hijacking ++### [3.2 Hijacking](#id37) + + In this version of the API, /attach, uses hijacking to transport stdin, + stdout and stderr on the same socket. This might change in the future. + +-### CORS Requests ++### [3.3 CORS Requests](#id38) + + To enable cross origin requests to the remote api add the flag +-“-api-enable-cors” when running docker in daemon mode. ++“–api-enable-cors” when running docker in daemon mode. + +-> docker -d -H=”192.168.1.9:4243” -api-enable-cors ++> docker -d -H=”192.168.1.9:4243” –api-enable-cors +diff --git a/docs/sources/reference/api/docker_remote_api_v1.4.md b/docs/sources/reference/api/docker_remote_api_v1.4.md +index f665b1e..4eca2a6 100644 +--- a/docs/sources/reference/api/docker_remote_api_v1.4.md ++++ b/docs/sources/reference/api/docker_remote_api_v1.4.md +@@ -2,21 +2,73 @@ page_title: Remote API v1.4 + page_description: API Documentation for Docker + page_keywords: API, Docker, rcli, REST, documentation + +-# Docker Remote API v1.4 +- +-## Introduction +- +-- The Remote API is replacing rcli +-- Default port in the docker daemon is 4243 +-- The API tends to be REST, but for some complex commands, like attach ++# [Docker Remote API v1.4](#id1) ++ ++Table of Contents ++ ++- [Docker Remote API v1.4](#docker-remote-api-v1-4) ++ - [1. Brief introduction](#brief-introduction) ++ - [2. Endpoints](#endpoints) ++ - [2.1 Containers](#containers) ++ - [List containers](#list-containers) ++ - [Create a container](#create-a-container) ++ - [Inspect a container](#inspect-a-container) ++ - [List processes running inside a ++ container](#list-processes-running-inside-a-container) ++ - [Inspect changes on a container’s ++ filesystem](#inspect-changes-on-a-container-s-filesystem) ++ - [Export a container](#export-a-container) ++ - [Start a container](#start-a-container) ++ - [Stop a container](#stop-a-container) ++ - [Restart a container](#restart-a-container) ++ - [Kill a container](#kill-a-container) ++ - [Attach to a container](#attach-to-a-container) ++ - [Wait a container](#wait-a-container) ++ - [Remove a container](#remove-a-container) ++ - [Copy files or folders from a ++ container](#copy-files-or-folders-from-a-container) ++ - [2.2 Images](#images) ++ - [List Images](#list-images) ++ - [Create an image](#create-an-image) ++ - [Insert a file in an image](#insert-a-file-in-an-image) ++ - [Inspect an image](#inspect-an-image) ++ - [Get the history of an ++ image](#get-the-history-of-an-image) ++ - [Push an image on the ++ registry](#push-an-image-on-the-registry) ++ - [Tag an image into a ++ repository](#tag-an-image-into-a-repository) ++ - [Remove an image](#remove-an-image) ++ - [Search images](#search-images) ++ - [2.3 Misc](#misc) ++ - [Build an image from Dockerfile via ++ stdin](#build-an-image-from-dockerfile-via-stdin) ++ - [Check auth configuration](#check-auth-configuration) ++ - [Display system-wide ++ information](#display-system-wide-information) ++ - [Show the docker version ++ information](#show-the-docker-version-information) ++ - [Create a new image from a container’s ++ changes](#create-a-new-image-from-a-container-s-changes) ++ - [Monitor Docker’s events](#monitor-docker-s-events) ++ - [3. Going further](#going-further) ++ - [3.1 Inside ‘docker run’](#inside-docker-run) ++ - [3.2 Hijacking](#hijacking) ++ - [3.3 CORS Requests](#cors-requests) ++ ++## [1. Brief introduction](#id2) ++ ++- The Remote API is replacing rcli ++- Default port in the docker daemon 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 + +-## Endpoints ++## [2. Endpoints](#id3) + +-### Containers ++### [2.1 Containers](#id4) + +-### List containers: ++#### [List containers](#id5) + + `GET `{.descname}`/containers/json`{.descname} + : List containers +@@ -77,24 +129,24 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **all** – 1/True/true or 0/False/false, Show all containers. ++ - **all** – 1/True/true or 0/False/false, Show all containers. + Only running containers are shown by default +- - **limit** – Show `limit` last created ++ - **limit** – Show `limit` last created + containers, include non-running ones. +- - **since** – Show only containers created since Id, include ++ - **since** – Show only containers created since Id, include + non-running ones. +- - **before** – Show only containers created before Id, include ++ - **before** – Show only containers created before Id, include + non-running ones. +- - **size** – 1/True/true or 0/False/false, Show the containers ++ - **size** – 1/True/true or 0/False/false, Show the containers + sizes + + Status Codes: + +- - **200** – no error +- - **400** – bad parameter +- - **500** – server error ++ - **200** – no error ++ - **400** – bad parameter ++ - **500** – server error + +-### Create a container: ++#### [Create a container](#id6) + + `POST `{.descname}`/containers/create`{.descname} + : Create a container +@@ -143,16 +195,16 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **config** – the container’s configuration ++ - **config** – the container’s configuration + + Status Codes: + +- - **201** – no error +- - **404** – no such container +- - **406** – impossible to attach (container not running) +- - **500** – server error ++ - **201** – no error ++ - **404** – no such container ++ - **406** – impossible to attach (container not running) ++ - **500** – server error + +-### Inspect a container: ++#### [Inspect a container](#id7) + + `GET `{.descname}`/containers/`{.descname}(*id*)`/json`{.descname} + : Return low-level information on the container `id`{.docutils +@@ -217,12 +269,12 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **409** – conflict between containers and images +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **409** – conflict between containers and images ++ - **500** – server error + +-### List processes running inside a container: ++#### [List processes running inside a container](#id8) + + `GET `{.descname}`/containers/`{.descname}(*id*)`/top`{.descname} + : List processes running inside the container `id` +@@ -260,15 +312,15 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **ps\_args** – ps arguments to use (eg. aux) ++ - **ps\_args** – ps arguments to use (eg. aux) + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Inspect changes on a container’s filesystem: ++#### [Inspect changes on a container’s filesystem](#id9) + + `GET `{.descname}`/containers/`{.descname}(*id*)`/changes`{.descname} + : Inspect changes on container `id` ‘s filesystem +@@ -299,11 +351,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Export a container: ++#### [Export a container](#id10) + + `GET `{.descname}`/containers/`{.descname}(*id*)`/export`{.descname} + : Export the contents of container `id` +@@ -321,11 +373,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Start a container: ++#### [Start a container](#id11) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/start`{.descname} + : Start the container `id` +@@ -349,15 +401,15 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **hostConfig** – the container’s host configuration (optional) ++ - **hostConfig** – the container’s host configuration (optional) + + Status Codes: + +- - **204** – no error +- - **404** – no such container +- - **500** – server error ++ - **204** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Stop a container: ++#### [Stop a container](#id12) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/stop`{.descname} + : Stop the container `id` +@@ -374,15 +426,15 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **t** – number of seconds to wait before killing the container ++ - **t** – number of seconds to wait before killing the container + + Status Codes: + +- - **204** – no error +- - **404** – no such container +- - **500** – server error ++ - **204** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Restart a container: ++#### [Restart a container](#id13) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/restart`{.descname} + : Restart the container `id` +@@ -399,15 +451,15 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **t** – number of seconds to wait before killing the container ++ - **t** – number of seconds to wait before killing the container + + Status Codes: + +- - **204** – no error +- - **404** – no such container +- - **500** – server error ++ - **204** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Kill a container: ++#### [Kill a container](#id14) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/kill`{.descname} + : Kill the container `id` +@@ -422,11 +474,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **204** – no error +- - **404** – no such container +- - **500** – server error ++ - **204** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Attach to a container: ++#### [Attach to a container](#id15) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/attach`{.descname} + : Attach to the container `id` +@@ -446,25 +498,25 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **logs** – 1/True/true or 0/False/false, return logs. Default ++ - **logs** – 1/True/true or 0/False/false, return logs. Default + false +- - **stream** – 1/True/true or 0/False/false, return stream. ++ - **stream** – 1/True/true or 0/False/false, return stream. + Default false +- - **stdin** – 1/True/true or 0/False/false, if stream=true, attach ++ - **stdin** – 1/True/true or 0/False/false, if stream=true, attach + to stdin. Default false +- - **stdout** – 1/True/true or 0/False/false, if logs=true, return ++ - **stdout** – 1/True/true or 0/False/false, if logs=true, return + stdout log, if stream=true, attach to stdout. Default false +- - **stderr** – 1/True/true or 0/False/false, if logs=true, return ++ - **stderr** – 1/True/true or 0/False/false, if logs=true, return + stderr log, if stream=true, attach to stderr. Default false + + Status Codes: + +- - **200** – no error +- - **400** – bad parameter +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **400** – bad parameter ++ - **404** – no such container ++ - **500** – server error + +-### Wait a container: ++#### [Wait a container](#id16) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/wait`{.descname} + : Block until container `id` stops, then returns +@@ -483,11 +535,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Remove a container: ++#### [Remove a container](#id17) + + `DELETE `{.descname}`/containers/`{.descname}(*id*) + : Remove the container `id` from the filesystem +@@ -504,17 +556,17 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **v** – 1/True/true or 0/False/false, Remove the volumes ++ - **v** – 1/True/true or 0/False/false, Remove the volumes + associated to the container. Default false + + Status Codes: + +- - **204** – no error +- - **400** – bad parameter +- - **404** – no such container +- - **500** – server error ++ - **204** – no error ++ - **400** – bad parameter ++ - **404** – no such container ++ - **500** – server error + +-### Copy files or folders from a container: ++#### [Copy files or folders from a container](#id18) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/copy`{.descname} + : Copy files or folders of container `id` +@@ -537,13 +589,13 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-## Images ++### [2.2 Images](#id19) + +-### List images: ++#### [List Images](#id20) + + `GET `{.descname}`/images/`{.descname}(*format*) + : List images `format` could be json or viz (json +@@ -608,16 +660,16 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **all** – 1/True/true or 0/False/false, Show all containers. ++ - **all** – 1/True/true or 0/False/false, Show all containers. + Only running containers are shown by default + + Status Codes: + +- - **200** – no error +- - **400** – bad parameter +- - **500** – server error ++ - **200** – no error ++ - **400** – bad parameter ++ - **500** – server error + +-### Create an image: ++#### [Create an image](#id21) + + `POST `{.descname}`/images/create`{.descname} + : Create an image, either by pull it from the registry or by importing +@@ -641,18 +693,18 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **fromImage** – name of the image to pull +- - **fromSrc** – source to import, - means stdin +- - **repo** – repository +- - **tag** – tag +- - **registry** – the registry to pull from ++ - **fromImage** – name of the image to pull ++ - **fromSrc** – source to import, - means stdin ++ - **repo** – repository ++ - **tag** – tag ++ - **registry** – the registry to pull from + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Insert a file in an image: ++#### [Insert a file in an image](#id22) + + `POST `{.descname}`/images/`{.descname}(*name*)`/insert`{.descname} + : Insert a file from `url` in the image +@@ -674,10 +726,10 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Inspect an image: ++#### [Inspect an image](#id23) + + `GET `{.descname}`/images/`{.descname}(*name*)`/json`{.descname} + : Return low-level information on the image `name` +@@ -722,12 +774,12 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such image +- - **409** – conflict between containers and images +- - **500** – server error ++ - **200** – no error ++ - **404** – no such image ++ - **409** – conflict between containers and images ++ - **500** – server error + +-### Get the history of an image: ++#### [Get the history of an image](#id24) + + `GET `{.descname}`/images/`{.descname}(*name*)`/history`{.descname} + : Return the history of the image `name` +@@ -756,11 +808,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such image +- - **500** – server error ++ - **200** – no error ++ - **404** – no such image ++ - **500** – server error + +-### Push an image on the registry: ++#### [Push an image on the registry](#id25) + + `POST `{.descname}`/images/`{.descname}(*name*)`/push`{.descname} + : Push the image `name` on the registry +@@ -782,14 +834,14 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **registry** – the registry you wan to push, optional ++ - **registry** – the registry you wan to push, optional + + Status Codes: + +- - **200** – no error :statuscode 404: no such image :statuscode ++ - **200** – no error :statuscode 404: no such image :statuscode + 500: server error + +-### Tag an image into a repository: ++#### [Tag an image into a repository](#id26) + + `POST `{.descname}`/images/`{.descname}(*name*)`/tag`{.descname} + : Tag the image `name` into a repository +@@ -806,18 +858,18 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **repo** – The repository to tag in +- - **force** – 1/True/true or 0/False/false, default false ++ - **repo** – The repository to tag in ++ - **force** – 1/True/true or 0/False/false, default false + + Status Codes: + +- - **201** – no error +- - **400** – bad parameter +- - **404** – no such image +- - **409** – conflict +- - **500** – server error ++ - **201** – no error ++ - **400** – bad parameter ++ - **404** – no such image ++ - **409** – conflict ++ - **500** – server error + +-### Remove an image: ++#### [Remove an image](#id27) + + `DELETE `{.descname}`/images/`{.descname}(*name*) + : Remove the image `name` from the filesystem +@@ -839,12 +891,12 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such image +- - **409** – conflict +- - **500** – server error ++ - **200** – no error ++ - **404** – no such image ++ - **409** – conflict ++ - **500** – server error + +-### Search images: ++#### [Search images](#id28) + + `GET `{.descname}`/images/search`{.descname} + : Search for an image in the docker index +@@ -877,9 +929,9 @@ page_keywords: API, Docker, rcli, REST, documentation + :statuscode 200: no error + :statuscode 500: server error + +-## Misc ++### [2.3 Misc](#id29) + +-### Build an image from Dockerfile via stdin: ++#### [Build an image from Dockerfile via stdin](#id30) + + `POST `{.descname}`/build`{.descname} + : Build an image from Dockerfile via stdin +@@ -908,17 +960,17 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **t** – repository name (and optionally a tag) to be applied to ++ - **t** – repository name (and optionally a tag) to be applied to + the resulting image in case of success +- - **q** – suppress verbose build output +- - **nocache** – do not use the cache when building the image ++ - **q** – suppress verbose build output ++ - **nocache** – do not use the cache when building the image + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Check auth configuration: ++#### [Check auth configuration](#id31) + + `POST `{.descname}`/auth`{.descname} + : Get the default username and email +@@ -941,11 +993,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **204** – no error +- - **500** – server error ++ - **200** – no error ++ - **204** – no error ++ - **500** – server error + +-### Display system-wide information: ++#### [Display system-wide information](#id32) + + `GET `{.descname}`/info`{.descname} + : Display system-wide information +@@ -972,10 +1024,10 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Show the docker version information: ++#### [Show the docker version information](#id33) + + `GET `{.descname}`/version`{.descname} + : Show the docker version information +@@ -997,10 +1049,10 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Create a new image from a container’s changes: ++#### [Create a new image from a container’s changes](#id34) + + `POST `{.descname}`/commit`{.descname} + : Create a new image from a container’s changes +@@ -1026,20 +1078,20 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **container** – source container +- - **repo** – repository +- - **tag** – tag +- - **m** – commit message +- - **author** – author (eg. “John Hannibal Smith ++ - **container** – source container ++ - **repo** – repository ++ - **tag** – tag ++ - **m** – commit message ++ - **author** – author (eg. “John Hannibal Smith + \<[hannibal@a-team.com](mailto:hannibal%40a-team.com)\>”) + + Status Codes: + +- - **201** – no error +- - **404** – no such container +- - **500** – server error ++ - **201** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Monitor Docker’s events: ++#### [Monitor Docker’s events](#id35) + + `GET `{.descname}`/events`{.descname} + : Get events from docker, either in real time via streaming, or via +@@ -1063,42 +1115,42 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **since** – timestamp used for polling ++ - **since** – timestamp used for polling + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-## Going Further ++## [3. Going further](#id36) + +-### Inside ‘docker run’ ++### [3.1 Inside ‘docker run’](#id37) + + Here are the steps of ‘docker run’ : + +-- Create the container ++- Create the container + +-- If the status code is 404, it means the image doesn’t exists: +- : - Try to pull it +- - Then retry to create the container ++- If the status code is 404, it means the image doesn’t exists: ++ : - Try to pull it ++ - Then retry to create the container + +-- Start the container ++- Start the container + +-- If you are not in detached mode: +- : - Attach to the container, using logs=1 (to have stdout and ++- If you are not in detached mode: ++ : - Attach to the container, using logs=1 (to have stdout and + stderr from the container’s start) and stream=1 + +-- If in detached mode or only stdin is attached: +- : - Display the container’s id ++- If in detached mode or only stdin is attached: ++ : - Display the container’s id + +-### Hijacking ++### [3.2 Hijacking](#id38) + + In this version of the API, /attach, uses hijacking to transport stdin, + stdout and stderr on the same socket. This might change in the future. + +-### CORS Requests ++### [3.3 CORS Requests](#id39) + + To enable cross origin requests to the remote api add the flag +-“-api-enable-cors” when running docker in daemon mode. ++“–api-enable-cors” when running docker in daemon mode. + +- docker -d -H="192.168.1.9:4243" -api-enable-cors ++ docker -d -H="192.168.1.9:4243" --api-enable-cors +diff --git a/docs/sources/reference/api/docker_remote_api_v1.5.md b/docs/sources/reference/api/docker_remote_api_v1.5.md +index d9c3542..ff11cd1 100644 +--- a/docs/sources/reference/api/docker_remote_api_v1.5.md ++++ b/docs/sources/reference/api/docker_remote_api_v1.5.md +@@ -2,21 +2,73 @@ page_title: Remote API v1.5 + page_description: API Documentation for Docker + page_keywords: API, Docker, rcli, REST, documentation + +-# Docker Remote API v1.5 +- +-## Introduction +- +-- The Remote API is replacing rcli +-- Default port in the docker daemon is 4243 +-- The API tends to be REST, but for some complex commands, like attach ++# [Docker Remote API v1.5](#id1) ++ ++Table of Contents ++ ++- [Docker Remote API v1.5](#docker-remote-api-v1-5) ++ - [1. Brief introduction](#brief-introduction) ++ - [2. Endpoints](#endpoints) ++ - [2.1 Containers](#containers) ++ - [List containers](#list-containers) ++ - [Create a container](#create-a-container) ++ - [Inspect a container](#inspect-a-container) ++ - [List processes running inside a ++ container](#list-processes-running-inside-a-container) ++ - [Inspect changes on a container’s ++ filesystem](#inspect-changes-on-a-container-s-filesystem) ++ - [Export a container](#export-a-container) ++ - [Start a container](#start-a-container) ++ - [Stop a container](#stop-a-container) ++ - [Restart a container](#restart-a-container) ++ - [Kill a container](#kill-a-container) ++ - [Attach to a container](#attach-to-a-container) ++ - [Wait a container](#wait-a-container) ++ - [Remove a container](#remove-a-container) ++ - [Copy files or folders from a ++ container](#copy-files-or-folders-from-a-container) ++ - [2.2 Images](#images) ++ - [List Images](#list-images) ++ - [Create an image](#create-an-image) ++ - [Insert a file in an image](#insert-a-file-in-an-image) ++ - [Inspect an image](#inspect-an-image) ++ - [Get the history of an ++ image](#get-the-history-of-an-image) ++ - [Push an image on the ++ registry](#push-an-image-on-the-registry) ++ - [Tag an image into a ++ repository](#tag-an-image-into-a-repository) ++ - [Remove an image](#remove-an-image) ++ - [Search images](#search-images) ++ - [2.3 Misc](#misc) ++ - [Build an image from Dockerfile via ++ stdin](#build-an-image-from-dockerfile-via-stdin) ++ - [Check auth configuration](#check-auth-configuration) ++ - [Display system-wide ++ information](#display-system-wide-information) ++ - [Show the docker version ++ information](#show-the-docker-version-information) ++ - [Create a new image from a container’s ++ changes](#create-a-new-image-from-a-container-s-changes) ++ - [Monitor Docker’s events](#monitor-docker-s-events) ++ - [3. Going further](#going-further) ++ - [3.1 Inside ‘docker run’](#inside-docker-run) ++ - [3.2 Hijacking](#hijacking) ++ - [3.3 CORS Requests](#cors-requests) ++ ++## [1. Brief introduction](#id2) ++ ++- The Remote API is replacing rcli ++- Default port in the docker daemon 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 + +-## Endpoints ++## [2. Endpoints](#id3) + +-### Containers ++### [2.1 Containers](#id4) + +-### List containers: ++#### [List containers](#id5) + + `GET `{.descname}`/containers/json`{.descname} + : List containers +@@ -77,24 +129,24 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **all** – 1/True/true or 0/False/false, Show all containers. ++ - **all** – 1/True/true or 0/False/false, Show all containers. + Only running containers are shown by default +- - **limit** – Show `limit` last created ++ - **limit** – Show `limit` last created + containers, include non-running ones. +- - **since** – Show only containers created since Id, include ++ - **since** – Show only containers created since Id, include + non-running ones. +- - **before** – Show only containers created before Id, include ++ - **before** – Show only containers created before Id, include + non-running ones. +- - **size** – 1/True/true or 0/False/false, Show the containers ++ - **size** – 1/True/true or 0/False/false, Show the containers + sizes + + Status Codes: + +- - **200** – no error +- - **400** – bad parameter +- - **500** – server error ++ - **200** – no error ++ - **400** – bad parameter ++ - **500** – server error + +-### Create a container: ++#### [Create a container](#id6) + + `POST `{.descname}`/containers/create`{.descname} + : Create a container +@@ -142,16 +194,16 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **config** – the container’s configuration ++ - **config** – the container’s configuration + + Status Codes: + +- - **201** – no error +- - **404** – no such container +- - **406** – impossible to attach (container not running) +- - **500** – server error ++ - **201** – no error ++ - **404** – no such container ++ - **406** – impossible to attach (container not running) ++ - **500** – server error + +-### Inspect a container: ++#### [Inspect a container](#id7) + + `GET `{.descname}`/containers/`{.descname}(*id*)`/json`{.descname} + : Return low-level information on the container `id`{.docutils +@@ -215,11 +267,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-### List processes running inside a container: ++#### [List processes running inside a container](#id8) + + `GET `{.descname}`/containers/`{.descname}(*id*)`/top`{.descname} + : List processes running inside the container `id` +@@ -257,15 +309,15 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **ps\_args** – ps arguments to use (eg. aux) ++ - **ps\_args** – ps arguments to use (eg. aux) + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Inspect changes on a container’s filesystem: ++#### [Inspect changes on a container’s filesystem](#id9) + + `GET `{.descname}`/containers/`{.descname}(*id*)`/changes`{.descname} + : Inspect changes on container `id` ‘s filesystem +@@ -296,11 +348,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Export a container: ++#### [Export a container](#id10) + + `GET `{.descname}`/containers/`{.descname}(*id*)`/export`{.descname} + : Export the contents of container `id` +@@ -318,11 +370,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Start a container: ++#### [Start a container](#id11) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/start`{.descname} + : Start the container `id` +@@ -346,15 +398,15 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **hostConfig** – the container’s host configuration (optional) ++ - **hostConfig** – the container’s host configuration (optional) + + Status Codes: + +- - **204** – no error +- - **404** – no such container +- - **500** – server error ++ - **204** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Stop a container: ++#### [Stop a container](#id12) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/stop`{.descname} + : Stop the container `id` +@@ -371,15 +423,15 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **t** – number of seconds to wait before killing the container ++ - **t** – number of seconds to wait before killing the container + + Status Codes: + +- - **204** – no error +- - **404** – no such container +- - **500** – server error ++ - **204** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Restart a container: ++#### [Restart a container](#id13) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/restart`{.descname} + : Restart the container `id` +@@ -396,15 +448,15 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **t** – number of seconds to wait before killing the container ++ - **t** – number of seconds to wait before killing the container + + Status Codes: + +- - **204** – no error +- - **404** – no such container +- - **500** – server error ++ - **204** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Kill a container: ++#### [Kill a container](#id14) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/kill`{.descname} + : Kill the container `id` +@@ -419,11 +471,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **204** – no error +- - **404** – no such container +- - **500** – server error ++ - **204** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Attach to a container: ++#### [Attach to a container](#id15) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/attach`{.descname} + : Attach to the container `id` +@@ -443,25 +495,25 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **logs** – 1/True/true or 0/False/false, return logs. Default ++ - **logs** – 1/True/true or 0/False/false, return logs. Default + false +- - **stream** – 1/True/true or 0/False/false, return stream. ++ - **stream** – 1/True/true or 0/False/false, return stream. + Default false +- - **stdin** – 1/True/true or 0/False/false, if stream=true, attach ++ - **stdin** – 1/True/true or 0/False/false, if stream=true, attach + to stdin. Default false +- - **stdout** – 1/True/true or 0/False/false, if logs=true, return ++ - **stdout** – 1/True/true or 0/False/false, if logs=true, return + stdout log, if stream=true, attach to stdout. Default false +- - **stderr** – 1/True/true or 0/False/false, if logs=true, return ++ - **stderr** – 1/True/true or 0/False/false, if logs=true, return + stderr log, if stream=true, attach to stderr. Default false + + Status Codes: + +- - **200** – no error +- - **400** – bad parameter +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **400** – bad parameter ++ - **404** – no such container ++ - **500** – server error + +-### Wait a container: ++#### [Wait a container](#id16) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/wait`{.descname} + : Block until container `id` stops, then returns +@@ -480,11 +532,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Remove a container: ++#### [Remove a container](#id17) + + `DELETE `{.descname}`/containers/`{.descname}(*id*) + : Remove the container `id` from the filesystem +@@ -501,17 +553,17 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **v** – 1/True/true or 0/False/false, Remove the volumes ++ - **v** – 1/True/true or 0/False/false, Remove the volumes + associated to the container. Default false + + Status Codes: + +- - **204** – no error +- - **400** – bad parameter +- - **404** – no such container +- - **500** – server error ++ - **204** – no error ++ - **400** – bad parameter ++ - **404** – no such container ++ - **500** – server error + +-### Copy files or folders from a container: ++#### [Copy files or folders from a container](#id18) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/copy`{.descname} + : Copy files or folders of container `id` +@@ -534,13 +586,13 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-## Images ++### [2.2 Images](#id19) + +-### List images: ++#### [List Images](#id20) + + `GET `{.descname}`/images/`{.descname}(*format*) + : List images `format` could be json or viz (json +@@ -605,16 +657,16 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **all** – 1/True/true or 0/False/false, Show all containers. ++ - **all** – 1/True/true or 0/False/false, Show all containers. + Only running containers are shown by default + + Status Codes: + +- - **200** – no error +- - **400** – bad parameter +- - **500** – server error ++ - **200** – no error ++ - **400** – bad parameter ++ - **500** – server error + +-### Create an image: ++#### [Create an image](#id21) + + `POST `{.descname}`/images/create`{.descname} + : Create an image, either by pull it from the registry or by importing +@@ -642,18 +694,18 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **fromImage** – name of the image to pull +- - **fromSrc** – source to import, - means stdin +- - **repo** – repository +- - **tag** – tag +- - **registry** – the registry to pull from ++ - **fromImage** – name of the image to pull ++ - **fromSrc** – source to import, - means stdin ++ - **repo** – repository ++ - **tag** – tag ++ - **registry** – the registry to pull from + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Insert a file in an image: ++#### [Insert a file in an image](#id22) + + `POST `{.descname}`/images/`{.descname}(*name*)`/insert`{.descname} + : Insert a file from `url` in the image +@@ -675,10 +727,10 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Inspect an image: ++#### [Inspect an image](#id23) + + `GET `{.descname}`/images/`{.descname}(*name*)`/json`{.descname} + : Return low-level information on the image `name` +@@ -723,11 +775,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such image +- - **500** – server error ++ - **200** – no error ++ - **404** – no such image ++ - **500** – server error + +-### Get the history of an image: ++#### [Get the history of an image](#id24) + + `GET `{.descname}`/images/`{.descname}(*name*)`/history`{.descname} + : Return the history of the image `name` +@@ -756,11 +808,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such image +- - **500** – server error ++ - **200** – no error ++ - **404** – no such image ++ - **500** – server error + +-### Push an image on the registry: ++#### [Push an image on the registry](#id25) + + `POST `{.descname}`/images/`{.descname}(*name*)`/push`{.descname} + : Push the image `name` on the registry +@@ -786,15 +838,15 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **registry** – the registry you wan to push, optional ++ - **registry** – the registry you wan to push, optional + + Status Codes: + +- - **200** – no error +- - **404** – no such image +- - **500** – server error ++ - **200** – no error ++ - **404** – no such image ++ - **500** – server error + +-### Tag an image into a repository: ++#### [Tag an image into a repository](#id26) + + `POST `{.descname}`/images/`{.descname}(*name*)`/tag`{.descname} + : Tag the image `name` into a repository +@@ -811,18 +863,18 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **repo** – The repository to tag in +- - **force** – 1/True/true or 0/False/false, default false ++ - **repo** – The repository to tag in ++ - **force** – 1/True/true or 0/False/false, default false + + Status Codes: + +- - **201** – no error +- - **400** – bad parameter +- - **404** – no such image +- - **409** – conflict +- - **500** – server error ++ - **201** – no error ++ - **400** – bad parameter ++ - **404** – no such image ++ - **409** – conflict ++ - **500** – server error + +-### Remove an image: ++#### [Remove an image](#id27) + + `DELETE `{.descname}`/images/`{.descname}(*name*) + : Remove the image `name` from the filesystem +@@ -844,12 +896,12 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such image +- - **409** – conflict +- - **500** – server error ++ - **200** – no error ++ - **404** – no such image ++ - **409** – conflict ++ - **500** – server error + +-### Search images: ++#### [Search images](#id28) + + `GET `{.descname}`/images/search`{.descname} + : Search for an image in the docker index +@@ -882,16 +934,16 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **term** – term to search ++ - **term** – term to search + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-## Misc ++### [2.3 Misc](#id29) + +-### Build an image from Dockerfile via stdin: ++#### [Build an image from Dockerfile via stdin](#id30) + + `POST `{.descname}`/build`{.descname} + : Build an image from Dockerfile via stdin +@@ -920,18 +972,18 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **t** – repository name (and optionally a tag) to be applied to ++ - **t** – repository name (and optionally a tag) to be applied to + the resulting image in case of success +- - **q** – suppress verbose build output +- - **nocache** – do not use the cache when building the image +- - **rm** – remove intermediate containers after a successful build ++ - **q** – suppress verbose build output ++ - **nocache** – do not use the cache when building the image ++ - **rm** – remove intermediate containers after a successful build + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Check auth configuration: ++#### [Check auth configuration](#id31) + + `POST `{.descname}`/auth`{.descname} + : Get the default username and email +@@ -954,11 +1006,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **204** – no error +- - **500** – server error ++ - **200** – no error ++ - **204** – no error ++ - **500** – server error + +-### Display system-wide information: ++#### [Display system-wide information](#id32) + + `GET `{.descname}`/info`{.descname} + : Display system-wide information +@@ -985,10 +1037,10 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Show the docker version information: ++#### [Show the docker version information](#id33) + + `GET `{.descname}`/version`{.descname} + : Show the docker version information +@@ -1010,10 +1062,10 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Create a new image from a container’s changes: ++#### [Create a new image from a container’s changes](#id34) + + `POST `{.descname}`/commit`{.descname} + : Create a new image from a container’s changes +@@ -1039,20 +1091,20 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **container** – source container +- - **repo** – repository +- - **tag** – tag +- - **m** – commit message +- - **author** – author (eg. “John Hannibal Smith ++ - **container** – source container ++ - **repo** – repository ++ - **tag** – tag ++ - **m** – commit message ++ - **author** – author (eg. “John Hannibal Smith + \<[hannibal@a-team.com](mailto:hannibal%40a-team.com)\>”) + + Status Codes: + +- - **201** – no error +- - **404** – no such container +- - **500** – server error ++ - **201** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Monitor Docker’s events: ++#### [Monitor Docker’s events](#id35) + + `GET `{.descname}`/events`{.descname} + : Get events from docker, either in real time via streaming, or via +@@ -1076,37 +1128,37 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **since** – timestamp used for polling ++ - **since** – timestamp used for polling + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-## Going Further ++## [3. Going further](#id36) + +-### Inside ‘docker run’ ++### [3.1 Inside ‘docker run’](#id37) + + Here are the steps of ‘docker run’ : + +-- Create the container +-- If the status code is 404, it means the image doesn’t exists: \* Try ++- Create the container ++- If the status code is 404, it means the image doesn’t exists: \* Try + to pull it \* Then retry to create the container +-- Start the container +-- If you are not in detached mode: \* Attach to the container, using ++- Start the container ++- If you are not in detached mode: \* Attach to the container, using + logs=1 (to have stdout and stderr from the container’s start) and + stream=1 +-- If in detached mode or only stdin is attached: \* Display the ++- If in detached mode or only stdin is attached: \* Display the + container’s id + +-### Hijacking ++### [3.2 Hijacking](#id38) + + In this version of the API, /attach, uses hijacking to transport stdin, + stdout and stderr on the same socket. This might change in the future. + +-### CORS Requests ++### [3.3 CORS Requests](#id39) + + To enable cross origin requests to the remote api add the flag +-“-api-enable-cors” when running docker in daemon mode. ++“–api-enable-cors” when running docker in daemon mode. + +- docker -d -H="192.168.1.9:4243" -api-enable-cors ++ docker -d -H="192.168.1.9:4243" --api-enable-cors +diff --git a/docs/sources/reference/api/docker_remote_api_v1.6.md b/docs/sources/reference/api/docker_remote_api_v1.6.md +index 4455608..fd6a650 100644 +--- a/docs/sources/reference/api/docker_remote_api_v1.6.md ++++ b/docs/sources/reference/api/docker_remote_api_v1.6.md +@@ -2,24 +2,76 @@ page_title: Remote API v1.6 + page_description: API Documentation for Docker + page_keywords: API, Docker, rcli, REST, documentation + +-# Docker Remote API v1.6 +- +-## Introduction +- +-- The Remote API has replaced rcli +-- The daemon listens on `unix:///var/run/docker.sock`{.docutils ++# [Docker Remote API v1.6](#id1) ++ ++Table of Contents ++ ++- [Docker Remote API v1.6](#docker-remote-api-v1-6) ++ - [1. Brief introduction](#brief-introduction) ++ - [2. Endpoints](#endpoints) ++ - [2.1 Containers](#containers) ++ - [List containers](#list-containers) ++ - [Create a container](#create-a-container) ++ - [Inspect a container](#inspect-a-container) ++ - [List processes running inside a ++ container](#list-processes-running-inside-a-container) ++ - [Inspect changes on a container’s ++ filesystem](#inspect-changes-on-a-container-s-filesystem) ++ - [Export a container](#export-a-container) ++ - [Start a container](#start-a-container) ++ - [Stop a container](#stop-a-container) ++ - [Restart a container](#restart-a-container) ++ - [Kill a container](#kill-a-container) ++ - [Attach to a container](#attach-to-a-container) ++ - [Wait a container](#wait-a-container) ++ - [Remove a container](#remove-a-container) ++ - [Copy files or folders from a ++ container](#copy-files-or-folders-from-a-container) ++ - [2.2 Images](#images) ++ - [List Images](#list-images) ++ - [Create an image](#create-an-image) ++ - [Insert a file in an image](#insert-a-file-in-an-image) ++ - [Inspect an image](#inspect-an-image) ++ - [Get the history of an ++ image](#get-the-history-of-an-image) ++ - [Push an image on the ++ registry](#push-an-image-on-the-registry) ++ - [Tag an image into a ++ repository](#tag-an-image-into-a-repository) ++ - [Remove an image](#remove-an-image) ++ - [Search images](#search-images) ++ - [2.3 Misc](#misc) ++ - [Build an image from Dockerfile via ++ stdin](#build-an-image-from-dockerfile-via-stdin) ++ - [Check auth configuration](#check-auth-configuration) ++ - [Display system-wide ++ information](#display-system-wide-information) ++ - [Show the docker version ++ information](#show-the-docker-version-information) ++ - [Create a new image from a container’s ++ changes](#create-a-new-image-from-a-container-s-changes) ++ - [Monitor Docker’s events](#monitor-docker-s-events) ++ - [3. Going further](#going-further) ++ - [3.1 Inside ‘docker run’](#inside-docker-run) ++ - [3.2 Hijacking](#hijacking) ++ - [3.3 CORS Requests](#cors-requests) ++ ++## [1. Brief introduction](#id2) ++ ++- The Remote API has replaced rcli ++- The daemon listens on `unix:///var/run/docker.sock`{.docutils + .literal}, but you can [*Bind Docker to another host/port or a Unix + socket*](../../../use/basics/#bind-docker). +-- The API tends to be REST, but for some complex commands, like ++- The API tends to be REST, but for some complex commands, like + `attach` or `pull`{.docutils .literal}, the HTTP + connection is hijacked to transport `stdout, stdin`{.docutils + .literal} and `stderr` + +-## Endpoints ++## [2. Endpoints](#id3) + +-### Containers ++### [2.1 Containers](#id4) + +-### List containers: ++#### [List containers](#id5) + + `GET `{.descname}`/containers/json`{.descname} + : List containers +@@ -80,24 +132,24 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **all** – 1/True/true or 0/False/false, Show all containers. ++ - **all** – 1/True/true or 0/False/false, Show all containers. + Only running containers are shown by default +- - **limit** – Show `limit` last created ++ - **limit** – Show `limit` last created + containers, include non-running ones. +- - **since** – Show only containers created since Id, include ++ - **since** – Show only containers created since Id, include + non-running ones. +- - **before** – Show only containers created before Id, include ++ - **before** – Show only containers created before Id, include + non-running ones. +- - **size** – 1/True/true or 0/False/false, Show the containers ++ - **size** – 1/True/true or 0/False/false, Show the containers + sizes + + Status Codes: + +- - **200** – no error +- - **400** – bad parameter +- - **500** – server error ++ - **200** – no error ++ - **400** – bad parameter ++ - **500** – server error + +-### Create a container: ++#### [Create a container](#id6) + + `POST `{.descname}`/containers/create`{.descname} + : Create a container +@@ -144,20 +196,20 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **config** – the container’s configuration ++ - **config** – the container’s configuration + + Query Parameters: + +   + +- - **name** – container name to use ++ - **name** – container name to use + + Status Codes: + +- - **201** – no error +- - **404** – no such container +- - **406** – impossible to attach (container not running) +- - **500** – server error ++ - **201** – no error ++ - **404** – no such container ++ - **406** – impossible to attach (container not running) ++ - **500** – server error + + **More Complex Example request, in 2 steps.** **First, use create to + expose a Private Port, which can be bound back to a Public Port at +@@ -202,7 +254,7 @@ page_keywords: API, Docker, rcli, REST, documentation + + **Now you can ssh into your new container on port 11022.** + +-### Inspect a container: ++#### [Inspect a container](#id7) + + `GET `{.descname}`/containers/`{.descname}(*id*)`/json`{.descname} + : Return low-level information on the container `id`{.docutils +@@ -267,11 +319,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-### List processes running inside a container: ++#### [List processes running inside a container](#id8) + + `GET `{.descname}`/containers/`{.descname}(*id*)`/top`{.descname} + : List processes running inside the container `id` +@@ -309,15 +361,15 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **ps\_args** – ps arguments to use (eg. aux) ++ - **ps\_args** – ps arguments to use (eg. aux) + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Inspect changes on a container’s filesystem: ++#### [Inspect changes on a container’s filesystem](#id9) + + `GET `{.descname}`/containers/`{.descname}(*id*)`/changes`{.descname} + : Inspect changes on container `id` ‘s filesystem +@@ -348,11 +400,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Export a container: ++#### [Export a container](#id10) + + `GET `{.descname}`/containers/`{.descname}(*id*)`/export`{.descname} + : Export the contents of container `id` +@@ -370,11 +422,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Start a container: ++#### [Start a container](#id11) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/start`{.descname} + : Start the container `id` +@@ -403,15 +455,15 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **hostConfig** – the container’s host configuration (optional) ++ - **hostConfig** – the container’s host configuration (optional) + + Status Codes: + +- - **204** – no error +- - **404** – no such container +- - **500** – server error ++ - **204** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Stop a container: ++#### [Stop a container](#id12) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/stop`{.descname} + : Stop the container `id` +@@ -428,15 +480,15 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **t** – number of seconds to wait before killing the container ++ - **t** – number of seconds to wait before killing the container + + Status Codes: + +- - **204** – no error +- - **404** – no such container +- - **500** – server error ++ - **204** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Restart a container: ++#### [Restart a container](#id13) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/restart`{.descname} + : Restart the container `id` +@@ -453,15 +505,15 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **t** – number of seconds to wait before killing the container ++ - **t** – number of seconds to wait before killing the container + + Status Codes: + +- - **204** – no error +- - **404** – no such container +- - **500** – server error ++ - **204** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Kill a container: ++#### [Kill a container](#id14) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/kill`{.descname} + : Kill the container `id` +@@ -478,17 +530,17 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **signal** – Signal to send to the container (integer). When not ++ - **signal** – Signal to send to the container (integer). When not + set, SIGKILL is assumed and the call will waits for the + container to exit. + + Status Codes: + +- - **204** – no error +- - **404** – no such container +- - **500** – server error ++ - **204** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Attach to a container: ++#### [Attach to a container](#id15) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/attach`{.descname} + : Attach to the container `id` +@@ -508,23 +560,23 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **logs** – 1/True/true or 0/False/false, return logs. Default ++ - **logs** – 1/True/true or 0/False/false, return logs. Default + false +- - **stream** – 1/True/true or 0/False/false, return stream. ++ - **stream** – 1/True/true or 0/False/false, return stream. + Default false +- - **stdin** – 1/True/true or 0/False/false, if stream=true, attach ++ - **stdin** – 1/True/true or 0/False/false, if stream=true, attach + to stdin. Default false +- - **stdout** – 1/True/true or 0/False/false, if logs=true, return ++ - **stdout** – 1/True/true or 0/False/false, if logs=true, return + stdout log, if stream=true, attach to stdout. Default false +- - **stderr** – 1/True/true or 0/False/false, if logs=true, return ++ - **stderr** – 1/True/true or 0/False/false, if logs=true, return + stderr log, if stream=true, attach to stderr. Default false + + Status Codes: + +- - **200** – no error +- - **400** – bad parameter +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **400** – bad parameter ++ - **404** – no such container ++ - **500** – server error + + **Stream details**: + +@@ -549,9 +601,9 @@ page_keywords: API, Docker, rcli, REST, documentation + + `STREAM_TYPE` can be: + +- - 0: stdin (will be writen on stdout) +- - 1: stdout +- - 2: stderr ++ - 0: stdin (will be writen on stdout) ++ - 1: stdout ++ - 2: stderr + + `SIZE1, SIZE2, SIZE3, SIZE4` are the 4 bytes of + the uint32 size encoded as big endian. +@@ -570,7 +622,7 @@ page_keywords: API, Docker, rcli, REST, documentation + 4. Read the extracted size and output it on the correct output + 5. Goto 1) + +-### Wait a container: ++#### [Wait a container](#id16) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/wait`{.descname} + : Block until container `id` stops, then returns +@@ -589,11 +641,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Remove a container: ++#### [Remove a container](#id17) + + `DELETE `{.descname}`/containers/`{.descname}(*id*) + : Remove the container `id` from the filesystem +@@ -610,17 +662,17 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **v** – 1/True/true or 0/False/false, Remove the volumes ++ - **v** – 1/True/true or 0/False/false, Remove the volumes + associated to the container. Default false + + Status Codes: + +- - **204** – no error +- - **400** – bad parameter +- - **404** – no such container +- - **500** – server error ++ - **204** – no error ++ - **400** – bad parameter ++ - **404** – no such container ++ - **500** – server error + +-### Copy files or folders from a container: ++#### [Copy files or folders from a container](#id18) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/copy`{.descname} + : Copy files or folders of container `id` +@@ -643,13 +695,13 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-## Images ++### [2.2 Images](#id19) + +-### List images: ++#### [List Images](#id20) + + `GET `{.descname}`/images/`{.descname}(*format*) + : List images `format` could be json or viz (json +@@ -714,16 +766,16 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **all** – 1/True/true or 0/False/false, Show all containers. ++ - **all** – 1/True/true or 0/False/false, Show all containers. + Only running containers are shown by default + + Status Codes: + +- - **200** – no error +- - **400** – bad parameter +- - **500** – server error ++ - **200** – no error ++ - **400** – bad parameter ++ - **500** – server error + +-### Create an image: ++#### [Create an image](#id21) + + `POST `{.descname}`/images/create`{.descname} + : Create an image, either by pull it from the registry or by importing +@@ -751,18 +803,18 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **fromImage** – name of the image to pull +- - **fromSrc** – source to import, - means stdin +- - **repo** – repository +- - **tag** – tag +- - **registry** – the registry to pull from ++ - **fromImage** – name of the image to pull ++ - **fromSrc** – source to import, - means stdin ++ - **repo** – repository ++ - **tag** – tag ++ - **registry** – the registry to pull from + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Insert a file in an image: ++#### [Insert a file in an image](#id22) + + `POST `{.descname}`/images/`{.descname}(*name*)`/insert`{.descname} + : Insert a file from `url` in the image +@@ -784,10 +836,10 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Inspect an image: ++#### [Inspect an image](#id23) + + `GET `{.descname}`/images/`{.descname}(*name*)`/json`{.descname} + : Return low-level information on the image `name` +@@ -832,11 +884,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such image +- - **500** – server error ++ - **200** – no error ++ - **404** – no such image ++ - **500** – server error + +-### Get the history of an image: ++#### [Get the history of an image](#id24) + + `GET `{.descname}`/images/`{.descname}(*name*)`/history`{.descname} + : Return the history of the image `name` +@@ -865,11 +917,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such image +- - **500** – server error ++ - **200** – no error ++ - **404** – no such image ++ - **500** – server error + +-### Push an image on the registry: ++#### [Push an image on the registry](#id25) + + `POST `{.descname}`/images/`{.descname}(*name*)`/push`{.descname} + : Push the image `name` on the registry +@@ -893,14 +945,14 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **registry** – the registry you wan to push, optional ++ - **registry** – the registry you wan to push, optional + + Status Codes: + +- - **200** – no error :statuscode 404: no such image :statuscode ++ - **200** – no error :statuscode 404: no such image :statuscode + 500: server error + +-### Tag an image into a repository: ++#### [Tag an image into a repository](#id26) + + `POST `{.descname}`/images/`{.descname}(*name*)`/tag`{.descname} + : Tag the image `name` into a repository +@@ -917,18 +969,18 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **repo** – The repository to tag in +- - **force** – 1/True/true or 0/False/false, default false ++ - **repo** – The repository to tag in ++ - **force** – 1/True/true or 0/False/false, default false + + Status Codes: + +- - **201** – no error +- - **400** – bad parameter +- - **404** – no such image +- - **409** – conflict +- - **500** – server error ++ - **201** – no error ++ - **400** – bad parameter ++ - **404** – no such image ++ - **409** – conflict ++ - **500** – server error + +-### Remove an image: ++#### [Remove an image](#id27) + + `DELETE `{.descname}`/images/`{.descname}(*name*) + : Remove the image `name` from the filesystem +@@ -950,12 +1002,12 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such image +- - **409** – conflict +- - **500** – server error ++ - **200** – no error ++ - **404** – no such image ++ - **409** – conflict ++ - **500** – server error + +-### Search images: ++#### [Search images](#id28) + + `GET `{.descname}`/images/search`{.descname} + : Search for an image in the docker index +@@ -988,9 +1040,9 @@ page_keywords: API, Docker, rcli, REST, documentation + :statuscode 200: no error + :statuscode 500: server error + +-## Misc ++### [2.3 Misc](#id29) + +-### Build an image from Dockerfile via stdin: ++#### [Build an image from Dockerfile via stdin](#id30) + + `POST `{.descname}`/build`{.descname} + : Build an image from Dockerfile via stdin +@@ -1019,17 +1071,17 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **t** – repository name (and optionally a tag) to be applied to ++ - **t** – repository name (and optionally a tag) to be applied to + the resulting image in case of success +- - **q** – suppress verbose build output +- - **nocache** – do not use the cache when building the image ++ - **q** – suppress verbose build output ++ - **nocache** – do not use the cache when building the image + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Check auth configuration: ++#### [Check auth configuration](#id31) + + `POST `{.descname}`/auth`{.descname} + : Get the default username and email +@@ -1052,11 +1104,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **204** – no error +- - **500** – server error ++ - **200** – no error ++ - **204** – no error ++ - **500** – server error + +-### Display system-wide information: ++#### [Display system-wide information](#id32) + + `GET `{.descname}`/info`{.descname} + : Display system-wide information +@@ -1083,10 +1135,10 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Show the docker version information: ++#### [Show the docker version information](#id33) + + `GET `{.descname}`/version`{.descname} + : Show the docker version information +@@ -1108,10 +1160,10 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Create a new image from a container’s changes: ++#### [Create a new image from a container’s changes](#id34) + + `POST `{.descname}`/commit`{.descname} + : Create a new image from a container’s changes +@@ -1137,20 +1189,20 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **container** – source container +- - **repo** – repository +- - **tag** – tag +- - **m** – commit message +- - **author** – author (eg. “John Hannibal Smith ++ - **container** – source container ++ - **repo** – repository ++ - **tag** – tag ++ - **m** – commit message ++ - **author** – author (eg. “John Hannibal Smith + \<[hannibal@a-team.com](mailto:hannibal%40a-team.com)\>”) + + Status Codes: + +- - **201** – no error +- - **404** – no such container +- - **500** – server error ++ - **201** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Monitor Docker’s events: ++#### [Monitor Docker’s events](#id35) + + `GET `{.descname}`/events`{.descname} + : Get events from docker, either in real time via streaming, or via +@@ -1174,42 +1226,42 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **since** – timestamp used for polling ++ - **since** – timestamp used for polling + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-## Going Further ++## [3. Going further](#id36) + +-### Inside ‘docker run’ ++### [3.1 Inside ‘docker run’](#id37) + + Here are the steps of ‘docker run’ : + +-- Create the container ++- Create the container + +-- If the status code is 404, it means the image doesn’t exists: +- : - Try to pull it +- - Then retry to create the container ++- If the status code is 404, it means the image doesn’t exists: ++ : - Try to pull it ++ - Then retry to create the container + +-- Start the container ++- Start the container + +-- If you are not in detached mode: +- : - Attach to the container, using logs=1 (to have stdout and ++- If you are not in detached mode: ++ : - Attach to the container, using logs=1 (to have stdout and + stderr from the container’s start) and stream=1 + +-- If in detached mode or only stdin is attached: +- : - Display the container’s id ++- If in detached mode or only stdin is attached: ++ : - Display the container’s id + +-### Hijacking ++### [3.2 Hijacking](#id38) + + In this version of the API, /attach, uses hijacking to transport stdin, + stdout and stderr on the same socket. This might change in the future. + +-### CORS Requests ++### [3.3 CORS Requests](#id39) + + To enable cross origin requests to the remote api add the flag +-“-api-enable-cors” when running docker in daemon mode. ++“–api-enable-cors” when running docker in daemon mode. + +- docker -d -H="192.168.1.9:4243" -api-enable-cors ++ docker -d -H="192.168.1.9:4243" --api-enable-cors +diff --git a/docs/sources/reference/api/docker_remote_api_v1.7.md b/docs/sources/reference/api/docker_remote_api_v1.7.md +index 1d1bd27..0c8c962 100644 +--- a/docs/sources/reference/api/docker_remote_api_v1.7.md ++++ b/docs/sources/reference/api/docker_remote_api_v1.7.md +@@ -2,24 +2,80 @@ page_title: Remote API v1.7 + page_description: API Documentation for Docker + page_keywords: API, Docker, rcli, REST, documentation + +-# Docker Remote API v1.7 +- +-## Introduction +- +-- The Remote API has replaced rcli +-- The daemon listens on `unix:///var/run/docker.sock`{.docutils ++# [Docker Remote API v1.7](#id1) ++ ++Table of Contents ++ ++- [Docker Remote API v1.7](#docker-remote-api-v1-7) ++ - [1. Brief introduction](#brief-introduction) ++ - [2. Endpoints](#endpoints) ++ - [2.1 Containers](#containers) ++ - [List containers](#list-containers) ++ - [Create a container](#create-a-container) ++ - [Inspect a container](#inspect-a-container) ++ - [List processes running inside a ++ container](#list-processes-running-inside-a-container) ++ - [Inspect changes on a container’s ++ filesystem](#inspect-changes-on-a-container-s-filesystem) ++ - [Export a container](#export-a-container) ++ - [Start a container](#start-a-container) ++ - [Stop a container](#stop-a-container) ++ - [Restart a container](#restart-a-container) ++ - [Kill a container](#kill-a-container) ++ - [Attach to a container](#attach-to-a-container) ++ - [Wait a container](#wait-a-container) ++ - [Remove a container](#remove-a-container) ++ - [Copy files or folders from a ++ container](#copy-files-or-folders-from-a-container) ++ - [2.2 Images](#images) ++ - [List Images](#list-images) ++ - [Create an image](#create-an-image) ++ - [Insert a file in an image](#insert-a-file-in-an-image) ++ - [Inspect an image](#inspect-an-image) ++ - [Get the history of an ++ image](#get-the-history-of-an-image) ++ - [Push an image on the ++ registry](#push-an-image-on-the-registry) ++ - [Tag an image into a ++ repository](#tag-an-image-into-a-repository) ++ - [Remove an image](#remove-an-image) ++ - [Search images](#search-images) ++ - [2.3 Misc](#misc) ++ - [Build an image from Dockerfile via ++ stdin](#build-an-image-from-dockerfile-via-stdin) ++ - [Check auth configuration](#check-auth-configuration) ++ - [Display system-wide ++ information](#display-system-wide-information) ++ - [Show the docker version ++ information](#show-the-docker-version-information) ++ - [Create a new image from a container’s ++ changes](#create-a-new-image-from-a-container-s-changes) ++ - [Monitor Docker’s events](#monitor-docker-s-events) ++ - [Get a tarball containing all images and tags in a ++ repository](#get-a-tarball-containing-all-images-and-tags-in-a-repository) ++ - [Load a tarball with a set of images and tags into ++ docker](#load-a-tarball-with-a-set-of-images-and-tags-into-docker) ++ - [3. Going further](#going-further) ++ - [3.1 Inside ‘docker run’](#inside-docker-run) ++ - [3.2 Hijacking](#hijacking) ++ - [3.3 CORS Requests](#cors-requests) ++ ++## [1. Brief introduction](#id2) ++ ++- The Remote API has replaced rcli ++- The daemon listens on `unix:///var/run/docker.sock`{.docutils + .literal}, but you can [*Bind Docker to another host/port or a Unix + socket*](../../../use/basics/#bind-docker). +-- The API tends to be REST, but for some complex commands, like ++- The API tends to be REST, but for some complex commands, like + `attach` or `pull`{.docutils .literal}, the HTTP + connection is hijacked to transport `stdout, stdin`{.docutils + .literal} and `stderr` + +-## Endpoints ++## [2. Endpoints](#id3) + +-### Containers ++### [2.1 Containers](#id4) + +-### List containers: ++#### [List containers](#id5) + + `GET `{.descname}`/containers/json`{.descname} + : List containers +@@ -80,24 +136,24 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **all** – 1/True/true or 0/False/false, Show all containers. ++ - **all** – 1/True/true or 0/False/false, Show all containers. + Only running containers are shown by default +- - **limit** – Show `limit` last created ++ - **limit** – Show `limit` last created + containers, include non-running ones. +- - **since** – Show only containers created since Id, include ++ - **since** – Show only containers created since Id, include + non-running ones. +- - **before** – Show only containers created before Id, include ++ - **before** – Show only containers created before Id, include + non-running ones. +- - **size** – 1/True/true or 0/False/false, Show the containers ++ - **size** – 1/True/true or 0/False/false, Show the containers + sizes + + Status Codes: + +- - **200** – no error +- - **400** – bad parameter +- - **500** – server error ++ - **200** – no error ++ - **400** – bad parameter ++ - **500** – server error + +-### Create a container: ++#### [Create a container](#id6) + + `POST `{.descname}`/containers/create`{.descname} + : Create a container +@@ -149,16 +205,16 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **config** – the container’s configuration ++ - **config** – the container’s configuration + + Status Codes: + +- - **201** – no error +- - **404** – no such container +- - **406** – impossible to attach (container not running) +- - **500** – server error ++ - **201** – no error ++ - **404** – no such container ++ - **406** – impossible to attach (container not running) ++ - **500** – server error + +-### Inspect a container: ++#### [Inspect a container](#id7) + + `GET `{.descname}`/containers/`{.descname}(*id*)`/json`{.descname} + : Return low-level information on the container `id`{.docutils +@@ -223,11 +279,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-### List processes running inside a container: ++#### [List processes running inside a container](#id8) + + `GET `{.descname}`/containers/`{.descname}(*id*)`/top`{.descname} + : List processes running inside the container `id` +@@ -265,15 +321,15 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **ps\_args** – ps arguments to use (eg. aux) ++ - **ps\_args** – ps arguments to use (eg. aux) + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Inspect changes on a container’s filesystem: ++#### [Inspect changes on a container’s filesystem](#id9) + + `GET `{.descname}`/containers/`{.descname}(*id*)`/changes`{.descname} + : Inspect changes on container `id` ‘s filesystem +@@ -304,11 +360,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Export a container: ++#### [Export a container](#id10) + + `GET `{.descname}`/containers/`{.descname}(*id*)`/export`{.descname} + : Export the contents of container `id` +@@ -326,11 +382,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Start a container: ++#### [Start a container](#id11) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/start`{.descname} + : Start the container `id` +@@ -360,15 +416,15 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **hostConfig** – the container’s host configuration (optional) ++ - **hostConfig** – the container’s host configuration (optional) + + Status Codes: + +- - **204** – no error +- - **404** – no such container +- - **500** – server error ++ - **204** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Stop a container: ++#### [Stop a container](#id12) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/stop`{.descname} + : Stop the container `id` +@@ -385,15 +441,15 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **t** – number of seconds to wait before killing the container ++ - **t** – number of seconds to wait before killing the container + + Status Codes: + +- - **204** – no error +- - **404** – no such container +- - **500** – server error ++ - **204** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Restart a container: ++#### [Restart a container](#id13) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/restart`{.descname} + : Restart the container `id` +@@ -410,15 +466,15 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **t** – number of seconds to wait before killing the container ++ - **t** – number of seconds to wait before killing the container + + Status Codes: + +- - **204** – no error +- - **404** – no such container +- - **500** – server error ++ - **204** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Kill a container: ++#### [Kill a container](#id14) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/kill`{.descname} + : Kill the container `id` +@@ -433,11 +489,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **204** – no error +- - **404** – no such container +- - **500** – server error ++ - **204** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Attach to a container: ++#### [Attach to a container](#id15) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/attach`{.descname} + : Attach to the container `id` +@@ -457,23 +513,23 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **logs** – 1/True/true or 0/False/false, return logs. Default ++ - **logs** – 1/True/true or 0/False/false, return logs. Default + false +- - **stream** – 1/True/true or 0/False/false, return stream. ++ - **stream** – 1/True/true or 0/False/false, return stream. + Default false +- - **stdin** – 1/True/true or 0/False/false, if stream=true, attach ++ - **stdin** – 1/True/true or 0/False/false, if stream=true, attach + to stdin. Default false +- - **stdout** – 1/True/true or 0/False/false, if logs=true, return ++ - **stdout** – 1/True/true or 0/False/false, if logs=true, return + stdout log, if stream=true, attach to stdout. Default false +- - **stderr** – 1/True/true or 0/False/false, if logs=true, return ++ - **stderr** – 1/True/true or 0/False/false, if logs=true, return + stderr log, if stream=true, attach to stderr. Default false + + Status Codes: + +- - **200** – no error +- - **400** – bad parameter +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **400** – bad parameter ++ - **404** – no such container ++ - **500** – server error + + **Stream details**: + +@@ -498,9 +554,9 @@ page_keywords: API, Docker, rcli, REST, documentation + + `STREAM_TYPE` can be: + +- - 0: stdin (will be writen on stdout) +- - 1: stdout +- - 2: stderr ++ - 0: stdin (will be writen on stdout) ++ - 1: stdout ++ - 2: stderr + + `SIZE1, SIZE2, SIZE3, SIZE4` are the 4 bytes of + the uint32 size encoded as big endian. +@@ -519,7 +575,7 @@ page_keywords: API, Docker, rcli, REST, documentation + 4. Read the extracted size and output it on the correct output + 5. Goto 1) + +-### Wait a container: ++#### [Wait a container](#id16) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/wait`{.descname} + : Block until container `id` stops, then returns +@@ -538,11 +594,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Remove a container: ++#### [Remove a container](#id17) + + `DELETE `{.descname}`/containers/`{.descname}(*id*) + : Remove the container `id` from the filesystem +@@ -559,17 +615,17 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **v** – 1/True/true or 0/False/false, Remove the volumes ++ - **v** – 1/True/true or 0/False/false, Remove the volumes + associated to the container. Default false + + Status Codes: + +- - **204** – no error +- - **400** – bad parameter +- - **404** – no such container +- - **500** – server error ++ - **204** – no error ++ - **400** – bad parameter ++ - **404** – no such container ++ - **500** – server error + +-### Copy files or folders from a container: ++#### [Copy files or folders from a container](#id18) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/copy`{.descname} + : Copy files or folders of container `id` +@@ -592,13 +648,13 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-## Images ++### [2.2 Images](#id19) + +-### List images: ++#### [List Images](#id20) + + `GET `{.descname}`/images/json`{.descname} + : **Example request**: +@@ -635,7 +691,7 @@ page_keywords: API, Docker, rcli, REST, documentation + } + ] + +-### Create an image: ++#### [Create an image](#id21) + + `POST `{.descname}`/images/create`{.descname} + : Create an image, either by pull it from the registry or by importing +@@ -663,24 +719,24 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **fromImage** – name of the image to pull +- - **fromSrc** – source to import, - means stdin +- - **repo** – repository +- - **tag** – tag +- - **registry** – the registry to pull from ++ - **fromImage** – name of the image to pull ++ - **fromSrc** – source to import, - means stdin ++ - **repo** – repository ++ - **tag** – tag ++ - **registry** – the registry to pull from + + Request Headers: + +   + +- - **X-Registry-Auth** – base64-encoded AuthConfig object ++ - **X-Registry-Auth** – base64-encoded AuthConfig object + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Insert a file in an image: ++#### [Insert a file in an image](#id22) + + `POST `{.descname}`/images/`{.descname}(*name*)`/insert`{.descname} + : Insert a file from `url` in the image +@@ -702,10 +758,10 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Inspect an image: ++#### [Inspect an image](#id23) + + `GET `{.descname}`/images/`{.descname}(*name*)`/json`{.descname} + : Return low-level information on the image `name` +@@ -750,11 +806,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such image +- - **500** – server error ++ - **200** – no error ++ - **404** – no such image ++ - **500** – server error + +-### Get the history of an image: ++#### [Get the history of an image](#id24) + + `GET `{.descname}`/images/`{.descname}(*name*)`/history`{.descname} + : Return the history of the image `name` +@@ -783,11 +839,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such image +- - **500** – server error ++ - **200** – no error ++ - **404** – no such image ++ - **500** – server error + +-### Push an image on the registry: ++#### [Push an image on the registry](#id25) + + `POST `{.descname}`/images/`{.descname}(*name*)`/push`{.descname} + : Push the image `name` on the registry +@@ -810,22 +866,22 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **registry** – the registry you wan to push, optional ++ - **registry** – the registry you wan to push, optional + + Request Headers: + +   + +- - **X-Registry-Auth** – include a base64-encoded AuthConfig ++ - **X-Registry-Auth** – include a base64-encoded AuthConfig + object. + + Status Codes: + +- - **200** – no error +- - **404** – no such image +- - **500** – server error ++ - **200** – no error ++ - **404** – no such image ++ - **500** – server error + +-### Tag an image into a repository: ++#### [Tag an image into a repository](#id26) + + `POST `{.descname}`/images/`{.descname}(*name*)`/tag`{.descname} + : Tag the image `name` into a repository +@@ -842,18 +898,18 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **repo** – The repository to tag in +- - **force** – 1/True/true or 0/False/false, default false ++ - **repo** – The repository to tag in ++ - **force** – 1/True/true or 0/False/false, default false + + Status Codes: + +- - **201** – no error +- - **400** – bad parameter +- - **404** – no such image +- - **409** – conflict +- - **500** – server error ++ - **201** – no error ++ - **400** – bad parameter ++ - **404** – no such image ++ - **409** – conflict ++ - **500** – server error + +-### Remove an image: ++#### [Remove an image](#id27) + + `DELETE `{.descname}`/images/`{.descname}(*name*) + : Remove the image `name` from the filesystem +@@ -875,12 +931,12 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such image +- - **409** – conflict +- - **500** – server error ++ - **200** – no error ++ - **404** – no such image ++ - **409** – conflict ++ - **500** – server error + +-### Search images: ++#### [Search images](#id28) + + `GET `{.descname}`/images/search`{.descname} + : Search for an image in the docker index. +@@ -928,16 +984,16 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **term** – term to search ++ - **term** – term to search + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-## Misc ++### [2.3 Misc](#id29) + +-### Build an image from Dockerfile via stdin: ++#### [Build an image from Dockerfile via stdin](#id30) + + `POST `{.descname}`/build`{.descname} + : Build an image from Dockerfile via stdin +@@ -967,24 +1023,24 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **t** – repository name (and optionally a tag) to be applied to ++ - **t** – repository name (and optionally a tag) to be applied to + the resulting image in case of success +- - **q** – suppress verbose build output +- - **nocache** – do not use the cache when building the image ++ - **q** – suppress verbose build output ++ - **nocache** – do not use the cache when building the image + + Request Headers: + +   + +- - **Content-type** – should be set to ++ - **Content-type** – should be set to + `"application/tar"`. + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Check auth configuration: ++#### [Check auth configuration](#id31) + + `POST `{.descname}`/auth`{.descname} + : Get the default username and email +@@ -1007,11 +1063,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **204** – no error +- - **500** – server error ++ - **200** – no error ++ - **204** – no error ++ - **500** – server error + +-### Display system-wide information: ++#### [Display system-wide information](#id32) + + `GET `{.descname}`/info`{.descname} + : Display system-wide information +@@ -1038,10 +1094,10 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Show the docker version information: ++#### [Show the docker version information](#id33) + + `GET `{.descname}`/version`{.descname} + : Show the docker version information +@@ -1063,10 +1119,10 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Create a new image from a container’s changes: ++#### [Create a new image from a container’s changes](#id34) + + `POST `{.descname}`/commit`{.descname} + : Create a new image from a container’s changes +@@ -1086,22 +1142,22 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **container** – source container +- - **repo** – repository +- - **tag** – tag +- - **m** – commit message +- - **author** – author (eg. “John Hannibal Smith ++ - **container** – source container ++ - **repo** – repository ++ - **tag** – tag ++ - **m** – commit message ++ - **author** – author (eg. “John Hannibal Smith + \<[hannibal@a-team.com](mailto:hannibal%40a-team.com)\>”) +- - **run** – config automatically applied when the image is run. ++ - **run** – config automatically applied when the image is run. + (ex: {“Cmd”: [“cat”, “/world”], “PortSpecs”:[“22”]}) + + Status Codes: + +- - **201** – no error +- - **404** – no such container +- - **500** – server error ++ - **201** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Monitor Docker’s events: ++#### [Monitor Docker’s events](#id35) + + `GET `{.descname}`/events`{.descname} + : Get events from docker, either in real time via streaming, or via +@@ -1125,14 +1181,14 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **since** – timestamp used for polling ++ - **since** – timestamp used for polling + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Get a tarball containing all images and tags in a repository: ++#### [Get a tarball containing all images and tags in a repository](#id36) + + `GET `{.descname}`/images/`{.descname}(*name*)`/get`{.descname} + : Get a tarball containing all images and metadata for the repository +@@ -1153,7 +1209,7 @@ page_keywords: API, Docker, rcli, REST, documentation + :statuscode 200: no error + :statuscode 500: server error + +-### Load a tarball with a set of images and tags into docker: ++#### [Load a tarball with a set of images and tags into docker](#id37) + + `POST `{.descname}`/images/load`{.descname} + : Load a set of images and tags into the docker repository. +@@ -1173,35 +1229,35 @@ page_keywords: API, Docker, rcli, REST, documentation + :statuscode 200: no error + :statuscode 500: server error + +-## Going Further ++## [3. Going further](#id38) + +-### Inside ‘docker run’ ++### [3.1 Inside ‘docker run’](#id39) + + Here are the steps of ‘docker run’ : + +-- Create the container ++- Create the container + +-- If the status code is 404, it means the image doesn’t exists: +- : - Try to pull it +- - Then retry to create the container ++- If the status code is 404, it means the image doesn’t exists: ++ : - Try to pull it ++ - Then retry to create the container + +-- Start the container ++- Start the container + +-- If you are not in detached mode: +- : - Attach to the container, using logs=1 (to have stdout and ++- If you are not in detached mode: ++ : - Attach to the container, using logs=1 (to have stdout and + stderr from the container’s start) and stream=1 + +-- If in detached mode or only stdin is attached: +- : - Display the container’s id ++- If in detached mode or only stdin is attached: ++ : - Display the container’s id + +-### Hijacking ++### [3.2 Hijacking](#id40) + + In this version of the API, /attach, uses hijacking to transport stdin, + stdout and stderr on the same socket. This might change in the future. + +-### CORS Requests ++### [3.3 CORS Requests](#id41) + + To enable cross origin requests to the remote api add the flag +-“-api-enable-cors” when running docker in daemon mode. ++“–api-enable-cors” when running docker in daemon mode. + +- docker -d -H="192.168.1.9:4243" -api-enable-cors ++ docker -d -H="192.168.1.9:4243" --api-enable-cors +diff --git a/docs/sources/reference/api/docker_remote_api_v1.8.md b/docs/sources/reference/api/docker_remote_api_v1.8.md +index 49c8fb6..115cabc 100644 +--- a/docs/sources/reference/api/docker_remote_api_v1.8.md ++++ b/docs/sources/reference/api/docker_remote_api_v1.8.md +@@ -2,24 +2,80 @@ page_title: Remote API v1.8 + page_description: API Documentation for Docker + page_keywords: API, Docker, rcli, REST, documentation + +-# Docker Remote API v1.8 +- +-## Introduction +- +-- The Remote API has replaced rcli +-- The daemon listens on `unix:///var/run/docker.sock`{.docutils +- .literal}, but you can [*Bind Docker to another host/port or a Unix +- socket*](../../../use/basics/#bind-docker). +-- The API tends to be REST, but for some complex commands, like +- `attach` or `pull`{.docutils .literal}, the HTTP +- connection is hijacked to transport `stdout, stdin`{.docutils +- .literal} and `stderr` +- +-## Endpoints +- +-### Containers +- +-### List containers: ++# [Docker Remote API v1.8](#id1) ++ ++Table of Contents ++ ++- [Docker Remote API v1.8](#docker-remote-api-v1-8) ++ - [1. Brief introduction](#brief-introduction) ++ - [2. Endpoints](#endpoints) ++ - [2.1 Containers](#containers) ++ - [List containers](#list-containers) ++ - [Create a container](#create-a-container) ++ - [Inspect a container](#inspect-a-container) ++ - [List processes running inside a ++ container](#list-processes-running-inside-a-container) ++ - [Inspect changes on a container’s ++ filesystem](#inspect-changes-on-a-container-s-filesystem) ++ - [Export a container](#export-a-container) ++ - [Start a container](#start-a-container) ++ - [Stop a container](#stop-a-container) ++ - [Restart a container](#restart-a-container) ++ - [Kill a container](#kill-a-container) ++ - [Attach to a container](#attach-to-a-container) ++ - [Wait a container](#wait-a-container) ++ - [Remove a container](#remove-a-container) ++ - [Copy files or folders from a ++ container](#copy-files-or-folders-from-a-container) ++ - [2.2 Images](#images) ++ - [List Images](#list-images) ++ - [Create an image](#create-an-image) ++ - [Insert a file in an image](#insert-a-file-in-an-image) ++ - [Inspect an image](#inspect-an-image) ++ - [Get the history of an ++ image](#get-the-history-of-an-image) ++ - [Push an image on the ++ registry](#push-an-image-on-the-registry) ++ - [Tag an image into a ++ repository](#tag-an-image-into-a-repository) ++ - [Remove an image](#remove-an-image) ++ - [Search images](#search-images) ++ - [2.3 Misc](#misc) ++ - [Build an image from Dockerfile via ++ stdin](#build-an-image-from-dockerfile-via-stdin) ++ - [Check auth configuration](#check-auth-configuration) ++ - [Display system-wide ++ information](#display-system-wide-information) ++ - [Show the docker version ++ information](#show-the-docker-version-information) ++ - [Create a new image from a container’s ++ changes](#create-a-new-image-from-a-container-s-changes) ++ - [Monitor Docker’s events](#monitor-docker-s-events) ++ - [Get a tarball containing all images and tags in a ++ repository](#get-a-tarball-containing-all-images-and-tags-in-a-repository) ++ - [Load a tarball with a set of images and tags into ++ docker](#load-a-tarball-with-a-set-of-images-and-tags-into-docker) ++ - [3. Going further](#going-further) ++ - [3.1 Inside ‘docker run’](#inside-docker-run) ++ - [3.2 Hijacking](#hijacking) ++ - [3.3 CORS Requests](#cors-requests) ++ ++## [1. Brief introduction](#id2) ++ ++- The Remote API has replaced rcli ++- The daemon listens on `unix:///var/run/docker.sock`{.docutils ++ .literal}, but you can [*Bind Docker to another host/port or a Unix ++ socket*](../../../use/basics/#bind-docker). ++- The API tends to be REST, but for some complex commands, like ++ `attach` or `pull`{.docutils .literal}, the HTTP ++ connection is hijacked to transport `stdout, stdin`{.docutils ++ .literal} and `stderr` ++ ++## [2. Endpoints](#id3) ++ ++### [2.1 Containers](#id4) ++ ++#### [List containers](#id5) + + `GET `{.descname}`/containers/json`{.descname} + : List containers +@@ -80,24 +136,24 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **all** – 1/True/true or 0/False/false, Show all containers. ++ - **all** – 1/True/true or 0/False/false, Show all containers. + Only running containers are shown by default +- - **limit** – Show `limit` last created ++ - **limit** – Show `limit` last created + containers, include non-running ones. +- - **since** – Show only containers created since Id, include ++ - **since** – Show only containers created since Id, include + non-running ones. +- - **before** – Show only containers created before Id, include ++ - **before** – Show only containers created before Id, include + non-running ones. +- - **size** – 1/True/true or 0/False/false, Show the containers ++ - **size** – 1/True/true or 0/False/false, Show the containers + sizes + + Status Codes: + +- - **200** – no error +- - **400** – bad parameter +- - **500** – server error ++ - **200** – no error ++ - **400** – bad parameter ++ - **500** – server error + +-### Create a container: ++#### [Create a container](#id6) + + `POST `{.descname}`/containers/create`{.descname} + : Create a container +@@ -150,36 +206,36 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **Hostname** – Container host name +- - **User** – Username or UID +- - **Memory** – Memory Limit in bytes +- - **CpuShares** – CPU shares (relative weight +- - **AttachStdin** – 1/True/true or 0/False/false, attach to ++ - **Hostname** – Container host name ++ - **User** – Username or UID ++ - **Memory** – Memory Limit in bytes ++ - **CpuShares** – CPU shares (relative weight) ++ - **AttachStdin** – 1/True/true or 0/False/false, attach to + standard input. Default false +- - **AttachStdout** – 1/True/true or 0/False/false, attach to ++ - **AttachStdout** – 1/True/true or 0/False/false, attach to + standard output. Default false +- - **AttachStderr** – 1/True/true or 0/False/false, attach to ++ - **AttachStderr** – 1/True/true or 0/False/false, attach to + standard error. Default false +- - **Tty** – 1/True/true or 0/False/false, allocate a pseudo-tty. ++ - **Tty** – 1/True/true or 0/False/false, allocate a pseudo-tty. + Default false +- - **OpenStdin** – 1/True/true or 0/False/false, keep stdin open ++ - **OpenStdin** – 1/True/true or 0/False/false, keep stdin open + even if not attached. Default false + + Query Parameters: + +   + +- - **name** – Assign the specified name to the container. Must ++ - **name** – Assign the specified name to the container. Must + match `/?[a-zA-Z0-9_-]+`. + + Status Codes: + +- - **201** – no error +- - **404** – no such container +- - **406** – impossible to attach (container not running +- - **500** – server error ++ - **201** – no error ++ - **404** – no such container ++ - **406** – impossible to attach (container not running) ++ - **500** – server error + +-### Inspect a container: ++#### [Inspect a container](#id7) + + `GET `{.descname}`/containers/`{.descname}(*id*)`/json`{.descname} + : Return low-level information on the container `id`{.docutils +@@ -260,11 +316,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-### List processes running inside a container: ++#### [List processes running inside a container](#id8) + + `GET `{.descname}`/containers/`{.descname}(*id*)`/top`{.descname} + : List processes running inside the container `id` +@@ -302,15 +358,15 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **ps\_args** – ps arguments to use (eg. aux ++ - **ps\_args** – ps arguments to use (eg. aux) + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Inspect changes on a container’s filesystem: ++#### [Inspect changes on a container’s filesystem](#id9) + + `GET `{.descname}`/containers/`{.descname}(*id*)`/changes`{.descname} + : Inspect changes on container `id` ‘s filesystem +@@ -341,11 +397,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Export a container: ++#### [Export a container](#id10) + + `GET `{.descname}`/containers/`{.descname}(*id*)`/export`{.descname} + : Export the contents of container `id` +@@ -363,11 +419,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Start a container: ++#### [Start a container](#id11) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/start`{.descname} + : Start the container `id` +@@ -394,24 +450,24 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **Binds** – Create a bind mount to a directory or file with ++ - **Binds** – Create a bind mount to a directory or file with + [host-path]:[container-path]:[rw|ro]. If a directory + “container-path” is missing, then docker creates a new volume. +- - **LxcConf** – Map of custom lxc options +- - **PortBindings** – Expose ports from the container, optionally ++ - **LxcConf** – Map of custom lxc options ++ - **PortBindings** – Expose ports from the container, optionally + publishing them via the HostPort flag +- - **PublishAllPorts** – 1/True/true or 0/False/false, publish all ++ - **PublishAllPorts** – 1/True/true or 0/False/false, publish all + exposed ports to the host interfaces. Default false +- - **Privileged** – 1/True/true or 0/False/false, give extended ++ - **Privileged** – 1/True/true or 0/False/false, give extended + privileges to this container. Default false + + Status Codes: + +- - **204** – no error +- - **404** – no such container +- - **500** – server error ++ - **204** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Stop a container: ++#### [Stop a container](#id12) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/stop`{.descname} + : Stop the container `id` +@@ -428,15 +484,15 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **t** – number of seconds to wait before killing the container ++ - **t** – number of seconds to wait before killing the container + + Status Codes: + +- - **204** – no error +- - **404** – no such container +- - **500** – server error ++ - **204** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Restart a container: ++#### [Restart a container](#id13) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/restart`{.descname} + : Restart the container `id` +@@ -453,15 +509,15 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **t** – number of seconds to wait before killing the container ++ - **t** – number of seconds to wait before killing the container + + Status Codes: + +- - **204** – no error +- - **404** – no such container +- - **500** – server error ++ - **204** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Kill a container: ++#### [Kill a container](#id14) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/kill`{.descname} + : Kill the container `id` +@@ -476,11 +532,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **204** – no error +- - **404** – no such container +- - **500** – server error ++ - **204** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Attach to a container: ++#### [Attach to a container](#id15) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/attach`{.descname} + : Attach to the container `id` +@@ -500,23 +556,23 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **logs** – 1/True/true or 0/False/false, return logs. Default ++ - **logs** – 1/True/true or 0/False/false, return logs. Default + false +- - **stream** – 1/True/true or 0/False/false, return stream. ++ - **stream** – 1/True/true or 0/False/false, return stream. + Default false +- - **stdin** – 1/True/true or 0/False/false, if stream=true, attach ++ - **stdin** – 1/True/true or 0/False/false, if stream=true, attach + to stdin. Default false +- - **stdout** – 1/True/true or 0/False/false, if logs=true, return ++ - **stdout** – 1/True/true or 0/False/false, if logs=true, return + stdout log, if stream=true, attach to stdout. Default false +- - **stderr** – 1/True/true or 0/False/false, if logs=true, return ++ - **stderr** – 1/True/true or 0/False/false, if logs=true, return + stderr log, if stream=true, attach to stderr. Default false + + Status Codes: + +- - **200** – no error +- - **400** – bad parameter +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **400** – bad parameter ++ - **404** – no such container ++ - **500** – server error + + **Stream details**: + +@@ -541,9 +597,9 @@ page_keywords: API, Docker, rcli, REST, documentation + + `STREAM_TYPE` can be: + +- - 0: stdin (will be writen on stdout +- - 1: stdout +- - 2: stderr ++ - 0: stdin (will be writen on stdout) ++ - 1: stdout ++ - 2: stderr + + `SIZE1, SIZE2, SIZE3, SIZE4` are the 4 bytes of + the uint32 size encoded as big endian. +@@ -560,9 +616,9 @@ page_keywords: API, Docker, rcli, REST, documentation + 2. chose stdout or stderr depending on the first byte + 3. Extract the frame size from the last 4 byets + 4. Read the extracted size and output it on the correct output +- 5. Goto 1 ++ 5. Goto 1) + +-### Wait a container: ++#### [Wait a container](#id16) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/wait`{.descname} + : Block until container `id` stops, then returns +@@ -581,13 +637,13 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Remove a container: ++#### [Remove a container](#id17) + +- `DELETE `{.descname}`/containers/`{.descname}(*id* ++ `DELETE `{.descname}`/containers/`{.descname}(*id*) + : Remove the container `id` from the filesystem + + **Example request**: +@@ -602,17 +658,17 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **v** – 1/True/true or 0/False/false, Remove the volumes ++ - **v** – 1/True/true or 0/False/false, Remove the volumes + associated to the container. Default false + + Status Codes: + +- - **204** – no error +- - **400** – bad parameter +- - **404** – no such container +- - **500** – server error ++ - **204** – no error ++ - **400** – bad parameter ++ - **404** – no such container ++ - **500** – server error + +-### Copy files or folders from a container: ++#### [Copy files or folders from a container](#id18) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/copy`{.descname} + : Copy files or folders of container `id` +@@ -635,13 +691,13 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Images ++### [2.2 Images](#id19) + +-### List Images: ++#### [List Images](#id20) + + `GET `{.descname}`/images/json`{.descname} + : **Example request**: +@@ -678,7 +734,7 @@ page_keywords: API, Docker, rcli, REST, documentation + } + ] + +-### Create an image: ++#### [Create an image](#id21) + + `POST `{.descname}`/images/create`{.descname} + : Create an image, either by pull it from the registry or by importing +@@ -706,24 +762,24 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **fromImage** – name of the image to pull +- - **fromSrc** – source to import, - means stdin +- - **repo** – repository +- - **tag** – tag +- - **registry** – the registry to pull from ++ - **fromImage** – name of the image to pull ++ - **fromSrc** – source to import, - means stdin ++ - **repo** – repository ++ - **tag** – tag ++ - **registry** – the registry to pull from + + Request Headers: + +   + +- - **X-Registry-Auth** – base64-encoded AuthConfig object ++ - **X-Registry-Auth** – base64-encoded AuthConfig object + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Insert a file in an image: ++#### [Insert a file in an image](#id22) + + `POST `{.descname}`/images/`{.descname}(*name*)`/insert`{.descname} + : Insert a file from `url` in the image +@@ -745,10 +801,10 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Inspect an image: ++#### [Inspect an image](#id23) + + `GET `{.descname}`/images/`{.descname}(*name*)`/json`{.descname} + : Return low-level information on the image `name` +@@ -793,11 +849,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such image +- - **500** – server error ++ - **200** – no error ++ - **404** – no such image ++ - **500** – server error + +-### Get the history of an image: ++#### [Get the history of an image](#id24) + + `GET `{.descname}`/images/`{.descname}(*name*)`/history`{.descname} + : Return the history of the image `name` +@@ -826,11 +882,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such image +- - **500** – server error ++ - **200** – no error ++ - **404** – no such image ++ - **500** – server error + +-### Push an image on the registry: ++#### [Push an image on the registry](#id25) + + `POST `{.descname}`/images/`{.descname}(*name*)`/push`{.descname} + : Push the image `name` on the registry +@@ -853,22 +909,22 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **registry** – the registry you wan to push, optional ++ - **registry** – the registry you wan to push, optional + + Request Headers: + +   + +- - **X-Registry-Auth** – include a base64-encoded AuthConfig ++ - **X-Registry-Auth** – include a base64-encoded AuthConfig + object. + + Status Codes: + +- - **200** – no error +- - **404** – no such image +- - **500** – server error ++ - **200** – no error ++ - **404** – no such image ++ - **500** – server error + +-### Tag an image into a repository: ++#### [Tag an image into a repository](#id26) + + `POST `{.descname}`/images/`{.descname}(*name*)`/tag`{.descname} + : Tag the image `name` into a repository +@@ -885,20 +941,20 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **repo** – The repository to tag in +- - **force** – 1/True/true or 0/False/false, default false ++ - **repo** – The repository to tag in ++ - **force** – 1/True/true or 0/False/false, default false + + Status Codes: + +- - **201** – no error +- - **400** – bad parameter +- - **404** – no such image +- - **409** – conflict +- - **500** – server error ++ - **201** – no error ++ - **400** – bad parameter ++ - **404** – no such image ++ - **409** – conflict ++ - **500** – server error + +-### Remove an image: ++#### [Remove an image](#id27) + +- `DELETE `{.descname}`/images/`{.descname}(*name* ++ `DELETE `{.descname}`/images/`{.descname}(*name*) + : Remove the image `name` from the filesystem + + **Example request**: +@@ -918,12 +974,12 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such image +- - **409** – conflict +- - **500** – server error ++ - **200** – no error ++ - **404** – no such image ++ - **409** – conflict ++ - **500** – server error + +-### Search images: ++#### [Search images](#id28) + + `GET `{.descname}`/images/search`{.descname} + : Search for an image in the docker index. +@@ -971,16 +1027,16 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **term** – term to search ++ - **term** – term to search + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Misc ++### [2.3 Misc](#id29) + +-### Build an image from Dockerfile via stdin: ++#### [Build an image from Dockerfile via stdin](#id30) + + `POST `{.descname}`/build`{.descname} + : Build an image from Dockerfile via stdin +@@ -1012,25 +1068,25 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **t** – repository name (and optionally a tag) to be applied to ++ - **t** – repository name (and optionally a tag) to be applied to + the resulting image in case of success +- - **q** – suppress verbose build output +- - **nocache** – do not use the cache when building the image ++ - **q** – suppress verbose build output ++ - **nocache** – do not use the cache when building the image + + Request Headers: + +   + +- - **Content-type** – should be set to ++ - **Content-type** – should be set to + `"application/tar"`. +- - **X-Registry-Auth** – base64-encoded AuthConfig object ++ - **X-Registry-Auth** – base64-encoded AuthConfig object + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Check auth configuration: ++#### [Check auth configuration](#id31) + + `POST `{.descname}`/auth`{.descname} + : Get the default username and email +@@ -1053,11 +1109,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **204** – no error +- - **500** – server error ++ - **200** – no error ++ - **204** – no error ++ - **500** – server error + +-### Display system-wide information: ++#### [Display system-wide information](#id32) + + `GET `{.descname}`/info`{.descname} + : Display system-wide information +@@ -1084,10 +1140,10 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Show the docker version information: ++#### [Show the docker version information](#id33) + + `GET `{.descname}`/version`{.descname} + : Show the docker version information +@@ -1109,10 +1165,10 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Create a new image from a container’s changes: ++#### [Create a new image from a container’s changes](#id34) + + `POST `{.descname}`/commit`{.descname} + : Create a new image from a container’s changes +@@ -1132,26 +1188,26 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **container** – source container +- - **repo** – repository +- - **tag** – tag +- - **m** – commit message +- - **author** – author (eg. “John Hannibal Smith +- \<[hannibal@a-team.com](mailto:hannibal%40a-team.com)\>” +- - **run** – config automatically applied when the image is run. +- (ex: {“Cmd”: [“cat”, “/world”], “PortSpecs”:[“22”]} ++ - **container** – source container ++ - **repo** – repository ++ - **tag** – tag ++ - **m** – commit message ++ - **author** – author (eg. “John Hannibal Smith ++ \<[hannibal@a-team.com](mailto:hannibal%40a-team.com)\>”) ++ - **run** – config automatically applied when the image is run. ++ (ex: {“Cmd”: [“cat”, “/world”], “PortSpecs”:[“22”]}) + + Status Codes: + +- - **201** – no error +- - **404** – no such container +- - **500** – server error ++ - **201** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Monitor Docker’s events: ++#### [Monitor Docker’s events](#id35) + + `GET `{.descname}`/events`{.descname} + : Get events from docker, either in real time via streaming, or via +- polling (using since ++ polling (using since) + + **Example request**: + +@@ -1171,14 +1227,14 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **since** – timestamp used for polling ++ - **since** – timestamp used for polling + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Get a tarball containing all images and tags in a repository: ++#### [Get a tarball containing all images and tags in a repository](#id36) + + `GET `{.descname}`/images/`{.descname}(*name*)`/get`{.descname} + : Get a tarball containing all images and metadata for the repository +@@ -1197,10 +1253,10 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Load a tarball with a set of images and tags into docker: ++#### [Load a tarball with a set of images and tags into docker](#id37) + + `POST `{.descname}`/images/load`{.descname} + : Load a set of images and tags into the docker repository. +@@ -1217,38 +1273,38 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-## Going Further ++## [3. Going further](#id38) + +-### Inside ‘docker run’ ++### [3.1 Inside ‘docker run’](#id39) + + Here are the steps of ‘docker run’ : + +-- Create the container ++- Create the container + +-- If the status code is 404, it means the image doesn’t exists: +- : - Try to pull it +- - Then retry to create the container ++- If the status code is 404, it means the image doesn’t exists: ++ : - Try to pull it ++ - Then retry to create the container + +-- Start the container ++- Start the container + +-- If you are not in detached mode: +- : - Attach to the container, using logs=1 (to have stdout and ++- If you are not in detached mode: ++ : - Attach to the container, using logs=1 (to have stdout and + stderr from the container’s start) and stream=1 + +-- If in detached mode or only stdin is attached: +- : - Display the container’s id ++- If in detached mode or only stdin is attached: ++ : - Display the container’s id + +-### Hijacking ++### [3.2 Hijacking](#id40) + + In this version of the API, /attach, uses hijacking to transport stdin, + stdout and stderr on the same socket. This might change in the future. + +-### CORS Requests ++### [3.3 CORS Requests](#id41) + + To enable cross origin requests to the remote api add the flag +-“-api-enable-cors” when running docker in daemon mode. ++“–api-enable-cors” when running docker in daemon mode. + +- docker -d -H="192.168.1.9:4243" -api-enable-cors ++ docker -d -H="192.168.1.9:4243" --api-enable-cors +diff --git a/docs/sources/reference/api/docker_remote_api_v1.9.md b/docs/sources/reference/api/docker_remote_api_v1.9.md +index 658835c..c25f837 100644 +--- a/docs/sources/reference/api/docker_remote_api_v1.9.md ++++ b/docs/sources/reference/api/docker_remote_api_v1.9.md +@@ -2,24 +2,80 @@ page_title: Remote API v1.9 + page_description: API Documentation for Docker + page_keywords: API, Docker, rcli, REST, documentation + +-# Docker Remote API v1.9 +- +-## Introduction +- +-- The Remote API has replaced rcli +-- The daemon listens on `unix:///var/run/docker.sock`{.docutils +- .literal}, but you can [*Bind Docker to another host/port or a Unix +- socket*](../../../use/basics/#bind-docker). +-- The API tends to be REST, but for some complex commands, like +- `attach` or `pull`{.docutils .literal}, the HTTP +- connection is hijacked to transport `stdout, stdin`{.docutils +- .literal} and `stderr` +- +-## Endpoints +- +-## Containers +- +-### List containers: ++# [Docker Remote API v1.9](#id1) ++ ++Table of Contents ++ ++- [Docker Remote API v1.9](#docker-remote-api-v1-9) ++ - [1. Brief introduction](#brief-introduction) ++ - [2. Endpoints](#endpoints) ++ - [2.1 Containers](#containers) ++ - [List containers](#list-containers) ++ - [Create a container](#create-a-container) ++ - [Inspect a container](#inspect-a-container) ++ - [List processes running inside a ++ container](#list-processes-running-inside-a-container) ++ - [Inspect changes on a container’s ++ filesystem](#inspect-changes-on-a-container-s-filesystem) ++ - [Export a container](#export-a-container) ++ - [Start a container](#start-a-container) ++ - [Stop a container](#stop-a-container) ++ - [Restart a container](#restart-a-container) ++ - [Kill a container](#kill-a-container) ++ - [Attach to a container](#attach-to-a-container) ++ - [Wait a container](#wait-a-container) ++ - [Remove a container](#remove-a-container) ++ - [Copy files or folders from a ++ container](#copy-files-or-folders-from-a-container) ++ - [2.2 Images](#images) ++ - [List Images](#list-images) ++ - [Create an image](#create-an-image) ++ - [Insert a file in an image](#insert-a-file-in-an-image) ++ - [Inspect an image](#inspect-an-image) ++ - [Get the history of an ++ image](#get-the-history-of-an-image) ++ - [Push an image on the ++ registry](#push-an-image-on-the-registry) ++ - [Tag an image into a ++ repository](#tag-an-image-into-a-repository) ++ - [Remove an image](#remove-an-image) ++ - [Search images](#search-images) ++ - [2.3 Misc](#misc) ++ - [Build an image from ++ Dockerfile](#build-an-image-from-dockerfile) ++ - [Check auth configuration](#check-auth-configuration) ++ - [Display system-wide ++ information](#display-system-wide-information) ++ - [Show the docker version ++ information](#show-the-docker-version-information) ++ - [Create a new image from a container’s ++ changes](#create-a-new-image-from-a-container-s-changes) ++ - [Monitor Docker’s events](#monitor-docker-s-events) ++ - [Get a tarball containing all images and tags in a ++ repository](#get-a-tarball-containing-all-images-and-tags-in-a-repository) ++ - [Load a tarball with a set of images and tags into ++ docker](#load-a-tarball-with-a-set-of-images-and-tags-into-docker) ++ - [3. Going further](#going-further) ++ - [3.1 Inside ‘docker run’](#inside-docker-run) ++ - [3.2 Hijacking](#hijacking) ++ - [3.3 CORS Requests](#cors-requests) ++ ++## [1. Brief introduction](#id2) ++ ++- The Remote API has replaced rcli ++- The daemon listens on `unix:///var/run/docker.sock`{.docutils ++ .literal}, but you can [*Bind Docker to another host/port or a Unix ++ socket*](../../../use/basics/#bind-docker). ++- The API tends to be REST, but for some complex commands, like ++ `attach` or `pull`{.docutils .literal}, the HTTP ++ connection is hijacked to transport `stdout, stdin`{.docutils ++ .literal} and `stderr` ++ ++## [2. Endpoints](#id3) ++ ++### [2.1 Containers](#id4) ++ ++#### [List containers](#id5) + + `GET `{.descname}`/containers/json`{.descname} + : List containers +@@ -80,24 +136,24 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **all** – 1/True/true or 0/False/false, Show all containers. ++ - **all** – 1/True/true or 0/False/false, Show all containers. + Only running containers are shown by default +- - **limit** – Show `limit` last created ++ - **limit** – Show `limit` last created + containers, include non-running ones. +- - **since** – Show only containers created since Id, include ++ - **since** – Show only containers created since Id, include + non-running ones. +- - **before** – Show only containers created before Id, include ++ - **before** – Show only containers created before Id, include + non-running ones. +- - **size** – 1/True/true or 0/False/false, Show the containers ++ - **size** – 1/True/true or 0/False/false, Show the containers + sizes + + Status Codes: + +- - **200** – no error +- - **400** – bad parameter +- - **500** – server error ++ - **200** – no error ++ - **400** – bad parameter ++ - **500** – server error + +-### Create a container: ++#### [Create a container](#id6) + + `POST `{.descname}`/containers/create`{.descname} + : Create a container +@@ -150,36 +206,36 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **Hostname** – Container host name +- - **User** – Username or UID +- - **Memory** – Memory Limit in bytes +- - **CpuShares** – CPU shares (relative weight) +- - **AttachStdin** – 1/True/true or 0/False/false, attach to ++ - **Hostname** – Container host name ++ - **User** – Username or UID ++ - **Memory** – Memory Limit in bytes ++ - **CpuShares** – CPU shares (relative weight) ++ - **AttachStdin** – 1/True/true or 0/False/false, attach to + standard input. Default false +- - **AttachStdout** – 1/True/true or 0/False/false, attach to ++ - **AttachStdout** – 1/True/true or 0/False/false, attach to + standard output. Default false +- - **AttachStderr** – 1/True/true or 0/False/false, attach to ++ - **AttachStderr** – 1/True/true or 0/False/false, attach to + standard error. Default false +- - **Tty** – 1/True/true or 0/False/false, allocate a pseudo-tty. ++ - **Tty** – 1/True/true or 0/False/false, allocate a pseudo-tty. + Default false +- - **OpenStdin** – 1/True/true or 0/False/false, keep stdin open ++ - **OpenStdin** – 1/True/true or 0/False/false, keep stdin open + even if not attached. Default false + + Query Parameters: + +   + +- - **name** – Assign the specified name to the container. Must ++ - **name** – Assign the specified name to the container. Must + match `/?[a-zA-Z0-9_-]+`. + + Status Codes: + +- - **201** – no error +- - **404** – no such container +- - **406** – impossible to attach (container not running) +- - **500** – server error ++ - **201** – no error ++ - **404** – no such container ++ - **406** – impossible to attach (container not running) ++ - **500** – server error + +-### Inspect a container: ++#### [Inspect a container](#id7) + + `GET `{.descname}`/containers/`{.descname}(*id*)`/json`{.descname} + : Return low-level information on the container `id`{.docutils +@@ -260,11 +316,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-### List processes running inside a container: ++#### [List processes running inside a container](#id8) + + `GET `{.descname}`/containers/`{.descname}(*id*)`/top`{.descname} + : List processes running inside the container `id` +@@ -302,15 +358,15 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **ps\_args** – ps arguments to use (eg. aux) ++ - **ps\_args** – ps arguments to use (eg. aux) + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Inspect changes on a container’s filesystem: ++#### [Inspect changes on a container’s filesystem](#id9) + + `GET `{.descname}`/containers/`{.descname}(*id*)`/changes`{.descname} + : Inspect changes on container `id` ‘s filesystem +@@ -341,12 +397,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error +- +-### Export a container: ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + ++#### [Export a container](#id10) + + `GET `{.descname}`/containers/`{.descname}(*id*)`/export`{.descname} + : Export the contents of container `id` +@@ -364,12 +419,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error +- +-### Start a container: ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + ++#### [Start a container](#id11) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/start`{.descname} + : Start the container `id` +@@ -396,25 +450,24 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **Binds** – Create a bind mount to a directory or file with ++ - **Binds** – Create a bind mount to a directory or file with + [host-path]:[container-path]:[rw|ro]. If a directory + “container-path” is missing, then docker creates a new volume. +- - **LxcConf** – Map of custom lxc options +- - **PortBindings** – Expose ports from the container, optionally ++ - **LxcConf** – Map of custom lxc options ++ - **PortBindings** – Expose ports from the container, optionally + publishing them via the HostPort flag +- - **PublishAllPorts** – 1/True/true or 0/False/false, publish all ++ - **PublishAllPorts** – 1/True/true or 0/False/false, publish all + exposed ports to the host interfaces. Default false +- - **Privileged** – 1/True/true or 0/False/false, give extended ++ - **Privileged** – 1/True/true or 0/False/false, give extended + privileges to this container. Default false + + Status Codes: + +- - **204** – no error +- - **404** – no such container +- - **500** – server error +- +-### Stop a container: ++ - **204** – no error ++ - **404** – no such container ++ - **500** – server error + ++#### [Stop a container](#id12) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/stop`{.descname} + : Stop the container `id` +@@ -431,16 +484,15 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **t** – number of seconds to wait before killing the container ++ - **t** – number of seconds to wait before killing the container + + Status Codes: + +- - **204** – no error +- - **404** – no such container +- - **500** – server error +- +-### Restart a container: ++ - **204** – no error ++ - **404** – no such container ++ - **500** – server error + ++#### [Restart a container](#id13) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/restart`{.descname} + : Restart the container `id` +@@ -457,16 +509,15 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **t** – number of seconds to wait before killing the container ++ - **t** – number of seconds to wait before killing the container + + Status Codes: + +- - **204** – no error +- - **404** – no such container +- - **500** – server error +- +-### Kill a container: ++ - **204** – no error ++ - **404** – no such container ++ - **500** – server error + ++#### [Kill a container](#id14) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/kill`{.descname} + : Kill the container `id` +@@ -481,12 +532,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **204** – no error +- - **404** – no such container +- - **500** – server error +- +-### Attach to a container: ++ - **204** – no error ++ - **404** – no such container ++ - **500** – server error + ++#### [Attach to a container](#id15) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/attach`{.descname} + : Attach to the container `id` +@@ -506,23 +556,23 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **logs** – 1/True/true or 0/False/false, return logs. Default ++ - **logs** – 1/True/true or 0/False/false, return logs. Default + false +- - **stream** – 1/True/true or 0/False/false, return stream. ++ - **stream** – 1/True/true or 0/False/false, return stream. + Default false +- - **stdin** – 1/True/true or 0/False/false, if stream=true, attach ++ - **stdin** – 1/True/true or 0/False/false, if stream=true, attach + to stdin. Default false +- - **stdout** – 1/True/true or 0/False/false, if logs=true, return ++ - **stdout** – 1/True/true or 0/False/false, if logs=true, return + stdout log, if stream=true, attach to stdout. Default false +- - **stderr** – 1/True/true or 0/False/false, if logs=true, return ++ - **stderr** – 1/True/true or 0/False/false, if logs=true, return + stderr log, if stream=true, attach to stderr. Default false + + Status Codes: + +- - **200** – no error +- - **400** – bad parameter +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **400** – bad parameter ++ - **404** – no such container ++ - **500** – server error + + **Stream details**: + +@@ -547,9 +597,9 @@ page_keywords: API, Docker, rcli, REST, documentation + + `STREAM_TYPE` can be: + +- - 0: stdin (will be writen on stdout) +- - 1: stdout +- - 2: stderr ++ - 0: stdin (will be writen on stdout) ++ - 1: stdout ++ - 2: stderr + + `SIZE1, SIZE2, SIZE3, SIZE4` are the 4 bytes of + the uint32 size encoded as big endian. +@@ -568,7 +618,7 @@ page_keywords: API, Docker, rcli, REST, documentation + 4. Read the extracted size and output it on the correct output + 5. Goto 1) + +-### Wait a container: ++#### [Wait a container](#id16) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/wait`{.descname} + : Block until container `id` stops, then returns +@@ -587,11 +637,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Remove a container: ++#### [Remove a container](#id17) + + `DELETE `{.descname}`/containers/`{.descname}(*id*) + : Remove the container `id` from the filesystem +@@ -608,17 +658,17 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **v** – 1/True/true or 0/False/false, Remove the volumes ++ - **v** – 1/True/true or 0/False/false, Remove the volumes + associated to the container. Default false + + Status Codes: + +- - **204** – no error +- - **400** – bad parameter +- - **404** – no such container +- - **500** – server error ++ - **204** – no error ++ - **400** – bad parameter ++ - **404** – no such container ++ - **500** – server error + +-### Copy files or folders from a container: ++#### [Copy files or folders from a container](#id18) + + `POST `{.descname}`/containers/`{.descname}(*id*)`/copy`{.descname} + : Copy files or folders of container `id` +@@ -641,13 +691,13 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such container +- - **500** – server error ++ - **200** – no error ++ - **404** – no such container ++ - **500** – server error + +-## Images ++### [2.2 Images](#id19) + +-### List Images: ++#### [List Images](#id20) + + `GET `{.descname}`/images/json`{.descname} + : **Example request**: +@@ -684,7 +734,7 @@ page_keywords: API, Docker, rcli, REST, documentation + } + ] + +-### Create an image: ++#### [Create an image](#id21) + + `POST `{.descname}`/images/create`{.descname} + : Create an image, either by pull it from the registry or by importing +@@ -712,25 +762,24 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **fromImage** – name of the image to pull +- - **fromSrc** – source to import, - means stdin +- - **repo** – repository +- - **tag** – tag +- - **registry** – the registry to pull from ++ - **fromImage** – name of the image to pull ++ - **fromSrc** – source to import, - means stdin ++ - **repo** – repository ++ - **tag** – tag ++ - **registry** – the registry to pull from + + Request Headers: + +   + +- - **X-Registry-Auth** – base64-encoded AuthConfig object ++ - **X-Registry-Auth** – base64-encoded AuthConfig object + + Status Codes: + +- - **200** – no error +- - **500** – server error +- +-### Insert a file in an image: ++ - **200** – no error ++ - **500** – server error + ++#### [Insert a file in an image](#id22) + + `POST `{.descname}`/images/`{.descname}(*name*)`/insert`{.descname} + : Insert a file from `url` in the image +@@ -752,10 +801,10 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Inspect an image: ++#### [Inspect an image](#id23) + + `GET `{.descname}`/images/`{.descname}(*name*)`/json`{.descname} + : Return low-level information on the image `name` +@@ -800,11 +849,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such image +- - **500** – server error ++ - **200** – no error ++ - **404** – no such image ++ - **500** – server error + +-### Get the history of an image: ++#### [Get the history of an image](#id24) + + `GET `{.descname}`/images/`{.descname}(*name*)`/history`{.descname} + : Return the history of the image `name` +@@ -833,12 +882,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such image +- - **500** – server error +- +-### Push an image on the registry: ++ - **200** – no error ++ - **404** – no such image ++ - **500** – server error + ++#### [Push an image on the registry](#id25) + + `POST `{.descname}`/images/`{.descname}(*name*)`/push`{.descname} + : Push the image `name` on the registry +@@ -861,22 +909,22 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **registry** – the registry you wan to push, optional ++ - **registry** – the registry you wan to push, optional + + Request Headers: + +   + +- - **X-Registry-Auth** – include a base64-encoded AuthConfig ++ - **X-Registry-Auth** – include a base64-encoded AuthConfig + object. + + Status Codes: + +- - **200** – no error +- - **404** – no such image +- - **500** – server error ++ - **200** – no error ++ - **404** – no such image ++ - **500** – server error + +-### Tag an image into a repository: ++#### [Tag an image into a repository](#id26) + + `POST `{.descname}`/images/`{.descname}(*name*)`/tag`{.descname} + : Tag the image `name` into a repository +@@ -893,18 +941,18 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **repo** – The repository to tag in +- - **force** – 1/True/true or 0/False/false, default false ++ - **repo** – The repository to tag in ++ - **force** – 1/True/true or 0/False/false, default false + + Status Codes: + +- - **201** – no error +- - **400** – bad parameter +- - **404** – no such image +- - **409** – conflict +- - **500** – server error ++ - **201** – no error ++ - **400** – bad parameter ++ - **404** – no such image ++ - **409** – conflict ++ - **500** – server error + +-### Remove an image: ++#### [Remove an image](#id27) + + `DELETE `{.descname}`/images/`{.descname}(*name*) + : Remove the image `name` from the filesystem +@@ -926,12 +974,12 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **404** – no such image +- - **409** – conflict +- - **500** – server error ++ - **200** – no error ++ - **404** – no such image ++ - **409** – conflict ++ - **500** – server error + +-### Search images: ++#### [Search images](#id28) + + `GET `{.descname}`/images/search`{.descname} + : Search for an image in the docker index. +@@ -979,16 +1027,16 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **term** – term to search ++ - **term** – term to search + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-## Misc ++### [2.3 Misc](#id29) + +-### Build an image from Dockerfile: ++#### [Build an image from Dockerfile](#id30) + + `POST `{.descname}`/build`{.descname} + : Build an image from Dockerfile using a POST body. +@@ -1020,26 +1068,26 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **t** – repository name (and optionally a tag) to be applied to ++ - **t** – repository name (and optionally a tag) to be applied to + the resulting image in case of success +- - **q** – suppress verbose build output +- - **nocache** – do not use the cache when building the image +- - **rm** – Remove intermediate containers after a successful build ++ - **q** – suppress verbose build output ++ - **nocache** – do not use the cache when building the image ++ - **rm** – Remove intermediate containers after a successful build + + Request Headers: + +   + +- - **Content-type** – should be set to ++ - **Content-type** – should be set to + `"application/tar"`. +- - **X-Registry-Config** – base64-encoded ConfigFile object ++ - **X-Registry-Config** – base64-encoded ConfigFile object + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Check auth configuration: ++#### [Check auth configuration](#id31) + + `POST `{.descname}`/auth`{.descname} + : Get the default username and email +@@ -1062,11 +1110,11 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **204** – no error +- - **500** – server error ++ - **200** – no error ++ - **204** – no error ++ - **500** – server error + +-### Display system-wide information: ++#### [Display system-wide information](#id32) + + `GET `{.descname}`/info`{.descname} + : Display system-wide information +@@ -1093,10 +1141,10 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Show the docker version information: ++#### [Show the docker version information](#id33) + + `GET `{.descname}`/version`{.descname} + : Show the docker version information +@@ -1118,10 +1166,10 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Create a new image from a container’s changes: ++#### [Create a new image from a container’s changes](#id34) + + `POST `{.descname}`/commit`{.descname} + : Create a new image from a container’s changes +@@ -1141,22 +1189,22 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **container** – source container +- - **repo** – repository +- - **tag** – tag +- - **m** – commit message +- - **author** – author (eg. “John Hannibal Smith ++ - **container** – source container ++ - **repo** – repository ++ - **tag** – tag ++ - **m** – commit message ++ - **author** – author (eg. “John Hannibal Smith + \<[hannibal@a-team.com](mailto:hannibal%40a-team.com)\>”) +- - **run** – config automatically applied when the image is run. ++ - **run** – config automatically applied when the image is run. + (ex: {“Cmd”: [“cat”, “/world”], “PortSpecs”:[“22”]}) + + Status Codes: + +- - **201** – no error +- - **404** – no such container +- - **500** – server error ++ - **201** – no error ++ - **404** – no such container ++ - **500** – server error + +-### Monitor Docker’s events: ++#### [Monitor Docker’s events](#id35) + + `GET `{.descname}`/events`{.descname} + : Get events from docker, either in real time via streaming, or via +@@ -1180,14 +1228,14 @@ page_keywords: API, Docker, rcli, REST, documentation + +   + +- - **since** – timestamp used for polling ++ - **since** – timestamp used for polling + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Get a tarball containing all images and tags in a repository: ++#### [Get a tarball containing all images and tags in a repository](#id36) + + `GET `{.descname}`/images/`{.descname}(*name*)`/get`{.descname} + : Get a tarball containing all images and metadata for the repository +@@ -1206,10 +1254,10 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-### Load a tarball with a set of images and tags into docker: ++#### [Load a tarball with a set of images and tags into docker](#id37) + + `POST `{.descname}`/images/load`{.descname} + : Load a set of images and tags into the docker repository. +@@ -1226,38 +1274,38 @@ page_keywords: API, Docker, rcli, REST, documentation + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + +-## Going Further ++## [3. Going further](#id38) + +-### Inside ‘docker run’ ++### [3.1 Inside ‘docker run’](#id39) + + Here are the steps of ‘docker run’ : + +-- Create the container ++- Create the container + +-- If the status code is 404, it means the image doesn’t exists: +- : - Try to pull it +- - Then retry to create the container ++- If the status code is 404, it means the image doesn’t exists: ++ : - Try to pull it ++ - Then retry to create the container + +-- Start the container ++- Start the container + +-- If you are not in detached mode: +- : - Attach to the container, using logs=1 (to have stdout and ++- If you are not in detached mode: ++ : - Attach to the container, using logs=1 (to have stdout and + stderr from the container’s start) and stream=1 + +-- If in detached mode or only stdin is attached: +- : - Display the container’s id ++- If in detached mode or only stdin is attached: ++ : - Display the container’s id + +-### Hijacking ++### [3.2 Hijacking](#id40) + + In this version of the API, /attach, uses hijacking to transport stdin, + stdout and stderr on the same socket. This might change in the future. + +-### CORS Requests ++### [3.3 CORS Requests](#id41) + + To enable cross origin requests to the remote api add the flag +-“-api-enable-cors” when running docker in daemon mode. ++“–api-enable-cors” when running docker in daemon mode. + +- docker -d -H="192.168.1.9:4243" -api-enable-cors ++ docker -d -H="192.168.1.9:4243" --api-enable-cors +diff --git a/docs/sources/reference/api/index_api.md b/docs/sources/reference/api/index_api.md +index 83cf36b..e9bcc2b 100644 +--- a/docs/sources/reference/api/index_api.md ++++ b/docs/sources/reference/api/index_api.md +@@ -4,17 +4,19 @@ page_keywords: API, Docker, index, REST, documentation + + # Docker Index API + +-## Introduction ++## 1. Brief introduction + +-- This is the REST API for the Docker index +-- Authorization is done with basic auth over SSL +-- Not all commands require authentication, only those noted as such. ++- This is the REST API for the Docker index ++- Authorization is done with basic auth over SSL ++- Not all commands require authentication, only those noted as such. + +-## Repository ++## 2. Endpoints + +-### Repositories ++### 2.1 Repository + +-### User Repo ++#### Repositories ++ ++##### User Repo + + `PUT `{.descname}`/v1/repositories/`{.descname}(*namespace*)`/`{.descname}(*repo\_name*)`/`{.descname} + : Create a user repository with the given `namespace`{.docutils +@@ -33,8 +35,8 @@ page_keywords: API, Docker, index, REST, documentation + + Parameters: + +- - **namespace** – the namespace for the repo +- - **repo\_name** – the name for the repo ++ - **namespace** – the namespace for the repo ++ - **repo\_name** – the name for the repo + + **Example Response**: + +@@ -49,10 +51,10 @@ page_keywords: API, Docker, index, REST, documentation + + Status Codes: + +- - **200** – Created +- - **400** – Errors (invalid json, missing or invalid fields, etc) +- - **401** – Unauthorized +- - **403** – Account is not Active ++ - **200** – Created ++ - **400** – Errors (invalid json, missing or invalid fields, etc) ++ - **401** – Unauthorized ++ - **403** – Account is not Active + + `DELETE `{.descname}`/v1/repositories/`{.descname}(*namespace*)`/`{.descname}(*repo\_name*)`/`{.descname} + : Delete a user repository with the given `namespace`{.docutils +@@ -71,8 +73,8 @@ page_keywords: API, Docker, index, REST, documentation + + Parameters: + +- - **namespace** – the namespace for the repo +- - **repo\_name** – the name for the repo ++ - **namespace** – the namespace for the repo ++ - **repo\_name** – the name for the repo + + **Example Response**: + +@@ -87,13 +89,13 @@ page_keywords: API, Docker, index, REST, documentation + + Status Codes: + +- - **200** – Deleted +- - **202** – Accepted +- - **400** – Errors (invalid json, missing or invalid fields, etc) +- - **401** – Unauthorized +- - **403** – Account is not Active ++ - **200** – Deleted ++ - **202** – Accepted ++ - **400** – Errors (invalid json, missing or invalid fields, etc) ++ - **401** – Unauthorized ++ - **403** – Account is not Active + +-### Library Repo ++##### Library Repo + + `PUT `{.descname}`/v1/repositories/`{.descname}(*repo\_name*)`/`{.descname} + : Create a library repository with the given `repo_name`{.docutils +@@ -116,7 +118,7 @@ page_keywords: API, Docker, index, REST, documentation + + Parameters: + +- - **repo\_name** – the library name for the repo ++ - **repo\_name** – the library name for the repo + + **Example Response**: + +@@ -131,10 +133,10 @@ page_keywords: API, Docker, index, REST, documentation + + Status Codes: + +- - **200** – Created +- - **400** – Errors (invalid json, missing or invalid fields, etc) +- - **401** – Unauthorized +- - **403** – Account is not Active ++ - **200** – Created ++ - **400** – Errors (invalid json, missing or invalid fields, etc) ++ - **401** – Unauthorized ++ - **403** – Account is not Active + + `DELETE `{.descname}`/v1/repositories/`{.descname}(*repo\_name*)`/`{.descname} + : Delete a library repository with the given `repo_name`{.docutils +@@ -157,7 +159,7 @@ page_keywords: API, Docker, index, REST, documentation + + Parameters: + +- - **repo\_name** – the library name for the repo ++ - **repo\_name** – the library name for the repo + + **Example Response**: + +@@ -172,15 +174,15 @@ page_keywords: API, Docker, index, REST, documentation + + Status Codes: + +- - **200** – Deleted +- - **202** – Accepted +- - **400** – Errors (invalid json, missing or invalid fields, etc) +- - **401** – Unauthorized +- - **403** – Account is not Active ++ - **200** – Deleted ++ - **202** – Accepted ++ - **400** – Errors (invalid json, missing or invalid fields, etc) ++ - **401** – Unauthorized ++ - **403** – Account is not Active + +-### Repository Images ++#### Repository Images + +-### User Repo Images ++##### User Repo Images + + `PUT `{.descname}`/v1/repositories/`{.descname}(*namespace*)`/`{.descname}(*repo\_name*)`/images`{.descname} + : Update the images for a user repo. +@@ -198,8 +200,8 @@ page_keywords: API, Docker, index, REST, documentation + + Parameters: + +- - **namespace** – the namespace for the repo +- - **repo\_name** – the name for the repo ++ - **namespace** – the namespace for the repo ++ - **repo\_name** – the name for the repo + + **Example Response**: + +@@ -211,10 +213,10 @@ page_keywords: API, Docker, index, REST, documentation + + Status Codes: + +- - **204** – Created +- - **400** – Errors (invalid json, missing or invalid fields, etc) +- - **401** – Unauthorized +- - **403** – Account is not Active or permission denied ++ - **204** – Created ++ - **400** – Errors (invalid json, missing or invalid fields, etc) ++ - **401** – Unauthorized ++ - **403** – Account is not Active or permission denied + + `GET `{.descname}`/v1/repositories/`{.descname}(*namespace*)`/`{.descname}(*repo\_name*)`/images`{.descname} + : get the images for a user repo. +@@ -227,8 +229,8 @@ page_keywords: API, Docker, index, REST, documentation + + Parameters: + +- - **namespace** – the namespace for the repo +- - **repo\_name** – the name for the repo ++ - **namespace** – the namespace for the repo ++ - **repo\_name** – the name for the repo + + **Example Response**: + +@@ -243,10 +245,10 @@ page_keywords: API, Docker, index, REST, documentation + + Status Codes: + +- - **200** – OK +- - **404** – Not found ++ - **200** – OK ++ - **404** – Not found + +-### Library Repo Images ++##### Library Repo Images + + `PUT `{.descname}`/v1/repositories/`{.descname}(*repo\_name*)`/images`{.descname} + : Update the images for a library repo. +@@ -264,7 +266,7 @@ page_keywords: API, Docker, index, REST, documentation + + Parameters: + +- - **repo\_name** – the library name for the repo ++ - **repo\_name** – the library name for the repo + + **Example Response**: + +@@ -276,10 +278,10 @@ page_keywords: API, Docker, index, REST, documentation + + Status Codes: + +- - **204** – Created +- - **400** – Errors (invalid json, missing or invalid fields, etc) +- - **401** – Unauthorized +- - **403** – Account is not Active or permission denied ++ - **204** – Created ++ - **400** – Errors (invalid json, missing or invalid fields, etc) ++ - **401** – Unauthorized ++ - **403** – Account is not Active or permission denied + + `GET `{.descname}`/v1/repositories/`{.descname}(*repo\_name*)`/images`{.descname} + : get the images for a library repo. +@@ -292,7 +294,7 @@ page_keywords: API, Docker, index, REST, documentation + + Parameters: + +- - **repo\_name** – the library name for the repo ++ - **repo\_name** – the library name for the repo + + **Example Response**: + +@@ -307,12 +309,12 @@ page_keywords: API, Docker, index, REST, documentation + + Status Codes: + +- - **200** – OK +- - **404** – Not found ++ - **200** – OK ++ - **404** – Not found + +-### Repository Authorization ++#### Repository Authorization + +-### Library Repo ++##### Library Repo + + `PUT `{.descname}`/v1/repositories/`{.descname}(*repo\_name*)`/auth`{.descname} + : authorize a token for a library repo +@@ -326,7 +328,7 @@ page_keywords: API, Docker, index, REST, documentation + + Parameters: + +- - **repo\_name** – the library name for the repo ++ - **repo\_name** – the library name for the repo + + **Example Response**: + +@@ -338,11 +340,11 @@ page_keywords: API, Docker, index, REST, documentation + + Status Codes: + +- - **200** – OK +- - **403** – Permission denied +- - **404** – Not found ++ - **200** – OK ++ - **403** – Permission denied ++ - **404** – Not found + +-### User Repo ++##### User Repo + + `PUT `{.descname}`/v1/repositories/`{.descname}(*namespace*)`/`{.descname}(*repo\_name*)`/auth`{.descname} + : authorize a token for a user repo +@@ -356,8 +358,8 @@ page_keywords: API, Docker, index, REST, documentation + + Parameters: + +- - **namespace** – the namespace for the repo +- - **repo\_name** – the name for the repo ++ - **namespace** – the namespace for the repo ++ - **repo\_name** – the name for the repo + + **Example Response**: + +@@ -369,13 +371,13 @@ page_keywords: API, Docker, index, REST, documentation + + Status Codes: + +- - **200** – OK +- - **403** – Permission denied +- - **404** – Not found ++ - **200** – OK ++ - **403** – Permission denied ++ - **404** – Not found + +-### Users ++### 2.2 Users + +-### User Login ++#### User Login + + `GET `{.descname}`/v1/users`{.descname} + : If you want to check your login, you can try this endpoint +@@ -397,11 +399,11 @@ page_keywords: API, Docker, index, REST, documentation + + Status Codes: + +- - **200** – no error +- - **401** – Unauthorized +- - **403** – Account is not Active ++ - **200** – no error ++ - **401** – Unauthorized ++ - **403** – Account is not Active + +-### User Register ++#### User Register + + `POST `{.descname}`/v1/users`{.descname} + : Registering a new account. +@@ -421,10 +423,10 @@ page_keywords: API, Docker, index, REST, documentation + +   + +- - **email** – valid email address, that needs to be confirmed +- - **username** – min 4 character, max 30 characters, must match ++ - **email** – valid email address, that needs to be confirmed ++ - **username** – min 4 character, max 30 characters, must match + the regular expression [a-z0-9\_]. +- - **password** – min 5 characters ++ - **password** – min 5 characters + + **Example Response**: + +@@ -436,10 +438,10 @@ page_keywords: API, Docker, index, REST, documentation + + Status Codes: + +- - **201** – User Created +- - **400** – Errors (invalid json, missing or invalid fields, etc) ++ - **201** – User Created ++ - **400** – Errors (invalid json, missing or invalid fields, etc) + +-### Update User ++#### Update User + + `PUT `{.descname}`/v1/users/`{.descname}(*username*)`/`{.descname} + : Change a password or email address for given user. If you pass in an +@@ -463,7 +465,7 @@ page_keywords: API, Docker, index, REST, documentation + + Parameters: + +- - **username** – username for the person you want to update ++ - **username** – username for the person you want to update + + **Example Response**: + +@@ -475,17 +477,17 @@ page_keywords: API, Docker, index, REST, documentation + + Status Codes: + +- - **204** – User Updated +- - **400** – Errors (invalid json, missing or invalid fields, etc) +- - **401** – Unauthorized +- - **403** – Account is not Active +- - **404** – User not found ++ - **204** – User Updated ++ - **400** – Errors (invalid json, missing or invalid fields, etc) ++ - **401** – Unauthorized ++ - **403** – Account is not Active ++ - **404** – User not found + +-## Search ++### 2.3 Search + + If you need to search the index, this is the endpoint you would use. + +-### Search ++#### Search + + `GET `{.descname}`/v1/search`{.descname} + : Search the Index given a search term. It accepts +@@ -515,11 +517,13 @@ If you need to search the index, this is the endpoint you would use. + + Query Parameters: + +- - **q** – what you want to search for ++   ++ ++ - **q** – what you want to search for + + Status Codes: + +- - **200** – no error +- - **500** – server error ++ - **200** – no error ++ - **500** – server error + + +diff --git a/docs/sources/reference/api/registry_api.md b/docs/sources/reference/api/registry_api.md +index e067586..f251169 100644 +--- a/docs/sources/reference/api/registry_api.md ++++ b/docs/sources/reference/api/registry_api.md +@@ -4,34 +4,34 @@ page_keywords: API, Docker, index, registry, REST, documentation + + # Docker Registry API + +-## Introduction ++## 1. Brief introduction + +-- This is the REST API for the Docker Registry +-- It stores the images and the graph for a set of repositories +-- It does not have user accounts data +-- It has no notion of user accounts or authorization +-- It delegates authentication and authorization to the Index Auth ++- This is the REST API for the Docker Registry ++- It stores the images and the graph for a set of repositories ++- It does not have user accounts data ++- It has no notion of user accounts or authorization ++- It delegates authentication and authorization to the Index Auth + service using tokens +-- It supports different storage backends (S3, cloud files, local FS) +-- It doesn’t have a local database +-- It will be open-sourced at some point ++- It supports different storage backends (S3, cloud files, local FS) ++- It doesn’t have a local database ++- It will be open-sourced at some point + + We expect that there will be multiple registries out there. To help to + grasp the context, here are some examples of registries: + +-- **sponsor registry**: such a registry is provided by a third-party ++- **sponsor registry**: such a registry is provided by a third-party + hosting infrastructure as a convenience for their customers and the + docker community as a whole. Its costs are supported by the third + party, but the management and operation of the registry are + supported by dotCloud. It features read/write access, and delegates + authentication and authorization to the Index. +-- **mirror registry**: such a registry is provided by a third-party ++- **mirror registry**: such a registry is provided by a third-party + hosting infrastructure but is targeted at their customers only. Some + mechanism (unspecified to date) ensures that public images are + pulled from a sponsor registry to the mirror registry, to make sure + that the customers of the third-party provider can “docker pull” + those images locally. +-- **vendor registry**: such a registry is provided by a software ++- **vendor registry**: such a registry is provided by a software + vendor, who wants to distribute docker images. It would be operated + and managed by the vendor. Only users authorized by the vendor would + be able to get write access. Some images would be public (accessible +@@ -41,7 +41,7 @@ grasp the context, here are some examples of registries: + basho/riak1.3” and automatically push from the vendor registry + (instead of a sponsor registry); i.e. get all the convenience of a + sponsor registry, while retaining control on the asset distribution. +-- **private registry**: such a registry is located behind a firewall, ++- **private registry**: such a registry is located behind a firewall, + or protected by an additional security layer (HTTP authorization, + SSL client-side certificates, IP address authorization...). The + registry is operated by a private entity, outside of dotCloud’s +@@ -58,9 +58,9 @@ can be powered by a simple static HTTP server. + Note + + The latter implies that while HTTP is the protocol of choice for a registry, multiple schemes are possible (and in some cases, trivial): +-: - HTTP with GET (and PUT for read-write registries); +- - local mount point; +- - remote docker addressed through SSH. ++: - HTTP with GET (and PUT for read-write registries); ++ - local mount point; ++ - remote docker addressed through SSH. + + The latter would only require two new commands in docker, e.g. + `registryget` and `registryput`{.docutils .literal}, +@@ -68,11 +68,11 @@ wrapping access to the local filesystem (and optionally doing + consistency checks). Authentication and authorization are then delegated + to SSH (e.g. with public keys). + +-## Endpoints ++## 2. Endpoints + +-### Images ++### 2.1 Images + +-### Layer ++#### Layer + + `GET `{.descname}`/v1/images/`{.descname}(*image\_id*)`/layer`{.descname} + : get image layer for a given `image_id` +@@ -87,7 +87,7 @@ to SSH (e.g. with public keys). + + Parameters: + +- - **image\_id** – the id for the layer you want to get ++ - **image\_id** – the id for the layer you want to get + + **Example Response**: + +@@ -100,9 +100,9 @@ to SSH (e.g. with public keys). + + Status Codes: + +- - **200** – OK +- - **401** – Requires authorization +- - **404** – Image not found ++ - **200** – OK ++ - **401** – Requires authorization ++ - **404** – Image not found + + `PUT `{.descname}`/v1/images/`{.descname}(*image\_id*)`/layer`{.descname} + : put image layer for a given `image_id` +@@ -118,7 +118,7 @@ to SSH (e.g. with public keys). + + Parameters: + +- - **image\_id** – the id for the layer you want to get ++ - **image\_id** – the id for the layer you want to get + + **Example Response**: + +@@ -131,11 +131,11 @@ to SSH (e.g. with public keys). + + Status Codes: + +- - **200** – OK +- - **401** – Requires authorization +- - **404** – Image not found ++ - **200** – OK ++ - **401** – Requires authorization ++ - **404** – Image not found + +-### Image ++#### Image + + `PUT `{.descname}`/v1/images/`{.descname}(*image\_id*)`/json`{.descname} + : put image for a given `image_id` +@@ -181,7 +181,7 @@ to SSH (e.g. with public keys). + + Parameters: + +- - **image\_id** – the id for the layer you want to get ++ - **image\_id** – the id for the layer you want to get + + **Example Response**: + +@@ -194,8 +194,8 @@ to SSH (e.g. with public keys). + + Status Codes: + +- - **200** – OK +- - **401** – Requires authorization ++ - **200** – OK ++ - **401** – Requires authorization + + `GET `{.descname}`/v1/images/`{.descname}(*image\_id*)`/json`{.descname} + : get image for a given `image_id` +@@ -210,7 +210,7 @@ to SSH (e.g. with public keys). + + Parameters: + +- - **image\_id** – the id for the layer you want to get ++ - **image\_id** – the id for the layer you want to get + + **Example Response**: + +@@ -254,11 +254,11 @@ to SSH (e.g. with public keys). + + Status Codes: + +- - **200** – OK +- - **401** – Requires authorization +- - **404** – Image not found ++ - **200** – OK ++ - **401** – Requires authorization ++ - **404** – Image not found + +-### Ancestry ++#### Ancestry + + `GET `{.descname}`/v1/images/`{.descname}(*image\_id*)`/ancestry`{.descname} + : get ancestry for an image given an `image_id` +@@ -273,7 +273,7 @@ to SSH (e.g. with public keys). + + Parameters: + +- - **image\_id** – the id for the layer you want to get ++ - **image\_id** – the id for the layer you want to get + + **Example Response**: + +@@ -289,11 +289,11 @@ to SSH (e.g. with public keys). + + Status Codes: + +- - **200** – OK +- - **401** – Requires authorization +- - **404** – Image not found ++ - **200** – OK ++ - **401** – Requires authorization ++ - **404** – Image not found + +-### Tags ++### 2.2 Tags + + `GET `{.descname}`/v1/repositories/`{.descname}(*namespace*)`/`{.descname}(*repository*)`/tags`{.descname} + : get all of the tags for the given repo. +@@ -309,8 +309,8 @@ to SSH (e.g. with public keys). + + Parameters: + +- - **namespace** – namespace for the repo +- - **repository** – name for the repo ++ - **namespace** – namespace for the repo ++ - **repository** – name for the repo + + **Example Response**: + +@@ -326,9 +326,9 @@ to SSH (e.g. with public keys). + + Status Codes: + +- - **200** – OK +- - **401** – Requires authorization +- - **404** – Repository not found ++ - **200** – OK ++ - **401** – Requires authorization ++ - **404** – Repository not found + + `GET `{.descname}`/v1/repositories/`{.descname}(*namespace*)`/`{.descname}(*repository*)`/tags/`{.descname}(*tag*) + : get a tag for the given repo. +@@ -344,9 +344,9 @@ to SSH (e.g. with public keys). + + Parameters: + +- - **namespace** – namespace for the repo +- - **repository** – name for the repo +- - **tag** – name of tag you want to get ++ - **namespace** – namespace for the repo ++ - **repository** – name for the repo ++ - **tag** – name of tag you want to get + + **Example Response**: + +@@ -359,9 +359,9 @@ to SSH (e.g. with public keys). + + Status Codes: + +- - **200** – OK +- - **401** – Requires authorization +- - **404** – Tag not found ++ - **200** – OK ++ - **401** – Requires authorization ++ - **404** – Tag not found + + `DELETE `{.descname}`/v1/repositories/`{.descname}(*namespace*)`/`{.descname}(*repository*)`/tags/`{.descname}(*tag*) + : delete the tag for the repo +@@ -376,9 +376,9 @@ to SSH (e.g. with public keys). + + Parameters: + +- - **namespace** – namespace for the repo +- - **repository** – name for the repo +- - **tag** – name of tag you want to delete ++ - **namespace** – namespace for the repo ++ - **repository** – name for the repo ++ - **tag** – name of tag you want to delete + + **Example Response**: + +@@ -391,9 +391,9 @@ to SSH (e.g. with public keys). + + Status Codes: + +- - **200** – OK +- - **401** – Requires authorization +- - **404** – Tag not found ++ - **200** – OK ++ - **401** – Requires authorization ++ - **404** – Tag not found + + `PUT `{.descname}`/v1/repositories/`{.descname}(*namespace*)`/`{.descname}(*repository*)`/tags/`{.descname}(*tag*) + : put a tag for the given repo. +@@ -410,9 +410,9 @@ to SSH (e.g. with public keys). + + Parameters: + +- - **namespace** – namespace for the repo +- - **repository** – name for the repo +- - **tag** – name of tag you want to add ++ - **namespace** – namespace for the repo ++ - **repository** – name for the repo ++ - **tag** – name of tag you want to add + + **Example Response**: + +@@ -425,12 +425,12 @@ to SSH (e.g. with public keys). + + Status Codes: + +- - **200** – OK +- - **400** – Invalid data +- - **401** – Requires authorization +- - **404** – Image not found ++ - **200** – OK ++ - **400** – Invalid data ++ - **401** – Requires authorization ++ - **404** – Image not found + +-### Repositories ++### 2.3 Repositories + + `DELETE `{.descname}`/v1/repositories/`{.descname}(*namespace*)`/`{.descname}(*repository*)`/`{.descname} + : delete a repository +@@ -447,8 +447,8 @@ to SSH (e.g. with public keys). + + Parameters: + +- - **namespace** – namespace for the repo +- - **repository** – name for the repo ++ - **namespace** – namespace for the repo ++ - **repository** – name for the repo + + **Example Response**: + +@@ -461,11 +461,11 @@ to SSH (e.g. with public keys). + + Status Codes: + +- - **200** – OK +- - **401** – Requires authorization +- - **404** – Repository not found ++ - **200** – OK ++ - **401** – Requires authorization ++ - **404** – Repository not found + +-### Status ++### 2.4 Status + + `GET `{.descname}`/v1/_ping`{.descname} + : Check status of the registry. This endpoint is also used to +@@ -491,9 +491,9 @@ to SSH (e.g. with public keys). + + Status Codes: + +- - **200** – OK ++ - **200** – OK + +-## Authorization ++## 3 Authorization + + This is where we describe the authorization process, including the + tokens and cookies. +diff --git a/docs/sources/reference/api/registry_index_spec.md b/docs/sources/reference/api/registry_index_spec.md +index dc0dd80..281fe07 100644 +--- a/docs/sources/reference/api/registry_index_spec.md ++++ b/docs/sources/reference/api/registry_index_spec.md +@@ -4,55 +4,55 @@ page_keywords: docker, registry, api, index + + # Registry & Index Spec + +-## The 3 roles ++## 1. The 3 roles + +-### Index ++### 1.1 Index + + The Index is responsible for centralizing information about: + +-- User accounts +-- Checksums of the images +-- Public namespaces ++- User accounts ++- Checksums of the images ++- Public namespaces + + The Index has different components: + +-- Web UI +-- Meta-data store (comments, stars, list public repositories) +-- Authentication service +-- Tokenization ++- Web UI ++- Meta-data store (comments, stars, list public repositories) ++- Authentication service ++- Tokenization + + The index is authoritative for those information. + + We expect that there will be only one instance of the index, run and + managed by Docker Inc. + +-### Registry ++### 1.2 Registry + +-- It stores the images and the graph for a set of repositories +-- It does not have user accounts data +-- It has no notion of user accounts or authorization +-- It delegates authentication and authorization to the Index Auth ++- It stores the images and the graph for a set of repositories ++- It does not have user accounts data ++- It has no notion of user accounts or authorization ++- It delegates authentication and authorization to the Index Auth + service using tokens +-- It supports different storage backends (S3, cloud files, local FS) +-- It doesn’t have a local database +-- [Source Code](https://github.com/dotcloud/docker-registry) ++- It supports different storage backends (S3, cloud files, local FS) ++- It doesn’t have a local database ++- [Source Code](https://github.com/dotcloud/docker-registry) + + We expect that there will be multiple registries out there. To help to + grasp the context, here are some examples of registries: + +-- **sponsor registry**: such a registry is provided by a third-party ++- **sponsor registry**: such a registry is provided by a third-party + hosting infrastructure as a convenience for their customers and the + docker community as a whole. Its costs are supported by the third + party, but the management and operation of the registry are + supported by dotCloud. It features read/write access, and delegates + authentication and authorization to the Index. +-- **mirror registry**: such a registry is provided by a third-party ++- **mirror registry**: such a registry is provided by a third-party + hosting infrastructure but is targeted at their customers only. Some + mechanism (unspecified to date) ensures that public images are + pulled from a sponsor registry to the mirror registry, to make sure + that the customers of the third-party provider can “docker pull” + those images locally. +-- **vendor registry**: such a registry is provided by a software ++- **vendor registry**: such a registry is provided by a software + vendor, who wants to distribute docker images. It would be operated + and managed by the vendor. Only users authorized by the vendor would + be able to get write access. Some images would be public (accessible +@@ -62,20 +62,19 @@ grasp the context, here are some examples of registries: + basho/riak1.3” and automatically push from the vendor registry + (instead of a sponsor registry); i.e. get all the convenience of a + sponsor registry, while retaining control on the asset distribution. +-- **private registry**: such a registry is located behind a firewall, ++- **private registry**: such a registry is located behind a firewall, + or protected by an additional security layer (HTTP authorization, + SSL client-side certificates, IP address authorization...). The + registry is operated by a private entity, outside of dotCloud’s + control. It can optionally delegate additional authorization to the + Index, but it is not mandatory. + +-> **Note:** The latter implies that while HTTP is the protocol +-> of choice for a registry, multiple schemes are possible (and +-> in some cases, trivial): +-> +-> - HTTP with GET (and PUT for read-write registries); +-> - local mount point; +-> - remote docker addressed through SSH. ++Note ++ ++The latter implies that while HTTP is the protocol of choice for a registry, multiple schemes are possible (and in some cases, trivial): ++: - HTTP with GET (and PUT for read-write registries); ++ - local mount point; ++ - remote docker addressed through SSH. + + The latter would only require two new commands in docker, e.g. + `registryget` and `registryput`{.docutils .literal}, +@@ -83,17 +82,17 @@ wrapping access to the local filesystem (and optionally doing + consistency checks). Authentication and authorization are then delegated + to SSH (e.g. with public keys). + +-### Docker ++### 1.3 Docker + + On top of being a runtime for LXC, Docker is the Registry client. It + supports: + +-- Push / Pull on the registry +-- Client authentication on the Index ++- Push / Pull on the registry ++- Client authentication on the Index + +-## Workflow ++## 2. Workflow + +-### Pull ++### 2.1 Pull + + ![](../../../_images/docker_pull_chart.png) + +@@ -147,9 +146,9 @@ and for an active account. + 2. (Index -\> Docker) HTTP 200 OK + + > **Headers**: +- > : - Authorization: Token ++ > : - Authorization: Token + > signature=123abc,repository=”foo/bar”,access=write +- > - X-Docker-Endpoints: registry.docker.io [, ++ > - X-Docker-Endpoints: registry.docker.io [, + > registry2.docker.io] + > + > **Body**: +@@ -188,7 +187,7 @@ Note + If someone makes a second request, then we will always give a new token, + never reuse tokens. + +-### Push ++### 2.2 Push + + ![](../../../_images/docker_push_chart.png) + +@@ -204,15 +203,17 @@ never reuse tokens. + pushed by docker and store the repository (with its images) + 6. docker contacts the index to give checksums for upload images + +-> **Note:** +-> **It’s possible not to use the Index at all!** In this case, a deployed +-> version of the Registry is deployed to store and serve images. Those +-> images are not authenticated and the security is not guaranteed. ++Note ++ ++**It’s possible not to use the Index at all!** In this case, a deployed ++version of the Registry is deployed to store and serve images. Those ++images are not authenticated and the security is not guaranteed. ++ ++Note + +-> **Note:** +-> **Index can be replaced!** For a private Registry deployed, a custom +-> Index can be used to serve and validate token according to different +-> policies. ++**Index can be replaced!** For a private Registry deployed, a custom ++Index can be used to serve and validate token according to different ++policies. + + Docker computes the checksums and submit them to the Index at the end of + the push. When a repository name does not have checksums on the Index, +@@ -227,7 +228,7 @@ the end). + true + + **Action**:: +- : - in index, we allocated a new repository, and set to ++ : - in index, we allocated a new repository, and set to + initialized + + **Body**:: +@@ -239,9 +240,9 @@ the end). + + 2. (Index -\> Docker) 200 Created + : **Headers**: +- : - WWW-Authenticate: Token ++ : - WWW-Authenticate: Token + signature=123abc,repository=”foo/bar”,access=write +- - X-Docker-Endpoints: registry.docker.io [, ++ - X-Docker-Endpoints: registry.docker.io [, + registry2.docker.io] + + 3. (Docker -\> Registry) PUT /v1/images/98765432\_parent/json +@@ -255,18 +256,18 @@ the end). + signature=123abc,repository=”foo/bar”,access=write + + **Action**:: +- : - Index: ++ : - Index: + : will invalidate the token. + +- - Registry: ++ - Registry: + : grants a session (if token is approved) and fetches + the images id + + 5. (Docker -\> Registry) PUT /v1/images/98765432\_parent/json + : **Headers**:: +- : - Authorization: Token ++ : - Authorization: Token + signature=123abc,repository=”foo/bar”,access=write +- - Cookie: (Cookie provided by the Registry) ++ - Cookie: (Cookie provided by the Registry) + + 6. (Docker -\> Registry) PUT /v1/images/98765432/json + : **Headers**: +@@ -303,17 +304,19 @@ the end). + + **Return** HTTP 204 + +-> **Note:** If push fails and they need to start again, what happens in the index, +-> there will already be a record for the namespace/name, but it will be +-> initialized. Should we allow it, or mark as name already used? One edge +-> case could be if someone pushes the same thing at the same time with two +-> different shells. ++Note ++ ++If push fails and they need to start again, what happens in the index, ++there will already be a record for the namespace/name, but it will be ++initialized. Should we allow it, or mark as name already used? One edge ++case could be if someone pushes the same thing at the same time with two ++different shells. + + If it’s a retry on the Registry, Docker has a cookie (provided by the + registry after token validation). So the Index won’t have to provide a + new token. + +-### Delete ++### 2.3 Delete + + If you need to delete something from the index or registry, we need a + nice clean way to do that. Here is the workflow. +@@ -333,9 +336,11 @@ nice clean way to do that. Here is the workflow. + 6. docker contacts the index to let it know it was removed from the + registry, the index removes all records from the database. + +-> **Note:** The Docker client should present an “Are you sure?” prompt to confirm +-> the deletion before starting the process. Once it starts it can’t be +-> undone. ++Note ++ ++The Docker client should present an “Are you sure?” prompt to confirm ++the deletion before starting the process. Once it starts it can’t be ++undone. + + #### API (deleting repository foo/bar): + +@@ -345,7 +350,7 @@ nice clean way to do that. Here is the workflow. + true + + **Action**:: +- : - in index, we make sure it is a valid repository, and set ++ : - in index, we make sure it is a valid repository, and set + to deleted (logically) + + **Body**:: +@@ -353,9 +358,9 @@ nice clean way to do that. Here is the workflow. + + 2. (Index -\> Docker) 202 Accepted + : **Headers**: +- : - WWW-Authenticate: Token ++ : - WWW-Authenticate: Token + signature=123abc,repository=”foo/bar”,access=delete +- - X-Docker-Endpoints: registry.docker.io [, ++ - X-Docker-Endpoints: registry.docker.io [, + registry2.docker.io] \# list of endpoints where this + repo lives. + +@@ -370,10 +375,10 @@ nice clean way to do that. Here is the workflow. + signature=123abc,repository=”foo/bar”,access=delete + + **Action**:: +- : - Index: ++ : - Index: + : will invalidate the token. + +- - Registry: ++ - Registry: + : deletes the repository (if token is approved) + + 5. (Registry -\> Docker) 200 OK +@@ -391,20 +396,20 @@ nice clean way to do that. Here is the workflow. + > + > **Return** HTTP 200 + +-## How to use the Registry in standalone mode ++## 3. How to use the Registry in standalone mode + + 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 -\> ++- Resolve short names (to avoid passing absolute URLs all the time) ++ : - username/projectname -\> + https://registry.docker.io/users/\/repositories/\/ +- - team/projectname -\> ++ - team/projectname -\> + https://registry.docker.io/team/\/repositories/\/ + +-- Authenticate a user as a repos owner (for a central referenced ++- Authenticate a user as a repos owner (for a central referenced + repository) + +-### Without an Index ++### 3.1 Without an Index + + Using the Registry without the Index can be useful to store the images + on a private network without having to rely on an external entity +@@ -425,12 +430,12 @@ As hinted previously, a standalone registry can also be implemented by + any HTTP server handling GET/PUT requests (or even only GET requests if + no write access is necessary). + +-### With an Index ++### 3.2 With an Index + + The Index data needed by the Registry are simple: + +-- Serve the checksums +-- Provide and authorize a Token ++- Serve the checksums ++- Provide and authorize a Token + + In the scenario of a Registry running on a private network with the need + of centralizing and authorizing, it’s easy to use a custom Index. +@@ -441,12 +446,12 @@ specific Index, it’ll be the private entity responsibility (basically + the organization who uses Docker in a private environment) to maintain + the Index and the Docker’s configuration among its consumers. + +-## The API ++## 4. The API + + The first version of the api is available here: + [https://github.com/jpetazzo/docker/blob/acd51ecea8f5d3c02b00a08176171c59442df8b3/docs/images-repositories-push-pull.md](https://github.com/jpetazzo/docker/blob/acd51ecea8f5d3c02b00a08176171c59442df8b3/docs/images-repositories-push-pull.md) + +-### Images ++### 4.1 Images + + The format returned in the images is not defined here (for layer and + JSON), basically because Registry stores exactly the same kind of +@@ -464,9 +469,9 @@ file is empty. + GET /v1/images//ancestry + PUT /v1/images//ancestry + +-### Users ++### 4.2 Users + +-### Create a user (Index) ++#### 4.2.1 Create a user (Index) + + POST /v1/users + +@@ -474,9 +479,9 @@ POST /v1/users + : {“email”: “[sam@dotcloud.com](mailto:sam%40dotcloud.com)”, + “password”: “toto42”, “username”: “foobar”’} + **Validation**: +-: - **username**: min 4 character, max 30 characters, must match the ++: - **username**: min 4 character, max 30 characters, must match the + regular expression [a-z0-9\_]. +- - **password**: min 5 characters ++ - **password**: min 5 characters + + **Valid**: return HTTP 200 + +@@ -489,7 +494,7 @@ Note + A user account will be valid only if the email has been validated (a + validation link is sent to the email address). + +-### Update a user (Index) ++#### 4.2.2 Update a user (Index) + + PUT /v1/users/\ + +@@ -501,7 +506,7 @@ Note + We can also update email address, if they do, they will need to reverify + their new email address. + +-### Login (Index) ++#### 4.2.3 Login (Index) + + Does nothing else but asking for a user authentication. Can be used to + validate credentials. HTTP Basic Auth for now, maybe change in future. +@@ -509,11 +514,11 @@ validate credentials. HTTP Basic Auth for now, maybe change in future. + GET /v1/users + + **Return**: +-: - Valid: HTTP 200 +- - Invalid login: HTTP 401 +- - Account inactive: HTTP 403 Account is not Active ++: - Valid: HTTP 200 ++ - Invalid login: HTTP 401 ++ - Account inactive: HTTP 403 Account is not Active + +-### Tags (Registry) ++### 4.3 Tags (Registry) + + The Registry does not know anything about users. Even though + repositories are under usernames, it’s just a namespace for the +@@ -522,11 +527,11 @@ per user later, without modifying the Registry’s API. + + The following naming restrictions apply: + +-- Namespaces must match the same regular expression as usernames (See ++- Namespaces must match the same regular expression as usernames (See + 4.2.1.) +-- Repository names must match the regular expression [a-zA-Z0-9-\_.] ++- Repository names must match the regular expression [a-zA-Z0-9-\_.] + +-### Get all tags: ++#### 4.3.1 Get all tags + + GET /v1/repositories/\/\/tags + +@@ -536,25 +541,25 @@ GET /v1/repositories/\/\/tags + “0.1.1”: + “b486531f9a779a0c17e3ed29dae8f12c4f9e89cc6f0bc3c38722009fe6857087” } + +-### Read the content of a tag (resolve the image id): ++#### 4.3.2 Read the content of a tag (resolve the image id) + + GET /v1/repositories/\/\/tags/\ + + **Return**: + : “9e89cc6f0bc3c38722009fe6857087b486531f9a779a0c17e3ed29dae8f12c4f” + +-### Delete a tag (registry): ++#### 4.3.3 Delete a tag (registry) + + DELETE /v1/repositories/\/\/tags/\ + +-## Images (Index) ++### 4.4 Images (Index) + + For the Index to “resolve” the repository name to a Registry location, + it uses the X-Docker-Endpoints header. In other terms, this requests + always add a `X-Docker-Endpoints` to indicate the + location of the registry which hosts this repository. + +-### Get the images: ++#### 4.4.1 Get the images + + GET /v1/repositories/\/\/images + +@@ -562,9 +567,9 @@ GET /v1/repositories/\/\/images + : [{“id”: + “9e89cc6f0bc3c38722009fe6857087b486531f9a779a0c17e3ed29dae8f12c4f”, + “checksum”: +- “[md5:b486531f9a779a0c17e3ed29dae8f12c4f9e89cc6f0bc3c38722009fe6857087](md5:b486531f9a779a0c17e3ed29dae8f12c4f9e89cc6f0bc3c38722009fe6857087)”}] ++ “”}] + +-### Add/update the images: ++#### 4.4.2 Add/update the images + + You always add images, you never remove them. + +@@ -579,15 +584,15 @@ PUT /v1/repositories/\/\/images + + **Return** 204 + +-### Repositories ++### 4.5 Repositories + +-### Remove a Repository (Registry) ++#### 4.5.1 Remove a Repository (Registry) + + DELETE /v1/repositories/\/\ + + Return 200 OK + +-### Remove a Repository (Index) ++#### 4.5.2 Remove a Repository (Index) + + This starts the delete process. see 2.3 for more details. + +@@ -595,12 +600,12 @@ DELETE /v1/repositories/\/\ + + Return 202 OK + +-## Chaining Registries ++## 5. Chaining Registries + + It’s possible to chain Registries server for several reasons: + +-- Load balancing +-- Delegate the next request to another server ++- Load balancing ++- Delegate the next request to another server + + When a Registry is a reference for a repository, it should host the + entire images chain in order to avoid breaking the chain during the +@@ -618,9 +623,9 @@ On every request, a special header can be returned: + On the next request, the client will always pick a server from this + list. + +-## Authentication & Authorization ++## 6. Authentication & Authorization + +-### On the Index ++### 6.1 On the Index + + The Index supports both “Basic” and “Token” challenges. Usually when + there is a `401 Unauthorized`, the Index replies +@@ -634,16 +639,16 @@ You have 3 options: + 1. Provide user credentials and ask for a token + + > **Header**: +- > : - Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== +- > - X-Docker-Token: true ++ > : - Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== ++ > - X-Docker-Token: true + > + > In this case, along with the 200 response, you’ll get a new token + > (if user auth is ok): If authorization isn’t correct you get a 401 + > response. If account isn’t active you will get a 403 response. + > + > **Response**: +- > : - 200 OK +- > - X-Docker-Token: Token ++ > : - 200 OK ++ > - X-Docker-Token: Token + > signature=123abc,repository=”foo/bar”,access=read + > + 2. Provide user credentials only +@@ -681,9 +686,9 @@ Next request: + GET /(...) + Cookie: session="wD/J7LqL5ctqw8haL10vgfhrb2Q=?foo=UydiYXInCnAxCi4=×tamp=RjEzNjYzMTQ5NDcuNDc0NjQzCi4=" + +-## Document Version ++## 7 Document Version + +-- 1.0 : May 6th 2013 : initial release +-- 1.1 : June 1st 2013 : Added Delete Repository and way to handle new ++- 1.0 : May 6th 2013 : initial release ++- 1.1 : June 1st 2013 : Added Delete Repository and way to handle new + source namespace. + +diff --git a/docs/sources/reference/api/remote_api_client_libraries.md b/docs/sources/reference/api/remote_api_client_libraries.md +index 0392da3..4991924 100644 +--- a/docs/sources/reference/api/remote_api_client_libraries.md ++++ b/docs/sources/reference/api/remote_api_client_libraries.md +@@ -4,115 +4,82 @@ page_keywords: API, Docker, index, registry, REST, documentation, clients, Pytho + + # Docker Remote API Client Libraries + +-## Introduction +- + These libraries have not been tested by the Docker Maintainers for + 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 +- +-Status +- +-Python +- +-docker-py +- +-[https://github.com/dotcloud/docker-py](https://github.com/dotcloud/docker-py) +- +-Active +- +-Ruby +- +-docker-client +- +-[https://github.com/geku/docker-client](https://github.com/geku/docker-client) +- +-Outdated +- +-Ruby +- +-docker-api +- +-[https://github.com/swipely/docker-api](https://github.com/swipely/docker-api) +- +-Active +- +-JavaScript (NodeJS) +- +-dockerode +- +-[https://github.com/apocas/dockerode](https://github.com/apocas/dockerode) +-Install via NPM: npm install dockerode +- +-Active +- +-JavaScript (NodeJS) +- +-docker.io +- +-[https://github.com/appersonlabs/docker.io](https://github.com/appersonlabs/docker.io) +-Install via NPM: npm install docker.io +- +-Active +- +-JavaScript +- +-docker-js +- +-[https://github.com/dgoujard/docker-js](https://github.com/dgoujard/docker-js) +- +-Active +- +-JavaScript (Angular) **WebUI** +- +-docker-cp +- +-[https://github.com/13W/docker-cp](https://github.com/13W/docker-cp) +- +-Active +- +-JavaScript (Angular) **WebUI** +- +-dockerui +- +-[https://github.com/crosbymichael/dockerui](https://github.com/crosbymichael/dockerui) ++ ------------------------------------------------------------------------- ++ Language/Framewor Name Repository Status ++ k ++ ----------------- ------------ ---------------------------------- ------- ++ Python docker-py [https://github.com/dotcloud/docke Active ++ r-py](https://github.com/dotcloud/ ++ docker-py) + +-Active ++ Ruby docker-clien [https://github.com/geku/docker-cl Outdate ++ t ient](https://github.com/geku/dock d ++ er-client) + +-Java ++ Ruby docker-api [https://github.com/swipely/docker Active ++ -api](https://github.com/swipely/d ++ ocker-api) + +-docker-java ++ JavaScript dockerode [https://github.com/apocas/dockero Active ++ (NodeJS) de](https://github.com/apocas/dock ++ erode) ++ Install via NPM: npm install ++ dockerode + +-[https://github.com/kpelykh/docker-java](https://github.com/kpelykh/docker-java) ++ JavaScript docker.io [https://github.com/appersonlabs/d Active ++ (NodeJS) ocker.io](https://github.com/apper ++ sonlabs/docker.io) ++ Install via NPM: npm install ++ docker.io + +-Active ++ JavaScript docker-js [https://github.com/dgoujard/docke Outdate ++ r-js](https://github.com/dgoujard/ d ++ docker-js) + +-Erlang ++ JavaScript docker-cp [https://github.com/13W/docker-cp] Active ++ (Angular) (https://github.com/13W/docker-cp) ++ **WebUI** + +-erldocker ++ JavaScript dockerui [https://github.com/crosbymichael/ Active ++ (Angular) dockerui](https://github.com/crosb ++ **WebUI** ymichael/dockerui) + +-[https://github.com/proger/erldocker](https://github.com/proger/erldocker) ++ Java docker-java [https://github.com/kpelykh/docker Active ++ -java](https://github.com/kpelykh/ ++ docker-java) + +-Active ++ Erlang erldocker [https://github.com/proger/erldock Active ++ er](https://github.com/proger/erld ++ ocker) + +-Go ++ Go go-dockercli [https://github.com/fsouza/go-dock Active ++ ent erclient](https://github.com/fsouz ++ a/go-dockerclient) + +-go-dockerclient ++ Go dockerclient [https://github.com/samalba/docker Active ++ client](https://github.com/samalba ++ /dockerclient) + +-[https://github.com/fsouza/go-dockerclient](https://github.com/fsouza/go-dockerclient) ++ PHP Alvine [http://pear.alvine.io/](http://pe Active ++ ar.alvine.io/) ++ (alpha) + +-Active ++ PHP Docker-PHP [http://stage1.github.io/docker-ph Active ++ p/](http://stage1.github.io/docker ++ -php/) + +-PHP ++ Perl Net::Docker [https://metacpan.org/pod/Net::Doc Active ++ ker](https://metacpan.org/pod/Net: ++ :Docker) + +-Alvine ++ Perl Eixo::Docker [https://github.com/alambike/eixo- Active ++ docker](https://github.com/alambik ++ e/eixo-docker) ++ ------------------------------------------------------------------------- + +-[http://pear.alvine.io/](http://pear.alvine.io/) (alpha) + +-Active +diff --git a/docs/sources/reference/commandline.md b/docs/sources/reference/commandline.md +index 6f7a779..b2fb7e0 100644 +--- a/docs/sources/reference/commandline.md ++++ b/docs/sources/reference/commandline.md +@@ -1,7 +1,7 @@ + + # Commands + +-## Contents: ++Contents: + + - [Command Line Help](cli/) + - [Options](cli/#options) +diff --git a/docs/sources/reference/run.md b/docs/sources/reference/run.md +index 9d825ce..3deac40 100644 +--- a/docs/sources/reference/run.md ++++ b/docs/sources/reference/run.md +@@ -2,7 +2,7 @@ page_title: Docker Run Reference + page_description: Configure containers at runtime + page_keywords: docker, run, configure, runtime + +-# Docker Run Reference ++# [Docker Run Reference](#id2) + + **Docker runs processes in isolated containers**. When an operator + executes `docker run`, she starts a process with its +@@ -25,7 +25,7 @@ Table of Contents + - [Overriding `Dockerfile` Image + Defaults](#overriding-dockerfile-image-defaults) + +-## General Form ++## [General Form](#id3) + + As you’ve seen in the [*Examples*](../../examples/#example-list), the + basic run command takes this form: +@@ -52,7 +52,7 @@ control over runtime behavior to the operator, allowing them to override + all defaults set by the developer during `docker build`{.docutils + .literal} and nearly all the defaults set by the Docker runtime itself. + +-## Operator Exclusive Options ++## [Operator Exclusive Options](#id4) + + Only the operator (the person executing `docker run`{.docutils + .literal}) can set the following options. +@@ -60,19 +60,17 @@ Only the operator (the person executing `docker run`{.docutils + - [Detached vs Foreground](#detached-vs-foreground) + - [Detached (-d)](#detached-d) + - [Foreground](#foreground) +- + - [Container Identification](#container-identification) +- - [Name (-name)](#name-name) ++ - [Name (–name)](#name-name) + - [PID Equivalent](#pid-equivalent) +- + - [Network Settings](#network-settings) +-- [Clean Up (-rm)](#clean-up-rm) ++- [Clean Up (–rm)](#clean-up-rm) + - [Runtime Constraints on CPU and + Memory](#runtime-constraints-on-cpu-and-memory) + - [Runtime Privilege and LXC + Configuration](#runtime-privilege-and-lxc-configuration) + +-### Detached vs Foreground ++### [Detached vs Foreground](#id6) + + When starting a Docker container, you must first decide if you want to + run the container in the background in a “detached” mode or in the +@@ -80,7 +78,7 @@ default foreground mode: + + -d=false: Detached mode: Run container in the background, print new container id + +-**Detached (-d)** ++#### [Detached (-d)](#id7) + + In detached mode (`-d=true` or just `-d`{.docutils + .literal}), all I/O should be done through network connections or shared +@@ -88,10 +86,10 @@ volumes because the container is no longer listening to the commandline + where you executed `docker run`. You can reattach to + a detached container with `docker` + [*attach*](../commandline/cli/#cli-attach). If you choose to run a +-container in the detached mode, then you cannot use the `-rm`{.docutils ++container in the detached mode, then you cannot use the `--rm`{.docutils + .literal} option. + +-**Foreground** ++#### [Foreground](#id8) + + In foreground mode (the default when `-d` is not + specified), `docker run` can start the process in +@@ -100,10 +98,10 @@ output, and standard error. It can even pretend to be a TTY (this is + what most commandline executables expect) and pass along signals. All of + that is configurable: + +- -a=[] : Attach to ``stdin``, ``stdout`` and/or ``stderr`` +- -t=false : Allocate a pseudo-tty +- -sig-proxy=true: Proxify all received signal to the process (even in non-tty mode) +- -i=false : Keep STDIN open even if not attached ++ -a=[] : Attach to ``stdin``, ``stdout`` and/or ``stderr`` ++ -t=false : Allocate a pseudo-tty ++ --sig-proxy=true: Proxify all received signal to the process (even in non-tty mode) ++ -i=false : Keep STDIN open even if not attached + + If you do not specify `-a` then Docker will [attach + everything +@@ -119,9 +117,9 @@ as well as persistent standard input (`stdin`), so + you’ll use `-i -t` together in most interactive + cases. + +-### Container Identification ++### [Container Identification](#id9) + +-**Name (-name)** ++#### [Name (–name)](#id10) + + The operator can identify a container in three ways: + +@@ -131,27 +129,27 @@ The operator can identify a container in three ways: + - Name (“evil\_ptolemy”) + + The UUID identifiers come from the Docker daemon, and if you do not +-assign a name to the container with `-name` then the +-daemon will also generate a random string name too. The name can become +-a handy way to add meaning to a container since you can use this name +-when defining ++assign a name to the container with `--name` then ++the daemon will also generate a random string name too. The name can ++become a handy way to add meaning to a container since you can use this ++name when defining + [*links*](../../use/working_with_links_names/#working-with-links-names) + (or any other place you need to identify a container). This works for + both background and foreground Docker containers. + +-**PID Equivalent** ++#### [PID Equivalent](#id11) + + And finally, to help with automation, you can have Docker write the + container ID out to a file of your choosing. This is similar to how some + programs might write out their process ID to a file (you’ve seen them as + PID files): + +- -cidfile="": Write the container ID to the file ++ --cidfile="": Write the container ID to the file + +-### Network Settings ++### [Network Settings](#id12) + + -n=true : Enable networking for this container +- -dns=[] : Set custom dns servers for the container ++ --dns=[] : Set custom dns servers for the container + + By default, all containers have networking enabled and they can make any + outgoing connections. The operator can completely disable networking +@@ -160,9 +158,9 @@ outgoing networking. In cases like this, you would perform I/O through + files or STDIN/STDOUT only. + + Your container will use the same DNS servers as the host by default, but +-you can override this with `-dns`. ++you can override this with `--dns`. + +-### Clean Up (-rm) ++### [Clean Up (–rm)](#id13) + + By default a container’s file system persists even after the container + exits. This makes debugging a lot easier (since you can inspect the +@@ -170,11 +168,11 @@ final state) and you retain all your data by default. But if you are + running short-term **foreground** processes, these container file + systems can really pile up. If instead you’d like Docker to + **automatically clean up the container and remove the file system when +-the container exits**, you can add the `-rm` flag: ++the container exits**, you can add the `--rm` flag: + +- -rm=false: Automatically remove the container when it exits (incompatible with -d) ++ --rm=false: Automatically remove the container when it exits (incompatible with -d) + +-### Runtime Constraints on CPU and Memory ++### [Runtime Constraints on CPU and Memory](#id14) + + The operator can also adjust the performance parameters of the + container: +@@ -193,10 +191,10 @@ the same priority and get the same proportion of CPU cycles, but you can + tell the kernel to give more shares of CPU time to one or more + containers when you start them via Docker. + +-### Runtime Privilege and LXC Configuration ++### [Runtime Privilege and LXC Configuration](#id15) + +- -privileged=false: Give extended privileges to this container +- -lxc-conf=[]: Add custom lxc options -lxc-conf="lxc.cgroup.cpuset.cpus = 0,1" ++ --privileged=false: Give extended privileges to this container ++ --lxc-conf=[]: (lxc exec-driver only) Add custom lxc options --lxc-conf="lxc.cgroup.cpuset.cpus = 0,1" + + By default, Docker containers are “unprivileged” and cannot, for + example, run a Docker daemon inside a Docker container. This is because +@@ -206,23 +204,26 @@ by default a container is not allowed to access any devices, but a + and documentation on [cgroups + devices](https://www.kernel.org/doc/Documentation/cgroups/devices.txt)). + +-When the operator executes `docker run -privileged`, +-Docker will enable to access to all devices on the host as well as set +-some configuration in AppArmor to allow the container nearly all the +-same access to the host as processes running outside containers on the +-host. Additional information about running with `-privileged`{.docutils +-.literal} is available on the [Docker ++When the operator executes `docker run --privileged`{.docutils ++.literal}, Docker will enable to access to all devices on the host as ++well as set some configuration in AppArmor to allow the container nearly ++all the same access to the host as processes running outside containers ++on the host. Additional information about running with ++`--privileged` is available on the [Docker + Blog](http://blog.docker.io/2013/09/docker-can-now-run-within-docker/). + +-An operator can also specify LXC options using one or more +-`-lxc-conf` parameters. These can be new parameters ++If the Docker daemon was started using the `lxc` ++exec-driver (`docker -d --exec-driver=lxc`) then the ++operator can also specify LXC options using one or more ++`--lxc-conf` parameters. These can be new parameters + or override existing parameters from the + [lxc-template.go](https://github.com/dotcloud/docker/blob/master/execdriver/lxc/lxc_template.go). + Note that in the future, a given host’s Docker daemon may not use LXC, + so this is an implementation-specific configuration meant for operators + already familiar with using LXC directly. + +-## Overriding `Dockerfile` Image Defaults ++## [Overriding `Dockerfile` Image Defaults](#id5) ++ + When a developer builds an image from a + [*Dockerfile*](../builder/#dockerbuilder) or when she commits it, the + developer can set a number of default parameters that take effect when +@@ -244,7 +245,7 @@ how the operator can override that setting. + - [USER](#user) + - [WORKDIR](#workdir) + +-### CMD (Default Command or Options) ++### [CMD (Default Command or Options)](#id16) + + Recall the optional `COMMAND` in the Docker + commandline: +@@ -262,9 +263,9 @@ If the image also specifies an `ENTRYPOINT` then the + `CMD` or `COMMAND`{.docutils .literal} get appended + as arguments to the `ENTRYPOINT`. + +-### ENTRYPOINT (Default Command to Execute at Runtime ++### [ENTRYPOINT (Default Command to Execute at Runtime](#id17) + +- -entrypoint="": Overwrite the default entrypoint set by the image ++ --entrypoint="": Overwrite the default entrypoint set by the image + + The ENTRYPOINT of an image is similar to a `COMMAND` + because it specifies what executable to run when the container starts, +@@ -280,14 +281,14 @@ the new `ENTRYPOINT`. Here is an example of how to + run a shell in a container that has been set up to automatically run + something else (like `/usr/bin/redis-server`): + +- docker run -i -t -entrypoint /bin/bash example/redis ++ docker run -i -t --entrypoint /bin/bash example/redis + + or two examples of how to pass more parameters to that ENTRYPOINT: + +- docker run -i -t -entrypoint /bin/bash example/redis -c ls -l +- docker run -i -t -entrypoint /usr/bin/redis-cli example/redis --help ++ docker run -i -t --entrypoint /bin/bash example/redis -c ls -l ++ docker run -i -t --entrypoint /usr/bin/redis-cli example/redis --help + +-### EXPOSE (Incoming Ports) ++### [EXPOSE (Incoming Ports)](#id18) + + The `Dockerfile` doesn’t give much control over + networking, only providing the `EXPOSE` instruction +@@ -295,17 +296,17 @@ to give a hint to the operator about what incoming ports might provide + services. The following options work with or override the + `Dockerfile`‘s exposed defaults: + +- -expose=[]: Expose a port from the container ++ --expose=[]: Expose a port from the container + without publishing it to your host +- -P=false : Publish all exposed ports to the host interfaces +- -p=[] : Publish a container's port to the host (format: +- ip:hostPort:containerPort | ip::containerPort | +- hostPort:containerPort) +- (use 'docker port' to see the actual mapping) +- -link="" : Add link to another container (name:alias) ++ -P=false : Publish all exposed ports to the host interfaces ++ -p=[] : Publish a container's port to the host (format: ++ ip:hostPort:containerPort | ip::containerPort | ++ hostPort:containerPort) ++ (use 'docker port' to see the actual mapping) ++ --link="" : Add link to another container (name:alias) + + As mentioned previously, `EXPOSE` (and +-`-expose`) make a port available **in** a container ++`--expose`) make a port available **in** a container + for incoming connections. The port number on the inside of the container + (where the service listens) does not need to be the same number as the + port exposed on the outside of the container (where clients connect), so +@@ -315,11 +316,11 @@ inside the container you might have an HTTP service listening on port 80 + might be 42800. + + To help a new client container reach the server container’s internal +-port operator `-expose`‘d by the operator or ++port operator `--expose`‘d by the operator or + `EXPOSE`‘d by the developer, the operator has three + choices: start the server container with `-P` or + `-p,` or start the client container with +-`-link`. ++`--link`. + + If the operator uses `-P` or `-p`{.docutils + .literal} then Docker will make the exposed port accessible on the host +@@ -327,20 +328,20 @@ and the ports will be available to any client that can reach the host. + To find the map between the host ports and the exposed ports, use + `docker port`) + +-If the operator uses `-link` when starting the new ++If the operator uses `--link` when starting the new + client container, then the client container can access the exposed port + via a private networking interface. Docker will set some environment + variables in the client container to help indicate which interface and + port to use. + +-### ENV (Environment Variables) ++### [ENV (Environment Variables)](#id19) + + The operator can **set any environment variable** in the container by + using one or more `-e` flags, even overriding those + already defined by the developer with a Dockefile `ENV`{.docutils + .literal}: + +- $ docker run -e "deep=purple" -rm ubuntu /bin/bash -c export ++ $ docker run -e "deep=purple" --rm ubuntu /bin/bash -c export + declare -x HOME="/" + declare -x HOSTNAME="85bc26a0e200" + declare -x OLDPWD +@@ -353,13 +354,13 @@ already defined by the developer with a Dockefile `ENV`{.docutils + Similarly the operator can set the **hostname** with `-h`{.docutils + .literal}. + +-`-link name:alias` also sets environment variables, ++`--link name:alias` also sets environment variables, + using the *alias* string to define environment variables within the + container that give the IP and PORT information for connecting to the + service container. Let’s imagine we have a container running Redis: + + # Start the service container, named redis-name +- $ docker run -d -name redis-name dockerfiles/redis ++ $ docker run -d --name redis-name dockerfiles/redis + 4241164edf6f5aca5b0e9e4c9eccd899b0b8080c64c0cd26efe02166c73208f3 + + # The redis-name container exposed port 6379 +@@ -372,10 +373,10 @@ service container. Let’s imagine we have a container running Redis: + 2014/01/25 00:55:38 Error: No public port '6379' published for 4241164edf6f + + Yet we can get information about the Redis container’s exposed ports +-with `-link`. Choose an alias that will form a valid +-environment variable! ++with `--link`. Choose an alias that will form a ++valid environment variable! + +- $ docker run -rm -link redis-name:redis_alias -entrypoint /bin/bash dockerfiles/redis -c export ++ $ docker run --rm --link redis-name:redis_alias --entrypoint /bin/bash dockerfiles/redis -c export + declare -x HOME="/" + declare -x HOSTNAME="acda7f7b1cdc" + declare -x OLDPWD +@@ -393,14 +394,14 @@ environment variable! + And we can use that information to connect from another container as a + client: + +- $ docker run -i -t -rm -link redis-name:redis_alias -entrypoint /bin/bash dockerfiles/redis -c '/redis-stable/src/redis-cli -h $REDIS_ALIAS_PORT_6379_TCP_ADDR -p $REDIS_ALIAS_PORT_6379_TCP_PORT' ++ $ docker run -i -t --rm --link redis-name:redis_alias --entrypoint /bin/bash dockerfiles/redis -c '/redis-stable/src/redis-cli -h $REDIS_ALIAS_PORT_6379_TCP_ADDR -p $REDIS_ALIAS_PORT_6379_TCP_PORT' + 172.17.0.32:6379> + +-### VOLUME (Shared Filesystems) ++### [VOLUME (Shared Filesystems)](#id20) + + -v=[]: Create a bind mount with: [host-dir]:[container-dir]:[rw|ro]. + If "container-dir" is missing, then docker creates a new volume. +- -volumes-from="": Mount all volumes from the given container(s) ++ --volumes-from="": Mount all volumes from the given container(s) + + The volumes commands are complex enough to have their own documentation + in section [*Share Directories via +@@ -409,7 +410,7 @@ define one or more `VOLUME`s associated with an + image, but only the operator can give access from one container to + another (or from a container to a volume mounted on the host). + +-### USER ++### [USER](#id21) + + The default user within a container is `root` (id = + 0), but if the developer created additional users, those are accessible +@@ -419,7 +420,7 @@ override it + + -u="": Username or UID + +-### WORKDIR ++### [WORKDIR](#id22) + + The default working directory for running binaries within a container is + the root directory (`/`), but the developer can set +diff --git a/docs/sources/search.md b/docs/sources/search.md +index 0e2e13f..0296d50 100644 +--- a/docs/sources/search.md ++++ b/docs/sources/search.md +@@ -1,8 +1,7 @@ +-# Search + +-*Please activate JavaScript to enable the search functionality.* ++# Search {#search-documentation} + +-## How To Search ++Please activate JavaScript to enable the search functionality. + + From here you can search these documents. Enter your search words into + the box below and click "search". Note that the search function will +diff --git a/docs/sources/terms.md b/docs/sources/terms.md +index 59579d9..5152876 100644 +--- a/docs/sources/terms.md ++++ b/docs/sources/terms.md +@@ -1,13 +1,14 @@ ++ + # Glossary + +-*Definitions of terms used in Docker documentation.* ++Definitions of terms used in Docker documentation. + +-## Contents: ++Contents: + +-- [File System](filesystem/) +-- [Layers](layer/) +-- [Image](image/) +-- [Container](container/) +-- [Registry](registry/) +-- [Repository](repository/) ++- [File System](filesystem/) ++- [Layers](layer/) ++- [Image](image/) ++- [Container](container/) ++- [Registry](registry/) ++- [Repository](repository/) + +diff --git a/docs/sources/terms/container.md b/docs/sources/terms/container.md +index bc493d4..6fbf952 100644 +--- a/docs/sources/terms/container.md ++++ b/docs/sources/terms/container.md +@@ -4,8 +4,6 @@ page_keywords: containers, lxc, concepts, explanation, image, container + + # Container + +-## Introduction +- + ![](../../_images/docker-filesystems-busyboxrw.png) + + Once you start a process in Docker from an +diff --git a/docs/sources/terms/filesystem.md b/docs/sources/terms/filesystem.md +index 2038d00..8fbd977 100644 +--- a/docs/sources/terms/filesystem.md ++++ b/docs/sources/terms/filesystem.md +@@ -4,8 +4,6 @@ page_keywords: containers, files, linux + + # File System + +-## Introduction +- + ![](../../_images/docker-filesystems-generic.png) + + In order for a Linux system to run, it typically needs two [file +diff --git a/docs/sources/terms/image.md b/docs/sources/terms/image.md +index 721d4c9..98914dd 100644 +--- a/docs/sources/terms/image.md ++++ b/docs/sources/terms/image.md +@@ -4,8 +4,6 @@ page_keywords: containers, lxc, concepts, explanation, image, container + + # Image + +-## Introduction +- + ![](../../_images/docker-filesystems-debian.png) + + In Docker terminology, a read-only [*Layer*](../layer/#layer-def) is +diff --git a/docs/sources/terms/layer.md b/docs/sources/terms/layer.md +index 7665467..6949d5c 100644 +--- a/docs/sources/terms/layer.md ++++ b/docs/sources/terms/layer.md +@@ -4,8 +4,6 @@ page_keywords: containers, lxc, concepts, explanation, image, container + + # Layers + +-## Introduction +- + In a traditional Linux boot, the kernel first mounts the root [*File + System*](../filesystem/#filesystem-def) as read-only, checks its + integrity, and then switches the whole rootfs volume to read-write mode. +diff --git a/docs/sources/terms/registry.md b/docs/sources/terms/registry.md +index 0d5af2c..53c0a24 100644 +--- a/docs/sources/terms/registry.md ++++ b/docs/sources/terms/registry.md +@@ -4,8 +4,6 @@ page_keywords: containers, lxc, concepts, explanation, image, repository, contai + + # Registry + +-## Introduction +- + A Registry is a hosted service containing + [*repositories*](../repository/#repository-def) of + [*images*](../image/#image-def) which responds to the Registry API. +@@ -14,7 +12,5 @@ The default registry can be accessed using a browser at + [http://images.docker.io](http://images.docker.io) or using the + `sudo docker search` command. + +-## Further Reading +- + For more information see [*Working with + Repositories*](../../use/workingwithrepository/#working-with-the-repository) +diff --git a/docs/sources/terms/repository.md b/docs/sources/terms/repository.md +index e3332e4..8868440 100644 +--- a/docs/sources/terms/repository.md ++++ b/docs/sources/terms/repository.md +@@ -4,8 +4,6 @@ page_keywords: containers, lxc, concepts, explanation, image, repository, contai + + # Repository + +-## Introduction +- + A repository is a set of images either on your local Docker server, or + shared, by pushing it to a [*Registry*](../registry/#registry-def) + server. +diff --git a/docs/sources/toctree.md b/docs/sources/toctree.md +index 259a231..b268e90 100644 +--- a/docs/sources/toctree.md ++++ b/docs/sources/toctree.md +@@ -1,14 +1,18 @@ ++page_title: Documentation ++page_description: -- todo: change me ++page_keywords: todo, docker, documentation, installation, usage, examples, contributing, faq, command line, concepts ++ + # Documentation + +-## This documentation has the following resources: +- +-- [Introduction](../) +-- [Installation](../installation/) +-- [Use](../use/) +-- [Examples](../examples/) +-- [Reference Manual](../reference/) +-- [Contributing](../contributing/) +-- [Glossary](../terms/) +-- [Articles](../articles/) +-- [FAQ](../faq/) ++This documentation has the following resources: ++ ++- [Introduction](../) ++- [Installation](../installation/) ++- [Use](../use/) ++- [Examples](../examples/) ++- [Reference Manual](../reference/) ++- [Contributing](../contributing/) ++- [Glossary](../terms/) ++- [Articles](../articles/) ++- [FAQ](../faq/) + +diff --git a/docs/sources/use.md b/docs/sources/use.md +index ce4a510..00077a5 100644 +--- a/docs/sources/use.md ++++ b/docs/sources/use.md +@@ -1,13 +1,16 @@ ++ + # Use + +-## Contents: +- +-- [First steps with Docker](basics/) +-- [Share Images via Repositories](workingwithrepository/) +-- [Redirect Ports](port_redirection/) +-- [Configure Networking](networking/) +-- [Automatically Start Containers](host_integration/) +-- [Share Directories via Volumes](working_with_volumes/) +-- [Link Containers](working_with_links_names/) +-- [Link via an Ambassador Container](ambassador_pattern_linking/) +-- [Using Puppet](puppet/) +\ No newline at end of file ++Contents: ++ ++- [First steps with Docker](basics/) ++- [Share Images via Repositories](workingwithrepository/) ++- [Redirect Ports](port_redirection/) ++- [Configure Networking](networking/) ++- [Automatically Start Containers](host_integration/) ++- [Share Directories via Volumes](working_with_volumes/) ++- [Link Containers](working_with_links_names/) ++- [Link via an Ambassador Container](ambassador_pattern_linking/) ++- [Using Chef](chef/) ++- [Using Puppet](puppet/) ++ +diff --git a/docs/sources/use/ambassador_pattern_linking.md b/docs/sources/use/ambassador_pattern_linking.md +index b5df7f8..f7704a5 100644 +--- a/docs/sources/use/ambassador_pattern_linking.md ++++ b/docs/sources/use/ambassador_pattern_linking.md +@@ -4,8 +4,6 @@ page_keywords: Examples, Usage, links, docker, documentation, examples, names, n + + # Link via an Ambassador Container + +-## Introduction +- + Rather than hardcoding network links between a service consumer and + provider, Docker encourages service portability. + +@@ -38,24 +36,24 @@ link wiring is controlled entirely from the `docker run`{.docutils + + Start actual redis server on one Docker host + +- big-server $ docker run -d -name redis crosbymichael/redis ++ big-server $ docker run -d --name redis crosbymichael/redis + + Then add an ambassador linked to the redis server, mapping a port to the + outside world + +- big-server $ docker run -d -link redis:redis -name redis_ambassador -p 6379:6379 svendowideit/ambassador ++ big-server $ docker run -d --link redis:redis --name redis_ambassador -p 6379:6379 svendowideit/ambassador + + On the other host, you can set up another ambassador setting environment + variables for each remote port we want to proxy to the + `big-server` + +- client-server $ docker run -d -name redis_ambassador -expose 6379 -e REDIS_PORT_6379_TCP=tcp://192.168.1.52:6379 svendowideit/ambassador ++ client-server $ docker run -d --name redis_ambassador --expose 6379 -e REDIS_PORT_6379_TCP=tcp://192.168.1.52:6379 svendowideit/ambassador + + Then on the `client-server` host, you can use a + redis client container to talk to the remote redis server, just by + linking to the local redis ambassador. + +- client-server $ docker run -i -t -rm -link redis_ambassador:redis relateiq/redis-cli ++ client-server $ docker run -i -t --rm --link redis_ambassador:redis relateiq/redis-cli + redis 172.17.0.160:6379> ping + PONG + +@@ -68,19 +66,19 @@ The following example shows what the `svendowideit/ambassador`{.docutils + On the docker host (192.168.1.52) that redis will run on: + + # start actual redis server +- $ docker run -d -name redis crosbymichael/redis ++ $ docker run -d --name redis crosbymichael/redis + + # get a redis-cli container for connection testing + $ docker pull relateiq/redis-cli + + # test the redis server by talking to it directly +- $ docker run -t -i -rm -link redis:redis relateiq/redis-cli ++ $ docker run -t -i --rm --link redis:redis relateiq/redis-cli + redis 172.17.0.136:6379> ping + PONG + ^D + + # add redis ambassador +- $ docker run -t -i -link redis:redis -name redis_ambassador -p 6379:6379 busybox sh ++ $ docker run -t -i --link redis:redis --name redis_ambassador -p 6379:6379 busybox sh + + in the redis\_ambassador container, you can see the linked redis + containers’s env +@@ -104,7 +102,7 @@ to the world (via the -p 6379:6379 port mapping) + + $ docker rm redis_ambassador + $ sudo ./contrib/mkimage-unittest.sh +- $ docker run -t -i -link redis:redis -name redis_ambassador -p 6379:6379 docker-ut sh ++ $ docker run -t -i --link redis:redis --name redis_ambassador -p 6379:6379 docker-ut sh + + $ socat TCP4-LISTEN:6379,fork,reuseaddr TCP4:172.17.0.136:6379 + +@@ -113,14 +111,14 @@ then ping the redis server via the ambassador + Now goto a different server + + $ sudo ./contrib/mkimage-unittest.sh +- $ docker run -t -i -expose 6379 -name redis_ambassador docker-ut sh ++ $ docker run -t -i --expose 6379 --name redis_ambassador docker-ut sh + + $ socat TCP4-LISTEN:6379,fork,reuseaddr TCP4:192.168.1.52:6379 + + and get the redis-cli image so we can talk over the ambassador bridge + + $ docker pull relateiq/redis-cli +- $ docker run -i -t -rm -link redis_ambassador:redis relateiq/redis-cli ++ $ docker run -i -t --rm --link redis_ambassador:redis relateiq/redis-cli + redis 172.17.0.160:6379> ping + PONG + +@@ -133,7 +131,7 @@ out the (possibly multiple) link environment variables to set up the + port forwarding. On the remote host, you need to set the variable using + the `-e` command line option. + +-`-expose 1234 -e REDIS_PORT_1234_TCP=tcp://192.168.1.52:6379`{.docutils ++`--expose 1234 -e REDIS_PORT_1234_TCP=tcp://192.168.1.52:6379`{.docutils + .literal} will forward the local `1234` port to the + remote IP and port - in this case `192.168.1.52:6379`{.docutils + .literal}. +@@ -146,12 +144,12 @@ remote IP and port - in this case `192.168.1.52:6379`{.docutils + # docker build -t SvenDowideit/ambassador . + # docker tag SvenDowideit/ambassador ambassador + # then to run it (on the host that has the real backend on it) +- # docker run -t -i -link redis:redis -name redis_ambassador -p 6379:6379 ambassador ++ # docker run -t -i --link redis:redis --name redis_ambassador -p 6379:6379 ambassador + # on the remote host, you can set up another ambassador +- # docker run -t -i -name redis_ambassador -expose 6379 sh ++ # docker run -t -i --name redis_ambassador --expose 6379 sh + + FROM docker-ut + MAINTAINER SvenDowideit@home.org.au + + +- CMD env | grep _TCP= | sed 's/.*_PORT_\([0-9]*\)_TCP=tcp:\/\/\(.*\):\(.*\)/socat TCP4-LISTEN:\1,fork,reuseaddr TCP4:\2:\3 \&/' | sh && top +\ No newline at end of file ++ CMD env | grep _TCP= | sed 's/.*_PORT_\([0-9]*\)_TCP=tcp:\/\/\(.*\):\(.*\)/socat TCP4-LISTEN:\1,fork,reuseaddr TCP4:\2:\3 \&/' | sh && top +diff --git a/docs/sources/use/basics.md b/docs/sources/use/basics.md +index 1b10335..0abc8e7 100644 +--- a/docs/sources/use/basics.md ++++ b/docs/sources/use/basics.md +@@ -37,7 +37,10 @@ hash `539c0211cd76: Download complete` which is the + short form of the image ID. These short image IDs are the first 12 + characters of the full image ID - which can be found using + `docker inspect` or +-`docker images -notrunc=true` ++`docker images --no-trunc=true` ++ ++**If you’re using OS X** then you shouldn’t use `sudo`{.docutils ++.literal} + + ## Running an interactive shell + +diff --git a/docs/sources/use/host_integration.md b/docs/sources/use/host_integration.md +index 50eae8b..a7dba9b 100644 +--- a/docs/sources/use/host_integration.md ++++ b/docs/sources/use/host_integration.md +@@ -5,7 +5,8 @@ page_keywords: systemd, upstart, supervisor, docker, documentation, host integra + # Automatically Start Containers + + You can use your Docker containers with process managers like +-`upstart`, `systemd`{.docutils .literal} and `supervisor`. ++`upstart`, `systemd`{.docutils .literal} and ++`supervisor`. + + ## Introduction + +@@ -15,21 +16,22 @@ docker will not automatically restart your containers when the host is + restarted. + + When you have finished setting up your image and are happy with your +-running container, you may want to use a process manager to manage it. ++running container, you can then attach a process manager to manage it. + When your run `docker start -a` docker will +-automatically attach to the process and forward all signals so that the +-process manager can detect when a container stops and correctly restart +-it. ++automatically attach to the running container, or start it if needed and ++forward all signals so that the process manager can detect when a ++container stops and correctly restart it. + + Here are a few sample scripts for systemd and upstart to integrate with + docker. + + ## Sample Upstart Script + +-In this example we’ve already created a container to run Redis with an +-id of 0a7e070b698b. To create an upstart script for our container, we +-create a file named `/etc/init/redis.conf` and place +-the following into it: ++In this example we’ve already created a container to run Redis with ++`--name redis_server`. To create an upstart script ++for our container, we create a file named ++`/etc/init/redis.conf` and place the following into ++it: + + description "Redis container" + author "Me" +@@ -42,7 +44,7 @@ the following into it: + while [ ! -e $FILE ] ; do + inotifywait -t 2 -e create $(dirname $FILE) + done +- /usr/bin/docker start -a 0a7e070b698b ++ /usr/bin/docker start -a redis_server + end script + + Next, we have to configure docker so that it’s run with the option +@@ -59,8 +61,8 @@ Next, we have to configure docker so that it’s run with the option + + [Service] + Restart=always +- ExecStart=/usr/bin/docker start -a 0a7e070b698b +- ExecStop=/usr/bin/docker stop -t 2 0a7e070b698b ++ ExecStart=/usr/bin/docker start -a redis_server ++ ExecStop=/usr/bin/docker stop -t 2 redis_server + + [Install] + WantedBy=local.target +diff --git a/docs/sources/use/networking.md b/docs/sources/use/networking.md +index e4cc5c5..56a9885 100644 +--- a/docs/sources/use/networking.md ++++ b/docs/sources/use/networking.md +@@ -4,16 +4,15 @@ page_keywords: network, networking, bridge, docker, documentation + + # Configure Networking + +-## Introduction +- + Docker uses Linux bridge capabilities to provide network connectivity to + containers. The `docker0` bridge interface is + managed by Docker for this purpose. When the Docker daemon starts it : + +-- creates the `docker0` bridge if not present +-- searches for an IP address range which doesn’t overlap with an existing route +-- picks an IP in the selected range +-- assigns this IP to the `docker0` bridge ++- creates the `docker0` bridge if not present ++- searches for an IP address range which doesn’t overlap with an ++ existing route ++- picks an IP in the selected range ++- assigns this IP to the `docker0` bridge + + + +@@ -113,9 +112,9 @@ The value of the Docker daemon’s `icc` parameter + determines whether containers can communicate with each other over the + bridge network. + +-- The default, `-icc=true` allows containers to ++- The default, `--icc=true` allows containers to + communicate with each other. +-- `-icc=false` means containers are isolated from ++- `--icc=false` means containers are isolated from + each other. + + Docker uses `iptables` under the hood to either +@@ -137,6 +136,6 @@ ip link command) and the namespaces infrastructure. + + ## I want more + +-Jérôme Petazzoni has create `pipework` to connect ++Jérôme Petazzoni has created `pipework` to connect + together containers in arbitrarily complex scenarios : + [https://github.com/jpetazzo/pipework](https://github.com/jpetazzo/pipework) +diff --git a/docs/sources/use/port_redirection.md b/docs/sources/use/port_redirection.md +index 6970d0d..1c1b676 100644 +--- a/docs/sources/use/port_redirection.md ++++ b/docs/sources/use/port_redirection.md +@@ -4,8 +4,6 @@ page_keywords: Usage, basic port, docker, documentation, examples + + # Redirect Ports + +-## Introduction +- + Interacting with a service is commonly done through a connection to a + port. When this service runs inside a container, one can connect to the + port after finding the IP address of the container as follows: +@@ -74,7 +72,7 @@ port on the host machine bound to a given container port. It is useful + when using dynamically allocated ports: + + # Bind to a dynamically allocated port +- docker run -p 127.0.0.1::8080 -name dyn-bound ++ docker run -p 127.0.0.1::8080 --name dyn-bound + + # Lookup the actual port + docker port dyn-bound 8080 +@@ -105,18 +103,18 @@ started. + + Here is a full example. On `server`, the port of + interest is exposed. The exposure is done either through the +-`-expose` parameter to the `docker run`{.docutils ++`--expose` parameter to the `docker run`{.docutils + .literal} command, or the `EXPOSE` build command in + a Dockerfile: + + # Expose port 80 +- docker run -expose 80 -name server ++ docker run --expose 80 --name server + + The `client` then links to the `server`{.docutils + .literal}: + + # Link +- docker run -name client -link server:linked-server ++ docker run --name client --link server:linked-server + + `client` locally refers to `server`{.docutils + .literal} as `linked-server`. The following +@@ -137,4 +135,4 @@ port 80 of `server` and that `server`{.docutils + .literal} is accessible at the IP address 172.17.0.8 + + Note: Using the `-p` parameter also exposes the +-port.. ++port. +diff --git a/docs/sources/use/puppet.md b/docs/sources/use/puppet.md +index 55f16dd..b00346c 100644 +--- a/docs/sources/use/puppet.md ++++ b/docs/sources/use/puppet.md +@@ -4,10 +4,12 @@ page_keywords: puppet, installation, usage, docker, documentation + + # Using Puppet + +-> *Note:* Please note this is a community contributed installation path. The only +-> ‘official’ installation is using the +-> [*Ubuntu*](../../installation/ubuntulinux/#ubuntu-linux) installation +-> path. This version may sometimes be out of date. ++Note ++ ++Please note this is a community contributed installation path. The only ++‘official’ installation is using the ++[*Ubuntu*](../../installation/ubuntulinux/#ubuntu-linux) installation ++path. This version may sometimes be out of date. + + ## Requirements + +diff --git a/docs/sources/use/working_with_links_names.md b/docs/sources/use/working_with_links_names.md +index 3a12284..b41be0d 100644 +--- a/docs/sources/use/working_with_links_names.md ++++ b/docs/sources/use/working_with_links_names.md +@@ -4,8 +4,6 @@ page_keywords: Examples, Usage, links, linking, docker, documentation, examples, + + # Link Containers + +-## Introduction +- + From version 0.6.5 you are now able to `name` a + container and `link` it to another container by + referring to its name. This will create a parent -\> child relationship +@@ -15,12 +13,13 @@ where the parent container can see selected information about its child. + + New in version v0.6.5. + +-You can now name your container by using the `-name` +-flag. If no name is provided, Docker will automatically generate a name. +-You can see this name using the `docker ps` command. ++You can now name your container by using the `--name`{.docutils ++.literal} flag. If no name is provided, Docker will automatically ++generate a name. You can see this name using the `docker ps`{.docutils ++.literal} command. + +- # format is "sudo docker run -name " +- $ sudo docker run -name test ubuntu /bin/bash ++ # format is "sudo docker run --name " ++ $ sudo docker run --name test ubuntu /bin/bash + + # the flag "-a" Show all containers. Only running containers are shown by default. + $ sudo docker ps -a +@@ -32,9 +31,9 @@ You can see this name using the `docker ps` command. + New in version v0.6.5. + + Links allow containers to discover and securely communicate with each +-other by using the flag `-link name:alias`. ++other by using the flag `--link name:alias`. + Inter-container communication can be disabled with the daemon flag +-`-icc=false`. With this flag set to ++`--icc=false`. With this flag set to + `false`, Container A cannot access Container B + unless explicitly allowed via a link. This is a huge win for securing + your containers. When two containers are linked together Docker creates +@@ -52,9 +51,9 @@ communication is set to false. + For example, there is an image called `crosbymichael/redis`{.docutils + .literal} that exposes the port 6379 and starts the Redis server. Let’s + name the container as `redis` based on that image +-and run it as daemon. ++and run it as a daemon. + +- $ sudo docker run -d -name redis crosbymichael/redis ++ $ sudo docker run -d --name redis crosbymichael/redis + + We can issue all the commands that you would expect using the name + `redis`; start, stop, attach, using the name for our +@@ -67,9 +66,9 @@ our Redis server we did not use the `-p` flag to + publish the Redis port to the host system. Redis exposed port 6379 and + this is all we need to establish a link. + +- $ sudo docker run -t -i -link redis:db -name webapp ubuntu bash ++ $ sudo docker run -t -i --link redis:db --name webapp ubuntu bash + +-When you specified `-link redis:db` you are telling ++When you specified `--link redis:db` you are telling + Docker to link the container named `redis` into this + new container with the alias `db`. Environment + variables are prefixed with the alias so that the parent container can +@@ -101,8 +100,18 @@ Accessing the network information along with the environment of the + child container allows us to easily connect to the Redis service on the + specific IP and port in the environment. + ++Note ++ ++These Environment variables are only set for the first process in the ++container. Similarly, some daemons (such as `sshd`) ++will scrub them when spawning shells for connection. ++ ++You can work around this by storing the initial `env`{.docutils ++.literal} in a file, or looking at `/proc/1/environ`{.docutils ++.literal}. ++ + Running `docker ps` shows the 2 containers, and the +-`webapp/db` alias name for the redis container. ++`webapp/db` alias name for the Redis container. + + $ docker ps + CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES +diff --git a/docs/sources/use/working_with_volumes.md b/docs/sources/use/working_with_volumes.md +index 6cf57ee..542c715 100644 +--- a/docs/sources/use/working_with_volumes.md ++++ b/docs/sources/use/working_with_volumes.md +@@ -4,27 +4,24 @@ page_keywords: Examples, Usage, volume, docker, documentation, examples + + # Share Directories via Volumes + +-## Introduction +- + A *data volume* is a specially-designated directory within one or more + containers that bypasses the [*Union File + System*](../../terms/layer/#ufs-def) to provide several useful features + for persistent or shared data: + +-- **Data volumes can be shared and reused between containers:** +- This is the feature that makes data volumes so powerful. You can +- use it for anything from hot database upgrades to custom backup or +- replication tools. See the example below. +-- **Changes to a data volume are made directly:** +- Without the overhead of a copy-on-write mechanism. This is good for +- very large files. +-- **Changes to a data volume will not be included at the next commit:** +- Because they are not recorded as regular filesystem changes in the +- top layer of the [*Union File System*](../../terms/layer/#ufs-def) +-- **Volumes persist until no containers use them:** +- As they are a reference counted resource. The container does not need to be +- running to share its volumes, but running it can help protect it +- against accidental removal via `docker rm`. ++- **Data volumes can be shared and reused between containers.** This ++ is the feature that makes data volumes so powerful. You can use it ++ for anything from hot database upgrades to custom backup or ++ replication tools. See the example below. ++- **Changes to a data volume are made directly**, without the overhead ++ of a copy-on-write mechanism. This is good for very large files. ++- **Changes to a data volume will not be included at the next commit** ++ because they are not recorded as regular filesystem changes in the ++ top layer of the [*Union File System*](../../terms/layer/#ufs-def) ++- **Volumes persist until no containers use them** as they are a ++ reference counted resource. The container does not need to be ++ running to share its volumes, but running it can help protect it ++ against accidental removal via `docker rm`. + + Each container can have zero or more data volumes. + +@@ -43,7 +40,7 @@ container with two new volumes: + This command will create the new container with two new volumes that + exits instantly (`true` is pretty much the smallest, + simplest program that you can run). Once created you can mount its +-volumes in any other container using the `-volumes-from`{.docutils ++volumes in any other container using the `--volumes-from`{.docutils + .literal} option; irrespective of whether the container is running or + not. + +@@ -51,7 +48,7 @@ Or, you can use the VOLUME instruction in a Dockerfile to add one or + more new volumes to any container created from that image: + + # BUILD-USING: docker build -t data . +- # RUN-USING: docker run -name DATA data ++ # RUN-USING: docker run --name DATA data + FROM busybox + VOLUME ["/var/volume1", "/var/volume2"] + CMD ["/bin/true"] +@@ -66,20 +63,20 @@ it. + Create a named container with volumes to share (`/var/volume1`{.docutils + .literal} and `/var/volume2`): + +- $ docker run -v /var/volume1 -v /var/volume2 -name DATA busybox true ++ $ docker run -v /var/volume1 -v /var/volume2 --name DATA busybox true + + Then mount those data volumes into your application containers: + +- $ docker run -t -i -rm -volumes-from DATA -name client1 ubuntu bash ++ $ docker run -t -i --rm --volumes-from DATA --name client1 ubuntu bash + +-You can use multiple `-volumes-from` parameters to ++You can use multiple `--volumes-from` parameters to + bring together multiple data volumes from multiple containers. + + Interestingly, you can mount the volumes that came from the + `DATA` container in yet another container via the + `client1` middleman container: + +- $ docker run -t -i -rm -volumes-from client1 -name client2 ubuntu bash ++ $ docker run -t -i --rm --volumes-from client1 --name client2 ubuntu bash + + This allows you to abstract the actual data source from users of that + data, similar to +@@ -136,9 +133,9 @@ because they are external to images. Instead you can use + `--volumes-from` to start a new container that can + access the data-container’s volume. For example: + +- $ sudo docker run -rm --volumes-from DATA -v $(pwd):/backup busybox tar cvf /backup/backup.tar /data ++ $ sudo docker run --rm --volumes-from DATA -v $(pwd):/backup busybox tar cvf /backup/backup.tar /data + +-- `-rm` - remove the container when it exits ++- `--rm` - remove the container when it exits + - `--volumes-from DATA` - attach to the volumes + shared by the `DATA` container + - `-v $(pwd):/backup` - bind mount the current +@@ -153,13 +150,13 @@ Then to restore to the same container, or another that you’ve made + elsewhere: + + # create a new data container +- $ sudo docker run -v /data -name DATA2 busybox true ++ $ sudo docker run -v /data --name DATA2 busybox true + # untar the backup files into the new container's data volume +- $ sudo docker run -rm --volumes-from DATA2 -v $(pwd):/backup busybox tar xvf /backup/backup.tar ++ $ sudo docker run --rm --volumes-from DATA2 -v $(pwd):/backup busybox tar xvf /backup/backup.tar + data/ + data/sven.txt + # compare to the original container +- $ sudo docker run -rm --volumes-from DATA -v `pwd`:/backup busybox ls /data ++ $ sudo docker run --rm --volumes-from DATA -v `pwd`:/backup busybox ls /data + sven.txt + + You can use the basic techniques above to automate backup, migration and +diff --git a/docs/sources/use/workingwithrepository.md b/docs/sources/use/workingwithrepository.md +index bd0e274..1cfec63 100644 +--- a/docs/sources/use/workingwithrepository.md ++++ b/docs/sources/use/workingwithrepository.md +@@ -4,8 +4,6 @@ page_keywords: repo, repositories, usage, pull image, push image, image, documen + + # Share Images via Repositories + +-## Introduction +- + A *repository* is a shareable collection of tagged + [*images*](../../terms/image/#image-def) that together create the file + systems for containers. The repository’s name is a label that indicates +@@ -27,14 +25,12 @@ repositories. You can host your own Registry too! Docker acts as a + client for these services via `docker search, pull, login`{.docutils + .literal} and `push`. + +-## Repositories +- +-### Local Repositories ++## Local Repositories + + Docker images which have been created and labeled on your local Docker + server need to be pushed to a Public or Private registry to be shared. + +-### Public Repositories ++## Public Repositories + + There are two types of public repositories: *top-level* repositories + which are controlled by the Docker team, and *user* repositories created +@@ -67,7 +63,7 @@ user name or description: + + Search the docker index for images + +- -notrunc=false: Don't truncate output ++ --no-trunc=false: Don't truncate output + $ sudo docker search centos + Found 25 results matching your query ("centos") + NAME DESCRIPTION +@@ -204,7 +200,7 @@ See also + [Docker Blog: How to use your own + registry](http://blog.docker.io/2013/07/how-to-use-your-own-registry/) + +-## Authentication File ++## Authentication file + + The authentication is stored in a json file, `.dockercfg`{.docutils + .literal} located in your home directory. It supports multiple registry diff --git a/docs/release.sh b/docs/release.sh new file mode 100755 index 0000000000..323887f594 --- /dev/null +++ b/docs/release.sh @@ -0,0 +1,63 @@ +#!/usr/bin/env bash +set -e + +set -o pipefail + +usage() { + cat >&2 <<'EOF' +To publish the Docker documentation you need to set your access_key and secret_key in the docs/awsconfig file +(with the keys in a [profile $AWS_S3_BUCKET] section - so you can have more than one set of keys in your file) +and set the AWS_S3_BUCKET env var to the name of your bucket. + +make AWS_S3_BUCKET=beta-docs.docker.io docs-release + +will then push the documentation site to your s3 bucket. +EOF + exit 1 +} + +[ "$AWS_S3_BUCKET" ] || usage + +#VERSION=$(cat VERSION) +BUCKET=$AWS_S3_BUCKET + +export AWS_CONFIG_FILE=$(pwd)/awsconfig +[ -e "$AWS_CONFIG_FILE" ] || usage +export AWS_DEFAULT_PROFILE=$BUCKET + +echo "cfg file: $AWS_CONFIG_FILE ; profile: $AWS_DEFAULT_PROFILE" + +setup_s3() { + echo "Create $BUCKET" + # Try creating the bucket. Ignore errors (it might already exist). + aws s3 mb s3://$BUCKET 2>/dev/null || true + # Check access to the bucket. + echo "test $BUCKET exists" + aws s3 ls s3://$BUCKET + # Make the bucket accessible through website endpoints. + echo "make $BUCKET accessible as a website" + #aws s3 website s3://$BUCKET --index-document index.html --error-document jsearch/index.html + s3conf=$(cat s3_website.json) + aws s3api put-bucket-website --bucket $BUCKET --website-configuration "$s3conf" +} + +build_current_documentation() { + mkdocs build +} + +upload_current_documentation() { + src=site/ + dst=s3://$BUCKET + + echo + echo "Uploading $src" + echo " to $dst" + echo + #s3cmd --recursive --follow-symlinks --preserve --acl-public sync "$src" "$dst" + aws s3 sync --acl public-read --exclude "*.rej" --exclude "*.rst" --exclude "*.orig" --exclude "*.py" "$src" "$dst" +} + +setup_s3 +build_current_documentation +upload_current_documentation + diff --git a/docs/s3_website.json b/docs/s3_website.json new file mode 100644 index 0000000000..bb68b6652c --- /dev/null +++ b/docs/s3_website.json @@ -0,0 +1,15 @@ +{ + "ErrorDocument": { + "Key": "jsearch/index.html" + }, + "IndexDocument": { + "Suffix": "index.html" + }, + "RoutingRules": [ + { "Condition": { "KeyPrefixEquals": "en/latest/" }, "Redirect": { "ReplaceKeyPrefixWith": "" } }, + { "Condition": { "KeyPrefixEquals": "en/master/" }, "Redirect": { "ReplaceKeyPrefixWith": "" } }, + { "Condition": { "KeyPrefixEquals": "en/v0.6.3/" }, "Redirect": { "ReplaceKeyPrefixWith": "" } }, + { "Condition": { "KeyPrefixEquals": "jsearch/index.html" }, "Redirect": { "ReplaceKeyPrefixWith": "jsearch/" } } + ] +} + diff --git a/docs/sources/article-img/architecture.svg b/docs/sources/article-img/architecture.svg new file mode 100644 index 0000000000..607cc3c18f --- /dev/null +++ b/docs/sources/article-img/architecture.svg @@ -0,0 +1,3 @@ + + +2014-04-15 00:37ZCanvas 1Layer 1HostContainer 1Container 2Container 3Container ...Docker Clientdocker pulldocker rundocker ...Docker IndexDocker Daemon diff --git a/docs/sources/articles.md b/docs/sources/articles.md new file mode 100644 index 0000000000..da5a2d255f --- /dev/null +++ b/docs/sources/articles.md @@ -0,0 +1,8 @@ +# Articles + +## Contents: + +- [Docker Security](security/) +- [Create a Base Image](baseimages/) +- [Runtime Metrics](runmetrics/) + diff --git a/docs/sources/articles/baseimages.md b/docs/sources/articles/baseimages.md new file mode 100644 index 0000000000..d2d6336a6c --- /dev/null +++ b/docs/sources/articles/baseimages.md @@ -0,0 +1,60 @@ +page_title: Create a Base Image +page_description: How to create base images +page_keywords: Examples, Usage, base image, docker, documentation, examples + +# Create a Base Image + +So you want to create your own [*Base +Image*](../../terms/image/#base-image-def)? Great! + +The specific process will depend heavily on the Linux distribution you +want to package. We have some examples below, and you are encouraged to +submit pull requests to contribute new ones. + +## Create a full image using tar + +In general, you’ll want to start with a working machine that is running +the distribution you’d like to package as a base image, though that is +not required for some tools like Debian’s +[Debootstrap](https://wiki.debian.org/Debootstrap), which you can also +use to build Ubuntu images. + +It can be as simple as this to create an Ubuntu base image: + + $ sudo debootstrap raring raring > /dev/null + $ sudo tar -C raring -c . | sudo docker import - raring + a29c15f1bf7a + $ sudo docker run raring cat /etc/lsb-release + DISTRIB_ID=Ubuntu + DISTRIB_RELEASE=13.04 + DISTRIB_CODENAME=raring + DISTRIB_DESCRIPTION="Ubuntu 13.04" + +There are more example scripts for creating base images in the Docker +GitHub Repo: + +- [BusyBox](https://github.com/dotcloud/docker/blob/master/contrib/mkimage-busybox.sh) +- CentOS / Scientific Linux CERN (SLC) [on + Debian/Ubuntu](https://github.com/dotcloud/docker/blob/master/contrib/mkimage-rinse.sh) + or [on + CentOS/RHEL/SLC/etc.](https://github.com/dotcloud/docker/blob/master/contrib/mkimage-yum.sh) +- [Debian / + Ubuntu](https://github.com/dotcloud/docker/blob/master/contrib/mkimage-debootstrap.sh) + +## Creating a simple base image using `scratch` + +There is a special repository in the Docker registry called +`scratch`, which was created using an empty tar +file: + + $ tar cv --files-from /dev/null | docker import - scratch + +which you can `docker pull`. You can then use that +image to base your new minimal containers `FROM`: + + FROM scratch + ADD true-asm /true + CMD ["/true"] + +The Dockerfile above is from extremely minimal image - +[tianon/true](https://github.com/tianon/dockerfiles/tree/master/true). diff --git a/docs/sources/articles/runmetrics.md b/docs/sources/articles/runmetrics.md new file mode 100644 index 0000000000..30e204c892 --- /dev/null +++ b/docs/sources/articles/runmetrics.md @@ -0,0 +1,434 @@ +page_title: Runtime Metrics +page_description: Measure the behavior of running containers +page_keywords: docker, metrics, CPU, memory, disk, IO, run, runtime + +# Runtime Metrics + +Linux Containers rely on [control +groups](https://www.kernel.org/doc/Documentation/cgroups/cgroups.txt) +which not only track groups of processes, but also expose metrics about +CPU, memory, and block I/O usage. You can access those metrics and +obtain network usage metrics as well. This is relevant for "pure" LXC +containers, as well as for Docker containers. + +## Control Groups + +Control groups are exposed through a pseudo-filesystem. In recent +distros, you should find this filesystem under +`/sys/fs/cgroup`. Under that directory, you will see +multiple sub-directories, called devices, freezer, blkio, etc.; each +sub-directory actually corresponds to a different cgroup hierarchy. + +On older systems, the control groups might be mounted on +`/cgroup`, without distinct hierarchies. In that +case, instead of seeing the sub-directories, you will see a bunch of +files in that directory, and possibly some directories corresponding to +existing containers. + +To figure out where your control groups are mounted, you can run: + + grep cgroup /proc/mounts + +## Enumerating Cgroups + +You can look into `/proc/cgroups` to see the +different control group subsystems known to the system, the hierarchy +they belong to, and how many groups they contain. + +You can also look at `/proc//cgroup` to see +which control groups a process belongs to. The control group will be +shown as a path relative to the root of the hierarchy mountpoint; e.g. +`/` means “this process has not been assigned into a +particular group”, while `/lxc/pumpkin` means that +the process is likely to be a member of a container named +`pumpkin`. + +## Finding the Cgroup for a Given Container + +For each container, one cgroup will be created in each hierarchy. On +older systems with older versions of the LXC userland tools, the name of +the cgroup will be the name of the container. With more recent versions +of the LXC tools, the cgroup will be `lxc/.` + +For Docker containers using cgroups, the container name will be the full +ID or long ID of the container. If a container shows up as ae836c95b4c3 +in `docker ps`, its long ID might be something like +`ae836c95b4c3c9e9179e0e91015512da89fdec91612f63cebae57df9a5444c79`. You can look it up with `docker inspect` +or `docker ps -notrunc`. + +Putting everything together to look at the memory metrics for a Docker +container, take a look at +`/sys/fs/cgroup/memory/lxc//`. + +## Metrics from Cgroups: Memory, CPU, Block IO + +For each subsystem (memory, CPU, and block I/O), you will find one or +more pseudo-files containing statistics. + +### Memory Metrics: `memory.stat` + +Memory metrics are found in the "memory" cgroup. Note that the memory +control group adds a little overhead, because it does very fine-grained +accounting of the memory usage on your host. Therefore, many distros +chose to not enable it by default. Generally, to enable it, all you have +to do is to add some kernel command-line parameters: +`cgroup_enable=memory swapaccount=1`. + +The metrics are in the pseudo-file `memory.stat`. +Here is what it will look like: + + cache 11492564992 + rss 1930993664 + mapped_file 306728960 + pgpgin 406632648 + pgpgout 403355412 + swap 0 + pgfault 728281223 + pgmajfault 1724 + inactive_anon 46608384 + active_anon 1884520448 + inactive_file 7003344896 + active_file 4489052160 + unevictable 32768 + hierarchical_memory_limit 9223372036854775807 + hierarchical_memsw_limit 9223372036854775807 + total_cache 11492564992 + total_rss 1930993664 + total_mapped_file 306728960 + total_pgpgin 406632648 + total_pgpgout 403355412 + total_swap 0 + total_pgfault 728281223 + total_pgmajfault 1724 + total_inactive_anon 46608384 + total_active_anon 1884520448 + total_inactive_file 7003344896 + total_active_file 4489052160 + total_unevictable 32768 + +The first half (without the `total_` prefix) +contains statistics relevant to the processes within the cgroup, +excluding sub-cgroups. The second half (with the `total_` +prefix) includes sub-cgroups as well. + +Some metrics are "gauges", i.e. values that can increase or decrease +(e.g. swap, the amount of swap space used by the members of the cgroup). +Some others are "counters", i.e. values that can only go up, because +they represent occurrences of a specific event (e.g. pgfault, which +indicates the number of page faults which happened since the creation of +the cgroup; this number can never decrease). + +cache +: the amount of memory used by the processes of this control group + that can be associated precisely with a block on a block device. + When you read from and write to files on disk, this amount will + increase. This will be the case if you use "conventional" I/O + (`open`, `read`, + `write` syscalls) as well as mapped files (with + `mmap`). It also accounts for the memory used by + `tmpfs` mounts, though the reasons are unclear. +rss +: the amount of memory that *doesn’t* correspond to anything on disk: + stacks, heaps, and anonymous memory maps. +mapped\_file +: indicates the amount of memory mapped by the processes in the + control group. It doesn’t give you information about *how much* + memory is used; it rather tells you *how* it is used. +pgfault and pgmajfault +: indicate the number of times that a process of the cgroup triggered + a "page fault" and a "major fault", respectively. A page fault + happens when a process accesses a part of its virtual memory space + which is nonexistent or protected. The former can happen if the + process is buggy and tries to access an invalid address (it will + then be sent a `SIGSEGV` signal, typically + killing it with the famous `Segmentation fault` + message). The latter can happen when the process reads from a memory + zone which has been swapped out, or which corresponds to a mapped + file: in that case, the kernel will load the page from disk, and let + the CPU complete the memory access. It can also happen when the + process writes to a copy-on-write memory zone: likewise, the kernel + will preempt the process, duplicate the memory page, and resume the + write operation on the process’ own copy of the page. "Major" faults + happen when the kernel actually has to read the data from disk. When + it just has to duplicate an existing page, or allocate an empty + page, it’s a regular (or "minor") fault. +swap +: the amount of swap currently used by the processes in this cgroup. +active\_anon and inactive\_anon +: the amount of *anonymous* memory that has been identified has + respectively *active* and *inactive* by the kernel. "Anonymous" + memory is the memory that is *not* linked to disk pages. In other + words, that’s the equivalent of the rss counter described above. In + fact, the very definition of the rss counter is **active\_anon** + + **inactive\_anon** - **tmpfs** (where tmpfs is the amount of memory + used up by `tmpfs` filesystems mounted by this + control group). Now, what’s the difference between "active" and + "inactive"? Pages are initially "active"; and at regular intervals, + the kernel sweeps over the memory, and tags some pages as + "inactive". Whenever they are accessed again, they are immediately + retagged "active". When the kernel is almost out of memory, and time + comes to swap out to disk, the kernel will swap "inactive" pages. +active\_file and inactive\_file +: cache memory, with *active* and *inactive* similar to the *anon* + memory above. The exact formula is cache = **active\_file** + + **inactive\_file** + **tmpfs**. The exact rules used by the kernel + to move memory pages between active and inactive sets are different + from the ones used for anonymous memory, but the general principle + is the same. Note that when the kernel needs to reclaim memory, it + is cheaper to reclaim a clean (=non modified) page from this pool, + since it can be reclaimed immediately (while anonymous pages and + dirty/modified pages have to be written to disk first). +unevictable +: the amount of memory that cannot be reclaimed; generally, it will + account for memory that has been "locked" with `mlock` +. It is often used by crypto frameworks to make sure that + secret keys and other sensitive material never gets swapped out to + disk. +memory and memsw limits +: These are not really metrics, but a reminder of the limits applied + to this cgroup. The first one indicates the maximum amount of + physical memory that can be used by the processes of this control + group; the second one indicates the maximum amount of RAM+swap. + +Accounting for memory in the page cache is very complex. If two +processes in different control groups both read the same file +(ultimately relying on the same blocks on disk), the corresponding +memory charge will be split between the control groups. It’s nice, but +it also means that when a cgroup is terminated, it could increase the +memory usage of another cgroup, because they are not splitting the cost +anymore for those memory pages. + +### CPU metrics: `cpuacct.stat` + +Now that we’ve covered memory metrics, everything else will look very +simple in comparison. CPU metrics will be found in the +`cpuacct` controller. + +For each container, you will find a pseudo-file `cpuacct.stat`, +containing the CPU usage accumulated by the processes of the container, +broken down between `user` and `system` time. If you’re not familiar +with the distinction, `user` is the time during which the processes were +in direct control of the CPU (i.e. executing process code), and `system` +is the time during which the CPU was executing system calls on behalf of +those processes. + +Those times are expressed in ticks of 1/100th of a second. Actually, +they are expressed in "user jiffies". There are `USER_HZ` +*"jiffies"* per second, and on x86 systems, +`USER_HZ` is 100. This used to map exactly to the +number of scheduler "ticks" per second; but with the advent of higher +frequency scheduling, as well as [tickless +kernels](http://lwn.net/Articles/549580/), the number of kernel ticks +wasn’t relevant anymore. It stuck around anyway, mainly for legacy and +compatibility reasons. + +### Block I/O metrics + +Block I/O is accounted in the `blkio` controller. +Different metrics are scattered across different files. While you can +find in-depth details in the +[blkio-controller](https://www.kernel.org/doc/Documentation/cgroups/blkio-controller.txt) +file in the kernel documentation, here is a short list of the most +relevant ones: + +blkio.sectors +: contain the number of 512-bytes sectors read and written by the + processes member of the cgroup, device by device. Reads and writes + are merged in a single counter. +blkio.io\_service\_bytes +: indicates the number of bytes read and written by the cgroup. It has + 4 counters per device, because for each device, it differentiates + between synchronous vs. asynchronous I/O, and reads vs. writes. +blkio.io\_serviced +: the number of I/O operations performed, regardless of their size. It + also has 4 counters per device. +blkio.io\_queued +: indicates the number of I/O operations currently queued for this + cgroup. In other words, if the cgroup isn’t doing any I/O, this will + be zero. Note that the opposite is not true. In other words, if + there is no I/O queued, it does not mean that the cgroup is idle + (I/O-wise). It could be doing purely synchronous reads on an + otherwise quiescent device, which is therefore able to handle them + immediately, without queuing. Also, while it is helpful to figure + out which cgroup is putting stress on the I/O subsystem, keep in + mind that is is a relative quantity. Even if a process group does + not perform more I/O, its queue size can increase just because the + device load increases because of other devices. + +## Network Metrics + +Network metrics are not exposed directly by control groups. There is a +good explanation for that: network interfaces exist within the context +of *network namespaces*. The kernel could probably accumulate metrics +about packets and bytes sent and received by a group of processes, but +those metrics wouldn’t be very useful. You want per-interface metrics +(because traffic happening on the local `lo` +interface doesn’t really count). But since processes in a single cgroup +can belong to multiple network namespaces, those metrics would be harder +to interpret: multiple network namespaces means multiple `lo` +interfaces, potentially multiple `eth0` +interfaces, etc.; so this is why there is no easy way to gather network +metrics with control groups. + +Instead we can gather network metrics from other sources: + +### IPtables + +IPtables (or rather, the netfilter framework for which iptables is just +an interface) can do some serious accounting. + +For instance, you can setup a rule to account for the outbound HTTP +traffic on a web server: + + iptables -I OUTPUT -p tcp --sport 80 + +There is no `-j` or `-g` flag, +so the rule will just count matched packets and go to the following +rule. + +Later, you can check the values of the counters, with: + + iptables -nxvL OUTPUT + +Technically, `-n` is not required, but it will +prevent iptables from doing DNS reverse lookups, which are probably +useless in this scenario. + +Counters include packets and bytes. If you want to setup metrics for +container traffic like this, you could execute a `for` +loop to add two `iptables` rules per +container IP address (one in each direction), in the `FORWARD` +chain. This will only meter traffic going through the NAT +layer; you will also have to add traffic going through the userland +proxy. + +Then, you will need to check those counters on a regular basis. If you +happen to use `collectd`, there is a nice plugin to +automate iptables counters collection. + +### Interface-level counters + +Since each container has a virtual Ethernet interface, you might want to +check directly the TX and RX counters of this interface. You will notice +that each container is associated to a virtual Ethernet interface in +your host, with a name like `vethKk8Zqi`. Figuring +out which interface corresponds to which container is, unfortunately, +difficult. + +But for now, the best way is to check the metrics *from within the +containers*. To accomplish this, you can run an executable from the host +environment within the network namespace of a container using **ip-netns +magic**. + +The `ip-netns exec` command will let you execute any +program (present in the host system) within any network namespace +visible to the current process. This means that your host will be able +to enter the network namespace of your containers, but your containers +won’t be able to access the host, nor their sibling containers. +Containers will be able to “see” and affect their sub-containers, +though. + +The exact format of the command is: + + ip netns exec + +For example: + + ip netns exec mycontainer netstat -i + +`ip netns` finds the "mycontainer" container by +using namespaces pseudo-files. Each process belongs to one network +namespace, one PID namespace, one `mnt` namespace, +etc., and those namespaces are materialized under +`/proc//ns/`. For example, the network +namespace of PID 42 is materialized by the pseudo-file +`/proc/42/ns/net`. + +When you run `ip netns exec mycontainer ...`, it +expects `/var/run/netns/mycontainer` to be one of +those pseudo-files. (Symlinks are accepted.) + +In other words, to execute a command within the network namespace of a +container, we need to: + +- Find out the PID of any process within the container that we want to + investigate; +- Create a symlink from `/var/run/netns/` + to `/proc//ns/net` +- Execute `ip netns exec ....` + +Please review [*Enumerating Cgroups*](#enumerating-cgroups) to learn how to find +the cgroup of a pprocess running in the container of which you want to +measure network usage. From there, you can examine the pseudo-file named +`tasks`, which containes the PIDs that are in the +control group (i.e. in the container). Pick any one of them. + +Putting everything together, if the "short ID" of a container is held in +the environment variable `$CID`, then you can do +this: + + TASKS=/sys/fs/cgroup/devices/$CID*/tasks + PID=$(head -n 1 $TASKS) + mkdir -p /var/run/netns + ln -sf /proc/$PID/ns/net /var/run/netns/$CID + ip netns exec $CID netstat -i + +## Tips for high-performance metric collection + +Note that running a new process each time you want to update metrics is +(relatively) expensive. If you want to collect metrics at high +resolutions, and/or over a large number of containers (think 1000 +containers on a single host), you do not want to fork a new process each +time. + +Here is how to collect metrics from a single process. You will have to +write your metric collector in C (or any language that lets you do +low-level system calls). You need to use a special system call, +`setns()`, which lets the current process enter any +arbitrary namespace. It requires, however, an open file descriptor to +the namespace pseudo-file (remember: that’s the pseudo-file in +`/proc//ns/net`). + +However, there is a catch: you must not keep this file descriptor open. +If you do, when the last process of the control group exits, the +namespace will not be destroyed, and its network resources (like the +virtual interface of the container) will stay around for ever (or until +you close that file descriptor). + +The right approach would be to keep track of the first PID of each +container, and re-open the namespace pseudo-file each time. + +## Collecting metrics when a container exits + +Sometimes, you do not care about real time metric collection, but when a +container exits, you want to know how much CPU, memory, etc. it has +used. + +Docker makes this difficult because it relies on `lxc-start`, which +carefully cleans up after itself, but it is still possible. It is +usually easier to collect metrics at regular intervals (e.g. every +minute, with the collectd LXC plugin) and rely on that instead. + +But, if you’d still like to gather the stats when a container stops, +here is how: + +For each container, start a collection process, and move it to the +control groups that you want to monitor by writing its PID to the tasks +file of the cgroup. The collection process should periodically re-read +the tasks file to check if it’s the last process of the control group. +(If you also want to collect network statistics as explained in the +previous section, you should also move the process to the appropriate +network namespace.) + +When the container exits, `lxc-start` will try to +delete the control groups. It will fail, since the control group is +still in use; but that’s fine. You process should now detect that it is +the only one remaining in the group. Now is the right time to collect +all the metrics you need! + +Finally, your process should move itself back to the root control group, +and remove the container control group. To remove a control group, just +`rmdir` its directory. It’s counter-intuitive to +`rmdir` a directory as it still contains files; but +remember that this is a pseudo-filesystem, so usual rules don’t apply. +After the cleanup is done, the collection process can exit safely. diff --git a/docs/sources/articles/security.md b/docs/sources/articles/security.md new file mode 100644 index 0000000000..1a438295e7 --- /dev/null +++ b/docs/sources/articles/security.md @@ -0,0 +1,258 @@ +page_title: Docker Security +page_description: Review of the Docker Daemon attack surface +page_keywords: Docker, Docker documentation, security + +# Docker Security + +> *Adapted from* [Containers & Docker: How Secure are +> They?](http://blog.docker.io/2013/08/containers-docker-how-secure-are-they/) + +There are three major areas to consider when reviewing Docker security: + +- the intrinsic security of containers, as implemented by kernel + namespaces and cgroups; +- the attack surface of the Docker daemon itself; +- the "hardening" security features of the kernel and how they + interact with containers. + +## Kernel Namespaces + +Docker containers are essentially LXC containers, and they come with the +same security features. When you start a container with +`docker run`, behind the scenes Docker uses +`lxc-start` to execute the Docker container. This +creates a set of namespaces and control groups for the container. Those +namespaces and control groups are not created by Docker itself, but by +`lxc-start`. This means that as the LXC userland +tools evolve (and provide additional namespaces and isolation features), +Docker will automatically make use of them. + +**Namespaces provide the first and most straightforward form of +isolation**: processes running within a container cannot see, and even +less affect, processes running in another container, or in the host +system. + +**Each container also gets its own network stack**, meaning that a +container doesn’t get a privileged access to the sockets or interfaces +of another container. Of course, if the host system is setup +accordingly, containers can interact with each other through their +respective network interfaces — just like they can interact with +external hosts. When you specify public ports for your containers or use +[*links*](../../use/working_with_links_names/#working-with-links-names) +then IP traffic is allowed between containers. They can ping each other, +send/receive UDP packets, and establish TCP connections, but that can be +restricted if necessary. From a network architecture point of view, all +containers on a given Docker host are sitting on bridge interfaces. This +means that they are just like physical machines connected through a +common Ethernet switch; no more, no less. + +How mature is the code providing kernel namespaces and private +networking? Kernel namespaces were introduced [between kernel version +2.6.15 and +2.6.26](http://lxc.sourceforge.net/index.php/about/kernel-namespaces/). +This means that since July 2008 (date of the 2.6.26 release, now 5 years +ago), namespace code has been exercised and scrutinized on a large +number of production systems. And there is more: the design and +inspiration for the namespaces code are even older. Namespaces are +actually an effort to reimplement the features of +[OpenVZ](http://en.wikipedia.org/wiki/OpenVZ) in such a way that they +could be merged within the mainstream kernel. And OpenVZ was initially +released in 2005, so both the design and the implementation are pretty +mature. + +## Control Groups + +Control Groups are the other key component of Linux Containers. They +implement resource accounting and limiting. They provide a lot of very +useful metrics, but they also help to ensure that each container gets +its fair share of memory, CPU, disk I/O; and, more importantly, that a +single container cannot bring the system down by exhausting one of those +resources. + +So while they do not play a role in preventing one container from +accessing or affecting the data and processes of another container, they +are essential to fend off some denial-of-service attacks. They are +particularly important on multi-tenant platforms, like public and +private PaaS, to guarantee a consistent uptime (and performance) even +when some applications start to misbehave. + +Control Groups have been around for a while as well: the code was +started in 2006, and initially merged in kernel 2.6.24. + +## Docker Daemon Attack Surface + +Running containers (and applications) with Docker implies running the +Docker daemon. This daemon currently requires root privileges, and you +should therefore be aware of some important details. + +First of all, **only trusted users should be allowed to control your +Docker daemon**. This is a direct consequence of some powerful Docker +features. Specifically, Docker allows you to share a directory between +the Docker host and a guest container; and it allows you to do so +without limiting the access rights of the container. This means that you +can start a container where the `/host` directory +will be the `/` directory on your host; and the +container will be able to alter your host filesystem without any +restriction. This sounds crazy? Well, you have to know that **all +virtualization systems allowing filesystem resource sharing behave the +same way**. Nothing prevents you from sharing your root filesystem (or +even your root block device) with a virtual machine. + +This has a strong security implication: if you instrument Docker from +e.g. a web server to provision containers through an API, you should be +even more careful than usual with parameter checking, to make sure that +a malicious user cannot pass crafted parameters causing Docker to create +arbitrary containers. + +For this reason, the REST API endpoint (used by the Docker CLI to +communicate with the Docker daemon) changed in Docker 0.5.2, and now +uses a UNIX socket instead of a TCP socket bound on 127.0.0.1 (the +latter being prone to cross-site-scripting attacks if you happen to run +Docker directly on your local machine, outside of a VM). You can then +use traditional UNIX permission checks to limit access to the control +socket. + +You can also expose the REST API over HTTP if you explicitly decide so. +However, if you do that, being aware of the abovementioned security +implication, you should ensure that it will be reachable only from a +trusted network or VPN; or protected with e.g. `stunnel` +and client SSL certificates. + +Recent improvements in Linux namespaces will soon allow to run +full-featured containers without root privileges, thanks to the new user +namespace. This is covered in detail +[here](http://s3hh.wordpress.com/2013/07/19/creating-and-using-containers-without-privilege/). +Moreover, this will solve the problem caused by sharing filesystems +between host and guest, since the user namespace allows users within +containers (including the root user) to be mapped to other users in the +host system. + +The end goal for Docker is therefore to implement two additional +security improvements: + +- map the root user of a container to a non-root user of the Docker + host, to mitigate the effects of a container-to-host privilege + escalation; +- allow the Docker daemon to run without root privileges, and delegate + operations requiring those privileges to well-audited sub-processes, + each with its own (very limited) scope: virtual network setup, + filesystem management, etc. + +Finally, if you run Docker on a server, it is recommended to run +exclusively Docker in the server, and move all other services within +containers controlled by Docker. Of course, it is fine to keep your +favorite admin tools (probably at least an SSH server), as well as +existing monitoring/supervision processes (e.g. NRPE, collectd, etc). + +## Linux Kernel Capabilities + +By default, Docker starts containers with a very restricted set of +capabilities. What does that mean? + +Capabilities turn the binary "root/non-root" dichotomy into a +fine-grained access control system. Processes (like web servers) that +just need to bind on a port below 1024 do not have to run as root: they +can just be granted the `net_bind_service` +capability instead. And there are many other capabilities, for almost +all the specific areas where root privileges are usually needed. + +This means a lot for container security; let’s see why! + +Your average server (bare metal or virtual machine) needs to run a bunch +of processes as root. Those typically include SSH, cron, syslogd; +hardware management tools (to e.g. load modules), network configuration +tools (to handle e.g. DHCP, WPA, or VPNs), and much more. A container is +very different, because almost all of those tasks are handled by the +infrastructure around the container: + +- SSH access will typically be managed by a single server running in + the Docker host; +- `cron`, when necessary, should run as a user + process, dedicated and tailored for the app that needs its + scheduling service, rather than as a platform-wide facility; +- log management will also typically be handed to Docker, or by + third-party services like Loggly or Splunk; +- hardware management is irrelevant, meaning that you never need to + run `udevd` or equivalent daemons within + containers; +- network management happens outside of the containers, enforcing + separation of concerns as much as possible, meaning that a container + should never need to perform `ifconfig`, + `route`, or ip commands (except when a container + is specifically engineered to behave like a router or firewall, of + course). + +This means that in most cases, containers will not need "real" root +privileges *at all*. And therefore, containers can run with a reduced +capability set; meaning that "root" within a container has much less +privileges than the real "root". For instance, it is possible to: + +- deny all "mount" operations; +- deny access to raw sockets (to prevent packet spoofing); +- deny access to some filesystem operations, like creating new device + nodes, changing the owner of files, or altering attributes + (including the immutable flag); +- deny module loading; +- and many others. + +This means that even if an intruder manages to escalate to root within a +container, it will be much harder to do serious damage, or to escalate +to the host. + +This won’t affect regular web apps; but malicious users will find that +the arsenal at their disposal has shrunk considerably! You can see [the +list of dropped capabilities in the Docker +code](https://github.com/dotcloud/docker/blob/v0.5.0/lxc_template.go#L97), +and a full list of available capabilities in [Linux +manpages](http://man7.org/linux/man-pages/man7/capabilities.7.html). + +Of course, you can always enable extra capabilities if you really need +them (for instance, if you want to use a FUSE-based filesystem), but by +default, Docker containers will be locked down to ensure maximum safety. + +## Other Kernel Security Features + +Capabilities are just one of the many security features provided by +modern Linux kernels. It is also possible to leverage existing, +well-known systems like TOMOYO, AppArmor, SELinux, GRSEC, etc. with +Docker. + +While Docker currently only enables capabilities, it doesn’t interfere +with the other systems. This means that there are many different ways to +harden a Docker host. Here are a few examples. + +- You can run a kernel with GRSEC and PAX. This will add many safety + checks, both at compile-time and run-time; it will also defeat many + exploits, thanks to techniques like address randomization. It + doesn’t require Docker-specific configuration, since those security + features apply system-wide, independently of containers. +- If your distribution comes with security model templates for LXC + containers, you can use them out of the box. For instance, Ubuntu + comes with AppArmor templates for LXC, and those templates provide + an extra safety net (even though it overlaps greatly with + capabilities). +- You can define your own policies using your favorite access control + mechanism. Since Docker containers are standard LXC containers, + there is nothing “magic” or specific to Docker. + +Just like there are many third-party tools to augment Docker containers +with e.g. special network topologies or shared filesystems, you can +expect to see tools to harden existing Docker containers without +affecting Docker’s core. + +## Conclusions + +Docker containers are, by default, quite secure; especially if you take +care of running your processes inside the containers as non-privileged +users (i.e. non root). + +You can add an extra layer of safety by enabling Apparmor, SELinux, +GRSEC, or your favorite hardening solution. + +Last but not least, if you see interesting security features in other +containerization systems, you will be able to implement them as well +with Docker, since everything is provided by the kernel anyway. + +For more context and especially for comparisons with VMs and other +container systems, please also see the [original blog +post](http://blog.docker.io/2013/08/containers-docker-how-secure-are-they/). diff --git a/docs/sources/contributing.md b/docs/sources/contributing.md new file mode 100644 index 0000000000..b311d13f8c --- /dev/null +++ b/docs/sources/contributing.md @@ -0,0 +1,7 @@ +# Contributing + +## Contents: + +- [Contributing to Docker](contributing/) +- [Setting Up a Dev Environment](devenvironment/) + diff --git a/docs/sources/contributing/contributing.md b/docs/sources/contributing/contributing.md new file mode 100644 index 0000000000..9e2ad19073 --- /dev/null +++ b/docs/sources/contributing/contributing.md @@ -0,0 +1,24 @@ +page_title: Contribution Guidelines +page_description: Contribution guidelines: create issues, conventions, pull requests +page_keywords: contributing, docker, documentation, help, guideline + +# Contributing to Docker + +Want to hack on Docker? Awesome! + +The repository includes [all the instructions you need to get +started](https://github.com/dotcloud/docker/blob/master/CONTRIBUTING.md). + +The [developer environment +Dockerfile](https://github.com/dotcloud/docker/blob/master/Dockerfile) +specifies the tools and versions used to test and build Docker. + +If you’re making changes to the documentation, see the +[README.md](https://github.com/dotcloud/docker/blob/master/docs/README.md). + +The [documentation environment +Dockerfile](https://github.com/dotcloud/docker/blob/master/docs/Dockerfile) +specifies the tools and versions used to build the Documentation. + +Further interesting details can be found in the [Packaging +hints](https://github.com/dotcloud/docker/blob/master/hack/PACKAGERS.md). diff --git a/docs/sources/contributing/devenvironment.md b/docs/sources/contributing/devenvironment.md new file mode 100644 index 0000000000..6551d9fbac --- /dev/null +++ b/docs/sources/contributing/devenvironment.md @@ -0,0 +1,147 @@ +page_title: Setting Up a Dev Environment +page_description: Guides on how to contribute to docker +page_keywords: Docker, documentation, developers, contributing, dev environment + +# Setting Up a Dev Environment + +To make it easier to contribute to Docker, we provide a standard +development environment. It is important that the same environment be +used for all tests, builds and releases. The standard development +environment defines all build dependencies: system libraries and +binaries, go environment, go dependencies, etc. + +## Install Docker + +Docker’s build environment itself is a Docker container, so the first +step is to install Docker on your system. + +You can follow the [install instructions most relevant to your +system](https://docs.docker.io/en/latest/installation/). Make sure you +have a working, up-to-date docker installation, then continue to the +next step. + +## Install tools used for this tutorial + +Install `git`; honest, it’s very good. You can use +other ways to get the Docker source, but they’re not anywhere near as +easy. + +Install `make`. This tutorial uses our base Makefile +to kick off the docker containers in a repeatable and consistent way. +Again, you can do it in other ways but you need to do more work. + +## Check out the Source + + git clone http://git@github.com/dotcloud/docker + cd docker + +To checkout a different revision just use `git checkout` +with the name of branch or revision number. + +## Build the Environment + +This following command will build a development environment using the +Dockerfile in the current directory. Essentially, it will install all +the build and runtime dependencies necessary to build and test Docker. +This command will take some time to complete when you first execute it. + + sudo make build + +If the build is successful, congratulations! You have produced a clean +build of docker, neatly encapsulated in a standard build environment. + +## Build the Docker Binary + +To create the Docker binary, run this command: + + sudo make binary + +This will create the Docker binary in +`./bundles/-dev/binary/` + +### Using your built Docker binary + +The binary is available outside the container in the directory +`./bundles/-dev/binary/`. You can swap your +host docker executable with this binary for live testing - for example, +on ubuntu: + + sudo service docker stop ; sudo cp $(which docker) $(which docker)_ ; sudo cp ./bundles/-dev/binary/docker--dev $(which docker);sudo service docker start + +> **Note**: +> Its safer to run the tests below before swapping your hosts docker binary. + +## Run the Tests + +To execute the test cases, run this command: + + sudo make test + +If the test are successful then the tail of the output should look +something like this + + --- PASS: TestWriteBroadcaster (0.00 seconds) + === RUN TestRaceWriteBroadcaster + --- PASS: TestRaceWriteBroadcaster (0.00 seconds) + === RUN TestTruncIndex + --- PASS: TestTruncIndex (0.00 seconds) + === RUN TestCompareKernelVersion + --- PASS: TestCompareKernelVersion (0.00 seconds) + === RUN TestHumanSize + --- PASS: TestHumanSize (0.00 seconds) + === RUN TestParseHost + --- PASS: TestParseHost (0.00 seconds) + === RUN TestParseRepositoryTag + --- PASS: TestParseRepositoryTag (0.00 seconds) + === RUN TestGetResolvConf + --- PASS: TestGetResolvConf (0.00 seconds) + === RUN TestCheckLocalDns + --- PASS: TestCheckLocalDns (0.00 seconds) + === RUN TestParseRelease + --- PASS: TestParseRelease (0.00 seconds) + === RUN TestDependencyGraphCircular + --- PASS: TestDependencyGraphCircular (0.00 seconds) + === RUN TestDependencyGraph + --- PASS: TestDependencyGraph (0.00 seconds) + PASS + ok github.com/dotcloud/docker/utils 0.017s + +If $TESTFLAGS is set in the environment, it is passed as extra +arguments to ‘go test’. You can use this to select certain tests to run, +eg. + +> TESTFLAGS=’-run \^TestBuild\$’ make test + +If the output indicates "FAIL" and you see errors like this: + + server.go:1302 Error: Insertion failed because database is full: database or disk is full + + utils_test.go:179: Error copy: exit status 1 (cp: writing '/tmp/docker-testd5c9-[...]': No space left on device + +Then you likely don’t have enough memory available the test suite. 2GB +is recommended. + +## Use Docker + +You can run an interactive session in the newly built container: + + sudo make shell + + # type 'exit' or Ctrl-D to exit + +## Build And View The Documentation + +If you want to read the documentation from a local website, or are +making changes to it, you can build the documentation and then serve it +by: + + sudo make docs + # when its done, you can point your browser to http://yourdockerhost:8000 + # type Ctrl-C to exit + +**Need More Help?** + +If you need more help then hop on to the [\#docker-dev IRC +channel](irc://chat.freenode.net#docker-dev) or post a message on the +[Docker developer mailing +list](https://groups.google.com/d/forum/docker-dev). diff --git a/docs/sources/examples.md b/docs/sources/examples.md new file mode 100644 index 0000000000..98b3d25893 --- /dev/null +++ b/docs/sources/examples.md @@ -0,0 +1,25 @@ + +# Examples + +## Introduction: + +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 those which you might find in production. + +## Contents: + +- [Check your Docker install](hello_world/) +- [Hello World](hello_world/#hello-world) +- [Hello World Daemon](hello_world/#hello-world-daemon) +- [Node.js Web App](nodejs_web_app/) +- [Redis Service](running_redis_service/) +- [SSH Daemon Service](running_ssh_service/) +- [CouchDB Service](couchdb_data_volumes/) +- [PostgreSQL Service](postgresql_service/) +- [Building an Image with MongoDB](mongodb/) +- [Riak Service](running_riak_service/) +- [Using Supervisor with Docker](using_supervisord/) +- [Process Management with CFEngine](cfengine_process_management/) +- [Python Web App](python_web_app/) + diff --git a/docs/sources/examples/apt-cacher-ng.md b/docs/sources/examples/apt-cacher-ng.md new file mode 100644 index 0000000000..c7fee5542a --- /dev/null +++ b/docs/sources/examples/apt-cacher-ng.md @@ -0,0 +1,112 @@ +page_title: Running an apt-cacher-ng service +page_description: Installing and running an apt-cacher-ng service +page_keywords: docker, example, package installation, networking, debian, ubuntu + +# Apt-Cacher-ng Service + +> **Note**: +> +> - This example assumes you have Docker running in daemon mode. For +> more information please see [*Check your Docker +> install*](../hello_world/#running-examples). +> - **If you don’t like sudo** then see [*Giving non-root +> access*](../../installation/binaries/#dockergroup). +> - **If you’re using OS X or docker via TCP** then you shouldn’t use +> sudo. + +When you have multiple Docker servers, or build unrelated Docker +containers which can’t make use of the Docker build cache, it can be +useful to have a caching proxy for your packages. This container makes +the second download of any package almost instant. + +Use the following Dockerfile: + + # + # Build: docker build -t apt-cacher . + # Run: docker run -d -p 3142:3142 --name apt-cacher-run apt-cacher + # + # and then you can run containers with: + # docker run -t -i --rm -e http_proxy http://dockerhost:3142/ debian bash + # + FROM ubuntu + MAINTAINER SvenDowideit@docker.com + + VOLUME ["/var/cache/apt-cacher-ng"] + RUN apt-get update ; apt-get install -yq apt-cacher-ng + + EXPOSE 3142 + CMD chmod 777 /var/cache/apt-cacher-ng ; /etc/init.d/apt-cacher-ng start ; tail -f /var/log/apt-cacher-ng/* + +To build the image using: + + $ sudo docker build -t eg_apt_cacher_ng . + +Then run it, mapping the exposed port to one on the host + + $ sudo docker run -d -p 3142:3142 --name test_apt_cacher_ng eg_apt_cacher_ng + +To see the logfiles that are ‘tailed’ in the default command, you can +use: + + $ sudo docker logs -f test_apt_cacher_ng + +To get your Debian-based containers to use the proxy, you can do one of +three things + +1. Add an apt Proxy setting + `echo 'Acquire::http { Proxy "http://dockerhost:3142"; };' >> /etc/apt/conf.d/01proxy` + +2. Set an environment variable: + `http_proxy=http://dockerhost:3142/` +3. Change your `sources.list` entries to start with + `http://dockerhost:3142/` + +**Option 1** injects the settings safely into your apt configuration in +a local version of a common base: + + FROM ubuntu + RUN echo 'Acquire::http { Proxy "http://dockerhost:3142"; };' >> /etc/apt/apt.conf.d/01proxy + RUN apt-get update ; apt-get install vim git + + # docker build -t my_ubuntu . + +**Option 2** is good for testing, but will break other HTTP clients +which obey `http_proxy`, such as `curl`, `wget` and others: + + $ sudo docker run --rm -t -i -e http_proxy=http://dockerhost:3142/ debian bash + +**Option 3** is the least portable, but there will be times when you +might need to do it and you can do it from your `Dockerfile` +too. + +Apt-cacher-ng has some tools that allow you to manage the repository, +and they can be used by leveraging the `VOLUME` +instruction, and the image we built to run the service: + + $ sudo docker run --rm -t -i --volumes-from test_apt_cacher_ng eg_apt_cacher_ng bash + + $$ /usr/lib/apt-cacher-ng/distkill.pl + Scanning /var/cache/apt-cacher-ng, please wait... + Found distributions: + bla, taggedcount: 0 + 1. precise-security (36 index files) + 2. wheezy (25 index files) + 3. precise-updates (36 index files) + 4. precise (36 index files) + 5. wheezy-updates (18 index files) + + Found architectures: + 6. amd64 (36 index files) + 7. i386 (24 index files) + + WARNING: The removal action may wipe out whole directories containing + index files. Select d to see detailed list. + + (Number nn: tag distribution or architecture nn; 0: exit; d: show details; r: remove tagged; q: quit): q + +Finally, clean up after your test by stopping and removing the +container, and then removing the image. + + $ sudo docker stop test_apt_cacher_ng + $ sudo docker rm test_apt_cacher_ng + $ sudo docker rmi eg_apt_cacher_ng diff --git a/docs/sources/examples/cfengine_process_management.md b/docs/sources/examples/cfengine_process_management.md new file mode 100644 index 0000000000..45d6edcec4 --- /dev/null +++ b/docs/sources/examples/cfengine_process_management.md @@ -0,0 +1,152 @@ +page_title: Process Management with CFEngine +page_description: Managing containerized processes with CFEngine +page_keywords: cfengine, process, management, usage, docker, documentation + +# Process Management with CFEngine + +Create Docker containers with managed processes. + +Docker monitors one process in each running container and the container +lives or dies with that process. By introducing CFEngine inside Docker +containers, we can alleviate a few of the issues that may arise: + +- It is possible to easily start multiple processes within a + container, all of which will be managed automatically, with the + normal `docker run` command. +- If a managed process dies or crashes, CFEngine will start it again + within 1 minute. +- The container itself will live as long as the CFEngine scheduling + daemon (cf-execd) lives. With CFEngine, we are able to decouple the + life of the container from the uptime of the service it provides. + +## How it works + +CFEngine, together with the cfe-docker integration policies, are +installed as part of the Dockerfile. This builds CFEngine into our +Docker image. + +The Dockerfile’s `ENTRYPOINT` takes an arbitrary +amount of commands (with any desired arguments) as parameters. When we +run the Docker container these parameters get written to CFEngine +policies and CFEngine takes over to ensure that the desired processes +are running in the container. + +CFEngine scans the process table for the `basename` +of the commands given to the `ENTRYPOINT` and runs +the command to start the process if the `basename` +is not found. For example, if we start the container with +`docker run "/path/to/my/application parameters"`, +CFEngine will look for a process named `application` +and run the command. If an entry for `application` +is not found in the process table at any point in time, CFEngine will +execute `/path/to/my/application parameters` to +start the application once again. The check on the process table happens +every minute. + +Note that it is therefore important that the command to start your +application leaves a process with the basename of the command. This can +be made more flexible by making some minor adjustments to the CFEngine +policies, if desired. + +## Usage + +This example assumes you have Docker installed and working. We will +install and manage `apache2` and `sshd` +in a single container. + +There are three steps: + +1. Install CFEngine into the container. +2. Copy the CFEngine Docker process management policy into the + containerized CFEngine installation. +3. Start your application processes as part of the + `docker run` command. + +### Building the container image + +The first two steps can be done as part of a Dockerfile, as follows. + + FROM ubuntu + MAINTAINER Eystein Måløy Stenberg + + RUN apt-get -y install wget lsb-release unzip ca-certificates + + # install latest CFEngine + RUN wget -qO- http://cfengine.com/pub/gpg.key | apt-key add - + RUN echo "deb http://cfengine.com/pub/apt $(lsb_release -cs) main" > /etc/apt/sources.list.d/cfengine-community.list + RUN apt-get update + RUN apt-get install cfengine-community + + # install cfe-docker process management policy + RUN wget https://github.com/estenberg/cfe-docker/archive/master.zip -P /tmp/ && unzip /tmp/master.zip -d /tmp/ + RUN cp /tmp/cfe-docker-master/cfengine/bin/* /var/cfengine/bin/ + RUN cp /tmp/cfe-docker-master/cfengine/inputs/* /var/cfengine/inputs/ + RUN rm -rf /tmp/cfe-docker-master /tmp/master.zip + + # apache2 and openssh are just for testing purposes, install your own apps here + RUN apt-get -y install openssh-server apache2 + RUN mkdir -p /var/run/sshd + RUN echo "root:password" | chpasswd # need a password for ssh + + ENTRYPOINT ["/var/cfengine/bin/docker_processes_run.sh"] + +By saving this file as `Dockerfile` to a working +directory, you can then build your container with the docker build +command, e.g. `docker build -t managed_image`. + +### Testing the container + +Start the container with `apache2` and +`sshd` running and managed, forwarding a port to our +SSH instance: + + docker run -p 127.0.0.1:222:22 -d managed_image "/usr/sbin/sshd" "/etc/init.d/apache2 start" + +We now clearly see one of the benefits of the cfe-docker integration: it +allows to start several processes as part of a normal +`docker run` command. + +We can now log in to our new container and see that both +`apache2` and `sshd` are +running. We have set the root password to "password" in the Dockerfile +above and can use that to log in with ssh: + + ssh -p222 root@127.0.0.1 + + ps -ef + UID PID PPID C STIME TTY TIME CMD + root 1 0 0 07:48 ? 00:00:00 /bin/bash /var/cfengine/bin/docker_processes_run.sh /usr/sbin/sshd /etc/init.d/apache2 start + root 18 1 0 07:48 ? 00:00:00 /var/cfengine/bin/cf-execd -F + root 20 1 0 07:48 ? 00:00:00 /usr/sbin/sshd + root 32 1 0 07:48 ? 00:00:00 /usr/sbin/apache2 -k start + www-data 34 32 0 07:48 ? 00:00:00 /usr/sbin/apache2 -k start + www-data 35 32 0 07:48 ? 00:00:00 /usr/sbin/apache2 -k start + www-data 36 32 0 07:48 ? 00:00:00 /usr/sbin/apache2 -k start + root 93 20 0 07:48 ? 00:00:00 sshd: root@pts/0 + root 105 93 0 07:48 pts/0 00:00:00 -bash + root 112 105 0 07:49 pts/0 00:00:00 ps -ef + +If we stop apache2, it will be started again within a minute by +CFEngine. + + service apache2 status + Apache2 is running (pid 32). + service apache2 stop + * Stopping web server apache2 ... waiting [ OK ] + service apache2 status + Apache2 is NOT running. + # ... wait up to 1 minute... + service apache2 status + Apache2 is running (pid 173). + +## Adapting to your applications + +To make sure your applications get managed in the same manner, there are +just two things you need to adjust from the above example: + +- In the Dockerfile used above, install your applications instead of + `apache2` and `sshd`. +- When you start the container with `docker run`, + specify the command line arguments to your applications rather than + `apache2` and `sshd`. + diff --git a/docs/sources/examples/couchdb_data_volumes.md b/docs/sources/examples/couchdb_data_volumes.md new file mode 100644 index 0000000000..1b18cf0aa7 --- /dev/null +++ b/docs/sources/examples/couchdb_data_volumes.md @@ -0,0 +1,48 @@ +page_title: Sharing data between 2 couchdb databases +page_description: Sharing data between 2 couchdb databases +page_keywords: docker, example, package installation, networking, couchdb, data volumes + +# CouchDB Service + +> **Note**: +> +> - This example assumes you have Docker running in daemon mode. For +> more information please see [*Check your Docker +> install*](../hello_world/#running-examples). +> - **If you don’t like sudo** then see [*Giving non-root +> access*](../../installation/binaries/#dockergroup) + +Here’s an example of using data volumes to share the same data between +two CouchDB containers. This could be used for hot upgrades, testing +different versions of CouchDB on the same data, etc. + +## Create first database + +Note that we’re marking `/var/lib/couchdb` as a data +volume. + + COUCH1=$(sudo docker run -d -p 5984 -v /var/lib/couchdb shykes/couchdb:2013-05-03) + +## Add data to the first database + +We’re assuming your Docker host is reachable at `localhost`. If not, +replace `localhost` with the public IP of your Docker host. + + HOST=localhost + URL="http://$HOST:$(sudo docker port $COUCH1 5984 | grep -Po '\d+$')/_utils/" + echo "Navigate to $URL in your browser, and use the couch interface to add data" + +## Create second database + +This time, we’re requesting shared access to `$COUCH1`'s volumes. + + COUCH2=$(sudo docker run -d -p 5984 --volumes-from $COUCH1 shykes/couchdb:2013-05-03) + +## Browse data on the second database + + HOST=localhost + URL="http://$HOST:$(sudo docker port $COUCH2 5984 | grep -Po '\d+$')/_utils/" + echo "Navigate to $URL in your browser. You should see the same data as in the first database"'!' + +Congratulations, you are now running two Couchdb containers, completely +isolated from each other *except* for their data. diff --git a/docs/sources/examples/hello_world.md b/docs/sources/examples/hello_world.md new file mode 100644 index 0000000000..062d5d37b3 --- /dev/null +++ b/docs/sources/examples/hello_world.md @@ -0,0 +1,166 @@ +page_title: Hello world example +page_description: A simple hello world example with Docker +page_keywords: docker, example, hello world + +# Check your Docker installation + +This guide assumes you have a working installation of Docker. To check +your Docker install, run the following command: + + # Check that you have a working install + $ sudo docker info + +If you get `docker: command not found` or something +like `/var/lib/docker/repositories: permission denied` +you may have an incomplete Docker installation or insufficient +privileges to access docker on your machine. + +Please refer to [*Installation*](../../installation/) +for installation instructions. + +## Hello World + +> **Note**: +> +> - This example assumes you have Docker running in daemon mode. For +> more information please see [*Check your Docker +> install*](#check-your-docker-installation). +> - **If you don’t like sudo** then see [*Giving non-root +> access*](../../installation/binaries/#dockergroup) + +This is the most basic example available for using Docker. + +Download the small base image named `busybox`: + + # Download a busybox image + $ sudo docker pull busybox + +The `busybox` image is a minimal Linux system. You +can do the same with any number of other images, such as +`debian`, `ubuntu` or +`centos`. The images can be found and retrieved +using the [Docker index](http://index.docker.io). + + $ sudo docker run busybox /bin/echo hello world + +This command will run a simple `echo` command, that +will echo `hello world` back to the console over +standard out. + +**Explanation:** + +- **"sudo"** execute the following commands as user *root* +- **"docker run"** run a command in a new container +- **"busybox"** is the image we are running the command in. +- **"/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 + + + + + + +## Hello World Daemon + +> **Note**: +> +> - This example assumes you have Docker running in daemon mode. For +> more information please see [*Check your Docker +> install*](#check-your-docker-installation). +> - **If you don’t like sudo** then see [*Giving non-root +> access*](../../installation/binaries/#dockergroup) + +And now for the most boring daemon ever written! + +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:** + + 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. + +- **"sudo 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. + + + + 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. + + + + sudo docker attach --sig-proxy=false $container_id + +Attach to the container to see the results in real-time. + +- **"docker attach**" This will allow us to attach to a background + process to see what is going on. +- **"–sig-proxy=false"** Do not forward signals to the container; + allows us to exit the attachment using Control-C without stopping + the container. +- **$container_id** The Id of the container we want to attach to. + +Exit from the container attachment by pressing Control-C. + + sudo docker ps + +Check the process list to make sure it is running. + +- **"docker ps"** this shows all running process managed by docker + + + + 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. + + + + sudo docker ps + +Make sure it is really stopped. + +**Video:** + +See the example in action + + + + + +The next example in the series is a [*Node.js Web +App*](../nodejs_web_app/#nodejs-web-app) example, or you could skip to +any of the other examples: + +- [*Node.js Web App*](../nodejs_web_app/#nodejs-web-app) +- [*Redis Service*](../running_redis_service/#running-redis-service) +- [*SSH Daemon Service*](../running_ssh_service/#running-ssh-service) +- [*CouchDB + Service*](../couchdb_data_volumes/#running-couchdb-service) +- [*PostgreSQL Service*](../postgresql_service/#postgresql-service) +- [*Building an Image with MongoDB*](../mongodb/#mongodb-image) +- [*Python Web App*](../python_web_app/#python-web-app) + diff --git a/docs/sources/examples/https.md b/docs/sources/examples/https.md new file mode 100644 index 0000000000..153a6c0cf9 --- /dev/null +++ b/docs/sources/examples/https.md @@ -0,0 +1,107 @@ +page_title: Docker HTTPS Setup +page_description: How to setup docker with https +page_keywords: docker, example, https, daemon + +# Running Docker with https + +By default, Docker runs via a non-networked Unix socket. It can also +optionally communicate using a HTTP socket. + +If you need Docker reachable via the network in a safe manner, you can +enable TLS by specifying the tlsverify flag and pointing Docker’s +tlscacert flag to a trusted CA certificate. + +In daemon mode, it will only allow connections from clients +authenticated by a certificate signed by that CA. In client mode, it +will only connect to servers with a certificate signed by that CA. + +> **Warning**: +> Using TLS and managing a CA is an advanced topic. Please make you self +> familiar with openssl, x509 and tls before using it in production. + +## Create a CA, server and client keys with OpenSSL + +First, initialize the CA serial file and generate CA private and public +keys: + + $ echo 01 > ca.srl + $ openssl genrsa -des3 -out ca-key.pem + $ openssl req -new -x509 -days 365 -key ca-key.pem -out ca.pem + +Now that we have a CA, you can create a server key and certificate +signing request. Make sure that "Common Name (e.g. server FQDN or YOUR +name)" matches the hostname you will use to connect to Docker or just +use ‘\*’ for a certificate valid for any hostname: + + $ openssl genrsa -des3 -out server-key.pem + $ openssl req -new -key server-key.pem -out server.csr + +Next we’re going to sign the key with our CA: + + $ openssl x509 -req -days 365 -in server.csr -CA ca.pem -CAkey ca-key.pem \ + -out server-cert.pem + +For client authentication, create a client key and certificate signing +request: + + $ openssl genrsa -des3 -out client-key.pem + $ openssl req -new -key client-key.pem -out client.csr + +To make the key suitable for client authentication, create a extensions +config file: + + $ echo extendedKeyUsage = clientAuth > extfile.cnf + +Now sign the key: + + $ openssl x509 -req -days 365 -in client.csr -CA ca.pem -CAkey ca-key.pem \ + -out client-cert.pem -extfile extfile.cnf + +Finally you need to remove the passphrase from the client and server +key: + + $ openssl rsa -in server-key.pem -out server-key.pem + $ openssl rsa -in client-key.pem -out client-key.pem + +Now you can make the Docker daemon only accept connections from clients +providing a certificate trusted by our CA: + + $ sudo docker -d --tlsverify --tlscacert=ca.pem --tlscert=server-cert.pem --tlskey=server-key.pem \ + -H=0.0.0.0:4243 + +To be able to connect to Docker and validate its certificate, you now +need to provide your client keys, certificates and trusted CA: + + $ docker --tlsverify --tlscacert=ca.pem --tlscert=client-cert.pem --tlskey=client-key.pem \ + -H=dns-name-of-docker-host:4243 + +> **Warning**: +> As shown in the example above, you don’t have to run the +> `docker` client with `sudo` or +> the `docker` group when you use certificate +> authentication. That means anyone with the keys can give any +> instructions to your Docker daemon, giving them root access to the +> machine hosting the daemon. Guard these keys as you would a root +> password! + +## Other modes + +If you don’t want to have complete two-way authentication, you can run +Docker in various other modes by mixing the flags. + +### Daemon modes + +- tlsverify, tlscacert, tlscert, tlskey set: Authenticate clients +- tls, tlscert, tlskey: Do not authenticate clients + +### Client modes + +- tls: Authenticate server based on public/default CA pool +- tlsverify, tlscacert: Authenticate server based on given CA +- tls, tlscert, tlskey: Authenticate with client certificate, do not + authenticate server based on given CA +- tlsverify, tlscacert, tlscert, tlskey: Authenticate with client + certificate, authenticate server based on given CA + +The client will send its client certificate if found, so you just need +to drop your keys into \~/.docker/\.pem diff --git a/docs/sources/examples/mongodb.md b/docs/sources/examples/mongodb.md new file mode 100644 index 0000000000..c9078419d6 --- /dev/null +++ b/docs/sources/examples/mongodb.md @@ -0,0 +1,89 @@ +page_title: Building a Docker Image with MongoDB +page_description: How to build a Docker image with MongoDB pre-installed +page_keywords: docker, example, package installation, networking, mongodb + +# Building an Image with MongoDB + +> **Note**: +> +> - This example assumes you have Docker running in daemon mode. For +> more information please see [*Check your Docker +> install*](../hello_world/#running-examples). +> - **If you don’t like sudo** then see [*Giving non-root +> access*](../../installation/binaries/#dockergroup) + +The goal of this example is to show how you can build your own Docker +images with MongoDB pre-installed. We will do that by constructing a +`Dockerfile` that downloads a base image, adds an +apt source and installs the database software on Ubuntu. + +## Creating a `Dockerfile` + +Create an empty file called `Dockerfile`: + + touch Dockerfile + +Next, define the parent image you want to use to build your own image on +top of. Here, we’ll use [Ubuntu](https://index.docker.io/_/ubuntu/) +(tag: `latest`) available on the [docker +index](http://index.docker.io): + + FROM ubuntu:latest + +Since we want to be running the latest version of MongoDB we’ll need to +add the 10gen repo to our apt sources list. + + # Add 10gen official apt source to the sources list + RUN apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv 7F0CEB10 + RUN echo 'deb http://downloads-distro.mongodb.org/repo/ubuntu-upstart dist 10gen' | tee /etc/apt/sources.list.d/10gen.list + +Then, we don’t want Ubuntu to complain about init not being available so +we’ll divert `/sbin/initctl` to +`/bin/true` so it thinks everything is working. + + # Hack for initctl not being available in Ubuntu + RUN dpkg-divert --local --rename --add /sbin/initctl + RUN ln -s /bin/true /sbin/initctl + +Afterwards we’ll be able to update our apt repositories and install +MongoDB + + # Install MongoDB + RUN apt-get update + RUN apt-get install mongodb-10gen + +To run MongoDB we’ll have to create the default data directory (because +we want it to run without needing to provide a special configuration +file) + + # Create the MongoDB data directory + RUN mkdir -p /data/db + +Finally, we’ll expose the standard port that MongoDB runs on, 27107, as +well as define an `ENTRYPOINT` instruction for the +container. + + EXPOSE 27017 + ENTRYPOINT ["usr/bin/mongod"] + +Now, lets build the image which will go through the +`Dockerfile` we made and run all of the commands. + + sudo docker build -t /mongodb . + +Now you should be able to run `mongod` as a daemon +and be able to connect on the local port! + + # Regular style + MONGO_ID=$(sudo docker run -d /mongodb) + + # Lean and mean + MONGO_ID=$(sudo docker run -d /mongodb --noprealloc --smallfiles) + + # Check the logs out + sudo docker logs $MONGO_ID + + # Connect and play around + mongo --port + +Sweet! diff --git a/docs/sources/examples/nodejs_web_app.md b/docs/sources/examples/nodejs_web_app.md new file mode 100644 index 0000000000..77d75047b6 --- /dev/null +++ b/docs/sources/examples/nodejs_web_app.md @@ -0,0 +1,204 @@ +page_title: Running a Node.js app on CentOS +page_description: Installing and running a Node.js app on CentOS +page_keywords: docker, example, package installation, node, centos + +# Node.js Web App + +> **Note**: +> +> - This example assumes you have Docker running in daemon mode. For +> more information please see [*Check your Docker +> install*](../hello_world/#running-examples). +> - **If you don’t like sudo** then see [*Giving non-root +> access*](../../installation/binaries/#dockergroup) + +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](https://github.com/gasi/docker-node-hello). + +## Create Node.js app + +First, create a directory `src` where all the files +would live. Then create a `package.json` file that +describes your app and its dependencies: + + { + "name": "docker-centos-hello", + "private": true, + "version": "0.0.1", + "description": "Node.js Hello World app on CentOS using docker", + "author": "Daniel Gasienica ", + "dependencies": { + "express": "3.2.4" + } + } + +Then, create an `index.js` file that defines a web +app using the [Express.js](http://expressjs.com/) framework: + + 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`: + + 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): + + # 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](https://index.docker.io/): + + 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](https://github.com/joyent/node/wiki/Installing-Node.js-via-package-manager#rhelcentosscientific-linux-6): + + # 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 + +To bundle your app’s source code inside the Docker image, use the +`ADD` instruction: + + # Bundle app source + ADD . /src + +Install your app dependencies using the `npm` +binary: + + # Install app dependencies + RUN cd /src; npm install + +Your app binds to port `8080` so you’ll use the +`EXPOSE` instruction to have it mapped by the +`docker` daemon: + + 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): + + CMD ["node", "/src/index.js"] + +Your `Dockerfile` should now look like this: + + # 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 + + # 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: + + sudo docker build -t /centos-node-hello . + +Your image will now be listed by Docker: + + sudo 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. The +`-p` flag redirects a public port to a private port +in the container. Run the image you previously built: + + sudo docker run -p 49160:8080 -d /centos-node-hello + +Print the output of your app: + + # Get container ID + sudo docker ps + + # Print app output + sudo docker logs + + > # Example + > Running on http://localhost:8080 + +## Test + +To test your app, get the the port of your app that Docker mapped: + + sudo 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`): + + 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](https://github.com/gasi/docker-node-hello). + +Continue to [*Redis +Service*](../running_redis_service/#running-redis-service). diff --git a/docs/sources/examples/postgresql_service.md b/docs/sources/examples/postgresql_service.md new file mode 100644 index 0000000000..053bf410c0 --- /dev/null +++ b/docs/sources/examples/postgresql_service.md @@ -0,0 +1,155 @@ +page_title: PostgreSQL service How-To +page_description: Running and installing a PostgreSQL service +page_keywords: docker, example, package installation, postgresql + +# PostgreSQL Service + +> **Note**: +> +> - This example assumes you have Docker running in daemon mode. For +> more information please see [*Check your Docker +> install*](../hello_world/#running-examples). +> - **If you don’t like sudo** then see [*Giving non-root +> access*](../../installation/binaries/#dockergroup) + +## Installing PostgreSQL on Docker + +Assuming there is no Docker image that suits your needs in [the +index](http://index.docker.io), you can create one yourself. + +Start by creating a new Dockerfile: + +> **Note**: +> This PostgreSQL setup is for development only purposes. Refer to the +> PostgreSQL documentation to fine-tune these settings so that it is +> suitably secure. + + # + # example Dockerfile for http://docs.docker.io/en/latest/examples/postgresql_service/ + # + + FROM ubuntu + MAINTAINER SvenDowideit@docker.com + + # Add the PostgreSQL PGP key to verify their Debian packages. + # It should be the same key as https://www.postgresql.org/media/keys/ACCC4CF8.asc + RUN apt-key adv --keyserver keyserver.ubuntu.com --recv-keys B97B0AFCAA1A47F044F244A07FCC7D46ACCC4CF8 + + # Add PostgreSQL's repository. It contains the most recent stable release + # of PostgreSQL, ``9.3``. + RUN echo "deb http://apt.postgresql.org/pub/repos/apt/ precise-pgdg main" > /etc/apt/sources.list.d/pgdg.list + + # Update the Ubuntu and PostgreSQL repository indexes + RUN apt-get update + + # Install ``python-software-properties``, ``software-properties-common`` and PostgreSQL 9.3 + # There are some warnings (in red) that show up during the build. You can hide + # them by prefixing each apt-get statement with DEBIAN_FRONTEND=noninteractive + RUN apt-get -y -q install python-software-properties software-properties-common + RUN apt-get -y -q install postgresql-9.3 postgresql-client-9.3 postgresql-contrib-9.3 + + # Note: The official Debian and Ubuntu images automatically ``apt-get clean`` + # after each ``apt-get`` + + # Run the rest of the commands as the ``postgres`` user created by the ``postgres-9.3`` package when it was ``apt-get installed`` + USER postgres + + # Create a PostgreSQL role named ``docker`` with ``docker`` as the password and + # then create a database `docker` owned by the ``docker`` role. + # Note: here we use ``&&\`` to run commands one after the other - the ``\`` + # allows the RUN command to span multiple lines. + RUN /etc/init.d/postgresql start &&\ + psql --command "CREATE USER docker WITH SUPERUSER PASSWORD 'docker';" &&\ + createdb -O docker docker + + # Adjust PostgreSQL configuration so that remote connections to the + # database are possible. + RUN echo "host all all 0.0.0.0/0 md5" >> /etc/postgresql/9.3/main/pg_hba.conf + + # And add ``listen_addresses`` to ``/etc/postgresql/9.3/main/postgresql.conf`` + RUN echo "listen_addresses='*'" >> /etc/postgresql/9.3/main/postgresql.conf + + # Expose the PostgreSQL port + EXPOSE 5432 + + # Add VOLUMEs to allow backup of config, logs and databases + VOLUME ["/etc/postgresql", "/var/log/postgresql", "/var/lib/postgresql"] + + # Set the default command to run when starting the container + CMD ["/usr/lib/postgresql/9.3/bin/postgres", "-D", "/var/lib/postgresql/9.3/main", "-c", "config_file=/etc/postgresql/9.3/main/postgresql.conf"] + +Build an image from the Dockerfile assign it a name. + + $ sudo docker build -t eg_postgresql . + +And run the PostgreSQL server container (in the foreground): + + $ sudo docker run -rm -P -name pg_test eg_postgresql + +There are 2 ways to connect to the PostgreSQL server. We can use [*Link +Containers*](../../use/working_with_links_names/#working-with-links-names), +or we can access it from our host (or the network). + +> **Note**: +> The `-rm` removes the container and its image when +> the container exists successfully. + +### Using container linking + +Containers can be linked to another container’s ports directly using +`-link remote_name:local_alias` in the client’s +`docker run`. This will set a number of environment +variables that can then be used to connect: + + $ sudo docker run -rm -t -i -link pg_test:pg eg_postgresql bash + + postgres@7ef98b1b7243:/$ psql -h $PG_PORT_5432_TCP_ADDR -p $PG_PORT_5432_TCP_PORT -d docker -U docker --password + +### Connecting from your host system + +Assuming you have the postgresql-client installed, you can use the +host-mapped port to test as well. You need to use `docker ps` +to find out what local host port the container is mapped to +first: + + $ docker ps + CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES + 5e24362f27f6 eg_postgresql:latest /usr/lib/postgresql/ About an hour ago Up About an hour 0.0.0.0:49153->5432/tcp pg_test + $ psql -h localhost -p 49153 -d docker -U docker --password + +### Testing the database + +Once you have authenticated and have a `docker =#` +prompt, you can create a table and populate it. + + psql (9.3.1) + Type "help" for help. + + docker=# CREATE TABLE cities ( + docker(# name varchar(80), + docker(# location point + docker(# ); + CREATE TABLE + docker=# INSERT INTO cities VALUES ('San Francisco', '(-194.0, 53.0)'); + INSERT 0 1 + docker=# select * from cities; + name | location + ---------------+----------- + San Francisco | (-194,53) + (1 row) + +### Using the container volumes + +You can use the defined volumes to inspect the PostgreSQL log files and +to backup your configuration and data: + + docker run -rm --volumes-from pg_test -t -i busybox sh + + / # ls + bin etc lib linuxrc mnt proc run sys usr + dev home lib64 media opt root sbin tmp var + / # ls /etc/postgresql/9.3/main/ + environment pg_hba.conf postgresql.conf + pg_ctl.conf pg_ident.conf start.conf + /tmp # ls /var/log + ldconfig postgresql diff --git a/docs/sources/examples/python_web_app.md b/docs/sources/examples/python_web_app.md new file mode 100644 index 0000000000..2212f97139 --- /dev/null +++ b/docs/sources/examples/python_web_app.md @@ -0,0 +1,127 @@ +page_title: Python Web app example +page_description: Building your own python web app using docker +page_keywords: docker, example, python, web app + +# Python Web App + +> **Note**: +> +> - This example assumes you have Docker running in daemon mode. For +> more information please see [*Check your Docker +> install*](../hello_world/#running-examples). +> - **If you don’t like sudo** then see [*Giving non-root +> access*](../../installation/binaries/#dockergroup) + +While using Dockerfiles is the preferred way to create maintainable and +repeatable images, its useful to know how you can try things out and +then commit your live changes to an image. + +The goal of this example is to show you how you can modify your own +Docker images by making changes to a running container, and then saving +the results as a new image. We will do that by making a simple ‘hello +world’ Flask web application image. + +## Download the initial image + +Download the `shykes/pybuilder` Docker image from +the `http://index.docker.io` registry. + +This image contains a `buildapp` script to download +the web app and then `pip install` any required +modules, and a `runapp` script that finds the +`app.py` and runs it. + + $ sudo docker pull shykes/pybuilder + +> **Note**: +> This container was built with a very old version of docker (May 2013 - +> see [shykes/pybuilder](https://github.com/shykes/pybuilder) ), when the +> `Dockerfile` format was different, but the image can +> still be used now. + +## Interactively make some modifications + +We then start a new container running interactively using the image. +First, we set a `URL` variable that points to a +tarball of a simple helloflask web app, and then we run a command +contained in the image called `buildapp`, passing it +the `$URL` variable. The container is given a name +`pybuilder_run` which we will use in the next steps. + +While this example is simple, you could run any number of interactive +commands, try things out, and then exit when you’re done. + + $ sudo docker run -i -t -name pybuilder_run shykes/pybuilder bash + + $$ URL=http://github.com/shykes/helloflask/archive/master.tar.gz + $$ /usr/local/bin/buildapp $URL + [...] + $$ exit + +## Commit the container to create a new image + +Save the changes we just made in the container to a new image called +`/builds/github.com/shykes/helloflask/master`. You +now have 3 different ways to refer to the container: name +`pybuilder_run`, short-id `c8b2e8228f11`, or long-id +`c8b2e8228f11b8b3e492cbf9a49923ae66496230056d61e07880dc74c5f495f9`. + + $ sudo docker commit pybuilder_run /builds/github.com/shykes/helloflask/master + c8b2e8228f11b8b3e492cbf9a49923ae66496230056d61e07880dc74c5f495f9 + +## Run the new image to start the web worker + +Use the new image to create a new container with network port 5000 +mapped to a local port + + $ sudo docker run -d -p 5000 --name web_worker /builds/github.com/shykes/helloflask/master /usr/local/bin/runapp + +- **"docker run -d "** run a command in a new container. We pass "-d" + so it runs as a daemon. +- **"-p 5000"** the web app is going to listen on this port, so it + must be mapped from the container to the host system. +- **/usr/local/bin/runapp** is the command which starts the web app. + +## View the container logs + +View the logs for the new `web_worker` container and +if everything worked as planned you should see the line +`Running on http://0.0.0.0:5000/` in the log output. + +To exit the view without stopping the container, hit Ctrl-C, or open +another terminal and continue with the example while watching the result +in the logs. + + $ sudo docker logs -f web_worker + * Running on http://0.0.0.0:5000/ + +## See the webapp output + +Look up the public-facing port which is NAT-ed. Find the private port +used by the container and store it inside of the `WEB_PORT` +variable. + +Access the web app using the `curl` binary. If +everything worked as planned you should see the line +`Hello world!` inside of your console. + + $ WEB_PORT=$(sudo docker port web_worker 5000 | awk -F: '{ print $2 }') + + # install curl if necessary, then ... + $ curl http://127.0.0.1:$WEB_PORT + Hello world! + +## Clean up example containers and images + + $ sudo docker ps --all + +List `--all` the Docker containers. If this +container had already finished running, it will still be listed here +with a status of ‘Exit 0’. + + $ sudo docker stop web_worker + $ sudo docker rm web_worker pybuilder_run + $ sudo docker rmi /builds/github.com/shykes/helloflask/master shykes/pybuilder:latest + +And now stop the running web worker, and delete the containers, so that +we can then delete the images that we used. diff --git a/docs/sources/examples/running_redis_service.md b/docs/sources/examples/running_redis_service.md new file mode 100644 index 0000000000..b67937fab5 --- /dev/null +++ b/docs/sources/examples/running_redis_service.md @@ -0,0 +1,95 @@ +page_title: Running a Redis service +page_description: Installing and running an redis service +page_keywords: docker, example, package installation, networking, redis + +# Redis Service + +> **Note**: +> +> - This example assumes you have Docker running in daemon mode. For +> more information please see [*Check your Docker +> install*](../hello_world/#running-examples). +> - **If you don’t like sudo** then see [*Giving non-root +> access*](../../installation/binaries/#dockergroup) + +Very simple, no frills, Redis service attached to a web application +using a link. + +## Create a docker container for Redis + +Firstly, we create a `Dockerfile` for our new Redis +image. + + FROM ubuntu:12.10 + RUN apt-get update + RUN apt-get -y install redis-server + EXPOSE 6379 + ENTRYPOINT ["/usr/bin/redis-server"] + +Next we build an image from our `Dockerfile`. +Replace `` with your own user name. + + sudo docker build -t /redis . + +## Run the service + +Use the image we’ve just created and name your container +`redis`. + +Running the service with `-d` runs the container in +detached mode, leaving the container running in the background. + +Importantly, we’re not exposing any ports on our container. Instead +we’re going to use a container link to provide access to our Redis +database. + + sudo docker run --name redis -d /redis + +## Create your web application container + +Next we can create a container for our application. We’re going to use +the `-link` flag to create a link to the +`redis` container we’ve just created with an alias +of `db`. This will create a secure tunnel to the +`redis` container and expose the Redis instance +running inside that container to only this container. + + sudo docker run --link redis:db -i -t ubuntu:12.10 /bin/bash + +Once inside our freshly created container we need to install Redis to +get the `redis-cli` binary to test our connection. + + apt-get update + apt-get -y install redis-server + service redis-server stop + +As we’ve used the `--link redis:db` option, Docker +has created some environment variables in our web application container. + + env | grep DB_ + + # Should return something similar to this with your values + DB_NAME=/violet_wolf/db + DB_PORT_6379_TCP_PORT=6379 + DB_PORT=tcp://172.17.0.33:6379 + DB_PORT_6379_TCP=tcp://172.17.0.33:6379 + DB_PORT_6379_TCP_ADDR=172.17.0.33 + DB_PORT_6379_TCP_PROTO=tcp + +We can see that we’ve got a small list of environment variables prefixed +with `DB`. The `DB` comes from +the link alias specified when we launched the container. Let’s use the +`DB_PORT_6379_TCP_ADDR` variable to connect to our +Redis container. + + redis-cli -h $DB_PORT_6379_TCP_ADDR + redis 172.17.0.33:6379> + redis 172.17.0.33:6379> set docker awesome + OK + redis 172.17.0.33:6379> get docker + "awesome" + redis 172.17.0.33:6379> exit + +We could easily use this or other environment variables in our web +application to make a connection to our `redis` +container. diff --git a/docs/sources/examples/running_riak_service.md b/docs/sources/examples/running_riak_service.md new file mode 100644 index 0000000000..ad0b20a628 --- /dev/null +++ b/docs/sources/examples/running_riak_service.md @@ -0,0 +1,137 @@ +page_title: Running a Riak service +page_description: Build a Docker image with Riak pre-installed +page_keywords: docker, example, package installation, networking, riak + +# Riak Service + +> **Note**: +> +> - This example assumes you have Docker running in daemon mode. For +> more information please see [*Check your Docker +> install*](../hello_world/#running-examples). +> - **If you don’t like sudo** then see [*Giving non-root +> access*](../../installation/binaries/#dockergroup) + +The goal of this example is to show you how to build a Docker image with +Riak pre-installed. + +## Creating a `Dockerfile` + +Create an empty file called `Dockerfile`: + + touch Dockerfile + +Next, define the parent image you want to use to build your image on top +of. We’ll use [Ubuntu](https://index.docker.io/_/ubuntu/) (tag: +`latest`), which is available on the [docker +index](http://index.docker.io): + + # Riak + # + # VERSION 0.1.0 + + # Use the Ubuntu base image provided by dotCloud + FROM ubuntu:latest + MAINTAINER Hector Castro hector@basho.com + +Next, we update the APT cache and apply any updates: + + # Update the APT cache + RUN sed -i.bak 's/main$/main universe/' /etc/apt/sources.list + RUN apt-get update + RUN apt-get upgrade -y + +After that, we install and setup a few dependencies: + +- `curl` is used to download Basho’s APT + repository key +- `lsb-release` helps us derive the Ubuntu release + codename +- `openssh-server` allows us to login to + containers remotely and join Riak nodes to form a cluster +- `supervisor` is used manage the OpenSSH and Riak + processes + + + + # Install and setup project dependencies + RUN apt-get install -y curl lsb-release supervisor openssh-server + + RUN mkdir -p /var/run/sshd + RUN mkdir -p /var/log/supervisor + + RUN locale-gen en_US en_US.UTF-8 + + ADD supervisord.conf /etc/supervisor/conf.d/supervisord.conf + + RUN echo 'root:basho' | chpasswd + +Next, we add Basho’s APT repository: + + RUN curl -s http://apt.basho.com/gpg/basho.apt.key | apt-key add -- + RUN echo "deb http://apt.basho.com $(lsb_release -cs) main" > /etc/apt/sources.list.d/basho.list + RUN apt-get update + +After that, we install Riak and alter a few defaults: + + # Install Riak and prepare it to run + RUN apt-get install -y riak + RUN sed -i.bak 's/127.0.0.1/0.0.0.0/' /etc/riak/app.config + RUN echo "ulimit -n 4096" >> /etc/default/riak + +Almost there. Next, we add a hack to get us by the lack of +`initctl`: + + # Hack for initctl + # See: https://github.com/dotcloud/docker/issues/1024 + RUN dpkg-divert --local --rename --add /sbin/initctl + RUN ln -s /bin/true /sbin/initctl + +Then, we expose the Riak Protocol Buffers and HTTP interfaces, along +with SSH: + + # Expose Riak Protocol Buffers and HTTP interfaces, along with SSH + EXPOSE 8087 8098 22 + +Finally, run `supervisord` so that Riak and OpenSSH +are started: + + CMD ["/usr/bin/supervisord"] + +## Create a `supervisord` configuration file + +Create an empty file called `supervisord.conf`. Make +sure it’s at the same directory level as your `Dockerfile`: + + touch supervisord.conf + +Populate it with the following program definitions: + + [supervisord] + nodaemon=true + + [program:sshd] + command=/usr/sbin/sshd -D + stdout_logfile=/var/log/supervisor/%(program_name)s.log + stderr_logfile=/var/log/supervisor/%(program_name)s.log + autorestart=true + + [program:riak] + command=bash -c ". /etc/default/riak && /usr/sbin/riak console" + pidfile=/var/log/riak/riak.pid + stdout_logfile=/var/log/supervisor/%(program_name)s.log + stderr_logfile=/var/log/supervisor/%(program_name)s.log + +## Build the Docker image for Riak + +Now you should be able to build a Docker image for Riak: + + docker build -t "/riak" . + +## Next steps + +Riak is a distributed database. Many production deployments consist of +[at least five +nodes](http://basho.com/why-your-riak-cluster-should-have-at-least-five-nodes/). +See the [docker-riak](https://github.com/hectcastro/docker-riak) project +details on how to deploy a Riak cluster using Docker and Pipework. diff --git a/docs/sources/examples/running_ssh_service.md b/docs/sources/examples/running_ssh_service.md new file mode 100644 index 0000000000..112b9fa441 --- /dev/null +++ b/docs/sources/examples/running_ssh_service.md @@ -0,0 +1,60 @@ +page_title: Running an SSH service +page_description: Installing and running an sshd service +page_keywords: docker, example, package installation, networking + +# SSH Daemon Service + +> **Note:** +> - This example assumes you have Docker running in daemon mode. For +> more information please see [*Check your Docker +> install*](../hello_world/#running-examples). +> - **If you don’t like sudo** then see [*Giving non-root +> access*](../../installation/binaries/#dockergroup) + +The following Dockerfile sets up an sshd service in a container that you +can use to connect to and inspect other container’s volumes, or to get +quick access to a test container. + + # sshd + # + # VERSION 0.0.1 + + FROM ubuntu + MAINTAINER Thatcher R. Peskens "thatcher@dotcloud.com" + + # make sure the package repository is up to date + RUN echo "deb http://archive.ubuntu.com/ubuntu precise main universe" > /etc/apt/sources.list + RUN apt-get update + + RUN apt-get install -y openssh-server + RUN mkdir /var/run/sshd + RUN echo 'root:screencast' |chpasswd + + EXPOSE 22 + CMD /usr/sbin/sshd -D + +Build the image using: + + $ sudo docker build -rm -t eg_sshd . + +Then run it. You can then use `docker port` to find +out what host port the container’s port 22 is mapped to: + + $ sudo docker run -d -P -name test_sshd eg_sshd + $ sudo docker port test_sshd 22 + 0.0.0.0:49154 + +And now you can ssh to port `49154` on the Docker +daemon’s host IP address (`ip address` or +`ifconfig` can tell you that): + + $ ssh root@192.168.1.2 -p 49154 + # The password is ``screencast``. + $$ + +Finally, clean up after your test by stopping and removing the +container, and then removing the image. + + $ sudo docker stop test_sshd + $ sudo docker rm test_sshd + $ sudo docker rmi eg_sshd diff --git a/docs/sources/examples/using_supervisord.md b/docs/sources/examples/using_supervisord.md new file mode 100644 index 0000000000..3a0793710f --- /dev/null +++ b/docs/sources/examples/using_supervisord.md @@ -0,0 +1,121 @@ +page_title: Using Supervisor with Docker +page_description: How to use Supervisor process management with Docker +page_keywords: docker, supervisor, process management + +# Using Supervisor with Docker + +> **Note**: +> +> - This example assumes you have Docker running in daemon mode. For +> more information please see [*Check your Docker +> install*](../hello_world/#running-examples). +> - **If you don’t like sudo** then see [*Giving non-root +> access*](../../installation/binaries/#dockergroup) + +Traditionally a Docker container runs a single process when it is +launched, for example an Apache daemon or a SSH server daemon. Often +though you want to run more than one process in a container. There are a +number of ways you can achieve this ranging from using a simple Bash +script as the value of your container’s `CMD` +instruction to installing a process management tool. + +In this example we’re going to make use of the process management tool, +[Supervisor](http://supervisord.org/), to manage multiple processes in +our container. Using Supervisor allows us to better control, manage, and +restart the processes we want to run. To demonstrate this we’re going to +install and manage both an SSH daemon and an Apache daemon. + +## Creating a Dockerfile + +Let’s start by creating a basic `Dockerfile` for our +new image. + + FROM ubuntu:latest + MAINTAINER examples@docker.io + RUN echo "deb http://archive.ubuntu.com/ubuntu precise main universe" > /etc/apt/sources.list + RUN apt-get update + RUN apt-get upgrade -y + +## Installing Supervisor + +We can now install our SSH and Apache daemons as well as Supervisor in +our container. + + RUN apt-get install -y openssh-server apache2 supervisor + RUN mkdir -p /var/run/sshd + RUN mkdir -p /var/log/supervisor + +Here we’re installing the `openssh-server`, +`apache2` and `supervisor` +(which provides the Supervisor daemon) packages. We’re also creating two +new directories that are needed to run our SSH daemon and Supervisor. + +## Adding Supervisor’s configuration file + +Now let’s add a configuration file for Supervisor. The default file is +called `supervisord.conf` and is located in +`/etc/supervisor/conf.d/`. + + ADD supervisord.conf /etc/supervisor/conf.d/supervisord.conf + +Let’s see what is inside our `supervisord.conf` +file. + + [supervisord] + nodaemon=true + + [program:sshd] + command=/usr/sbin/sshd -D + + [program:apache2] + command=/bin/bash -c "source /etc/apache2/envvars && exec /usr/sbin/apache2 -DFOREGROUND" + +The `supervisord.conf` configuration file contains +directives that configure Supervisor and the processes it manages. The +first block `[supervisord]` provides configuration +for Supervisor itself. We’re using one directive, `nodaemon` +which tells Supervisor to run interactively rather than +daemonize. + +The next two blocks manage the services we wish to control. Each block +controls a separate process. The blocks contain a single directive, +`command`, which specifies what command to run to +start each process. + +## Exposing ports and running Supervisor + +Now let’s finish our `Dockerfile` by exposing some +required ports and specifying the `CMD` instruction +to start Supervisor when our container launches. + + EXPOSE 22 80 + CMD ["/usr/bin/supervisord"] + +Here we’ve exposed ports 22 and 80 on the container and we’re running +the `/usr/bin/supervisord` binary when the container +launches. + +## Building our container + +We can now build our new container. + + sudo docker build -t /supervisord . + +## Running our Supervisor container + +Once we’ve got a built image we can launch a container from it. + + sudo docker run -p 22 -p 80 -t -i /supervisord + 2013-11-25 18:53:22,312 CRIT Supervisor running as root (no user in config file) + 2013-11-25 18:53:22,312 WARN Included extra file "/etc/supervisor/conf.d/supervisord.conf" during parsing + 2013-11-25 18:53:22,342 INFO supervisord started with pid 1 + 2013-11-25 18:53:23,346 INFO spawned: 'sshd' with pid 6 + 2013-11-25 18:53:23,349 INFO spawned: 'apache2' with pid 7 + . . . + +We’ve launched a new container interactively using the +`docker run` command. That container has run +Supervisor and launched the SSH and Apache daemons with it. We’ve +specified the `-p` flag to expose ports 22 and 80. +From here we can now identify the exposed ports and connect to one or +both of the SSH and Apache daemons. diff --git a/docs/sources/faq.md b/docs/sources/faq.md new file mode 100644 index 0000000000..563e07a1c7 --- /dev/null +++ b/docs/sources/faq.md @@ -0,0 +1,218 @@ +page_title: FAQ +page_description: Most frequently asked questions. +page_keywords: faq, questions, documentation, docker + +# FAQ + +## Most frequently asked questions. + +### How much does Docker cost? + +> Docker is 100% free, it is open source, so you can use it without +> paying. + +### 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](https://github.com/dotcloud/docker/blob/master/LICENSE) + +### 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 [*Mac OS +> X*](../installation/mac/#macosx) and [*Microsoft +> Windows*](../installation/windows/#windows) installation guides. The +> small Linux distribution boot2docker can be run inside virtual +> machines on these two operating systems. + +### 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. + +### What does Docker add to just plain LXC? + +> Docker is not a replacement for LXC. "LXC" refers to capabilities of +> the Linux kernel (specifically namespaces and control groups) which +> allow sandboxing processes from one another, and controlling their +> resource allocations. On top of this low-level foundation of kernel +> features, Docker offers a high-level tool with several powerful +> functionalities: +> +> - *Portable deployment across machines.* +> : Docker defines a format for bundling an application and all +> its dependencies into a single object which can be transferred +> to any Docker-enabled machine, and executed there with the +> guarantee that the execution environment exposed to the +> application will be the same. LXC implements process +> sandboxing, which is an important pre-requisite for portable +> deployment, but that alone is not enough for portable +> deployment. If you sent me a copy of your application +> installed in a custom LXC configuration, it would almost +> certainly not run on my machine the way it does on yours, +> because it is tied to your machine’s specific configuration: +> networking, storage, logging, distro, etc. Docker defines an +> abstraction for these machine-specific settings, so that the +> exact same Docker container can run - unchanged - on many +> different machines, with many different configurations. +> +> - *Application-centric.* +> : Docker is optimized for the deployment of applications, as +> opposed to machines. This is reflected in its API, user +> interface, design philosophy and documentation. By contrast, +> the `lxc` helper scripts focus on +> containers as lightweight machines - basically servers that +> boot faster and need less RAM. We think there’s more to +> containers than just that. +> +> - *Automatic build.* +> : Docker includes [*a tool for developers to automatically +> assemble a container from their source +> code*](../reference/builder/#dockerbuilder), with full control +> over application dependencies, build tools, packaging etc. +> They are free to use +> `make, maven, chef, puppet, salt,` Debian +> packages, RPMs, source tarballs, or any combination of the +> above, regardless of the configuration of the machines. +> +> - *Versioning.* +> : Docker includes git-like capabilities for tracking successive +> versions of a container, inspecting the diff between versions, +> committing new versions, rolling back etc. The history also +> includes how a container was assembled and by whom, so you get +> full traceability from the production server all the way back +> to the upstream developer. Docker also implements incremental +> uploads and downloads, similar to `git pull` +> , so new versions of a container can be transferred +> by only sending diffs. +> +> - *Component re-use.* +> : Any container can be used as a [*"base +> image"*](../terms/image/#base-image-def) to create more +> specialized components. This can be done manually or as part +> of an automated build. For example you can prepare the ideal +> Python environment, and use it as a base for 10 different +> applications. Your ideal Postgresql setup can be re-used for +> all your future projects. And so on. +> +> - *Sharing.* +> : Docker has access to a [public +> registry](http://index.docker.io) where thousands of people +> have uploaded useful containers: anything from Redis, CouchDB, +> Postgres to IRC bouncers to Rails app servers to Hadoop to +> base images for various Linux distros. The +> [*registry*](../reference/api/registry_index_spec/#registryindexspec) +> also includes an official "standard library" of useful +> containers maintained by the Docker team. The registry itself +> is open-source, so anyone can deploy their own registry to +> store and transfer private containers, for internal server +> deployments for example. +> +> - *Tool ecosystem.* +> : Docker defines an API for automating and customizing the +> creation and deployment of containers. There are a huge number +> of tools integrating with Docker to extend its capabilities. +> PaaS-like deployment (Dokku, Deis, Flynn), multi-node +> orchestration (Maestro, Salt, Mesos, Openstack Nova), +> management dashboards (docker-ui, Openstack Horizon, +> Shipyard), configuration management (Chef, Puppet), continuous +> integration (Jenkins, Strider, Travis), etc. Docker is rapidly +> establishing itself as the standard for container-based +> tooling. +> +### What is different between a Docker container and a VM? + +There’s a great StackOverflow answer [showing the +differences](http://stackoverflow.com/questions/16047306/how-is-docker-io-different-from-a-normal-virtual-machine). + +### Do I lose my data when the container exits? + +Not at all! Any data that your application writes to disk gets preserved +in its container until you explicitly delete the container. The file +system for the container persists even after the container halts. + +### How far do Docker containers scale? + +Some of the largest server farms in the world today are based on +containers. Large web deployments like Google and Twitter, and platform +providers such as Heroku and dotCloud all run on container technology, +at a scale of hundreds of thousands or even millions of containers +running in parallel. + +### How do I connect Docker containers? + +Currently the recommended way to link containers is via the link +primitive. You can see details of how to [work with links +here](http://docs.docker.io/en/latest/use/working_with_links_names/). + +Also of useful when enabling more flexible service portability is the +[Ambassador linking +pattern](http://docs.docker.io/en/latest/use/ambassador_pattern_linking/). + +### How do I run more than one process in a Docker container? + +Any capable process supervisor such as +[http://supervisord.org/](http://supervisord.org/), runit, s6, or +daemontools can do the trick. Docker will start up the process +management daemon which will then fork to run additional processes. As +long as the processor manager daemon continues to run, the container +will continue to as well. You can see a more substantial example [that +uses supervisord +here](http://docs.docker.io/en/latest/examples/using_supervisord/). + +### What platforms does Docker run on? + +Linux: + +- Ubuntu 12.04, 13.04 et al +- Fedora 19/20+ +- RHEL 6.5+ +- Centos 6+ +- Gentoo +- ArchLinux +- openSUSE 12.3+ +- CRUX 3.0+ + +Cloud: + +- Amazon EC2 +- Google Compute Engine +- Rackspace + +### How do I report a security issue with Docker? + +You can learn about the project’s security policy +[here](http://www.docker.io/security/) and report security issues to +this [mailbox](mailto:security%40docker.com). + +### Why do I need to sign my commits to Docker with the DCO? + +Please read [our blog +post](http://blog.docker.io/2014/01/docker-code-contributions-require-developer-certificate-of-origin/) +on the introduction of the DCO. + +### Can I help by adding some questions and answers? + +Definitely! You can fork [the +repo](http://www.github.com/dotcloud/docker) and edit the documentation +sources. + +### Where can I find more answers? + +You can find more answers on: + +- [Docker user + mailinglist](https://groups.google.com/d/forum/docker-user) +- [Docker developer + mailinglist](https://groups.google.com/d/forum/docker-dev) +- [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/docker) + +Looking for something else to read? Checkout the [*Hello +World*](../examples/hello_world/#hello-world) example. diff --git a/docs/sources/genindex.md b/docs/sources/genindex.md new file mode 100644 index 0000000000..8b013d6a6b --- /dev/null +++ b/docs/sources/genindex.md @@ -0,0 +1 @@ +# Index diff --git a/docs/sources/http-routingtable.md b/docs/sources/http-routingtable.md new file mode 100644 index 0000000000..9fd78d03b5 --- /dev/null +++ b/docs/sources/http-routingtable.md @@ -0,0 +1,104 @@ +# HTTP Routing Table + +[**/api**](#cap-/api) | [**/auth**](#cap-/auth) | +[**/build**](#cap-/build) | [**/commit**](#cap-/commit) | +[**/containers**](#cap-/containers) | [**/events**](#cap-/events) | +[**/events:**](#cap-/events:) | [**/images**](#cap-/images) | +[**/info**](#cap-/info) | [**/v1**](#cap-/v1) | +[**/version**](#cap-/version) + + -- -------------------------------------------------------------------------------------------------------------------------------------------------------------------- ---- +   + **/api** + [`GET /api/v1.1/o/authorize/`](../reference/api/docker_io_oauth_api/#get--api-v1.1-o-authorize-) ** + [`POST /api/v1.1/o/token/`](../reference/api/docker_io_oauth_api/#post--api-v1.1-o-token-) ** + [`GET /api/v1.1/users/:username/`](../reference/api/docker_io_accounts_api/#get--api-v1.1-users--username-) ** + [`PATCH /api/v1.1/users/:username/`](../reference/api/docker_io_accounts_api/#patch--api-v1.1-users--username-) ** + [`GET /api/v1.1/users/:username/emails/`](../reference/api/docker_io_accounts_api/#get--api-v1.1-users--username-emails-) ** + [`PATCH /api/v1.1/users/:username/emails/`](../reference/api/docker_io_accounts_api/#patch--api-v1.1-users--username-emails-) ** + [`POST /api/v1.1/users/:username/emails/`](../reference/api/docker_io_accounts_api/#post--api-v1.1-users--username-emails-) ** + [`DELETE /api/v1.1/users/:username/emails/`](../reference/api/docker_io_accounts_api/#delete--api-v1.1-users--username-emails-) ** +   + **/auth** + [`GET /auth`](../reference/api/docker_remote_api/#get--auth) ** + [`POST /auth`](../reference/api/docker_remote_api_v1.9/#post--auth) ** +   + **/build** + [`POST /build`](../reference/api/docker_remote_api_v1.9/#post--build) ** +   + **/commit** + [`POST /commit`](../reference/api/docker_remote_api_v1.9/#post--commit) ** +   + **/containers** + [`DELETE /containers/(id)`](../reference/api/docker_remote_api_v1.9/#delete--containers-(id)) ** + [`POST /containers/(id)/attach`](../reference/api/docker_remote_api_v1.9/#post--containers-(id)-attach) ** + [`GET /containers/(id)/changes`](../reference/api/docker_remote_api_v1.9/#get--containers-(id)-changes) ** + [`POST /containers/(id)/copy`](../reference/api/docker_remote_api_v1.9/#post--containers-(id)-copy) ** + [`GET /containers/(id)/export`](../reference/api/docker_remote_api_v1.9/#get--containers-(id)-export) ** + [`GET /containers/(id)/json`](../reference/api/docker_remote_api_v1.9/#get--containers-(id)-json) ** + [`POST /containers/(id)/kill`](../reference/api/docker_remote_api_v1.9/#post--containers-(id)-kill) ** + [`POST /containers/(id)/restart`](../reference/api/docker_remote_api_v1.9/#post--containers-(id)-restart) ** + [`POST /containers/(id)/start`](../reference/api/docker_remote_api_v1.9/#post--containers-(id)-start) ** + [`POST /containers/(id)/stop`](../reference/api/docker_remote_api_v1.9/#post--containers-(id)-stop) ** + [`GET /containers/(id)/top`](../reference/api/docker_remote_api_v1.9/#get--containers-(id)-top) ** + [`POST /containers/(id)/wait`](../reference/api/docker_remote_api_v1.9/#post--containers-(id)-wait) ** + [`POST /containers/create`](../reference/api/docker_remote_api_v1.9/#post--containers-create) ** + [`GET /containers/json`](../reference/api/docker_remote_api_v1.9/#get--containers-json) ** +   + **/events** + [`GET /events`](../reference/api/docker_remote_api_v1.9/#get--events) ** +   + **/events:** + [`GET /events:`](../reference/api/docker_remote_api/#get--events-) ** +   + **/images** + [`GET /images/(format)`](../reference/api/archive/docker_remote_api_v1.6/#get--images-(format)) ** + [`DELETE /images/(name)`](../reference/api/docker_remote_api_v1.9/#delete--images-(name)) ** + [`GET /images/(name)/get`](../reference/api/docker_remote_api_v1.9/#get--images-(name)-get) ** + [`GET /images/(name)/history`](../reference/api/docker_remote_api_v1.9/#get--images-(name)-history) ** + [`POST /images/(name)/insert`](../reference/api/docker_remote_api_v1.9/#post--images-(name)-insert) ** + [`GET /images/(name)/json`](../reference/api/docker_remote_api_v1.9/#get--images-(name)-json) ** + [`POST /images/(name)/push`](../reference/api/docker_remote_api_v1.9/#post--images-(name)-push) ** + [`POST /images/(name)/tag`](../reference/api/docker_remote_api_v1.9/#post--images-(name)-tag) ** + [`POST /images//delete`](../reference/api/docker_remote_api/#post--images--name--delete) ** + [`POST /images/create`](../reference/api/docker_remote_api_v1.9/#post--images-create) ** + [`GET /images/json`](../reference/api/docker_remote_api_v1.9/#get--images-json) ** + [`POST /images/load`](../reference/api/docker_remote_api_v1.9/#post--images-load) ** + [`GET /images/search`](../reference/api/docker_remote_api_v1.9/#get--images-search) ** + [`GET /images/viz`](../reference/api/docker_remote_api/#get--images-viz) ** +   + **/info** + [`GET /info`](../reference/api/docker_remote_api_v1.9/#get--info) ** +   + **/v1** + [`GET /v1/_ping`](../reference/api/registry_api/#get--v1-_ping) ** + [`GET /v1/images/(image_id)/ancestry`](../reference/api/registry_api/#get--v1-images-(image_id)-ancestry) ** + [`GET /v1/images/(image_id)/json`](../reference/api/registry_api/#get--v1-images-(image_id)-json) ** + [`PUT /v1/images/(image_id)/json`](../reference/api/registry_api/#put--v1-images-(image_id)-json) ** + [`GET /v1/images/(image_id)/layer`](../reference/api/registry_api/#get--v1-images-(image_id)-layer) ** + [`PUT /v1/images/(image_id)/layer`](../reference/api/registry_api/#put--v1-images-(image_id)-layer) ** + [`PUT /v1/repositories/(namespace)/(repo_name)/`](../reference/api/index_api/#put--v1-repositories-(namespace)-(repo_name)-) ** + [`DELETE /v1/repositories/(namespace)/(repo_name)/`](../reference/api/index_api/#delete--v1-repositories-(namespace)-(repo_name)-) ** + [`PUT /v1/repositories/(namespace)/(repo_name)/auth`](../reference/api/index_api/#put--v1-repositories-(namespace)-(repo_name)-auth) ** + [`GET /v1/repositories/(namespace)/(repo_name)/images`](../reference/api/index_api/#get--v1-repositories-(namespace)-(repo_name)-images) ** + [`PUT /v1/repositories/(namespace)/(repo_name)/images`](../reference/api/index_api/#put--v1-repositories-(namespace)-(repo_name)-images) ** + [`DELETE /v1/repositories/(namespace)/(repository)/`](../reference/api/registry_api/#delete--v1-repositories-(namespace)-(repository)-) ** + [`GET /v1/repositories/(namespace)/(repository)/tags`](../reference/api/registry_api/#get--v1-repositories-(namespace)-(repository)-tags) ** + [`GET /v1/repositories/(namespace)/(repository)/tags/(tag)`](../reference/api/registry_api/#get--v1-repositories-(namespace)-(repository)-tags-(tag)) ** + [`PUT /v1/repositories/(namespace)/(repository)/tags/(tag)`](../reference/api/registry_api/#put--v1-repositories-(namespace)-(repository)-tags-(tag)) ** + [`DELETE /v1/repositories/(namespace)/(repository)/tags/(tag)`](../reference/api/registry_api/#delete--v1-repositories-(namespace)-(repository)-tags-(tag)) ** + [`PUT /v1/repositories/(repo_name)/`](../reference/api/index_api/#put--v1-repositories-(repo_name)-) ** + [`DELETE /v1/repositories/(repo_name)/`](../reference/api/index_api/#delete--v1-repositories-(repo_name)-) ** + [`PUT /v1/repositories/(repo_name)/auth`](../reference/api/index_api/#put--v1-repositories-(repo_name)-auth) ** + [`GET /v1/repositories/(repo_name)/images`](../reference/api/index_api/#get--v1-repositories-(repo_name)-images) ** + [`PUT /v1/repositories/(repo_name)/images`](../reference/api/index_api/#put--v1-repositories-(repo_name)-images) ** + [`GET /v1/search`](../reference/api/index_api/#get--v1-search) ** + [`GET /v1/users`](../reference/api/index_api/#get--v1-users) ** + [`POST /v1/users`](../reference/api/index_api/#post--v1-users) ** + [`PUT /v1/users/(username)/`](../reference/api/index_api/#put--v1-users-(username)-) ** +   + **/version** + [`GET /version`](../reference/api/docker_remote_api_v1.9/#get--version) ** + -- -------------------------------------------------------------------------------------------------------------------------------------------------------------------- ---- + + diff --git a/docs/sources/index.md b/docs/sources/index.md new file mode 100644 index 0000000000..42f3286352 --- /dev/null +++ b/docs/sources/index.md @@ -0,0 +1,82 @@ +page_title: About Docker +page_description: Docker introduction home page +page_keywords: docker, introduction, documentation, about, technology, understanding, Dockerfile + +# About Docker + +*Secure And Portable Containers Made Easy* + +## Introduction + +[**Docker**](http://www.docker.io) is a container based virtualization +framework. Unlike traditional virtualization Docker is fast, lightweight +and easy to use. Docker allows you to create containers holding +all the dependencies for an application. Each container is kept isolated +from any other, and nothing gets shared. + +## Docker highlights + + - **Containers provide sand-boxing:** + Applications run securely without outside access. + - **Docker allows simple portability:** + Containers are directories, they can be zipped and transported. + - **It all works fast:** + Starting a container is a very fast single process. + - **Docker is easy on the system resources (unlike VMs):** + No more than what each application needs. + - **Agnostic in its _essence_:** + Free of framework, language or platform dependencies. + +And most importantly: + + - **Docker reduces complexity:** + Docker accepts commands *in plain English*, e.g. `docker run [..]`. + +## About this guide + +In this introduction we will take you on a tour and show you what +makes Docker tick. + +On the [**first page**](introduction/understanding-docker.md), which is +**_informative_**: + + - You will find information on Docker; + - And discover Docker's features. + - We will also compare Docker to virtual machines; + - And see some common use cases. + +> [Click here to go to Understanding Docker](introduction/understanding-docker.md). + +The [**second page**](introduction/technology.md) has **_technical_** information on: + + - The architecture of Docker; + - The underlying technology, and; + - *How* Docker works. + +> [Click here to go to Understanding the Technology](introduction/technology.md). + +On the [**third page**](introduction/working-with-docker.md) we get **_practical_**. +There you can: + + - Learn about Docker's components (i.e. Containers, Images and the + Dockerfile); + - And get started working with them straight away. + +> [Click here to go to Working with Docker](introduction/working-with-docker.md). + +Finally, on the [**fourth**](introduction/get-docker.md) page, we go **_hands on_** +and see: + + - The installation instructions, and; + - How Docker makes some hard problems much, much easier. + +> [Click here to go to Get Docker](introduction/get-docker.md). + +> **Note**: +> We know how valuable your time is. Therefore, the documentation is prepared +> in a way to allow anyone to start from any section need. Although we strongly +> recommend that you visit [Understanding Docker]( +> introduction/understanding-docker.md) to see how Docker is different, if you +> already have some knowledge and want to quickly get started with Docker, +> don't hesitate to jump to [Working with Docker]( +> introduction/working-with-docker.md). diff --git a/docs/sources/index.rst b/docs/sources/index.rst deleted file mode 100644 index a89349b2bb..0000000000 --- a/docs/sources/index.rst +++ /dev/null @@ -1,29 +0,0 @@ -:title: Docker Documentation -:description: An overview of the Docker Documentation -:keywords: containers, lxc, concepts, explanation - -Introduction ------------- - -Docker is an open-source engine to easily create lightweight, portable, -self-sufficient containers from any application. The same container that a -developer builds and tests on a laptop can run at scale, in production, on -VMs, bare metal, OpenStack clusters, or any major infrastructure provider. - -Common use cases for Docker include: - -- Automating the packaging and deployment of web applications. -- Automated testing and continuous integration/deployment. -- Deploying and scaling databases and backend services in a service-oriented environment. -- Building custom PaaS environments, either from scratch or as an extension of off-the-shelf platforms like OpenShift or Cloud Foundry. - -Please note Docker is currently under heavy development. It should not be used in production (yet). - -For a high-level overview of Docker, please see the `Introduction -`_. When you're ready to start working with -Docker, we have a `quick start `_ -and a more in-depth guide to :ref:`ubuntu_linux` and other -:ref:`installation_list` paths including prebuilt binaries, -Rackspace and Amazon instances. - -Enough reading! :ref:`Try it out! ` diff --git a/docs/sources/index/accounts.md b/docs/sources/index/accounts.md new file mode 100644 index 0000000000..216b0c17ee --- /dev/null +++ b/docs/sources/index/accounts.md @@ -0,0 +1,31 @@ +page_title: Accounts in the Docker Index +page_description: Docker Index accounts +page_keywords: Docker, docker, index, accounts, plans, Dockerfile, Docker.io, docs, documentation + +# Accounts in the Docker Index + +## Docker IO and Docker Index Accounts + +You can `search` for Docker images and `pull` them from the [Docker Index] +(https://index.docker.io) without signing in or even having an account. However, +in order to `push` images, leave comments or to *star* a repository, you are going +to need a [Docker IO](https://www.docker.io) account. + +### Registration for a Docker IO Account + +You can get a Docker IO account by [signing up for one here] +(https://index.docker.io/account/signup/). A valid email address is required to +register, which you will need to verify for account activation. + +### Email activation process + +You need to have at least one verified email address to be able to use your +Docker IO account. If you can't find the validation email, you can request +another by visiting the [Resend Email Confirmation] +(https://index.docker.io/account/resend-email-confirmation/) page. + +### Password reset process + +If you can't access your account for some reason, you can reset your password +from the [*Password Reset*](https://www.docker.io/account/forgot-password/) +page. \ No newline at end of file diff --git a/docs/sources/index/builds.md b/docs/sources/index/builds.md new file mode 100644 index 0000000000..899971c201 --- /dev/null +++ b/docs/sources/index/builds.md @@ -0,0 +1,121 @@ +page_title: Trusted Builds in the Docker Index +page_description: Docker Index Trusted Builds +page_keywords: Docker, docker, index, accounts, plans, Dockerfile, Docker.io, docs, documentation, trusted, builds, trusted builds + +# Trusted Builds in the Docker Index + +## Trusted Builds + +*Trusted Builds* is a special feature allowing you to specify a source +repository with a *Dockerfile* to be built by the Docker build clusters. The +system will clone your repository and build the Dockerfile using the repository +as the context. The resulting image will then be uploaded to the index and +marked as a `Trusted Build`. + +Trusted Builds have a number of advantages. For example, users of *your* Trusted +Build can be certain that the resulting image was built exactly how it claims +to be. + +Furthermore, the Dockerfile will be available to anyone browsing your repository +on the Index. Another advantage of the Trusted Builds feature is the automated +builds. This makes sure that your repository is always up to date. + +### Linking with a GitHub account + +In order to setup a Trusted Build, you need to first link your Docker Index +account with a GitHub one. This will allow the Docker Index to see your +repositories. + +> *Note:* We currently request access for *read* and *write* since the Index +> needs to setup a GitHub service hook. Although nothing else is done with +> your account, this is how GitHub manages permissions, sorry! + +### Creating a Trusted Build + +You can [create a Trusted Build](https://index.docker.io/builds/github/select/) +from any of your public GitHub repositories with a Dockerfile. + +> **Note:** We currently only support public repositories. To have more than +> one Docker image from the same GitHub repository, you will need to set up one +> Trusted Build per Dockerfile, each using a different image name. This rule +> applies to building multiple branches on the same GitHub repository as well. + +### GitHub organizations + +GitHub organizations appear once your membership to that organization is +made public on GitHub. To verify, you can look at the members tab for your +organization on GitHub. + +### GitHub service hooks + +You can follow the below steps to configure the GitHub service hooks for your +Trusted Build: + + + + + + + + + + + + + + + + + + + + + + +
StepScreenshotDescription
1.Login to Github.com, and visit your Repository page. Click on the repository "Settings" link. You will need admin rights to the repository in order to do this. So if you don't have admin rights, you will need to ask someone who does.
2.Service HooksClick on the "Service Hooks" link
3.Find the service hook labeled DockerFind the service hook labeled "Docker" and click on it.
4.Activate Service HooksClick on the "Active" checkbox and then the "Update settings" button, to save changes.
+ +### The Dockerfile and Trusted Builds + +During the build process, we copy the contents of your Dockerfile. We also +add it to the Docker Index for the Docker community to see on the repository +page. + +### README.md + +If you have a `README.md` file in your repository, we will use that as the +repository's full description. + +> **Warning:** +> If you change the full description after a build, it will be +> rewritten the next time the Trusted Build has been built. To make changes, +> modify the README.md from the Git repository. We will look for a README.md +> in the same directory as your Dockerfile. + +### Build triggers + +If you need another way to trigger your Trusted Builds outside of GitHub, you +can setup a build trigger. When you turn on the build trigger for a Trusted +Build, it will give you a URL to which you can send POST requests. This will +trigger the Trusted Build process, which is similar to GitHub webhooks. + +> **Note:** +> You can only trigger one build at a time and no more than one +> every five minutes. If you have a build already pending, or if you already +> recently submitted a build request, those requests *will be ignored*. +> You can find the logs of last 10 triggers on the settings page to verify +> if everything is working correctly. + +### Repository links + +Repository links are a way to associate one Trusted Build with another. If one +gets updated, linking system also triggers a build for the other Trusted Build. +This makes it easy to keep your Trusted Builds up to date. + +To add a link, go to the settings page of a Trusted Build and click on +*Repository Links*. Then enter the name of the repository that you want have +linked. + +> **Warning:** +> You can add more than one repository link, however, you should +> be very careful. Creating a two way relationship between Trusted Builds will +> cause a never ending build loop. diff --git a/docs/sources/index/home.md b/docs/sources/index/home.md new file mode 100644 index 0000000000..1b03df4ab7 --- /dev/null +++ b/docs/sources/index/home.md @@ -0,0 +1,13 @@ +page_title: The Docker Index Help +page_description: The Docker Index help documentation home +page_keywords: Docker, docker, index, accounts, plans, Dockerfile, Docker.io, docs, documentation + +# The Docker Index Help + +## Introduction + +For your questions about the [Docker Index](https://index.docker.io) you can +use [this documentation](docs.md). + +If you can not find something you are looking for, please feel free to +[contact us](https://index.docker.io/help/support/). \ No newline at end of file diff --git a/docs/sources/index/index.md b/docs/sources/index/index.md new file mode 100644 index 0000000000..747b4ee491 --- /dev/null +++ b/docs/sources/index/index.md @@ -0,0 +1,15 @@ +title +: Documentation + +description +: -- todo: change me + +keywords +: todo, docker, documentation, basic, builder + +Use +=== + +Contents: + +{{ site_name }} diff --git a/docs/sources/index/repos.md b/docs/sources/index/repos.md new file mode 100644 index 0000000000..40b270a0b8 --- /dev/null +++ b/docs/sources/index/repos.md @@ -0,0 +1,97 @@ +page_title: Repositories and Images in the Docker Index +page_description: Docker Index repositories +page_keywords: Docker, docker, index, accounts, plans, Dockerfile, Docker.io, docs, documentation + +# Repositories and Images in the Docker Index + +## Searching for repositories and images + +You can `search` for all the publicly available repositories and images using +Docker. If a repository is not public (i.e., private), it won't be listed on +the Index search results. To see repository statuses, you can look at your +[profile page](https://index.docker.io/account/). + +## Repositories + +### Stars + +Stars are a way to show that you like a repository. They are also an easy way +of bookmark your favorites. + +### Comments + +You can interact with other members of the Docker community and maintainers by +leaving comments on repositories. If you find any comments that are not +appropriate, you can flag them for the Index admins' review. + +### Private Docker Repositories + +To work with a private repository on the Docker Index, you will need to add one +via the [Add Repository](https://index.docker.io/account/repositories/add) link. +Once the private repository is created, you can `push` and `pull` images to and +from it using Docker. + +> *Note:* You need to be signed in and have access to work with a private +> repository. + +Private repositories are just like public ones. However, it isn't possible to +browse them or search their content on the public index. They do not get cached +the same way as a public repository either. + +It is possible to give access to a private repository to those whom you +designate (i.e., collaborators) from its settings page. + +From there, you can also switch repository status (*public* to *private*, or +viceversa). You will need to have an available private repository slot open +before you can do such a switch. If you don't have any, you can always upgrade +your [Docker Index plan](https://index.docker.io/plans/). + +### Collaborators and their role + +A collaborator is someone you want to give access to a private repository. Once +designated, they can `push` and `pull`. Although, they will not be allowed to +perform any administrative tasks such as deleting the repository or changing its +status from private to public. + +> **Note:** A collaborator can not add other collaborators. Only the owner of +> the repository has administrative access. + +### Webhooks + +You can configure webhooks on the repository settings page. A webhook is called +only after a successful `push` is made. The webhook calls are HTTP POST requests +with a JSON payload similar to the example shown below. + +> **Note:** For testing, you can try an HTTP request tool like +> [requestb.in](http://requestb.in/). + +*Example webhook JSON payload:* + + { + "push_data":{ + "pushed_at":1385141110, + "images":[ + "imagehash1", + "imagehash2", + "imagehash3" + ], + "pusher":"username" + }, + "repository":{ + "status":"Active", + "description":"my docker repo that does cool things", + "is_trusted":false, + "full_description":"This is my full description", + "repo_url":"https://index.docker.io/u/username/reponame/", + "owner":"username", + "is_official":false, + "is_private":false, + "name":"reponame", + "namespace":"username", + "star_count":1, + "comment_count":1, + "date_created":1370174400, + "dockerfile":"my full dockerfile is listed here", + "repo_name":"username/reponame" + } + } diff --git a/docs/sources/installation.md b/docs/sources/installation.md new file mode 100644 index 0000000000..0ee7b2f903 --- /dev/null +++ b/docs/sources/installation.md @@ -0,0 +1,25 @@ +# Installation + +## Introduction + +There are a number of ways to install Docker, depending on where you +want to run the daemon. The [*Ubuntu*](ubuntulinux/#ubuntu-linux) +installation is the officially-tested version. The community adds more +techniques for installing Docker all the time. + +## Contents: + +- [Ubuntu](ubuntulinux/) +- [Red Hat Enterprise Linux](rhel/) +- [Fedora](fedora/) +- [Arch Linux](archlinux/) +- [CRUX Linux](cruxlinux/) +- [Gentoo](gentoolinux/) +- [openSUSE](openSUSE/) +- [FrugalWare](frugalware/) +- [Mac OS X](mac/) +- [Windows](windows/) +- [Amazon EC2](amazon/) +- [Rackspace Cloud](rackspace/) +- [Google Cloud Platform](google/) +- [Binaries](binaries/) \ No newline at end of file diff --git a/docs/sources/installation/amazon.md b/docs/sources/installation/amazon.md new file mode 100644 index 0000000000..f97c8fde9e --- /dev/null +++ b/docs/sources/installation/amazon.md @@ -0,0 +1,104 @@ +page_title: Installation on Amazon EC2 +page_description: Please note this project is currently under heavy development. It should not be used in production. +page_keywords: amazon ec2, virtualization, cloud, docker, documentation, installation + +# Amazon EC2 + +> **Note**: +> Docker is still under heavy development! We don’t recommend using it in +> production yet, but we’re getting closer with each release. Please see +> our blog post, [Getting to Docker 1.0]( +> http://blog.docker.io/2013/08/getting-to-docker-1-0/) + +There are several ways to install Docker on AWS EC2: + +- [*Amazon QuickStart (Release Candidate - March + 2014)*](#amazon-quickstart-release-candidate-march-2014) or +- [*Amazon QuickStart*](#amazon-quickstart) or +- [*Standard Ubuntu Installation*](#standard-ubuntu-installation) + +**You’ll need an** [AWS account](http://aws.amazon.com/) **first, of +course.** + +## Amazon QuickStart + +1. **Choose an image:** + - Launch the [Create Instance + Wizard](https://console.aws.amazon.com/ec2/v2/home?#LaunchInstanceWizard:) + menu on your AWS Console. + - Click the `Select` button for a 64Bit Ubuntu + image. For example: Ubuntu Server 12.04.3 LTS + - For testing you can use the default (possibly free) + `t1.micro` instance (more info on + [pricing](http://aws.amazon.com/en/ec2/pricing/)). + - Click the `Next: Configure Instance Details` + button at the bottom right. + +2. **Tell CloudInit to install Docker:** + - When you’re on the "Configure Instance Details" step, expand the + "Advanced Details" section. + - Under "User data", select "As text". + - Enter `#include https://get.docker.io` into + the instance *User Data*. + [CloudInit](https://help.ubuntu.com/community/CloudInit) is part + of the Ubuntu image you chose; it will bootstrap Docker by + running the shell script located at this URL. + +3. After a few more standard choices where defaults are probably ok, + your AWS Ubuntu instance with Docker should be running! + +**If this is your first AWS instance, you may need to set up your +Security Group to allow SSH.** By default all incoming ports to your new +instance will be blocked by the AWS Security Group, so you might just +get timeouts when you try to connect. + +Installing with `get.docker.io` (as above) will +create a service named `lxc-docker`. It will also +set up a [*docker group*](../binaries/#dockergroup) and you may want to +add the *ubuntu* user to it so that you don’t have to use +`sudo` for every Docker command. + +Once you’ve got Docker installed, you’re ready to try it out – head on +over to the [*First steps with Docker*](../../use/basics/) or +[*Examples*](../../examples/) section. + +## Amazon QuickStart (Release Candidate - March 2014) + +Amazon just published new Docker-ready AMIs (2014.03 Release Candidate). +Docker packages can now be installed from Amazon’s provided Software +Repository. + +1. **Choose an image:** + - Launch the [Create Instance + Wizard](https://console.aws.amazon.com/ec2/v2/home?#LaunchInstanceWizard:) + menu on your AWS Console. + - Click the `Community AMI` menu option on the + left side + - Search for ‘2014.03’ and select one of the Amazon provided AMI, + for example `amzn-ami-pv-2014.03.rc-0.x86_64-ebs` + - For testing you can use the default (possibly free) + `t1.micro` instance (more info on + [pricing](http://aws.amazon.com/en/ec2/pricing/)). + - Click the `Next: Configure Instance Details` + button at the bottom right. + +2. After a few more standard choices where defaults are probably ok, + your Amazon Linux instance should be running! +3. SSH to your instance to install Docker : + `ssh -i ec2-user@` + +4. Once connected to the instance, type + `sudo yum install -y docker ; sudo service docker start` + to install and start Docker + +## Standard Ubuntu Installation + +If you want a more hands-on installation, then you can follow the +[*Ubuntu*](../ubuntulinux/#ubuntu-linux) instructions installing Docker +on any EC2 instance running Ubuntu. Just follow Step 1 from [*Amazon +QuickStart*](#amazon-quickstart) to pick an image (or use one of your +own) and skip the step with the *User Data*. Then continue with the +[*Ubuntu*](../ubuntulinux/#ubuntu-linux) instructions. + +Continue with the [*Hello +World*](../../examples/hello_world/#hello-world) example. diff --git a/docs/sources/installation/archlinux.md b/docs/sources/installation/archlinux.md new file mode 100644 index 0000000000..3eebdecdc8 --- /dev/null +++ b/docs/sources/installation/archlinux.md @@ -0,0 +1,67 @@ +page_title: Installation on Arch Linux +page_description: Please note this project is currently under heavy development. It should not be used in production. +page_keywords: arch linux, virtualization, docker, documentation, installation + +# Arch Linux + +> **Note**: +> Docker is still under heavy development! We don’t recommend using it in +> production yet, but we’re getting closer with each release. Please see +> our blog post, [Getting to Docker 1.0]( +> http://blog.docker.io/2013/08/getting-to-docker-1-0/) + +> **Note**: +> This is a community contributed installation path. The only ‘official’ +> installation is using the [*Ubuntu*](../ubuntulinux/#ubuntu-linux) +> installation path. This version may be out of date because it depends on +> some binaries to be updated and published + +Installing on Arch Linux can be handled via the package in community: + +- [docker](https://www.archlinux.org/packages/community/x86_64/docker/) + +or the following AUR package: + +- [docker-git](https://aur.archlinux.org/packages/docker-git/) + +The docker package will install the latest tagged version of docker. The +docker-git package will build from the current master branch. + +## Dependencies + +Docker depends on several packages which are specified as dependencies +in the packages. The core dependencies are: + +- bridge-utils +- device-mapper +- iproute2 +- lxc +- sqlite + +## Installation + +For the normal package a simple + + pacman -S docker + +is all that is needed. + +For the AUR package execute: + + yaourt -S docker-git + +The instructions here assume **yaourt** is installed. See [Arch User +Repository](https://wiki.archlinux.org/index.php/Arch_User_Repository#Installing_packages) +for information on building and installing packages from the AUR if you +have not done so before. + +## Starting Docker + +There is a systemd service unit created for docker. To start the docker +service: + + sudo systemctl start docker + +To start on system boot: + + sudo systemctl enable docker diff --git a/docs/sources/installation/binaries.md b/docs/sources/installation/binaries.md new file mode 100644 index 0000000000..b62e2d071b --- /dev/null +++ b/docs/sources/installation/binaries.md @@ -0,0 +1,103 @@ +page_title: Installation from Binaries +page_description: This instruction set is meant for hackers who want to try out Docker on a variety of environments. +page_keywords: binaries, installation, docker, documentation, linux + +# Binaries + +> **Note**: +> Docker is still under heavy development! We don’t recommend using it in +> production yet, but we’re getting closer with each release. Please see +> our blog post, [Getting to Docker 1.0]( +> http://blog.docker.io/2013/08/getting-to-docker-1-0/) + +**This instruction set is meant for hackers who want to try out Docker +on a variety of environments.** + +Before following these directions, you should really check if a packaged +version of Docker is already available for your distribution. We have +packages for many distributions, and more keep showing up all the time! + +## Check runtime dependencies + +To run properly, docker needs the following software to be installed at +runtime: + +- iptables version 1.4 or later +- Git version 1.7 or later +- procps (or similar provider of a "ps" executable) +- XZ Utils 4.9 or later +- a [properly + mounted](https://github.com/tianon/cgroupfs-mount/blob/master/cgroupfs-mount) + cgroupfs hierarchy (having a single, all-encompassing "cgroup" mount + point [is](https://github.com/dotcloud/docker/issues/2683) + [not](https://github.com/dotcloud/docker/issues/3485) + [sufficient](https://github.com/dotcloud/docker/issues/4568)) + +## Check kernel dependencies + +Docker in daemon mode has specific kernel requirements. For details, +check your distribution in [*Installation*](../#installation-list). + +In general, a 3.8 Linux kernel (or higher) is preferred, as some of the +prior versions have known issues that are triggered by Docker. + +Note that Docker also has a client mode, which can run on virtually any +Linux kernel (it even builds on OSX!). + +## Get the docker binary: + + wget https://get.docker.io/builds/Linux/x86_64/docker-latest -O docker + chmod +x docker + +> **Note**: +> If you have trouble downloading the binary, you can also get the smaller +> compressed release file: +> [https://get.docker.io/builds/Linux/x86\_64/docker-latest.tgz]( +> https://get.docker.io/builds/Linux/x86_64/docker-latest.tgz) + +## Run the docker daemon + + # start the docker in daemon mode from the directory you unpacked + sudo ./docker -d & + +## Giving non-root access + +The `docker` daemon always runs as the root user, +and since Docker version 0.5.2, the `docker` daemon +binds to a Unix socket instead of a TCP port. By default that Unix +socket is owned by the user *root*, and so, by default, you can access +it with `sudo`. + +Starting in version 0.5.3, if you (or your Docker installer) create a +Unix group called *docker* and add users to it, then the +`docker` daemon will make the ownership of the Unix +socket read/writable by the *docker* group when the daemon starts. The +`docker` daemon must always run as the root user, +but if you run the `docker` client as a user in the +*docker* group then you don’t need to add `sudo` to +all the client commands. + +> **Warning**: +> The *docker* group (or the group specified with `-G`) is root-equivalent; +> see [*Docker Daemon Attack Surface*]( +> ../../articles/security/#dockersecurity-daemon) details. + +## Upgrades + +To upgrade your manual installation of Docker, first kill the docker +daemon: + + killall docker + +Then follow the regular installation steps. + +## Run your first container! + + # check your docker version + sudo ./docker version + + # run a container and open an interactive shell in the container + sudo ./docker run -i -t ubuntu /bin/bash + +Continue with the [*Hello +World*](../../examples/hello_world/#hello-world) example. diff --git a/docs/sources/installation/binaries.rst b/docs/sources/installation/binaries.rst index c31e19acc4..9fa880b364 100644 --- a/docs/sources/installation/binaries.rst +++ b/docs/sources/installation/binaries.rst @@ -28,6 +28,7 @@ To run properly, docker needs the following software to be installed at runtime: - iptables version 1.4 or later - Git version 1.7 or later +- procps (or similar provider of a "ps" executable) - XZ Utils 4.9 or later - a `properly mounted `_ diff --git a/docs/sources/installation/cruxlinux.md b/docs/sources/installation/cruxlinux.md new file mode 100644 index 0000000000..9bb336a6f5 --- /dev/null +++ b/docs/sources/installation/cruxlinux.md @@ -0,0 +1,93 @@ +page_title: Installation on CRUX Linux +page_description: Docker installation on CRUX Linux. +page_keywords: crux linux, virtualization, Docker, documentation, installation + +# CRUX Linux + +> **Note**: +> Docker is still under heavy development! We don’t recommend using it in +> production yet, but we’re getting closer with each release. Please see +> our blog post, [Getting to Docker 1.0]( +> http://blog.docker.io/2013/08/getting-to-docker-1-0/) + +> **Note**: +> This is a community contributed installation path. The only ‘official’ +> installation is using the [*Ubuntu*](../ubuntulinux/#ubuntu-linux) +> installation path. This version may be out of date because it depends on +> some binaries to be updated and published. + +Installing on CRUX Linux can be handled via the ports from [James +Mills](http://prologic.shortcircuit.net.au/): + +- [docker](https://bitbucket.org/prologic/ports/src/tip/docker/) +- [docker-bin](https://bitbucket.org/prologic/ports/src/tip/docker-bin/) +- [docker-git](https://bitbucket.org/prologic/ports/src/tip/docker-git/) + +The `docker` port will install the latest tagged +version of Docker. The `docker-bin` port will +install the latest tagged versin of Docker from upstream built binaries. +The `docker-git` package will build from the current +master branch. + +## Installation + +For the time being (*until the CRUX Docker port(s) get into the official +contrib repository*) you will need to install [James +Mills’](https://bitbucket.org/prologic/ports) ports repository. You can +do so via: + +Download the `httpup` file to +`/etc/ports/`: + + curl -q -o - http://crux.nu/portdb/?a=getup&q=prologic > /etc/ports/prologic.httpup + +Add `prtdir /usr/ports/prologic` to +`/etc/prt-get.conf`: + + vim /etc/prt-get.conf + + # or: + echo "prtdir /usr/ports/prologic" >> /etc/prt-get.conf + +Update ports and prt-get cache: + + ports -u + prt-get cache + +To install (*and its dependencies*): + + prt-get depinst docker + +Use `docker-bin` for the upstream binary or +`docker-git` to build and install from the master +branch from git. + +## Kernel Requirements + +To have a working **CRUX+Docker** Host you must ensure your Kernel has +the necessary modules enabled for LXC containers to function correctly +and Docker Daemon to work properly. + +Please read the `README.rst`: + + prt-get readme docker + +There is a `test_kernel_config.sh` script in the +above ports which you can use to test your Kernel configuration: + + cd /usr/ports/prologic/docker + ./test_kernel_config.sh /usr/src/linux/.config + +## Starting Docker + +There is a rc script created for Docker. To start the Docker service: + + sudo su - + /etc/rc.d/docker start + +To start on system boot: + +- Edit `/etc/rc.conf` +- Put `docker` into the `SERVICES=(...)` + array after `net`. + diff --git a/docs/sources/installation/fedora.md b/docs/sources/installation/fedora.md new file mode 100644 index 0000000000..0718df032c --- /dev/null +++ b/docs/sources/installation/fedora.md @@ -0,0 +1,64 @@ +page_title: Installation on Fedora +page_description: Please note this project is currently under heavy development. It should not be used in production. +page_keywords: Docker, Docker documentation, Fedora, requirements, virtualbox, vagrant, git, ssh, putty, cygwin, linux + +# Fedora + +> **Note**: +> Docker is still under heavy development! We don’t recommend using it in +> production yet, but we’re getting closer with each release. Please see +> our blog post, [Getting to Docker 1.0]( +> http://blog.docker.io/2013/08/getting-to-docker-1-0/) + +> **Note**: +> This is a community contributed installation path. The only ‘official’ +> installation is using the [*Ubuntu*](../ubuntulinux/#ubuntu-linux) +> installation path. This version may be out of date because it depends on +> some binaries to be updated and published. + +Docker is available in **Fedora 19 and later**. Please note that due to +the current Docker limitations Docker is able to run only on the **64 +bit** architecture. + +## Installation + +The `docker-io` package provides Docker on Fedora. + +If you have the (unrelated) `docker` package installed already, it will +conflict with `docker-io`. There’s a [bug +report](https://bugzilla.redhat.com/show_bug.cgi?id=1043676) filed for +it. To proceed with `docker-io` installation on Fedora 19, please remove +`docker` first. + + sudo yum -y remove docker + +For Fedora 20 and later, the `wmdocker` package will +provide the same functionality as `docker` and will +also not conflict with `docker-io`. + + sudo yum -y install wmdocker + sudo yum -y remove docker + +Install the `docker-io` package which will install +Docker on our host. + + sudo yum -y install docker-io + +To update the `docker-io` package: + + sudo yum -y update docker-io + +Now that it’s installed, let’s start the Docker daemon. + + sudo systemctl start docker + +If we want Docker to start at boot, we should also: + + sudo systemctl enable docker + +Now let’s verify that Docker is working. + + sudo docker run -i -t fedora /bin/bash + +**Done!**, now continue with the [*Hello +World*](../../examples/hello_world/#hello-world) example. diff --git a/docs/sources/installation/frugalware.md b/docs/sources/installation/frugalware.md new file mode 100644 index 0000000000..0e9f9c9f1b --- /dev/null +++ b/docs/sources/installation/frugalware.md @@ -0,0 +1,56 @@ +page_title: Installation on FrugalWare +page_description: Please note this project is currently under heavy development. It should not be used in production. +page_keywords: frugalware linux, virtualization, docker, documentation, installation + +# FrugalWare + +> **Note**: +> Docker is still under heavy development! We don’t recommend using it in +> production yet, but we’re getting closer with each release. Please see +> our blog post, [Getting to Docker 1.0]( +> http://blog.docker.io/2013/08/getting-to-docker-1-0/) + +> **Note**: +> This is a community contributed installation path. The only ‘official’ +> installation is using the [*Ubuntu*](../ubuntulinux/#ubuntu-linux) +> installation path. This version may be out of date because it depends on +> some binaries to be updated and published + +Installing on FrugalWare is handled via the official packages: + +- [lxc-docker i686](http://www.frugalware.org/packages/200141) +- [lxc-docker x86\_64](http://www.frugalware.org/packages/200130) + +The lxc-docker package will install the latest tagged version of Docker. + +## Dependencies + +Docker depends on several packages which are specified as dependencies +in the packages. The core dependencies are: + +- systemd +- lvm2 +- sqlite3 +- libguestfs +- lxc +- iproute2 +- bridge-utils + +## Installation + +A simple + + pacman -S lxc-docker + +is all that is needed. + +## Starting Docker + +There is a systemd service unit created for Docker. To start Docker as +service: + + sudo systemctl start lxc-docker + +To start on system boot: + + sudo systemctl enable lxc-docker diff --git a/docs/sources/installation/gentoolinux.md b/docs/sources/installation/gentoolinux.md new file mode 100644 index 0000000000..87e1c78e84 --- /dev/null +++ b/docs/sources/installation/gentoolinux.md @@ -0,0 +1,78 @@ +page_title: Installation on Gentoo +page_description: Please note this project is currently under heavy development. It should not be used in production. +page_keywords: gentoo linux, virtualization, docker, documentation, installation + +# Gentoo + +> **Note**: +> Docker is still under heavy development! We don’t recommend using it in +> production yet, but we’re getting closer with each release. Please see +> our blog post, [Getting to Docker 1.0]( +> http://blog.docker.io/2013/08/getting-to-docker-1-0/) + +> **Note**: +> This is a community contributed installation path. The only ‘official’ +> installation is using the [*Ubuntu*](../ubuntulinux/#ubuntu-linux) +> installation path. This version may be out of date because it depends on +> some binaries to be updated and published + +Installing Docker on Gentoo Linux can be accomplished using one of two +methods. The first and best way if you’re looking for a stable +experience is to use the official app-emulation/docker package directly +in the portage tree. + +If you’re looking for a `-bin` ebuild, a live +ebuild, or bleeding edge ebuild changes/fixes, the second installation +method is to use the overlay provided at +[https://github.com/tianon/docker-overlay](https://github.com/tianon/docker-overlay) +which can be added using `app-portage/layman`. The +most accurate and up-to-date documentation for properly installing and +using the overlay can be found in [the overlay +README](https://github.com/tianon/docker-overlay/blob/master/README.md#using-this-overlay). + +Note that sometimes there is a disparity between the latest version and +what’s in the overlay, and between the latest version in the overlay and +what’s in the portage tree. Please be patient, and the latest version +should propagate shortly. + +## Installation + +The package should properly pull in all the necessary dependencies and +prompt for all necessary kernel options. The ebuilds for 0.7+ include +use flags to pull in the proper dependencies of the major storage +drivers, with the "device-mapper" use flag being enabled by default, +since that is the simplest installation path. + + sudo emerge -av app-emulation/docker + +If any issues arise from this ebuild or the resulting binary, including +and especially missing kernel configuration flags and/or dependencies, +[open an issue on the docker-overlay +repository](https://github.com/tianon/docker-overlay/issues) or ping +tianon directly in the \#docker IRC channel on the freenode network. + +## Starting Docker + +Ensure that you are running a kernel that includes all the necessary +modules and/or configuration for LXC (and optionally for device-mapper +and/or AUFS, depending on the storage driver you’ve decided to use). + +### OpenRC + +To start the docker daemon: + + sudo /etc/init.d/docker start + +To start on system boot: + + sudo rc-update add docker default + +### systemd + +To start the docker daemon: + + sudo systemctl start docker.service + +To start on system boot: + + sudo systemctl enable docker.service diff --git a/docs/sources/installation/google.md b/docs/sources/installation/google.md new file mode 100644 index 0000000000..611e9bb7bc --- /dev/null +++ b/docs/sources/installation/google.md @@ -0,0 +1,63 @@ +page_title: Installation on Google Cloud Platform +page_description: Please note this project is currently under heavy development. It should not be used in production. +page_keywords: Docker, Docker documentation, installation, google, Google Compute Engine, Google Cloud Platform + +# [Google Cloud Platform](https://cloud.google.com/) + +> **Note**: +> Docker is still under heavy development! We don’t recommend using it in +> production yet, but we’re getting closer with each release. Please see +> our blog post, [Getting to Docker 1.0]( +> http://blog.docker.io/2013/08/getting-to-docker-1-0/) + +## [Compute Engine](https://developers.google.com/compute) QuickStart for [Debian](https://www.debian.org) + +1. Go to [Google Cloud Console](https://cloud.google.com/console) and + create a new Cloud Project with [Compute Engine + enabled](https://developers.google.com/compute/docs/signup). +2. Download and configure the [Google Cloud + SDK](https://developers.google.com/cloud/sdk/) to use your project + with the following commands: + + + + $ curl https://dl.google.com/dl/cloudsdk/release/install_google_cloud_sdk.bash | bash + $ gcloud auth login + Enter a cloud project id (or leave blank to not set): + +3. Start a new instance, select a zone close to you and the desired + instance size: + + + + $ gcutil addinstance docker-playground --image=backports-debian-7 + 1: europe-west1-a + ... + 4: us-central1-b + >>> + 1: machineTypes/n1-standard-1 + ... + 12: machineTypes/g1-small + >>> + +4. Connect to the instance using SSH: + + + + $ gcutil ssh docker-playground + docker-playground:~$ + +5. Install the latest Docker release and configure it to start when the + instance boots: + + + + docker-playground:~$ curl get.docker.io | bash + docker-playground:~$ sudo update-rc.d docker defaults + +6. Start a new container: + + + + docker-playground:~$ sudo docker run busybox echo 'docker on GCE \o/' + docker on GCE \o/ diff --git a/docs/sources/installation/mac.md b/docs/sources/installation/mac.md new file mode 100644 index 0000000000..4b70ef8371 --- /dev/null +++ b/docs/sources/installation/mac.md @@ -0,0 +1,179 @@ +page_title: Installation on Mac OS X 10.6 Snow Leopard +page_description: Please note this project is currently under heavy development. It should not be used in production. +page_keywords: Docker, Docker documentation, requirements, virtualbox, ssh, linux, os x, osx, mac + +# Mac OS X + +> **Note**: +> These instructions are available with the new release of Docker (version +> 0.8). However, they are subject to change. + +> **Note**: +> Docker is still under heavy development! We don’t recommend using it in +> production yet, but we’re getting closer with each release. Please see +> our blog post, [Getting to Docker 1.0]( +> http://blog.docker.io/2013/08/getting-to-docker-1-0/) + +Docker is supported on Mac OS X 10.6 "Snow Leopard" or newer. + +## How To Install Docker On Mac OS X + +### VirtualBox + +Docker on OS X needs VirtualBox to run. To begin with, head over to +[VirtualBox Download Page](https://www.virtualbox.org/wiki/Downloads) +and get the tool for `OS X hosts x86/amd64`. + +Once the download is complete, open the disk image, run the set up file +(i.e. `VirtualBox.pkg`) and install VirtualBox. Do +not simply copy the package without running the installer. + +### boot2docker + +[boot2docker](https://github.com/boot2docker/boot2docker) provides a +handy script to easily manage the VM running the `docker` +daemon. It also takes care of the installation for the OS +image that is used for the job. + +#### With Homebrew + +If you are using Homebrew on your machine, simply run the following +command to install `boot2docker`: + + brew install boot2docker + +#### Manual installation + +Open up a new terminal window, if you have not already. + +Run the following commands to get boot2docker: + + # Enter the installation directory + cd ~/bin + + # Get the file + curl https://raw.github.com/boot2docker/boot2docker/master/boot2docker > boot2docker + + # Mark it executable + chmod +x boot2docker + +### Docker OS X Client + +The `docker` daemon is accessed using the +`docker` client. + +#### With Homebrew + +Run the following command to install the `docker` +client: + + brew install docker + +#### Manual installation + +Run the following commands to get it downloaded and set up: + + # Get the docker client file + DIR=$(mktemp -d ${TMPDIR:-/tmp}/dockerdl.XXXXXXX) && \ + curl -f -o $DIR/ld.tgz https://get.docker.io/builds/Darwin/x86_64/docker-latest.tgz && \ + gunzip $DIR/ld.tgz && \ + tar xvf $DIR/ld.tar -C $DIR/ && \ + cp $DIR/usr/local/bin/docker ./docker + + # Set the environment variable for the docker daemon + export DOCKER_HOST=tcp://127.0.0.1:4243 + + # Copy the executable file + sudo mkdir -p /usr/local/bin + sudo cp docker /usr/local/bin/ + +And that’s it! Let’s check out how to use it. + +## How To Use Docker On Mac OS X + +### The `docker` daemon (via boot2docker) + +Inside the `~/bin` directory, run the following +commands: + + # Initiate the VM + ./boot2docker init + + # Run the VM (the docker daemon) + ./boot2docker up + + # To see all available commands: + ./boot2docker + + # Usage ./boot2docker {init|start|up|pause|stop|restart|status|info|delete|ssh|download} + +### The `docker` client + +Once the VM with the `docker` daemon is up, you can +use the `docker` client just like any other +application. + + docker version + # Client version: 0.7.6 + # Go version (client): go1.2 + # Git commit (client): bc3b2ec + # Server version: 0.7.5 + # Git commit (server): c348c04 + # Go version (server): go1.2 + +### Forwarding VM Port Range to Host + +If we take the port range that docker uses by default with the -P option +(49000-49900), and forward same range from host to vm, we’ll be able to +interact with our containers as if they were running locally: + + # vm must be powered off + for i in {49000..49900}; do + VBoxManage modifyvm "boot2docker-vm" --natpf1 "tcp-port$i,tcp,,$i,,$i"; + VBoxManage modifyvm "boot2docker-vm" --natpf1 "udp-port$i,udp,,$i,,$i"; + done + +### SSH-ing The VM + +If you feel the need to connect to the VM, you can simply run: + + ./boot2docker ssh + + # User: docker + # Pwd: tcuser + +You can now continue with the [*Hello +World*](../../examples/hello_world/#hello-world) example. + +## Learn More + +### boot2docker: + +See the GitHub page for +[boot2docker](https://github.com/boot2docker/boot2docker). + +### If SSH complains about keys: + + ssh-keygen -R '[localhost]:2022' + +### Upgrading to a newer release of boot2docker + +To upgrade an initialised VM, you can use the following 3 commands. Your +persistence disk will not be changed, so you won’t lose your images and +containers: + + ./boot2docker stop + ./boot2docker download + ./boot2docker start + +### About the way Docker works on Mac OS X: + +Docker has two key components: the `docker` daemon +and the `docker` client. The tool works by client +commanding the daemon. In order to work and do its magic, the daemon +makes use of some Linux Kernel features (e.g. LXC, name spaces etc.), +which are not supported by OS X. Therefore, the solution of getting +Docker to run on OS X consists of running it inside a lightweight +virtual machine. In order to simplify things, Docker comes with a bash +script to make this whole process as easy as possible (i.e. +boot2docker). diff --git a/docs/sources/installation/openSUSE.md b/docs/sources/installation/openSUSE.md new file mode 100644 index 0000000000..ebd8ea6f6e --- /dev/null +++ b/docs/sources/installation/openSUSE.md @@ -0,0 +1,63 @@ +page_title: Installation on openSUSE +page_description: Please note this project is currently under heavy development. It should not be used in production. +page_keywords: openSUSE, virtualbox, docker, documentation, installation + +# openSUSE + +> **Note**: +> Docker is still under heavy development! We don’t recommend using it in +> production yet, but we’re getting closer with each release. Please see +> our blog post, [Getting to Docker 1.0]( +> http://blog.docker.io/2013/08/getting-to-docker-1-0/) + +> **Note**: +> This is a community contributed installation path. The only ‘official’ +> installation is using the [*Ubuntu*](../ubuntulinux/#ubuntu-linux) +> installation path. This version may be out of date because it depends on +> some binaries to be updated and published + +Docker is available in **openSUSE 12.3 and later**. Please note that due +to the current Docker limitations Docker is able to run only on the **64 +bit** architecture. + +## Installation + +The `docker` package from the [Virtualization +project](https://build.opensuse.org/project/show/Virtualization) on +[OBS](https://build.opensuse.org/) provides Docker on openSUSE. + +To proceed with Docker installation please add the right Virtualization +repository. + + # openSUSE 12.3 + sudo zypper ar -f http://download.opensuse.org/repositories/Virtualization/openSUSE_12.3/ Virtualization + + # openSUSE 13.1 + sudo zypper ar -f http://download.opensuse.org/repositories/Virtualization/openSUSE_13.1/ Virtualization + +Install the Docker package. + + sudo zypper in docker + +It’s also possible to install Docker using openSUSE’s 1-click install. +Just visit [this](http://software.opensuse.org/package/docker) page, +select your openSUSE version and click on the installation link. This +will add the right repository to your system and it will also install +the docker package. + +Now that it’s installed, let’s start the Docker daemon. + + sudo systemctl start docker + +If we want Docker to start at boot, we should also: + + sudo systemctl enable docker + +The docker package creates a new group named docker. Users, other than +root user, need to be part of this group in order to interact with the +Docker daemon. + + sudo usermod -G docker + +**Done!**, now continue with the [*Hello +World*](../../examples/hello_world/#hello-world) example. diff --git a/docs/sources/installation/rackspace.md b/docs/sources/installation/rackspace.md new file mode 100644 index 0000000000..2d213a7fc9 --- /dev/null +++ b/docs/sources/installation/rackspace.md @@ -0,0 +1,87 @@ +page_title: Installation on Rackspace Cloud +page_description: Please note this project is currently under heavy development. It should not be used in production. +page_keywords: Rackspace Cloud, installation, docker, linux, ubuntu + +# Rackspace Cloud + +> **Note**: +> This is a community contributed installation path. The only ‘official’ +> installation is using the [*Ubuntu*](../ubuntulinux/#ubuntu-linux) +> installation path. This version may be out of date because it depends on +> some binaries to be updated and published + +Installing Docker on Ubuntu provided by Rackspace is pretty +straightforward, and you should mostly be able to follow the +[*Ubuntu*](../ubuntulinux/#ubuntu-linux) installation guide. + +**However, there is one caveat:** + +If you are using any Linux not already shipping with the 3.8 kernel you +will need to install it. And this is a little more difficult on +Rackspace. + +Rackspace boots their servers using grub’s `menu.lst` +and does not like non ‘virtual’ packages (e.g. Xen compatible) +kernels there, although they do work. This results in +`update-grub` not having the expected result, and +you will need to set the kernel manually. + +**Do not attempt this on a production machine!** + + # update apt + apt-get update + + # install the new kernel + apt-get install linux-generic-lts-raring + +Great, now you have the kernel installed in `/boot/`, next you need to +make it boot next time. + + # find the exact names + find /boot/ -name '*3.8*' + + # this should return some results + +Now you need to manually edit `/boot/grub/menu.lst`, +you will find a section at the bottom with the existing options. Copy +the top one and substitute the new kernel into that. Make sure the new +kernel is on top, and double check the kernel and initrd lines point to +the right files. + +Take special care to double check the kernel and initrd entries. + + # now edit /boot/grub/menu.lst + vi /boot/grub/menu.lst + +It will probably look something like this: + + ## ## End Default Options ## + + title Ubuntu 12.04.2 LTS, kernel 3.8.x generic + root (hd0) + kernel /boot/vmlinuz-3.8.0-19-generic root=/dev/xvda1 ro quiet splash console=hvc0 + initrd /boot/initrd.img-3.8.0-19-generic + + title Ubuntu 12.04.2 LTS, kernel 3.2.0-38-virtual + root (hd0) + kernel /boot/vmlinuz-3.2.0-38-virtual root=/dev/xvda1 ro quiet splash console=hvc0 + initrd /boot/initrd.img-3.2.0-38-virtual + + title Ubuntu 12.04.2 LTS, kernel 3.2.0-38-virtual (recovery mode) + root (hd0) + kernel /boot/vmlinuz-3.2.0-38-virtual root=/dev/xvda1 ro quiet splash single + initrd /boot/initrd.img-3.2.0-38-virtual + +Reboot the server (either via command line or console) + + # reboot + +Verify the kernel was updated + + uname -a + # Linux docker-12-04 3.8.0-19-generic #30~precise1-Ubuntu SMP Wed May 1 22:26:36 UTC 2013 x86_64 x86_64 x86_64 GNU/Linux + + # nice! 3.8. + +Now you can finish with the [*Ubuntu*](../ubuntulinux/#ubuntu-linux) +instructions. diff --git a/docs/sources/installation/rhel.md b/docs/sources/installation/rhel.md new file mode 100644 index 0000000000..d7df63920d --- /dev/null +++ b/docs/sources/installation/rhel.md @@ -0,0 +1,78 @@ +page_title: Installation on Red Hat Enterprise Linux +page_description: Please note this project is currently under heavy development. It should not be used in production. +page_keywords: Docker, Docker documentation, requirements, linux, rhel, centos + +# Red Hat Enterprise Linux + +> **Note**: +> Docker is still under heavy development! We don’t recommend using it in +> production yet, but we’re getting closer with each release. Please see +> our blog post, [Getting to Docker 1.0]( +> http://blog.docker.io/2013/08/getting-to-docker-1-0/) + +> **Note**: +> This is a community contributed installation path. The only ‘official’ +> installation is using the [*Ubuntu*](../ubuntulinux/#ubuntu-linux) +> installation path. This version may be out of date because it depends on +> some binaries to be updated and published + +Docker is available for **RHEL** on EPEL. These instructions should work +for both RHEL and CentOS. They will likely work for other binary +compatible EL6 distributions as well, but they haven’t been tested. + +Please note that this package is part of [Extra Packages for Enterprise +Linux (EPEL)](https://fedoraproject.org/wiki/EPEL), a community effort +to create and maintain additional packages for the RHEL distribution. + +Also note that due to the current Docker limitations, Docker is able to +run only on the **64 bit** architecture. + +You will need [RHEL +6.5](https://access.redhat.com/site/articles/3078#RHEL6) or higher, with +a RHEL 6 kernel version 2.6.32-431 or higher as this has specific kernel +fixes to allow Docker to work. + +## Installation + +Firstly, you need to install the EPEL repository. Please follow the +[EPEL installation +instructions](https://fedoraproject.org/wiki/EPEL#How_can_I_use_these_extra_packages.3F). + +The `docker-io` package provides Docker on EPEL. + +If you already have the (unrelated) `docker` package +installed, it will conflict with `docker-io`. +There’s a [bug +report](https://bugzilla.redhat.com/show_bug.cgi?id=1043676) filed for +it. To proceed with `docker-io` installation, please +remove `docker` first. + +Next, let’s install the `docker-io` package which +will install Docker on our host. + + sudo yum -y install docker-io + +To update the `docker-io` package + + sudo yum -y update docker-io + +Now that it’s installed, let’s start the Docker daemon. + + sudo service docker start + +If we want Docker to start at boot, we should also: + + sudo chkconfig docker on + +Now let’s verify that Docker is working. + + sudo docker run -i -t fedora /bin/bash + +**Done!**, now continue with the [*Hello +World*](../../examples/hello_world/#hello-world) example. + +## Issues? + +If you have any issues - please report them directly in the [Red Hat +Bugzilla for docker-io +component](https://bugzilla.redhat.com/enter_bug.cgi?product=Fedora%20EPEL&component=docker-io). diff --git a/docs/sources/installation/softlayer.md b/docs/sources/installation/softlayer.md new file mode 100644 index 0000000000..0b14ac567d --- /dev/null +++ b/docs/sources/installation/softlayer.md @@ -0,0 +1,36 @@ +page_title: Installation on IBM SoftLayer +page_description: Please note this project is currently under heavy development. It should not be used in production. +page_keywords: IBM SoftLayer, virtualization, cloud, docker, documentation, installation + +# IBM SoftLayer + +> **Note**: +> Docker is still under heavy development! We don’t recommend using it in +> production yet, but we’re getting closer with each release. Please see +> our blog post, [Getting to Docker 1.0]( +> http://blog.docker.io/2013/08/getting-to-docker-1-0/) + +## IBM SoftLayer QuickStart + +1. Create an [IBM SoftLayer + account](https://www.softlayer.com/cloudlayer/). +2. Log in to the [SoftLayer + Console](https://control.softlayer.com/devices/). +3. Go to [Order Hourly Computing Instance + Wizard](https://manage.softlayer.com/Sales/orderHourlyComputingInstance) + on your SoftLayer Console. +4. Create a new *CloudLayer Computing Instance* (CCI) using the default + values for all the fields and choose: + +- *First Available* as `Datacenter` and +- *Ubuntu Linux 12.04 LTS Precise Pangolin - Minimal Install (64 bit)* + as `Operating System`. + +5. Click the *Continue Your Order* button at the bottom right and + select *Go to checkout*. +6. Insert the required *User Metadata* and place the order. +7. Then continue with the [*Ubuntu*](../ubuntulinux/#ubuntu-linux) + instructions. + +Continue with the [*Hello +World*](../../examples/hello_world/#hello-world) example. diff --git a/docs/sources/installation/ubuntulinux.md b/docs/sources/installation/ubuntulinux.md new file mode 100644 index 0000000000..07d6072b5d --- /dev/null +++ b/docs/sources/installation/ubuntulinux.md @@ -0,0 +1,321 @@ +page_title: Installation on Ubuntu +page_description: Please note this project is currently under heavy development. It should not be used in production. +page_keywords: Docker, Docker documentation, requirements, virtualbox, vagrant, git, ssh, putty, cygwin, linux + +# Ubuntu + +> **Warning**: +> These instructions have changed for 0.6. If you are upgrading from an +> earlier version, you will need to follow them again. + +> **Note**: +> Docker is still under heavy development! We don’t recommend using it in +> production yet, but we’re getting closer with each release. Please see +> our blog post, [Getting to Docker 1.0]( +> http://blog.docker.io/2013/08/getting-to-docker-1-0/) + +Docker is supported on the following versions of Ubuntu: + +- [*Ubuntu Precise 12.04 (LTS) (64-bit)*](#ubuntu-precise-1204-lts-64-bit) +- [*Ubuntu Raring 13.04 and Saucy 13.10 (64 + bit)*](#ubuntu-raring-1304-and-saucy-1310-64-bit) + +Please read [*Docker and UFW*](#docker-and-ufw), if you plan to use [UFW +(Uncomplicated Firewall)](https://help.ubuntu.com/community/UFW) + +## Ubuntu Precise 12.04 (LTS) (64-bit) + +This installation path should work at all times. + +### Dependencies + +**Linux kernel 3.8** + +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 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. + + # install the backported kernel + sudo apt-get update + sudo apt-get install linux-image-generic-lts-raring linux-headers-generic-lts-raring + + # reboot + sudo reboot + +### Installation + +> **Warning**: +> These instructions have changed for 0.6. If you are upgrading from an +> earlier version, you will need to follow them again. + +Docker is available as a Debian package, which makes installation easy. +**See the** [*Mirrors*](#mirrors) **section below if you are not +in the United States.** Other sources of the Debian packages may be +faster for you to install. + +First, check that your APT system can deal with `https` +URLs: the file `/usr/lib/apt/methods/https` +should exist. If it doesn’t, you need to install the package +`apt-transport-https`. + + [ -e /usr/lib/apt/methods/https ] || { + apt-get update + apt-get install apt-transport-https + } + +Then, add the Docker repository key to your local keychain. + + sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys 36A1D7869245C8950F966E92D8576A8BA88D21E9 + +Add the Docker repository to your apt sources list, update and install +the `lxc-docker` package. + +*You may receive a warning that the package isn’t trusted. Answer yes to +continue installation.* + + sudo sh -c "echo deb https://get.docker.io/ubuntu docker main\ + > /etc/apt/sources.list.d/docker.list" + sudo apt-get update + sudo apt-get install lxc-docker + +> **Note**: +> +> There is also a simple `curl` script available to help with this process. +> +> curl -s https://get.docker.io/ubuntu/ | sudo sh + +Now verify that the installation has worked by downloading the +`ubuntu` image and launching a container. + + sudo docker run -i -t ubuntu /bin/bash + +Type `exit` to exit + +**Done!**, now continue with the [*Hello +World*](../../examples/hello_world/#hello-world) example. + +## Ubuntu Raring 13.04 and Saucy 13.10 (64 bit) + +These instructions cover both Ubuntu Raring 13.04 and Saucy 13.10. + +### Dependencies + +**Optional 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. AUFS support is optional as of version 0.7, but it’s still +available as a driver and we recommend using it if you can. + +To make sure AUFS is installed, run the following commands: + + sudo apt-get update + sudo apt-get install linux-image-extra-`uname -r` + +### Installation + +Docker is available as a Debian package, which makes installation easy. + +> **Warning**: +> 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. + +First add the Docker repository key to your local keychain. + + sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys 36A1D7869245C8950F966E92D8576A8BA88D21E9 + +Add the Docker repository to your apt sources list, update and install +the `lxc-docker` package. + + sudo sh -c "echo deb http://get.docker.io/ubuntu docker main\ + > /etc/apt/sources.list.d/docker.list" + sudo apt-get update + sudo apt-get install lxc-docker + +Now verify that the installation has worked by downloading the +`ubuntu` image and launching a container. + + sudo docker run -i -t ubuntu /bin/bash + +Type `exit` to exit + +**Done!**, now continue with the [*Hello +World*](../../examples/hello_world/#hello-world) example. + +### Giving non-root access + +The `docker` daemon always runs as the root user, +and since Docker version 0.5.2, the `docker` daemon +binds to a Unix socket instead of a TCP port. By default that Unix +socket is owned by the user *root*, and so, by default, you can access +it with `sudo`. + +Starting in version 0.5.3, if you (or your Docker installer) create a +Unix group called *docker* and add users to it, then the +`docker` daemon will make the ownership of the Unix +socket read/writable by the *docker* group when the daemon starts. The +`docker` daemon must always run as the root user, +but if you run the `docker` client as a user in the +*docker* group then you don’t need to add `sudo` to +all the client commands. As of 0.9.0, you can specify that a group other +than `docker` should own the Unix socket with the +`-G` option. + +> **Warning**: +> The *docker* group (or the group specified with `-G`) is +> root-equivalent; see [*Docker Daemon Attack Surface*]( +> ../../articles/security/#dockersecurity-daemon) details. + +**Example:** + + # Add the docker group if it doesn't already exist. + sudo groupadd docker + + # Add the connected user "${USER}" to the docker group. + # Change the user name to match your preferred user. + # You may have to logout and log back in again for + # this to take effect. + sudo gpasswd -a ${USER} docker + + # Restart the Docker daemon. + sudo service docker restart + +### Upgrade + +To install the latest version of docker, use the standard +`apt-get` method: + + # update your sources list + sudo apt-get update + + # install the latest + sudo apt-get install lxc-docker + +## Memory and Swap Accounting + +If you want to enable memory and swap accounting, you must add the +following command-line parameters to your kernel: + + cgroup_enable=memory swapaccount=1 + +On systems using GRUB (which is the default for Ubuntu), you can add +those parameters by editing `/etc/default/grub` and +extending `GRUB_CMDLINE_LINUX`. Look for the +following line: + + GRUB_CMDLINE_LINUX="" + +And replace it by the following one: + + GRUB_CMDLINE_LINUX="cgroup_enable=memory swapaccount=1" + +Then run `sudo update-grub`, and reboot. + +These parameters will help you get rid of the following warnings: + + WARNING: Your kernel does not support cgroup swap limit. + WARNING: Your kernel does not support swap limit capabilities. Limitation discarded. + +## Troubleshooting + +On Linux Mint, the `cgroup-lite` package is not +installed by default. Before Docker will work correctly, you will need +to install this via: + + sudo apt-get update && sudo apt-get install cgroup-lite + +## Docker and UFW + +Docker uses a bridge to manage container networking. By default, UFW +drops all forwarding traffic. As a result you will need to enable UFW +forwarding: + + sudo nano /etc/default/ufw + ---- + # Change: + # DEFAULT_FORWARD_POLICY="DROP" + # to + DEFAULT_FORWARD_POLICY="ACCEPT" + +Then reload UFW: + + sudo ufw reload + +UFW’s default set of rules denies all incoming traffic. If you want to +be able to reach your containers from another host then you should allow +incoming connections on the Docker port (default 4243): + + sudo ufw allow 4243/tcp + +## Docker and local DNS server warnings + +Systems which are running Ubuntu or an Ubuntu derivative on the desktop +will use 127.0.0.1 as the default nameserver in /etc/resolv.conf. +NetworkManager sets up dnsmasq to use the real DNS servers of the +connection and sets up nameserver 127.0.0.1 in /etc/resolv.conf. + +When starting containers on these desktop machines, users will see a +warning: + + WARNING: Local (127.0.0.1) DNS resolver found in resolv.conf and containers can't use it. Using default external servers : [8.8.8.8 8.8.4.4] + +This warning is shown because the containers can’t use the local DNS +nameserver and Docker will default to using an external nameserver. + +This can be worked around by specifying a DNS server to be used by the +Docker daemon for the containers: + + sudo nano /etc/default/docker + --- + # Add: + DOCKER_OPTS="--dns 8.8.8.8" + # 8.8.8.8 could be replaced with a local DNS server, such as 192.168.1.1 + # multiple DNS servers can be specified: --dns 8.8.8.8 --dns 192.168.1.1 + +The Docker daemon has to be restarted: + + sudo restart docker + +> **Warning**: +> If you’re doing this on a laptop which connects to various networks, +> make sure to choose a public DNS server. + +An alternative solution involves disabling dnsmasq in NetworkManager by +following these steps: + + sudo nano /etc/NetworkManager/NetworkManager.conf + ---- + # Change: + dns=dnsmasq + # to + #dns=dnsmasq + +NetworkManager and Docker need to be restarted afterwards: + + sudo restart network-manager + sudo restart docker + +> **Warning**: This might make DNS resolution slower on some networks. + +## Mirrors + +You should `ping get.docker.io` and compare the +latency to the following mirrors, and pick whichever one is best for +you. + +### Yandex + +[Yandex](http://yandex.ru/) in Russia is mirroring the Docker Debian +packages, updating every 6 hours. Substitute +`http://mirror.yandex.ru/mirrors/docker/` for +`http://get.docker.io/ubuntu` in the instructions +above. For example: + + sudo sh -c "echo deb http://mirror.yandex.ru/mirrors/docker/ docker main\ + > /etc/apt/sources.list.d/docker.list" + sudo apt-get update + sudo apt-get install lxc-docker diff --git a/docs/sources/installation/windows.md b/docs/sources/installation/windows.md new file mode 100644 index 0000000000..cadecdaddb --- /dev/null +++ b/docs/sources/installation/windows.md @@ -0,0 +1,71 @@ +page_title: Installation on Windows +page_description: Please note this project is currently under heavy development. It should not be used in production. +page_keywords: Docker, Docker documentation, Windows, requirements, virtualbox, boot2docker + +# Windows + +Docker can run on Windows using a virtualization platform like +VirtualBox. A Linux distribution is run inside a virtual machine and +that’s where Docker will run. + +## Installation + +> **Note**: +> Docker is still under heavy development! We don’t recommend using it in +> production yet, but we’re getting closer with each release. Please see +> our blog post, [Getting to Docker 1.0]( +> http://blog.docker.io/2013/08/getting-to-docker-1-0/) + +1. Install virtualbox from + [https://www.virtualbox.org](https://www.virtualbox.org) - or follow + this + [tutorial](http://www.slideshare.net/julienbarbier42/install-virtualbox-on-windows-7). +2. Download the latest boot2docker.iso from + [https://github.com/boot2docker/boot2docker/releases](https://github.com/boot2docker/boot2docker/releases). +3. Start VirtualBox. +4. Create a new Virtual machine with the following settings: + +> - Name: boot2docker +> - Type: Linux +> - Version: Linux 2.6 (64 bit) +> - Memory size: 1024 MB +> - Hard drive: Do not add a virtual hard drive + +5. Open the settings of the virtual machine: + + 5.1. go to Storage + + 5.2. click the empty slot below Controller: IDE + + 5.3. click the disc icon on the right of IDE Secondary Master + + 5.4. click Choose a virtual CD/DVD disk file + +6. Browse to the path where you’ve saved the boot2docker.iso, select + the boot2docker.iso and click open. + +7. Click OK on the Settings dialog to save the changes and close the + window. + +8. Start the virtual machine by clicking the green start button. + +9. The boot2docker virtual machine should boot now. + +## Running Docker + +boot2docker will log you in automatically so you can start using Docker +right away. + +Let’s try the “hello world” example. Run + + docker run busybox echo hello world + +This will download the small busybox image and print hello world. + +## Observations + +### Persistent storage + +The virtual machine created above lacks any persistent data storage. All +images and containers will be lost when shutting down or rebooting the +VM. diff --git a/docs/sources/installation/windows.rst b/docs/sources/installation/windows.rst old mode 100644 new mode 100755 index d00b012e6c..ceb29c8853 --- a/docs/sources/installation/windows.rst +++ b/docs/sources/installation/windows.rst @@ -4,8 +4,8 @@ .. _windows: -Windows -======= +Microsoft Windows +================= Docker can run on Windows using a virtualization platform like VirtualBox. A Linux distribution is run inside a virtual machine and that's where Docker will run. @@ -15,7 +15,7 @@ Installation .. include:: install_header.inc -1. Install virtualbox from https://www.virtualbox.org - or follow this `tutorial `_. +1. Install VirtualBox from https://www.virtualbox.org - or follow this `tutorial `_. 2. Download the latest boot2docker.iso from https://github.com/boot2docker/boot2docker/releases. diff --git a/docs/sources/introduction/get-docker.md b/docs/sources/introduction/get-docker.md new file mode 100644 index 0000000000..e0d6f16654 --- /dev/null +++ b/docs/sources/introduction/get-docker.md @@ -0,0 +1,77 @@ +page_title: Getting Docker +page_description: Getting Docker and installation tutorials +page_keywords: docker, introduction, documentation, about, technology, understanding, Dockerfile + +# Getting Docker + +*How to install Docker?* + +## Introductions + +Once you are comfortable with your level of knowledge of Docker, and +feel like actually trying the product, you can download and start using +it by following the links listed below. There, you will find +installation instructions, specifically tailored for your platform of choice. + +## Installation Instructions + +### Linux (Native) + + - **Arch Linux:** + [Installation on Arch Linux](../installation/archlinux.md) + - **Fedora:** + [Installation on Fedora](../installation/fedora.md) + - **FrugalWare:** + [Installation on FrugalWare](../installation/frugalware.md) + - **Gentoo:** + [Installation on Gentoo](../installation/gentoolinux.md) + - **Red Hat Enterprise Linux:** + [Installation on Red Hat Enterprise Linux](../installation/rhel.md) + - **Ubuntu:** + [Installation on Ubuntu](../installation/ubuntulinux.md) + - **openSUSE:** + [Installation on openSUSE](../installation/openSUSE.md) + +### Mac OS X (Using Boot2Docker) + +In order to work, Docker makes use of some Linux Kernel features which +are not supported by Mac OS X. To run Docker on OS X we install and run +a lightweight virtual machine and run Docker on that. + + - **Mac OS X :** + [Installation on Mac OS X](../installation/mac.md) + +### Windows (Using Boot2Docker) + +Docker can also run on Windows using a virtual machine. You then run +Linux and Docker inside that virtual machine. + + - **Windows:** + [Installation on Windows](../installation/windows.md) + +### Infrastructure-as-a-Service + + - **Amazon EC2:** + [Installation on Amazon EC2](../installation/amazon.md) + - **Google Cloud Platform:** + [Installation on Google Cloud Platform](../installation/google.md) + - **Rackspace Cloud:** + [Installation on Rackspace Cloud](../installation/rackspace.md) + +## Where to go from here + +### Understanding Docker + +Visit [Understanding Docker](understanding-docker.md) in our Getting Started manual. + +### Learn about parts of Docker and the underlying technology + +Visit [Understanding the Technology](technology.md) in our Getting Started manual. + +### Get practical and learn how to use Docker straight away + +Visit [Working with Docker](working-with-docker.md) in our Getting Started manual. + +### Get the whole story + +[https://www.docker.io/the_whole_story/](https://www.docker.io/the_whole_story/) diff --git a/docs/sources/introduction/technology.md b/docs/sources/introduction/technology.md new file mode 100644 index 0000000000..6ae7445595 --- /dev/null +++ b/docs/sources/introduction/technology.md @@ -0,0 +1,268 @@ +page_title: Understanding the Technology +page_description: Technology of Docker explained in depth +page_keywords: docker, introduction, documentation, about, technology, understanding, Dockerfile + +# Understanding the Technology + +*What is the architecture of Docker? What is its underlying technology?* + +## Introduction + +When it comes to understanding Docker and its underlying technology +there is no *magic* involved. Everything is based on tried and tested +features of the *Linux kernel*. Docker either makes use of those +features directly or builds upon them to provide new functionality. + +Aside from the technology, one of the major factors that make Docker +great is the way it is built. The project's core is very lightweight and +as much of Docker as possible is designed to be pluggable. Docker is +also built with integration in mind and has a fully featured API that +allows you to access all of the power of Docker from inside your own +applications. + +## The Architecture of Docker + +Docker is designed for developers and sysadmins. It's built to help you +build applications and services and then deploy them quickly and +efficiently: from development to production. + +Let's take a look. + +-- Docker is a client-server application. +-- Both the Docker client and the daemon *can* run on the same system, or; +-- You can connect a Docker client with a remote Docker daemon. +-- They communicate via sockets or through a RESTful API. +-- Users interact with the client to command the daemon, e.g. to create, run, and stop containers. +-- The daemon, receiving those commands, does the job, e.g. run a container, stop a container. + +![Docker Architecture Diagram](/article-img/architecture.svg) + +## The components of Docker + +Docker's main components are: + + - Docker *daemon*; + - Docker *client*, and; + - The Docker Index. + +### The Docker daemon + +As shown on the diagram above, the Docker daemon runs on a host machine. +The user does not directly interact with the daemon, but instead through +an intermediary: the Docker client. + +### Docker client + +The Docker client is the primary user interface to Docker. It is tasked +with accepting commands from the user and communicating back and forth +with a Docker daemon to manage the container lifecycle on any host. + +### Docker Index, the central Docker registry + +The [Docker Index](http://index.docker.io) is the global archive (and +directory) of user supplied Docker container images. It currently hosts +a large – in fact, rapidly growing – number of projects where you +can find almost any popular application or deployment stack readily +available to download and run with a single command. + +As a social community project, Docker tries to provide all necessary +tools for everyone to grow with other *Dockers*. By issuing a single +command through the Docker client you can start sharing your own +creations with the rest of the world. + +However, knowing that not everything can be shared the Docker Index also +offers private repositories. In order to see the available plans, you +can click [here](https://index.docker.io/plans). + +Using the [Docker Registry](https://github.com/dotcloud/docker-registry), it is +also possible to run your own private Docker image registry service on your own +servers. + +> **Note:** To learn more about the [*Docker Image Index*]( +> http://index.docker.io) (public *and* private), check out the [Registry & +> Index Spec](http://docs.docker.io/en/latest/api/registry_index_spec/). + +### Summary + + - **When you install Docker, you get all the components:** + The daemon, the client and access to the public image registry: the [Docker Index](http://index.docker.io). + - **You can run these components together or distributed:** + Servers with the Docker daemon running, controlled by the Docker client. + - **You can benefit form the public registry:** + Download and build upon images created by the community. + - **You can start a private repository for proprietary use.** + Sign up for a [plan](https://index.docker.io/plans) or host your own [Docker registry](https://github.com/dotcloud/docker-registry). + +## Elements of Docker + +The basic elements of Docker are: + + - **Containers, which allow:** + The run portion of Docker. Your applications run inside of containers. + - **Images, which provide:** + The build portion of Docker. Your containers are built from images. + - **The Dockerfile, which automates:** + A file that contains simple instructions that build Docker images. + +To get practical and learn what they are, and **_how to work_** with +them, continue to [Working with Docker](working-with-docker.md). If you would like to +understand **_how they work_**, stay here and continue reading. + +## The underlying technology + +The power of Docker comes from the underlying technology it is built +from. A series of operating system features are carefully glued together +to provide Docker's features and provide an easy to use interface to +those features. In this section, we will see the main operating system +features that Docker uses to make easy containerization happen. + +### Namespaces + +Docker takes advantage of a technology called `namespaces` to provide +an isolated workspace we call a *container*. When you run a container, +Docker creates a set of *namespaces* for that container. + +This provides a layer of isolation: each process runs in its own +namespace and does not have access outside it. + +Some of the namespaces Docker uses are: + + - **The `pid` namespace:** + Used for process numbering (PID: Process ID) + - **The `net` namespace:** + Used for managing network interfaces (NET: Networking) + - **The `ipc` namespace:** + Used for managing access to IPC resources (IPC: InterProcess Communication) + - **The `mnt` namespace:** + Used for managing mount-points (MNT: Mount) + - **The `uts` namespace:** + Used for isolating kernel / version identifiers. (UTS: Unix Timesharing System) + +### Control groups + +Docker also makes use of another technology called `cgroups` or control +groups. A key need to run applications in isolation is to have them +contained, not just in terms of related filesystem and/or dependencies, +but also, resources. Control groups allow Docker to fairly +share available hardware resources to containers and if asked, set up to +limits and constraints, for example limiting the memory to a maximum of 128 +MBs. + +### UnionFS + +UnionFS or union filesystems are filesystems that operate by creating +layers, making them very lightweight and fast. Docker uses union +filesystems to provide the building blocks for containers. We'll see +more about this below. + +### Containers + +Docker combines these components to build a container format we call +`libcontainer`. Docker also supports traditional Linux containers like +[LXC](https://linuxcontainers.org/) which also make use of these +components. + +## How does everything work + +A lot happens when Docker creates a container. + +Let's see how it works! + +### How does a container work? + +A container consists of an operating system, user added files and +meta-data. Each container is built from an image. That image tells +Docker what the container holds, what process to run when the container +is launched and a variety of other configuration data. The Docker image +is read-only. When Docker runs a container from an image it adds a +read-write layer on top of the image (using the UnionFS technology we +saw earlier) to run inside the container. + +### What happens when you run a container? + +The Docker client (or the API!) tells the Docker daemon to run a +container. Let's take a look at a simple `Hello world` example. + + $ docker run -i -t ubuntu /bin/bash + +Let's break down this command. The Docker client is launched using the +`docker` binary. The bare minimum the Docker client needs to tell the +Docker daemon is: + +* What Docker image to build the container from; +* The command you want to run inside the container when it is launched. + +So what happens under the covers when we run this command? + +Docker begins with: + + - **Pulling the `ubuntu` image:** + Docker checks for the presence of the `ubuntu` image and if it doesn't + exist locally on the host, then Docker downloads it from the [Docker Index](https://index.docker.io) + - **Creates a new container:** + Once Docker has the image it creates a container from it. + - **Allocates a filesystem and mounts a read-write _layer_:** + The container is created in the filesystem and a read-write layer is added to the image. + - **Allocates a network / bridge interface:** + Creates a network interface that allows the Docker container to talk to the local host. + - **Sets up an IP address:** + Intelligently finds and attaches an available IP address from a pool. + - **Executes _a_ process that you specify:** + Runs your application, and; + - **Captures and provides application output:** + Connects and logs standard input, outputs and errors for you to see how your application is running. + +### How does a Docker Image work? + +We've already seen that Docker images are read-only templates that +Docker containers are launched from. When you launch that container it +creates a read-write layer on top of that image that your application is +run in. + +Docker images are built using a simple descriptive set of steps we +call *instructions*. Instructions are stored in a file called a +`Dockerfile`. Each instruction writes a new layer to an image using the +UnionFS technology we saw earlier. + +Every image starts from a base image, for example `ubuntu` a base Ubuntu +image or `fedora` a base Fedora image. Docker builds and provides these +base images via the [Docker Index](http://index.docker.io). + +### How does a Docker registry work? + +The Docker registry is a store for your Docker images. Once you build a +Docker image you can *push* it to the [Docker +Index](http://index.docker.io) or to a private registry you run behind +your firewall. + +Using the Docker client, you can search for already published images and +then pull them down to your Docker host to build containers from them +(or even build on these images). + +The [Docker Index](http://index.docker.io) provides both public and +private storage for images. Public storage is searchable and can be +downloaded by anyone. Private repositories are excluded from search +results and only you and your users can pull them down and use them to +build containers. You can [sign up for a plan here](https://index.docker.io/plans). + +To learn more, check out the [Working With Repositories]( +http://docs.docker.io/en/latest/use/workingwithrepository) section of our +[User's Manual](http://docs.docker.io). + +## Where to go from here + +### Understanding Docker + +Visit [Understanding Docker](understanding-docker.md) in our Getting Started manual. + +### Get practical and learn how to use Docker straight away + +Visit [Working with Docker](working-with-docker.md) in our Getting Started manual. + +### Get the product and go hands-on + +Visit [Get Docker](get-docker.md) in our Getting Started manual. + +### Get the whole story + +[https://www.docker.io/the_whole_story/](https://www.docker.io/the_whole_story/) diff --git a/docs/sources/introduction/understanding-docker.md b/docs/sources/introduction/understanding-docker.md new file mode 100644 index 0000000000..1c979d5810 --- /dev/null +++ b/docs/sources/introduction/understanding-docker.md @@ -0,0 +1,272 @@ +page_title: Understanding Docker +page_description: Docker explained in depth +page_keywords: docker, introduction, documentation, about, technology, understanding, Dockerfile + +# Understanding Docker + +*What is Docker? What makes it great?* + +Building development lifecycles, pipelines and deployment tooling is +hard. It's not easy to create portable applications and services. +There's often high friction getting code from your development +environment to production. It's also hard to ensure those applications +and services are consistent, up-to-date and managed. + +Docker is designed to solve these problem for both developers and +sysadmins. It is a lightweight framework (with a powerful API) that +provides a lifecycle for building and deploying applications into +containers. + +Docker provides a way to run almost any application securely isolated +into a container. The isolation and security allows you to run many +containers simultaneously on your host. The lightweight nature of +containers, which run without the extra overload of a hypervisor, means +you can get more out of your hardware. + +**Note:** Docker itself is *shipped* with the Apache 2.0 license and it +is completely open-source — *the pun? very much intended*. + +### What are the Docker basics I need to know? + +Docker has three major components: + +* Docker containers. +* Docker images. +* Docker registries. + +#### Docker containers + +Docker containers are like a directory. A Docker container holds +everything that is needed for an application to run. Each container is +created from a Docker image. Docker containers can be run, started, +stopped, moved and deleted. Each container is an isolated and secure +application platform. You can consider Docker containers the *run* +portion of the Docker framework. + +#### Docker images + +The Docker image is a template, for example an Ubuntu +operating system with Apache and your web application installed. Docker +containers are launched from images. Docker provides a simple way to +build new images or update existing images. You can consider Docker +images to be the *build* portion of the Docker framework. + +#### Docker Registries + +Docker registries hold images. These are public (or private!) stores +that you can upload or download images to and from. These images can be +images you create yourself or you can make use of images that others +have previously created. Docker registries allow you to build simple and +powerful development and deployment work flows. You can consider Docker +registries the *share* portion of the Docker framework. + +### How does Docker work? + +Docker is a client-server framework. The Docker *client* commands the Docker +*daemon*, which in turn creates, builds and manages containers. + +The Docker daemon takes advantage of some neat Linux kernel and +operating system features, like `namespaces` and `cgroups`, to build +isolated container. Docker provides a simple abstraction layer to these +technologies. + +> **Note:** If you would like to learn more about the underlying technology, +> why not jump to [Understanding the Technology](technology.md) where we talk about them? You can +> always come back here to continue learning about features of Docker and what +> makes it different. + +## Features of Docker + +In order to get a good grasp of the capabilities of Docker you should +read the [User's Manual](http://docs.docker.io). Let's look at a summary +of Docker's features to give you an idea of how Docker might be useful +to you. + +### User centric and simple to use + +*Docker is made for humans.* + +It's easy to get started and easy to build and deploy applications with +Docker: or as we say "*dockerise*" them! As much of Docker as possible +uses plain English for commands and tries to be as lightweight and +transparent as possible. We want to get out of the way so you can build +and deploy your applications. + +### Docker is Portable + +*Dockerise And Go!* + +Docker containers are highly portable. Docker provides a standard +container format to hold your applications: + +* You take care of your applications inside the container, and; +* Docker takes care of managing the container. + +Any machine, be it bare-metal or virtualized, can run any Docker +container. The sole requirement is to have Docker installed. + +**This translates to:** + + - Reliability; + - Freeing your applications out of the dependency-hell; + - A natural guarantee that things will work, anywhere. + +### Lightweight + +*No more resources waste.* + +Containers are lightweight, in fact, they are extremely lightweight. +Unlike traditional virtual machines, which have the overhead of a +hypervisor, Docker relies on operating system level features to provide +isolation and security. A Docker container does not need anything more +than what your application needs to run. + +This translates to: + + - Ability to deploy a large number of applications on a single system; + - Lightning fast start up times and reduced overhead. + +### Docker can run anything + +*An amazing host! (again, pun intended.)* + +Docker isn't prescriptive about what applications or services you can run +inside containers. We provide use cases and examples for running web +services, databases, applications - just about anything you can imagine +can run in a Docker container. + +**This translates to:** + + - Ability to run a wide range of applications; + - Ability to deploy reliably without repeating yourself. + +### Plays well with others + +*A wonderful guest.* + +Today, it is possible to install and use Docker almost anywhere. Even on +non-Linux systems such as Windows or Mac OS X thanks to a project called +[Boot2Docker](http://boot2docker.io). + +**This translates to running Docker (and Docker containers!) _anywhere_:** + + - **Linux:** + Ubuntu, CentOS / RHEL, Fedora, Gentoo, openSUSE and more. + - **Infrastructure-as-a-Service:** + Amazon AWS, Google GCE, Rackspace Cloud and probably, your favorite IaaS. + - **Microsoft Windows** + - **OS X** + +### Docker is Responsible + +*A tool that you can trust.* + +Docker does not just bring you a set of tools to isolate and run +applications. It also allows you to specify constraints and controls on +those resources. + +**This translates to:** + + - Fine tuning available resources for each application; + - Allocating memory or CPU intelligently to make most of your environment; + +Without dealing with complicated commands or third party applications. + +### Docker is Social + +*Docker knows that No One Is an Island.* + +Docker allows you to share the images you've built with the world. And +lots of people have already shared their own images. + +To facilitate this sharing Docker comes with a public registry and index +called the [Docker Index](http://index.docker.io). If you don't want +your images to be public you can also use private images on the Index or +even run your own registry behind your firewall. + +**This translates to:** + + - No more wasting time building everything from scratch; + - Easily and quickly save your application stack; + - Share and benefit from the depth of the Docker community. + +## Docker versus Virtual Machines + +> I suppose it is tempting, if the *only* tool you have is a hammer, to +> treat *everything* as if it were a nail. +> — **_Abraham Maslow_** + +**Docker containers are:** + + - Easy on the resources; + - Extremely light to deal with; + - Do not come with substantial overhead; + - Very easy to work with; + - Agnostic; + - Can work *on* virtual machines; + - Secure and isolated; + - *Artful*, *social*, *fun*, and; + - Powerful sand-boxes. + +**Docker containers are not:** + + - Hardware or OS emulators; + - Resource heavy; + - Platform, software or language dependent. + +## Docker Use Cases + +Docker is a framework. As a result it's flexible and powerful enough to +be used in a lot of different use cases. + +### For developers + + - **Developed with developers in mind:** + Build, test and ship applications with nothing but Docker and lean + containers. + - **Re-usable building blocks to create more:** + Docker images are easily updated building blocks. + - **Automatically build-able:** + It has never been this easy to build - *anything*. + - **Easy to integrate:** + A powerful, fully featured API allows you to integrate Docker into your tooling. + +### For sysadmins + + - **Efficient (and DevOps friendly!) lifecycle:** + Operations and developments are consistent, repeatable and reliable. + - **Balanced environments:** + Processes between development, testing and production are leveled. + - **Improvements on speed and integration:** + Containers are almost nothing more than isolated, secure processes. + - **Lowered costs of infrastructure:** + Containers are lightweight and heavy on resources compared to virtual machines. + - **Portable configurations:** + Issues and overheads with dealing with configurations and systems are eliminated. + +### For everyone + + - **Increased security without performance loss:** + Replacing VMs with containers provide security without additional + hardware (or software). + - **Portable:** + You can easily move applications and workloads from different operating + systems and platforms. + +## Where to go from here + +### Learn about Parts of Docker and the underlying technology + +Visit [Understanding the Technology](technology.md) in our Getting Started manual. + +### Get practical and learn how to use Docker straight away + +Visit [Working with Docker](working-with-docker.md) in our Getting Started manual. + +### Get the product and go hands-on + +Visit [Get Docker](get-docker.md) in our Getting Started manual. + +### Get the whole story + +[https://www.docker.io/the_whole_story/](https://www.docker.io/the_whole_story/) diff --git a/docs/sources/introduction/working-with-docker.md b/docs/sources/introduction/working-with-docker.md new file mode 100644 index 0000000000..f395723d60 --- /dev/null +++ b/docs/sources/introduction/working-with-docker.md @@ -0,0 +1,408 @@ +page_title: Working with Docker and the Dockerfile +page_description: Working with Docker and The Dockerfile explained in depth +page_keywords: docker, introduction, documentation, about, technology, understanding, Dockerfile + +# Working with Docker and the Dockerfile + +*How to use and work with Docker?* + +> **Warning! Don't let this long page bore you.** +> If you prefer a summary and would like to see how a specific command +> works, check out the glossary of all available client +> commands on our [User's Manual: Commands Reference]( +> http://docs.docker.io/en/latest/reference/commandline/cli). + +## Introduction + +On the last page, [Understanding the Technology](technology.md), we covered the +components that make up Docker and learnt about the +underlying technology and *how* everything works. + +Now, it is time to get practical and see *how to work with* the Docker client, +Docker containers and images and the `Dockerfile`. + +> **Note:** You are encouraged to take a good look at the container, +> image and `Dockerfile` explanations here to have a better understanding +> on what exactly they are and to get an overall idea on how to work with +> them. On the next page (i.e., [Get Docker](get-docker.md)), you will be +> able to find links for platform-centric installation instructions. + +## Elements of Docker + +As we mentioned on the, [Understanding the Technology](technology.md) page, the main +elements of Docker are: + + - Containers; + - Images, and; + - The `Dockerfile`. + +> **Note:** This page is more *practical* than *technical*. If you are +> interested in understanding how these tools work behind the scenes +> and do their job, you can always read more on +> [Understanding the Technology](technology.md). + +## Working with the Docker client + +In order to work with the Docker client, you need to have a host with +the Docker daemon installed and running. + +### How to use the client + +The client provides you a command-line interface to Docker. It is +accessed by running the `docker` binary. + +> **Tip:** The below instructions can be considered a summary of our +> *interactive tutorial*. If you prefer a more hands-on approach without +> installing anything, why not give that a shot and check out the +> [Docker Interactive Tutorial](http://www.docker.io/interactivetutorial). + +The `docker` client usage consists of passing a chain of arguments: + + # Usage: [sudo] docker [option] [command] [arguments] .. + # Example: + docker run -i -t ubuntu /bin/bash + +### Our first Docker command + +Let's get started with our first Docker command by checking the +version of the currently installed Docker client using the `docker +version` command. + + # Usage: [sudo] docker version + # Example: + docker version + +This command will not only provide you the version of Docker client you +are using, but also the version of Go (the programming language powering +Docker). + + Client version: 0.8.0 + Go version (client): go1.2 + + Git commit (client): cc3a8c8 + Server version: 0.8.0 + + Git commit (server): cc3a8c8 + Go version (server): go1.2 + + Last stable version: 0.8.0 + +### Finding out all available commands + +The user-centric nature of Docker means providing you a constant stream +of helpful instructions. This begins with the client itself. + +In order to get a full list of available commands run the `docker` +binary: + + # Usage: [sudo] docker + # Example: + docker + +You will get an output with all currently available commands. + + Commands: + attach Attach to a running container + build Build a container from a Dockerfile + commit Create a new image from a container's changes + . . . + +### Command usage instructions + +The same way used to learn all available commands can be repeated to find +out usage instructions for a specific command. + +Try typing Docker followed with a `[command]` to see the instructions: + + # Usage: [sudo] docker [command] [--help] + # Example: + docker attach + Help outputs . . . + +Or you can pass the `--help` flag to the `docker` binary. + + docker images --help + +You will get an output with all available options: + + Usage: docker attach [OPTIONS] CONTAINER + + Attach to a running container + + --no-stdin=false: Do not attach stdin + --sig-proxy=true: Proxify all received signal to the process (even in non-tty mode) + +## Working with images + +### Docker Images + +As we've discovered a Docker image is a read-only template that we build +containers from. Every Docker container is launched from an image and +you can use both images provided by others, for example we've discovered +the base `ubuntu` image provided by Docker, as well as images built by +others. For example we can build an image that runs Apache and our own +web application as a starting point to launch containers. + +### Searching for images + +To search for Docker image we use the `docker search` command. The +`docker search` command returns a list of all images that match your +search criteria together with additional, useful information about that +image. This includes information such as social metrics like how many +other people like the image - we call these "likes" *stars*. We also +tell you if an image is *trusted*. A *trusted* image is built from a +known source and allows you to introspect in greater detail how the +image is constructed. + + # Usage: [sudo] docker search [image name] + # Example: + docker search nginx + + NAME DESCRIPTION STARS OFFICIAL TRUSTED + dockerfile/nginx Trusted Nginx (http://nginx.org/) Build 6 [OK] + paintedfox/nginx-php5 A docker image for running Nginx with PHP5. 3 [OK] + dockerfiles/django-uwsgi-nginx Dockerfile and configuration files to buil... 2 [OK] + . . . + +> **Note:** To learn more about trusted builds, check out [this] +(http://blog.docker.io/2013/11/introducing-trusted-builds) blog post. + +### Downloading an image + +Downloading a Docker image is called *pulling*. To do this we hence use the +`docker pull` command. + + # Usage: [sudo] docker pull [image name] + # Example: + docker pull dockerfile/nginx + + Pulling repository dockerfile/nginx + 0ade68db1d05: Pulling dependent layers + 27cf78414709: Download complete + b750fe79269d: Download complete + . . . + +As you can see, Docker will download, one by one, all the layers forming +the final image. This demonstrates the *building block* philosophy of +Docker. + +### Listing available images + +In order to get a full list of available images, you can use the +`docker images` command. + + # Usage: [sudo] docker images + # Example: + docker images + + REPOSITORY TAG IMAGE ID CREATED VIRTUAL SIZE + myUserName/nginx latest a0d6c70867d2 41 seconds ago 578.8 MB + nginx latest 173c2dd28ab2 3 minutes ago 578.8 MB + dockerfile/nginx latest 0ade68db1d05 3 weeks ago 578.8 MB + +## Working with containers + +### Docker Containers + +Docker containers are directories on your Docker host that are built +from Docker images. In order to create or start a container, you need an +image. This could be the base `ubuntu` image or an image built and +shared with you or an image you've built yourself. + +### Running a new container from an image + +The easiest way to create a new container is to *run* one from an image. + + # Usage: [sudo] docker run [arguments] .. + # Example: + docker run -d --name nginx_web nginx /usr/sbin/nginx + +This will create a new container from an image called `nginx` which will +launch the command `/usr/sbin/nginx` when the container is run. We've +also given our container a name, `nginx_web`. + +Containers can be run in two modes: + +* Interactive; +* Daemonized; + +An interactive container runs in the foreground and you can connect to +it and interact with it. A daemonized container runs in the background. + +A container will run as long as the process you have launched inside it +is running, for example if the `/usr/bin/nginx` process stops running +the container will also stop. + +### Listing containers + +We can see a list of all the containers on our host using the `docker +ps` command. By default the `docker ps` commands only shows running +containers. But we can also add the `-a` flag to show *all* containers - +both running and stopped. + + # Usage: [sudo] docker ps [-a] + # Example: + docker ps + + CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES + 842a50a13032 dockerfile/nginx:latest nginx 35 minutes ago Up 30 minutes 0.0.0.0:80->80/tcp nginx_web + +### Stopping a container + +You can use the `docker stop` command to stop an active container. This will gracefully +end the active process. + + # Usage: [sudo] docker stop [container ID] + # Example: + docker stop nginx_web + nginx_web + +If the `docker stop` command succeeds it will return the name of +the container it has stopped. + +### Starting a Container + +Stopped containers can be started again. + + # Usage: [sudo] docker start [container ID] + # Example: + docker start nginx_web + nginx_web + +If the `docker start` command succeeds it will return the name of the +freshly started container. + +## Working with the Dockerfile + +The `Dockerfile` holds the set of instructions Docker uses to build a Docker image. + +> **Tip:** Below is a short summary of our full Dockerfile tutorial. In +> order to get a better-grasp of how to work with these automation +> scripts, check out the [Dockerfile step-by-step +> tutorial](http://www.docker.io/learn/dockerfile). + +A `Dockerfile` contains instructions written in the following format: + + # Usage: Instruction [arguments / command] .. + # Example: + FROM ubuntu + +A `#` sign is used to provide a comment: + + # Comments .. + +> **Tip:** The `Dockerfile` is very flexible and provides a powerful set +> of instructions for building applications. To learn more about the +> `Dockerfile` and it's instructions see the [Dockerfile +> Reference](http://docs.docker.io/en/latest/reference/builder). + +### First steps with the Dockerfile + +It's a good idea to add some comments to the start of your `Dockerfile` +to provide explanation and exposition to any future consumers, for +example: + + # + # Dockerfile to install Nginx + # VERSION 2 - EDITION 1 + +The first instruction in any `Dockerfile` must be the `FROM` instruction. The `FROM` instruction specifies the image name that this new image is built from, it is often a base image like `ubuntu`. + + # Base image used is Ubuntu: + FROM ubuntu + +Next, we recommend you use the `MAINTAINER` instruction to tell people who manages this image. + + # Maintainer: O.S. Tezer (@ostezer) + MAINTAINER O.S. Tezer, ostezer@gmail.com + +After this we can add additional instructions that represent the steps +to build our actual image. + +### Our Dockerfile so far + +So far our `Dockerfile` will look like. + + # Dockerfile to install Nginx + # VERSION 2 - EDITION 1 + FROM ubuntu + MAINTAINER O.S. Tezer, ostezer@gmail.com + +Let's install a package and configure an application inside our image. To do this we use a new +instruction: `RUN`. The `RUN` instruction executes commands inside our +image, for example. The instruction is just like running a command on +the command line inside a container. + + RUN echo "deb http://archive.ubuntu.com/ubuntu/ raring main universe" >> /etc/apt/sources.list + RUN apt-get update + RUN apt-get install -y nginx + RUN echo "\ndaemon off;" >> /etc/nginx/nginx.conf + +We can see here that we've *run* four instructions. Each time we run an +instruction a new layer is added to our image. Here's we've added an +Ubuntu package repository, updated the packages, installed the `nginx` +package and then echo'ed some configuration to the default +`/etc/nginx/nginx.conf` configuration file. + +Let's specify another instruction, `CMD`, that tells Docker what command +to run when a container is created from this image. + + CMD /usr/sbin/nginx + +We can now save this file and use it build an image. + +### Using a Dockerfile + +Docker uses the `Dockerfile` to build images. The build process is initiated by the `docker build` command. + + # Use the Dockerfile at the current location + # Usage: [sudo] docker build . + # Example: + docker build -t="my_nginx_image" . + + Uploading context 25.09 kB + Uploading context + Step 0 : FROM ubuntu + ---> 9cd978db300e + Step 1 : MAINTAINER O.S. Tezer, ostezer@gmail.com + ---> Using cache + ---> 467542d0cdd3 + Step 2 : RUN echo "deb http://archive.ubuntu.com/ubuntu/ raring main universe" >> /etc/apt/sources.list + ---> Using cache + ---> 0a688bd2a48c + Step 3 : RUN apt-get update + ---> Running in de2937e8915a + . . . + Step 10 : CMD /usr/sbin/nginx + ---> Running in b4908b9b9868 + ---> 626e92c5fab1 + Successfully built 626e92c5fab1 + +Here we can see that Docker has executed each instruction in turn and +each instruction has created a new layer in turn and each layer identified +by a new ID. The `-t` flag allows us to specify a name for our new +image, here `my_nginx_image`. + +We can see our new image using the `docker images` command. + + docker images + REPOSITORY TAG IMAGE ID CREATED VIRTUAL SIZE + my_nginx_img latest 626e92c5fab1 57 seconds ago 337.6 MB + +## Where to go from here + +### Understanding Docker + +Visit [Understanding Docker](understanding-docker.md) in our Getting Started manual. + +### Learn about parts of Docker and the underlying technology + +Visit [Understanding the Technology](technology.md) in our Getting Started manual. + +### Get the product and go hands-on + +Visit [Get Docker](get-docker.md) in our Getting Started manual. + +### Get the whole story + +[https://www.docker.io/the_whole_story/](https://www.docker.io/the_whole_story/) diff --git a/docs/sources/jsearch.md b/docs/sources/jsearch.md new file mode 100644 index 0000000000..0e2def2f70 --- /dev/null +++ b/docs/sources/jsearch.md @@ -0,0 +1,9 @@ +# Search + +
+ + +
+ +
+
diff --git a/docs/sources/reference.md b/docs/sources/reference.md new file mode 100644 index 0000000000..3cd720c551 --- /dev/null +++ b/docs/sources/reference.md @@ -0,0 +1,9 @@ +# Reference Manual + +## Contents: + +- [Commands](commandline/) +- [Dockerfile Reference](builder/) +- [Docker Run Reference](run/) +- [APIs](api/) + diff --git a/docs/sources/reference/api.md b/docs/sources/reference/api.md new file mode 100644 index 0000000000..7afa5250b3 --- /dev/null +++ b/docs/sources/reference/api.md @@ -0,0 +1,100 @@ +# APIs + +Your programs and scripts can access Docker’s functionality via these +interfaces: + +- [Registry & Index Spec](registry_index_spec/) + - [1. The 3 roles](registry_index_spec/#the-3-roles) + - [1.1 Index](registry_index_spec/#index) + - [1.2 Registry](registry_index_spec/#registry) + - [1.3 Docker](registry_index_spec/#docker) + + - [2. Workflow](registry_index_spec/#workflow) + - [2.1 Pull](registry_index_spec/#pull) + - [2.2 Push](registry_index_spec/#push) + - [2.3 Delete](registry_index_spec/#delete) + + - [3. How to use the Registry in standalone + mode](registry_index_spec/#how-to-use-the-registry-in-standalone-mode) + - [3.1 Without an + Index](registry_index_spec/#without-an-index) + - [3.2 With an Index](registry_index_spec/#with-an-index) + + - [4. The API](registry_index_spec/#the-api) + - [4.1 Images](registry_index_spec/#images) + - [4.2 Users](registry_index_spec/#users) + - [4.3 Tags (Registry)](registry_index_spec/#tags-registry) + - [4.4 Images (Index)](registry_index_spec/#images-index) + - [4.5 Repositories](registry_index_spec/#repositories) + + - [5. Chaining + Registries](registry_index_spec/#chaining-registries) + - [6. Authentication & + Authorization](registry_index_spec/#authentication-authorization) + - [6.1 On the Index](registry_index_spec/#on-the-index) + - [6.2 On the Registry](registry_index_spec/#on-the-registry) + + - [7 Document Version](registry_index_spec/#document-version) + +- [Docker Registry API](registry_api/) + - [1. Brief introduction](registry_api/#brief-introduction) + - [2. Endpoints](registry_api/#endpoints) + - [2.1 Images](registry_api/#images) + - [2.2 Tags](registry_api/#tags) + - [2.3 Repositories](registry_api/#repositories) + - [2.4 Status](registry_api/#status) + + - [3 Authorization](registry_api/#authorization) + +- [Docker Index API](index_api/) + - [1. Brief introduction](index_api/#brief-introduction) + - [2. Endpoints](index_api/#endpoints) + - [2.1 Repository](index_api/#repository) + - [2.2 Users](index_api/#users) + - [2.3 Search](index_api/#search) + +- [Docker Remote API](docker_remote_api/) + - [1. Brief introduction](docker_remote_api/#brief-introduction) + - [2. Versions](docker_remote_api/#versions) + - [v1.11](docker_remote_api/#v1-11) + - [v1.10](docker_remote_api/#v1-10) + - [v1.9](docker_remote_api/#v1-9) + - [v1.8](docker_remote_api/#v1-8) + - [v1.7](docker_remote_api/#v1-7) + - [v1.6](docker_remote_api/#v1-6) + - [v1.5](docker_remote_api/#v1-5) + - [v1.4](docker_remote_api/#v1-4) + - [v1.3](docker_remote_api/#v1-3) + - [v1.2](docker_remote_api/#v1-2) + - [v1.1](docker_remote_api/#v1-1) + - [v1.0](docker_remote_api/#v1-0) + +- [Docker Remote API Client Libraries](remote_api_client_libraries/) +- [docker.io OAuth API](docker_io_oauth_api/) + - [1. Brief introduction](docker_io_oauth_api/#brief-introduction) + - [2. Register Your + Application](docker_io_oauth_api/#register-your-application) + - [3. Endpoints](docker_io_oauth_api/#endpoints) + - [3.1 Get an Authorization + Code](docker_io_oauth_api/#get-an-authorization-code) + - [3.2 Get an Access + Token](docker_io_oauth_api/#get-an-access-token) + - [3.3 Refresh a Token](docker_io_oauth_api/#refresh-a-token) + + - [4. Use an Access Token with the + API](docker_io_oauth_api/#use-an-access-token-with-the-api) + +- [docker.io Accounts API](docker_io_accounts_api/) + - [1. Endpoints](docker_io_accounts_api/#endpoints) + - [1.1 Get a single + user](docker_io_accounts_api/#get-a-single-user) + - [1.2 Update a single + user](docker_io_accounts_api/#update-a-single-user) + - [1.3 List email addresses for a + user](docker_io_accounts_api/#list-email-addresses-for-a-user) + - [1.4 Add email address for a + user](docker_io_accounts_api/#add-email-address-for-a-user) + - [1.5 Update an email address for a + user](docker_io_accounts_api/#update-an-email-address-for-a-user) + - [1.6 Delete email address for a + user](docker_io_accounts_api/#delete-email-address-for-a-user) \ No newline at end of file diff --git a/docs/sources/reference/api/archive/docker_remote_api_v1.0.md b/docs/sources/reference/api/archive/docker_remote_api_v1.0.md new file mode 100644 index 0000000000..8f94733584 --- /dev/null +++ b/docs/sources/reference/api/archive/docker_remote_api_v1.0.md @@ -0,0 +1,949 @@ +page_title: Remote API v1.0 +page_description: API Documentation for Docker +page_keywords: API, Docker, rcli, REST, documentation + +# [Docker Remote API v1.0](#id1) + +## [1. Brief introduction](#id2) + +- The Remote API is replacing rcli +- Default port in the docker daemon 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](#id3) + +### [2.1 Containers](#id4) + +#### [List containers](#id5) + + `GET /containers/json` +: List containers + + **Example request**: + + GET /containers/json?all=1&before=8dfafdbc3a40 HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "Id": "8dfafdbc3a40", + "Image": "ubuntu:latest", + "Command": "echo 1", + "Created": 1367854155, + "Status": "Exit 0" + }, + { + "Id": "9cd87474be90", + "Image": "ubuntu:latest", + "Command": "echo 222222", + "Created": 1367854155, + "Status": "Exit 0" + }, + { + "Id": "3176a2479c92", + "Image": "centos:latest", + "Command": "echo 3333333333333333", + "Created": 1367854154, + "Status": "Exit 0" + }, + { + "Id": "4cb07b47f9fb", + "Image": "fedora:latest", + "Command": "echo 444444444444444444444444444444444", + "Created": 1367854152, + "Status": "Exit 0" + } + ] + + Query Parameters: + +   + + - **all** – 1/True/true or 0/False/false, Show all containers. + Only running containers are shown by default + - **limit** – Show `limit` last created + containers, include non-running ones. + - **since** – Show only containers created since Id, include + non-running ones. + - **before** – Show only containers created before Id, include + non-running ones. + + Status Codes: + + - **200** – no error + - **400** – bad parameter + - **500** – server error + +#### [Create a container](#id6) + + `POST /containers/create` +: Create a container + + **Example request**: + + POST /containers/create HTTP/1.1 + Content-Type: application/json + + { + "Hostname":"", + "User":"", + "Memory":0, + "MemorySwap":0, + "AttachStdin":false, + "AttachStdout":true, + "AttachStderr":true, + "PortSpecs":null, + "Tty":false, + "OpenStdin":false, + "StdinOnce":false, + "Env":null, + "Cmd":[ + "date" + ], + "Dns":null, + "Image":"ubuntu", + "Volumes":{}, + "VolumesFrom":"" + } + + **Example response**: + + HTTP/1.1 201 OK + Content-Type: application/json + + { + "Id":"e90e34656806" + "Warnings":[] + } + + Json Parameters: + +   + + - **config** – the container’s configuration + + Status Codes: + + - **201** – no error + - **404** – no such container + - **406** – impossible to attach (container not running) + - **500** – server error + +#### [Inspect a container](#id7) + + `GET /containers/`(*id*)`/json` +: Return low-level information on the container `id` + + + **Example request**: + + GET /containers/4fa6e0f0c678/json HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "Id": "4fa6e0f0c6786287e131c3852c58a2e01cc697a68231826813597e4994f1d6e2", + "Created": "2013-05-07T14:51:42.041847+02:00", + "Path": "date", + "Args": [], + "Config": { + "Hostname": "4fa6e0f0c678", + "User": "", + "Memory": 0, + "MemorySwap": 0, + "AttachStdin": false, + "AttachStdout": true, + "AttachStderr": true, + "PortSpecs": null, + "Tty": false, + "OpenStdin": false, + "StdinOnce": false, + "Env": null, + "Cmd": [ + "date" + ], + "Dns": null, + "Image": "ubuntu", + "Volumes": {}, + "VolumesFrom": "" + }, + "State": { + "Running": false, + "Pid": 0, + "ExitCode": 0, + "StartedAt": "2013-05-07T14:51:42.087658+02:01360", + "Ghost": false + }, + "Image": "b750fe79269d2ec9a3c593ef05b4332b1d1a02a62b4accb2c21d589ff2f5f2dc", + "NetworkSettings": { + "IpAddress": "", + "IpPrefixLen": 0, + "Gateway": "", + "Bridge": "", + "PortMapping": null + }, + "SysInitPath": "/home/kitty/go/src/github.com/dotcloud/docker/bin/docker", + "ResolvConfPath": "/etc/resolv.conf", + "Volumes": {} + } + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### [Inspect changes on a container’s filesystem](#id8) + + `GET /containers/`(*id*)`/changes` +: Inspect changes on container `id` ‘s filesystem + + **Example request**: + + GET /containers/4fa6e0f0c678/changes HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "Path":"/dev", + "Kind":0 + }, + { + "Path":"/dev/kmsg", + "Kind":1 + }, + { + "Path":"/test", + "Kind":1 + } + ] + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### [Export a container](#id9) + + `GET /containers/`(*id*)`/export` +: Export the contents of container `id` + + **Example request**: + + GET /containers/4fa6e0f0c678/export HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/octet-stream + + {{ STREAM }} + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### [Start a container](#id10) + + `POST /containers/`(*id*)`/start` +: Start the container `id` + + **Example request**: + + POST /containers/e90e34656806/start HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### [Stop a container](#id11) + + `POST /containers/`(*id*)`/stop` +: Stop the container `id` + + **Example request**: + + POST /containers/e90e34656806/stop?t=5 HTTP/1.1 + + **Example response**: + + HTTP/1.1 204 OK + + Query Parameters: + +   + + - **t** – number of seconds to wait before killing the container + + Status Codes: + + - **204** – no error + - **404** – no such container + - **500** – server error + +#### [Restart a container](#id12) + + `POST /containers/`(*id*)`/restart` +: Restart the container `id` + + **Example request**: + + POST /containers/e90e34656806/restart?t=5 HTTP/1.1 + + **Example response**: + + HTTP/1.1 204 OK + + Query Parameters: + +   + + - **t** – number of seconds to wait before killing the container + + Status Codes: + + - **204** – no error + - **404** – no such container + - **500** – server error + +#### [Kill a container](#id13) + + `POST /containers/`(*id*)`/kill` +: Kill the container `id` + + **Example request**: + + POST /containers/e90e34656806/kill HTTP/1.1 + + **Example response**: + + HTTP/1.1 204 OK + + Status Codes: + + - **204** – no error + - **404** – no such container + - **500** – server error + +#### [Attach to a container](#id14) + + `POST /containers/`(*id*)`/attach` +: Attach to the container `id` + + **Example request**: + + POST /containers/16253994b7c4/attach?logs=1&stream=0&stdout=1 HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/vnd.docker.raw-stream + + {{ STREAM }} + + Query Parameters: + +   + + - **logs** – 1/True/true or 0/False/false, return logs. Default + false + - **stream** – 1/True/true or 0/False/false, return stream. + Default false + - **stdin** – 1/True/true or 0/False/false, if stream=true, attach + to stdin. Default false + - **stdout** – 1/True/true or 0/False/false, if logs=true, return + stdout log, if stream=true, attach to stdout. Default false + - **stderr** – 1/True/true or 0/False/false, if logs=true, return + stderr log, if stream=true, attach to stderr. Default false + + Status Codes: + + - **200** – no error + - **400** – bad parameter + - **404** – no such container + - **500** – server error + +#### [Wait a container](#id15) + + `POST /containers/`(*id*)`/wait` +: Block until container `id` stops, then returns + the exit code + + **Example request**: + + POST /containers/16253994b7c4/wait HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {"StatusCode":0} + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### [Remove a container](#id16) + + `DELETE /containers/`(*id*) +: Remove the container `id` from the filesystem + + **Example request**: + + DELETE /containers/16253994b7c4?v=1 HTTP/1.1 + + **Example response**: + + HTTP/1.1 204 OK + + Query Parameters: + +   + + - **v** – 1/True/true or 0/False/false, Remove the volumes + associated to the container. Default false + + Status Codes: + + - **204** – no error + - **400** – bad parameter + - **404** – no such container + - **500** – server error + +### [2.2 Images](#id17) + +#### [List Images](#id18) + + `GET /images/`(*format*) +: List images `format` could be json or viz (json + default) + + **Example request**: + + GET /images/json?all=0 HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "Repository":"ubuntu", + "Tag":"precise", + "Id":"b750fe79269d", + "Created":1364102658 + }, + { + "Repository":"ubuntu", + "Tag":"12.04", + "Id":"b750fe79269d", + "Created":1364102658 + } + ] + + **Example request**: + + GET /images/viz HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: text/plain + + digraph docker { + "d82cbacda43a" -> "074be284591f" + "1496068ca813" -> "08306dc45919" + "08306dc45919" -> "0e7893146ac2" + "b750fe79269d" -> "1496068ca813" + base -> "27cf78414709" [style=invis] + "f71189fff3de" -> "9a33b36209ed" + "27cf78414709" -> "b750fe79269d" + "0e7893146ac2" -> "d6434d954665" + "d6434d954665" -> "d82cbacda43a" + base -> "e9aa60c60128" [style=invis] + "074be284591f" -> "f71189fff3de" + "b750fe79269d" [label="b750fe79269d\nubuntu",shape=box,fillcolor="paleturquoise",style="filled,rounded"]; + "e9aa60c60128" [label="e9aa60c60128\ncentos",shape=box,fillcolor="paleturquoise",style="filled,rounded"]; + "9a33b36209ed" [label="9a33b36209ed\nfedora",shape=box,fillcolor="paleturquoise",style="filled,rounded"]; + base [style=invisible] + } + + Query Parameters: + +   + + - **all** – 1/True/true or 0/False/false, Show all containers. + Only running containers are shown by default + + Status Codes: + + - **200** – no error + - **400** – bad parameter + - **500** – server error + +#### [Create an image](#id19) + + `POST /images/create` +: Create an image, either by pull it from the registry or by importing + it + + **Example request**: + + POST /images/create?fromImage=ubuntu HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/vnd.docker.raw-stream + + {{ STREAM }} + + Query Parameters: + +   + + - **fromImage** – name of the image to pull + - **fromSrc** – source to import, - means stdin + - **repo** – repository + - **tag** – tag + - **registry** – the registry to pull from + + Status Codes: + + - **200** – no error + - **500** – server error + +#### [Insert a file in an image](#id20) + + `POST /images/`(*name*)`/insert` +: Insert a file from `url` in the image + `name` at `path` + + **Example request**: + + POST /images/test/insert?path=/usr&url=myurl HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + + {{ STREAM }} + + Status Codes: + + - **200** – no error + - **500** – server error + +#### [Inspect an image](#id21) + + `GET /images/`(*name*)`/json` +: Return low-level information on the image `name` + + **Example request**: + + GET /images/centos/json HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "id":"b750fe79269d2ec9a3c593ef05b4332b1d1a02a62b4accb2c21d589ff2f5f2dc", + "parent":"27cf784147099545", + "created":"2013-03-23T22:24:18.818426-07:00", + "container":"3d67245a8d72ecf13f33dffac9f79dcdf70f75acb84d308770391510e0c23ad0", + "container_config": + { + "Hostname":"", + "User":"", + "Memory":0, + "MemorySwap":0, + "AttachStdin":false, + "AttachStdout":false, + "AttachStderr":false, + "PortSpecs":null, + "Tty":true, + "OpenStdin":true, + "StdinOnce":false, + "Env":null, + "Cmd": ["/bin/bash"] + ,"Dns":null, + "Image":"centos", + "Volumes":null, + "VolumesFrom":"" + } + } + + Status Codes: + + - **200** – no error + - **404** – no such image + - **500** – server error + +#### [Get the history of an image](#id22) + + `GET /images/`(*name*)`/history` +: Return the history of the image `name` + + **Example request**: + + GET /images/fedora/history HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "Id":"b750fe79269d", + "Created":1364102658, + "CreatedBy":"/bin/bash" + }, + { + "Id":"27cf78414709", + "Created":1364068391, + "CreatedBy":"" + } + ] + + Status Codes: + + - **200** – no error + - **404** – no such image + - **500** – server error + +#### [Push an image on the registry](#id23) + + `POST /images/`(*name*)`/push` +: Push the image `name` on the registry + + > **Example request**: + > + > POST /images/test/push HTTP/1.1 + > + > **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/vnd.docker.raw-stream + + {{ STREAM }} + + Query Parameters: + +   + + - **registry** – the registry you wan to push, optional + + Status Codes: + + - **200** – no error + - **404** – no such image + - **500** – server error + +#### [Tag an image into a repository](#id24) + + `POST /images/`(*name*)`/tag` +: Tag the image `name` into a repository + + **Example request**: + + POST /images/test/tag?repo=myrepo&force=0 HTTP/1.1 + + **Example response**: + + HTTP/1.1 201 OK + + Query Parameters: + +   + + - **repo** – The repository to tag in + - **force** – 1/True/true or 0/False/false, default false + + Status Codes: + + - **201** – no error + - **400** – bad parameter + - **404** – no such image + - **500** – server error + +#### [Remove an image](#id25) + + `DELETE /images/`(*name*) +: Remove the image `name` from the filesystem + + **Example request**: + + DELETE /images/test HTTP/1.1 + + **Example response**: + + HTTP/1.1 204 OK + + Status Codes: + + - **204** – no error + - **404** – no such image + - **500** – server error + +#### [Search images](#id26) + + `GET /images/search` +: Search for an image in the docker index + + **Example request**: + + GET /images/search?term=sshd HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "Name":"cespare/sshd", + "Description":"" + }, + { + "Name":"johnfuller/sshd", + "Description":"" + }, + { + "Name":"dhrp/mongodb-sshd", + "Description":"" + } + ] + + :query term: term to search + :statuscode 200: no error + :statuscode 500: server error + +### [2.3 Misc](#id27) + +#### [Build an image from Dockerfile via stdin](#id28) + + `POST /build` +: Build an image from Dockerfile via stdin + + **Example request**: + + POST /build HTTP/1.1 + + {{ STREAM }} + + **Example response**: + + HTTP/1.1 200 OK + + {{ STREAM }} + + Query Parameters: + +   + + - **t** – repository name to be applied to the resulting image in + case of success + + Status Codes: + + - **200** – no error + - **500** – server error + +#### [Get default username and email](#id29) + + `GET /auth` +: Get the default username and email + + **Example request**: + + GET /auth HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "username":"hannibal", + "email":"hannibal@a-team.com" + } + + Status Codes: + + - **200** – no error + - **500** – server error + +#### [Check auth configuration and store it](#id30) + + `POST /auth` +: Get the default username and email + + **Example request**: + + POST /auth HTTP/1.1 + Content-Type: application/json + + { + "username":"hannibal", + "password:"xxxx", + "email":"hannibal@a-team.com" + } + + **Example response**: + + HTTP/1.1 200 OK + + Status Codes: + + - **200** – no error + - **204** – no error + - **500** – server error + +#### [Display system-wide information](#id31) + + `GET /info` +: Display system-wide information + + **Example request**: + + GET /info HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "Containers":11, + "Images":16, + "Debug":false, + "NFd": 11, + "NGoroutines":21, + "MemoryLimit":true, + "SwapLimit":false + } + + Status Codes: + + - **200** – no error + - **500** – server error + +#### [Show the docker version information](#id32) + + `GET /version` +: Show the docker version information + + **Example request**: + + GET /version HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "Version":"0.2.2", + "GitCommit":"5a2a5cc+CHANGES", + "GoVersion":"go1.0.3" + } + + Status Codes: + + - **200** – no error + - **500** – server error + +#### [Create a new image from a container’s changes](#id33) + + `POST /commit` +: Create a new image from a container’s changes + > + > **Example request**: + + POST /commit?container=44c004db4b17&m=message&repo=myrepo HTTP/1.1 + Content-Type: application/json + + { + "Cmd": ["cat", "/world"], + "PortSpecs":["22"] + } + + **Example response**: + + HTTP/1.1 201 OK + Content-Type: application/vnd.docker.raw-stream + + {"Id":"596069db4bf5"} + + Query Parameters: + +   + + - **container** – source container + - **repo** – repository + - **tag** – tag + - **m** – commit message + - **author** – author (eg. "John Hannibal Smith + \<[hannibal@a-team.com](mailto:hannibal%40a-team.com)\>") + + Status Codes: + + - **201** – no error + - **404** – no such container + - **500** – server error + +## [3. Going further](#id34) + +### [3.1 Inside ‘docker run’](#id35) + +Here are the steps of ‘docker run’ : + +- Create the container + +- If the status code is 404, it means the image doesn’t exists: + : - Try to pull it + - Then retry to create the container + +- Start the container + +- If you are not in detached mode: + : - Attach to the container, using logs=1 (to have stdout and + stderr from the container’s start) and stream=1 + +- If in detached mode or only stdin is attached: + : - Display the container’s id + +### [3.2 Hijacking](#id36) + +In this first version of the API, some of the endpoints, like /attach, +/pull or /push uses hijacking to transport stdin, stdout and stderr on +the same socket. This might change in the future. diff --git a/docs/sources/reference/api/docker_remote_api_v1.0.rst b/docs/sources/reference/api/archive/docker_remote_api_v1.0.rst similarity index 100% rename from docs/sources/reference/api/docker_remote_api_v1.0.rst rename to docs/sources/reference/api/archive/docker_remote_api_v1.0.rst diff --git a/docs/sources/reference/api/archive/docker_remote_api_v1.1.md b/docs/sources/reference/api/archive/docker_remote_api_v1.1.md new file mode 100644 index 0000000000..71d2f91d37 --- /dev/null +++ b/docs/sources/reference/api/archive/docker_remote_api_v1.1.md @@ -0,0 +1,959 @@ +page_title: Remote API v1.1 +page_description: API Documentation for Docker +page_keywords: API, Docker, rcli, REST, documentation + +# [Docker Remote API v1.1](#id1) + +## [1. Brief introduction](#id2) + +- The Remote API is replacing rcli +- Default port in the docker daemon 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](#id3) + +### [2.1 Containers](#id4) + +#### [List containers](#id5) + + `GET /containers/json` +: List containers + + **Example request**: + + GET /containers/json?all=1&before=8dfafdbc3a40 HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "Id": "8dfafdbc3a40", + "Image": "ubuntu:latest", + "Command": "echo 1", + "Created": 1367854155, + "Status": "Exit 0" + }, + { + "Id": "9cd87474be90", + "Image": "ubuntu:latest", + "Command": "echo 222222", + "Created": 1367854155, + "Status": "Exit 0" + }, + { + "Id": "3176a2479c92", + "Image": "centos:latest", + "Command": "echo 3333333333333333", + "Created": 1367854154, + "Status": "Exit 0" + }, + { + "Id": "4cb07b47f9fb", + "Image": "fedora:latest", + "Command": "echo 444444444444444444444444444444444", + "Created": 1367854152, + "Status": "Exit 0" + } + ] + + Query Parameters: + +   + + - **all** – 1/True/true or 0/False/false, Show all containers. + Only running containers are shown by default + - **limit** – Show `limit` last created + containers, include non-running ones. + - **since** – Show only containers created since Id, include + non-running ones. + - **before** – Show only containers created before Id, include + non-running ones. + + Status Codes: + + - **200** – no error + - **400** – bad parameter + - **500** – server error + +#### [Create a container](#id6) + + `POST /containers/create` +: Create a container + + **Example request**: + + POST /containers/create HTTP/1.1 + Content-Type: application/json + + { + "Hostname":"", + "User":"", + "Memory":0, + "MemorySwap":0, + "AttachStdin":false, + "AttachStdout":true, + "AttachStderr":true, + "PortSpecs":null, + "Tty":false, + "OpenStdin":false, + "StdinOnce":false, + "Env":null, + "Cmd":[ + "date" + ], + "Dns":null, + "Image":"ubuntu", + "Volumes":{}, + "VolumesFrom":"" + } + + **Example response**: + + HTTP/1.1 201 OK + Content-Type: application/json + + { + "Id":"e90e34656806" + "Warnings":[] + } + + Json Parameters: + +   + + - **config** – the container’s configuration + + Status Codes: + + - **201** – no error + - **404** – no such container + - **406** – impossible to attach (container not running) + - **500** – server error + +#### [Inspect a container](#id7) + + `GET /containers/`(*id*)`/json` +: Return low-level information on the container `id` + + + **Example request**: + + GET /containers/4fa6e0f0c678/json HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "Id": "4fa6e0f0c6786287e131c3852c58a2e01cc697a68231826813597e4994f1d6e2", + "Created": "2013-05-07T14:51:42.041847+02:00", + "Path": "date", + "Args": [], + "Config": { + "Hostname": "4fa6e0f0c678", + "User": "", + "Memory": 0, + "MemorySwap": 0, + "AttachStdin": false, + "AttachStdout": true, + "AttachStderr": true, + "PortSpecs": null, + "Tty": false, + "OpenStdin": false, + "StdinOnce": false, + "Env": null, + "Cmd": [ + "date" + ], + "Dns": null, + "Image": "ubuntu", + "Volumes": {}, + "VolumesFrom": "" + }, + "State": { + "Running": false, + "Pid": 0, + "ExitCode": 0, + "StartedAt": "2013-05-07T14:51:42.087658+02:01360", + "Ghost": false + }, + "Image": "b750fe79269d2ec9a3c593ef05b4332b1d1a02a62b4accb2c21d589ff2f5f2dc", + "NetworkSettings": { + "IpAddress": "", + "IpPrefixLen": 0, + "Gateway": "", + "Bridge": "", + "PortMapping": null + }, + "SysInitPath": "/home/kitty/go/src/github.com/dotcloud/docker/bin/docker", + "ResolvConfPath": "/etc/resolv.conf", + "Volumes": {} + } + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### [Inspect changes on a container’s filesystem](#id8) + + `GET /containers/`(*id*)`/changes` +: Inspect changes on container `id` ‘s filesystem + + **Example request**: + + GET /containers/4fa6e0f0c678/changes HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "Path":"/dev", + "Kind":0 + }, + { + "Path":"/dev/kmsg", + "Kind":1 + }, + { + "Path":"/test", + "Kind":1 + } + ] + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### [Export a container](#id9) + + `GET /containers/`(*id*)`/export` +: Export the contents of container `id` + + **Example request**: + + GET /containers/4fa6e0f0c678/export HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/octet-stream + + {{ STREAM }} + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### [Start a container](#id10) + + `POST /containers/`(*id*)`/start` +: Start the container `id` + + **Example request**: + + POST /containers/e90e34656806/start HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### [Stop a container](#id11) + + `POST /containers/`(*id*)`/stop` +: Stop the container `id` + + **Example request**: + + POST /containers/e90e34656806/stop?t=5 HTTP/1.1 + + **Example response**: + + HTTP/1.1 204 OK + + Query Parameters: + +   + + - **t** – number of seconds to wait before killing the container + + Status Codes: + + - **204** – no error + - **404** – no such container + - **500** – server error + +#### [Restart a container](#id12) + + `POST /containers/`(*id*)`/restart` +: Restart the container `id` + + **Example request**: + + POST /containers/e90e34656806/restart?t=5 HTTP/1.1 + + **Example response**: + + HTTP/1.1 204 OK + + Query Parameters: + +   + + - **t** – number of seconds to wait before killing the container + + Status Codes: + + - **204** – no error + - **404** – no such container + - **500** – server error + +#### [Kill a container](#id13) + + `POST /containers/`(*id*)`/kill` +: Kill the container `id` + + **Example request**: + + POST /containers/e90e34656806/kill HTTP/1.1 + + **Example response**: + + HTTP/1.1 204 OK + + Status Codes: + + - **204** – no error + - **404** – no such container + - **500** – server error + +#### [Attach to a container](#id14) + + `POST /containers/`(*id*)`/attach` +: Attach to the container `id` + + **Example request**: + + POST /containers/16253994b7c4/attach?logs=1&stream=0&stdout=1 HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/vnd.docker.raw-stream + + {{ STREAM }} + + Query Parameters: + +   + + - **logs** – 1/True/true or 0/False/false, return logs. Default + false + - **stream** – 1/True/true or 0/False/false, return stream. + Default false + - **stdin** – 1/True/true or 0/False/false, if stream=true, attach + to stdin. Default false + - **stdout** – 1/True/true or 0/False/false, if logs=true, return + stdout log, if stream=true, attach to stdout. Default false + - **stderr** – 1/True/true or 0/False/false, if logs=true, return + stderr log, if stream=true, attach to stderr. Default false + + Status Codes: + + - **200** – no error + - **400** – bad parameter + - **404** – no such container + - **500** – server error + +#### [Wait a container](#id15) + + `POST /containers/`(*id*)`/wait` +: Block until container `id` stops, then returns + the exit code + + **Example request**: + + POST /containers/16253994b7c4/wait HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {"StatusCode":0} + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### [Remove a container](#id16) + + `DELETE /containers/`(*id*) +: Remove the container `id` from the filesystem + + **Example request**: + + DELETE /containers/16253994b7c4?v=1 HTTP/1.1 + + **Example response**: + + HTTP/1.1 204 OK + + Query Parameters: + +   + + - **v** – 1/True/true or 0/False/false, Remove the volumes + associated to the container. Default false + + Status Codes: + + - **204** – no error + - **400** – bad parameter + - **404** – no such container + - **500** – server error + +### [2.2 Images](#id17) + +#### [List Images](#id18) + + `GET /images/`(*format*) +: List images `format` could be json or viz (json + default) + + **Example request**: + + GET /images/json?all=0 HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "Repository":"ubuntu", + "Tag":"precise", + "Id":"b750fe79269d", + "Created":1364102658 + }, + { + "Repository":"ubuntu", + "Tag":"12.04", + "Id":"b750fe79269d", + "Created":1364102658 + } + ] + + **Example request**: + + GET /images/viz HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: text/plain + + digraph docker { + "d82cbacda43a" -> "074be284591f" + "1496068ca813" -> "08306dc45919" + "08306dc45919" -> "0e7893146ac2" + "b750fe79269d" -> "1496068ca813" + base -> "27cf78414709" [style=invis] + "f71189fff3de" -> "9a33b36209ed" + "27cf78414709" -> "b750fe79269d" + "0e7893146ac2" -> "d6434d954665" + "d6434d954665" -> "d82cbacda43a" + base -> "e9aa60c60128" [style=invis] + "074be284591f" -> "f71189fff3de" + "b750fe79269d" [label="b750fe79269d\nubuntu",shape=box,fillcolor="paleturquoise",style="filled,rounded"]; + "e9aa60c60128" [label="e9aa60c60128\ncentos",shape=box,fillcolor="paleturquoise",style="filled,rounded"]; + "9a33b36209ed" [label="9a33b36209ed\nfedora",shape=box,fillcolor="paleturquoise",style="filled,rounded"]; + base [style=invisible] + } + + Query Parameters: + +   + + - **all** – 1/True/true or 0/False/false, Show all containers. + Only running containers are shown by default + + Status Codes: + + - **200** – no error + - **400** – bad parameter + - **500** – server error + +#### [Create an image](#id19) + + `POST /images/create` +: Create an image, either by pull it from the registry or by importing + it + + **Example request**: + + POST /images/create?fromImage=ubuntu HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {"status":"Pulling..."} + {"status":"Pulling", "progress":"1/? (n/a)"} + {"error":"Invalid..."} + ... + + Query Parameters: + +   + + - **fromImage** – name of the image to pull + - **fromSrc** – source to import, - means stdin + - **repo** – repository + - **tag** – tag + - **registry** – the registry to pull from + + Status Codes: + + - **200** – no error + - **500** – server error + +#### [Insert a file in an image](#id20) + + `POST /images/`(*name*)`/insert` +: Insert a file from `url` in the image + `name` at `path` + + **Example request**: + + POST /images/test/insert?path=/usr&url=myurl HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {"status":"Inserting..."} + {"status":"Inserting", "progress":"1/? (n/a)"} + {"error":"Invalid..."} + ... + + Status Codes: + + - **200** – no error + - **500** – server error + +#### [Inspect an image](#id21) + + `GET /images/`(*name*)`/json` +: Return low-level information on the image `name` + + **Example request**: + + GET /images/centos/json HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "id":"b750fe79269d2ec9a3c593ef05b4332b1d1a02a62b4accb2c21d589ff2f5f2dc", + "parent":"27cf784147099545", + "created":"2013-03-23T22:24:18.818426-07:00", + "container":"3d67245a8d72ecf13f33dffac9f79dcdf70f75acb84d308770391510e0c23ad0", + "container_config": + { + "Hostname":"", + "User":"", + "Memory":0, + "MemorySwap":0, + "AttachStdin":false, + "AttachStdout":false, + "AttachStderr":false, + "PortSpecs":null, + "Tty":true, + "OpenStdin":true, + "StdinOnce":false, + "Env":null, + "Cmd": ["/bin/bash"] + ,"Dns":null, + "Image":"centos", + "Volumes":null, + "VolumesFrom":"" + } + } + + Status Codes: + + - **200** – no error + - **404** – no such image + - **500** – server error + +#### [Get the history of an image](#id22) + + `GET /images/`(*name*)`/history` +: Return the history of the image `name` + + **Example request**: + + GET /images/fedora/history HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "Id":"b750fe79269d", + "Created":1364102658, + "CreatedBy":"/bin/bash" + }, + { + "Id":"27cf78414709", + "Created":1364068391, + "CreatedBy":"" + } + ] + + Status Codes: + + - **200** – no error + - **404** – no such image + - **500** – server error + +#### [Push an image on the registry](#id23) + + `POST /images/`(*name*)`/push` +: Push the image `name` on the registry + + > **Example request**: + > + > POST /images/test/push HTTP/1.1 + > + > **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {"status":"Pushing..."} + {"status":"Pushing", "progress":"1/? (n/a)"} + {"error":"Invalid..."} + ... + + Query Parameters: + +   + + - **registry** – the registry you wan to push, optional + + Status Codes: + + - **200** – no error + - **404** – no such image + - **500** – server error + +#### [Tag an image into a repository](#id24) + + `POST /images/`(*name*)`/tag` +: Tag the image `name` into a repository + + **Example request**: + + POST /images/test/tag?repo=myrepo&force=0 HTTP/1.1 + + **Example response**: + + HTTP/1.1 201 OK + + Query Parameters: + +   + + - **repo** – The repository to tag in + - **force** – 1/True/true or 0/False/false, default false + + Status Codes: + + - **201** – no error + - **400** – bad parameter + - **404** – no such image + - **409** – conflict + - **500** – server error + +#### [Remove an image](#id25) + + `DELETE /images/`(*name*) +: Remove the image `name` from the filesystem + + **Example request**: + + DELETE /images/test HTTP/1.1 + + **Example response**: + + HTTP/1.1 204 OK + + Status Codes: + + - **204** – no error + - **404** – no such image + - **500** – server error + +#### [Search images](#id26) + + `GET /images/search` +: Search for an image in the docker index + + **Example request**: + + GET /images/search?term=sshd HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "Name":"cespare/sshd", + "Description":"" + }, + { + "Name":"johnfuller/sshd", + "Description":"" + }, + { + "Name":"dhrp/mongodb-sshd", + "Description":"" + } + ] + + :query term: term to search + :statuscode 200: no error + :statuscode 500: server error + +### [2.3 Misc](#id27) + +#### [Build an image from Dockerfile via stdin](#id28) + + `POST /build` +: Build an image from Dockerfile via stdin + + **Example request**: + + POST /build HTTP/1.1 + + {{ STREAM }} + + **Example response**: + + HTTP/1.1 200 OK + + {{ STREAM }} + + Query Parameters: + +   + + - **t** – tag to be applied to the resulting image in case of + success + + Status Codes: + + - **200** – no error + - **500** – server error + +#### [Get default username and email](#id29) + + `GET /auth` +: Get the default username and email + + **Example request**: + + GET /auth HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "username":"hannibal", + "email":"hannibal@a-team.com" + } + + Status Codes: + + - **200** – no error + - **500** – server error + +#### [Check auth configuration and store it](#id30) + + `POST /auth` +: Get the default username and email + + **Example request**: + + POST /auth HTTP/1.1 + Content-Type: application/json + + { + "username":"hannibal", + "password:"xxxx", + "email":"hannibal@a-team.com" + } + + **Example response**: + + HTTP/1.1 200 OK + + Status Codes: + + - **200** – no error + - **204** – no error + - **500** – server error + +#### [Display system-wide information](#id31) + + `GET /info` +: Display system-wide information + + **Example request**: + + GET /info HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "Containers":11, + "Images":16, + "Debug":false, + "NFd": 11, + "NGoroutines":21, + "MemoryLimit":true, + "SwapLimit":false + } + + Status Codes: + + - **200** – no error + - **500** – server error + +#### [Show the docker version information](#id32) + + `GET /version` +: Show the docker version information + + **Example request**: + + GET /version HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "Version":"0.2.2", + "GitCommit":"5a2a5cc+CHANGES", + "GoVersion":"go1.0.3" + } + + Status Codes: + + - **200** – no error + - **500** – server error + +#### [Create a new image from a container’s changes](#id33) + + `POST /commit` +: Create a new image from a container’s changes + + **Example request**: + + POST /commit?container=44c004db4b17&m=message&repo=myrepo HTTP/1.1 + Content-Type: application/json + + { + "Cmd": ["cat", "/world"], + "PortSpecs":["22"] + } + + **Example response**: + + HTTP/1.1 201 OK + Content-Type: application/vnd.docker.raw-stream + + {"Id":"596069db4bf5"} + + Query Parameters: + +   + + - **container** – source container + - **repo** – repository + - **tag** – tag + - **m** – commit message + - **author** – author (eg. "John Hannibal Smith + \<[hannibal@a-team.com](mailto:hannibal%40a-team.com)\>") + + Status Codes: + + - **201** – no error + - **404** – no such container + - **500** – server error + +## [3. Going further](#id34) + +### [3.1 Inside ‘docker run’](#id35) + +Here are the steps of ‘docker run’ : + +- Create the container + +- If the status code is 404, it means the image doesn’t exists: + : - Try to pull it + - Then retry to create the container + +- Start the container + +- If you are not in detached mode: + : - Attach to the container, using logs=1 (to have stdout and + stderr from the container’s start) and stream=1 + +- If in detached mode or only stdin is attached: + : - Display the container’s id + +### [3.2 Hijacking](#id36) + +In this version of the API, /attach uses hijacking to transport stdin, +stdout and stderr on the same socket. This might change in the future. diff --git a/docs/sources/reference/api/docker_remote_api_v1.1.rst b/docs/sources/reference/api/archive/docker_remote_api_v1.1.rst similarity index 100% rename from docs/sources/reference/api/docker_remote_api_v1.1.rst rename to docs/sources/reference/api/archive/docker_remote_api_v1.1.rst diff --git a/docs/sources/reference/api/archive/docker_remote_api_v1.2.md b/docs/sources/reference/api/archive/docker_remote_api_v1.2.md new file mode 100644 index 0000000000..0239de6681 --- /dev/null +++ b/docs/sources/reference/api/archive/docker_remote_api_v1.2.md @@ -0,0 +1,981 @@ +page_title: Remote API v1.2 +page_description: API Documentation for Docker +page_keywords: API, Docker, rcli, REST, documentation + +# [Docker Remote API v1.2](#id1) + +## [1. Brief introduction](#id2) + +- The Remote API is replacing rcli +- Default port in the docker daemon 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](#id3) + +### [2.1 Containers](#id4) + +#### [List containers](#id5) + + `GET /containers/json` +: List containers + + **Example request**: + + GET /containers/json?all=1&before=8dfafdbc3a40 HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "Id": "8dfafdbc3a40", + "Image": "ubuntu:latest", + "Command": "echo 1", + "Created": 1367854155, + "Status": "Exit 0", + "Ports":"", + "SizeRw":12288, + "SizeRootFs":0 + }, + { + "Id": "9cd87474be90", + "Image": "ubuntu:latest", + "Command": "echo 222222", + "Created": 1367854155, + "Status": "Exit 0", + "Ports":"", + "SizeRw":12288, + "SizeRootFs":0 + }, + { + "Id": "3176a2479c92", + "Image": "centos:latest", + "Command": "echo 3333333333333333", + "Created": 1367854154, + "Status": "Exit 0", + "Ports":"", + "SizeRw":12288, + "SizeRootFs":0 + }, + { + "Id": "4cb07b47f9fb", + "Image": "fedora:latest", + "Command": "echo 444444444444444444444444444444444", + "Created": 1367854152, + "Status": "Exit 0", + "Ports":"", + "SizeRw":12288, + "SizeRootFs":0 + } + ] + + Query Parameters: + +   + + - **all** – 1/True/true or 0/False/false, Show all containers. + Only running containers are shown by default + - **limit** – Show `limit` last created + containers, include non-running ones. + - **since** – Show only containers created since Id, include + non-running ones. + - **before** – Show only containers created before Id, include + non-running ones. + + Status Codes: + + - **200** – no error + - **400** – bad parameter + - **500** – server error + +#### [Create a container](#id6) + + `POST /containers/create` +: Create a container + + **Example request**: + + POST /containers/create HTTP/1.1 + Content-Type: application/json + + { + "Hostname":"", + "User":"", + "Memory":0, + "MemorySwap":0, + "AttachStdin":false, + "AttachStdout":true, + "AttachStderr":true, + "PortSpecs":null, + "Tty":false, + "OpenStdin":false, + "StdinOnce":false, + "Env":null, + "Cmd":[ + "date" + ], + "Dns":null, + "Image":"ubuntu", + "Volumes":{}, + "VolumesFrom":"" + } + + **Example response**: + + HTTP/1.1 201 OK + Content-Type: application/json + + { + "Id":"e90e34656806" + "Warnings":[] + } + + Json Parameters: + +   + + - **config** – the container’s configuration + + Status Codes: + + - **201** – no error + - **404** – no such container + - **406** – impossible to attach (container not running) + - **500** – server error + +#### [Inspect a container](#id7) + + `GET /containers/`(*id*)`/json` +: Return low-level information on the container `id` + + + **Example request**: + + GET /containers/4fa6e0f0c678/json HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "Id": "4fa6e0f0c6786287e131c3852c58a2e01cc697a68231826813597e4994f1d6e2", + "Created": "2013-05-07T14:51:42.041847+02:00", + "Path": "date", + "Args": [], + "Config": { + "Hostname": "4fa6e0f0c678", + "User": "", + "Memory": 0, + "MemorySwap": 0, + "AttachStdin": false, + "AttachStdout": true, + "AttachStderr": true, + "PortSpecs": null, + "Tty": false, + "OpenStdin": false, + "StdinOnce": false, + "Env": null, + "Cmd": [ + "date" + ], + "Dns": null, + "Image": "ubuntu", + "Volumes": {}, + "VolumesFrom": "" + }, + "State": { + "Running": false, + "Pid": 0, + "ExitCode": 0, + "StartedAt": "2013-05-07T14:51:42.087658+02:01360", + "Ghost": false + }, + "Image": "b750fe79269d2ec9a3c593ef05b4332b1d1a02a62b4accb2c21d589ff2f5f2dc", + "NetworkSettings": { + "IpAddress": "", + "IpPrefixLen": 0, + "Gateway": "", + "Bridge": "", + "PortMapping": null + }, + "SysInitPath": "/home/kitty/go/src/github.com/dotcloud/docker/bin/docker", + "ResolvConfPath": "/etc/resolv.conf", + "Volumes": {} + } + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### [Inspect changes on a container’s filesystem](#id8) + + `GET /containers/`(*id*)`/changes` +: Inspect changes on container `id` ‘s filesystem + + **Example request**: + + GET /containers/4fa6e0f0c678/changes HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "Path":"/dev", + "Kind":0 + }, + { + "Path":"/dev/kmsg", + "Kind":1 + }, + { + "Path":"/test", + "Kind":1 + } + ] + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### [Export a container](#id9) + + `GET /containers/`(*id*)`/export` +: Export the contents of container `id` + + **Example request**: + + GET /containers/4fa6e0f0c678/export HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/octet-stream + + {{ STREAM }} + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### [Start a container](#id10) + + `POST /containers/`(*id*)`/start` +: Start the container `id` + + **Example request**: + + POST /containers/e90e34656806/start HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### [Stop a container](#id11) + + `POST /containers/`(*id*)`/stop` +: Stop the container `id` + + **Example request**: + + POST /containers/e90e34656806/stop?t=5 HTTP/1.1 + + **Example response**: + + HTTP/1.1 204 OK + + Query Parameters: + +   + + - **t** – number of seconds to wait before killing the container + + Status Codes: + + - **204** – no error + - **404** – no such container + - **500** – server error + +#### [Restart a container](#id12) + + `POST /containers/`(*id*)`/restart` +: Restart the container `id` + + **Example request**: + + POST /containers/e90e34656806/restart?t=5 HTTP/1.1 + + **Example response**: + + HTTP/1.1 204 OK + + Query Parameters: + +   + + - **t** – number of seconds to wait before killing the container + + Status Codes: + + - **204** – no error + - **404** – no such container + - **500** – server error + +#### [Kill a container](#id13) + + `POST /containers/`(*id*)`/kill` +: Kill the container `id` + + **Example request**: + + POST /containers/e90e34656806/kill HTTP/1.1 + + **Example response**: + + HTTP/1.1 204 OK + + Status Codes: + + - **204** – no error + - **404** – no such container + - **500** – server error + +#### [Attach to a container](#id14) + + `POST /containers/`(*id*)`/attach` +: Attach to the container `id` + + **Example request**: + + POST /containers/16253994b7c4/attach?logs=1&stream=0&stdout=1 HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/vnd.docker.raw-stream + + {{ STREAM }} + + Query Parameters: + +   + + - **logs** – 1/True/true or 0/False/false, return logs. Default + false + - **stream** – 1/True/true or 0/False/false, return stream. + Default false + - **stdin** – 1/True/true or 0/False/false, if stream=true, attach + to stdin. Default false + - **stdout** – 1/True/true or 0/False/false, if logs=true, return + stdout log, if stream=true, attach to stdout. Default false + - **stderr** – 1/True/true or 0/False/false, if logs=true, return + stderr log, if stream=true, attach to stderr. Default false + + Status Codes: + + - **200** – no error + - **400** – bad parameter + - **404** – no such container + - **500** – server error + +#### [Wait a container](#id15) + + `POST /containers/`(*id*)`/wait` +: Block until container `id` stops, then returns + the exit code + + **Example request**: + + POST /containers/16253994b7c4/wait HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {"StatusCode":0} + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### [Remove a container](#id16) + + `DELETE /containers/`(*id*) +: Remove the container `id` from the filesystem + + **Example request**: + + DELETE /containers/16253994b7c4?v=1 HTTP/1.1 + + **Example response**: + + HTTP/1.1 204 OK + + Query Parameters: + +   + + - **v** – 1/True/true or 0/False/false, Remove the volumes + associated to the container. Default false + + Status Codes: + + - **204** – no error + - **400** – bad parameter + - **404** – no such container + - **500** – server error + +### [2.2 Images](#id17) + +#### [List Images](#id18) + + `GET /images/`(*format*) +: List images `format` could be json or viz (json + default) + + **Example request**: + + GET /images/json?all=0 HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "Repository":"ubuntu", + "Tag":"precise", + "Id":"b750fe79269d", + "Created":1364102658, + "Size":24653, + "VirtualSize":180116135 + }, + { + "Repository":"ubuntu", + "Tag":"12.04", + "Id":"b750fe79269d", + "Created":1364102658, + "Size":24653, + "VirtualSize":180116135 + } + ] + + **Example request**: + + GET /images/viz HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: text/plain + + digraph docker { + "d82cbacda43a" -> "074be284591f" + "1496068ca813" -> "08306dc45919" + "08306dc45919" -> "0e7893146ac2" + "b750fe79269d" -> "1496068ca813" + base -> "27cf78414709" [style=invis] + "f71189fff3de" -> "9a33b36209ed" + "27cf78414709" -> "b750fe79269d" + "0e7893146ac2" -> "d6434d954665" + "d6434d954665" -> "d82cbacda43a" + base -> "e9aa60c60128" [style=invis] + "074be284591f" -> "f71189fff3de" + "b750fe79269d" [label="b750fe79269d\nubuntu",shape=box,fillcolor="paleturquoise",style="filled,rounded"]; + "e9aa60c60128" [label="e9aa60c60128\ncentos",shape=box,fillcolor="paleturquoise",style="filled,rounded"]; + "9a33b36209ed" [label="9a33b36209ed\nfedora",shape=box,fillcolor="paleturquoise",style="filled,rounded"]; + base [style=invisible] + } + + Query Parameters: + +   + + - **all** – 1/True/true or 0/False/false, Show all containers. + Only running containers are shown by default + + Status Codes: + + - **200** – no error + - **400** – bad parameter + - **500** – server error + +#### [Create an image](#id19) + + `POST /images/create` +: Create an image, either by pull it from the registry or by importing + it + + **Example request**: + + POST /images/create?fromImage=ubuntu HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {"status":"Pulling..."} + {"status":"Pulling", "progress":"1/? (n/a)"} + {"error":"Invalid..."} + ... + + Query Parameters: + +   + + - **fromImage** – name of the image to pull + - **fromSrc** – source to import, - means stdin + - **repo** – repository + - **tag** – tag + - **registry** – the registry to pull from + + Status Codes: + + - **200** – no error + - **500** – server error + +#### [Insert a file in an image](#id20) + + `POST /images/`(*name*)`/insert` +: Insert a file from `url` in the image + `name` at `path` + + **Example request**: + + POST /images/test/insert?path=/usr&url=myurl HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {"status":"Inserting..."} + {"status":"Inserting", "progress":"1/? (n/a)"} + {"error":"Invalid..."} + ... + + Status Codes: + + - **200** – no error + - **500** – server error + +#### [Inspect an image](#id21) + + `GET /images/`(*name*)`/json` +: Return low-level information on the image `name` + + **Example request**: + + GET /images/centos/json HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "id":"b750fe79269d2ec9a3c593ef05b4332b1d1a02a62b4accb2c21d589ff2f5f2dc", + "parent":"27cf784147099545", + "created":"2013-03-23T22:24:18.818426-07:00", + "container":"3d67245a8d72ecf13f33dffac9f79dcdf70f75acb84d308770391510e0c23ad0", + "container_config": + { + "Hostname":"", + "User":"", + "Memory":0, + "MemorySwap":0, + "AttachStdin":false, + "AttachStdout":false, + "AttachStderr":false, + "PortSpecs":null, + "Tty":true, + "OpenStdin":true, + "StdinOnce":false, + "Env":null, + "Cmd": ["/bin/bash"] + ,"Dns":null, + "Image":"centos", + "Volumes":null, + "VolumesFrom":"" + }, + "Size": 6824592 + } + + Status Codes: + + - **200** – no error + - **404** – no such image + - **500** – server error + +#### [Get the history of an image](#id22) + + `GET /images/`(*name*)`/history` +: Return the history of the image `name` + + **Example request**: + + GET /images/fedora/history HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "Id":"b750fe79269d", + "Tag":["ubuntu:latest"], + "Created":1364102658, + "CreatedBy":"/bin/bash" + }, + { + "Id":"27cf78414709", + "Created":1364068391, + "CreatedBy":"" + } + ] + + Status Codes: + + - **200** – no error + - **404** – no such image + - **500** – server error + +#### [Push an image on the registry](#id23) + + `POST /images/`(*name*)`/push` +: Push the image `name` on the registry + + > **Example request**: + > + > POST /images/test/push HTTP/1.1 + > {{ authConfig }} + > + > **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {"status":"Pushing..."} + {"status":"Pushing", "progress":"1/? (n/a)"} + {"error":"Invalid..."} + ... + + Query Parameters: + +   + + - **registry** – the registry you wan to push, optional + + Status Codes: + + - **200** – no error + - **404** – no such image + - **500** – server error + +#### [Tag an image into a repository](#id24) + + `POST /images/`(*name*)`/tag` +: Tag the image `name` into a repository + + **Example request**: + + POST /images/test/tag?repo=myrepo&force=0 HTTP/1.1 + + **Example response**: + + HTTP/1.1 201 OK + + Query Parameters: + +   + + - **repo** – The repository to tag in + - **force** – 1/True/true or 0/False/false, default false + + Status Codes: + + - **201** – no error + - **400** – bad parameter + - **404** – no such image + - **409** – conflict + - **500** – server error + +#### [Remove an image](#id25) + + `DELETE /images/`(*name*) +: Remove the image `name` from the filesystem + + **Example request**: + + DELETE /images/test HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-type: application/json + + [ + {"Untagged":"3e2f21a89f"}, + {"Deleted":"3e2f21a89f"}, + {"Deleted":"53b4f83ac9"} + ] + + Status Codes: + + - **204** – no error + - **404** – no such image + - **409** – conflict + - **500** – server error + +#### [Search images](#id26) + + `GET /images/search` +: Search for an image in the docker index + + **Example request**: + + GET /images/search?term=sshd HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "Name":"cespare/sshd", + "Description":"" + }, + { + "Name":"johnfuller/sshd", + "Description":"" + }, + { + "Name":"dhrp/mongodb-sshd", + "Description":"" + } + ] + + :query term: term to search + :statuscode 200: no error + :statuscode 500: server error + +### [2.3 Misc](#id27) + +#### [Build an image from Dockerfile via stdin](#id28) + + `POST /build` +: Build an image from Dockerfile + + **Example request**: + + POST /build HTTP/1.1 + + {{ STREAM }} + + **Example response**: + + HTTP/1.1 200 OK + + {{ STREAM }} + + Query Parameters: + +   + + - **t** – repository name to be applied to the resulting image in + case of success + - **remote** – resource to fetch, as URI + + Status Codes: + + - **200** – no error + - **500** – server error + +{{ STREAM }} is the raw text output of the build command. It uses the +HTTP Hijack method in order to stream. + +#### [Check auth configuration](#id29) + + `POST /auth` +: Get the default username and email + + **Example request**: + + POST /auth HTTP/1.1 + Content-Type: application/json + + { + "username":"hannibal", + "password:"xxxx", + "email":"hannibal@a-team.com" + } + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "Status": "Login Succeeded" + } + + Status Codes: + + - **200** – no error + - **204** – no error + - **401** – unauthorized + - **403** – forbidden + - **500** – server error + +#### [Display system-wide information](#id30) + + `GET /info` +: Display system-wide information + + **Example request**: + + GET /info HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "Containers":11, + "Images":16, + "Debug":false, + "NFd": 11, + "NGoroutines":21, + "MemoryLimit":true, + "SwapLimit":false + } + + Status Codes: + + - **200** – no error + - **500** – server error + +#### [Show the docker version information](#id31) + + `GET /version` +: Show the docker version information + + **Example request**: + + GET /version HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "Version":"0.2.2", + "GitCommit":"5a2a5cc+CHANGES", + "GoVersion":"go1.0.3" + } + + Status Codes: + + - **200** – no error + - **500** – server error + +#### [Create a new image from a container’s changes](#id32) + + `POST /commit` +: Create a new image from a container’s changes + + **Example request**: + + POST /commit?container=44c004db4b17&m=message&repo=myrepo HTTP/1.1 + Content-Type: application/json + + { + "Cmd": ["cat", "/world"], + "PortSpecs":["22"] + } + + **Example response**: + + HTTP/1.1 201 OK + Content-Type: application/vnd.docker.raw-stream + + {"Id":"596069db4bf5"} + + Query Parameters: + +   + + - **container** – source container + - **repo** – repository + - **tag** – tag + - **m** – commit message + - **author** – author (eg. "John Hannibal Smith + \<[hannibal@a-team.com](mailto:hannibal%40a-team.com)\>") + + Status Codes: + + - **201** – no error + - **404** – no such container + - **500** – server error + +## [3. Going further](#id33) + +### [3.1 Inside ‘docker run’](#id34) + +Here are the steps of ‘docker run’ : + +- Create the container + +- If the status code is 404, it means the image doesn’t exists: + : - Try to pull it + - Then retry to create the container + +- Start the container + +- If you are not in detached mode: + : - Attach to the container, using logs=1 (to have stdout and + stderr from the container’s start) and stream=1 + +- If in detached mode or only stdin is attached: + : - Display the container’s id + +### [3.2 Hijacking](#id35) + +In this version of the API, /attach, uses hijacking to transport stdin, +stdout and stderr on the same socket. This might change in the future. + +### [3.3 CORS Requests](#id36) + +To enable cross origin requests to the remote api add the flag +"–api-enable-cors" when running docker in daemon mode. + +> docker -d -H="[tcp://192.168.1.9:4243](tcp://192.168.1.9:4243)" +> –api-enable-cors diff --git a/docs/sources/reference/api/docker_remote_api_v1.2.rst b/docs/sources/reference/api/archive/docker_remote_api_v1.2.rst similarity index 100% rename from docs/sources/reference/api/docker_remote_api_v1.2.rst rename to docs/sources/reference/api/archive/docker_remote_api_v1.2.rst diff --git a/docs/sources/reference/api/archive/docker_remote_api_v1.3.md b/docs/sources/reference/api/archive/docker_remote_api_v1.3.md new file mode 100644 index 0000000000..d83b9d85b1 --- /dev/null +++ b/docs/sources/reference/api/archive/docker_remote_api_v1.3.md @@ -0,0 +1,1060 @@ +page_title: Remote API v1.3 +page_description: API Documentation for Docker +page_keywords: API, Docker, rcli, REST, documentation + +# [Docker Remote API v1.3](#id1) + +## [1. Brief introduction](#id2) + +- The Remote API is replacing rcli +- Default port in the docker daemon 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](#id3) + +### [2.1 Containers](#id4) + +#### [List containers](#id5) + + `GET /containers/json` +: List containers + + **Example request**: + + GET /containers/json?all=1&before=8dfafdbc3a40&size=1 HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "Id": "8dfafdbc3a40", + "Image": "ubuntu:latest", + "Command": "echo 1", + "Created": 1367854155, + "Status": "Exit 0", + "Ports":"", + "SizeRw":12288, + "SizeRootFs":0 + }, + { + "Id": "9cd87474be90", + "Image": "ubuntu:latest", + "Command": "echo 222222", + "Created": 1367854155, + "Status": "Exit 0", + "Ports":"", + "SizeRw":12288, + "SizeRootFs":0 + }, + { + "Id": "3176a2479c92", + "Image": "centos:latest", + "Command": "echo 3333333333333333", + "Created": 1367854154, + "Status": "Exit 0", + "Ports":"", + "SizeRw":12288, + "SizeRootFs":0 + }, + { + "Id": "4cb07b47f9fb", + "Image": "fedora:latest", + "Command": "echo 444444444444444444444444444444444", + "Created": 1367854152, + "Status": "Exit 0", + "Ports":"", + "SizeRw":12288, + "SizeRootFs":0 + } + ] + + Query Parameters: + +   + + - **all** – 1/True/true or 0/False/false, Show all containers. + Only running containers are shown by default + - **limit** – Show `limit` last created + containers, include non-running ones. + - **since** – Show only containers created since Id, include + non-running ones. + - **before** – Show only containers created before Id, include + non-running ones. + - **size** – 1/True/true or 0/False/false, Show the containers + sizes + + Status Codes: + + - **200** – no error + - **400** – bad parameter + - **500** – server error + +#### [Create a container](#id6) + + `POST /containers/create` +: Create a container + + **Example request**: + + POST /containers/create HTTP/1.1 + Content-Type: application/json + + { + "Hostname":"", + "User":"", + "Memory":0, + "MemorySwap":0, + "AttachStdin":false, + "AttachStdout":true, + "AttachStderr":true, + "PortSpecs":null, + "Tty":false, + "OpenStdin":false, + "StdinOnce":false, + "Env":null, + "Cmd":[ + "date" + ], + "Dns":null, + "Image":"ubuntu", + "Volumes":{}, + "VolumesFrom":"" + } + + **Example response**: + + HTTP/1.1 201 OK + Content-Type: application/json + + { + "Id":"e90e34656806" + "Warnings":[] + } + + Json Parameters: + +   + + - **config** – the container’s configuration + + Status Codes: + + - **201** – no error + - **404** – no such container + - **406** – impossible to attach (container not running) + - **500** – server error + +#### [Inspect a container](#id7) + + `GET /containers/`(*id*)`/json` +: Return low-level information on the container `id` + + + **Example request**: + + GET /containers/4fa6e0f0c678/json HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "Id": "4fa6e0f0c6786287e131c3852c58a2e01cc697a68231826813597e4994f1d6e2", + "Created": "2013-05-07T14:51:42.041847+02:00", + "Path": "date", + "Args": [], + "Config": { + "Hostname": "4fa6e0f0c678", + "User": "", + "Memory": 0, + "MemorySwap": 0, + "AttachStdin": false, + "AttachStdout": true, + "AttachStderr": true, + "PortSpecs": null, + "Tty": false, + "OpenStdin": false, + "StdinOnce": false, + "Env": null, + "Cmd": [ + "date" + ], + "Dns": null, + "Image": "ubuntu", + "Volumes": {}, + "VolumesFrom": "" + }, + "State": { + "Running": false, + "Pid": 0, + "ExitCode": 0, + "StartedAt": "2013-05-07T14:51:42.087658+02:01360", + "Ghost": false + }, + "Image": "b750fe79269d2ec9a3c593ef05b4332b1d1a02a62b4accb2c21d589ff2f5f2dc", + "NetworkSettings": { + "IpAddress": "", + "IpPrefixLen": 0, + "Gateway": "", + "Bridge": "", + "PortMapping": null + }, + "SysInitPath": "/home/kitty/go/src/github.com/dotcloud/docker/bin/docker", + "ResolvConfPath": "/etc/resolv.conf", + "Volumes": {} + } + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### [List processes running inside a container](#id8) + + `GET /containers/`(*id*)`/top` +: List processes running inside the container `id` + + **Example request**: + + GET /containers/4fa6e0f0c678/top HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "PID":"11935", + "Tty":"pts/2", + "Time":"00:00:00", + "Cmd":"sh" + }, + { + "PID":"12140", + "Tty":"pts/2", + "Time":"00:00:00", + "Cmd":"sleep" + } + ] + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### [Inspect changes on a container’s filesystem](#id9) + + `GET /containers/`(*id*)`/changes` +: Inspect changes on container `id` ‘s filesystem + + **Example request**: + + GET /containers/4fa6e0f0c678/changes HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "Path":"/dev", + "Kind":0 + }, + { + "Path":"/dev/kmsg", + "Kind":1 + }, + { + "Path":"/test", + "Kind":1 + } + ] + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### [Export a container](#id10) + + `GET /containers/`(*id*)`/export` +: Export the contents of container `id` + + **Example request**: + + GET /containers/4fa6e0f0c678/export HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/octet-stream + + {{ STREAM }} + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### [Start a container](#id11) + + `POST /containers/`(*id*)`/start` +: Start the container `id` + + **Example request**: + + POST /containers/(id)/start HTTP/1.1 + Content-Type: application/json + + { + "Binds":["/tmp:/tmp"] + } + + **Example response**: + + HTTP/1.1 204 No Content + Content-Type: text/plain + + Json Parameters: + +   + + - **hostConfig** – the container’s host configuration (optional) + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### [Stop a container](#id12) + + `POST /containers/`(*id*)`/stop` +: Stop the container `id` + + **Example request**: + + POST /containers/e90e34656806/stop?t=5 HTTP/1.1 + + **Example response**: + + HTTP/1.1 204 OK + + Query Parameters: + +   + + - **t** – number of seconds to wait before killing the container + + Status Codes: + + - **204** – no error + - **404** – no such container + - **500** – server error + +#### [Restart a container](#id13) + + `POST /containers/`(*id*)`/restart` +: Restart the container `id` + + **Example request**: + + POST /containers/e90e34656806/restart?t=5 HTTP/1.1 + + **Example response**: + + HTTP/1.1 204 OK + + Query Parameters: + +   + + - **t** – number of seconds to wait before killing the container + + Status Codes: + + - **204** – no error + - **404** – no such container + - **500** – server error + +#### [Kill a container](#id14) + + `POST /containers/`(*id*)`/kill` +: Kill the container `id` + + **Example request**: + + POST /containers/e90e34656806/kill HTTP/1.1 + + **Example response**: + + HTTP/1.1 204 OK + + Status Codes: + + - **204** – no error + - **404** – no such container + - **500** – server error + +#### [Attach to a container](#id15) + + `POST /containers/`(*id*)`/attach` +: Attach to the container `id` + + **Example request**: + + POST /containers/16253994b7c4/attach?logs=1&stream=0&stdout=1 HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/vnd.docker.raw-stream + + {{ STREAM }} + + Query Parameters: + +   + + - **logs** – 1/True/true or 0/False/false, return logs. Default + false + - **stream** – 1/True/true or 0/False/false, return stream. + Default false + - **stdin** – 1/True/true or 0/False/false, if stream=true, attach + to stdin. Default false + - **stdout** – 1/True/true or 0/False/false, if logs=true, return + stdout log, if stream=true, attach to stdout. Default false + - **stderr** – 1/True/true or 0/False/false, if logs=true, return + stderr log, if stream=true, attach to stderr. Default false + + Status Codes: + + - **200** – no error + - **400** – bad parameter + - **404** – no such container + - **500** – server error + +#### [Wait a container](#id16) + + `POST /containers/`(*id*)`/wait` +: Block until container `id` stops, then returns + the exit code + + **Example request**: + + POST /containers/16253994b7c4/wait HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {"StatusCode":0} + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### [Remove a container](#id17) + + `DELETE /containers/`(*id*) +: Remove the container `id` from the filesystem + + **Example request**: + + DELETE /containers/16253994b7c4?v=1 HTTP/1.1 + + **Example response**: + + HTTP/1.1 204 OK + + Query Parameters: + +   + + - **v** – 1/True/true or 0/False/false, Remove the volumes + associated to the container. Default false + + Status Codes: + + - **204** – no error + - **400** – bad parameter + - **404** – no such container + - **500** – server error + +### [2.2 Images](#id18) + +#### [List Images](#id19) + + `GET /images/`(*format*) +: List images `format` could be json or viz (json + default) + + **Example request**: + + GET /images/json?all=0 HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "Repository":"ubuntu", + "Tag":"precise", + "Id":"b750fe79269d", + "Created":1364102658, + "Size":24653, + "VirtualSize":180116135 + }, + { + "Repository":"ubuntu", + "Tag":"12.04", + "Id":"b750fe79269d", + "Created":1364102658, + "Size":24653, + "VirtualSize":180116135 + } + ] + + **Example request**: + + GET /images/viz HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: text/plain + + digraph docker { + "d82cbacda43a" -> "074be284591f" + "1496068ca813" -> "08306dc45919" + "08306dc45919" -> "0e7893146ac2" + "b750fe79269d" -> "1496068ca813" + base -> "27cf78414709" [style=invis] + "f71189fff3de" -> "9a33b36209ed" + "27cf78414709" -> "b750fe79269d" + "0e7893146ac2" -> "d6434d954665" + "d6434d954665" -> "d82cbacda43a" + base -> "e9aa60c60128" [style=invis] + "074be284591f" -> "f71189fff3de" + "b750fe79269d" [label="b750fe79269d\nubuntu",shape=box,fillcolor="paleturquoise",style="filled,rounded"]; + "e9aa60c60128" [label="e9aa60c60128\ncentos",shape=box,fillcolor="paleturquoise",style="filled,rounded"]; + "9a33b36209ed" [label="9a33b36209ed\nfedora",shape=box,fillcolor="paleturquoise",style="filled,rounded"]; + base [style=invisible] + } + + Query Parameters: + +   + + - **all** – 1/True/true or 0/False/false, Show all containers. + Only running containers are shown by default + + Status Codes: + + - **200** – no error + - **400** – bad parameter + - **500** – server error + +#### [Create an image](#id20) + + `POST /images/create` +: Create an image, either by pull it from the registry or by importing + it + + **Example request**: + + POST /images/create?fromImage=ubuntu HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {"status":"Pulling..."} + {"status":"Pulling", "progress":"1/? (n/a)"} + {"error":"Invalid..."} + ... + + Query Parameters: + +   + + - **fromImage** – name of the image to pull + - **fromSrc** – source to import, - means stdin + - **repo** – repository + - **tag** – tag + - **registry** – the registry to pull from + + Status Codes: + + - **200** – no error + - **500** – server error + +#### [Insert a file in an image](#id21) + + `POST /images/`(*name*)`/insert` +: Insert a file from `url` in the image + `name` at `path` + + **Example request**: + + POST /images/test/insert?path=/usr&url=myurl HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {"status":"Inserting..."} + {"status":"Inserting", "progress":"1/? (n/a)"} + {"error":"Invalid..."} + ... + + Status Codes: + + - **200** – no error + - **500** – server error + +#### [Inspect an image](#id22) + + `GET /images/`(*name*)`/json` +: Return low-level information on the image `name` + + **Example request**: + + GET /images/centos/json HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "id":"b750fe79269d2ec9a3c593ef05b4332b1d1a02a62b4accb2c21d589ff2f5f2dc", + "parent":"27cf784147099545", + "created":"2013-03-23T22:24:18.818426-07:00", + "container":"3d67245a8d72ecf13f33dffac9f79dcdf70f75acb84d308770391510e0c23ad0", + "container_config": + { + "Hostname":"", + "User":"", + "Memory":0, + "MemorySwap":0, + "AttachStdin":false, + "AttachStdout":false, + "AttachStderr":false, + "PortSpecs":null, + "Tty":true, + "OpenStdin":true, + "StdinOnce":false, + "Env":null, + "Cmd": ["/bin/bash"] + ,"Dns":null, + "Image":"centos", + "Volumes":null, + "VolumesFrom":"" + }, + "Size": 6824592 + } + + Status Codes: + + - **200** – no error + - **404** – no such image + - **500** – server error + +#### [Get the history of an image](#id23) + + `GET /images/`(*name*)`/history` +: Return the history of the image `name` + + **Example request**: + + GET /images/fedora/history HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "Id":"b750fe79269d", + "Created":1364102658, + "CreatedBy":"/bin/bash" + }, + { + "Id":"27cf78414709", + "Created":1364068391, + "CreatedBy":"" + } + ] + + Status Codes: + + - **200** – no error + - **404** – no such image + - **500** – server error + +#### [Push an image on the registry](#id24) + + `POST /images/`(*name*)`/push` +: Push the image `name` on the registry + + > **Example request**: + > + > POST /images/test/push HTTP/1.1 + > {{ authConfig }} + > + > **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {"status":"Pushing..."} + {"status":"Pushing", "progress":"1/? (n/a)"} + {"error":"Invalid..."} + ... + + Query Parameters: + +   + + - **registry** – the registry you wan to push, optional + + Status Codes: + + - **200** – no error + - **404** – no such image + - **500** – server error + +#### [Tag an image into a repository](#id25) + + `POST /images/`(*name*)`/tag` +: Tag the image `name` into a repository + + **Example request**: + + POST /images/test/tag?repo=myrepo&force=0 HTTP/1.1 + + **Example response**: + + HTTP/1.1 201 OK + + Query Parameters: + +   + + - **repo** – The repository to tag in + - **force** – 1/True/true or 0/False/false, default false + + Status Codes: + + - **201** – no error + - **400** – bad parameter + - **404** – no such image + - **409** – conflict + - **500** – server error + +#### [Remove an image](#id26) + + `DELETE /images/`(*name*) +: Remove the image `name` from the filesystem + + **Example request**: + + DELETE /images/test HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-type: application/json + + [ + {"Untagged":"3e2f21a89f"}, + {"Deleted":"3e2f21a89f"}, + {"Deleted":"53b4f83ac9"} + ] + + Status Codes: + + - **200** – no error + - **404** – no such image + - **409** – conflict + - **500** – server error + +#### [Search images](#id27) + + `GET /images/search` +: Search for an image in the docker index + + **Example request**: + + GET /images/search?term=sshd HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "Name":"cespare/sshd", + "Description":"" + }, + { + "Name":"johnfuller/sshd", + "Description":"" + }, + { + "Name":"dhrp/mongodb-sshd", + "Description":"" + } + ] + + :query term: term to search + :statuscode 200: no error + :statuscode 500: server error + +### [2.3 Misc](#id28) + +#### [Build an image from Dockerfile via stdin](#id29) + + `POST /build` +: Build an image from Dockerfile via stdin + + **Example request**: + + POST /build HTTP/1.1 + + {{ STREAM }} + + **Example response**: + + HTTP/1.1 200 OK + + {{ STREAM }} + + The stream must be a tar archive compressed with one of the + following algorithms: identity (no compression), gzip, bzip2, xz. + The archive must include a file called Dockerfile at its root. It + may include any number of other files, which will be accessible in + the build context (See the ADD build command). + + The Content-type header should be set to "application/tar". + + Query Parameters: + +   + + - **t** – repository name (and optionally a tag) to be applied to + the resulting image in case of success + - **q** – suppress verbose build output + + Status Codes: + + - **200** – no error + - **500** – server error + +#### [Check auth configuration](#id30) + + `POST /auth` +: Get the default username and email + + **Example request**: + + POST /auth HTTP/1.1 + Content-Type: application/json + + { + "username":"hannibal", + "password:"xxxx", + "email":"hannibal@a-team.com" + } + + **Example response**: + + HTTP/1.1 200 OK + + Status Codes: + + - **200** – no error + - **204** – no error + - **500** – server error + +#### [Display system-wide information](#id31) + + `GET /info` +: Display system-wide information + + **Example request**: + + GET /info HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "Containers":11, + "Images":16, + "Debug":false, + "NFd": 11, + "NGoroutines":21, + "MemoryLimit":true, + "SwapLimit":false, + "EventsListeners":"0", + "LXCVersion":"0.7.5", + "KernelVersion":"3.8.0-19-generic" + } + + Status Codes: + + - **200** – no error + - **500** – server error + +#### [Show the docker version information](#id32) + + `GET /version` +: Show the docker version information + + **Example request**: + + GET /version HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "Version":"0.2.2", + "GitCommit":"5a2a5cc+CHANGES", + "GoVersion":"go1.0.3" + } + + Status Codes: + + - **200** – no error + - **500** – server error + +#### [Create a new image from a container’s changes](#id33) + + `POST /commit` +: Create a new image from a container’s changes + + **Example request**: + + POST /commit?container=44c004db4b17&m=message&repo=myrepo HTTP/1.1 + Content-Type: application/json + + { + "Cmd": ["cat", "/world"], + "PortSpecs":["22"] + } + + **Example response**: + + HTTP/1.1 201 OK + Content-Type: application/vnd.docker.raw-stream + + {"Id":"596069db4bf5"} + + Query Parameters: + +   + + - **container** – source container + - **repo** – repository + - **tag** – tag + - **m** – commit message + - **author** – author (eg. "John Hannibal Smith + \<[hannibal@a-team.com](mailto:hannibal%40a-team.com)\>") + + Status Codes: + + - **201** – no error + - **404** – no such container + - **500** – server error + +#### [Monitor Docker’s events](#id34) + + `GET /events` +: Get events from docker, either in real time via streaming, or via + polling (using since) + + **Example request**: + + GET /events?since=1374067924 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {"status":"create","id":"dfdf82bd3881","time":1374067924} + {"status":"start","id":"dfdf82bd3881","time":1374067924} + {"status":"stop","id":"dfdf82bd3881","time":1374067966} + {"status":"destroy","id":"dfdf82bd3881","time":1374067970} + + Query Parameters: + +   + + - **since** – timestamp used for polling + + Status Codes: + + - **200** – no error + - **500** – server error + +## [3. Going further](#id35) + +### [3.1 Inside ‘docker run’](#id36) + +Here are the steps of ‘docker run’ : + +- Create the container + +- If the status code is 404, it means the image doesn’t exists: + : - Try to pull it + - Then retry to create the container + +- Start the container + +- If you are not in detached mode: + : - Attach to the container, using logs=1 (to have stdout and + stderr from the container’s start) and stream=1 + +- If in detached mode or only stdin is attached: + : - Display the container’s id + +### [3.2 Hijacking](#id37) + +In this version of the API, /attach, uses hijacking to transport stdin, +stdout and stderr on the same socket. This might change in the future. + +### [3.3 CORS Requests](#id38) + +To enable cross origin requests to the remote api add the flag +"–api-enable-cors" when running docker in daemon mode. + +> docker -d -H="192.168.1.9:4243" –api-enable-cors diff --git a/docs/sources/reference/api/docker_remote_api_v1.3.rst b/docs/sources/reference/api/archive/docker_remote_api_v1.3.rst similarity index 100% rename from docs/sources/reference/api/docker_remote_api_v1.3.rst rename to docs/sources/reference/api/archive/docker_remote_api_v1.3.rst diff --git a/docs/sources/reference/api/archive/docker_remote_api_v1.4.md b/docs/sources/reference/api/archive/docker_remote_api_v1.4.md new file mode 100644 index 0000000000..32733708b3 --- /dev/null +++ b/docs/sources/reference/api/archive/docker_remote_api_v1.4.md @@ -0,0 +1,1104 @@ +page_title: Remote API v1.4 +page_description: API Documentation for Docker +page_keywords: API, Docker, rcli, REST, documentation + +# [Docker Remote API v1.4](#id1) + +## [1. Brief introduction](#id2) + +- The Remote API is replacing rcli +- Default port in the docker daemon 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](#id3) + +### [2.1 Containers](#id4) + +#### [List containers](#id5) + + `GET /containers/json` +: List containers + + **Example request**: + + GET /containers/json?all=1&before=8dfafdbc3a40&size=1 HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "Id": "8dfafdbc3a40", + "Image": "ubuntu:latest", + "Command": "echo 1", + "Created": 1367854155, + "Status": "Exit 0", + "Ports":"", + "SizeRw":12288, + "SizeRootFs":0 + }, + { + "Id": "9cd87474be90", + "Image": "ubuntu:latest", + "Command": "echo 222222", + "Created": 1367854155, + "Status": "Exit 0", + "Ports":"", + "SizeRw":12288, + "SizeRootFs":0 + }, + { + "Id": "3176a2479c92", + "Image": "centos:latest", + "Command": "echo 3333333333333333", + "Created": 1367854154, + "Status": "Exit 0", + "Ports":"", + "SizeRw":12288, + "SizeRootFs":0 + }, + { + "Id": "4cb07b47f9fb", + "Image": "fedora:latest", + "Command": "echo 444444444444444444444444444444444", + "Created": 1367854152, + "Status": "Exit 0", + "Ports":"", + "SizeRw":12288, + "SizeRootFs":0 + } + ] + + Query Parameters: + +   + + - **all** – 1/True/true or 0/False/false, Show all containers. + Only running containers are shown by default + - **limit** – Show `limit` last created + containers, include non-running ones. + - **since** – Show only containers created since Id, include + non-running ones. + - **before** – Show only containers created before Id, include + non-running ones. + - **size** – 1/True/true or 0/False/false, Show the containers + sizes + + Status Codes: + + - **200** – no error + - **400** – bad parameter + - **500** – server error + +#### [Create a container](#id6) + + `POST /containers/create` +: Create a container + + **Example request**: + + POST /containers/create HTTP/1.1 + Content-Type: application/json + + { + "Hostname":"", + "User":"", + "Memory":0, + "MemorySwap":0, + "AttachStdin":false, + "AttachStdout":true, + "AttachStderr":true, + "PortSpecs":null, + "Privileged": false, + "Tty":false, + "OpenStdin":false, + "StdinOnce":false, + "Env":null, + "Cmd":[ + "date" + ], + "Dns":null, + "Image":"ubuntu", + "Volumes":{}, + "VolumesFrom":"", + "WorkingDir":"" + + } + + **Example response**: + + HTTP/1.1 201 OK + Content-Type: application/json + + { + "Id":"e90e34656806" + "Warnings":[] + } + + Json Parameters: + +   + + - **config** – the container’s configuration + + Status Codes: + + - **201** – no error + - **404** – no such container + - **406** – impossible to attach (container not running) + - **500** – server error + +#### [Inspect a container](#id7) + + `GET /containers/`(*id*)`/json` +: Return low-level information on the container `id` + + + **Example request**: + + GET /containers/4fa6e0f0c678/json HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "Id": "4fa6e0f0c6786287e131c3852c58a2e01cc697a68231826813597e4994f1d6e2", + "Created": "2013-05-07T14:51:42.041847+02:00", + "Path": "date", + "Args": [], + "Config": { + "Hostname": "4fa6e0f0c678", + "User": "", + "Memory": 0, + "MemorySwap": 0, + "AttachStdin": false, + "AttachStdout": true, + "AttachStderr": true, + "PortSpecs": null, + "Tty": false, + "OpenStdin": false, + "StdinOnce": false, + "Env": null, + "Cmd": [ + "date" + ], + "Dns": null, + "Image": "ubuntu", + "Volumes": {}, + "VolumesFrom": "", + "WorkingDir":"" + + }, + "State": { + "Running": false, + "Pid": 0, + "ExitCode": 0, + "StartedAt": "2013-05-07T14:51:42.087658+02:01360", + "Ghost": false + }, + "Image": "b750fe79269d2ec9a3c593ef05b4332b1d1a02a62b4accb2c21d589ff2f5f2dc", + "NetworkSettings": { + "IpAddress": "", + "IpPrefixLen": 0, + "Gateway": "", + "Bridge": "", + "PortMapping": null + }, + "SysInitPath": "/home/kitty/go/src/github.com/dotcloud/docker/bin/docker", + "ResolvConfPath": "/etc/resolv.conf", + "Volumes": {} + } + + Status Codes: + + - **200** – no error + - **404** – no such container + - **409** – conflict between containers and images + - **500** – server error + +#### [List processes running inside a container](#id8) + + `GET /containers/`(*id*)`/top` +: List processes running inside the container `id` + + **Example request**: + + GET /containers/4fa6e0f0c678/top HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "Titles":[ + "USER", + "PID", + "%CPU", + "%MEM", + "VSZ", + "RSS", + "TTY", + "STAT", + "START", + "TIME", + "COMMAND" + ], + "Processes":[ + ["root","20147","0.0","0.1","18060","1864","pts/4","S","10:06","0:00","bash"], + ["root","20271","0.0","0.0","4312","352","pts/4","S+","10:07","0:00","sleep","10"] + ] + } + + Query Parameters: + +   + + - **ps\_args** – ps arguments to use (eg. aux) + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### [Inspect changes on a container’s filesystem](#id9) + + `GET /containers/`(*id*)`/changes` +: Inspect changes on container `id` ‘s filesystem + + **Example request**: + + GET /containers/4fa6e0f0c678/changes HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "Path":"/dev", + "Kind":0 + }, + { + "Path":"/dev/kmsg", + "Kind":1 + }, + { + "Path":"/test", + "Kind":1 + } + ] + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### [Export a container](#id10) + + `GET /containers/`(*id*)`/export` +: Export the contents of container `id` + + **Example request**: + + GET /containers/4fa6e0f0c678/export HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/octet-stream + + {{ STREAM }} + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### [Start a container](#id11) + + `POST /containers/`(*id*)`/start` +: Start the container `id` + + **Example request**: + + POST /containers/(id)/start HTTP/1.1 + Content-Type: application/json + + { + "Binds":["/tmp:/tmp"], + "LxcConf":[{"Key":"lxc.utsname","Value":"docker"}] + } + + **Example response**: + + HTTP/1.1 204 No Content + Content-Type: text/plain + + Json Parameters: + +   + + - **hostConfig** – the container’s host configuration (optional) + + Status Codes: + + - **204** – no error + - **404** – no such container + - **500** – server error + +#### [Stop a container](#id12) + + `POST /containers/`(*id*)`/stop` +: Stop the container `id` + + **Example request**: + + POST /containers/e90e34656806/stop?t=5 HTTP/1.1 + + **Example response**: + + HTTP/1.1 204 OK + + Query Parameters: + +   + + - **t** – number of seconds to wait before killing the container + + Status Codes: + + - **204** – no error + - **404** – no such container + - **500** – server error + +#### [Restart a container](#id13) + + `POST /containers/`(*id*)`/restart` +: Restart the container `id` + + **Example request**: + + POST /containers/e90e34656806/restart?t=5 HTTP/1.1 + + **Example response**: + + HTTP/1.1 204 OK + + Query Parameters: + +   + + - **t** – number of seconds to wait before killing the container + + Status Codes: + + - **204** – no error + - **404** – no such container + - **500** – server error + +#### [Kill a container](#id14) + + `POST /containers/`(*id*)`/kill` +: Kill the container `id` + + **Example request**: + + POST /containers/e90e34656806/kill HTTP/1.1 + + **Example response**: + + HTTP/1.1 204 OK + + Status Codes: + + - **204** – no error + - **404** – no such container + - **500** – server error + +#### [Attach to a container](#id15) + + `POST /containers/`(*id*)`/attach` +: Attach to the container `id` + + **Example request**: + + POST /containers/16253994b7c4/attach?logs=1&stream=0&stdout=1 HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/vnd.docker.raw-stream + + {{ STREAM }} + + Query Parameters: + +   + + - **logs** – 1/True/true or 0/False/false, return logs. Default + false + - **stream** – 1/True/true or 0/False/false, return stream. + Default false + - **stdin** – 1/True/true or 0/False/false, if stream=true, attach + to stdin. Default false + - **stdout** – 1/True/true or 0/False/false, if logs=true, return + stdout log, if stream=true, attach to stdout. Default false + - **stderr** – 1/True/true or 0/False/false, if logs=true, return + stderr log, if stream=true, attach to stderr. Default false + + Status Codes: + + - **200** – no error + - **400** – bad parameter + - **404** – no such container + - **500** – server error + +#### [Wait a container](#id16) + + `POST /containers/`(*id*)`/wait` +: Block until container `id` stops, then returns + the exit code + + **Example request**: + + POST /containers/16253994b7c4/wait HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {"StatusCode":0} + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### [Remove a container](#id17) + + `DELETE /containers/`(*id*) +: Remove the container `id` from the filesystem + + **Example request**: + + DELETE /containers/16253994b7c4?v=1 HTTP/1.1 + + **Example response**: + + HTTP/1.1 204 OK + + Query Parameters: + +   + + - **v** – 1/True/true or 0/False/false, Remove the volumes + associated to the container. Default false + + Status Codes: + + - **204** – no error + - **400** – bad parameter + - **404** – no such container + - **500** – server error + +#### [Copy files or folders from a container](#id18) + + `POST /containers/`(*id*)`/copy` +: Copy files or folders of container `id` + + **Example request**: + + POST /containers/4fa6e0f0c678/copy HTTP/1.1 + Content-Type: application/json + + { + "Resource":"test.txt" + } + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/octet-stream + + {{ STREAM }} + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +### [2.2 Images](#id19) + +#### [List Images](#id20) + + `GET /images/`(*format*) +: List images `format` could be json or viz (json + default) + + **Example request**: + + GET /images/json?all=0 HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "Repository":"ubuntu", + "Tag":"precise", + "Id":"b750fe79269d", + "Created":1364102658, + "Size":24653, + "VirtualSize":180116135 + }, + { + "Repository":"ubuntu", + "Tag":"12.04", + "Id":"b750fe79269d", + "Created":1364102658, + "Size":24653, + "VirtualSize":180116135 + } + ] + + **Example request**: + + GET /images/viz HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: text/plain + + digraph docker { + "d82cbacda43a" -> "074be284591f" + "1496068ca813" -> "08306dc45919" + "08306dc45919" -> "0e7893146ac2" + "b750fe79269d" -> "1496068ca813" + base -> "27cf78414709" [style=invis] + "f71189fff3de" -> "9a33b36209ed" + "27cf78414709" -> "b750fe79269d" + "0e7893146ac2" -> "d6434d954665" + "d6434d954665" -> "d82cbacda43a" + base -> "e9aa60c60128" [style=invis] + "074be284591f" -> "f71189fff3de" + "b750fe79269d" [label="b750fe79269d\nubuntu",shape=box,fillcolor="paleturquoise",style="filled,rounded"]; + "e9aa60c60128" [label="e9aa60c60128\ncentos",shape=box,fillcolor="paleturquoise",style="filled,rounded"]; + "9a33b36209ed" [label="9a33b36209ed\nfedora",shape=box,fillcolor="paleturquoise",style="filled,rounded"]; + base [style=invisible] + } + + Query Parameters: + +   + + - **all** – 1/True/true or 0/False/false, Show all containers. + Only running containers are shown by default + + Status Codes: + + - **200** – no error + - **400** – bad parameter + - **500** – server error + +#### [Create an image](#id21) + + `POST /images/create` +: Create an image, either by pull it from the registry or by importing + it + + **Example request**: + + POST /images/create?fromImage=ubuntu HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {"status":"Pulling..."} + {"status":"Pulling", "progress":"1/? (n/a)"} + {"error":"Invalid..."} + ... + + Query Parameters: + +   + + - **fromImage** – name of the image to pull + - **fromSrc** – source to import, - means stdin + - **repo** – repository + - **tag** – tag + - **registry** – the registry to pull from + + Status Codes: + + - **200** – no error + - **500** – server error + +#### [Insert a file in an image](#id22) + + `POST /images/`(*name*)`/insert` +: Insert a file from `url` in the image + `name` at `path` + + **Example request**: + + POST /images/test/insert?path=/usr&url=myurl HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {"status":"Inserting..."} + {"status":"Inserting", "progress":"1/? (n/a)"} + {"error":"Invalid..."} + ... + + Status Codes: + + - **200** – no error + - **500** – server error + +#### [Inspect an image](#id23) + + `GET /images/`(*name*)`/json` +: Return low-level information on the image `name` + + **Example request**: + + GET /images/centos/json HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "id":"b750fe79269d2ec9a3c593ef05b4332b1d1a02a62b4accb2c21d589ff2f5f2dc", + "parent":"27cf784147099545", + "created":"2013-03-23T22:24:18.818426-07:00", + "container":"3d67245a8d72ecf13f33dffac9f79dcdf70f75acb84d308770391510e0c23ad0", + "container_config": + { + "Hostname":"", + "User":"", + "Memory":0, + "MemorySwap":0, + "AttachStdin":false, + "AttachStdout":false, + "AttachStderr":false, + "PortSpecs":null, + "Tty":true, + "OpenStdin":true, + "StdinOnce":false, + "Env":null, + "Cmd": ["/bin/bash"] + ,"Dns":null, + "Image":"centos", + "Volumes":null, + "VolumesFrom":"", + "WorkingDir":"" + }, + "Size": 6824592 + } + + Status Codes: + + - **200** – no error + - **404** – no such image + - **409** – conflict between containers and images + - **500** – server error + +#### [Get the history of an image](#id24) + + `GET /images/`(*name*)`/history` +: Return the history of the image `name` + + **Example request**: + + GET /images/fedora/history HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "Id":"b750fe79269d", + "Created":1364102658, + "CreatedBy":"/bin/bash" + }, + { + "Id":"27cf78414709", + "Created":1364068391, + "CreatedBy":"" + } + ] + + Status Codes: + + - **200** – no error + - **404** – no such image + - **500** – server error + +#### [Push an image on the registry](#id25) + + `POST /images/`(*name*)`/push` +: Push the image `name` on the registry + + **Example request**: + + POST /images/test/push HTTP/1.1 + {{ authConfig }} + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {"status":"Pushing..."} {"status":"Pushing", "progress":"1/? (n/a)"} + {"error":"Invalid..."} ... + + Query Parameters: + +   + + - **registry** – the registry you wan to push, optional + + Status Codes: + + - **200** – no error :statuscode 404: no such image :statuscode + 500: server error + +#### [Tag an image into a repository](#id26) + + `POST /images/`(*name*)`/tag` +: Tag the image `name` into a repository + + **Example request**: + + POST /images/test/tag?repo=myrepo&force=0 HTTP/1.1 + + **Example response**: + + HTTP/1.1 201 OK + + Query Parameters: + +   + + - **repo** – The repository to tag in + - **force** – 1/True/true or 0/False/false, default false + + Status Codes: + + - **201** – no error + - **400** – bad parameter + - **404** – no such image + - **409** – conflict + - **500** – server error + +#### [Remove an image](#id27) + + `DELETE /images/`(*name*) +: Remove the image `name` from the filesystem + + **Example request**: + + DELETE /images/test HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-type: application/json + + [ + {"Untagged":"3e2f21a89f"}, + {"Deleted":"3e2f21a89f"}, + {"Deleted":"53b4f83ac9"} + ] + + Status Codes: + + - **200** – no error + - **404** – no such image + - **409** – conflict + - **500** – server error + +#### [Search images](#id28) + + `GET /images/search` +: Search for an image in the docker index + + **Example request**: + + GET /images/search?term=sshd HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "Name":"cespare/sshd", + "Description":"" + }, + { + "Name":"johnfuller/sshd", + "Description":"" + }, + { + "Name":"dhrp/mongodb-sshd", + "Description":"" + } + ] + + :query term: term to search + :statuscode 200: no error + :statuscode 500: server error + +### [2.3 Misc](#id29) + +#### [Build an image from Dockerfile via stdin](#id30) + + `POST /build` +: Build an image from Dockerfile via stdin + + **Example request**: + + POST /build HTTP/1.1 + + {{ STREAM }} + + **Example response**: + + HTTP/1.1 200 OK + + {{ STREAM }} + + The stream must be a tar archive compressed with one of the + following algorithms: identity (no compression), gzip, bzip2, xz. + The archive must include a file called Dockerfile at its root. It + may include any number of other files, which will be accessible in + the build context (See the ADD build command). + + The Content-type header should be set to "application/tar". + + Query Parameters: + +   + + - **t** – repository name (and optionally a tag) to be applied to + the resulting image in case of success + - **q** – suppress verbose build output + - **nocache** – do not use the cache when building the image + + Status Codes: + + - **200** – no error + - **500** – server error + +#### [Check auth configuration](#id31) + + `POST /auth` +: Get the default username and email + + **Example request**: + + POST /auth HTTP/1.1 + Content-Type: application/json + + { + "username":"hannibal", + "password:"xxxx", + "email":"hannibal@a-team.com", + "serveraddress":"https://index.docker.io/v1/" + } + + **Example response**: + + HTTP/1.1 200 OK + + Status Codes: + + - **200** – no error + - **204** – no error + - **500** – server error + +#### [Display system-wide information](#id32) + + `GET /info` +: Display system-wide information + + **Example request**: + + GET /info HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "Containers":11, + "Images":16, + "Debug":false, + "NFd": 11, + "NGoroutines":21, + "MemoryLimit":true, + "SwapLimit":false, + "IPv4Forwarding":true + } + + Status Codes: + + - **200** – no error + - **500** – server error + +#### [Show the docker version information](#id33) + + `GET /version` +: Show the docker version information + > + > **Example request**: + > + > GET /version HTTP/1.1 + > + > **Example response**: + > + > HTTP/1.1 200 OK + > Content-Type: application/json + > + > { + > "Version":"0.2.2", + > "GitCommit":"5a2a5cc+CHANGES", + > "GoVersion":"go1.0.3" + > } + + Status Codes: + + - **200** – no error + - **500** – server error + +#### [Create a new image from a container’s changes](#id34) + + `POST /commit` +: Create a new image from a container’s changes + + **Example request**: + + POST /commit?container=44c004db4b17&m=message&repo=myrepo HTTP/1.1 + Content-Type: application/json + + { + "Cmd": ["cat", "/world"], + "PortSpecs":["22"] + } + + **Example response**: + + HTTP/1.1 201 OK + Content-Type: application/vnd.docker.raw-stream + + {"Id":"596069db4bf5"} + + Query Parameters: + +   + + - **container** – source container + - **repo** – repository + - **tag** – tag + - **m** – commit message + - **author** – author (eg. "John Hannibal Smith + \<[hannibal@a-team.com](mailto:hannibal%40a-team.com)\>") + + Status Codes: + + - **201** – no error + - **404** – no such container + - **500** – server error + +#### [Monitor Docker’s events](#id35) + + `GET /events` +: Get events from docker, either in real time via streaming, or via + polling (using since) + + **Example request**: + + GET /events?since=1374067924 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {"status":"create","id":"dfdf82bd3881","from":"ubuntu:latest","time":1374067924} + {"status":"start","id":"dfdf82bd3881","from":"ubuntu:latest","time":1374067924} + {"status":"stop","id":"dfdf82bd3881","from":"ubuntu:latest","time":1374067966} + {"status":"destroy","id":"dfdf82bd3881","from":"ubuntu:latest","time":1374067970} + + Query Parameters: + +   + + - **since** – timestamp used for polling + + Status Codes: + + - **200** – no error + - **500** – server error + +## [3. Going further](#id36) + +### [3.1 Inside ‘docker run’](#id37) + +Here are the steps of ‘docker run’ : + +- Create the container + +- If the status code is 404, it means the image doesn’t exists: + : - Try to pull it + - Then retry to create the container + +- Start the container + +- If you are not in detached mode: + : - Attach to the container, using logs=1 (to have stdout and + stderr from the container’s start) and stream=1 + +- If in detached mode or only stdin is attached: + : - Display the container’s id + +### [3.2 Hijacking](#id38) + +In this version of the API, /attach, uses hijacking to transport stdin, +stdout and stderr on the same socket. This might change in the future. + +### [3.3 CORS Requests](#id39) + +To enable cross origin requests to the remote api add the flag +"–api-enable-cors" when running docker in daemon mode. + + docker -d -H="192.168.1.9:4243" --api-enable-cors diff --git a/docs/sources/reference/api/docker_remote_api_v1.4.rst b/docs/sources/reference/api/archive/docker_remote_api_v1.4.rst similarity index 100% rename from docs/sources/reference/api/docker_remote_api_v1.4.rst rename to docs/sources/reference/api/archive/docker_remote_api_v1.4.rst diff --git a/docs/sources/reference/api/archive/docker_remote_api_v1.5.md b/docs/sources/reference/api/archive/docker_remote_api_v1.5.md new file mode 100644 index 0000000000..adef571b3f --- /dev/null +++ b/docs/sources/reference/api/archive/docker_remote_api_v1.5.md @@ -0,0 +1,1112 @@ +page_title: Remote API v1.5 +page_description: API Documentation for Docker +page_keywords: API, Docker, rcli, REST, documentation + +# [Docker Remote API v1.5](#id1) + +## [1. Brief introduction](#id2) + +- The Remote API is replacing rcli +- Default port in the docker daemon 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](#id3) + +### [2.1 Containers](#id4) + +#### [List containers](#id5) + + `GET /containers/json` +: List containers + + **Example request**: + + GET /containers/json?all=1&before=8dfafdbc3a40&size=1 HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "Id": "8dfafdbc3a40", + "Image": "ubuntu:latest", + "Command": "echo 1", + "Created": 1367854155, + "Status": "Exit 0", + "Ports":[{"PrivatePort": 2222, "PublicPort": 3333, "Type": "tcp"}], + "SizeRw":12288, + "SizeRootFs":0 + }, + { + "Id": "9cd87474be90", + "Image": "ubuntu:latest", + "Command": "echo 222222", + "Created": 1367854155, + "Status": "Exit 0", + "Ports":[], + "SizeRw":12288, + "SizeRootFs":0 + }, + { + "Id": "3176a2479c92", + "Image": "centos:latest", + "Command": "echo 3333333333333333", + "Created": 1367854154, + "Status": "Exit 0", + "Ports":[], + "SizeRw":12288, + "SizeRootFs":0 + }, + { + "Id": "4cb07b47f9fb", + "Image": "fedora:latest", + "Command": "echo 444444444444444444444444444444444", + "Created": 1367854152, + "Status": "Exit 0", + "Ports":[], + "SizeRw":12288, + "SizeRootFs":0 + } + ] + + Query Parameters: + +   + + - **all** – 1/True/true or 0/False/false, Show all containers. + Only running containers are shown by default + - **limit** – Show `limit` last created + containers, include non-running ones. + - **since** – Show only containers created since Id, include + non-running ones. + - **before** – Show only containers created before Id, include + non-running ones. + - **size** – 1/True/true or 0/False/false, Show the containers + sizes + + Status Codes: + + - **200** – no error + - **400** – bad parameter + - **500** – server error + +#### [Create a container](#id6) + + `POST /containers/create` +: Create a container + + **Example request**: + + POST /containers/create HTTP/1.1 + Content-Type: application/json + + { + "Hostname":"", + "User":"", + "Memory":0, + "MemorySwap":0, + "AttachStdin":false, + "AttachStdout":true, + "AttachStderr":true, + "PortSpecs":null, + "Privileged": false, + "Tty":false, + "OpenStdin":false, + "StdinOnce":false, + "Env":null, + "Cmd":[ + "date" + ], + "Dns":null, + "Image":"ubuntu", + "Volumes":{}, + "VolumesFrom":"", + "WorkingDir":"" + } + + **Example response**: + + HTTP/1.1 201 OK + Content-Type: application/json + + { + "Id":"e90e34656806" + "Warnings":[] + } + + Json Parameters: + +   + + - **config** – the container’s configuration + + Status Codes: + + - **201** – no error + - **404** – no such container + - **406** – impossible to attach (container not running) + - **500** – server error + +#### [Inspect a container](#id7) + + `GET /containers/`(*id*)`/json` +: Return low-level information on the container `id` + + + **Example request**: + + GET /containers/4fa6e0f0c678/json HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "Id": "4fa6e0f0c6786287e131c3852c58a2e01cc697a68231826813597e4994f1d6e2", + "Created": "2013-05-07T14:51:42.041847+02:00", + "Path": "date", + "Args": [], + "Config": { + "Hostname": "4fa6e0f0c678", + "User": "", + "Memory": 0, + "MemorySwap": 0, + "AttachStdin": false, + "AttachStdout": true, + "AttachStderr": true, + "PortSpecs": null, + "Tty": false, + "OpenStdin": false, + "StdinOnce": false, + "Env": null, + "Cmd": [ + "date" + ], + "Dns": null, + "Image": "ubuntu", + "Volumes": {}, + "VolumesFrom": "", + "WorkingDir":"" + }, + "State": { + "Running": false, + "Pid": 0, + "ExitCode": 0, + "StartedAt": "2013-05-07T14:51:42.087658+02:01360", + "Ghost": false + }, + "Image": "b750fe79269d2ec9a3c593ef05b4332b1d1a02a62b4accb2c21d589ff2f5f2dc", + "NetworkSettings": { + "IpAddress": "", + "IpPrefixLen": 0, + "Gateway": "", + "Bridge": "", + "PortMapping": null + }, + "SysInitPath": "/home/kitty/go/src/github.com/dotcloud/docker/bin/docker", + "ResolvConfPath": "/etc/resolv.conf", + "Volumes": {} + } + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### [List processes running inside a container](#id8) + + `GET /containers/`(*id*)`/top` +: List processes running inside the container `id` + + **Example request**: + + GET /containers/4fa6e0f0c678/top HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "Titles":[ + "USER", + "PID", + "%CPU", + "%MEM", + "VSZ", + "RSS", + "TTY", + "STAT", + "START", + "TIME", + "COMMAND" + ], + "Processes":[ + ["root","20147","0.0","0.1","18060","1864","pts/4","S","10:06","0:00","bash"], + ["root","20271","0.0","0.0","4312","352","pts/4","S+","10:07","0:00","sleep","10"] + ] + } + + Query Parameters: + +   + + - **ps\_args** – ps arguments to use (eg. aux) + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### [Inspect changes on a container’s filesystem](#id9) + + `GET /containers/`(*id*)`/changes` +: Inspect changes on container `id` ‘s filesystem + + **Example request**: + + GET /containers/4fa6e0f0c678/changes HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "Path":"/dev", + "Kind":0 + }, + { + "Path":"/dev/kmsg", + "Kind":1 + }, + { + "Path":"/test", + "Kind":1 + } + ] + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### [Export a container](#id10) + + `GET /containers/`(*id*)`/export` +: Export the contents of container `id` + + **Example request**: + + GET /containers/4fa6e0f0c678/export HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/octet-stream + + {{ STREAM }} + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### [Start a container](#id11) + + `POST /containers/`(*id*)`/start` +: Start the container `id` + + **Example request**: + + POST /containers/(id)/start HTTP/1.1 + Content-Type: application/json + + { + "Binds":["/tmp:/tmp"], + "LxcConf":[{"Key":"lxc.utsname","Value":"docker"}] + } + + **Example response**: + + HTTP/1.1 204 No Content + Content-Type: text/plain + + Json Parameters: + +   + + - **hostConfig** – the container’s host configuration (optional) + + Status Codes: + + - **204** – no error + - **404** – no such container + - **500** – server error + +#### [Stop a container](#id12) + + `POST /containers/`(*id*)`/stop` +: Stop the container `id` + + **Example request**: + + POST /containers/e90e34656806/stop?t=5 HTTP/1.1 + + **Example response**: + + HTTP/1.1 204 OK + + Query Parameters: + +   + + - **t** – number of seconds to wait before killing the container + + Status Codes: + + - **204** – no error + - **404** – no such container + - **500** – server error + +#### [Restart a container](#id13) + + `POST /containers/`(*id*)`/restart` +: Restart the container `id` + + **Example request**: + + POST /containers/e90e34656806/restart?t=5 HTTP/1.1 + + **Example response**: + + HTTP/1.1 204 OK + + Query Parameters: + +   + + - **t** – number of seconds to wait before killing the container + + Status Codes: + + - **204** – no error + - **404** – no such container + - **500** – server error + +#### [Kill a container](#id14) + + `POST /containers/`(*id*)`/kill` +: Kill the container `id` + + **Example request**: + + POST /containers/e90e34656806/kill HTTP/1.1 + + **Example response**: + + HTTP/1.1 204 OK + + Status Codes: + + - **204** – no error + - **404** – no such container + - **500** – server error + +#### [Attach to a container](#id15) + + `POST /containers/`(*id*)`/attach` +: Attach to the container `id` + + **Example request**: + + POST /containers/16253994b7c4/attach?logs=1&stream=0&stdout=1 HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/vnd.docker.raw-stream + + {{ STREAM }} + + Query Parameters: + +   + + - **logs** – 1/True/true or 0/False/false, return logs. Default + false + - **stream** – 1/True/true or 0/False/false, return stream. + Default false + - **stdin** – 1/True/true or 0/False/false, if stream=true, attach + to stdin. Default false + - **stdout** – 1/True/true or 0/False/false, if logs=true, return + stdout log, if stream=true, attach to stdout. Default false + - **stderr** – 1/True/true or 0/False/false, if logs=true, return + stderr log, if stream=true, attach to stderr. Default false + + Status Codes: + + - **200** – no error + - **400** – bad parameter + - **404** – no such container + - **500** – server error + +#### [Wait a container](#id16) + + `POST /containers/`(*id*)`/wait` +: Block until container `id` stops, then returns + the exit code + + **Example request**: + + POST /containers/16253994b7c4/wait HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {"StatusCode":0} + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### [Remove a container](#id17) + + `DELETE /containers/`(*id*) +: Remove the container `id` from the filesystem + + **Example request**: + + DELETE /containers/16253994b7c4?v=1 HTTP/1.1 + + **Example response**: + + HTTP/1.1 204 OK + + Query Parameters: + +   + + - **v** – 1/True/true or 0/False/false, Remove the volumes + associated to the container. Default false + + Status Codes: + + - **204** – no error + - **400** – bad parameter + - **404** – no such container + - **500** – server error + +#### [Copy files or folders from a container](#id18) + + `POST /containers/`(*id*)`/copy` +: Copy files or folders of container `id` + + **Example request**: + + POST /containers/4fa6e0f0c678/copy HTTP/1.1 + Content-Type: application/json + + { + "Resource":"test.txt" + } + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/octet-stream + + {{ STREAM }} + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +### [2.2 Images](#id19) + +#### [List Images](#id20) + + `GET /images/`(*format*) +: List images `format` could be json or viz (json + default) + + **Example request**: + + GET /images/json?all=0 HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "Repository":"ubuntu", + "Tag":"precise", + "Id":"b750fe79269d", + "Created":1364102658, + "Size":24653, + "VirtualSize":180116135 + }, + { + "Repository":"ubuntu", + "Tag":"12.04", + "Id":"b750fe79269d", + "Created":1364102658, + "Size":24653, + "VirtualSize":180116135 + } + ] + + **Example request**: + + GET /images/viz HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: text/plain + + digraph docker { + "d82cbacda43a" -> "074be284591f" + "1496068ca813" -> "08306dc45919" + "08306dc45919" -> "0e7893146ac2" + "b750fe79269d" -> "1496068ca813" + base -> "27cf78414709" [style=invis] + "f71189fff3de" -> "9a33b36209ed" + "27cf78414709" -> "b750fe79269d" + "0e7893146ac2" -> "d6434d954665" + "d6434d954665" -> "d82cbacda43a" + base -> "e9aa60c60128" [style=invis] + "074be284591f" -> "f71189fff3de" + "b750fe79269d" [label="b750fe79269d\nubuntu",shape=box,fillcolor="paleturquoise",style="filled,rounded"]; + "e9aa60c60128" [label="e9aa60c60128\ncentos",shape=box,fillcolor="paleturquoise",style="filled,rounded"]; + "9a33b36209ed" [label="9a33b36209ed\nfedora",shape=box,fillcolor="paleturquoise",style="filled,rounded"]; + base [style=invisible] + } + + Query Parameters: + +   + + - **all** – 1/True/true or 0/False/false, Show all containers. + Only running containers are shown by default + + Status Codes: + + - **200** – no error + - **400** – bad parameter + - **500** – server error + +#### [Create an image](#id21) + + `POST /images/create` +: Create an image, either by pull it from the registry or by importing + it + + **Example request**: + + POST /images/create?fromImage=ubuntu HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {"status":"Pulling..."} + {"status":"Pulling", "progress":"1/? (n/a)"} + {"error":"Invalid..."} + ... + + When using this endpoint to pull an image from the registry, the + `X-Registry-Auth` header can be used to include + a base64-encoded AuthConfig object. + + Query Parameters: + +   + + - **fromImage** – name of the image to pull + - **fromSrc** – source to import, - means stdin + - **repo** – repository + - **tag** – tag + - **registry** – the registry to pull from + + Status Codes: + + - **200** – no error + - **500** – server error + +#### [Insert a file in an image](#id22) + + `POST /images/`(*name*)`/insert` +: Insert a file from `url` in the image + `name` at `path` + + **Example request**: + + POST /images/test/insert?path=/usr&url=myurl HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {"status":"Inserting..."} + {"status":"Inserting", "progress":"1/? (n/a)"} + {"error":"Invalid..."} + ... + + Status Codes: + + - **200** – no error + - **500** – server error + +#### [Inspect an image](#id23) + + `GET /images/`(*name*)`/json` +: Return low-level information on the image `name` + + **Example request**: + + GET /images/centos/json HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "id":"b750fe79269d2ec9a3c593ef05b4332b1d1a02a62b4accb2c21d589ff2f5f2dc", + "parent":"27cf784147099545", + "created":"2013-03-23T22:24:18.818426-07:00", + "container":"3d67245a8d72ecf13f33dffac9f79dcdf70f75acb84d308770391510e0c23ad0", + "container_config": + { + "Hostname":"", + "User":"", + "Memory":0, + "MemorySwap":0, + "AttachStdin":false, + "AttachStdout":false, + "AttachStderr":false, + "PortSpecs":null, + "Tty":true, + "OpenStdin":true, + "StdinOnce":false, + "Env":null, + "Cmd": ["/bin/bash"] + ,"Dns":null, + "Image":"centos", + "Volumes":null, + "VolumesFrom":"", + "WorkingDir":"" + }, + "Size": 6824592 + } + + Status Codes: + + - **200** – no error + - **404** – no such image + - **500** – server error + +#### [Get the history of an image](#id24) + + `GET /images/`(*name*)`/history` +: Return the history of the image `name` + + **Example request**: + + GET /images/fedora/history HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "Id":"b750fe79269d", + "Created":1364102658, + "CreatedBy":"/bin/bash" + }, + { + "Id":"27cf78414709", + "Created":1364068391, + "CreatedBy":"" + } + ] + + Status Codes: + + - **200** – no error + - **404** – no such image + - **500** – server error + +#### [Push an image on the registry](#id25) + + `POST /images/`(*name*)`/push` +: Push the image `name` on the registry + + **Example request**: + + POST /images/test/push HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {"status":"Pushing..."} + {"status":"Pushing", "progress":"1/? (n/a)"} + {"error":"Invalid..."} + ... + + The `X-Registry-Auth` header can be used to + include a base64-encoded AuthConfig object. + + Query Parameters: + +   + + - **registry** – the registry you wan to push, optional + + Status Codes: + + - **200** – no error + - **404** – no such image + - **500** – server error + +#### [Tag an image into a repository](#id26) + + `POST /images/`(*name*)`/tag` +: Tag the image `name` into a repository + + **Example request**: + + POST /images/test/tag?repo=myrepo&force=0 HTTP/1.1 + + **Example response**: + + HTTP/1.1 201 OK + + Query Parameters: + +   + + - **repo** – The repository to tag in + - **force** – 1/True/true or 0/False/false, default false + + Status Codes: + + - **201** – no error + - **400** – bad parameter + - **404** – no such image + - **409** – conflict + - **500** – server error + +#### [Remove an image](#id27) + + `DELETE /images/`(*name*) +: Remove the image `name` from the filesystem + + **Example request**: + + DELETE /images/test HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-type: application/json + + [ + {"Untagged":"3e2f21a89f"}, + {"Deleted":"3e2f21a89f"}, + {"Deleted":"53b4f83ac9"} + ] + + Status Codes: + + - **200** – no error + - **404** – no such image + - **409** – conflict + - **500** – server error + +#### [Search images](#id28) + + `GET /images/search` +: Search for an image in the docker index + + **Example request**: + + GET /images/search?term=sshd HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "Name":"cespare/sshd", + "Description":"" + }, + { + "Name":"johnfuller/sshd", + "Description":"" + }, + { + "Name":"dhrp/mongodb-sshd", + "Description":"" + } + ] + + Query Parameters: + +   + + - **term** – term to search + + Status Codes: + + - **200** – no error + - **500** – server error + +### [2.3 Misc](#id29) + +#### [Build an image from Dockerfile via stdin](#id30) + + `POST /build` +: Build an image from Dockerfile via stdin + + **Example request**: + + POST /build HTTP/1.1 + + {{ STREAM }} + + **Example response**: + + HTTP/1.1 200 OK + + {{ STREAM }} + + The stream must be a tar archive compressed with one of the + following algorithms: identity (no compression), gzip, bzip2, xz. + The archive must include a file called Dockerfile at its root. It + may include any number of other files, which will be accessible in + the build context (See the ADD build command). + + The Content-type header should be set to "application/tar". + + Query Parameters: + +   + + - **t** – repository name (and optionally a tag) to be applied to + the resulting image in case of success + - **q** – suppress verbose build output + - **nocache** – do not use the cache when building the image + - **rm** – remove intermediate containers after a successful build + + Status Codes: + + - **200** – no error + - **500** – server error + +#### [Check auth configuration](#id31) + + `POST /auth` +: Get the default username and email + + **Example request**: + + POST /auth HTTP/1.1 + Content-Type: application/json + + { + "username":"hannibal", + "password:"xxxx", + "email":"hannibal@a-team.com", + "serveraddress":"https://index.docker.io/v1/" + } + + **Example response**: + + HTTP/1.1 200 OK + + Status Codes: + + - **200** – no error + - **204** – no error + - **500** – server error + +#### [Display system-wide information](#id32) + + `GET /info` +: Display system-wide information + + **Example request**: + + GET /info HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "Containers":11, + "Images":16, + "Debug":false, + "NFd": 11, + "NGoroutines":21, + "MemoryLimit":true, + "SwapLimit":false, + "IPv4Forwarding":true + } + + Status Codes: + + - **200** – no error + - **500** – server error + +#### [Show the docker version information](#id33) + + `GET /version` +: Show the docker version information + + **Example request**: + + GET /version HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "Version":"0.2.2", + "GitCommit":"5a2a5cc+CHANGES", + "GoVersion":"go1.0.3" + } + + Status Codes: + + - **200** – no error + - **500** – server error + +#### [Create a new image from a container’s changes](#id34) + + `POST /commit` +: Create a new image from a container’s changes + + **Example request**: + + POST /commit?container=44c004db4b17&m=message&repo=myrepo HTTP/1.1 + Content-Type: application/json + + { + "Cmd": ["cat", "/world"], + "PortSpecs":["22"] + } + + **Example response**: + + HTTP/1.1 201 OK + Content-Type: application/vnd.docker.raw-stream + + {"Id":"596069db4bf5"} + + Query Parameters: + +   + + - **container** – source container + - **repo** – repository + - **tag** – tag + - **m** – commit message + - **author** – author (eg. "John Hannibal Smith + \<[hannibal@a-team.com](mailto:hannibal%40a-team.com)\>") + + Status Codes: + + - **201** – no error + - **404** – no such container + - **500** – server error + +#### [Monitor Docker’s events](#id35) + + `GET /events` +: Get events from docker, either in real time via streaming, or via + polling (using since) + + **Example request**: + + GET /events?since=1374067924 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {"status":"create","id":"dfdf82bd3881","from":"ubuntu:latest","time":1374067924} + {"status":"start","id":"dfdf82bd3881","from":"ubuntu:latest","time":1374067924} + {"status":"stop","id":"dfdf82bd3881","from":"ubuntu:latest","time":1374067966} + {"status":"destroy","id":"dfdf82bd3881","from":"ubuntu:latest","time":1374067970} + + Query Parameters: + +   + + - **since** – timestamp used for polling + + Status Codes: + + - **200** – no error + - **500** – server error + +## [3. Going further](#id36) + +### [3.1 Inside ‘docker run’](#id37) + +Here are the steps of ‘docker run’ : + +- Create the container +- If the status code is 404, it means the image doesn’t exists: \* Try + to pull it \* Then retry to create the container +- Start the container +- If you are not in detached mode: \* Attach to the container, using + logs=1 (to have stdout and stderr from the container’s start) and + stream=1 +- If in detached mode or only stdin is attached: \* Display the + container’s id + +### [3.2 Hijacking](#id38) + +In this version of the API, /attach, uses hijacking to transport stdin, +stdout and stderr on the same socket. This might change in the future. + +### [3.3 CORS Requests](#id39) + +To enable cross origin requests to the remote api add the flag +"–api-enable-cors" when running docker in daemon mode. + + docker -d -H="192.168.1.9:4243" --api-enable-cors diff --git a/docs/sources/reference/api/docker_remote_api_v1.5.rst b/docs/sources/reference/api/archive/docker_remote_api_v1.5.rst similarity index 100% rename from docs/sources/reference/api/docker_remote_api_v1.5.rst rename to docs/sources/reference/api/archive/docker_remote_api_v1.5.rst diff --git a/docs/sources/reference/api/archive/docker_remote_api_v1.6.md b/docs/sources/reference/api/archive/docker_remote_api_v1.6.md new file mode 100644 index 0000000000..5bd0e46d50 --- /dev/null +++ b/docs/sources/reference/api/archive/docker_remote_api_v1.6.md @@ -0,0 +1,1215 @@ +page_title: Remote API v1.6 +page_description: API Documentation for Docker +page_keywords: API, Docker, rcli, REST, documentation + +# [Docker Remote API v1.6](#id1) + +## [1. Brief introduction](#id2) + +- The Remote API has replaced rcli +- The daemon listens on `unix:///var/run/docker.sock` +, but you can [*Bind Docker to another host/port or a Unix + socket*](../../../../use/basics/#bind-docker). +- 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](#id3) + +### [2.1 Containers](#id4) + +#### [List containers](#id5) + + `GET /containers/json` +: List containers + + **Example request**: + + GET /containers/json?all=1&before=8dfafdbc3a40&size=1 HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "Id": "8dfafdbc3a40", + "Image": "base:latest", + "Command": "echo 1", + "Created": 1367854155, + "Status": "Exit 0", + "Ports":[{"PrivatePort": 2222, "PublicPort": 3333, "Type": "tcp"}], + "SizeRw":12288, + "SizeRootFs":0 + }, + { + "Id": "9cd87474be90", + "Image": "base:latest", + "Command": "echo 222222", + "Created": 1367854155, + "Status": "Exit 0", + "Ports":[], + "SizeRw":12288, + "SizeRootFs":0 + }, + { + "Id": "3176a2479c92", + "Image": "base:latest", + "Command": "echo 3333333333333333", + "Created": 1367854154, + "Status": "Exit 0", + "Ports":[], + "SizeRw":12288, + "SizeRootFs":0 + }, + { + "Id": "4cb07b47f9fb", + "Image": "base:latest", + "Command": "echo 444444444444444444444444444444444", + "Created": 1367854152, + "Status": "Exit 0", + "Ports":[], + "SizeRw":12288, + "SizeRootFs":0 + } + ] + + Query Parameters: + +   + + - **all** – 1/True/true or 0/False/false, Show all containers. + Only running containers are shown by default + - **limit** – Show `limit` last created + containers, include non-running ones. + - **since** – Show only containers created since Id, include + non-running ones. + - **before** – Show only containers created before Id, include + non-running ones. + - **size** – 1/True/true or 0/False/false, Show the containers + sizes + + Status Codes: + + - **200** – no error + - **400** – bad parameter + - **500** – server error + +#### [Create a container](#id6) + + `POST /containers/create` +: Create a container + + **Example request**: + + POST /containers/create HTTP/1.1 + Content-Type: application/json + + { + "Hostname":"", + "User":"", + "Memory":0, + "MemorySwap":0, + "AttachStdin":false, + "AttachStdout":true, + "AttachStderr":true, + "ExposedPorts":{}, + "Tty":false, + "OpenStdin":false, + "StdinOnce":false, + "Env":null, + "Cmd":[ + "date" + ], + "Dns":null, + "Image":"base", + "Volumes":{}, + "VolumesFrom":"", + "WorkingDir":"" + } + + **Example response**: + + HTTP/1.1 201 OK + Content-Type: application/json + + { + "Id":"e90e34656806" + "Warnings":[] + } + + Json Parameters: + +   + + - **config** – the container’s configuration + + Query Parameters: + +   + + - **name** – container name to use + + Status Codes: + + - **201** – no error + - **404** – no such container + - **406** – impossible to attach (container not running) + - **500** – server error + + **More Complex Example request, in 2 steps.** **First, use create to + expose a Private Port, which can be bound back to a Public Port at + startup**: + + POST /containers/create HTTP/1.1 + Content-Type: application/json + + { + "Cmd":[ + "/usr/sbin/sshd","-D" + ], + "Image":"image-with-sshd", + "ExposedPorts":{"22/tcp":{}} + } + + **Example response**: + + HTTP/1.1 201 OK + Content-Type: application/json + + { + "Id":"e90e34656806" + "Warnings":[] + } + + **Second, start (using the ID returned above) the image we just + created, mapping the ssh port 22 to something on the host**: + + POST /containers/e90e34656806/start HTTP/1.1 + Content-Type: application/json + + { + "PortBindings": { "22/tcp": [{ "HostPort": "11022" }]} + } + + **Example response**: + + HTTP/1.1 204 No Content + Content-Type: text/plain; charset=utf-8 + Content-Length: 0 + + **Now you can ssh into your new container on port 11022.** + +#### [Inspect a container](#id7) + + `GET /containers/`(*id*)`/json` +: Return low-level information on the container `id` + + + **Example request**: + + GET /containers/4fa6e0f0c678/json HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "Id": "4fa6e0f0c6786287e131c3852c58a2e01cc697a68231826813597e4994f1d6e2", + "Created": "2013-05-07T14:51:42.041847+02:00", + "Path": "date", + "Args": [], + "Config": { + "Hostname": "4fa6e0f0c678", + "User": "", + "Memory": 0, + "MemorySwap": 0, + "AttachStdin": false, + "AttachStdout": true, + "AttachStderr": true, + "ExposedPorts": {}, + "Tty": false, + "OpenStdin": false, + "StdinOnce": false, + "Env": null, + "Cmd": [ + "date" + ], + "Dns": null, + "Image": "base", + "Volumes": {}, + "VolumesFrom": "", + "WorkingDir":"" + + }, + "State": { + "Running": false, + "Pid": 0, + "ExitCode": 0, + "StartedAt": "2013-05-07T14:51:42.087658+02:01360", + "Ghost": false + }, + "Image": "b750fe79269d2ec9a3c593ef05b4332b1d1a02a62b4accb2c21d589ff2f5f2dc", + "NetworkSettings": { + "IpAddress": "", + "IpPrefixLen": 0, + "Gateway": "", + "Bridge": "", + "PortMapping": null + }, + "SysInitPath": "/home/kitty/go/src/github.com/dotcloud/docker/bin/docker", + "ResolvConfPath": "/etc/resolv.conf", + "Volumes": {} + } + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### [List processes running inside a container](#id8) + + `GET /containers/`(*id*)`/top` +: List processes running inside the container `id` + + **Example request**: + + GET /containers/4fa6e0f0c678/top HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "Titles":[ + "USER", + "PID", + "%CPU", + "%MEM", + "VSZ", + "RSS", + "TTY", + "STAT", + "START", + "TIME", + "COMMAND" + ], + "Processes":[ + ["root","20147","0.0","0.1","18060","1864","pts/4","S","10:06","0:00","bash"], + ["root","20271","0.0","0.0","4312","352","pts/4","S+","10:07","0:00","sleep","10"] + ] + } + + Query Parameters: + +   + + - **ps\_args** – ps arguments to use (eg. aux) + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### [Inspect changes on a container’s filesystem](#id9) + + `GET /containers/`(*id*)`/changes` +: Inspect changes on container `id` ‘s filesystem + + **Example request**: + + GET /containers/4fa6e0f0c678/changes HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "Path":"/dev", + "Kind":0 + }, + { + "Path":"/dev/kmsg", + "Kind":1 + }, + { + "Path":"/test", + "Kind":1 + } + ] + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### [Export a container](#id10) + + `GET /containers/`(*id*)`/export` +: Export the contents of container `id` + + **Example request**: + + GET /containers/4fa6e0f0c678/export HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/octet-stream + + {{ STREAM }} + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### [Start a container](#id11) + + `POST /containers/`(*id*)`/start` +: Start the container `id` + + **Example request**: + + POST /containers/(id)/start HTTP/1.1 + Content-Type: application/json + + { + "Binds":["/tmp:/tmp"], + "LxcConf":{"lxc.utsname":"docker"}, + "ContainerIDFile": "", + "Privileged": false, + "PortBindings": {"22/tcp": [{HostIp:"", HostPort:""}]}, + "Links": [], + "PublishAllPorts": false + } + + **Example response**: + + HTTP/1.1 204 No Content + Content-Type: text/plain + + Json Parameters: + +   + + - **hostConfig** – the container’s host configuration (optional) + + Status Codes: + + - **204** – no error + - **404** – no such container + - **500** – server error + +#### [Stop a container](#id12) + + `POST /containers/`(*id*)`/stop` +: Stop the container `id` + + **Example request**: + + POST /containers/e90e34656806/stop?t=5 HTTP/1.1 + + **Example response**: + + HTTP/1.1 204 OK + + Query Parameters: + +   + + - **t** – number of seconds to wait before killing the container + + Status Codes: + + - **204** – no error + - **404** – no such container + - **500** – server error + +#### [Restart a container](#id13) + + `POST /containers/`(*id*)`/restart` +: Restart the container `id` + + **Example request**: + + POST /containers/e90e34656806/restart?t=5 HTTP/1.1 + + **Example response**: + + HTTP/1.1 204 OK + + Query Parameters: + +   + + - **t** – number of seconds to wait before killing the container + + Status Codes: + + - **204** – no error + - **404** – no such container + - **500** – server error + +#### [Kill a container](#id14) + + `POST /containers/`(*id*)`/kill` +: Kill the container `id` + + **Example request**: + + POST /containers/e90e34656806/kill HTTP/1.1 + + **Example response**: + + HTTP/1.1 204 OK + + Query Parameters: + +   + + - **signal** – Signal to send to the container (integer). When not + set, SIGKILL is assumed and the call will waits for the + container to exit. + + Status Codes: + + - **204** – no error + - **404** – no such container + - **500** – server error + +#### [Attach to a container](#id15) + + `POST /containers/`(*id*)`/attach` +: Attach to the container `id` + + **Example request**: + + POST /containers/16253994b7c4/attach?logs=1&stream=0&stdout=1 HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/vnd.docker.raw-stream + + {{ STREAM }} + + Query Parameters: + +   + + - **logs** – 1/True/true or 0/False/false, return logs. Default + false + - **stream** – 1/True/true or 0/False/false, return stream. + Default false + - **stdin** – 1/True/true or 0/False/false, if stream=true, attach + to stdin. Default false + - **stdout** – 1/True/true or 0/False/false, if logs=true, return + stdout log, if stream=true, attach to stdout. Default false + - **stderr** – 1/True/true or 0/False/false, if logs=true, return + stderr log, if stream=true, attach to stderr. Default false + + Status Codes: + + - **200** – no error + - **400** – bad parameter + - **404** – no such container + - **500** – server error + + **Stream details**: + + When using the TTY setting is enabled in + [`POST /containers/create` +](../../docker_remote_api_v1.9/#post--containers-create "POST /containers/create"), + the stream is the raw data from the process PTY and client’s stdin. + When the TTY is disabled, then the stream is multiplexed to separate + stdout and stderr. + + The format is a **Header** and a **Payload** (frame). + + **HEADER** + + The header will contain the information on which stream write the + stream (stdout or stderr). It also contain the size of the + associated frame encoded on the last 4 bytes (uint32). + + It is encoded on the first 8 bytes like this: + + header := [8]byte{STREAM_TYPE, 0, 0, 0, SIZE1, SIZE2, SIZE3, SIZE4} + + `STREAM_TYPE` can be: + + - 0: stdin (will be writen on stdout) + - 1: stdout + - 2: stderr + + `SIZE1, SIZE2, SIZE3, SIZE4` are the 4 bytes of + the uint32 size encoded as big endian. + + **PAYLOAD** + + The payload is the raw stream. + + **IMPLEMENTATION** + + The simplest way to implement the Attach protocol is the following: + + 1. Read 8 bytes + 2. chose stdout or stderr depending on the first byte + 3. Extract the frame size from the last 4 byets + 4. Read the extracted size and output it on the correct output + 5. Goto 1) + +#### [Wait a container](#id16) + + `POST /containers/`(*id*)`/wait` +: Block until container `id` stops, then returns + the exit code + + **Example request**: + + POST /containers/16253994b7c4/wait HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {"StatusCode":0} + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### [Remove a container](#id17) + + `DELETE /containers/`(*id*) +: Remove the container `id` from the filesystem + + **Example request**: + + DELETE /containers/16253994b7c4?v=1 HTTP/1.1 + + **Example response**: + + HTTP/1.1 204 OK + + Query Parameters: + +   + + - **v** – 1/True/true or 0/False/false, Remove the volumes + associated to the container. Default false + + Status Codes: + + - **204** – no error + - **400** – bad parameter + - **404** – no such container + - **500** – server error + +#### [Copy files or folders from a container](#id18) + + `POST /containers/`(*id*)`/copy` +: Copy files or folders of container `id` + + **Example request**: + + POST /containers/4fa6e0f0c678/copy HTTP/1.1 + Content-Type: application/json + + { + "Resource":"test.txt" + } + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/octet-stream + + {{ STREAM }} + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +### [2.2 Images](#id19) + +#### [List Images](#id20) + + `GET /images/`(*format*) +: List images `format` could be json or viz (json + default) + + **Example request**: + + GET /images/json?all=0 HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "Repository":"base", + "Tag":"ubuntu-12.10", + "Id":"b750fe79269d", + "Created":1364102658, + "Size":24653, + "VirtualSize":180116135 + }, + { + "Repository":"base", + "Tag":"ubuntu-quantal", + "Id":"b750fe79269d", + "Created":1364102658, + "Size":24653, + "VirtualSize":180116135 + } + ] + + **Example request**: + + GET /images/viz HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: text/plain + + digraph docker { + "d82cbacda43a" -> "074be284591f" + "1496068ca813" -> "08306dc45919" + "08306dc45919" -> "0e7893146ac2" + "b750fe79269d" -> "1496068ca813" + base -> "27cf78414709" [style=invis] + "f71189fff3de" -> "9a33b36209ed" + "27cf78414709" -> "b750fe79269d" + "0e7893146ac2" -> "d6434d954665" + "d6434d954665" -> "d82cbacda43a" + base -> "e9aa60c60128" [style=invis] + "074be284591f" -> "f71189fff3de" + "b750fe79269d" [label="b750fe79269d\nbase",shape=box,fillcolor="paleturquoise",style="filled,rounded"]; + "e9aa60c60128" [label="e9aa60c60128\nbase2",shape=box,fillcolor="paleturquoise",style="filled,rounded"]; + "9a33b36209ed" [label="9a33b36209ed\ntest",shape=box,fillcolor="paleturquoise",style="filled,rounded"]; + base [style=invisible] + } + + Query Parameters: + +   + + - **all** – 1/True/true or 0/False/false, Show all containers. + Only running containers are shown by default + + Status Codes: + + - **200** – no error + - **400** – bad parameter + - **500** – server error + +#### [Create an image](#id21) + + `POST /images/create` +: Create an image, either by pull it from the registry or by importing + it + + **Example request**: + + POST /images/create?fromImage=base HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {"status":"Pulling..."} + {"status":"Pulling", "progress":"1/? (n/a)"} + {"error":"Invalid..."} + ... + + When using this endpoint to pull an image from the registry, the + `X-Registry-Auth` header can be used to include + a base64-encoded AuthConfig object. + + Query Parameters: + +   + + - **fromImage** – name of the image to pull + - **fromSrc** – source to import, - means stdin + - **repo** – repository + - **tag** – tag + - **registry** – the registry to pull from + + Status Codes: + + - **200** – no error + - **500** – server error + +#### [Insert a file in an image](#id22) + + `POST /images/`(*name*)`/insert` +: Insert a file from `url` in the image + `name` at `path` + + **Example request**: + + POST /images/test/insert?path=/usr&url=myurl HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {"status":"Inserting..."} + {"status":"Inserting", "progress":"1/? (n/a)"} + {"error":"Invalid..."} + ... + + Status Codes: + + - **200** – no error + - **500** – server error + +#### [Inspect an image](#id23) + + `GET /images/`(*name*)`/json` +: Return low-level information on the image `name` + + **Example request**: + + GET /images/base/json HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "id":"b750fe79269d2ec9a3c593ef05b4332b1d1a02a62b4accb2c21d589ff2f5f2dc", + "parent":"27cf784147099545", + "created":"2013-03-23T22:24:18.818426-07:00", + "container":"3d67245a8d72ecf13f33dffac9f79dcdf70f75acb84d308770391510e0c23ad0", + "container_config": + { + "Hostname":"", + "User":"", + "Memory":0, + "MemorySwap":0, + "AttachStdin":false, + "AttachStdout":false, + "AttachStderr":false, + "ExposedPorts":{}, + "Tty":true, + "OpenStdin":true, + "StdinOnce":false, + "Env":null, + "Cmd": ["/bin/bash"] + ,"Dns":null, + "Image":"base", + "Volumes":null, + "VolumesFrom":"", + "WorkingDir":"" + }, + "Size": 6824592 + } + + Status Codes: + + - **200** – no error + - **404** – no such image + - **500** – server error + +#### [Get the history of an image](#id24) + + `GET /images/`(*name*)`/history` +: Return the history of the image `name` + + **Example request**: + + GET /images/base/history HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "Id":"b750fe79269d", + "Created":1364102658, + "CreatedBy":"/bin/bash" + }, + { + "Id":"27cf78414709", + "Created":1364068391, + "CreatedBy":"" + } + ] + + Status Codes: + + - **200** – no error + - **404** – no such image + - **500** – server error + +#### [Push an image on the registry](#id25) + + `POST /images/`(*name*)`/push` +: Push the image `name` on the registry + + **Example request**: + + POST /images/test/push HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {"status":"Pushing..."} {"status":"Pushing", "progress":"1/? (n/a)"} + {"error":"Invalid..."} ... + + > The `X-Registry-Auth` header can be used to + > include a base64-encoded AuthConfig object. + + Query Parameters: + +   + + - **registry** – the registry you wan to push, optional + + Status Codes: + + - **200** – no error :statuscode 404: no such image :statuscode + 500: server error + +#### [Tag an image into a repository](#id26) + + `POST /images/`(*name*)`/tag` +: Tag the image `name` into a repository + + **Example request**: + + POST /images/test/tag?repo=myrepo&force=0 HTTP/1.1 + + **Example response**: + + HTTP/1.1 201 OK + + Query Parameters: + +   + + - **repo** – The repository to tag in + - **force** – 1/True/true or 0/False/false, default false + + Status Codes: + + - **201** – no error + - **400** – bad parameter + - **404** – no such image + - **409** – conflict + - **500** – server error + +#### [Remove an image](#id27) + + `DELETE /images/`(*name*) +: Remove the image `name` from the filesystem + + **Example request**: + + DELETE /images/test HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-type: application/json + + [ + {"Untagged":"3e2f21a89f"}, + {"Deleted":"3e2f21a89f"}, + {"Deleted":"53b4f83ac9"} + ] + + Status Codes: + + - **200** – no error + - **404** – no such image + - **409** – conflict + - **500** – server error + +#### [Search images](#id28) + + `GET /images/search` +: Search for an image in the docker index + + **Example request**: + + GET /images/search?term=sshd HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "Name":"cespare/sshd", + "Description":"" + }, + { + "Name":"johnfuller/sshd", + "Description":"" + }, + { + "Name":"dhrp/mongodb-sshd", + "Description":"" + } + ] + + :query term: term to search + :statuscode 200: no error + :statuscode 500: server error + +### [2.3 Misc](#id29) + +#### [Build an image from Dockerfile via stdin](#id30) + + `POST /build` +: Build an image from Dockerfile via stdin + + **Example request**: + + POST /build HTTP/1.1 + + {{ STREAM }} + + **Example response**: + + HTTP/1.1 200 OK + + {{ STREAM }} + + The stream must be a tar archive compressed with one of the + following algorithms: identity (no compression), gzip, bzip2, xz. + The archive must include a file called Dockerfile at its root. It + may include any number of other files, which will be accessible in + the build context (See the ADD build command). + + The Content-type header should be set to "application/tar". + + Query Parameters: + +   + + - **t** – repository name (and optionally a tag) to be applied to + the resulting image in case of success + - **q** – suppress verbose build output + - **nocache** – do not use the cache when building the image + + Status Codes: + + - **200** – no error + - **500** – server error + +#### [Check auth configuration](#id31) + + `POST /auth` +: Get the default username and email + + **Example request**: + + POST /auth HTTP/1.1 + Content-Type: application/json + + { + "username":"hannibal", + "password:"xxxx", + "email":"hannibal@a-team.com", + "serveraddress":"https://index.docker.io/v1/" + } + + **Example response**: + + HTTP/1.1 200 OK + + Status Codes: + + - **200** – no error + - **204** – no error + - **500** – server error + +#### [Display system-wide information](#id32) + + `GET /info` +: Display system-wide information + + **Example request**: + + GET /info HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "Containers":11, + "Images":16, + "Debug":false, + "NFd": 11, + "NGoroutines":21, + "MemoryLimit":true, + "SwapLimit":false, + "IPv4Forwarding":true + } + + Status Codes: + + - **200** – no error + - **500** – server error + +#### [Show the docker version information](#id33) + + `GET /version` +: Show the docker version information + + **Example request**: + + GET /version HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "Version":"0.2.2", + "GitCommit":"5a2a5cc+CHANGES", + "GoVersion":"go1.0.3" + } + + Status Codes: + + - **200** – no error + - **500** – server error + +#### [Create a new image from a container’s changes](#id34) + + `POST /commit` +: Create a new image from a container’s changes + + **Example request**: + + POST /commit?container=44c004db4b17&m=message&repo=myrepo HTTP/1.1 + Content-Type: application/json + + { + "Cmd": ["cat", "/world"], + "ExposedPorts":{"22/tcp":{}} + } + + **Example response**: + + HTTP/1.1 201 OK + Content-Type: application/vnd.docker.raw-stream + + {"Id":"596069db4bf5"} + + Query Parameters: + +   + + - **container** – source container + - **repo** – repository + - **tag** – tag + - **m** – commit message + - **author** – author (eg. "John Hannibal Smith + \<[hannibal@a-team.com](mailto:hannibal%40a-team.com)\>") + + Status Codes: + + - **201** – no error + - **404** – no such container + - **500** – server error + +#### [Monitor Docker’s events](#id35) + + `GET /events` +: Get events from docker, either in real time via streaming, or via + polling (using since) + + **Example request**: + + GET /events?since=1374067924 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {"status":"create","id":"dfdf82bd3881","from":"base:latest","time":1374067924} + {"status":"start","id":"dfdf82bd3881","from":"base:latest","time":1374067924} + {"status":"stop","id":"dfdf82bd3881","from":"base:latest","time":1374067966} + {"status":"destroy","id":"dfdf82bd3881","from":"base:latest","time":1374067970} + + Query Parameters: + +   + + - **since** – timestamp used for polling + + Status Codes: + + - **200** – no error + - **500** – server error + +## [3. Going further](#id36) + +### [3.1 Inside ‘docker run’](#id37) + +Here are the steps of ‘docker run’ : + +- Create the container + +- If the status code is 404, it means the image doesn’t exists: + : - Try to pull it + - Then retry to create the container + +- Start the container + +- If you are not in detached mode: + : - Attach to the container, using logs=1 (to have stdout and + stderr from the container’s start) and stream=1 + +- If in detached mode or only stdin is attached: + : - Display the container’s id + +### [3.2 Hijacking](#id38) + +In this version of the API, /attach, uses hijacking to transport stdin, +stdout and stderr on the same socket. This might change in the future. + +### [3.3 CORS Requests](#id39) + +To enable cross origin requests to the remote api add the flag +"–api-enable-cors" when running docker in daemon mode. + + docker -d -H="192.168.1.9:4243" --api-enable-cors diff --git a/docs/sources/reference/api/docker_remote_api_v1.6.rst b/docs/sources/reference/api/archive/docker_remote_api_v1.6.rst similarity index 100% rename from docs/sources/reference/api/docker_remote_api_v1.6.rst rename to docs/sources/reference/api/archive/docker_remote_api_v1.6.rst diff --git a/docs/sources/reference/api/archive/docker_remote_api_v1.7.md b/docs/sources/reference/api/archive/docker_remote_api_v1.7.md new file mode 100644 index 0000000000..ac02aa5d0e --- /dev/null +++ b/docs/sources/reference/api/archive/docker_remote_api_v1.7.md @@ -0,0 +1,1206 @@ +page_title: Remote API v1.7 +page_description: API Documentation for Docker +page_keywords: API, Docker, rcli, REST, documentation + +# [Docker Remote API v1.7](#id1) + +## [1. Brief introduction](#id2) + +- The Remote API has replaced rcli +- The daemon listens on `unix:///var/run/docker.sock` +, but you can [*Bind Docker to another host/port or a Unix + socket*](../../../../use/basics/#bind-docker). +- 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](#id3) + +### [2.1 Containers](#id4) + +#### [List containers](#id5) + + `GET /containers/json` +: List containers + + **Example request**: + + GET /containers/json?all=1&before=8dfafdbc3a40&size=1 HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "Id": "8dfafdbc3a40", + "Image": "base:latest", + "Command": "echo 1", + "Created": 1367854155, + "Status": "Exit 0", + "Ports":[{"PrivatePort": 2222, "PublicPort": 3333, "Type": "tcp"}], + "SizeRw":12288, + "SizeRootFs":0 + }, + { + "Id": "9cd87474be90", + "Image": "base:latest", + "Command": "echo 222222", + "Created": 1367854155, + "Status": "Exit 0", + "Ports":[], + "SizeRw":12288, + "SizeRootFs":0 + }, + { + "Id": "3176a2479c92", + "Image": "base:latest", + "Command": "echo 3333333333333333", + "Created": 1367854154, + "Status": "Exit 0", + "Ports":[], + "SizeRw":12288, + "SizeRootFs":0 + }, + { + "Id": "4cb07b47f9fb", + "Image": "base:latest", + "Command": "echo 444444444444444444444444444444444", + "Created": 1367854152, + "Status": "Exit 0", + "Ports":[], + "SizeRw":12288, + "SizeRootFs":0 + } + ] + + Query Parameters: + +   + + - **all** – 1/True/true or 0/False/false, Show all containers. + Only running containers are shown by default + - **limit** – Show `limit` last created + containers, include non-running ones. + - **since** – Show only containers created since Id, include + non-running ones. + - **before** – Show only containers created before Id, include + non-running ones. + - **size** – 1/True/true or 0/False/false, Show the containers + sizes + + Status Codes: + + - **200** – no error + - **400** – bad parameter + - **500** – server error + +#### [Create a container](#id6) + + `POST /containers/create` +: Create a container + + **Example request**: + + POST /containers/create HTTP/1.1 + Content-Type: application/json + + { + "Hostname":"", + "User":"", + "Memory":0, + "MemorySwap":0, + "AttachStdin":false, + "AttachStdout":true, + "AttachStderr":true, + "PortSpecs":null, + "Tty":false, + "OpenStdin":false, + "StdinOnce":false, + "Env":null, + "Cmd":[ + "date" + ], + "Dns":null, + "Image":"base", + "Volumes":{ + "/tmp": {} + }, + "VolumesFrom":"", + "WorkingDir":"", + "ExposedPorts":{ + "22/tcp": {} + } + } + + **Example response**: + + HTTP/1.1 201 OK + Content-Type: application/json + + { + "Id":"e90e34656806" + "Warnings":[] + } + + Json Parameters: + +   + + - **config** – the container’s configuration + + Status Codes: + + - **201** – no error + - **404** – no such container + - **406** – impossible to attach (container not running) + - **500** – server error + +#### [Inspect a container](#id7) + + `GET /containers/`(*id*)`/json` +: Return low-level information on the container `id` + + + **Example request**: + + GET /containers/4fa6e0f0c678/json HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "Id": "4fa6e0f0c6786287e131c3852c58a2e01cc697a68231826813597e4994f1d6e2", + "Created": "2013-05-07T14:51:42.041847+02:00", + "Path": "date", + "Args": [], + "Config": { + "Hostname": "4fa6e0f0c678", + "User": "", + "Memory": 0, + "MemorySwap": 0, + "AttachStdin": false, + "AttachStdout": true, + "AttachStderr": true, + "PortSpecs": null, + "Tty": false, + "OpenStdin": false, + "StdinOnce": false, + "Env": null, + "Cmd": [ + "date" + ], + "Dns": null, + "Image": "base", + "Volumes": {}, + "VolumesFrom": "", + "WorkingDir":"" + + }, + "State": { + "Running": false, + "Pid": 0, + "ExitCode": 0, + "StartedAt": "2013-05-07T14:51:42.087658+02:01360", + "Ghost": false + }, + "Image": "b750fe79269d2ec9a3c593ef05b4332b1d1a02a62b4accb2c21d589ff2f5f2dc", + "NetworkSettings": { + "IpAddress": "", + "IpPrefixLen": 0, + "Gateway": "", + "Bridge": "", + "PortMapping": null + }, + "SysInitPath": "/home/kitty/go/src/github.com/dotcloud/docker/bin/docker", + "ResolvConfPath": "/etc/resolv.conf", + "Volumes": {} + } + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### [List processes running inside a container](#id8) + + `GET /containers/`(*id*)`/top` +: List processes running inside the container `id` + + **Example request**: + + GET /containers/4fa6e0f0c678/top HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "Titles":[ + "USER", + "PID", + "%CPU", + "%MEM", + "VSZ", + "RSS", + "TTY", + "STAT", + "START", + "TIME", + "COMMAND" + ], + "Processes":[ + ["root","20147","0.0","0.1","18060","1864","pts/4","S","10:06","0:00","bash"], + ["root","20271","0.0","0.0","4312","352","pts/4","S+","10:07","0:00","sleep","10"] + ] + } + + Query Parameters: + +   + + - **ps\_args** – ps arguments to use (eg. aux) + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### [Inspect changes on a container’s filesystem](#id9) + + `GET /containers/`(*id*)`/changes` +: Inspect changes on container `id` ‘s filesystem + + **Example request**: + + GET /containers/4fa6e0f0c678/changes HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "Path":"/dev", + "Kind":0 + }, + { + "Path":"/dev/kmsg", + "Kind":1 + }, + { + "Path":"/test", + "Kind":1 + } + ] + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### [Export a container](#id10) + + `GET /containers/`(*id*)`/export` +: Export the contents of container `id` + + **Example request**: + + GET /containers/4fa6e0f0c678/export HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/octet-stream + + {{ STREAM }} + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### [Start a container](#id11) + + `POST /containers/`(*id*)`/start` +: Start the container `id` + + **Example request**: + + POST /containers/(id)/start HTTP/1.1 + Content-Type: application/json + + { + "Binds":["/tmp:/tmp"], + "LxcConf":{"lxc.utsname":"docker"}, + "PortBindings":{ "22/tcp": [{ "HostPort": "11022" }] }, + "Privileged":false, + "PublishAllPorts":false + } + + Binds need to reference Volumes that were defined during container + creation. + + **Example response**: + + HTTP/1.1 204 No Content + Content-Type: text/plain + + Json Parameters: + +   + + - **hostConfig** – the container’s host configuration (optional) + + Status Codes: + + - **204** – no error + - **404** – no such container + - **500** – server error + +#### [Stop a container](#id12) + + `POST /containers/`(*id*)`/stop` +: Stop the container `id` + + **Example request**: + + POST /containers/e90e34656806/stop?t=5 HTTP/1.1 + + **Example response**: + + HTTP/1.1 204 OK + + Query Parameters: + +   + + - **t** – number of seconds to wait before killing the container + + Status Codes: + + - **204** – no error + - **404** – no such container + - **500** – server error + +#### [Restart a container](#id13) + + `POST /containers/`(*id*)`/restart` +: Restart the container `id` + + **Example request**: + + POST /containers/e90e34656806/restart?t=5 HTTP/1.1 + + **Example response**: + + HTTP/1.1 204 OK + + Query Parameters: + +   + + - **t** – number of seconds to wait before killing the container + + Status Codes: + + - **204** – no error + - **404** – no such container + - **500** – server error + +#### [Kill a container](#id14) + + `POST /containers/`(*id*)`/kill` +: Kill the container `id` + + **Example request**: + + POST /containers/e90e34656806/kill HTTP/1.1 + + **Example response**: + + HTTP/1.1 204 OK + + Status Codes: + + - **204** – no error + - **404** – no such container + - **500** – server error + +#### [Attach to a container](#id15) + + `POST /containers/`(*id*)`/attach` +: Attach to the container `id` + + **Example request**: + + POST /containers/16253994b7c4/attach?logs=1&stream=0&stdout=1 HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/vnd.docker.raw-stream + + {{ STREAM }} + + Query Parameters: + +   + + - **logs** – 1/True/true or 0/False/false, return logs. Default + false + - **stream** – 1/True/true or 0/False/false, return stream. + Default false + - **stdin** – 1/True/true or 0/False/false, if stream=true, attach + to stdin. Default false + - **stdout** – 1/True/true or 0/False/false, if logs=true, return + stdout log, if stream=true, attach to stdout. Default false + - **stderr** – 1/True/true or 0/False/false, if logs=true, return + stderr log, if stream=true, attach to stderr. Default false + + Status Codes: + + - **200** – no error + - **400** – bad parameter + - **404** – no such container + - **500** – server error + + **Stream details**: + + When using the TTY setting is enabled in + [`POST /containers/create` +](../../docker_remote_api_v1.9/#post--containers-create "POST /containers/create"), + the stream is the raw data from the process PTY and client’s stdin. + When the TTY is disabled, then the stream is multiplexed to separate + stdout and stderr. + + The format is a **Header** and a **Payload** (frame). + + **HEADER** + + The header will contain the information on which stream write the + stream (stdout or stderr). It also contain the size of the + associated frame encoded on the last 4 bytes (uint32). + + It is encoded on the first 8 bytes like this: + + header := [8]byte{STREAM_TYPE, 0, 0, 0, SIZE1, SIZE2, SIZE3, SIZE4} + + `STREAM_TYPE` can be: + + - 0: stdin (will be writen on stdout) + - 1: stdout + - 2: stderr + + `SIZE1, SIZE2, SIZE3, SIZE4` are the 4 bytes of + the uint32 size encoded as big endian. + + **PAYLOAD** + + The payload is the raw stream. + + **IMPLEMENTATION** + + The simplest way to implement the Attach protocol is the following: + + 1. Read 8 bytes + 2. chose stdout or stderr depending on the first byte + 3. Extract the frame size from the last 4 byets + 4. Read the extracted size and output it on the correct output + 5. Goto 1) + +#### [Wait a container](#id16) + + `POST /containers/`(*id*)`/wait` +: Block until container `id` stops, then returns + the exit code + + **Example request**: + + POST /containers/16253994b7c4/wait HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {"StatusCode":0} + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### [Remove a container](#id17) + + `DELETE /containers/`(*id*) +: Remove the container `id` from the filesystem + + **Example request**: + + DELETE /containers/16253994b7c4?v=1 HTTP/1.1 + + **Example response**: + + HTTP/1.1 204 OK + + Query Parameters: + +   + + - **v** – 1/True/true or 0/False/false, Remove the volumes + associated to the container. Default false + + Status Codes: + + - **204** – no error + - **400** – bad parameter + - **404** – no such container + - **500** – server error + +#### [Copy files or folders from a container](#id18) + + `POST /containers/`(*id*)`/copy` +: Copy files or folders of container `id` + + **Example request**: + + POST /containers/4fa6e0f0c678/copy HTTP/1.1 + Content-Type: application/json + + { + "Resource":"test.txt" + } + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/octet-stream + + {{ STREAM }} + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +### [2.2 Images](#id19) + +#### [List Images](#id20) + + `GET /images/json` +: **Example request**: + + GET /images/json?all=0 HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "RepoTags": [ + "ubuntu:12.04", + "ubuntu:precise", + "ubuntu:latest" + ], + "Id": "8dbd9e392a964056420e5d58ca5cc376ef18e2de93b5cc90e868a1bbc8318c1c", + "Created": 1365714795, + "Size": 131506275, + "VirtualSize": 131506275 + }, + { + "RepoTags": [ + "ubuntu:12.10", + "ubuntu:quantal" + ], + "ParentId": "27cf784147099545", + "Id": "b750fe79269d2ec9a3c593ef05b4332b1d1a02a62b4accb2c21d589ff2f5f2dc", + "Created": 1364102658, + "Size": 24653, + "VirtualSize": 180116135 + } + ] + +#### [Create an image](#id21) + + `POST /images/create` +: Create an image, either by pull it from the registry or by importing + it + + **Example request**: + + POST /images/create?fromImage=base HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {"status":"Pulling..."} + {"status":"Pulling", "progress":"1/? (n/a)"} + {"error":"Invalid..."} + ... + + When using this endpoint to pull an image from the registry, the + `X-Registry-Auth` header can be used to include + a base64-encoded AuthConfig object. + + Query Parameters: + +   + + - **fromImage** – name of the image to pull + - **fromSrc** – source to import, - means stdin + - **repo** – repository + - **tag** – tag + - **registry** – the registry to pull from + + Request Headers: + +   + + - **X-Registry-Auth** – base64-encoded AuthConfig object + + Status Codes: + + - **200** – no error + - **500** – server error + +#### [Insert a file in an image](#id22) + + `POST /images/`(*name*)`/insert` +: Insert a file from `url` in the image + `name` at `path` + + **Example request**: + + POST /images/test/insert?path=/usr&url=myurl HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {"status":"Inserting..."} + {"status":"Inserting", "progress":"1/? (n/a)"} + {"error":"Invalid..."} + ... + + Status Codes: + + - **200** – no error + - **500** – server error + +#### [Inspect an image](#id23) + + `GET /images/`(*name*)`/json` +: Return low-level information on the image `name` + + **Example request**: + + GET /images/base/json HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "id":"b750fe79269d2ec9a3c593ef05b4332b1d1a02a62b4accb2c21d589ff2f5f2dc", + "parent":"27cf784147099545", + "created":"2013-03-23T22:24:18.818426-07:00", + "container":"3d67245a8d72ecf13f33dffac9f79dcdf70f75acb84d308770391510e0c23ad0", + "container_config": + { + "Hostname":"", + "User":"", + "Memory":0, + "MemorySwap":0, + "AttachStdin":false, + "AttachStdout":false, + "AttachStderr":false, + "PortSpecs":null, + "Tty":true, + "OpenStdin":true, + "StdinOnce":false, + "Env":null, + "Cmd": ["/bin/bash"] + ,"Dns":null, + "Image":"base", + "Volumes":null, + "VolumesFrom":"", + "WorkingDir":"" + }, + "Size": 6824592 + } + + Status Codes: + + - **200** – no error + - **404** – no such image + - **500** – server error + +#### [Get the history of an image](#id24) + + `GET /images/`(*name*)`/history` +: Return the history of the image `name` + + **Example request**: + + GET /images/base/history HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "Id":"b750fe79269d", + "Created":1364102658, + "CreatedBy":"/bin/bash" + }, + { + "Id":"27cf78414709", + "Created":1364068391, + "CreatedBy":"" + } + ] + + Status Codes: + + - **200** – no error + - **404** – no such image + - **500** – server error + +#### [Push an image on the registry](#id25) + + `POST /images/`(*name*)`/push` +: Push the image `name` on the registry + + **Example request**: + + POST /images/test/push HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {"status":"Pushing..."} + {"status":"Pushing", "progress":"1/? (n/a)"} + {"error":"Invalid..."} + ... + + Query Parameters: + +   + + - **registry** – the registry you wan to push, optional + + Request Headers: + +   + + - **X-Registry-Auth** – include a base64-encoded AuthConfig + object. + + Status Codes: + + - **200** – no error + - **404** – no such image + - **500** – server error + +#### [Tag an image into a repository](#id26) + + `POST /images/`(*name*)`/tag` +: Tag the image `name` into a repository + + **Example request**: + + POST /images/test/tag?repo=myrepo&force=0 HTTP/1.1 + + **Example response**: + + HTTP/1.1 201 OK + + Query Parameters: + +   + + - **repo** – The repository to tag in + - **force** – 1/True/true or 0/False/false, default false + + Status Codes: + + - **201** – no error + - **400** – bad parameter + - **404** – no such image + - **409** – conflict + - **500** – server error + +#### [Remove an image](#id27) + + `DELETE /images/`(*name*) +: Remove the image `name` from the filesystem + + **Example request**: + + DELETE /images/test HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-type: application/json + + [ + {"Untagged":"3e2f21a89f"}, + {"Deleted":"3e2f21a89f"}, + {"Deleted":"53b4f83ac9"} + ] + + Status Codes: + + - **200** – no error + - **404** – no such image + - **409** – conflict + - **500** – server error + +#### [Search images](#id28) + + `GET /images/search` +: Search for an image in the docker index. + +> **Note**: +> The response keys have changed from API v1.6 to reflect the JSON +> sent by the registry server to the docker daemon’s request. + + **Example request**: + + GET /images/search?term=sshd HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "description": "", + "is_official": false, + "is_trusted": false, + "name": "wma55/u1210sshd", + "star_count": 0 + }, + { + "description": "", + "is_official": false, + "is_trusted": false, + "name": "jdswinbank/sshd", + "star_count": 0 + }, + { + "description": "", + "is_official": false, + "is_trusted": false, + "name": "vgauthier/sshd", + "star_count": 0 + } + ... + ] + + Query Parameters: + +   + + - **term** – term to search + + Status Codes: + + - **200** – no error + - **500** – server error + +### [2.3 Misc](#id29) + +#### [Build an image from Dockerfile via stdin](#id30) + + `POST /build` +: Build an image from Dockerfile via stdin + + **Example request**: + + POST /build HTTP/1.1 + + {{ STREAM }} + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {{ STREAM }} + + The stream must be a tar archive compressed with one of the + following algorithms: identity (no compression), gzip, bzip2, xz. + + The archive must include a file called `Dockerfile` + at its root. It may include any number of other files, + which will be accessible in the build context (See the [*ADD build + command*](../../../builder/#dockerbuilder)). + + Query Parameters: + +   + + - **t** – repository name (and optionally a tag) to be applied to + the resulting image in case of success + - **q** – suppress verbose build output + - **nocache** – do not use the cache when building the image + + Request Headers: + +   + + - **Content-type** – should be set to + `"application/tar"`. + + Status Codes: + + - **200** – no error + - **500** – server error + +#### [Check auth configuration](#id31) + + `POST /auth` +: Get the default username and email + + **Example request**: + + POST /auth HTTP/1.1 + Content-Type: application/json + + { + "username":"hannibal", + "password:"xxxx", + "email":"hannibal@a-team.com", + "serveraddress":"https://index.docker.io/v1/" + } + + **Example response**: + + HTTP/1.1 200 OK + + Status Codes: + + - **200** – no error + - **204** – no error + - **500** – server error + +#### [Display system-wide information](#id32) + + `GET /info` +: Display system-wide information + + **Example request**: + + GET /info HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "Containers":11, + "Images":16, + "Debug":false, + "NFd": 11, + "NGoroutines":21, + "MemoryLimit":true, + "SwapLimit":false, + "IPv4Forwarding":true + } + + Status Codes: + + - **200** – no error + - **500** – server error + +#### [Show the docker version information](#id33) + + `GET /version` +: Show the docker version information + + **Example request**: + + GET /version HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "Version":"0.2.2", + "GitCommit":"5a2a5cc+CHANGES", + "GoVersion":"go1.0.3" + } + + Status Codes: + + - **200** – no error + - **500** – server error + +#### [Create a new image from a container’s changes](#id34) + + `POST /commit` +: Create a new image from a container’s changes + + **Example request**: + + POST /commit?container=44c004db4b17&m=message&repo=myrepo HTTP/1.1 + + **Example response**: + + HTTP/1.1 201 OK + Content-Type: application/vnd.docker.raw-stream + + {"Id":"596069db4bf5"} + + Query Parameters: + +   + + - **container** – source container + - **repo** – repository + - **tag** – tag + - **m** – commit message + - **author** – author (eg. "John Hannibal Smith + \<[hannibal@a-team.com](mailto:hannibal%40a-team.com)\>") + - **run** – config automatically applied when the image is run. + (ex: {"Cmd": ["cat", "/world"], "PortSpecs":["22"]}) + + Status Codes: + + - **201** – no error + - **404** – no such container + - **500** – server error + +#### [Monitor Docker’s events](#id35) + + `GET /events` +: Get events from docker, either in real time via streaming, or via + polling (using since) + + **Example request**: + + GET /events?since=1374067924 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {"status":"create","id":"dfdf82bd3881","from":"base:latest","time":1374067924} + {"status":"start","id":"dfdf82bd3881","from":"base:latest","time":1374067924} + {"status":"stop","id":"dfdf82bd3881","from":"base:latest","time":1374067966} + {"status":"destroy","id":"dfdf82bd3881","from":"base:latest","time":1374067970} + + Query Parameters: + +   + + - **since** – timestamp used for polling + + Status Codes: + + - **200** – no error + - **500** – server error + +#### [Get a tarball containing all images and tags in a repository](#id36) + + `GET /images/`(*name*)`/get` +: Get a tarball containing all images and metadata for the repository + specified by `name`. + + **Example request** + + GET /images/ubuntu/get + + **Example response**: + + .. sourcecode:: http + + HTTP/1.1 200 OK + Content-Type: application/x-tar + + Binary data stream + :statuscode 200: no error + :statuscode 500: server error + +#### [Load a tarball with a set of images and tags into docker](#id37) + + `POST /images/load` +: Load a set of images and tags into the docker repository. + + **Example request** + + POST /images/load + + Tarball in body + + **Example response**: + + .. sourcecode:: http + + HTTP/1.1 200 OK + + :statuscode 200: no error + :statuscode 500: server error + +## [3. Going further](#id38) + +### [3.1 Inside ‘docker run’](#id39) + +Here are the steps of ‘docker run’ : + +- Create the container + +- If the status code is 404, it means the image doesn’t exists: + : - Try to pull it + - Then retry to create the container + +- Start the container + +- If you are not in detached mode: + : - Attach to the container, using logs=1 (to have stdout and + stderr from the container’s start) and stream=1 + +- If in detached mode or only stdin is attached: + : - Display the container’s id + +### [3.2 Hijacking](#id40) + +In this version of the API, /attach, uses hijacking to transport stdin, +stdout and stderr on the same socket. This might change in the future. + +### [3.3 CORS Requests](#id41) + +To enable cross origin requests to the remote api add the flag +"–api-enable-cors" when running docker in daemon mode. + + docker -d -H="192.168.1.9:4243" --api-enable-cors diff --git a/docs/sources/reference/api/docker_remote_api_v1.7.rst b/docs/sources/reference/api/archive/docker_remote_api_v1.7.rst similarity index 100% rename from docs/sources/reference/api/docker_remote_api_v1.7.rst rename to docs/sources/reference/api/archive/docker_remote_api_v1.7.rst diff --git a/docs/sources/reference/api/archive/docker_remote_api_v1.8.md b/docs/sources/reference/api/archive/docker_remote_api_v1.8.md new file mode 100644 index 0000000000..eb29699e62 --- /dev/null +++ b/docs/sources/reference/api/archive/docker_remote_api_v1.8.md @@ -0,0 +1,1253 @@ +page_title: Remote API v1.8 +page_description: API Documentation for Docker +page_keywords: API, Docker, rcli, REST, documentation + +# [Docker Remote API v1.8](#id1) + +## [1. Brief introduction](#id2) + +- The Remote API has replaced rcli +- The daemon listens on `unix:///var/run/docker.sock` +, but you can [*Bind Docker to another host/port or a Unix + socket*](../../../../use/basics/#bind-docker). +- 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](#id3) + +### [2.1 Containers](#id4) + +#### [List containers](#id5) + + `GET /containers/json` +: List containers + + **Example request**: + + GET /containers/json?all=1&before=8dfafdbc3a40&size=1 HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "Id": "8dfafdbc3a40", + "Image": "base:latest", + "Command": "echo 1", + "Created": 1367854155, + "Status": "Exit 0", + "Ports":[{"PrivatePort": 2222, "PublicPort": 3333, "Type": "tcp"}], + "SizeRw":12288, + "SizeRootFs":0 + }, + { + "Id": "9cd87474be90", + "Image": "base:latest", + "Command": "echo 222222", + "Created": 1367854155, + "Status": "Exit 0", + "Ports":[], + "SizeRw":12288, + "SizeRootFs":0 + }, + { + "Id": "3176a2479c92", + "Image": "base:latest", + "Command": "echo 3333333333333333", + "Created": 1367854154, + "Status": "Exit 0", + "Ports":[], + "SizeRw":12288, + "SizeRootFs":0 + }, + { + "Id": "4cb07b47f9fb", + "Image": "base:latest", + "Command": "echo 444444444444444444444444444444444", + "Created": 1367854152, + "Status": "Exit 0", + "Ports":[], + "SizeRw":12288, + "SizeRootFs":0 + } + ] + + Query Parameters: + +   + + - **all** – 1/True/true or 0/False/false, Show all containers. + Only running containers are shown by default + - **limit** – Show `limit` last created + containers, include non-running ones. + - **since** – Show only containers created since Id, include + non-running ones. + - **before** – Show only containers created before Id, include + non-running ones. + - **size** – 1/True/true or 0/False/false, Show the containers + sizes + + Status Codes: + + - **200** – no error + - **400** – bad parameter + - **500** – server error + +#### [Create a container](#id6) + + `POST /containers/create` +: Create a container + + **Example request**: + + POST /containers/create HTTP/1.1 + Content-Type: application/json + + { + "Hostname":"", + "User":"", + "Memory":0, + "MemorySwap":0, + "CpuShares":0, + "AttachStdin":false, + "AttachStdout":true, + "AttachStderr":true, + "PortSpecs":null, + "Tty":false, + "OpenStdin":false, + "StdinOnce":false, + "Env":null, + "Cmd":[ + "date" + ], + "Dns":null, + "Image":"base", + "Volumes":{ + "/tmp": {} + }, + "VolumesFrom":"", + "WorkingDir":"", + "ExposedPorts":{ + "22/tcp": {} + } + } + + **Example response**: + + HTTP/1.1 201 OK + Content-Type: application/json + + { + "Id":"e90e34656806" + "Warnings":[] + } + + Json Parameters: + +   + + - **Hostname** – Container host name + - **User** – Username or UID + - **Memory** – Memory Limit in bytes + - **CpuShares** – CPU shares (relative weight) + - **AttachStdin** – 1/True/true or 0/False/false, attach to + standard input. Default false + - **AttachStdout** – 1/True/true or 0/False/false, attach to + standard output. Default false + - **AttachStderr** – 1/True/true or 0/False/false, attach to + standard error. Default false + - **Tty** – 1/True/true or 0/False/false, allocate a pseudo-tty. + Default false + - **OpenStdin** – 1/True/true or 0/False/false, keep stdin open + even if not attached. Default false + + Query Parameters: + +   + + - **name** – Assign the specified name to the container. Must + match `/?[a-zA-Z0-9_-]+`. + + Status Codes: + + - **201** – no error + - **404** – no such container + - **406** – impossible to attach (container not running) + - **500** – server error + +#### [Inspect a container](#id7) + + `GET /containers/`(*id*)`/json` +: Return low-level information on the container `id` + + + **Example request**: + + GET /containers/4fa6e0f0c678/json HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "Id": "4fa6e0f0c6786287e131c3852c58a2e01cc697a68231826813597e4994f1d6e2", + "Created": "2013-05-07T14:51:42.041847+02:00", + "Path": "date", + "Args": [], + "Config": { + "Hostname": "4fa6e0f0c678", + "User": "", + "Memory": 0, + "MemorySwap": 0, + "AttachStdin": false, + "AttachStdout": true, + "AttachStderr": true, + "PortSpecs": null, + "Tty": false, + "OpenStdin": false, + "StdinOnce": false, + "Env": null, + "Cmd": [ + "date" + ], + "Dns": null, + "Image": "base", + "Volumes": {}, + "VolumesFrom": "", + "WorkingDir":"" + + }, + "State": { + "Running": false, + "Pid": 0, + "ExitCode": 0, + "StartedAt": "2013-05-07T14:51:42.087658+02:01360", + "Ghost": false + }, + "Image": "b750fe79269d2ec9a3c593ef05b4332b1d1a02a62b4accb2c21d589ff2f5f2dc", + "NetworkSettings": { + "IpAddress": "", + "IpPrefixLen": 0, + "Gateway": "", + "Bridge": "", + "PortMapping": null + }, + "SysInitPath": "/home/kitty/go/src/github.com/dotcloud/docker/bin/docker", + "ResolvConfPath": "/etc/resolv.conf", + "Volumes": {}, + "HostConfig": { + "Binds": null, + "ContainerIDFile": "", + "LxcConf": [], + "Privileged": false, + "PortBindings": { + "80/tcp": [ + { + "HostIp": "0.0.0.0", + "HostPort": "49153" + } + ] + }, + "Links": null, + "PublishAllPorts": false + } + } + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### [List processes running inside a container](#id8) + + `GET /containers/`(*id*)`/top` +: List processes running inside the container `id` + + **Example request**: + + GET /containers/4fa6e0f0c678/top HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "Titles":[ + "USER", + "PID", + "%CPU", + "%MEM", + "VSZ", + "RSS", + "TTY", + "STAT", + "START", + "TIME", + "COMMAND" + ], + "Processes":[ + ["root","20147","0.0","0.1","18060","1864","pts/4","S","10:06","0:00","bash"], + ["root","20271","0.0","0.0","4312","352","pts/4","S+","10:07","0:00","sleep","10"] + ] + } + + Query Parameters: + +   + + - **ps\_args** – ps arguments to use (eg. aux) + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### [Inspect changes on a container’s filesystem](#id9) + + `GET /containers/`(*id*)`/changes` +: Inspect changes on container `id` ‘s filesystem + + **Example request**: + + GET /containers/4fa6e0f0c678/changes HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "Path":"/dev", + "Kind":0 + }, + { + "Path":"/dev/kmsg", + "Kind":1 + }, + { + "Path":"/test", + "Kind":1 + } + ] + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### [Export a container](#id10) + + `GET /containers/`(*id*)`/export` +: Export the contents of container `id` + + **Example request**: + + GET /containers/4fa6e0f0c678/export HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/octet-stream + + {{ STREAM }} + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### [Start a container](#id11) + + `POST /containers/`(*id*)`/start` +: Start the container `id` + + **Example request**: + + POST /containers/(id)/start HTTP/1.1 + Content-Type: application/json + + { + "Binds":["/tmp:/tmp"], + "LxcConf":{"lxc.utsname":"docker"}, + "PortBindings":{ "22/tcp": [{ "HostPort": "11022" }] }, + "PublishAllPorts":false, + "Privileged":false + } + + **Example response**: + + HTTP/1.1 204 No Content + Content-Type: text/plain + + Json Parameters: + +   + + - **Binds** – Create a bind mount to a directory or file with + [host-path]:[container-path]:[rw|ro]. If a directory + "container-path" is missing, then docker creates a new volume. + - **LxcConf** – Map of custom lxc options + - **PortBindings** – Expose ports from the container, optionally + publishing them via the HostPort flag + - **PublishAllPorts** – 1/True/true or 0/False/false, publish all + exposed ports to the host interfaces. Default false + - **Privileged** – 1/True/true or 0/False/false, give extended + privileges to this container. Default false + + Status Codes: + + - **204** – no error + - **404** – no such container + - **500** – server error + +#### [Stop a container](#id12) + + `POST /containers/`(*id*)`/stop` +: Stop the container `id` + + **Example request**: + + POST /containers/e90e34656806/stop?t=5 HTTP/1.1 + + **Example response**: + + HTTP/1.1 204 OK + + Query Parameters: + +   + + - **t** – number of seconds to wait before killing the container + + Status Codes: + + - **204** – no error + - **404** – no such container + - **500** – server error + +#### [Restart a container](#id13) + + `POST /containers/`(*id*)`/restart` +: Restart the container `id` + + **Example request**: + + POST /containers/e90e34656806/restart?t=5 HTTP/1.1 + + **Example response**: + + HTTP/1.1 204 OK + + Query Parameters: + +   + + - **t** – number of seconds to wait before killing the container + + Status Codes: + + - **204** – no error + - **404** – no such container + - **500** – server error + +#### [Kill a container](#id14) + + `POST /containers/`(*id*)`/kill` +: Kill the container `id` + + **Example request**: + + POST /containers/e90e34656806/kill HTTP/1.1 + + **Example response**: + + HTTP/1.1 204 OK + + Status Codes: + + - **204** – no error + - **404** – no such container + - **500** – server error + +#### [Attach to a container](#id15) + + `POST /containers/`(*id*)`/attach` +: Attach to the container `id` + + **Example request**: + + POST /containers/16253994b7c4/attach?logs=1&stream=0&stdout=1 HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/vnd.docker.raw-stream + + {{ STREAM }} + + Query Parameters: + +   + + - **logs** – 1/True/true or 0/False/false, return logs. Default + false + - **stream** – 1/True/true or 0/False/false, return stream. + Default false + - **stdin** – 1/True/true or 0/False/false, if stream=true, attach + to stdin. Default false + - **stdout** – 1/True/true or 0/False/false, if logs=true, return + stdout log, if stream=true, attach to stdout. Default false + - **stderr** – 1/True/true or 0/False/false, if logs=true, return + stderr log, if stream=true, attach to stderr. Default false + + Status Codes: + + - **200** – no error + - **400** – bad parameter + - **404** – no such container + - **500** – server error + + **Stream details**: + + When using the TTY setting is enabled in + [`POST /containers/create` +](../../docker_remote_api_v1.9/#post--containers-create "POST /containers/create"), + the stream is the raw data from the process PTY and client’s stdin. + When the TTY is disabled, then the stream is multiplexed to separate + stdout and stderr. + + The format is a **Header** and a **Payload** (frame). + + **HEADER** + + The header will contain the information on which stream write the + stream (stdout or stderr). It also contain the size of the + associated frame encoded on the last 4 bytes (uint32). + + It is encoded on the first 8 bytes like this: + + header := [8]byte{STREAM_TYPE, 0, 0, 0, SIZE1, SIZE2, SIZE3, SIZE4} + + `STREAM_TYPE` can be: + + - 0: stdin (will be writen on stdout) + - 1: stdout + - 2: stderr + + `SIZE1, SIZE2, SIZE3, SIZE4` are the 4 bytes of + the uint32 size encoded as big endian. + + **PAYLOAD** + + The payload is the raw stream. + + **IMPLEMENTATION** + + The simplest way to implement the Attach protocol is the following: + + 1. Read 8 bytes + 2. chose stdout or stderr depending on the first byte + 3. Extract the frame size from the last 4 byets + 4. Read the extracted size and output it on the correct output + 5. Goto 1) + +#### [Wait a container](#id16) + + `POST /containers/`(*id*)`/wait` +: Block until container `id` stops, then returns + the exit code + + **Example request**: + + POST /containers/16253994b7c4/wait HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {"StatusCode":0} + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### [Remove a container](#id17) + + `DELETE /containers/`(*id*) +: Remove the container `id` from the filesystem + + **Example request**: + + DELETE /containers/16253994b7c4?v=1 HTTP/1.1 + + **Example response**: + + HTTP/1.1 204 OK + + Query Parameters: + +   + + - **v** – 1/True/true or 0/False/false, Remove the volumes + associated to the container. Default false + + Status Codes: + + - **204** – no error + - **400** – bad parameter + - **404** – no such container + - **500** – server error + +#### [Copy files or folders from a container](#id18) + + `POST /containers/`(*id*)`/copy` +: Copy files or folders of container `id` + + **Example request**: + + POST /containers/4fa6e0f0c678/copy HTTP/1.1 + Content-Type: application/json + + { + "Resource":"test.txt" + } + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/octet-stream + + {{ STREAM }} + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +### [2.2 Images](#id19) + +#### [List Images](#id20) + + `GET /images/json` +: **Example request**: + + GET /images/json?all=0 HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "RepoTags": [ + "ubuntu:12.04", + "ubuntu:precise", + "ubuntu:latest" + ], + "Id": "8dbd9e392a964056420e5d58ca5cc376ef18e2de93b5cc90e868a1bbc8318c1c", + "Created": 1365714795, + "Size": 131506275, + "VirtualSize": 131506275 + }, + { + "RepoTags": [ + "ubuntu:12.10", + "ubuntu:quantal" + ], + "ParentId": "27cf784147099545", + "Id": "b750fe79269d2ec9a3c593ef05b4332b1d1a02a62b4accb2c21d589ff2f5f2dc", + "Created": 1364102658, + "Size": 24653, + "VirtualSize": 180116135 + } + ] + +#### [Create an image](#id21) + + `POST /images/create` +: Create an image, either by pull it from the registry or by importing + it + + **Example request**: + + POST /images/create?fromImage=base HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {"status":"Pulling..."} + {"status":"Pulling", "progress":"1 B/ 100 B", "progressDetail":{"current":1, "total":100}} + {"error":"Invalid..."} + ... + + When using this endpoint to pull an image from the registry, the + `X-Registry-Auth` header can be used to include + a base64-encoded AuthConfig object. + + Query Parameters: + +   + + - **fromImage** – name of the image to pull + - **fromSrc** – source to import, - means stdin + - **repo** – repository + - **tag** – tag + - **registry** – the registry to pull from + + Request Headers: + +   + + - **X-Registry-Auth** – base64-encoded AuthConfig object + + Status Codes: + + - **200** – no error + - **500** – server error + +#### [Insert a file in an image](#id22) + + `POST /images/`(*name*)`/insert` +: Insert a file from `url` in the image + `name` at `path` + + **Example request**: + + POST /images/test/insert?path=/usr&url=myurl HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {"status":"Inserting..."} + {"status":"Inserting", "progress":"1/? (n/a)", "progressDetail":{"current":1}} + {"error":"Invalid..."} + ... + + Status Codes: + + - **200** – no error + - **500** – server error + +#### [Inspect an image](#id23) + + `GET /images/`(*name*)`/json` +: Return low-level information on the image `name` + + **Example request**: + + GET /images/base/json HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "id":"b750fe79269d2ec9a3c593ef05b4332b1d1a02a62b4accb2c21d589ff2f5f2dc", + "parent":"27cf784147099545", + "created":"2013-03-23T22:24:18.818426-07:00", + "container":"3d67245a8d72ecf13f33dffac9f79dcdf70f75acb84d308770391510e0c23ad0", + "container_config": + { + "Hostname":"", + "User":"", + "Memory":0, + "MemorySwap":0, + "AttachStdin":false, + "AttachStdout":false, + "AttachStderr":false, + "PortSpecs":null, + "Tty":true, + "OpenStdin":true, + "StdinOnce":false, + "Env":null, + "Cmd": ["/bin/bash"] + ,"Dns":null, + "Image":"base", + "Volumes":null, + "VolumesFrom":"", + "WorkingDir":"" + }, + "Size": 6824592 + } + + Status Codes: + + - **200** – no error + - **404** – no such image + - **500** – server error + +#### [Get the history of an image](#id24) + + `GET /images/`(*name*)`/history` +: Return the history of the image `name` + + **Example request**: + + GET /images/base/history HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "Id":"b750fe79269d", + "Created":1364102658, + "CreatedBy":"/bin/bash" + }, + { + "Id":"27cf78414709", + "Created":1364068391, + "CreatedBy":"" + } + ] + + Status Codes: + + - **200** – no error + - **404** – no such image + - **500** – server error + +#### [Push an image on the registry](#id25) + + `POST /images/`(*name*)`/push` +: Push the image `name` on the registry + + **Example request**: + + POST /images/test/push HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {"status":"Pushing..."} + {"status":"Pushing", "progress":"1/? (n/a)", "progressDetail":{"current":1}}} + {"error":"Invalid..."} + ... + + Query Parameters: + +   + + - **registry** – the registry you wan to push, optional + + Request Headers: + +   + + - **X-Registry-Auth** – include a base64-encoded AuthConfig + object. + + Status Codes: + + - **200** – no error + - **404** – no such image + - **500** – server error + +#### [Tag an image into a repository](#id26) + + `POST /images/`(*name*)`/tag` +: Tag the image `name` into a repository + + **Example request**: + + POST /images/test/tag?repo=myrepo&force=0 HTTP/1.1 + + **Example response**: + + HTTP/1.1 201 OK + + Query Parameters: + +   + + - **repo** – The repository to tag in + - **force** – 1/True/true or 0/False/false, default false + + Status Codes: + + - **201** – no error + - **400** – bad parameter + - **404** – no such image + - **409** – conflict + - **500** – server error + +#### [Remove an image](#id27) + + `DELETE /images/`(*name*) +: Remove the image `name` from the filesystem + + **Example request**: + + DELETE /images/test HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-type: application/json + + [ + {"Untagged":"3e2f21a89f"}, + {"Deleted":"3e2f21a89f"}, + {"Deleted":"53b4f83ac9"} + ] + + Status Codes: + + - **200** – no error + - **404** – no such image + - **409** – conflict + - **500** – server error + +#### [Search images](#id28) + + `GET /images/search` +: Search for an image in the docker index. + +> **Note**: +> The response keys have changed from API v1.6 to reflect the JSON +> sent by the registry server to the docker daemon’s request. + + **Example request**: + + GET /images/search?term=sshd HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "description": "", + "is_official": false, + "is_trusted": false, + "name": "wma55/u1210sshd", + "star_count": 0 + }, + { + "description": "", + "is_official": false, + "is_trusted": false, + "name": "jdswinbank/sshd", + "star_count": 0 + }, + { + "description": "", + "is_official": false, + "is_trusted": false, + "name": "vgauthier/sshd", + "star_count": 0 + } + ... + ] + + Query Parameters: + +   + + - **term** – term to search + + Status Codes: + + - **200** – no error + - **500** – server error + +### [2.3 Misc](#id29) + +#### [Build an image from Dockerfile via stdin](#id30) + + `POST /build` +: Build an image from Dockerfile via stdin + + **Example request**: + + POST /build HTTP/1.1 + + {{ STREAM }} + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {"stream":"Step 1..."} + {"stream":"..."} + {"error":"Error...", "errorDetail":{"code": 123, "message": "Error..."}} + + The stream must be a tar archive compressed with one of the + following algorithms: identity (no compression), gzip, bzip2, xz. + + The archive must include a file called `Dockerfile` + at its root. It may include any number of other files, + which will be accessible in the build context (See the [*ADD build + command*](../../../builder/#dockerbuilder)). + + Query Parameters: + +   + + - **t** – repository name (and optionally a tag) to be applied to + the resulting image in case of success + - **q** – suppress verbose build output + - **nocache** – do not use the cache when building the image + + Request Headers: + +   + + - **Content-type** – should be set to + `"application/tar"`. + - **X-Registry-Auth** – base64-encoded AuthConfig object + + Status Codes: + + - **200** – no error + - **500** – server error + +#### [Check auth configuration](#id31) + + `POST /auth` +: Get the default username and email + + **Example request**: + + POST /auth HTTP/1.1 + Content-Type: application/json + + { + "username":"hannibal", + "password:"xxxx", + "email":"hannibal@a-team.com", + "serveraddress":"https://index.docker.io/v1/" + } + + **Example response**: + + HTTP/1.1 200 OK + + Status Codes: + + - **200** – no error + - **204** – no error + - **500** – server error + +#### [Display system-wide information](#id32) + + `GET /info` +: Display system-wide information + + **Example request**: + + GET /info HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "Containers":11, + "Images":16, + "Debug":false, + "NFd": 11, + "NGoroutines":21, + "MemoryLimit":true, + "SwapLimit":false, + "IPv4Forwarding":true + } + + Status Codes: + + - **200** – no error + - **500** – server error + +#### [Show the docker version information](#id33) + + `GET /version` +: Show the docker version information + + **Example request**: + + GET /version HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "Version":"0.2.2", + "GitCommit":"5a2a5cc+CHANGES", + "GoVersion":"go1.0.3" + } + + Status Codes: + + - **200** – no error + - **500** – server error + +#### [Create a new image from a container’s changes](#id34) + + `POST /commit` +: Create a new image from a container’s changes + + **Example request**: + + POST /commit?container=44c004db4b17&m=message&repo=myrepo HTTP/1.1 + + **Example response**: + + HTTP/1.1 201 OK + Content-Type: application/vnd.docker.raw-stream + + {"Id":"596069db4bf5"} + + Query Parameters: + +   + + - **container** – source container + - **repo** – repository + - **tag** – tag + - **m** – commit message + - **author** – author (eg. "John Hannibal Smith + \<[hannibal@a-team.com](mailto:hannibal%40a-team.com)\>") + - **run** – config automatically applied when the image is run. + (ex: {"Cmd": ["cat", "/world"], "PortSpecs":["22"]}) + + Status Codes: + + - **201** – no error + - **404** – no such container + - **500** – server error + +#### [Monitor Docker’s events](#id35) + + `GET /events` +: Get events from docker, either in real time via streaming, or via + polling (using since) + + **Example request**: + + GET /events?since=1374067924 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {"status":"create","id":"dfdf82bd3881","from":"base:latest","time":1374067924} + {"status":"start","id":"dfdf82bd3881","from":"base:latest","time":1374067924} + {"status":"stop","id":"dfdf82bd3881","from":"base:latest","time":1374067966} + {"status":"destroy","id":"dfdf82bd3881","from":"base:latest","time":1374067970} + + Query Parameters: + +   + + - **since** – timestamp used for polling + + Status Codes: + + - **200** – no error + - **500** – server error + +#### [Get a tarball containing all images and tags in a repository](#id36) + + `GET /images/`(*name*)`/get` +: Get a tarball containing all images and metadata for the repository + specified by `name`. + + **Example request** + + GET /images/ubuntu/get + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/x-tar + + Binary data stream + + Status Codes: + + - **200** – no error + - **500** – server error + +#### [Load a tarball with a set of images and tags into docker](#id37) + + `POST /images/load` +: Load a set of images and tags into the docker repository. + + **Example request** + + POST /images/load + + Tarball in body + + **Example response**: + + HTTP/1.1 200 OK + + Status Codes: + + - **200** – no error + - **500** – server error + +## [3. Going further](#id38) + +### [3.1 Inside ‘docker run’](#id39) + +Here are the steps of ‘docker run’ : + +- Create the container + +- If the status code is 404, it means the image doesn’t exists: + : - Try to pull it + - Then retry to create the container + +- Start the container + +- If you are not in detached mode: + : - Attach to the container, using logs=1 (to have stdout and + stderr from the container’s start) and stream=1 + +- If in detached mode or only stdin is attached: + : - Display the container’s id + +### [3.2 Hijacking](#id40) + +In this version of the API, /attach, uses hijacking to transport stdin, +stdout and stderr on the same socket. This might change in the future. + +### [3.3 CORS Requests](#id41) + +To enable cross origin requests to the remote api add the flag +"–api-enable-cors" when running docker in daemon mode. + + docker -d -H="192.168.1.9:4243" --api-enable-cors diff --git a/docs/sources/reference/api/docker_remote_api_v1.8.rst b/docs/sources/reference/api/archive/docker_remote_api_v1.8.rst similarity index 100% rename from docs/sources/reference/api/docker_remote_api_v1.8.rst rename to docs/sources/reference/api/archive/docker_remote_api_v1.8.rst diff --git a/docs/sources/reference/api/docker_io_accounts_api.md b/docs/sources/reference/api/docker_io_accounts_api.md new file mode 100644 index 0000000000..e5e77dc421 --- /dev/null +++ b/docs/sources/reference/api/docker_io_accounts_api.md @@ -0,0 +1,355 @@ +page_title: docker.io Accounts API +page_description: API Documentation for docker.io accounts. +page_keywords: API, Docker, accounts, REST, documentation + +# docker.io Accounts API + +## 1. Endpoints + +### 1.1 Get a single user + + `GET /api/v1.1/users/:username/` +: Get profile info for the specified user. + + Parameters: + + - **username** – username of the user whose profile info is being + requested. + + Request Headers: + +   + + - **Authorization** – required authentication credentials of + either type HTTP Basic or OAuth Bearer Token. + + Status Codes: + + - **200** – success, user data returned. + - **401** – authentication error. + - **403** – permission error, authenticated user must be the user + whose data is being requested, OAuth access tokens must have + `profile_read` scope. + - **404** – the specified username does not exist. + + **Example request**: + + GET /api/v1.1/users/janedoe/ HTTP/1.1 + Host: www.docker.io + Accept: application/json + Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ= + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "id": 2, + "username": "janedoe", + "url": "https://www.docker.io/api/v1.1/users/janedoe/", + "date_joined": "2014-02-12T17:58:01.431312Z", + "type": "User", + "full_name": "Jane Doe", + "location": "San Francisco, CA", + "company": "Success, Inc.", + "profile_url": "https://docker.io/", + "gravatar_url": "https://secure.gravatar.com/avatar/0212b397124be4acd4e7dea9aa357.jpg?s=80&r=g&d=mm" + "email": "jane.doe@example.com", + "is_active": true + } + +### 1.2 Update a single user + + `PATCH /api/v1.1/users/:username/` +: Update profile info for the specified user. + + Parameters: + + - **username** – username of the user whose profile info is being + updated. + + Json Parameters: + +   + + - **full\_name** (*string*) – (optional) the new name of the user. + - **location** (*string*) – (optional) the new location. + - **company** (*string*) – (optional) the new company of the user. + - **profile\_url** (*string*) – (optional) the new profile url. + - **gravatar\_email** (*string*) – (optional) the new Gravatar + email address. + + Request Headers: + +   + + - **Authorization** – required authentication credentials of + either type HTTP Basic or OAuth Bearer Token. + - **Content-Type** – MIME Type of post data. JSON, url-encoded + form data, etc. + + Status Codes: + + - **200** – success, user data updated. + - **400** – post data validation error. + - **401** – authentication error. + - **403** – permission error, authenticated user must be the user + whose data is being updated, OAuth access tokens must have + `profile_write` scope. + - **404** – the specified username does not exist. + + **Example request**: + + PATCH /api/v1.1/users/janedoe/ HTTP/1.1 + Host: www.docker.io + Accept: application/json + Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ= + + { + "location": "Private Island", + "profile_url": "http://janedoe.com/", + "company": "Retired", + } + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "id": 2, + "username": "janedoe", + "url": "https://www.docker.io/api/v1.1/users/janedoe/", + "date_joined": "2014-02-12T17:58:01.431312Z", + "type": "User", + "full_name": "Jane Doe", + "location": "Private Island", + "company": "Retired", + "profile_url": "http://janedoe.com/", + "gravatar_url": "https://secure.gravatar.com/avatar/0212b397124be4acd4e7dea9aa357.jpg?s=80&r=g&d=mm" + "email": "jane.doe@example.com", + "is_active": true + } + +### 1.3 List email addresses for a user + + `GET /api/v1.1/users/:username/emails/` +: List email info for the specified user. + + Parameters: + + - **username** – username of the user whose profile info is being + updated. + + Request Headers: + +   + + - **Authorization** – required authentication credentials of + either type HTTP Basic or OAuth Bearer Token + + Status Codes: + + - **200** – success, user data updated. + - **401** – authentication error. + - **403** – permission error, authenticated user must be the user + whose data is being requested, OAuth access tokens must have + `email_read` scope. + - **404** – the specified username does not exist. + + **Example request**: + + GET /api/v1.1/users/janedoe/emails/ HTTP/1.1 + Host: www.docker.io + Accept: application/json + Authorization: Bearer zAy0BxC1wDv2EuF3tGs4HrI6qJp6KoL7nM + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "email": "jane.doe@example.com", + "verified": true, + "primary": true + } + ] + +### 1.4 Add email address for a user + + `POST /api/v1.1/users/:username/emails/` +: Add a new email address to the specified user’s account. The email + address must be verified separately, a confirmation email is not + automatically sent. + + Json Parameters: + +   + + - **email** (*string*) – email address to be added. + + Request Headers: + +   + + - **Authorization** – required authentication credentials of + either type HTTP Basic or OAuth Bearer Token. + - **Content-Type** – MIME Type of post data. JSON, url-encoded + form data, etc. + + Status Codes: + + - **201** – success, new email added. + - **400** – data validation error. + - **401** – authentication error. + - **403** – permission error, authenticated user must be the user + whose data is being requested, OAuth access tokens must have + `email_write` scope. + - **404** – the specified username does not exist. + + **Example request**: + + POST /api/v1.1/users/janedoe/emails/ HTTP/1.1 + Host: www.docker.io + Accept: application/json + Content-Type: application/json + Authorization: Bearer zAy0BxC1wDv2EuF3tGs4HrI6qJp6KoL7nM + + { + "email": "jane.doe+other@example.com" + } + + **Example response**: + + HTTP/1.1 201 Created + Content-Type: application/json + + { + "email": "jane.doe+other@example.com", + "verified": false, + "primary": false + } + +### 1.5 Update an email address for a user + + `PATCH /api/v1.1/users/:username/emails/` +: Update an email address for the specified user to either verify an + email address or set it as the primary email for the user. You + cannot use this endpoint to un-verify an email address. You cannot + use this endpoint to unset the primary email, only set another as + the primary. + + Parameters: + + - **username** – username of the user whose email info is being + updated. + + Json Parameters: + +   + + - **email** (*string*) – the email address to be updated. + - **verified** (*boolean*) – (optional) whether the email address + is verified, must be `true` or absent. + - **primary** (*boolean*) – (optional) whether to set the email + address as the primary email, must be `true` + or absent. + + Request Headers: + +   + + - **Authorization** – required authentication credentials of + either type HTTP Basic or OAuth Bearer Token. + - **Content-Type** – MIME Type of post data. JSON, url-encoded + form data, etc. + + Status Codes: + + - **200** – success, user’s email updated. + - **400** – data validation error. + - **401** – authentication error. + - **403** – permission error, authenticated user must be the user + whose data is being updated, OAuth access tokens must have + `email_write` scope. + - **404** – the specified username or email address does not + exist. + + **Example request**: + + Once you have independently verified an email address. + + PATCH /api/v1.1/users/janedoe/emails/ HTTP/1.1 + Host: www.docker.io + Accept: application/json + Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ= + + { + "email": "jane.doe+other@example.com", + "verified": true, + } + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "email": "jane.doe+other@example.com", + "verified": true, + "primary": false + } + +### 1.6 Delete email address for a user + + `DELETE /api/v1.1/users/:username/emails/` +: Delete an email address from the specified user’s account. You + cannot delete a user’s primary email address. + + Json Parameters: + +   + + - **email** (*string*) – email address to be deleted. + + Request Headers: + +   + + - **Authorization** – required authentication credentials of + either type HTTP Basic or OAuth Bearer Token. + - **Content-Type** – MIME Type of post data. JSON, url-encoded + form data, etc. + + Status Codes: + + - **204** – success, email address removed. + - **400** – validation error. + - **401** – authentication error. + - **403** – permission error, authenticated user must be the user + whose data is being requested, OAuth access tokens must have + `email_write` scope. + - **404** – the specified username or email address does not + exist. + + **Example request**: + + DELETE /api/v1.1/users/janedoe/emails/ HTTP/1.1 + Host: www.docker.io + Accept: application/json + Content-Type: application/json + Authorization: Bearer zAy0BxC1wDv2EuF3tGs4HrI6qJp6KoL7nM + + { + "email": "jane.doe+other@example.com" + } + + **Example response**: + + HTTP/1.1 204 NO CONTENT + Content-Length: 0 + + diff --git a/docs/sources/reference/api/docker_io_accounts_api.rst b/docs/sources/reference/api/docker_io_accounts_api.rst index dc5c44d4a8..1ce75ca738 100644 --- a/docs/sources/reference/api/docker_io_accounts_api.rst +++ b/docs/sources/reference/api/docker_io_accounts_api.rst @@ -7,8 +7,6 @@ docker.io Accounts API ====================== -.. contents:: Table of Contents - 1. Endpoints ============ diff --git a/docs/sources/reference/api/docker_io_oauth_api.md b/docs/sources/reference/api/docker_io_oauth_api.md new file mode 100644 index 0000000000..3009f08e20 --- /dev/null +++ b/docs/sources/reference/api/docker_io_oauth_api.md @@ -0,0 +1,252 @@ +page_title: docker.io OAuth API +page_description: API Documentation for docker.io's OAuth flow. +page_keywords: API, Docker, oauth, REST, documentation + +# docker.io OAuth API + +## 1. Brief introduction + +Some docker.io API requests will require an access token to +authenticate. To get an access token for a user, that user must first +grant your application access to their docker.io account. In order for +them to grant your application access you must first register your +application. + +Before continuing, we encourage you to familiarize yourself with [The +OAuth 2.0 Authorization Framework](http://tools.ietf.org/html/rfc6749). + +*Also note that all OAuth interactions must take place over https +connections* + +## 2. Register Your Application + +You will need to register your application with docker.io before users +will be able to grant your application access to their account +information. We are currently only allowing applications selectively. To +request registration of your application send an email to +[support-accounts@docker.com](mailto:support-accounts%40docker.com) with +the following information: + +- The name of your application +- A description of your application and the service it will provide to + docker.io users. +- A callback URI that we will use for redirecting authorization + requests to your application. These are used in the step of getting + an Authorization Code. The domain name of the callback URI will be + visible to the user when they are requested to authorize your + application. + +When your application is approved you will receive a response from the +docker.io team with your `client_id` and +`client_secret` which your application will use in +the steps of getting an Authorization Code and getting an Access Token. + +## 3. Endpoints + +### 3.1 Get an Authorization Code + +Once You have registered you are ready to start integrating docker.io +accounts into your application! The process is usually started by a user +following a link in your application to an OAuth Authorization endpoint. + + `GET /api/v1.1/o/authorize/` +: Request that a docker.io user authorize your application. If the + user is not already logged in, they will be prompted to login. The + user is then presented with a form to authorize your application for + the requested access scope. On submission, the user will be + redirected to the specified `redirect_uri` with + an Authorization Code. + + Query Parameters: + +   + + - **client\_id** – The `client_id` given to + your application at registration. + - **response\_type** – MUST be set to `code`. + This specifies that you would like an Authorization Code + returned. + - **redirect\_uri** – The URI to redirect back to after the user + has authorized your application. If omitted, the first of your + registered `response_uris` is used. If + included, it must be one of the URIs which were submitted when + registering your application. + - **scope** – The extent of access permissions you are requesting. + Currently, the scope options are `profile_read`, `profile_write`, + `email_read`, and `email_write`. Scopes must be separated by a space. If omitted, the + default scopes `profile_read email_read` are + used. + - **state** – (Recommended) Used by your application to maintain + state between the authorization request and callback to protect + against CSRF attacks. + + **Example Request** + + Asking the user for authorization. + + GET /api/v1.1/o/authorize/?client_id=TestClientID&response_type=code&redirect_uri=https%3A//my.app/auth_complete/&scope=profile_read%20email_read&state=abc123 HTTP/1.1 + Host: www.docker.io + + **Authorization Page** + + When the user follows a link, making the above GET request, they + will be asked to login to their docker.io account if they are not + already and then be presented with the following authorization + prompt which asks the user to authorize your application with a + description of the requested scopes. + + ![](../../../_images/io_oauth_authorization_page.png) + + Once the user allows or denies your Authorization Request the user + will be redirected back to your application. Included in that + request will be the following query parameters: + + `code` + : The Authorization code generated by the docker.io authorization + server. Present it again to request an Access Token. This code + expires in 60 seconds. + `state` + : If the `state` parameter was present in the + authorization request this will be the exact value received from + that request. + `error` + : An error message in the event of the user denying the + authorization or some other kind of error with the request. + +### 3.2 Get an Access Token + +Once the user has authorized your application, a request will be made to +your application’s specified `redirect_uri` which +includes a `code` parameter that you must then use +to get an Access Token. + + `POST /api/v1.1/o/token/` +: Submit your newly granted Authorization Code and your application’s + credentials to receive an Access Token and Refresh Token. The code + is valid for 60 seconds and cannot be used more than once. + + Request Headers: + +   + + - **Authorization** – HTTP basic authentication using your + application’s `client_id` and + `client_secret` + + Form Parameters: + +   + + - **grant\_type** – MUST be set to `authorization_code` + - **code** – The authorization code received from the user’s + redirect request. + - **redirect\_uri** – The same `redirect_uri` + used in the authentication request. + + **Example Request** + + Using an authorization code to get an access token. + + POST /api/v1.1/o/token/ HTTP/1.1 + Host: www.docker.io + Authorization: Basic VGVzdENsaWVudElEOlRlc3RDbGllbnRTZWNyZXQ= + Accept: application/json + Content-Type: application/json + + { + "grant_type": "code", + "code": "YXV0aG9yaXphdGlvbl9jb2Rl", + "redirect_uri": "https://my.app/auth_complete/" + } + + **Example Response** + + HTTP/1.1 200 OK + Content-Type: application/json;charset=UTF-8 + + { + "username": "janedoe", + "user_id": 42, + "access_token": "t6k2BqgRw59hphQBsbBoPPWLqu6FmS", + "expires_in": 15552000, + "token_type": "Bearer", + "scope": "profile_read email_read", + "refresh_token": "hJDhLH3cfsUrQlT4MxA6s8xAFEqdgc" + } + + In the case of an error, there will be a non-200 HTTP Status and and + data detailing the error. + +### 3.3 Refresh a Token + +Once the Access Token expires you can use your `refresh_token` +to have docker.io issue your application a new Access Token, +if the user has not revoked access from your application. + + `POST /api/v1.1/o/token/` +: Submit your `refresh_token` and application’s + credentials to receive a new Access Token and Refresh Token. The + `refresh_token` can be used only once. + + Request Headers: + +   + + - **Authorization** – HTTP basic authentication using your + application’s `client_id` and + `client_secret` + + Form Parameters: + +   + + - **grant\_type** – MUST be set to `refresh_token` + - **refresh\_token** – The `refresh_token` + which was issued to your application. + - **scope** – (optional) The scope of the access token to be + returned. Must not include any scope not originally granted by + the user and if omitted is treated as equal to the scope + originally granted. + + **Example Request** + + Refreshing an access token. + + POST /api/v1.1/o/token/ HTTP/1.1 + Host: www.docker.io + Authorization: Basic VGVzdENsaWVudElEOlRlc3RDbGllbnRTZWNyZXQ= + Accept: application/json + Content-Type: application/json + + { + "grant_type": "refresh_token", + "refresh_token": "hJDhLH3cfsUrQlT4MxA6s8xAFEqdgc", + } + + **Example Response** + + HTTP/1.1 200 OK + Content-Type: application/json;charset=UTF-8 + + { + "username": "janedoe", + "user_id": 42, + "access_token": "t6k2BqgRw59hphQBsbBoPPWLqu6FmS", + "expires_in": 15552000, + "token_type": "Bearer", + "scope": "profile_read email_read", + "refresh_token": "hJDhLH3cfsUrQlT4MxA6s8xAFEqdgc" + } + + In the case of an error, there will be a non-200 HTTP Status and and + data detailing the error. + +## 4. Use an Access Token with the API + +Many of the docker.io API requests will require a Authorization request +header field. Simply ensure you add this header with "Bearer +\<`access_token`\>": + + GET /api/v1.1/resource HTTP/1.1 + Host: docker.io + Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA diff --git a/docs/sources/reference/api/docker_io_oauth_api.rst b/docs/sources/reference/api/docker_io_oauth_api.rst index d68dd8d36c..24d2af3adb 100644 --- a/docs/sources/reference/api/docker_io_oauth_api.rst +++ b/docs/sources/reference/api/docker_io_oauth_api.rst @@ -7,8 +7,6 @@ docker.io OAuth API =================== -.. contents:: Table of Contents - 1. Brief introduction ===================== diff --git a/docs/sources/reference/api/docker_remote_api.md b/docs/sources/reference/api/docker_remote_api.md new file mode 100644 index 0000000000..5df7d8938c --- /dev/null +++ b/docs/sources/reference/api/docker_remote_api.md @@ -0,0 +1,347 @@ +page_title: Remote API +page_description: API Documentation for Docker +page_keywords: API, Docker, rcli, REST, documentation + +# Docker Remote API + +## 1. Brief introduction + +- The Remote API is replacing rcli +- By default the Docker daemon listens on unix:///var/run/docker.sock + and the client must have root access to interact with the daemon +- If a group named *docker* exists on your system, docker will apply + ownership of the socket to the group +- 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 +- 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 +- authConfig, set as the `X-Registry-Auth` header, + is currently a Base64 encoded (json) string with credentials: + `{'username': string, 'password': string, 'email': string, 'serveraddress' : string}` + + +## 2. Versions + +The current version of the API is 1.11 + +Calling /images/\/insert is the same as calling +/v1.11/images/\/insert + +You can still call an old version of the api using +/v1.11/images/\/insert + +### v1.11 + +#### Full Documentation + +[*Docker Remote API v1.11*](../docker_remote_api_v1.11/) + +#### What’s new + + `GET /events` +: **New!** You can now use the `-until` parameter + to close connection after timestamp. + +### v1.10 + +#### Full Documentation + +[*Docker Remote API v1.10*](../docker_remote_api_v1.10/) + +#### What’s new + + `DELETE /images/`(*name*) +: **New!** You can now use the force parameter to force delete of an + image, even if it’s tagged in multiple repositories. **New!** You + can now use the noprune parameter to prevent the deletion of parent + images + + `DELETE /containers/`(*id*) +: **New!** You can now use the force paramter to force delete a + container, even if it is currently running + +### v1.9 + +#### Full Documentation + +[*Docker Remote API v1.9*](../docker_remote_api_v1.9/) + +#### What’s new + + `POST /build` +: **New!** This endpoint now takes a serialized ConfigFile which it + uses to resolve the proper registry auth credentials for pulling the + base image. Clients which previously implemented the version + accepting an AuthConfig object must be updated. + +### v1.8 + +#### Full Documentation + +#### What’s new + + `POST /build` +: **New!** This endpoint now returns build status as json stream. In + case of a build error, it returns the exit status of the failed + command. + + `GET /containers/`(*id*)`/json` +: **New!** This endpoint now returns the host config for the + container. + + `POST /images/create` +: + + `POST /images/`(*name*)`/insert` +: + + `POST /images/`(*name*)`/push` +: **New!** progressDetail object was added in the JSON. It’s now + possible to get the current value and the total of the progress + without having to parse the string. + +### v1.7 + +#### Full Documentation + +#### What’s new + + `GET /images/json` +: The format of the json returned from this uri changed. Instead of an + entry for each repo/tag on an image, each image is only represented + once, with a nested attribute indicating the repo/tags that apply to + that image. + + Instead of: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "VirtualSize": 131506275, + "Size": 131506275, + "Created": 1365714795, + "Id": "8dbd9e392a964056420e5d58ca5cc376ef18e2de93b5cc90e868a1bbc8318c1c", + "Tag": "12.04", + "Repository": "ubuntu" + }, + { + "VirtualSize": 131506275, + "Size": 131506275, + "Created": 1365714795, + "Id": "8dbd9e392a964056420e5d58ca5cc376ef18e2de93b5cc90e868a1bbc8318c1c", + "Tag": "latest", + "Repository": "ubuntu" + }, + { + "VirtualSize": 131506275, + "Size": 131506275, + "Created": 1365714795, + "Id": "8dbd9e392a964056420e5d58ca5cc376ef18e2de93b5cc90e868a1bbc8318c1c", + "Tag": "precise", + "Repository": "ubuntu" + }, + { + "VirtualSize": 180116135, + "Size": 24653, + "Created": 1364102658, + "Id": "b750fe79269d2ec9a3c593ef05b4332b1d1a02a62b4accb2c21d589ff2f5f2dc", + "Tag": "12.10", + "Repository": "ubuntu" + }, + { + "VirtualSize": 180116135, + "Size": 24653, + "Created": 1364102658, + "Id": "b750fe79269d2ec9a3c593ef05b4332b1d1a02a62b4accb2c21d589ff2f5f2dc", + "Tag": "quantal", + "Repository": "ubuntu" + } + ] + + The returned json looks like this: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "RepoTags": [ + "ubuntu:12.04", + "ubuntu:precise", + "ubuntu:latest" + ], + "Id": "8dbd9e392a964056420e5d58ca5cc376ef18e2de93b5cc90e868a1bbc8318c1c", + "Created": 1365714795, + "Size": 131506275, + "VirtualSize": 131506275 + }, + { + "RepoTags": [ + "ubuntu:12.10", + "ubuntu:quantal" + ], + "ParentId": "27cf784147099545", + "Id": "b750fe79269d2ec9a3c593ef05b4332b1d1a02a62b4accb2c21d589ff2f5f2dc", + "Created": 1364102658, + "Size": 24653, + "VirtualSize": 180116135 + } + ] + + `GET /images/viz` +: This URI no longer exists. The `images --viz` + output is now generated in the client, using the + `/images/json` data. + +### v1.6 + +#### Full Documentation + +#### What’s new + + `POST /containers/`(*id*)`/attach` +: **New!** You can now split stderr from stdout. This is done by + prefixing a header to each transmition. See + [`POST /containers/(id)/attach` +](../docker_remote_api_v1.9/#post--containers-(id)-attach "POST /containers/(id)/attach"). + The WebSocket attach is unchanged. Note that attach calls on the + previous API version didn’t change. Stdout and stderr are merged. + +### v1.5 + +#### Full Documentation + +#### What’s new + + `POST /images/create` +: **New!** You can now pass registry credentials (via an AuthConfig + object) through the X-Registry-Auth header + + `POST /images/`(*name*)`/push` +: **New!** The AuthConfig object now needs to be passed through the + X-Registry-Auth header + + `GET /containers/json` +: **New!** The format of the Ports entry has been changed to a list of + dicts each containing PublicPort, PrivatePort and Type describing a + port mapping. + +### v1.4 + +#### Full Documentation + +#### What’s new + + `POST /images/create` +: **New!** When pulling a repo, all images are now downloaded in + parallel. + + `GET /containers/`(*id*)`/top` +: **New!** You can now use ps args with docker top, like docker top + \ aux + + `GET /events:` +: **New!** Image’s name added in the events + +### v1.3 + +docker v0.5.0 +[51f6c4a](https://github.com/dotcloud/docker/commit/51f6c4a7372450d164c61e0054daf0223ddbd909) + +#### Full Documentation + +#### What’s new + + `GET /containers/`(*id*)`/top` +: List the processes running inside a container. + + `GET /events:` +: **New!** Monitor docker’s events via streaming or via polling + +Builder (/build): + +- Simplify the upload of the build context +- Simply stream a tarball instead of multipart upload with 4 + intermediary buffers +- Simpler, less memory usage, less disk usage and faster + +> **Warning**: +> The /build improvements are not reverse-compatible. Pre 1.3 clients will +> break on /build. + +List containers (/containers/json): + +- You can use size=1 to get the size of the containers + +Start containers (/containers/\/start): + +- You can now pass host-specific configuration (e.g. bind mounts) in + the POST body for start calls + +### v1.2 + +docker v0.4.2 +[2e7649b](https://github.com/dotcloud/docker/commit/2e7649beda7c820793bd46766cbc2cfeace7b168) + +#### Full Documentation + +#### What’s new + +The auth configuration is now handled by the client. + +The client should send it’s authConfig as POST on each call of +/images/(name)/push + + `GET /auth` +: **Deprecated.** + + `POST /auth` +: Only checks the configuration but doesn’t store it on the server + + Deleting an image is now improved, will only untag the image if it + has children and remove all the untagged parents if has any. + + `POST /images//delete` +: Now returns a JSON structure with the list of images + deleted/untagged. + +### v1.1 + +docker v0.4.0 +[a8ae398](https://github.com/dotcloud/docker/commit/a8ae398bf52e97148ee7bd0d5868de2e15bd297f) + +#### Full Documentation + +#### What’s new + + `POST /images/create` +: + + `POST /images/`(*name*)`/insert` +: + + `POST /images/`(*name*)`/push` +: Uses json stream instead of HTML hijack, it looks like this: + + > HTTP/1.1 200 OK + > Content-Type: application/json + > + > {"status":"Pushing..."} + > {"status":"Pushing", "progress":"1/? (n/a)"} + > {"error":"Invalid..."} + > ... + +### v1.0 + +docker v0.3.4 +[8d73740](https://github.com/dotcloud/docker/commit/8d73740343778651c09160cde9661f5f387b36f4) + +#### Full Documentation + +#### What’s new + +Initial version diff --git a/docs/sources/reference/api/docker_remote_api.rst b/docs/sources/reference/api/docker_remote_api.rst index bd5598bcf2..1e90b1bbe3 100644 --- a/docs/sources/reference/api/docker_remote_api.rst +++ b/docs/sources/reference/api/docker_remote_api.rst @@ -98,8 +98,6 @@ v1.8 Full Documentation ------------------ -:doc:`docker_remote_api_v1.8` - What's new ---------- @@ -126,8 +124,6 @@ v1.7 Full Documentation ------------------ -:doc:`docker_remote_api_v1.7` - What's new ---------- @@ -230,8 +226,6 @@ v1.6 Full Documentation ------------------ -:doc:`docker_remote_api_v1.6` - What's new ---------- @@ -250,8 +244,6 @@ v1.5 Full Documentation ------------------ -:doc:`docker_remote_api_v1.5` - What's new ---------- @@ -277,8 +269,6 @@ v1.4 Full Documentation ------------------ -:doc:`docker_remote_api_v1.4` - What's new ---------- @@ -302,8 +292,6 @@ docker v0.5.0 51f6c4a_ Full Documentation ------------------ -:doc:`docker_remote_api_v1.3` - What's new ---------- @@ -344,8 +332,6 @@ docker v0.4.2 2e7649b_ Full Documentation ------------------ -:doc:`docker_remote_api_v1.2` - What's new ---------- @@ -379,8 +365,6 @@ docker v0.4.0 a8ae398_ Full Documentation ------------------ -:doc:`docker_remote_api_v1.1` - What's new ---------- @@ -408,8 +392,6 @@ docker v0.3.4 8d73740_ Full Documentation ------------------ -:doc:`docker_remote_api_v1.0` - What's new ---------- diff --git a/docs/sources/reference/api/docker_remote_api_v1.10.md b/docs/sources/reference/api/docker_remote_api_v1.10.md new file mode 100644 index 0000000000..02d13403ef --- /dev/null +++ b/docs/sources/reference/api/docker_remote_api_v1.10.md @@ -0,0 +1,1237 @@ +page_title: Remote API v1.10 +page_description: API Documentation for Docker +page_keywords: API, Docker, rcli, REST, documentation + +# Docker Remote API v1.10 + +## 1. Brief introduction + +- The Remote API has replaced rcli +- The daemon listens on `unix:///var/run/docker.sock` +, but you can [*Bind Docker to another host/port or a Unix + socket*](../../../use/basics/#bind-docker). +- 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.1 Containers + +#### List containers + + `GET /containers/json` +: List containers + + **Example request**: + + GET /containers/json?all=1&before=8dfafdbc3a40&size=1 HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "Id": "8dfafdbc3a40", + "Image": "base:latest", + "Command": "echo 1", + "Created": 1367854155, + "Status": "Exit 0", + "Ports":[{"PrivatePort": 2222, "PublicPort": 3333, "Type": "tcp"}], + "SizeRw":12288, + "SizeRootFs":0 + }, + { + "Id": "9cd87474be90", + "Image": "base:latest", + "Command": "echo 222222", + "Created": 1367854155, + "Status": "Exit 0", + "Ports":[], + "SizeRw":12288, + "SizeRootFs":0 + }, + { + "Id": "3176a2479c92", + "Image": "base:latest", + "Command": "echo 3333333333333333", + "Created": 1367854154, + "Status": "Exit 0", + "Ports":[], + "SizeRw":12288, + "SizeRootFs":0 + }, + { + "Id": "4cb07b47f9fb", + "Image": "base:latest", + "Command": "echo 444444444444444444444444444444444", + "Created": 1367854152, + "Status": "Exit 0", + "Ports":[], + "SizeRw":12288, + "SizeRootFs":0 + } + ] + + Query Parameters: + +   + + - **all** – 1/True/true or 0/False/false, Show all containers. + Only running containers are shown by default + - **limit** – Show `limit` last created + containers, include non-running ones. + - **since** – Show only containers created since Id, include + non-running ones. + - **before** – Show only containers created before Id, include + non-running ones. + - **size** – 1/True/true or 0/False/false, Show the containers + sizes + + Status Codes: + + - **200** – no error + - **400** – bad parameter + - **500** – server error + +#### Create a container + + `POST /containers/create` +: Create a container + + **Example request**: + + POST /containers/create HTTP/1.1 + Content-Type: application/json + + { + "Hostname":"", + "User":"", + "Memory":0, + "MemorySwap":0, + "AttachStdin":false, + "AttachStdout":true, + "AttachStderr":true, + "PortSpecs":null, + "Tty":false, + "OpenStdin":false, + "StdinOnce":false, + "Env":null, + "Cmd":[ + "date" + ], + "Image":"base", + "Volumes":{ + "/tmp": {} + }, + "WorkingDir":"", + "DisableNetwork": false, + "ExposedPorts":{ + "DisableNetwork": false, + "22/tcp": {} + } + } + + **Example response**: + + HTTP/1.1 201 OK + Content-Type: application/json + + { + "Id":"e90e34656806" + "Warnings":[] + } + + Json Parameters: + +   + + - **config** – the container’s configuration + + Query Parameters: + +   + + - **name** – Assign the specified name to the container. Must + match `/?[a-zA-Z0-9_-]+`. + + Status Codes: + + - **201** – no error + - **404** – no such container + - **406** – impossible to attach (container not running) + - **500** – server error + +#### Inspect a container + + `GET /containers/`(*id*)`/json` +: Return low-level information on the container `id` + + + **Example request**: + + GET /containers/4fa6e0f0c678/json HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "Id": "4fa6e0f0c6786287e131c3852c58a2e01cc697a68231826813597e4994f1d6e2", + "Created": "2013-05-07T14:51:42.041847+02:00", + "Path": "date", + "Args": [], + "Config": { + "Hostname": "4fa6e0f0c678", + "User": "", + "Memory": 0, + "MemorySwap": 0, + "AttachStdin": false, + "AttachStdout": true, + "AttachStderr": true, + "PortSpecs": null, + "Tty": false, + "OpenStdin": false, + "StdinOnce": false, + "Env": null, + "Cmd": [ + "date" + ], + "Image": "base", + "Volumes": {}, + "WorkingDir":"" + + }, + "State": { + "Running": false, + "Pid": 0, + "ExitCode": 0, + "StartedAt": "2013-05-07T14:51:42.087658+02:01360", + "Ghost": false + }, + "Image": "b750fe79269d2ec9a3c593ef05b4332b1d1a02a62b4accb2c21d589ff2f5f2dc", + "NetworkSettings": { + "IpAddress": "", + "IpPrefixLen": 0, + "Gateway": "", + "Bridge": "", + "PortMapping": null + }, + "SysInitPath": "/home/kitty/go/src/github.com/dotcloud/docker/bin/docker", + "ResolvConfPath": "/etc/resolv.conf", + "Volumes": {}, + "HostConfig": { + "Binds": null, + "ContainerIDFile": "", + "LxcConf": [], + "Privileged": false, + "PortBindings": { + "80/tcp": [ + { + "HostIp": "0.0.0.0", + "HostPort": "49153" + } + ] + }, + "Links": null, + "PublishAllPorts": false + } + } + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### List processes running inside a container + + `GET /containers/`(*id*)`/top` +: List processes running inside the container `id` + + **Example request**: + + GET /containers/4fa6e0f0c678/top HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "Titles":[ + "USER", + "PID", + "%CPU", + "%MEM", + "VSZ", + "RSS", + "TTY", + "STAT", + "START", + "TIME", + "COMMAND" + ], + "Processes":[ + ["root","20147","0.0","0.1","18060","1864","pts/4","S","10:06","0:00","bash"], + ["root","20271","0.0","0.0","4312","352","pts/4","S+","10:07","0:00","sleep","10"] + ] + } + + Query Parameters: + +   + + - **ps\_args** – ps arguments to use (eg. aux) + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### Inspect changes on a container’s filesystem + + `GET /containers/`(*id*)`/changes` +: Inspect changes on container `id` ‘s filesystem + + **Example request**: + + GET /containers/4fa6e0f0c678/changes HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "Path":"/dev", + "Kind":0 + }, + { + "Path":"/dev/kmsg", + "Kind":1 + }, + { + "Path":"/test", + "Kind":1 + } + ] + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### Export a container + + `GET /containers/`(*id*)`/export` +: Export the contents of container `id` + + **Example request**: + + GET /containers/4fa6e0f0c678/export HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/octet-stream + + {{ STREAM }} + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### Start a container + + `POST /containers/`(*id*)`/start` +: Start the container `id` + + **Example request**: + + POST /containers/(id)/start HTTP/1.1 + Content-Type: application/json + + { + "Binds":["/tmp:/tmp"], + "LxcConf":{"lxc.utsname":"docker"}, + "PortBindings":{ "22/tcp": [{ "HostPort": "11022" }] }, + "PublishAllPorts":false, + "Privileged":false + "Dns": ["8.8.8.8"], + "VolumesFrom: ["parent", "other:ro"] + } + + **Example response**: + + HTTP/1.1 204 No Content + Content-Type: text/plain + + Json Parameters: + +   + + - **hostConfig** – the container’s host configuration (optional) + + Status Codes: + + - **204** – no error + - **404** – no such container + - **500** – server error + +#### Stop a container + + `POST /containers/`(*id*)`/stop` +: Stop the container `id` + + **Example request**: + + POST /containers/e90e34656806/stop?t=5 HTTP/1.1 + + **Example response**: + + HTTP/1.1 204 OK + + Query Parameters: + +   + + - **t** – number of seconds to wait before killing the container + + Status Codes: + + - **204** – no error + - **404** – no such container + - **500** – server error + +#### Restart a container + + `POST /containers/`(*id*)`/restart` +: Restart the container `id` + + **Example request**: + + POST /containers/e90e34656806/restart?t=5 HTTP/1.1 + + **Example response**: + + HTTP/1.1 204 OK + + Query Parameters: + +   + + - **t** – number of seconds to wait before killing the container + + Status Codes: + + - **204** – no error + - **404** – no such container + - **500** – server error + +#### Kill a container + + `POST /containers/`(*id*)`/kill` +: Kill the container `id` + + **Example request**: + + POST /containers/e90e34656806/kill HTTP/1.1 + + **Example response**: + + HTTP/1.1 204 OK + + Status Codes: + + - **204** – no error + - **404** – no such container + - **500** – server error + +#### Attach to a container + + `POST /containers/`(*id*)`/attach` +: Attach to the container `id` + + **Example request**: + + POST /containers/16253994b7c4/attach?logs=1&stream=0&stdout=1 HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/vnd.docker.raw-stream + + {{ STREAM }} + + Query Parameters: + +   + + - **logs** – 1/True/true or 0/False/false, return logs. Default + false + - **stream** – 1/True/true or 0/False/false, return stream. + Default false + - **stdin** – 1/True/true or 0/False/false, if stream=true, attach + to stdin. Default false + - **stdout** – 1/True/true or 0/False/false, if logs=true, return + stdout log, if stream=true, attach to stdout. Default false + - **stderr** – 1/True/true or 0/False/false, if logs=true, return + stderr log, if stream=true, attach to stderr. Default false + + Status Codes: + + - **200** – no error + - **400** – bad parameter + - **404** – no such container + - **500** – server error + + **Stream details**: + + When using the TTY setting is enabled in + [`POST /containers/create` +](../docker_remote_api_v1.9/#post--containers-create "POST /containers/create"), + the stream is the raw data from the process PTY and client’s stdin. + When the TTY is disabled, then the stream is multiplexed to separate + stdout and stderr. + + The format is a **Header** and a **Payload** (frame). + + **HEADER** + + The header will contain the information on which stream write the + stream (stdout or stderr). It also contain the size of the + associated frame encoded on the last 4 bytes (uint32). + + It is encoded on the first 8 bytes like this: + + header := [8]byte{STREAM_TYPE, 0, 0, 0, SIZE1, SIZE2, SIZE3, SIZE4} + + `STREAM_TYPE` can be: + + - 0: stdin (will be writen on stdout) + - 1: stdout + - 2: stderr + + `SIZE1, SIZE2, SIZE3, SIZE4` are the 4 bytes of + the uint32 size encoded as big endian. + + **PAYLOAD** + + The payload is the raw stream. + + **IMPLEMENTATION** + + The simplest way to implement the Attach protocol is the following: + + 1. Read 8 bytes + 2. chose stdout or stderr depending on the first byte + 3. Extract the frame size from the last 4 byets + 4. Read the extracted size and output it on the correct output + 5. Goto 1) + +#### Wait a container + + `POST /containers/`(*id*)`/wait` +: Block until container `id` stops, then returns + the exit code + + **Example request**: + + POST /containers/16253994b7c4/wait HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {"StatusCode":0} + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### Remove a container + + `DELETE /containers/`(*id*) +: Remove the container `id` from the filesystem + + **Example request**: + + DELETE /containers/16253994b7c4?v=1 HTTP/1.1 + + **Example response**: + + HTTP/1.1 204 OK + + Query Parameters: + +   + + - **v** – 1/True/true or 0/False/false, Remove the volumes + associated to the container. Default false + - **force** – 1/True/true or 0/False/false, Removes the container + even if it was running. Default false + + Status Codes: + + - **204** – no error + - **400** – bad parameter + - **404** – no such container + - **500** – server error + +#### Copy files or folders from a container + + `POST /containers/`(*id*)`/copy` +: Copy files or folders of container `id` + + **Example request**: + + POST /containers/4fa6e0f0c678/copy HTTP/1.1 + Content-Type: application/json + + { + "Resource":"test.txt" + } + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/octet-stream + + {{ STREAM }} + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +### 2.2 Images + +#### List Images + + `GET /images/json` +: **Example request**: + + GET /images/json?all=0 HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "RepoTags": [ + "ubuntu:12.04", + "ubuntu:precise", + "ubuntu:latest" + ], + "Id": "8dbd9e392a964056420e5d58ca5cc376ef18e2de93b5cc90e868a1bbc8318c1c", + "Created": 1365714795, + "Size": 131506275, + "VirtualSize": 131506275 + }, + { + "RepoTags": [ + "ubuntu:12.10", + "ubuntu:quantal" + ], + "ParentId": "27cf784147099545", + "Id": "b750fe79269d2ec9a3c593ef05b4332b1d1a02a62b4accb2c21d589ff2f5f2dc", + "Created": 1364102658, + "Size": 24653, + "VirtualSize": 180116135 + } + ] + +#### Create an image + + `POST /images/create` +: Create an image, either by pull it from the registry or by importing + it + + **Example request**: + + POST /images/create?fromImage=base HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {"status":"Pulling..."} + {"status":"Pulling", "progress":"1 B/ 100 B", "progressDetail":{"current":1, "total":100}} + {"error":"Invalid..."} + ... + + When using this endpoint to pull an image from the registry, the + `X-Registry-Auth` header can be used to include + a base64-encoded AuthConfig object. + + Query Parameters: + +   + + - **fromImage** – name of the image to pull + - **fromSrc** – source to import, - means stdin + - **repo** – repository + - **tag** – tag + - **registry** – the registry to pull from + + Request Headers: + +   + + - **X-Registry-Auth** – base64-encoded AuthConfig object + + Status Codes: + + - **200** – no error + - **500** – server error + +#### Insert a file in an image + + `POST /images/`(*name*)`/insert` +: Insert a file from `url` in the image + `name` at `path` + + **Example request**: + + POST /images/test/insert?path=/usr&url=myurl HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {"status":"Inserting..."} + {"status":"Inserting", "progress":"1/? (n/a)", "progressDetail":{"current":1}} + {"error":"Invalid..."} + ... + + Status Codes: + + - **200** – no error + - **500** – server error + +#### Inspect an image + + `GET /images/`(*name*)`/json` +: Return low-level information on the image `name` + + **Example request**: + + GET /images/base/json HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "id":"b750fe79269d2ec9a3c593ef05b4332b1d1a02a62b4accb2c21d589ff2f5f2dc", + "parent":"27cf784147099545", + "created":"2013-03-23T22:24:18.818426-07:00", + "container":"3d67245a8d72ecf13f33dffac9f79dcdf70f75acb84d308770391510e0c23ad0", + "container_config": + { + "Hostname":"", + "User":"", + "Memory":0, + "MemorySwap":0, + "AttachStdin":false, + "AttachStdout":false, + "AttachStderr":false, + "PortSpecs":null, + "Tty":true, + "OpenStdin":true, + "StdinOnce":false, + "Env":null, + "Cmd": ["/bin/bash"] + "Image":"base", + "Volumes":null, + "WorkingDir":"" + }, + "Size": 6824592 + } + + Status Codes: + + - **200** – no error + - **404** – no such image + - **500** – server error + +#### Get the history of an image + + `GET /images/`(*name*)`/history` +: Return the history of the image `name` + + **Example request**: + + GET /images/base/history HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "Id":"b750fe79269d", + "Created":1364102658, + "CreatedBy":"/bin/bash" + }, + { + "Id":"27cf78414709", + "Created":1364068391, + "CreatedBy":"" + } + ] + + Status Codes: + + - **200** – no error + - **404** – no such image + - **500** – server error + +#### Push an image on the registry + + `POST /images/`(*name*)`/push` +: Push the image `name` on the registry + + **Example request**: + + POST /images/test/push HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {"status":"Pushing..."} + {"status":"Pushing", "progress":"1/? (n/a)", "progressDetail":{"current":1}}} + {"error":"Invalid..."} + ... + + Query Parameters: + +   + + - **registry** – the registry you wan to push, optional + + Request Headers: + +   + + - **X-Registry-Auth** – include a base64-encoded AuthConfig + object. + + Status Codes: + + - **200** – no error + - **404** – no such image + - **500** – server error + +#### Tag an image into a repository + + `POST /images/`(*name*)`/tag` +: Tag the image `name` into a repository + + **Example request**: + + POST /images/test/tag?repo=myrepo&force=0 HTTP/1.1 + + **Example response**: + + HTTP/1.1 201 OK + + Query Parameters: + +   + + - **repo** – The repository to tag in + - **force** – 1/True/true or 0/False/false, default false + + Status Codes: + + - **201** – no error + - **400** – bad parameter + - **404** – no such image + - **409** – conflict + - **500** – server error + +#### Remove an image + + `DELETE /images/`(*name*) +: Remove the image `name` from the filesystem + + **Example request**: + + DELETE /images/test HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-type: application/json + + [ + {"Untagged":"3e2f21a89f"}, + {"Deleted":"3e2f21a89f"}, + {"Deleted":"53b4f83ac9"} + ] + + Query Parameters: + +   + + - **force** – 1/True/true or 0/False/false, default false + - **noprune** – 1/True/true or 0/False/false, default false + + Status Codes: + + - **200** – no error + - **404** – no such image + - **409** – conflict + - **500** – server error + +#### Search images + + `GET /images/search` +: Search for an image in the docker index. + +> **Note**: +> The response keys have changed from API v1.6 to reflect the JSON +> sent by the registry server to the docker daemon’s request. + + **Example request**: + + GET /images/search?term=sshd HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "description": "", + "is_official": false, + "is_trusted": false, + "name": "wma55/u1210sshd", + "star_count": 0 + }, + { + "description": "", + "is_official": false, + "is_trusted": false, + "name": "jdswinbank/sshd", + "star_count": 0 + }, + { + "description": "", + "is_official": false, + "is_trusted": false, + "name": "vgauthier/sshd", + "star_count": 0 + } + ... + ] + + Query Parameters: + +   + + - **term** – term to search + + Status Codes: + + - **200** – no error + - **500** – server error + +### 2.3 Misc + +#### Build an image from Dockerfile via stdin + + `POST /build` +: Build an image from Dockerfile via stdin + + **Example request**: + + POST /build HTTP/1.1 + + {{ STREAM }} + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {"stream":"Step 1..."} + {"stream":"..."} + {"error":"Error...", "errorDetail":{"code": 123, "message": "Error..."}} + + The stream must be a tar archive compressed with one of the + following algorithms: identity (no compression), gzip, bzip2, xz. + + The archive must include a file called `Dockerfile` + at its root. It may include any number of other files, + which will be accessible in the build context (See the [*ADD build + command*](../../builder/#dockerbuilder)). + + Query Parameters: + +   + + - **t** – repository name (and optionally a tag) to be applied to + the resulting image in case of success + - **q** – suppress verbose build output + - **nocache** – do not use the cache when building the image + + Request Headers: + +   + + - **Content-type** – should be set to + `"application/tar"`. + - **X-Registry-Config** – base64-encoded ConfigFile object + + Status Codes: + + - **200** – no error + - **500** – server error + +#### Check auth configuration + + `POST /auth` +: Get the default username and email + + **Example request**: + + POST /auth HTTP/1.1 + Content-Type: application/json + + { + "username":"hannibal", + "password:"xxxx", + "email":"hannibal@a-team.com", + "serveraddress":"https://index.docker.io/v1/" + } + + **Example response**: + + HTTP/1.1 200 OK + + Status Codes: + + - **200** – no error + - **204** – no error + - **500** – server error + +#### Display system-wide information + + `GET /info` +: Display system-wide information + + **Example request**: + + GET /info HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "Containers":11, + "Images":16, + "Debug":false, + "NFd": 11, + "NGoroutines":21, + "MemoryLimit":true, + "SwapLimit":false, + "IPv4Forwarding":true + } + + Status Codes: + + - **200** – no error + - **500** – server error + +#### Show the docker version information + + `GET /version` +: Show the docker version information + + **Example request**: + + GET /version HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "Version":"0.2.2", + "GitCommit":"5a2a5cc+CHANGES", + "GoVersion":"go1.0.3" + } + + Status Codes: + + - **200** – no error + - **500** – server error + +#### Create a new image from a container’s changes + + `POST /commit` +: Create a new image from a container’s changes + + **Example request**: + + POST /commit?container=44c004db4b17&m=message&repo=myrepo HTTP/1.1 + + **Example response**: + + HTTP/1.1 201 OK + Content-Type: application/vnd.docker.raw-stream + + {"Id":"596069db4bf5"} + + Query Parameters: + +   + + - **container** – source container + - **repo** – repository + - **tag** – tag + - **m** – commit message + - **author** – author (eg. "John Hannibal Smith + \<[hannibal@a-team.com](mailto:hannibal%40a-team.com)\>") + - **run** – config automatically applied when the image is run. + (ex: {"Cmd": ["cat", "/world"], "PortSpecs":["22"]}) + + Status Codes: + + - **201** – no error + - **404** – no such container + - **500** – server error + +#### Monitor Docker’s events + + `GET /events` +: Get events from docker, either in real time via streaming, or via + polling (using since) + + **Example request**: + + GET /events?since=1374067924 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {"status":"create","id":"dfdf82bd3881","from":"base:latest","time":1374067924} + {"status":"start","id":"dfdf82bd3881","from":"base:latest","time":1374067924} + {"status":"stop","id":"dfdf82bd3881","from":"base:latest","time":1374067966} + {"status":"destroy","id":"dfdf82bd3881","from":"base:latest","time":1374067970} + + Query Parameters: + +   + + - **since** – timestamp used for polling + + Status Codes: + + - **200** – no error + - **500** – server error + +#### Get a tarball containing all images and tags in a repository + + `GET /images/`(*name*)`/get` +: Get a tarball containing all images and metadata for the repository + specified by `name`. + + **Example request** + + GET /images/ubuntu/get + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/x-tar + + Binary data stream + + Status Codes: + + - **200** – no error + - **500** – server error + +#### Load a tarball with a set of images and tags into docker + + `POST /images/load` +: Load a set of images and tags into the docker repository. + + **Example request** + + POST /images/load + + Tarball in body + + **Example response**: + + HTTP/1.1 200 OK + + Status Codes: + + - **200** – no error + - **500** – server error + +## 3. Going further + +### 3.1 Inside ‘docker run’ + +Here are the steps of ‘docker run’ : + +- Create the container + +- If the status code is 404, it means the image doesn’t exists: + : - Try to pull it + - Then retry to create the container + +- Start the container + +- If you are not in detached mode: + : - Attach to the container, using logs=1 (to have stdout and + stderr from the container’s start) and stream=1 + +- If in detached mode or only stdin is attached: + : - Display the container’s id + +### 3.2 Hijacking + +In this version of the API, /attach, uses hijacking to transport stdin, +stdout and stderr on the same socket. This might change in the future. + +### 3.3 CORS Requests + +To enable cross origin requests to the remote api add the flag +"–api-enable-cors" when running docker in daemon mode. + + docker -d -H="192.168.1.9:4243" --api-enable-cors diff --git a/docs/sources/reference/api/docker_remote_api_v1.10.rst b/docs/sources/reference/api/docker_remote_api_v1.10.rst index 3d6af7e939..83e2c3c15b 100644 --- a/docs/sources/reference/api/docker_remote_api_v1.10.rst +++ b/docs/sources/reference/api/docker_remote_api_v1.10.rst @@ -8,8 +8,6 @@ Docker Remote API v1.10 ======================= -.. contents:: Table of Contents - 1. Brief introduction ===================== diff --git a/docs/sources/reference/api/docker_remote_api_v1.11.md b/docs/sources/reference/api/docker_remote_api_v1.11.md new file mode 100644 index 0000000000..6e038acd82 --- /dev/null +++ b/docs/sources/reference/api/docker_remote_api_v1.11.md @@ -0,0 +1,1241 @@ +page_title: Remote API v1.11 +page_description: API Documentation for Docker +page_keywords: API, Docker, rcli, REST, documentation + +# Docker Remote API v1.11 + +## 1. Brief introduction + +- The Remote API has replaced rcli +- The daemon listens on `unix:///var/run/docker.sock` +, but you can [*Bind Docker to another host/port or a Unix + socket*](../../../use/basics/#bind-docker). +- 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.1 Containers + +#### List containers + + `GET /containers/json` +: List containers + + **Example request**: + + GET /containers/json?all=1&before=8dfafdbc3a40&size=1 HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "Id": "8dfafdbc3a40", + "Image": "base:latest", + "Command": "echo 1", + "Created": 1367854155, + "Status": "Exit 0", + "Ports":[{"PrivatePort": 2222, "PublicPort": 3333, "Type": "tcp"}], + "SizeRw":12288, + "SizeRootFs":0 + }, + { + "Id": "9cd87474be90", + "Image": "base:latest", + "Command": "echo 222222", + "Created": 1367854155, + "Status": "Exit 0", + "Ports":[], + "SizeRw":12288, + "SizeRootFs":0 + }, + { + "Id": "3176a2479c92", + "Image": "base:latest", + "Command": "echo 3333333333333333", + "Created": 1367854154, + "Status": "Exit 0", + "Ports":[], + "SizeRw":12288, + "SizeRootFs":0 + }, + { + "Id": "4cb07b47f9fb", + "Image": "base:latest", + "Command": "echo 444444444444444444444444444444444", + "Created": 1367854152, + "Status": "Exit 0", + "Ports":[], + "SizeRw":12288, + "SizeRootFs":0 + } + ] + + Query Parameters: + +   + + - **all** – 1/True/true or 0/False/false, Show all containers. + Only running containers are shown by default + - **limit** – Show `limit` last created + containers, include non-running ones. + - **since** – Show only containers created since Id, include + non-running ones. + - **before** – Show only containers created before Id, include + non-running ones. + - **size** – 1/True/true or 0/False/false, Show the containers + sizes + + Status Codes: + + - **200** – no error + - **400** – bad parameter + - **500** – server error + +#### Create a container + + `POST /containers/create` +: Create a container + + **Example request**: + + POST /containers/create HTTP/1.1 + Content-Type: application/json + + { + "Hostname":"", + "User":"", + "Memory":0, + "MemorySwap":0, + "AttachStdin":false, + "AttachStdout":true, + "AttachStderr":true, + "PortSpecs":null, + "Tty":false, + "OpenStdin":false, + "StdinOnce":false, + "Env":null, + "Cmd":[ + "date" + ], + "Dns":null, + "Image":"base", + "Volumes":{ + "/tmp": {} + }, + "VolumesFrom":"", + "WorkingDir":"", + "DisableNetwork": false, + "ExposedPorts":{ + "22/tcp": {} + } + } + + **Example response**: + + HTTP/1.1 201 OK + Content-Type: application/json + + { + "Id":"e90e34656806" + "Warnings":[] + } + + Json Parameters: + +   + + - **config** – the container’s configuration + + Query Parameters: + +   + + - **name** – Assign the specified name to the container. Must + match `/?[a-zA-Z0-9_-]+`. + + Status Codes: + + - **201** – no error + - **404** – no such container + - **406** – impossible to attach (container not running) + - **500** – server error + +#### Inspect a container + + `GET /containers/`(*id*)`/json` +: Return low-level information on the container `id` + + + **Example request**: + + GET /containers/4fa6e0f0c678/json HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "Id": "4fa6e0f0c6786287e131c3852c58a2e01cc697a68231826813597e4994f1d6e2", + "Created": "2013-05-07T14:51:42.041847+02:00", + "Path": "date", + "Args": [], + "Config": { + "Hostname": "4fa6e0f0c678", + "User": "", + "Memory": 0, + "MemorySwap": 0, + "AttachStdin": false, + "AttachStdout": true, + "AttachStderr": true, + "PortSpecs": null, + "Tty": false, + "OpenStdin": false, + "StdinOnce": false, + "Env": null, + "Cmd": [ + "date" + ], + "Dns": null, + "Image": "base", + "Volumes": {}, + "VolumesFrom": "", + "WorkingDir":"" + + }, + "State": { + "Running": false, + "Pid": 0, + "ExitCode": 0, + "StartedAt": "2013-05-07T14:51:42.087658+02:01360", + "Ghost": false + }, + "Image": "b750fe79269d2ec9a3c593ef05b4332b1d1a02a62b4accb2c21d589ff2f5f2dc", + "NetworkSettings": { + "IpAddress": "", + "IpPrefixLen": 0, + "Gateway": "", + "Bridge": "", + "PortMapping": null + }, + "SysInitPath": "/home/kitty/go/src/github.com/dotcloud/docker/bin/docker", + "ResolvConfPath": "/etc/resolv.conf", + "Volumes": {}, + "HostConfig": { + "Binds": null, + "ContainerIDFile": "", + "LxcConf": [], + "Privileged": false, + "PortBindings": { + "80/tcp": [ + { + "HostIp": "0.0.0.0", + "HostPort": "49153" + } + ] + }, + "Links": null, + "PublishAllPorts": false + } + } + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### List processes running inside a container + + `GET /containers/`(*id*)`/top` +: List processes running inside the container `id` + + **Example request**: + + GET /containers/4fa6e0f0c678/top HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "Titles":[ + "USER", + "PID", + "%CPU", + "%MEM", + "VSZ", + "RSS", + "TTY", + "STAT", + "START", + "TIME", + "COMMAND" + ], + "Processes":[ + ["root","20147","0.0","0.1","18060","1864","pts/4","S","10:06","0:00","bash"], + ["root","20271","0.0","0.0","4312","352","pts/4","S+","10:07","0:00","sleep","10"] + ] + } + + Query Parameters: + +   + + - **ps\_args** – ps arguments to use (eg. aux) + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### Inspect changes on a container’s filesystem + + `GET /containers/`(*id*)`/changes` +: Inspect changes on container `id` ‘s filesystem + + **Example request**: + + GET /containers/4fa6e0f0c678/changes HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "Path":"/dev", + "Kind":0 + }, + { + "Path":"/dev/kmsg", + "Kind":1 + }, + { + "Path":"/test", + "Kind":1 + } + ] + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### Export a container + + `GET /containers/`(*id*)`/export` +: Export the contents of container `id` + + **Example request**: + + GET /containers/4fa6e0f0c678/export HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/octet-stream + + {{ STREAM }} + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### Start a container + + `POST /containers/`(*id*)`/start` +: Start the container `id` + + **Example request**: + + POST /containers/(id)/start HTTP/1.1 + Content-Type: application/json + + { + "Binds":["/tmp:/tmp"], + "LxcConf":{"lxc.utsname":"docker"}, + "PortBindings":{ "22/tcp": [{ "HostPort": "11022" }] }, + "PublishAllPorts":false, + "Privileged":false + } + + **Example response**: + + HTTP/1.1 204 No Content + Content-Type: text/plain + + Json Parameters: + +   + + - **hostConfig** – the container’s host configuration (optional) + + Status Codes: + + - **204** – no error + - **404** – no such container + - **500** – server error + +#### Stop a container + + `POST /containers/`(*id*)`/stop` +: Stop the container `id` + + **Example request**: + + POST /containers/e90e34656806/stop?t=5 HTTP/1.1 + + **Example response**: + + HTTP/1.1 204 OK + + Query Parameters: + +   + + - **t** – number of seconds to wait before killing the container + + Status Codes: + + - **204** – no error + - **404** – no such container + - **500** – server error + +#### Restart a container + + `POST /containers/`(*id*)`/restart` +: Restart the container `id` + + **Example request**: + + POST /containers/e90e34656806/restart?t=5 HTTP/1.1 + + **Example response**: + + HTTP/1.1 204 OK + + Query Parameters: + +   + + - **t** – number of seconds to wait before killing the container + + Status Codes: + + - **204** – no error + - **404** – no such container + - **500** – server error + +#### Kill a container + + `POST /containers/`(*id*)`/kill` +: Kill the container `id` + + **Example request**: + + POST /containers/e90e34656806/kill HTTP/1.1 + + **Example response**: + + HTTP/1.1 204 OK + + Status Codes: + + - **204** – no error + - **404** – no such container + - **500** – server error + +#### Attach to a container + + `POST /containers/`(*id*)`/attach` +: Attach to the container `id` + + **Example request**: + + POST /containers/16253994b7c4/attach?logs=1&stream=0&stdout=1 HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/vnd.docker.raw-stream + + {{ STREAM }} + + Query Parameters: + +   + + - **logs** – 1/True/true or 0/False/false, return logs. Default + false + - **stream** – 1/True/true or 0/False/false, return stream. + Default false + - **stdin** – 1/True/true or 0/False/false, if stream=true, attach + to stdin. Default false + - **stdout** – 1/True/true or 0/False/false, if logs=true, return + stdout log, if stream=true, attach to stdout. Default false + - **stderr** – 1/True/true or 0/False/false, if logs=true, return + stderr log, if stream=true, attach to stderr. Default false + + Status Codes: + + - **200** – no error + - **400** – bad parameter + - **404** – no such container + - **500** – server error + + **Stream details**: + + When using the TTY setting is enabled in + [`POST /containers/create` +](../docker_remote_api_v1.9/#post--containers-create "POST /containers/create"), + the stream is the raw data from the process PTY and client’s stdin. + When the TTY is disabled, then the stream is multiplexed to separate + stdout and stderr. + + The format is a **Header** and a **Payload** (frame). + + **HEADER** + + The header will contain the information on which stream write the + stream (stdout or stderr). It also contain the size of the + associated frame encoded on the last 4 bytes (uint32). + + It is encoded on the first 8 bytes like this: + + header := [8]byte{STREAM_TYPE, 0, 0, 0, SIZE1, SIZE2, SIZE3, SIZE4} + + `STREAM_TYPE` can be: + + - 0: stdin (will be writen on stdout) + - 1: stdout + - 2: stderr + + `SIZE1, SIZE2, SIZE3, SIZE4` are the 4 bytes of + the uint32 size encoded as big endian. + + **PAYLOAD** + + The payload is the raw stream. + + **IMPLEMENTATION** + + The simplest way to implement the Attach protocol is the following: + + 1. Read 8 bytes + 2. chose stdout or stderr depending on the first byte + 3. Extract the frame size from the last 4 byets + 4. Read the extracted size and output it on the correct output + 5. Goto 1) + +#### Wait a container + + `POST /containers/`(*id*)`/wait` +: Block until container `id` stops, then returns + the exit code + + **Example request**: + + POST /containers/16253994b7c4/wait HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {"StatusCode":0} + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### Remove a container + + `DELETE /containers/`(*id*) +: Remove the container `id` from the filesystem + + **Example request**: + + DELETE /containers/16253994b7c4?v=1 HTTP/1.1 + + **Example response**: + + HTTP/1.1 204 OK + + Query Parameters: + +   + + - **v** – 1/True/true or 0/False/false, Remove the volumes + associated to the container. Default false + - **force** – 1/True/true or 0/False/false, Removes the container + even if it was running. Default false + + Status Codes: + + - **204** – no error + - **400** – bad parameter + - **404** – no such container + - **500** – server error + +#### Copy files or folders from a container + + `POST /containers/`(*id*)`/copy` +: Copy files or folders of container `id` + + **Example request**: + + POST /containers/4fa6e0f0c678/copy HTTP/1.1 + Content-Type: application/json + + { + "Resource":"test.txt" + } + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/octet-stream + + {{ STREAM }} + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +### 2.2 Images + +#### List Images + + `GET /images/json` +: **Example request**: + + GET /images/json?all=0 HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "RepoTags": [ + "ubuntu:12.04", + "ubuntu:precise", + "ubuntu:latest" + ], + "Id": "8dbd9e392a964056420e5d58ca5cc376ef18e2de93b5cc90e868a1bbc8318c1c", + "Created": 1365714795, + "Size": 131506275, + "VirtualSize": 131506275 + }, + { + "RepoTags": [ + "ubuntu:12.10", + "ubuntu:quantal" + ], + "ParentId": "27cf784147099545", + "Id": "b750fe79269d2ec9a3c593ef05b4332b1d1a02a62b4accb2c21d589ff2f5f2dc", + "Created": 1364102658, + "Size": 24653, + "VirtualSize": 180116135 + } + ] + +#### Create an image + + `POST /images/create` +: Create an image, either by pull it from the registry or by importing + it + + **Example request**: + + POST /images/create?fromImage=base HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {"status":"Pulling..."} + {"status":"Pulling", "progress":"1 B/ 100 B", "progressDetail":{"current":1, "total":100}} + {"error":"Invalid..."} + ... + + When using this endpoint to pull an image from the registry, the + `X-Registry-Auth` header can be used to include + a base64-encoded AuthConfig object. + + Query Parameters: + +   + + - **fromImage** – name of the image to pull + - **fromSrc** – source to import, - means stdin + - **repo** – repository + - **tag** – tag + - **registry** – the registry to pull from + + Request Headers: + +   + + - **X-Registry-Auth** – base64-encoded AuthConfig object + + Status Codes: + + - **200** – no error + - **500** – server error + +#### Insert a file in an image + + `POST /images/`(*name*)`/insert` +: Insert a file from `url` in the image + `name` at `path` + + **Example request**: + + POST /images/test/insert?path=/usr&url=myurl HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {"status":"Inserting..."} + {"status":"Inserting", "progress":"1/? (n/a)", "progressDetail":{"current":1}} + {"error":"Invalid..."} + ... + + Status Codes: + + - **200** – no error + - **500** – server error + +#### Inspect an image + + `GET /images/`(*name*)`/json` +: Return low-level information on the image `name` + + **Example request**: + + GET /images/base/json HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "id":"b750fe79269d2ec9a3c593ef05b4332b1d1a02a62b4accb2c21d589ff2f5f2dc", + "parent":"27cf784147099545", + "created":"2013-03-23T22:24:18.818426-07:00", + "container":"3d67245a8d72ecf13f33dffac9f79dcdf70f75acb84d308770391510e0c23ad0", + "container_config": + { + "Hostname":"", + "User":"", + "Memory":0, + "MemorySwap":0, + "AttachStdin":false, + "AttachStdout":false, + "AttachStderr":false, + "PortSpecs":null, + "Tty":true, + "OpenStdin":true, + "StdinOnce":false, + "Env":null, + "Cmd": ["/bin/bash"] + ,"Dns":null, + "Image":"base", + "Volumes":null, + "VolumesFrom":"", + "WorkingDir":"" + }, + "Size": 6824592 + } + + Status Codes: + + - **200** – no error + - **404** – no such image + - **500** – server error + +#### Get the history of an image + + `GET /images/`(*name*)`/history` +: Return the history of the image `name` + + **Example request**: + + GET /images/base/history HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "Id":"b750fe79269d", + "Created":1364102658, + "CreatedBy":"/bin/bash" + }, + { + "Id":"27cf78414709", + "Created":1364068391, + "CreatedBy":"" + } + ] + + Status Codes: + + - **200** – no error + - **404** – no such image + - **500** – server error + +#### Push an image on the registry + + `POST /images/`(*name*)`/push` +: Push the image `name` on the registry + + **Example request**: + + POST /images/test/push HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {"status":"Pushing..."} + {"status":"Pushing", "progress":"1/? (n/a)", "progressDetail":{"current":1}}} + {"error":"Invalid..."} + ... + + Query Parameters: + +   + + - **registry** – the registry you wan to push, optional + + Request Headers: + +   + + - **X-Registry-Auth** – include a base64-encoded AuthConfig + object. + + Status Codes: + + - **200** – no error + - **404** – no such image + - **500** – server error + +#### Tag an image into a repository + + `POST /images/`(*name*)`/tag` +: Tag the image `name` into a repository + + **Example request**: + + POST /images/test/tag?repo=myrepo&force=0 HTTP/1.1 + + **Example response**: + + HTTP/1.1 201 OK + + Query Parameters: + +   + + - **repo** – The repository to tag in + - **force** – 1/True/true or 0/False/false, default false + + Status Codes: + + - **201** – no error + - **400** – bad parameter + - **404** – no such image + - **409** – conflict + - **500** – server error + +#### Remove an image + + `DELETE /images/`(*name*) +: Remove the image `name` from the filesystem + + **Example request**: + + DELETE /images/test HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-type: application/json + + [ + {"Untagged":"3e2f21a89f"}, + {"Deleted":"3e2f21a89f"}, + {"Deleted":"53b4f83ac9"} + ] + + Query Parameters: + +   + + - **force** – 1/True/true or 0/False/false, default false + - **noprune** – 1/True/true or 0/False/false, default false + + Status Codes: + + - **200** – no error + - **404** – no such image + - **409** – conflict + - **500** – server error + +#### Search images + + `GET /images/search` +: Search for an image in the docker index. + +> **Note**: +> The response keys have changed from API v1.6 to reflect the JSON +> sent by the registry server to the docker daemon’s request. + + **Example request**: + + GET /images/search?term=sshd HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "description": "", + "is_official": false, + "is_trusted": false, + "name": "wma55/u1210sshd", + "star_count": 0 + }, + { + "description": "", + "is_official": false, + "is_trusted": false, + "name": "jdswinbank/sshd", + "star_count": 0 + }, + { + "description": "", + "is_official": false, + "is_trusted": false, + "name": "vgauthier/sshd", + "star_count": 0 + } + ... + ] + + Query Parameters: + +   + + - **term** – term to search + + Status Codes: + + - **200** – no error + - **500** – server error + +### 2.3 Misc + +#### Build an image from Dockerfile via stdin + + `POST /build` +: Build an image from Dockerfile via stdin + + **Example request**: + + POST /build HTTP/1.1 + + {{ STREAM }} + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {"stream":"Step 1..."} + {"stream":"..."} + {"error":"Error...", "errorDetail":{"code": 123, "message": "Error..."}} + + The stream must be a tar archive compressed with one of the + following algorithms: identity (no compression), gzip, bzip2, xz. + + The archive must include a file called `Dockerfile` + at its root. It may include any number of other files, + which will be accessible in the build context (See the [*ADD build + command*](../../builder/#dockerbuilder)). + + Query Parameters: + +   + + - **t** – repository name (and optionally a tag) to be applied to + the resulting image in case of success + - **q** – suppress verbose build output + - **nocache** – do not use the cache when building the image + + Request Headers: + +   + + - **Content-type** – should be set to + `"application/tar"`. + - **X-Registry-Config** – base64-encoded ConfigFile object + + Status Codes: + + - **200** – no error + - **500** – server error + +#### Check auth configuration + + `POST /auth` +: Get the default username and email + + **Example request**: + + POST /auth HTTP/1.1 + Content-Type: application/json + + { + "username":"hannibal", + "password:"xxxx", + "email":"hannibal@a-team.com", + "serveraddress":"https://index.docker.io/v1/" + } + + **Example response**: + + HTTP/1.1 200 OK + + Status Codes: + + - **200** – no error + - **204** – no error + - **500** – server error + +#### Display system-wide information + + `GET /info` +: Display system-wide information + + **Example request**: + + GET /info HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "Containers":11, + "Images":16, + "Debug":false, + "NFd": 11, + "NGoroutines":21, + "MemoryLimit":true, + "SwapLimit":false, + "IPv4Forwarding":true + } + + Status Codes: + + - **200** – no error + - **500** – server error + +#### Show the docker version information + + `GET /version` +: Show the docker version information + + **Example request**: + + GET /version HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "Version":"0.2.2", + "GitCommit":"5a2a5cc+CHANGES", + "GoVersion":"go1.0.3" + } + + Status Codes: + + - **200** – no error + - **500** – server error + +#### Create a new image from a container’s changes + + `POST /commit` +: Create a new image from a container’s changes + + **Example request**: + + POST /commit?container=44c004db4b17&m=message&repo=myrepo HTTP/1.1 + + **Example response**: + + HTTP/1.1 201 OK + Content-Type: application/vnd.docker.raw-stream + + {"Id":"596069db4bf5"} + + Query Parameters: + +   + + - **container** – source container + - **repo** – repository + - **tag** – tag + - **m** – commit message + - **author** – author (eg. "John Hannibal Smith + \<[hannibal@a-team.com](mailto:hannibal%40a-team.com)\>") + - **run** – config automatically applied when the image is run. + (ex: {"Cmd": ["cat", "/world"], "PortSpecs":["22"]}) + + Status Codes: + + - **201** – no error + - **404** – no such container + - **500** – server error + +#### Monitor Docker’s events + + `GET /events` +: Get events from docker, either in real time via streaming, or via + polling (using since) + + **Example request**: + + GET /events?since=1374067924 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {"status":"create","id":"dfdf82bd3881","from":"base:latest","time":1374067924} + {"status":"start","id":"dfdf82bd3881","from":"base:latest","time":1374067924} + {"status":"stop","id":"dfdf82bd3881","from":"base:latest","time":1374067966} + {"status":"destroy","id":"dfdf82bd3881","from":"base:latest","time":1374067970} + + Query Parameters: + +   + + - **since** – timestamp used for polling + - **until** – timestamp used for polling + + Status Codes: + + - **200** – no error + - **500** – server error + +#### Get a tarball containing all images and tags in a repository + + `GET /images/`(*name*)`/get` +: Get a tarball containing all images and metadata for the repository + specified by `name`. + + **Example request** + + GET /images/ubuntu/get + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/x-tar + + Binary data stream + + Status Codes: + + - **200** – no error + - **500** – server error + +#### Load a tarball with a set of images and tags into docker + + `POST /images/load` +: Load a set of images and tags into the docker repository. + + **Example request** + + POST /images/load + + Tarball in body + + **Example response**: + + HTTP/1.1 200 OK + + Status Codes: + + - **200** – no error + - **500** – server error + +## 3. Going further + +### 3.1 Inside ‘docker run’ + +Here are the steps of ‘docker run’ : + +- Create the container + +- If the status code is 404, it means the image doesn’t exists: + : - Try to pull it + - Then retry to create the container + +- Start the container + +- If you are not in detached mode: + : - Attach to the container, using logs=1 (to have stdout and + stderr from the container’s start) and stream=1 + +- If in detached mode or only stdin is attached: + : - Display the container’s id + +### 3.2 Hijacking + +In this version of the API, /attach, uses hijacking to transport stdin, +stdout and stderr on the same socket. This might change in the future. + +### 3.3 CORS Requests + +To enable cross origin requests to the remote api add the flag +"–api-enable-cors" when running docker in daemon mode. + + docker -d -H="192.168.1.9:4243" --api-enable-cors diff --git a/docs/sources/reference/api/docker_remote_api_v1.11.rst b/docs/sources/reference/api/docker_remote_api_v1.11.rst index 8c14b21c65..556491c49a 100644 --- a/docs/sources/reference/api/docker_remote_api_v1.11.rst +++ b/docs/sources/reference/api/docker_remote_api_v1.11.rst @@ -8,8 +8,6 @@ Docker Remote API v1.11 ======================= -.. contents:: Table of Contents - 1. Brief introduction ===================== diff --git a/docs/sources/reference/api/docker_remote_api_v1.9.md b/docs/sources/reference/api/docker_remote_api_v1.9.md new file mode 100644 index 0000000000..aaa8dc194b --- /dev/null +++ b/docs/sources/reference/api/docker_remote_api_v1.9.md @@ -0,0 +1,1254 @@ +page_title: Remote API v1.9 +page_description: API Documentation for Docker +page_keywords: API, Docker, rcli, REST, documentation + +# Docker Remote API v1.9 + +## 1. Brief introduction + +- The Remote API has replaced rcli +- The daemon listens on `unix:///var/run/docker.sock` +, but you can [*Bind Docker to another host/port or a Unix + socket*](../../../use/basics/#bind-docker). +- 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.1 Containers + +#### List containers + + `GET /containers/json` +: List containers + + **Example request**: + + GET /containers/json?all=1&before=8dfafdbc3a40&size=1 HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "Id": "8dfafdbc3a40", + "Image": "base:latest", + "Command": "echo 1", + "Created": 1367854155, + "Status": "Exit 0", + "Ports":[{"PrivatePort": 2222, "PublicPort": 3333, "Type": "tcp"}], + "SizeRw":12288, + "SizeRootFs":0 + }, + { + "Id": "9cd87474be90", + "Image": "base:latest", + "Command": "echo 222222", + "Created": 1367854155, + "Status": "Exit 0", + "Ports":[], + "SizeRw":12288, + "SizeRootFs":0 + }, + { + "Id": "3176a2479c92", + "Image": "base:latest", + "Command": "echo 3333333333333333", + "Created": 1367854154, + "Status": "Exit 0", + "Ports":[], + "SizeRw":12288, + "SizeRootFs":0 + }, + { + "Id": "4cb07b47f9fb", + "Image": "base:latest", + "Command": "echo 444444444444444444444444444444444", + "Created": 1367854152, + "Status": "Exit 0", + "Ports":[], + "SizeRw":12288, + "SizeRootFs":0 + } + ] + + Query Parameters: + +   + + - **all** – 1/True/true or 0/False/false, Show all containers. + Only running containers are shown by default + - **limit** – Show `limit` last created + containers, include non-running ones. + - **since** – Show only containers created since Id, include + non-running ones. + - **before** – Show only containers created before Id, include + non-running ones. + - **size** – 1/True/true or 0/False/false, Show the containers + sizes + + Status Codes: + + - **200** – no error + - **400** – bad parameter + - **500** – server error + +#### Create a container + + `POST /containers/create` +: Create a container + + **Example request**: + + POST /containers/create HTTP/1.1 + Content-Type: application/json + + { + "Hostname":"", + "User":"", + "Memory":0, + "MemorySwap":0, + "CpuShares":0, + "AttachStdin":false, + "AttachStdout":true, + "AttachStderr":true, + "PortSpecs":null, + "Tty":false, + "OpenStdin":false, + "StdinOnce":false, + "Env":null, + "Cmd":[ + "date" + ], + "Dns":null, + "Image":"base", + "Volumes":{ + "/tmp": {} + }, + "VolumesFrom":"", + "WorkingDir":"", + "ExposedPorts":{ + "22/tcp": {} + } + } + + **Example response**: + + HTTP/1.1 201 OK + Content-Type: application/json + + { + "Id":"e90e34656806" + "Warnings":[] + } + + Json Parameters: + +   + + - **Hostname** – Container host name + - **User** – Username or UID + - **Memory** – Memory Limit in bytes + - **CpuShares** – CPU shares (relative weight) + - **AttachStdin** – 1/True/true or 0/False/false, attach to + standard input. Default false + - **AttachStdout** – 1/True/true or 0/False/false, attach to + standard output. Default false + - **AttachStderr** – 1/True/true or 0/False/false, attach to + standard error. Default false + - **Tty** – 1/True/true or 0/False/false, allocate a pseudo-tty. + Default false + - **OpenStdin** – 1/True/true or 0/False/false, keep stdin open + even if not attached. Default false + + Query Parameters: + +   + + - **name** – Assign the specified name to the container. Must + match `/?[a-zA-Z0-9_-]+`. + + Status Codes: + + - **201** – no error + - **404** – no such container + - **406** – impossible to attach (container not running) + - **500** – server error + +#### Inspect a container + + `GET /containers/`(*id*)`/json` +: Return low-level information on the container `id` + + + **Example request**: + + GET /containers/4fa6e0f0c678/json HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "Id": "4fa6e0f0c6786287e131c3852c58a2e01cc697a68231826813597e4994f1d6e2", + "Created": "2013-05-07T14:51:42.041847+02:00", + "Path": "date", + "Args": [], + "Config": { + "Hostname": "4fa6e0f0c678", + "User": "", + "Memory": 0, + "MemorySwap": 0, + "AttachStdin": false, + "AttachStdout": true, + "AttachStderr": true, + "PortSpecs": null, + "Tty": false, + "OpenStdin": false, + "StdinOnce": false, + "Env": null, + "Cmd": [ + "date" + ], + "Dns": null, + "Image": "base", + "Volumes": {}, + "VolumesFrom": "", + "WorkingDir":"" + + }, + "State": { + "Running": false, + "Pid": 0, + "ExitCode": 0, + "StartedAt": "2013-05-07T14:51:42.087658+02:01360", + "Ghost": false + }, + "Image": "b750fe79269d2ec9a3c593ef05b4332b1d1a02a62b4accb2c21d589ff2f5f2dc", + "NetworkSettings": { + "IpAddress": "", + "IpPrefixLen": 0, + "Gateway": "", + "Bridge": "", + "PortMapping": null + }, + "SysInitPath": "/home/kitty/go/src/github.com/dotcloud/docker/bin/docker", + "ResolvConfPath": "/etc/resolv.conf", + "Volumes": {}, + "HostConfig": { + "Binds": null, + "ContainerIDFile": "", + "LxcConf": [], + "Privileged": false, + "PortBindings": { + "80/tcp": [ + { + "HostIp": "0.0.0.0", + "HostPort": "49153" + } + ] + }, + "Links": null, + "PublishAllPorts": false + } + } + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### List processes running inside a container + + `GET /containers/`(*id*)`/top` +: List processes running inside the container `id` + + **Example request**: + + GET /containers/4fa6e0f0c678/top HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "Titles":[ + "USER", + "PID", + "%CPU", + "%MEM", + "VSZ", + "RSS", + "TTY", + "STAT", + "START", + "TIME", + "COMMAND" + ], + "Processes":[ + ["root","20147","0.0","0.1","18060","1864","pts/4","S","10:06","0:00","bash"], + ["root","20271","0.0","0.0","4312","352","pts/4","S+","10:07","0:00","sleep","10"] + ] + } + + Query Parameters: + +   + + - **ps\_args** – ps arguments to use (eg. aux) + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### Inspect changes on a container’s filesystem + + `GET /containers/`(*id*)`/changes` +: Inspect changes on container `id` ‘s filesystem + + **Example request**: + + GET /containers/4fa6e0f0c678/changes HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "Path":"/dev", + "Kind":0 + }, + { + "Path":"/dev/kmsg", + "Kind":1 + }, + { + "Path":"/test", + "Kind":1 + } + ] + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### Export a container + + `GET /containers/`(*id*)`/export` +: Export the contents of container `id` + + **Example request**: + + GET /containers/4fa6e0f0c678/export HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/octet-stream + + {{ STREAM }} + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### Start a container + + `POST /containers/`(*id*)`/start` +: Start the container `id` + + **Example request**: + + POST /containers/(id)/start HTTP/1.1 + Content-Type: application/json + + { + "Binds":["/tmp:/tmp"], + "LxcConf":{"lxc.utsname":"docker"}, + "PortBindings":{ "22/tcp": [{ "HostPort": "11022" }] }, + "PublishAllPorts":false, + "Privileged":false + } + + **Example response**: + + HTTP/1.1 204 No Content + Content-Type: text/plain + + Json Parameters: + +   + + - **Binds** – Create a bind mount to a directory or file with + [host-path]:[container-path]:[rw|ro]. If a directory + "container-path" is missing, then docker creates a new volume. + - **LxcConf** – Map of custom lxc options + - **PortBindings** – Expose ports from the container, optionally + publishing them via the HostPort flag + - **PublishAllPorts** – 1/True/true or 0/False/false, publish all + exposed ports to the host interfaces. Default false + - **Privileged** – 1/True/true or 0/False/false, give extended + privileges to this container. Default false + + Status Codes: + + - **204** – no error + - **404** – no such container + - **500** – server error + +#### Stop a container + + `POST /containers/`(*id*)`/stop` +: Stop the container `id` + + **Example request**: + + POST /containers/e90e34656806/stop?t=5 HTTP/1.1 + + **Example response**: + + HTTP/1.1 204 OK + + Query Parameters: + +   + + - **t** – number of seconds to wait before killing the container + + Status Codes: + + - **204** – no error + - **404** – no such container + - **500** – server error + +#### Restart a container + + `POST /containers/`(*id*)`/restart` +: Restart the container `id` + + **Example request**: + + POST /containers/e90e34656806/restart?t=5 HTTP/1.1 + + **Example response**: + + HTTP/1.1 204 OK + + Query Parameters: + +   + + - **t** – number of seconds to wait before killing the container + + Status Codes: + + - **204** – no error + - **404** – no such container + - **500** – server error + +#### Kill a container + + `POST /containers/`(*id*)`/kill` +: Kill the container `id` + + **Example request**: + + POST /containers/e90e34656806/kill HTTP/1.1 + + **Example response**: + + HTTP/1.1 204 OK + + Status Codes: + + - **204** – no error + - **404** – no such container + - **500** – server error + +#### Attach to a container + + `POST /containers/`(*id*)`/attach` +: Attach to the container `id` + + **Example request**: + + POST /containers/16253994b7c4/attach?logs=1&stream=0&stdout=1 HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/vnd.docker.raw-stream + + {{ STREAM }} + + Query Parameters: + +   + + - **logs** – 1/True/true or 0/False/false, return logs. Default + false + - **stream** – 1/True/true or 0/False/false, return stream. + Default false + - **stdin** – 1/True/true or 0/False/false, if stream=true, attach + to stdin. Default false + - **stdout** – 1/True/true or 0/False/false, if logs=true, return + stdout log, if stream=true, attach to stdout. Default false + - **stderr** – 1/True/true or 0/False/false, if logs=true, return + stderr log, if stream=true, attach to stderr. Default false + + Status Codes: + + - **200** – no error + - **400** – bad parameter + - **404** – no such container + - **500** – server error + + **Stream details**: + + When using the TTY setting is enabled in + [`POST /containers/create` +](#post--containers-create "POST /containers/create"), the + stream is the raw data from the process PTY and client’s stdin. When + the TTY is disabled, then the stream is multiplexed to separate + stdout and stderr. + + The format is a **Header** and a **Payload** (frame). + + **HEADER** + + The header will contain the information on which stream write the + stream (stdout or stderr). It also contain the size of the + associated frame encoded on the last 4 bytes (uint32). + + It is encoded on the first 8 bytes like this: + + header := [8]byte{STREAM_TYPE, 0, 0, 0, SIZE1, SIZE2, SIZE3, SIZE4} + + `STREAM_TYPE` can be: + + - 0: stdin (will be writen on stdout) + - 1: stdout + - 2: stderr + + `SIZE1, SIZE2, SIZE3, SIZE4` are the 4 bytes of + the uint32 size encoded as big endian. + + **PAYLOAD** + + The payload is the raw stream. + + **IMPLEMENTATION** + + The simplest way to implement the Attach protocol is the following: + + 1. Read 8 bytes + 2. chose stdout or stderr depending on the first byte + 3. Extract the frame size from the last 4 byets + 4. Read the extracted size and output it on the correct output + 5. Goto 1) + +#### Wait a container + + `POST /containers/`(*id*)`/wait` +: Block until container `id` stops, then returns + the exit code + + **Example request**: + + POST /containers/16253994b7c4/wait HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {"StatusCode":0} + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +#### Remove a container + + `DELETE /containers/`(*id*) +: Remove the container `id` from the filesystem + + **Example request**: + + DELETE /containers/16253994b7c4?v=1 HTTP/1.1 + + **Example response**: + + HTTP/1.1 204 OK + + Query Parameters: + +   + + - **v** – 1/True/true or 0/False/false, Remove the volumes + associated to the container. Default false + + Status Codes: + + - **204** – no error + - **400** – bad parameter + - **404** – no such container + - **500** – server error + +#### Copy files or folders from a container + + `POST /containers/`(*id*)`/copy` +: Copy files or folders of container `id` + + **Example request**: + + POST /containers/4fa6e0f0c678/copy HTTP/1.1 + Content-Type: application/json + + { + "Resource":"test.txt" + } + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/octet-stream + + {{ STREAM }} + + Status Codes: + + - **200** – no error + - **404** – no such container + - **500** – server error + +### 2.2 Images + +#### List Images + + `GET /images/json` +: **Example request**: + + GET /images/json?all=0 HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "RepoTags": [ + "ubuntu:12.04", + "ubuntu:precise", + "ubuntu:latest" + ], + "Id": "8dbd9e392a964056420e5d58ca5cc376ef18e2de93b5cc90e868a1bbc8318c1c", + "Created": 1365714795, + "Size": 131506275, + "VirtualSize": 131506275 + }, + { + "RepoTags": [ + "ubuntu:12.10", + "ubuntu:quantal" + ], + "ParentId": "27cf784147099545", + "Id": "b750fe79269d2ec9a3c593ef05b4332b1d1a02a62b4accb2c21d589ff2f5f2dc", + "Created": 1364102658, + "Size": 24653, + "VirtualSize": 180116135 + } + ] + +#### Create an image + + `POST /images/create` +: Create an image, either by pull it from the registry or by importing + it + + **Example request**: + + POST /images/create?fromImage=base HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {"status":"Pulling..."} + {"status":"Pulling", "progress":"1 B/ 100 B", "progressDetail":{"current":1, "total":100}} + {"error":"Invalid..."} + ... + + When using this endpoint to pull an image from the registry, the + `X-Registry-Auth` header can be used to include + a base64-encoded AuthConfig object. + + Query Parameters: + +   + + - **fromImage** – name of the image to pull + - **fromSrc** – source to import, - means stdin + - **repo** – repository + - **tag** – tag + - **registry** – the registry to pull from + + Request Headers: + +   + + - **X-Registry-Auth** – base64-encoded AuthConfig object + + Status Codes: + + - **200** – no error + - **500** – server error + +#### Insert a file in an image + + `POST /images/`(*name*)`/insert` +: Insert a file from `url` in the image + `name` at `path` + + **Example request**: + + POST /images/test/insert?path=/usr&url=myurl HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {"status":"Inserting..."} + {"status":"Inserting", "progress":"1/? (n/a)", "progressDetail":{"current":1}} + {"error":"Invalid..."} + ... + + Status Codes: + + - **200** – no error + - **500** – server error + +#### Inspect an image + + `GET /images/`(*name*)`/json` +: Return low-level information on the image `name` + + **Example request**: + + GET /images/base/json HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "id":"b750fe79269d2ec9a3c593ef05b4332b1d1a02a62b4accb2c21d589ff2f5f2dc", + "parent":"27cf784147099545", + "created":"2013-03-23T22:24:18.818426-07:00", + "container":"3d67245a8d72ecf13f33dffac9f79dcdf70f75acb84d308770391510e0c23ad0", + "container_config": + { + "Hostname":"", + "User":"", + "Memory":0, + "MemorySwap":0, + "AttachStdin":false, + "AttachStdout":false, + "AttachStderr":false, + "PortSpecs":null, + "Tty":true, + "OpenStdin":true, + "StdinOnce":false, + "Env":null, + "Cmd": ["/bin/bash"] + ,"Dns":null, + "Image":"base", + "Volumes":null, + "VolumesFrom":"", + "WorkingDir":"" + }, + "Size": 6824592 + } + + Status Codes: + + - **200** – no error + - **404** – no such image + - **500** – server error + +#### Get the history of an image + + `GET /images/`(*name*)`/history` +: Return the history of the image `name` + + **Example request**: + + GET /images/base/history HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "Id":"b750fe79269d", + "Created":1364102658, + "CreatedBy":"/bin/bash" + }, + { + "Id":"27cf78414709", + "Created":1364068391, + "CreatedBy":"" + } + ] + + Status Codes: + + - **200** – no error + - **404** – no such image + - **500** – server error + +#### Push an image on the registry + + `POST /images/`(*name*)`/push` +: Push the image `name` on the registry + + **Example request**: + + POST /images/test/push HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {"status":"Pushing..."} + {"status":"Pushing", "progress":"1/? (n/a)", "progressDetail":{"current":1}}} + {"error":"Invalid..."} + ... + + Query Parameters: + +   + + - **registry** – the registry you wan to push, optional + + Request Headers: + +   + + - **X-Registry-Auth** – include a base64-encoded AuthConfig + object. + + Status Codes: + + - **200** – no error + - **404** – no such image + - **500** – server error + +#### Tag an image into a repository + + `POST /images/`(*name*)`/tag` +: Tag the image `name` into a repository + + **Example request**: + + POST /images/test/tag?repo=myrepo&force=0 HTTP/1.1 + + **Example response**: + + HTTP/1.1 201 OK + + Query Parameters: + +   + + - **repo** – The repository to tag in + - **force** – 1/True/true or 0/False/false, default false + + Status Codes: + + - **201** – no error + - **400** – bad parameter + - **404** – no such image + - **409** – conflict + - **500** – server error + +#### Remove an image + + `DELETE /images/`(*name*) +: Remove the image `name` from the filesystem + + **Example request**: + + DELETE /images/test HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-type: application/json + + [ + {"Untagged":"3e2f21a89f"}, + {"Deleted":"3e2f21a89f"}, + {"Deleted":"53b4f83ac9"} + ] + + Status Codes: + + - **200** – no error + - **404** – no such image + - **409** – conflict + - **500** – server error + +#### Search images + + `GET /images/search` +: Search for an image in the docker index. + +> **Note**: +> The response keys have changed from API v1.6 to reflect the JSON +> sent by the registry server to the docker daemon’s request. + + **Example request**: + + GET /images/search?term=sshd HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + [ + { + "description": "", + "is_official": false, + "is_trusted": false, + "name": "wma55/u1210sshd", + "star_count": 0 + }, + { + "description": "", + "is_official": false, + "is_trusted": false, + "name": "jdswinbank/sshd", + "star_count": 0 + }, + { + "description": "", + "is_official": false, + "is_trusted": false, + "name": "vgauthier/sshd", + "star_count": 0 + } + ... + ] + + Query Parameters: + +   + + - **term** – term to search + + Status Codes: + + - **200** – no error + - **500** – server error + +### 2.3 Misc + +#### Build an image from Dockerfile + + `POST /build` +: Build an image from Dockerfile using a POST body. + + **Example request**: + + POST /build HTTP/1.1 + + {{ STREAM }} + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {"stream":"Step 1..."} + {"stream":"..."} + {"error":"Error...", "errorDetail":{"code": 123, "message": "Error..."}} + + The stream must be a tar archive compressed with one of the + following algorithms: identity (no compression), gzip, bzip2, xz. + + The archive must include a file called `Dockerfile` + at its root. It may include any number of other files, + which will be accessible in the build context (See the [*ADD build + command*](../../builder/#dockerbuilder)). + + Query Parameters: + +   + + - **t** – repository name (and optionally a tag) to be applied to + the resulting image in case of success + - **q** – suppress verbose build output + - **nocache** – do not use the cache when building the image + - **rm** – Remove intermediate containers after a successful build + + Request Headers: + +   + + - **Content-type** – should be set to + `"application/tar"`. + - **X-Registry-Config** – base64-encoded ConfigFile object + + Status Codes: + + - **200** – no error + - **500** – server error + +#### Check auth configuration + + `POST /auth` +: Get the default username and email + + **Example request**: + + POST /auth HTTP/1.1 + Content-Type: application/json + + { + "username":"hannibal", + "password:"xxxx", + "email":"hannibal@a-team.com", + "serveraddress":"https://index.docker.io/v1/" + } + + **Example response**: + + HTTP/1.1 200 OK + + Status Codes: + + - **200** – no error + - **204** – no error + - **500** – server error + +#### Display system-wide information + + `GET /info` +: Display system-wide information + + **Example request**: + + GET /info HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "Containers":11, + "Images":16, + "Debug":false, + "NFd": 11, + "NGoroutines":21, + "MemoryLimit":true, + "SwapLimit":false, + "IPv4Forwarding":true + } + + Status Codes: + + - **200** – no error + - **500** – server error + +#### Show the docker version information + + `GET /version` +: Show the docker version information + + **Example request**: + + GET /version HTTP/1.1 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + { + "Version":"0.2.2", + "GitCommit":"5a2a5cc+CHANGES", + "GoVersion":"go1.0.3" + } + + Status Codes: + + - **200** – no error + - **500** – server error + +#### Create a new image from a container’s changes + + `POST /commit` +: Create a new image from a container’s changes + + **Example request**: + + POST /commit?container=44c004db4b17&m=message&repo=myrepo HTTP/1.1 + + **Example response**: + + HTTP/1.1 201 OK + Content-Type: application/vnd.docker.raw-stream + + {"Id":"596069db4bf5"} + + Query Parameters: + +   + + - **container** – source container + - **repo** – repository + - **tag** – tag + - **m** – commit message + - **author** – author (eg. "John Hannibal Smith + \<[hannibal@a-team.com](mailto:hannibal%40a-team.com)\>") + - **run** – config automatically applied when the image is run. + (ex: {"Cmd": ["cat", "/world"], "PortSpecs":["22"]}) + + Status Codes: + + - **201** – no error + - **404** – no such container + - **500** – server error + +#### Monitor Docker’s events + + `GET /events` +: Get events from docker, either in real time via streaming, or via + polling (using since) + + **Example request**: + + GET /events?since=1374067924 + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/json + + {"status":"create","id":"dfdf82bd3881","from":"base:latest","time":1374067924} + {"status":"start","id":"dfdf82bd3881","from":"base:latest","time":1374067924} + {"status":"stop","id":"dfdf82bd3881","from":"base:latest","time":1374067966} + {"status":"destroy","id":"dfdf82bd3881","from":"base:latest","time":1374067970} + + Query Parameters: + +   + + - **since** – timestamp used for polling + + Status Codes: + + - **200** – no error + - **500** – server error + +#### Get a tarball containing all images and tags in a repository + + `GET /images/`(*name*)`/get` +: Get a tarball containing all images and metadata for the repository + specified by `name`. + + **Example request** + + GET /images/ubuntu/get + + **Example response**: + + HTTP/1.1 200 OK + Content-Type: application/x-tar + + Binary data stream + + Status Codes: + + - **200** – no error + - **500** – server error + +#### Load a tarball with a set of images and tags into docker + + `POST /images/load` +: Load a set of images and tags into the docker repository. + + **Example request** + + POST /images/load + + Tarball in body + + **Example response**: + + HTTP/1.1 200 OK + + Status Codes: + + - **200** – no error + - **500** – server error + +## 3. Going further + +### 3.1 Inside ‘docker run’ + +Here are the steps of ‘docker run’ : + +- Create the container + +- If the status code is 404, it means the image doesn’t exists: + : - Try to pull it + - Then retry to create the container + +- Start the container + +- If you are not in detached mode: + : - Attach to the container, using logs=1 (to have stdout and + stderr from the container’s start) and stream=1 + +- If in detached mode or only stdin is attached: + : - Display the container’s id + +### 3.2 Hijacking + +In this version of the API, /attach, uses hijacking to transport stdin, +stdout and stderr on the same socket. This might change in the future. + +### 3.3 CORS Requests + +To enable cross origin requests to the remote api add the flag +"–api-enable-cors" when running docker in daemon mode. + + docker -d -H="192.168.1.9:4243" --api-enable-cors diff --git a/docs/sources/reference/api/docker_remote_api_v1.9.rst b/docs/sources/reference/api/docker_remote_api_v1.9.rst index 27812457bb..4bbffcbd36 100644 --- a/docs/sources/reference/api/docker_remote_api_v1.9.rst +++ b/docs/sources/reference/api/docker_remote_api_v1.9.rst @@ -8,8 +8,6 @@ Docker Remote API v1.9 ====================== -.. contents:: Table of Contents - 1. Brief introduction ===================== diff --git a/docs/sources/reference/api/index_api.md b/docs/sources/reference/api/index_api.md new file mode 100644 index 0000000000..8f98513cf5 --- /dev/null +++ b/docs/sources/reference/api/index_api.md @@ -0,0 +1,525 @@ +page_title: Index API +page_description: API Documentation for Docker Index +page_keywords: API, Docker, index, REST, documentation + +# Docker Index API + +## Introduction + +- This is the REST API for the Docker index +- Authorization is done with basic auth over SSL +- Not all commands require authentication, only those noted as such. + +## Repository + +### Repositories + +### User Repo + + `PUT /v1/repositories/`(*namespace*)`/`(*repo\_name*)`/` +: Create a user repository with the given `namespace` + and `repo_name`. + + **Example Request**: + + PUT /v1/repositories/foo/bar/ HTTP/1.1 + Host: index.docker.io + Accept: application/json + Content-Type: application/json + Authorization: Basic akmklmasadalkm== + X-Docker-Token: true + + [{"id": "9e89cc6f0bc3c38722009fe6857087b486531f9a779a0c17e3ed29dae8f12c4f"}] + + Parameters: + + - **namespace** – the namespace for the repo + - **repo\_name** – the name for the repo + + **Example Response**: + + HTTP/1.1 200 + Vary: Accept + Content-Type: application/json + WWW-Authenticate: Token signature=123abc,repository="foo/bar",access=write + X-Docker-Token: signature=123abc,repository="foo/bar",access=write + X-Docker-Endpoints: registry-1.docker.io [, registry-2.docker.io] + + "" + + Status Codes: + + - **200** – Created + - **400** – Errors (invalid json, missing or invalid fields, etc) + - **401** – Unauthorized + - **403** – Account is not Active + + `DELETE /v1/repositories/`(*namespace*)`/`(*repo\_name*)`/` +: Delete a user repository with the given `namespace` + and `repo_name`. + + **Example Request**: + + DELETE /v1/repositories/foo/bar/ HTTP/1.1 + Host: index.docker.io + Accept: application/json + Content-Type: application/json + Authorization: Basic akmklmasadalkm== + X-Docker-Token: true + + "" + + Parameters: + + - **namespace** – the namespace for the repo + - **repo\_name** – the name for the repo + + **Example Response**: + + HTTP/1.1 202 + Vary: Accept + Content-Type: application/json + WWW-Authenticate: Token signature=123abc,repository="foo/bar",access=delete + X-Docker-Token: signature=123abc,repository="foo/bar",access=delete + X-Docker-Endpoints: registry-1.docker.io [, registry-2.docker.io] + + "" + + Status Codes: + + - **200** – Deleted + - **202** – Accepted + - **400** – Errors (invalid json, missing or invalid fields, etc) + - **401** – Unauthorized + - **403** – Account is not Active + +### Library Repo + + `PUT /v1/repositories/`(*repo\_name*)`/` +: Create a library repository with the given `repo_name` +. This is a restricted feature only available to docker + admins. + + When namespace is missing, it is assumed to be `library` + + + **Example Request**: + + PUT /v1/repositories/foobar/ HTTP/1.1 + Host: index.docker.io + Accept: application/json + Content-Type: application/json + Authorization: Basic akmklmasadalkm== + X-Docker-Token: true + + [{"id": "9e89cc6f0bc3c38722009fe6857087b486531f9a779a0c17e3ed29dae8f12c4f"}] + + Parameters: + + - **repo\_name** – the library name for the repo + + **Example Response**: + + HTTP/1.1 200 + Vary: Accept + Content-Type: application/json + WWW-Authenticate: Token signature=123abc,repository="library/foobar",access=write + X-Docker-Token: signature=123abc,repository="foo/bar",access=write + X-Docker-Endpoints: registry-1.docker.io [, registry-2.docker.io] + + "" + + Status Codes: + + - **200** – Created + - **400** – Errors (invalid json, missing or invalid fields, etc) + - **401** – Unauthorized + - **403** – Account is not Active + + `DELETE /v1/repositories/`(*repo\_name*)`/` +: Delete a library repository with the given `repo_name` +. This is a restricted feature only available to docker + admins. + + When namespace is missing, it is assumed to be `library` + + + **Example Request**: + + DELETE /v1/repositories/foobar/ HTTP/1.1 + Host: index.docker.io + Accept: application/json + Content-Type: application/json + Authorization: Basic akmklmasadalkm== + X-Docker-Token: true + + "" + + Parameters: + + - **repo\_name** – the library name for the repo + + **Example Response**: + + HTTP/1.1 202 + Vary: Accept + Content-Type: application/json + WWW-Authenticate: Token signature=123abc,repository="library/foobar",access=delete + X-Docker-Token: signature=123abc,repository="foo/bar",access=delete + X-Docker-Endpoints: registry-1.docker.io [, registry-2.docker.io] + + "" + + Status Codes: + + - **200** – Deleted + - **202** – Accepted + - **400** – Errors (invalid json, missing or invalid fields, etc) + - **401** – Unauthorized + - **403** – Account is not Active + +### Repository Images + +### User Repo Images + + `PUT /v1/repositories/`(*namespace*)`/`(*repo\_name*)`/images` +: Update the images for a user repo. + + **Example Request**: + + PUT /v1/repositories/foo/bar/images HTTP/1.1 + Host: index.docker.io + Accept: application/json + Content-Type: application/json + Authorization: Basic akmklmasadalkm== + + [{"id": "9e89cc6f0bc3c38722009fe6857087b486531f9a779a0c17e3ed29dae8f12c4f", + "checksum": "b486531f9a779a0c17e3ed29dae8f12c4f9e89cc6f0bc3c38722009fe6857087"}] + + Parameters: + + - **namespace** – the namespace for the repo + - **repo\_name** – the name for the repo + + **Example Response**: + + HTTP/1.1 204 + Vary: Accept + Content-Type: application/json + + "" + + Status Codes: + + - **204** – Created + - **400** – Errors (invalid json, missing or invalid fields, etc) + - **401** – Unauthorized + - **403** – Account is not Active or permission denied + + `GET /v1/repositories/`(*namespace*)`/`(*repo\_name*)`/images` +: get the images for a user repo. + + **Example Request**: + + GET /v1/repositories/foo/bar/images HTTP/1.1 + Host: index.docker.io + Accept: application/json + + Parameters: + + - **namespace** – the namespace for the repo + - **repo\_name** – the name for the repo + + **Example Response**: + + HTTP/1.1 200 + Vary: Accept + Content-Type: application/json + + [{"id": "9e89cc6f0bc3c38722009fe6857087b486531f9a779a0c17e3ed29dae8f12c4f", + "checksum": "b486531f9a779a0c17e3ed29dae8f12c4f9e89cc6f0bc3c38722009fe6857087"}, + {"id": "ertwetewtwe38722009fe6857087b486531f9a779a0c1dfddgfgsdgdsgds", + "checksum": "34t23f23fc17e3ed29dae8f12c4f9e89cc6f0bsdfgfsdgdsgdsgerwgew"}] + + Status Codes: + + - **200** – OK + - **404** – Not found + +### Library Repo Images + + `PUT /v1/repositories/`(*repo\_name*)`/images` +: Update the images for a library repo. + + **Example Request**: + + PUT /v1/repositories/foobar/images HTTP/1.1 + Host: index.docker.io + Accept: application/json + Content-Type: application/json + Authorization: Basic akmklmasadalkm== + + [{"id": "9e89cc6f0bc3c38722009fe6857087b486531f9a779a0c17e3ed29dae8f12c4f", + "checksum": "b486531f9a779a0c17e3ed29dae8f12c4f9e89cc6f0bc3c38722009fe6857087"}] + + Parameters: + + - **repo\_name** – the library name for the repo + + **Example Response**: + + HTTP/1.1 204 + Vary: Accept + Content-Type: application/json + + "" + + Status Codes: + + - **204** – Created + - **400** – Errors (invalid json, missing or invalid fields, etc) + - **401** – Unauthorized + - **403** – Account is not Active or permission denied + + `GET /v1/repositories/`(*repo\_name*)`/images` +: get the images for a library repo. + + **Example Request**: + + GET /v1/repositories/foobar/images HTTP/1.1 + Host: index.docker.io + Accept: application/json + + Parameters: + + - **repo\_name** – the library name for the repo + + **Example Response**: + + HTTP/1.1 200 + Vary: Accept + Content-Type: application/json + + [{"id": "9e89cc6f0bc3c38722009fe6857087b486531f9a779a0c17e3ed29dae8f12c4f", + "checksum": "b486531f9a779a0c17e3ed29dae8f12c4f9e89cc6f0bc3c38722009fe6857087"}, + {"id": "ertwetewtwe38722009fe6857087b486531f9a779a0c1dfddgfgsdgdsgds", + "checksum": "34t23f23fc17e3ed29dae8f12c4f9e89cc6f0bsdfgfsdgdsgdsgerwgew"}] + + Status Codes: + + - **200** – OK + - **404** – Not found + +### Repository Authorization + +### Library Repo + + `PUT /v1/repositories/`(*repo\_name*)`/auth` +: authorize a token for a library repo + + **Example Request**: + + PUT /v1/repositories/foobar/auth HTTP/1.1 + Host: index.docker.io + Accept: application/json + Authorization: Token signature=123abc,repository="library/foobar",access=write + + Parameters: + + - **repo\_name** – the library name for the repo + + **Example Response**: + + HTTP/1.1 200 + Vary: Accept + Content-Type: application/json + + "OK" + + Status Codes: + + - **200** – OK + - **403** – Permission denied + - **404** – Not found + +### User Repo + + `PUT /v1/repositories/`(*namespace*)`/`(*repo\_name*)`/auth` +: authorize a token for a user repo + + **Example Request**: + + PUT /v1/repositories/foo/bar/auth HTTP/1.1 + Host: index.docker.io + Accept: application/json + Authorization: Token signature=123abc,repository="foo/bar",access=write + + Parameters: + + - **namespace** – the namespace for the repo + - **repo\_name** – the name for the repo + + **Example Response**: + + HTTP/1.1 200 + Vary: Accept + Content-Type: application/json + + "OK" + + Status Codes: + + - **200** – OK + - **403** – Permission denied + - **404** – Not found + +### Users + +### User Login + + `GET /v1/users` +: If you want to check your login, you can try this endpoint + + **Example Request**: + + GET /v1/users HTTP/1.1 + Host: index.docker.io + Accept: application/json + Authorization: Basic akmklmasadalkm== + + **Example Response**: + + HTTP/1.1 200 OK + Vary: Accept + Content-Type: application/json + + OK + + Status Codes: + + - **200** – no error + - **401** – Unauthorized + - **403** – Account is not Active + +### User Register + + `POST /v1/users` +: Registering a new account. + + **Example request**: + + POST /v1/users HTTP/1.1 + Host: index.docker.io + Accept: application/json + Content-Type: application/json + + {"email": "sam@dotcloud.com", + "password": "toto42", + "username": "foobar"} + + Json Parameters: + +   + + - **email** – valid email address, that needs to be confirmed + - **username** – min 4 character, max 30 characters, must match + the regular expression [a-z0-9\_]. + - **password** – min 5 characters + + **Example Response**: + + HTTP/1.1 201 OK + Vary: Accept + Content-Type: application/json + + "User Created" + + Status Codes: + + - **201** – User Created + - **400** – Errors (invalid json, missing or invalid fields, etc) + +### Update User + + `PUT /v1/users/`(*username*)`/` +: Change a password or email address for given user. If you pass in an + email, it will add it to your account, it will not remove the old + one. Passwords will be updated. + + It is up to the client to verify that that password that is sent is + the one that they want. Common approach is to have them type it + twice. + + **Example Request**: + + PUT /v1/users/fakeuser/ HTTP/1.1 + Host: index.docker.io + Accept: application/json + Content-Type: application/json + Authorization: Basic akmklmasadalkm== + + {"email": "sam@dotcloud.com", + "password": "toto42"} + + Parameters: + + - **username** – username for the person you want to update + + **Example Response**: + + HTTP/1.1 204 + Vary: Accept + Content-Type: application/json + + "" + + Status Codes: + + - **204** – User Updated + - **400** – Errors (invalid json, missing or invalid fields, etc) + - **401** – Unauthorized + - **403** – Account is not Active + - **404** – User not found + +## Search + +If you need to search the index, this is the endpoint you would use. + +### Search + + `GET /v1/search` +: Search the Index given a search term. It accepts + [GET](http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html#sec9.3) + only. + + **Example request**: + + GET /v1/search?q=search_term HTTP/1.1 + Host: example.com + Accept: application/json + + **Example response**: + + HTTP/1.1 200 OK + Vary: Accept + Content-Type: application/json + + {"query":"search_term", + "num_results": 3, + "results" : [ + {"name": "ubuntu", "description": "An ubuntu image..."}, + {"name": "centos", "description": "A centos image..."}, + {"name": "fedora", "description": "A fedora image..."} + ] + } + + Query Parameters: + + - **q** – what you want to search for + + Status Codes: + + - **200** – no error + - **500** – server error + + diff --git a/docs/sources/reference/api/registry_api.md b/docs/sources/reference/api/registry_api.md new file mode 100644 index 0000000000..09035515f5 --- /dev/null +++ b/docs/sources/reference/api/registry_api.md @@ -0,0 +1,501 @@ +page_title: Registry API +page_description: API Documentation for Docker Registry +page_keywords: API, Docker, index, registry, REST, documentation + +# Docker Registry API + +## Introduction + +- This is the REST API for the Docker Registry +- It stores the images and the graph for a set of repositories +- It does not have user accounts data +- It has no notion of user accounts or authorization +- It delegates authentication and authorization to the Index Auth + service using tokens +- It supports different storage backends (S3, cloud files, local FS) +- It doesn’t have a local database +- It will be open-sourced at some point + +We expect that there will be multiple registries out there. To help to +grasp the context, here are some examples of registries: + +- **sponsor registry**: such a registry is provided by a third-party + hosting infrastructure as a convenience for their customers and the + docker community as a whole. Its costs are supported by the third + party, but the management and operation of the registry are + supported by dotCloud. It features read/write access, and delegates + authentication and authorization to the Index. +- **mirror registry**: such a registry is provided by a third-party + hosting infrastructure but is targeted at their customers only. Some + mechanism (unspecified to date) ensures that public images are + pulled from a sponsor registry to the mirror registry, to make sure + that the customers of the third-party provider can “docker pull” + those images locally. +- **vendor registry**: such a registry is provided by a software + vendor, who wants to distribute docker images. It would be operated + and managed by the vendor. Only users authorized by the vendor would + be able to get write access. Some images would be public (accessible + for anyone), others private (accessible only for authorized users). + Authentication and authorization would be delegated to the Index. + The goal of vendor registries is to let someone do “docker pull + basho/riak1.3” and automatically push from the vendor registry + (instead of a sponsor registry); i.e. get all the convenience of a + sponsor registry, while retaining control on the asset distribution. +- **private registry**: such a registry is located behind a firewall, + or protected by an additional security layer (HTTP authorization, + SSL client-side certificates, IP address authorization...). The + registry is operated by a private entity, outside of dotCloud’s + control. It can optionally delegate additional authorization to the + Index, but it is not mandatory. + +> **Note**: +> Mirror registries and private registries which do not use the Index +> don’t even need to run the registry code. They can be implemented by any +> kind of transport implementing HTTP GET and PUT. Read-only registries +> can be powered by a simple static HTTP server. + +> **Note**: +> The latter implies that while HTTP is the protocol of choice for a registry, +> multiple schemes are possible (and in some cases, trivial): +> +> - HTTP with GET (and PUT for read-write registries); +> - local mount point; +> - remote docker addressed through SSH. + +The latter would only require two new commands in docker, e.g. +`registryget` and `registryput`, +wrapping access to the local filesystem (and optionally doing +consistency checks). Authentication and authorization are then delegated +to SSH (e.g. with public keys). + +## Endpoints + +### Images + +### Layer + + `GET /v1/images/`(*image\_id*)`/layer` +: get image layer for a given `image_id` + + **Example Request**: + + GET /v1/images/088b4505aa3adc3d35e79c031fa126b403200f02f51920fbd9b7c503e87c7a2c/layer HTTP/1.1 + Host: registry-1.docker.io + Accept: application/json + Content-Type: application/json + Authorization: Token signature=123abc,repository="foo/bar",access=read + + Parameters: + + - **image\_id** – the id for the layer you want to get + + **Example Response**: + + HTTP/1.1 200 + Vary: Accept + X-Docker-Registry-Version: 0.6.0 + Cookie: (Cookie provided by the Registry) + + {layer binary data stream} + + Status Codes: + + - **200** – OK + - **401** – Requires authorization + - **404** – Image not found + + `PUT /v1/images/`(*image\_id*)`/layer` +: put image layer for a given `image_id` + + **Example Request**: + + PUT /v1/images/088b4505aa3adc3d35e79c031fa126b403200f02f51920fbd9b7c503e87c7a2c/layer HTTP/1.1 + Host: registry-1.docker.io + Transfer-Encoding: chunked + Authorization: Token signature=123abc,repository="foo/bar",access=write + + {layer binary data stream} + + Parameters: + + - **image\_id** – the id for the layer you want to get + + **Example Response**: + + HTTP/1.1 200 + Vary: Accept + Content-Type: application/json + X-Docker-Registry-Version: 0.6.0 + + "" + + Status Codes: + + - **200** – OK + - **401** – Requires authorization + - **404** – Image not found + +### Image + + `PUT /v1/images/`(*image\_id*)`/json` +: put image for a given `image_id` + + **Example Request**: + + PUT /v1/images/088b4505aa3adc3d35e79c031fa126b403200f02f51920fbd9b7c503e87c7a2c/json HTTP/1.1 + Host: registry-1.docker.io + Accept: application/json + Content-Type: application/json + Cookie: (Cookie provided by the Registry) + + { + id: "088b4505aa3adc3d35e79c031fa126b403200f02f51920fbd9b7c503e87c7a2c", + parent: "aeee6396d62273d180a49c96c62e45438d87c7da4a5cf5d2be6bee4e21bc226f", + created: "2013-04-30T17:46:10.843673+03:00", + container: "8305672a76cc5e3d168f97221106ced35a76ec7ddbb03209b0f0d96bf74f6ef7", + container_config: { + Hostname: "host-test", + User: "", + Memory: 0, + MemorySwap: 0, + AttachStdin: false, + AttachStdout: false, + AttachStderr: false, + PortSpecs: null, + Tty: false, + OpenStdin: false, + StdinOnce: false, + Env: null, + Cmd: [ + "/bin/bash", + "-c", + "apt-get -q -yy -f install libevent-dev" + ], + Dns: null, + Image: "imagename/blah", + Volumes: { }, + VolumesFrom: "" + }, + docker_version: "0.1.7" + } + + Parameters: + + - **image\_id** – the id for the layer you want to get + + **Example Response**: + + HTTP/1.1 200 + Vary: Accept + Content-Type: application/json + X-Docker-Registry-Version: 0.6.0 + + "" + + Status Codes: + + - **200** – OK + - **401** – Requires authorization + + `GET /v1/images/`(*image\_id*)`/json` +: get image for a given `image_id` + + **Example Request**: + + GET /v1/images/088b4505aa3adc3d35e79c031fa126b403200f02f51920fbd9b7c503e87c7a2c/json HTTP/1.1 + Host: registry-1.docker.io + Accept: application/json + Content-Type: application/json + Cookie: (Cookie provided by the Registry) + + Parameters: + + - **image\_id** – the id for the layer you want to get + + **Example Response**: + + HTTP/1.1 200 + Vary: Accept + Content-Type: application/json + X-Docker-Registry-Version: 0.6.0 + X-Docker-Size: 456789 + X-Docker-Checksum: b486531f9a779a0c17e3ed29dae8f12c4f9e89cc6f0bc3c38722009fe6857087 + + { + id: "088b4505aa3adc3d35e79c031fa126b403200f02f51920fbd9b7c503e87c7a2c", + parent: "aeee6396d62273d180a49c96c62e45438d87c7da4a5cf5d2be6bee4e21bc226f", + created: "2013-04-30T17:46:10.843673+03:00", + container: "8305672a76cc5e3d168f97221106ced35a76ec7ddbb03209b0f0d96bf74f6ef7", + container_config: { + Hostname: "host-test", + User: "", + Memory: 0, + MemorySwap: 0, + AttachStdin: false, + AttachStdout: false, + AttachStderr: false, + PortSpecs: null, + Tty: false, + OpenStdin: false, + StdinOnce: false, + Env: null, + Cmd: [ + "/bin/bash", + "-c", + "apt-get -q -yy -f install libevent-dev" + ], + Dns: null, + Image: "imagename/blah", + Volumes: { }, + VolumesFrom: "" + }, + docker_version: "0.1.7" + } + + Status Codes: + + - **200** – OK + - **401** – Requires authorization + - **404** – Image not found + +### Ancestry + + `GET /v1/images/`(*image\_id*)`/ancestry` +: get ancestry for an image given an `image_id` + + **Example Request**: + + GET /v1/images/088b4505aa3adc3d35e79c031fa126b403200f02f51920fbd9b7c503e87c7a2c/ancestry HTTP/1.1 + Host: registry-1.docker.io + Accept: application/json + Content-Type: application/json + Cookie: (Cookie provided by the Registry) + + Parameters: + + - **image\_id** – the id for the layer you want to get + + **Example Response**: + + HTTP/1.1 200 + Vary: Accept + Content-Type: application/json + X-Docker-Registry-Version: 0.6.0 + + ["088b4502f51920fbd9b7c503e87c7a2c05aa3adc3d35e79c031fa126b403200f", + "aeee63968d87c7da4a5cf5d2be6bee4e21bc226fd62273d180a49c96c62e4543", + "bfa4c5326bc764280b0863b46a4b20d940bc1897ef9c1dfec060604bdc383280", + "6ab5893c6927c15a15665191f2c6cf751f5056d8b95ceee32e43c5e8a3648544"] + + Status Codes: + + - **200** – OK + - **401** – Requires authorization + - **404** – Image not found + +### Tags + + `GET /v1/repositories/`(*namespace*)`/`(*repository*)`/tags` +: get all of the tags for the given repo. + + **Example Request**: + + GET /v1/repositories/foo/bar/tags HTTP/1.1 + Host: registry-1.docker.io + Accept: application/json + Content-Type: application/json + X-Docker-Registry-Version: 0.6.0 + Cookie: (Cookie provided by the Registry) + + Parameters: + + - **namespace** – namespace for the repo + - **repository** – name for the repo + + **Example Response**: + + HTTP/1.1 200 + Vary: Accept + Content-Type: application/json + X-Docker-Registry-Version: 0.6.0 + + { + "latest": "9e89cc6f0bc3c38722009fe6857087b486531f9a779a0c17e3ed29dae8f12c4f", + "0.1.1": "b486531f9a779a0c17e3ed29dae8f12c4f9e89cc6f0bc3c38722009fe6857087" + } + + Status Codes: + + - **200** – OK + - **401** – Requires authorization + - **404** – Repository not found + + `GET /v1/repositories/`(*namespace*)`/`(*repository*)`/tags/`(*tag*) +: get a tag for the given repo. + + **Example Request**: + + GET /v1/repositories/foo/bar/tags/latest HTTP/1.1 + Host: registry-1.docker.io + Accept: application/json + Content-Type: application/json + X-Docker-Registry-Version: 0.6.0 + Cookie: (Cookie provided by the Registry) + + Parameters: + + - **namespace** – namespace for the repo + - **repository** – name for the repo + - **tag** – name of tag you want to get + + **Example Response**: + + HTTP/1.1 200 + Vary: Accept + Content-Type: application/json + X-Docker-Registry-Version: 0.6.0 + + "9e89cc6f0bc3c38722009fe6857087b486531f9a779a0c17e3ed29dae8f12c4f" + + Status Codes: + + - **200** – OK + - **401** – Requires authorization + - **404** – Tag not found + + `DELETE /v1/repositories/`(*namespace*)`/`(*repository*)`/tags/`(*tag*) +: delete the tag for the repo + + **Example Request**: + + DELETE /v1/repositories/foo/bar/tags/latest HTTP/1.1 + Host: registry-1.docker.io + Accept: application/json + Content-Type: application/json + Cookie: (Cookie provided by the Registry) + + Parameters: + + - **namespace** – namespace for the repo + - **repository** – name for the repo + - **tag** – name of tag you want to delete + + **Example Response**: + + HTTP/1.1 200 + Vary: Accept + Content-Type: application/json + X-Docker-Registry-Version: 0.6.0 + + "" + + Status Codes: + + - **200** – OK + - **401** – Requires authorization + - **404** – Tag not found + + `PUT /v1/repositories/`(*namespace*)`/`(*repository*)`/tags/`(*tag*) +: put a tag for the given repo. + + **Example Request**: + + PUT /v1/repositories/foo/bar/tags/latest HTTP/1.1 + Host: registry-1.docker.io + Accept: application/json + Content-Type: application/json + Cookie: (Cookie provided by the Registry) + + "9e89cc6f0bc3c38722009fe6857087b486531f9a779a0c17e3ed29dae8f12c4f" + + Parameters: + + - **namespace** – namespace for the repo + - **repository** – name for the repo + - **tag** – name of tag you want to add + + **Example Response**: + + HTTP/1.1 200 + Vary: Accept + Content-Type: application/json + X-Docker-Registry-Version: 0.6.0 + + "" + + Status Codes: + + - **200** – OK + - **400** – Invalid data + - **401** – Requires authorization + - **404** – Image not found + +### Repositories + + `DELETE /v1/repositories/`(*namespace*)`/`(*repository*)`/` +: delete a repository + + **Example Request**: + + DELETE /v1/repositories/foo/bar/ HTTP/1.1 + Host: registry-1.docker.io + Accept: application/json + Content-Type: application/json + Cookie: (Cookie provided by the Registry) + + "" + + Parameters: + + - **namespace** – namespace for the repo + - **repository** – name for the repo + + **Example Response**: + + HTTP/1.1 200 + Vary: Accept + Content-Type: application/json + X-Docker-Registry-Version: 0.6.0 + + "" + + Status Codes: + + - **200** – OK + - **401** – Requires authorization + - **404** – Repository not found + +### Status + + `GET /v1/_ping` +: Check status of the registry. This endpoint is also used to + determine if the registry supports SSL. + + **Example Request**: + + GET /v1/_ping HTTP/1.1 + Host: registry-1.docker.io + Accept: application/json + Content-Type: application/json + + "" + + **Example Response**: + + HTTP/1.1 200 + Vary: Accept + Content-Type: application/json + X-Docker-Registry-Version: 0.6.0 + + "" + + Status Codes: + + - **200** – OK + +## Authorization + +This is where we describe the authorization process, including the +tokens and cookies. + +TODO: add more info. diff --git a/docs/sources/reference/api/registry_index_spec.md b/docs/sources/reference/api/registry_index_spec.md new file mode 100644 index 0000000000..53006cf0b5 --- /dev/null +++ b/docs/sources/reference/api/registry_index_spec.md @@ -0,0 +1,687 @@ +page_title: Registry Documentation +page_description: Documentation for docker Registry and Registry API +page_keywords: docker, registry, api, index + +# Registry & Index Spec + +## The 3 roles + +### Index + +The Index is responsible for centralizing information about: + +- User accounts +- Checksums of the images +- Public namespaces + +The Index has different components: + +- Web UI +- Meta-data store (comments, stars, list public repositories) +- Authentication service +- Tokenization + +The index is authoritative for those information. + +We expect that there will be only one instance of the index, run and +managed by Docker Inc. + +### Registry + +- It stores the images and the graph for a set of repositories +- It does not have user accounts data +- It has no notion of user accounts or authorization +- It delegates authentication and authorization to the Index Auth + service using tokens +- It supports different storage backends (S3, cloud files, local FS) +- It doesn’t have a local database +- [Source Code](https://github.com/dotcloud/docker-registry) + +We expect that there will be multiple registries out there. To help to +grasp the context, here are some examples of registries: + +- **sponsor registry**: such a registry is provided by a third-party + hosting infrastructure as a convenience for their customers and the + docker community as a whole. Its costs are supported by the third + party, but the management and operation of the registry are + supported by dotCloud. It features read/write access, and delegates + authentication and authorization to the Index. +- **mirror registry**: such a registry is provided by a third-party + hosting infrastructure but is targeted at their customers only. Some + mechanism (unspecified to date) ensures that public images are + pulled from a sponsor registry to the mirror registry, to make sure + that the customers of the third-party provider can “docker pull” + those images locally. +- **vendor registry**: such a registry is provided by a software + vendor, who wants to distribute docker images. It would be operated + and managed by the vendor. Only users authorized by the vendor would + be able to get write access. Some images would be public (accessible + for anyone), others private (accessible only for authorized users). + Authentication and authorization would be delegated to the Index. + The goal of vendor registries is to let someone do “docker pull + basho/riak1.3” and automatically push from the vendor registry + (instead of a sponsor registry); i.e. get all the convenience of a + sponsor registry, while retaining control on the asset distribution. +- **private registry**: such a registry is located behind a firewall, + or protected by an additional security layer (HTTP authorization, + SSL client-side certificates, IP address authorization...). The + registry is operated by a private entity, outside of dotCloud’s + control. It can optionally delegate additional authorization to the + Index, but it is not mandatory. + +> **Note:** The latter implies that while HTTP is the protocol +> of choice for a registry, multiple schemes are possible (and +> in some cases, trivial): +> +> - HTTP with GET (and PUT for read-write registries); +> - local mount point; +> - remote docker addressed through SSH. + +The latter would only require two new commands in docker, e.g. +`registryget` and `registryput`, +wrapping access to the local filesystem (and optionally doing +consistency checks). Authentication and authorization are then delegated +to SSH (e.g. with public keys). + +### Docker + +On top of being a runtime for LXC, Docker is the Registry client. It +supports: + +- Push / Pull on the registry +- Client authentication on the Index + +## Workflow + +### Pull + +![](../../../_images/docker_pull_chart.png) + +1. Contact the Index to know where I should download “samalba/busybox” +2. Index replies: a. `samalba/busybox` is on + Registry A b. here are the checksums for `samalba/busybox` + (for all layers) c. token +3. Contact Registry A to receive the layers for + `samalba/busybox` (all of them to the base + image). Registry A is authoritative for “samalba/busybox” but keeps + a copy of all inherited layers and serve them all from the same + location. +4. registry contacts index to verify if token/user is allowed to + download images +5. Index returns true/false lettings registry know if it should proceed + or error out +6. Get the payload for all layers + +It’s possible to run: + + docker pull https:///repositories/samalba/busybox + +In this case, Docker bypasses the Index. However the security is not +guaranteed (in case Registry A is corrupted) because there won’t be any +checksum checks. + +Currently registry redirects to s3 urls for downloads, going forward all +downloads need to be streamed through the registry. The Registry will +then abstract the calls to S3 by a top-level class which implements +sub-classes for S3 and local storage. + +Token is only returned when the `X-Docker-Token` +header is sent with request. + +Basic Auth is required to pull private repos. Basic auth isn’t required +for pulling public repos, but if one is provided, it needs to be valid +and for an active account. + +#### API (pulling repository foo/bar): + +1. (Docker -\> Index) GET /v1/repositories/foo/bar/images + : **Headers**: + : Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== + X-Docker-Token: true + + **Action**: + : (looking up the foo/bar in db and gets images and checksums + for that repo (all if no tag is specified, if tag, only + checksums for those tags) see part 4.4.1) + +2. (Index -\> Docker) HTTP 200 OK + + > **Headers**: + > : - Authorization: Token + > signature=123abc,repository=”foo/bar”,access=write + > - X-Docker-Endpoints: registry.docker.io [, + > registry2.docker.io] + > + > **Body**: + > : Jsonified checksums (see part 4.4.1) + > +3. (Docker -\> Registry) GET /v1/repositories/foo/bar/tags/latest + : **Headers**: + : Authorization: Token + signature=123abc,repository=”foo/bar”,access=write + +4. (Registry -\> Index) GET /v1/repositories/foo/bar/images + + > **Headers**: + > : Authorization: Token + > signature=123abc,repository=”foo/bar”,access=read + > + > **Body**: + > : \ + > + > **Action**: + > : ( Lookup token see if they have access to pull.) + > + > If good: + > : HTTP 200 OK Index will invalidate the token + > + > If bad: + > : HTTP 401 Unauthorized + > +5. (Docker -\> Registry) GET /v1/images/928374982374/ancestry + : **Action**: + : (for each image id returned in the registry, fetch /json + + /layer) + +> **Note**: +> If someone makes a second request, then we will always give a new token, +> never reuse tokens. + +### Push + +![](../../../_images/docker_push_chart.png) + +1. Contact the index to allocate the repository name “samalba/busybox” + (authentication required with user credentials) +2. If authentication works and namespace available, “samalba/busybox” + is allocated and a temporary token is returned (namespace is marked + as initialized in index) +3. Push the image on the registry (along with the token) +4. Registry A contacts the Index to verify the token (token must + corresponds to the repository name) +5. Index validates the token. Registry A starts reading the stream + pushed by docker and store the repository (with its images) +6. docker contacts the index to give checksums for upload images + +> **Note:** +> **It’s possible not to use the Index at all!** In this case, a deployed +> version of the Registry is deployed to store and serve images. Those +> images are not authenticated and the security is not guaranteed. + +> **Note:** +> **Index can be replaced!** For a private Registry deployed, a custom +> Index can be used to serve and validate token according to different +> policies. + +Docker computes the checksums and submit them to the Index at the end of +the push. When a repository name does not have checksums on the Index, +it means that the push is in progress (since checksums are submitted at +the end). + +#### API (pushing repos foo/bar): + +1. (Docker -\> Index) PUT /v1/repositories/foo/bar/ + : **Headers**: + : Authorization: Basic sdkjfskdjfhsdkjfh== X-Docker-Token: + true + + **Action**:: + : - in index, we allocated a new repository, and set to + initialized + + **Body**:: + : (The body contains the list of images that are going to be + pushed, with empty checksums. The checksums will be set at + the end of the push): + + [{“id”: “9e89cc6f0bc3c38722009fe6857087b486531f9a779a0c17e3ed29dae8f12c4f”}] + +2. (Index -\> Docker) 200 Created + : **Headers**: + : - WWW-Authenticate: Token + signature=123abc,repository=”foo/bar”,access=write + - X-Docker-Endpoints: registry.docker.io [, + registry2.docker.io] + +3. (Docker -\> Registry) PUT /v1/images/98765432\_parent/json + : **Headers**: + : Authorization: Token + signature=123abc,repository=”foo/bar”,access=write + +4. (Registry-\>Index) GET /v1/repositories/foo/bar/images + : **Headers**: + : Authorization: Token + signature=123abc,repository=”foo/bar”,access=write + + **Action**:: + : - Index: + : will invalidate the token. + + - Registry: + : grants a session (if token is approved) and fetches + the images id + +5. (Docker -\> Registry) PUT /v1/images/98765432\_parent/json + : **Headers**:: + : - Authorization: Token + signature=123abc,repository=”foo/bar”,access=write + - Cookie: (Cookie provided by the Registry) + +6. (Docker -\> Registry) PUT /v1/images/98765432/json + : **Headers**: + : Cookie: (Cookie provided by the Registry) + +7. (Docker -\> Registry) PUT /v1/images/98765432\_parent/layer + : **Headers**: + : Cookie: (Cookie provided by the Registry) + +8. (Docker -\> Registry) PUT /v1/images/98765432/layer + : **Headers**: + : X-Docker-Checksum: sha256:436745873465fdjkhdfjkgh + +9. (Docker -\> Registry) PUT /v1/repositories/foo/bar/tags/latest + : **Headers**: + : Cookie: (Cookie provided by the Registry) + + **Body**: + : “98765432” + +10. (Docker -\> Index) PUT /v1/repositories/foo/bar/images + + **Headers**: + : Authorization: Basic 123oislifjsldfj== X-Docker-Endpoints: + registry1.docker.io (no validation on this right now) + + **Body**: + : (The image, id’s, tags and checksums) + + [{“id”: + “9e89cc6f0bc3c38722009fe6857087b486531f9a779a0c17e3ed29dae8f12c4f”, + “checksum”: + “b486531f9a779a0c17e3ed29dae8f12c4f9e89cc6f0bc3c38722009fe6857087”}] + + **Return** HTTP 204 + +> **Note:** If push fails and they need to start again, what happens in the index, +> there will already be a record for the namespace/name, but it will be +> initialized. Should we allow it, or mark as name already used? One edge +> case could be if someone pushes the same thing at the same time with two +> different shells. + +If it’s a retry on the Registry, Docker has a cookie (provided by the +registry after token validation). So the Index won’t have to provide a +new token. + +### Delete + +If you need to delete something from the index or registry, we need a +nice clean way to do that. Here is the workflow. + +1. Docker contacts the index to request a delete of a repository + `samalba/busybox` (authentication required with + user credentials) +2. If authentication works and repository is valid, + `samalba/busybox` is marked as deleted and a + temporary token is returned +3. Send a delete request to the registry for the repository (along with + the token) +4. Registry A contacts the Index to verify the token (token must + corresponds to the repository name) +5. Index validates the token. Registry A deletes the repository and + everything associated to it. +6. docker contacts the index to let it know it was removed from the + registry, the index removes all records from the database. + +> **Note**: +> The Docker client should present an "Are you sure?" prompt to confirm +> the deletion before starting the process. Once it starts it can’t be +> undone. + +#### API (deleting repository foo/bar): + +1. (Docker -\> Index) DELETE /v1/repositories/foo/bar/ + : **Headers**: + : Authorization: Basic sdkjfskdjfhsdkjfh== X-Docker-Token: + true + + **Action**:: + : - in index, we make sure it is a valid repository, and set + to deleted (logically) + + **Body**:: + : Empty + +2. (Index -\> Docker) 202 Accepted + : **Headers**: + : - WWW-Authenticate: Token + signature=123abc,repository=”foo/bar”,access=delete + - X-Docker-Endpoints: registry.docker.io [, + registry2.docker.io] \# list of endpoints where this + repo lives. + +3. (Docker -\> Registry) DELETE /v1/repositories/foo/bar/ + : **Headers**: + : Authorization: Token + signature=123abc,repository=”foo/bar”,access=delete + +4. (Registry-\>Index) PUT /v1/repositories/foo/bar/auth + : **Headers**: + : Authorization: Token + signature=123abc,repository=”foo/bar”,access=delete + + **Action**:: + : - Index: + : will invalidate the token. + + - Registry: + : deletes the repository (if token is approved) + +5. (Registry -\> Docker) 200 OK + : 200 If success 403 if forbidden 400 if bad request 404 if + repository isn’t found + +6. (Docker -\> Index) DELETE /v1/repositories/foo/bar/ + + > **Headers**: + > : Authorization: Basic 123oislifjsldfj== X-Docker-Endpoints: + > registry-1.docker.io (no validation on this right now) + > + > **Body**: + > : Empty + > + > **Return** HTTP 200 + +## How to use the Registry in standalone mode + +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/\/repositories/\/ + - team/projectname -\> + https://registry.docker.io/team/\/repositories/\/ + +- Authenticate a user as a repos owner (for a central referenced + repository) + +### Without an Index + +Using the Registry without the Index can be useful to store the images +on a private network without having to rely on an external entity +controlled by Docker Inc. + +In this case, the registry will be launched in a special mode +(–standalone? –no-index?). In this mode, the only thing which changes is +that Registry will never contact the Index to verify a token. It will be +the Registry owner responsibility to authenticate the user who pushes +(or even pulls) an image using any mechanism (HTTP auth, IP based, +etc...). + +In this scenario, the Registry is responsible for the security in case +of data corruption since the checksums are not delivered by a trusted +entity. + +As hinted previously, a standalone registry can also be implemented by +any HTTP server handling GET/PUT requests (or even only GET requests if +no write access is necessary). + +### With an Index + +The Index data needed by the Registry are simple: + +- Serve the checksums +- Provide and authorize a Token + +In the scenario of a Registry running on a private network with the need +of centralizing and authorizing, it’s easy to use a custom Index. + +The only challenge will be to tell Docker to contact (and trust) this +custom Index. Docker will be configurable at some point to use a +specific Index, it’ll be the private entity responsibility (basically +the organization who uses Docker in a private environment) to maintain +the Index and the Docker’s configuration among its consumers. + +## The API + +The first version of the api is available here: +[https://github.com/jpetazzo/docker/blob/acd51ecea8f5d3c02b00a08176171c59442df8b3/docs/images-repositories-push-pull.md](https://github.com/jpetazzo/docker/blob/acd51ecea8f5d3c02b00a08176171c59442df8b3/docs/images-repositories-push-pull.md) + +### Images + +The format returned in the images is not defined here (for layer and +JSON), basically because Registry stores exactly the same kind of +information as Docker uses to manage them. + +The format of ancestry is a line-separated list of image ids, in age +order, i.e. the image’s parent is on the last line, the parent of the +parent on the next-to-last line, etc.; if the image has no parent, the +file is empty. + + GET /v1/images//layer + PUT /v1/images//layer + GET /v1/images//json + PUT /v1/images//json + GET /v1/images//ancestry + PUT /v1/images//ancestry + +### Users + +### Create a user (Index) + +POST /v1/users + +**Body**: +: {"email": "[sam@dotcloud.com](mailto:sam%40dotcloud.com)", + "password": "toto42", "username": "foobar"’} +**Validation**: +: - **username**: min 4 character, max 30 characters, must match the + regular expression [a-z0-9\_]. + - **password**: min 5 characters + +**Valid**: return HTTP 200 + +Errors: HTTP 400 (we should create error codes for possible errors) - +invalid json - missing field - wrong format (username, password, email, +etc) - forbidden name - name already exists + +> **Note**: +> A user account will be valid only if the email has been validated (a +> validation link is sent to the email address). + +### Update a user (Index) + +PUT /v1/users/\ + +**Body**: +: {"password": "toto"} + +> **Note**: +> We can also update email address, if they do, they will need to reverify +> their new email address. + +### Login (Index) + +Does nothing else but asking for a user authentication. Can be used to +validate credentials. HTTP Basic Auth for now, maybe change in future. + +GET /v1/users + +**Return**: +: - Valid: HTTP 200 + - Invalid login: HTTP 401 + - Account inactive: HTTP 403 Account is not Active + +### Tags (Registry) + +The Registry does not know anything about users. Even though +repositories are under usernames, it’s just a namespace for the +registry. Allowing us to implement organizations or different namespaces +per user later, without modifying the Registry’s API. + +The following naming restrictions apply: + +- Namespaces must match the same regular expression as usernames (See + 4.2.1.) +- Repository names must match the regular expression [a-zA-Z0-9-\_.] + +### Get all tags: + +GET /v1/repositories/\/\/tags + +**Return**: HTTP 200 +: { "latest": + "9e89cc6f0bc3c38722009fe6857087b486531f9a779a0c17e3ed29dae8f12c4f", + “0.1.1”: + “b486531f9a779a0c17e3ed29dae8f12c4f9e89cc6f0bc3c38722009fe6857087” } + +#### 4.3.2 Read the content of a tag (resolve the image id) + +GET /v1/repositories/\/\/tags/\ + +**Return**: +: "9e89cc6f0bc3c38722009fe6857087b486531f9a779a0c17e3ed29dae8f12c4f" + +#### 4.3.3 Delete a tag (registry) + +DELETE /v1/repositories/\/\/tags/\ + +### 4.4 Images (Index) + +For the Index to “resolve” the repository name to a Registry location, +it uses the X-Docker-Endpoints header. In other terms, this requests +always add a `X-Docker-Endpoints` to indicate the +location of the registry which hosts this repository. + +#### 4.4.1 Get the images + +GET /v1/repositories/\/\/images + +**Return**: HTTP 200 +: [{“id”: + “9e89cc6f0bc3c38722009fe6857087b486531f9a779a0c17e3ed29dae8f12c4f”, + “checksum”: + “[md5:b486531f9a779a0c17e3ed29dae8f12c4f9e89cc6f0bc3c38722009fe6857087](md5:b486531f9a779a0c17e3ed29dae8f12c4f9e89cc6f0bc3c38722009fe6857087)”}] + +### Add/update the images: + +You always add images, you never remove them. + +PUT /v1/repositories/\/\/images + +**Body**: +: [ {“id”: + “9e89cc6f0bc3c38722009fe6857087b486531f9a779a0c17e3ed29dae8f12c4f”, + “checksum”: + “sha256:b486531f9a779a0c17e3ed29dae8f12c4f9e89cc6f0bc3c38722009fe6857087”} + ] + +**Return** 204 + +### Repositories + +### Remove a Repository (Registry) + +DELETE /v1/repositories/\/\ + +Return 200 OK + +### Remove a Repository (Index) + +This starts the delete process. see 2.3 for more details. + +DELETE /v1/repositories/\/\ + +Return 202 OK + +## Chaining Registries + +It’s possible to chain Registries server for several reasons: + +- Load balancing +- Delegate the next request to another server + +When a Registry is a reference for a repository, it should host the +entire images chain in order to avoid breaking the chain during the +download. + +The Index and Registry use this mechanism to redirect on one or the +other. + +Example with an image download: + +On every request, a special header can be returned: + + X-Docker-Endpoints: server1,server2 + +On the next request, the client will always pick a server from this +list. + +## Authentication & Authorization + +### On the Index + +The Index supports both “Basic” and “Token” challenges. Usually when +there is a `401 Unauthorized`, the Index replies +this: + + 401 Unauthorized + WWW-Authenticate: Basic realm="auth required",Token + +You have 3 options: + +1. Provide user credentials and ask for a token + + > **Header**: + > : - Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== + > - X-Docker-Token: true + > + > In this case, along with the 200 response, you’ll get a new token + > (if user auth is ok): If authorization isn’t correct you get a 401 + > response. If account isn’t active you will get a 403 response. + > + > **Response**: + > : - 200 OK + > - X-Docker-Token: Token + > signature=123abc,repository=”foo/bar”,access=read + > +2. Provide user credentials only + + > **Header**: + > : Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== + > +3. Provide Token + + > **Header**: + > : Authorization: Token + > signature=123abc,repository=”foo/bar”,access=read + > +### 6.2 On the Registry + +The Registry only supports the Token challenge: + + 401 Unauthorized + WWW-Authenticate: Token + +The only way is to provide a token on `401 Unauthorized` +responses: + + Authorization: Token signature=123abc,repository="foo/bar",access=read + +Usually, the Registry provides a Cookie when a Token verification +succeeded. Every time the Registry passes a Cookie, you have to pass it +back the same cookie.: + + 200 OK + Set-Cookie: session="wD/J7LqL5ctqw8haL10vgfhrb2Q=?foo=UydiYXInCnAxCi4=×tamp=RjEzNjYzMTQ5NDcuNDc0NjQzCi4="; Path=/; HttpOnly + +Next request: + + GET /(...) + Cookie: session="wD/J7LqL5ctqw8haL10vgfhrb2Q=?foo=UydiYXInCnAxCi4=×tamp=RjEzNjYzMTQ5NDcuNDc0NjQzCi4=" + +## Document Version + +- 1.0 : May 6th 2013 : initial release +- 1.1 : June 1st 2013 : Added Delete Repository and way to handle new + source namespace. + diff --git a/docs/sources/reference/api/remote_api_client_libraries.md b/docs/sources/reference/api/remote_api_client_libraries.md new file mode 100644 index 0000000000..eb1e3a4ee1 --- /dev/null +++ b/docs/sources/reference/api/remote_api_client_libraries.md @@ -0,0 +1,89 @@ +page_title: Remote API Client Libraries +page_description: Various client libraries available to use with the Docker remote API +page_keywords: API, Docker, index, registry, REST, documentation, clients, Python, Ruby, JavaScript, Erlang, Go + +# Docker Remote API Client Libraries + +These libraries have not been tested by the Docker Maintainers for +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/Framewor Name Repository Status + k + ----------------- ------------ ---------------------------------- ------- + Python docker-py [https://github.com/dotcloud/docke Active + r-py](https://github.com/dotcloud/ + docker-py) + + Ruby docker-clien [https://github.com/geku/docker-cl Outdate + t ient](https://github.com/geku/dock d + er-client) + + Ruby docker-api [https://github.com/swipely/docker Active + -api](https://github.com/swipely/d + ocker-api) + + JavaScript dockerode [https://github.com/apocas/dockero Active + (NodeJS) de](https://github.com/apocas/dock + erode) + Install via NPM: npm install + dockerode + + JavaScript docker.io [https://github.com/appersonlabs/d Active + (NodeJS) ocker.io](https://github.com/apper + sonlabs/docker.io) + Install via NPM: npm install + docker.io + + JavaScript docker-js [https://github.com/dgoujard/docke Outdate + r-js](https://github.com/dgoujard/ d + docker-js) + + JavaScript docker-cp [https://github.com/13W/docker-cp] Active + (Angular) (https://github.com/13W/docker-cp) + **WebUI** + + JavaScript dockerui [https://github.com/crosbymichael/ Active + (Angular) dockerui](https://github.com/crosb + **WebUI** ymichael/dockerui) + + Java docker-java [https://github.com/kpelykh/docker Active + -java](https://github.com/kpelykh/ + docker-java) + + Erlang erldocker [https://github.com/proger/erldock Active + er](https://github.com/proger/erld + ocker) + + Go go-dockercli [https://github.com/fsouza/go-dock Active + ent erclient](https://github.com/fsouz + a/go-dockerclient) + + Go dockerclient [https://github.com/samalba/docker Active + client](https://github.com/samalba + /dockerclient) + + PHP Alvine [http://pear.alvine.io/](http://pe Active + ar.alvine.io/) + (alpha) + + PHP Docker-PHP [http://stage1.github.io/docker-ph Active + p/](http://stage1.github.io/docker + -php/) + + Perl Net::Docker [https://metacpan.org/pod/Net::Doc Active + ker](https://metacpan.org/pod/Net: + :Docker) + + Perl Eixo::Docker [https://github.com/alambike/eixo- Active + docker](https://github.com/alambik + e/eixo-docker) + + Scala reactive-doc [https://github.com/almoehi/reacti Active + ker ve-docker](https://github.com/almo + ehi/reactive-docker) + ------------------------------------------------------------------------- + + diff --git a/docs/sources/reference/builder.md b/docs/sources/reference/builder.md new file mode 100644 index 0000000000..5c332e5c2f --- /dev/null +++ b/docs/sources/reference/builder.md @@ -0,0 +1,500 @@ +page_title: Dockerfile Reference +page_description: Dockerfiles use a simple DSL which allows you to automate the steps you would normally manually take to create an image. +page_keywords: builder, docker, Dockerfile, automation, image creation + +# Dockerfile Reference + +**Docker can act as a builder** and read instructions from a text +`Dockerfile` to automate the steps you would +otherwise take manually to create an image. Executing +`docker build` will run your steps and commit them +along the way, giving you a final image. + +## Usage + +To [*build*](../commandline/cli/#cli-build) an image from a source +repository, create a description file called `Dockerfile` +at the root of your repository. This file will describe the +steps to assemble the image. + +Then call `docker build` with the path of your +source repository as argument (for example, `.`): + +> `sudo docker build .` + +The path to the source repository defines where to find the *context* of +the build. The build is run by the Docker daemon, not by the CLI, so the +whole context must be transferred to the daemon. The Docker CLI reports +"Uploading context" when the context is sent to the daemon. + +You can specify a repository and tag at which to save the new image if +the build succeeds: + +> `sudo docker build -t shykes/myapp .` + +The Docker daemon will run your steps one-by-one, committing the result +to a new image if necessary, before finally outputting the ID of your +new image. The Docker daemon will automatically clean up the context you +sent. + +Note that each instruction is run independently, and causes a new image +to be created - so `RUN cd /tmp` will not have any +effect on the next instructions. + +Whenever possible, Docker will re-use the intermediate images, +accelerating `docker build` significantly (indicated +by `Using cache`): + + $ docker build -t SvenDowideit/ambassador . + Uploading context 10.24 kB + Uploading context + Step 1 : FROM docker-ut + ---> cbba202fe96b + Step 2 : MAINTAINER SvenDowideit@home.org.au + ---> Using cache + ---> 51182097be13 + Step 3 : CMD env | grep _TCP= | sed 's/.*_PORT_\([0-9]*\)_TCP=tcp:\/\/\(.*\):\(.*\)/socat TCP4-LISTEN:\1,fork,reuseaddr TCP4:\2:\3 \&/' | sh && top + ---> Using cache + ---> 1a5ffc17324d + Successfully built 1a5ffc17324d + +When you’re done with your build, you’re ready to look into [*Pushing a +repository to its +registry*](../../use/workingwithrepository/#image-push). + +## Format + +Here is the format of the Dockerfile: + + # Comment + INSTRUCTION arguments + +The Instruction is not case-sensitive, however convention is for them to +be UPPERCASE in order to distinguish them from arguments more easily. + +Docker evaluates the instructions in a Dockerfile in order. **The first +instruction must be \`FROM\`** in order to specify the [*Base +Image*](../../terms/image/#base-image-def) from which you are building. + +Docker will treat lines that *begin* with `#` as a +comment. A `#` marker anywhere else in the line will +be treated as an argument. This allows statements like: + + # Comment + RUN echo 'we are running some # of cool things' + +Here is the set of instructions you can use in a `Dockerfile` +for building images. + +## `FROM` + +> `FROM ` + +Or + +> `FROM :` + +The `FROM` instruction sets the [*Base +Image*](../../terms/image/#base-image-def) for subsequent instructions. +As such, a valid Dockerfile must have `FROM` as its +first instruction. The image can be any valid image – it is especially +easy to start by **pulling an image** from the [*Public +Repositories*](../../use/workingwithrepository/#using-public-repositories). + +`FROM` must be the first non-comment instruction in +the `Dockerfile`. + +`FROM` can appear multiple times within a single +Dockerfile in order to create multiple images. Simply make a note of the +last image id output by the commit before each new `FROM` +command. + +If no `tag` is given to the `FROM` +instruction, `latest` is assumed. If the +used tag does not exist, an error will be returned. + +## `MAINTAINER` + +> `MAINTAINER ` + +The `MAINTAINER` instruction allows you to set the +*Author* field of the generated images. + +## `RUN` + +RUN has 2 forms: + +- `RUN ` (the command is run in a shell - + `/bin/sh -c`) +- `RUN ["executable", "param1", "param2"]` (*exec* + form) + +The `RUN` instruction will execute any commands in a +new layer on top of the current image and commit the results. The +resulting committed image will be used for the next step in the +Dockerfile. + +Layering `RUN` instructions and generating commits +conforms to the core concepts of Docker where commits are cheap and +containers can be created from any point in an image’s history, much +like source control. + +The *exec* form makes it possible to avoid shell string munging, and to +`RUN` commands using a base image that does not +contain `/bin/sh`. + +### Known Issues (RUN) + +- [Issue 783](https://github.com/dotcloud/docker/issues/783) is about + file permissions problems that can occur when using the AUFS file + system. You might notice it during an attempt to `rm` + a file, for example. The issue describes a workaround. +- [Issue 2424](https://github.com/dotcloud/docker/issues/2424) Locale + will not be set automatically. + +## `CMD` + +CMD has three forms: + +- `CMD ["executable","param1","param2"]` (like an + *exec*, preferred form) +- `CMD ["param1","param2"]` (as *default + parameters to ENTRYPOINT*) +- `CMD command param1 param2` (as a *shell*) + +There can only be one CMD in a Dockerfile. If you list more than one CMD +then only the last CMD will take effect. + +**The main purpose of a CMD is to provide defaults for an executing +container.** These defaults can include an executable, or they can omit +the executable, in which case you must specify an ENTRYPOINT as well. + +When used in the shell or exec formats, the `CMD` +instruction sets the command to be executed when running the image. + +If you use the *shell* form of the CMD, then the `` +will execute in `/bin/sh -c`: + + FROM ubuntu + CMD echo "This is a test." | wc - + +If you want to **run your** `` **without a +shell** then you must express the command as a JSON array and give the +full path to the executable. **This array form is the preferred format +of CMD.** Any additional parameters must be individually expressed as +strings in the array: + + FROM ubuntu + CMD ["/usr/bin/wc","--help"] + +If you would like your container to run the same executable every time, +then you should consider using `ENTRYPOINT` in +combination with `CMD`. See +[*ENTRYPOINT*](#entrypoint). + +If the user specifies arguments to `docker run` then +they will override the default specified in CMD. + +> **Note**: +> Don’t confuse `RUN` with `CMD`. `RUN` actually runs a command and commits +> the result; `CMD` does not execute anything at build time, but specifies +> the intended command for the image. + +## `EXPOSE` + +> `EXPOSE [...]` + +The `EXPOSE` instructions informs Docker that the +container will listen on the specified network ports at runtime. Docker +uses this information to interconnect containers using links (see +[*links*](../../use/working_with_links_names/#working-with-links-names)), +and to setup port redirection on the host system (see [*Redirect +Ports*](../../use/port_redirection/#port-redirection)). + +## `ENV` + +> `ENV ` + +The `ENV` instruction sets the environment variable +`` to the value ``. +This value will be passed to all future `RUN` +instructions. This is functionally equivalent to prefixing the command +with `=` + +The environment variables set using `ENV` will +persist when a container is run from the resulting image. You can view +the values using `docker inspect`, and change them +using `docker run --env =`. + +> **Note**: +> One example where this can cause unexpected consequenses, is setting +> `ENV DEBIAN_FRONTEND noninteractive`. Which will +> persist when the container is run interactively; for example: +> `docker run -t -i image bash` + +## `ADD` + +> `ADD ` + +The `ADD` instruction will copy new files from +\ and add them to the container’s filesystem at path +``. + +`` must be the path to a file or directory +relative to the source directory being built (also called the *context* +of the build) or a remote file URL. + +`` is the absolute path to which the source +will be copied inside the destination container. + +All new files and directories are created with mode 0755, uid and gid 0. + +> **Note**: +> If you build using STDIN (`docker build - < somefile`), there is no +> build context, so the Dockerfile can only contain an URL based ADD +> statement. + +> **Note**: +> If your URL files are protected using authentication, you will need to +> use an `RUN wget` , `RUN curl` +> or other tool from within the container as ADD does not support +> authentication. + +The copy obeys the following rules: + +- The `` path must be inside the *context* of + the build; you cannot `ADD ../something /something` +, because the first step of a `docker build` + is to send the context directory (and subdirectories) to + the docker daemon. + +- If `` is a URL and `` + does not end with a trailing slash, then a file is + downloaded from the URL and copied to ``. + +- If `` is a URL and `` + does end with a trailing slash, then the filename is + inferred from the URL and the file is downloaded to + `/`. For instance, + `ADD http://example.com/foobar /` would create + the file `/foobar`. The URL must have a + nontrivial path so that an appropriate filename can be discovered in + this case (`http://example.com` will not work). + +- If `` is a directory, the entire directory + is copied, including filesystem metadata. + +- If `` is a *local* tar archive in a + recognized compression format (identity, gzip, bzip2 or xz) then it + is unpacked as a directory. Resources from *remote* URLs are **not** + decompressed. + + When a directory is copied or unpacked, it has the same behavior as + `tar -x`: the result is the union of + + 1. whatever existed at the destination path and + 2. the contents of the source tree, + + with conflicts resolved in favor of "2." on a file-by-file basis. + +- If `` is any other kind of file, it is + copied individually along with its metadata. In this case, if + `` ends with a trailing slash + `/`, it will be considered a directory and the + contents of `` will be written at + `/base()`. + +- If `` does not end with a trailing slash, + it will be considered a regular file and the contents of + `` will be written at `` +. + +- If `` doesn’t exist, it is created along + with all missing directories in its path. + +## `ENTRYPOINT` + +ENTRYPOINT has two forms: + +- `ENTRYPOINT ["executable", "param1", "param2"]` + (like an *exec*, preferred form) +- `ENTRYPOINT command param1 param2` (as a + *shell*) + +There can only be one `ENTRYPOINT` in a Dockerfile. +If you have more than one `ENTRYPOINT`, then only +the last one in the Dockerfile will have an effect. + +An `ENTRYPOINT` helps you to configure a container +that you can run as an executable. That is, when you specify an +`ENTRYPOINT`, then the whole container runs as if it +was just that executable. + +The `ENTRYPOINT` instruction adds an entry command that will **not** be +overwritten when arguments are passed to `docker run`, unlike the +behavior of `CMD`. This allows arguments to be passed to the entrypoint. +i.e. `docker run -d` will pass the "-d" argument to the +ENTRYPOINT. + +You can specify parameters either in the ENTRYPOINT JSON array (as in +"like an exec" above), or by using a CMD statement. Parameters in the +ENTRYPOINT will not be overridden by the `docker run` +arguments, but parameters specified via CMD will be overridden +by `docker run` arguments. + +Like a `CMD`, you can specify a plain string for the +ENTRYPOINT and it will execute in `/bin/sh -c`: + + FROM ubuntu + ENTRYPOINT wc -l - + +For example, that Dockerfile’s image will *always* take stdin as input +("-") and print the number of lines ("-l"). If you wanted to make this +optional but default, you could use a CMD: + + FROM ubuntu + CMD ["-l", "-"] + ENTRYPOINT ["/usr/bin/wc"] + +## `VOLUME` + +> `VOLUME ["/data"]` + +The `VOLUME` instruction will create a mount point +with the specified name and mark it as holding externally mounted +volumes from native host or other containers. For more +information/examples and mounting instructions via docker client, refer +to [*Share Directories via +Volumes*](../../use/working_with_volumes/#volume-def) documentation. + +## `USER` + +> `USER daemon` + +The `USER` instruction sets the username or UID to +use when running the image. + +## `WORKDIR` + +> `WORKDIR /path/to/workdir` + +The `WORKDIR` instruction sets the working directory +for the `RUN`, `CMD` and +`ENTRYPOINT` Dockerfile commands that follow it. + +It can be used multiple times in the one Dockerfile. If a relative path +is provided, it will be relative to the path of the previous +`WORKDIR` instruction. For example: + +> WORKDIR /a WORKDIR b WORKDIR c RUN pwd + +The output of the final `pwd` command in this +Dockerfile would be `/a/b/c`. + +## `ONBUILD` + +> `ONBUILD [INSTRUCTION]` + +The `ONBUILD` instruction adds to the image a +"trigger" instruction to be executed at a later time, when the image is +used as the base for another build. The trigger will be executed in the +context of the downstream build, as if it had been inserted immediately +after the *FROM* instruction in the downstream Dockerfile. + +Any build instruction can be registered as a trigger. + +This is useful if you are building an image which will be used as a base +to build other images, for example an application build environment or a +daemon which may be customized with user-specific configuration. + +For example, if your image is a reusable python application builder, it +will require application source code to be added in a particular +directory, and it might require a build script to be called *after* +that. You can’t just call *ADD* and *RUN* now, because you don’t yet +have access to the application source code, and it will be different for +each application build. You could simply provide application developers +with a boilerplate Dockerfile to copy-paste into their application, but +that is inefficient, error-prone and difficult to update because it +mixes with application-specific code. + +The solution is to use *ONBUILD* to register in advance instructions to +run later, during the next build stage. + +Here’s how it works: + +1. When it encounters an *ONBUILD* instruction, the builder adds a + trigger to the metadata of the image being built. The instruction + does not otherwise affect the current build. +2. At the end of the build, a list of all triggers is stored in the + image manifest, under the key *OnBuild*. They can be inspected with + *docker inspect*. +3. Later the image may be used as a base for a new build, using the + *FROM* instruction. As part of processing the *FROM* instruction, + the downstream builder looks for *ONBUILD* triggers, and executes + them in the same order they were registered. If any of the triggers + fail, the *FROM* instruction is aborted which in turn causes the + build to fail. If all triggers succeed, the FROM instruction + completes and the build continues as usual. +4. Triggers are cleared from the final image after being executed. In + other words they are not inherited by "grand-children" builds. + +For example you might add something like this: + + [...] + ONBUILD ADD . /app/src + ONBUILD RUN /usr/local/bin/python-build --dir /app/src + [...] + +> **Warning**: Chaining ONBUILD instructions using ONBUILD ONBUILD isn’t allowed. + +> **Warning**: ONBUILD may not trigger FROM or MAINTAINER instructions. + +## Dockerfile Examples + + # Nginx + # + # VERSION 0.0.1 + + FROM ubuntu + MAINTAINER Guillaume J. Charmes + + # make sure the package repository is up to date + RUN echo "deb http://archive.ubuntu.com/ubuntu precise main universe" > /etc/apt/sources.list + RUN apt-get update + + RUN apt-get install -y inotify-tools nginx apache2 openssh-server + + # Firefox over VNC + # + # VERSION 0.3 + + FROM ubuntu + # make sure the package repository is up to date + RUN echo "deb http://archive.ubuntu.com/ubuntu precise main universe" > /etc/apt/sources.list + RUN apt-get update + + # Install vnc, xvfb in order to create a 'fake' display and firefox + RUN apt-get install -y x11vnc xvfb firefox + RUN mkdir /.vnc + # Setup a password + RUN x11vnc -storepasswd 1234 ~/.vnc/passwd + # Autostart firefox (might not be the best way, but it does the trick) + RUN bash -c 'echo "firefox" >> /.bashrc' + + EXPOSE 5900 + CMD ["x11vnc", "-forever", "-usepw", "-create"] + + # Multiple images example + # + # VERSION 0.1 + + FROM ubuntu + RUN echo foo > bar + # Will output something like ===> 907ad6c2736f + + FROM ubuntu + RUN echo moo > oink + # Will output something like ===> 695d7793cbe4 + + # You᾿ll now have two images, 907ad6c2736f with /bar, and 695d7793cbe4 with + # /oink. diff --git a/docs/sources/reference/commandline.md b/docs/sources/reference/commandline.md new file mode 100644 index 0000000000..8620a095b9 --- /dev/null +++ b/docs/sources/reference/commandline.md @@ -0,0 +1,7 @@ + +# Commands + +## Contents: + +- [Command Line](cli/) + diff --git a/docs/sources/reference/commandline/cli.md b/docs/sources/reference/commandline/cli.md new file mode 100644 index 0000000000..e0d896755b --- /dev/null +++ b/docs/sources/reference/commandline/cli.md @@ -0,0 +1,1162 @@ +page_title: Command Line Interface +page_description: Docker's CLI command description and usage +page_keywords: Docker, Docker documentation, CLI, command line + +# Command Line + +To list available commands, either run `docker` with +no parameters or execute `docker help`: + + $ sudo docker + Usage: docker [OPTIONS] COMMAND [arg...] + -H=[unix:///var/run/docker.sock]: tcp://[host]:port to bind/connect to or unix://[/path/to/socket] to use. When host=[127.0.0.1] is omitted for tcp or path=[/var/run/docker.sock] is omitted for unix sockets, default values are used. + + A self-sufficient runtime for linux containers. + + ... + +## Option types + +Single character commandline options can be combined, so rather than +typing `docker run -t -i --name test busybox sh`, +you can write `docker run -ti --name test busybox sh`. + +### Boolean + +Boolean options look like `-d=false`. The value you +see is the default value which gets set if you do **not** use the +boolean flag. If you do call `run -d`, that sets the +opposite boolean value, so in this case, `true`, and +so `docker run -d` **will** run in "detached" mode, +in the background. Other boolean options are similar – specifying them +will set the value to the opposite of the default value. + +### Multi + +Options like `-a=[]` indicate they can be specified +multiple times: + + docker run -a stdin -a stdout -a stderr -i -t ubuntu /bin/bash + +Sometimes this can use a more complex value string, as for +`-v`: + + docker run -v /host:/container example/mysql + +### Strings and Integers + +Options like `--name=""` expect a string, and they +can only be specified once. Options like `-c=0` +expect an integer, and they can only be specified once. + +## `daemon` + + Usage of docker: + -D, --debug=false: Enable debug mode + -H, --host=[]: Multiple tcp://host:port or unix://path/to/socket to bind in daemon mode, single connection otherwise. systemd socket activation can be used with fd://[socketfd]. + -G, --group="docker": Group to assign the unix socket specified by -H when running in daemon mode; use '' (the empty string) to disable setting of a group + --api-enable-cors=false: Enable CORS headers in the remote API + -b, --bridge="": Attach containers to a pre-existing network bridge; use 'none' to disable container networking + -bip="": Use this CIDR notation address for the network bridge᾿s IP, not compatible with -b + -d, --daemon=false: Enable daemon mode + --dns=[]: Force docker to use specific DNS servers + --dns-search=[]: Force Docker to use specific DNS search domains + -g, --graph="/var/lib/docker": Path to use as the root of the docker runtime + --icc=true: Enable inter-container communication + --ip="0.0.0.0": Default IP address to use when binding container ports + --ip-forward=true: Enable net.ipv4.ip_forward + --iptables=true: Enable Docker᾿s addition of iptables rules + -p, --pidfile="/var/run/docker.pid": Path to use for daemon PID file + -r, --restart=true: Restart previously running containers + -s, --storage-driver="": Force the docker runtime to use a specific storage driver + -e, --exec-driver="native": Force the docker runtime to use a specific exec driver + -v, --version=false: Print version information and quit + --tls=false: Use TLS; implied by tls-verify flags + --tlscacert="~/.docker/ca.pem": Trust only remotes providing a certificate signed by the CA given here + --tlscert="~/.docker/cert.pem": Path to TLS certificate file + --tlskey="~/.docker/key.pem": Path to TLS key file + --tlsverify=false: Use TLS and verify the remote (daemon: verify client, client: verify daemon) + --mtu=0: Set the containers network MTU; if no value is provided: default to the default route MTU or 1500 if no default route is available + +The Docker daemon is the persistent process that manages containers. +Docker uses the same binary for both the daemon and client. To run the +daemon you provide the `-d` flag. + +To force Docker to use devicemapper as the storage driver, use +`docker -d -s devicemapper`. + +To set the DNS server for all Docker containers, use +`docker -d --dns 8.8.8.8`. + +To set the DNS search domain for all Docker containers, use +`docker -d --dns-search example.com`. + +To run the daemon with debug output, use `docker -d -D`. + +To use lxc as the execution driver, use `docker -d -e lxc`. + +The docker client will also honor the `DOCKER_HOST` +environment variable to set the `-H` flag for the +client. + + docker -H tcp://0.0.0.0:4243 ps + # or + export DOCKER_HOST="tcp://0.0.0.0:4243" + docker ps + # both are equal + +To run the daemon with [systemd socket +activation](http://0pointer.de/blog/projects/socket-activation.html), +use `docker -d -H fd://`. Using `fd://` +will work perfectly for most setups but you can also specify +individual sockets too `docker -d -H fd://3`. If the +specified socket activated files aren’t found then docker will exit. You +can find examples of using systemd socket activation with docker and +systemd in the [docker source +tree](https://github.com/dotcloud/docker/blob/master/contrib/init/systemd/socket-activation/). + +Docker supports softlinks for the Docker data directory +(`/var/lib/docker`) and for `/tmp`. TMPDIR and the data directory can be set like this: + + TMPDIR=/mnt/disk2/tmp /usr/local/bin/docker -d -D -g /var/lib/docker -H unix:// > /var/lib/boot2docker/docker.log 2>&1 + # or + export TMPDIR=/mnt/disk2/tmp + /usr/local/bin/docker -d -D -g /var/lib/docker -H unix:// > /var/lib/boot2docker/docker.log 2>&1 + +## `attach` + + Usage: docker attach CONTAINER + + Attach to a running container. + + --no-stdin=false: Do not attach stdin + --sig-proxy=true: Proxify all received signal to the process (even in non-tty mode) + +The `attach` command will allow you to view or +interact with any running container, detached (`-d`) +or interactive (`-i`). You can attach to the same +container at the same time - screen sharing style, or quickly view the +progress of your daemonized process. + +You can detach from the container again (and leave it running) with +`CTRL-C` (for a quiet exit) or `CTRL-\` +to get a stacktrace of the Docker client when it quits. When +you detach from the container’s process the exit code will be returned +to the client. + +To stop a container, use `docker stop`. + +To kill the container, use `docker kill`. + +### Examples: + + $ ID=$(sudo docker run -d ubuntu /usr/bin/top -b) + $ sudo docker attach $ID + top - 02:05:52 up 3:05, 0 users, load average: 0.01, 0.02, 0.05 + Tasks: 1 total, 1 running, 0 sleeping, 0 stopped, 0 zombie + Cpu(s): 0.1%us, 0.2%sy, 0.0%ni, 99.7%id, 0.0%wa, 0.0%hi, 0.0%si, 0.0%st + Mem: 373572k total, 355560k used, 18012k free, 27872k buffers + Swap: 786428k total, 0k used, 786428k free, 221740k cached + + PID USER PR NI VIRT RES SHR S %CPU %MEM TIME+ COMMAND + 1 root 20 0 17200 1116 912 R 0 0.3 0:00.03 top + + top - 02:05:55 up 3:05, 0 users, load average: 0.01, 0.02, 0.05 + Tasks: 1 total, 1 running, 0 sleeping, 0 stopped, 0 zombie + Cpu(s): 0.0%us, 0.2%sy, 0.0%ni, 99.8%id, 0.0%wa, 0.0%hi, 0.0%si, 0.0%st + Mem: 373572k total, 355244k used, 18328k free, 27872k buffers + Swap: 786428k total, 0k used, 786428k free, 221776k cached + + PID USER PR NI VIRT RES SHR S %CPU %MEM TIME+ COMMAND + 1 root 20 0 17208 1144 932 R 0 0.3 0:00.03 top + + + top - 02:05:58 up 3:06, 0 users, load average: 0.01, 0.02, 0.05 + Tasks: 1 total, 1 running, 0 sleeping, 0 stopped, 0 zombie + Cpu(s): 0.2%us, 0.3%sy, 0.0%ni, 99.5%id, 0.0%wa, 0.0%hi, 0.0%si, 0.0%st + Mem: 373572k total, 355780k used, 17792k free, 27880k buffers + Swap: 786428k total, 0k used, 786428k free, 221776k cached + + PID USER PR NI VIRT RES SHR S %CPU %MEM TIME+ COMMAND + 1 root 20 0 17208 1144 932 R 0 0.3 0:00.03 top + ^C$ + $ sudo docker stop $ID + +## `build` + + Usage: docker build [OPTIONS] PATH | URL | - + Build a new container image from the source code at PATH + -t, --tag="": Repository name (and optionally a tag) to be applied + to the resulting image in case of success. + -q, --quiet=false: Suppress the verbose output generated by the containers. + --no-cache: Do not use the cache when building the image. + --rm=true: Remove intermediate containers after a successful build + +Use this command to build Docker images from a `Dockerfile` +and a "context". + +The files at `PATH` or `URL` are +called the "context" of the build. The build process may refer to any of +the files in the context, for example when using an +[*ADD*](../../builder/#dockerfile-add) instruction. When a single +`Dockerfile` is given as `URL`, +then no context is set. + +When a Git repository is set as `URL`, then the +repository is used as the context. The Git repository is cloned with its +submodules (git clone –recursive). A fresh git clone occurs in a +temporary directory on your local host, and then this is sent to the +Docker daemon as the context. This way, your local user credentials and +vpn’s etc can be used to access private repositories + +See also + +[*Dockerfile Reference*](../../builder/#dockerbuilder). + +### Examples: + + $ sudo docker build . + Uploading context 10240 bytes + Step 1 : FROM busybox + Pulling repository busybox + ---> e9aa60c60128MB/2.284 MB (100%) endpoint: https://cdn-registry-1.docker.io/v1/ + Step 2 : RUN ls -lh / + ---> Running in 9c9e81692ae9 + total 24 + drwxr-xr-x 2 root root 4.0K Mar 12 2013 bin + drwxr-xr-x 5 root root 4.0K Oct 19 00:19 dev + drwxr-xr-x 2 root root 4.0K Oct 19 00:19 etc + drwxr-xr-x 2 root root 4.0K Nov 15 23:34 lib + lrwxrwxrwx 1 root root 3 Mar 12 2013 lib64 -> lib + dr-xr-xr-x 116 root root 0 Nov 15 23:34 proc + lrwxrwxrwx 1 root root 3 Mar 12 2013 sbin -> bin + dr-xr-xr-x 13 root root 0 Nov 15 23:34 sys + drwxr-xr-x 2 root root 4.0K Mar 12 2013 tmp + drwxr-xr-x 2 root root 4.0K Nov 15 23:34 usr + ---> b35f4035db3f + Step 3 : CMD echo Hello World + ---> Running in 02071fceb21b + ---> f52f38b7823e + Successfully built f52f38b7823e + Removing intermediate container 9c9e81692ae9 + Removing intermediate container 02071fceb21b + +This example specifies that the `PATH` is +`.`, and so all the files in the local directory get +tar’d and sent to the Docker daemon. The `PATH` +specifies where to find the files for the "context" of the build on the +Docker daemon. Remember that the daemon could be running on a remote +machine and that no parsing of the `Dockerfile` +happens at the client side (where you’re running +`docker build`). That means that *all* the files at +`PATH` get sent, not just the ones listed to +[*ADD*](../../builder/#dockerfile-add) in the `Dockerfile`. + +The transfer of context from the local machine to the Docker daemon is +what the `docker` client means when you see the +"Uploading context" message. + +If you wish to keep the intermediate containers after the build is +complete, you must use `--rm=false`. This does not +affect the build cache. + + $ sudo docker build -t vieux/apache:2.0 . + +This will build like the previous example, but it will then tag the +resulting image. The repository name will be `vieux/apache` +and the tag will be `2.0` + + $ sudo docker build - < Dockerfile + +This will read a `Dockerfile` from *stdin* without +context. Due to the lack of a context, no contents of any local +directory will be sent to the `docker` daemon. Since +there is no context, a `Dockerfile` `ADD` +only works if it refers to a remote URL. + + $ sudo docker build github.com/creack/docker-firefox + +This will clone the GitHub repository and use the cloned repository as +context. The `Dockerfile` at the root of the +repository is used as `Dockerfile`. Note that you +can specify an arbitrary Git repository by using the `git://` +schema. + +## `commit` + + Usage: docker commit [OPTIONS] CONTAINER [REPOSITORY[:TAG]] + + Create a new image from a container᾿s changes + + -m, --message="": Commit message + -a, --author="": Author (eg. "John Hannibal Smith " + +It can be useful to commit a container’s file changes or settings into a +new image. This allows you debug a container by running an interactive +shell, or to export a working dataset to another server. Generally, it +is better to use Dockerfiles to manage your images in a documented and +maintainable way. + +### Commit an existing container + + $ sudo docker ps + ID IMAGE COMMAND CREATED STATUS PORTS + c3f279d17e0a ubuntu:12.04 /bin/bash 7 days ago Up 25 hours + 197387f1b436 ubuntu:12.04 /bin/bash 7 days ago Up 25 hours + $ docker commit c3f279d17e0a SvenDowideit/testimage:version3 + f5283438590d + $ docker images | head + REPOSITORY TAG ID CREATED VIRTUAL SIZE + SvenDowideit/testimage version3 f5283438590d 16 seconds ago 335.7 MB + +## `cp` + + Usage: docker cp CONTAINER:PATH HOSTPATH + + Copy files/folders from the containers filesystem to the host + path. Paths are relative to the root of the filesystem. + + $ sudo docker cp 7bb0e258aefe:/etc/debian_version . + $ sudo docker cp blue_frog:/etc/hosts . + +## `diff` + + Usage: docker diff CONTAINER + + List the changed files and directories in a container᾿s filesystem + +There are 3 events that are listed in the ‘diff’: + +1. `` `A` `` - Add +2. `` `D` `` - Delete +3. `` `C` `` - Change + +For example: + + $ sudo docker diff 7bb0e258aefe + + C /dev + A /dev/kmsg + C /etc + A /etc/mtab + A /go + A /go/src + A /go/src/github.com + A /go/src/github.com/dotcloud + A /go/src/github.com/dotcloud/docker + A /go/src/github.com/dotcloud/docker/.git + .... + +## `events` + + Usage: docker events + + Get real time events from the server + + --since="": Show all events created since timestamp + (either seconds since epoch, or date string as below) + --until="": Show events created before timestamp + (either seconds since epoch, or date string as below) + +### Examples + +You’ll need two shells for this example. + +#### Shell 1: Listening for events + + $ sudo docker events + +#### Shell 2: Start and Stop a Container + + $ sudo docker start 4386fb97867d + $ sudo docker stop 4386fb97867d + +#### Shell 1: (Again .. now showing events) + + [2013-09-03 15:49:26 +0200 CEST] 4386fb97867d: (from 12de384bfb10) start + [2013-09-03 15:49:29 +0200 CEST] 4386fb97867d: (from 12de384bfb10) die + [2013-09-03 15:49:29 +0200 CEST] 4386fb97867d: (from 12de384bfb10) stop + +#### Show events in the past from a specified time + + $ sudo docker events --since 1378216169 + [2013-09-03 15:49:29 +0200 CEST] 4386fb97867d: (from 12de384bfb10) die + [2013-09-03 15:49:29 +0200 CEST] 4386fb97867d: (from 12de384bfb10) stop + + $ sudo docker events --since '2013-09-03' + [2013-09-03 15:49:26 +0200 CEST] 4386fb97867d: (from 12de384bfb10) start + [2013-09-03 15:49:29 +0200 CEST] 4386fb97867d: (from 12de384bfb10) die + [2013-09-03 15:49:29 +0200 CEST] 4386fb97867d: (from 12de384bfb10) stop + + $ sudo docker events --since '2013-09-03 15:49:29 +0200 CEST' + [2013-09-03 15:49:29 +0200 CEST] 4386fb97867d: (from 12de384bfb10) die + [2013-09-03 15:49:29 +0200 CEST] 4386fb97867d: (from 12de384bfb10) stop + +## `export` + + Usage: docker export CONTAINER + + Export the contents of a filesystem as a tar archive to STDOUT + +For example: + + $ sudo docker export red_panda > latest.tar + +## `history` + + Usage: docker history [OPTIONS] IMAGE + + Show the history of an image + + --no-trunc=false: Don᾿t truncate output + -q, --quiet=false: Only show numeric IDs + +To see how the `docker:latest` image was built: + + $ docker history docker + IMAGE CREATED CREATED BY SIZE + 3e23a5875458790b7a806f95f7ec0d0b2a5c1659bfc899c89f939f6d5b8f7094 8 days ago /bin/sh -c #(nop) ENV LC_ALL=C.UTF-8 0 B + 8578938dd17054dce7993d21de79e96a037400e8d28e15e7290fea4f65128a36 8 days ago /bin/sh -c dpkg-reconfigure locales && locale-gen C.UTF-8 && /usr/sbin/update-locale LANG=C.UTF-8 1.245 MB + be51b77efb42f67a5e96437b3e102f81e0a1399038f77bf28cea0ed23a65cf60 8 days ago /bin/sh -c apt-get update && apt-get install -y git libxml2-dev python build-essential make gcc python-dev locales python-pip 338.3 MB + 4b137612be55ca69776c7f30c2d2dd0aa2e7d72059820abf3e25b629f887a084 6 weeks ago /bin/sh -c #(nop) ADD jessie.tar.xz in / 121 MB + 750d58736b4b6cc0f9a9abe8f258cef269e3e9dceced1146503522be9f985ada 6 weeks ago /bin/sh -c #(nop) MAINTAINER Tianon Gravi - mkimage-debootstrap.sh -t jessie.tar.xz jessie http://http.debian.net/debian 0 B + 511136ea3c5a64f264b78b5433614aec563103b4d4702f3ba7d4d2698e22c158 9 months ago 0 B + +## `images` + + Usage: docker images [OPTIONS] [NAME] + + List images + + -a, --all=false: Show all images (by default filter out the intermediate image layers) + --no-trunc=false: Don᾿t truncate output + -q, --quiet=false: Only show numeric IDs + +The default `docker images` will show all top level +images, their repository and tags, and their virtual size. + +Docker images have intermediate layers that increase reuseability, +decrease disk usage, and speed up `docker build` by +allowing each step to be cached. These intermediate layers are not shown +by default. + +### Listing the most recently created images + + $ sudo docker images | head + REPOSITORY TAG IMAGE ID CREATED VIRTUAL SIZE + 77af4d6b9913 19 hours ago 1.089 GB + committest latest b6fa739cedf5 19 hours ago 1.089 GB + 78a85c484f71 19 hours ago 1.089 GB + docker latest 30557a29d5ab 20 hours ago 1.089 GB + 0124422dd9f9 20 hours ago 1.089 GB + 18ad6fad3402 22 hours ago 1.082 GB + f9f1e26352f0 23 hours ago 1.089 GB + tryout latest 2629d1fa0b81 23 hours ago 131.5 MB + 5ed6274db6ce 24 hours ago 1.089 GB + +### Listing the full length image IDs + + $ sudo docker images --no-trunc | head + REPOSITORY TAG IMAGE ID CREATED VIRTUAL SIZE + 77af4d6b9913e693e8d0b4b294fa62ade6054e6b2f1ffb617ac955dd63fb0182 19 hours ago 1.089 GB + committest latest b6fa739cedf5ea12a620a439402b6004d057da800f91c7524b5086a5e4749c9f 19 hours ago 1.089 GB + 78a85c484f71509adeaace20e72e941f6bdd2b25b4c75da8693efd9f61a37921 19 hours ago 1.089 GB + docker latest 30557a29d5abc51e5f1d5b472e79b7e296f595abcf19fe6b9199dbbc809c6ff4 20 hours ago 1.089 GB + 0124422dd9f9cf7ef15c0617cda3931ee68346455441d66ab8bdc5b05e9fdce5 20 hours ago 1.089 GB + 18ad6fad340262ac2a636efd98a6d1f0ea775ae3d45240d3418466495a19a81b 22 hours ago 1.082 GB + f9f1e26352f0a3ba6a0ff68167559f64f3e21ff7ada60366e2d44a04befd1d3a 23 hours ago 1.089 GB + tryout latest 2629d1fa0b81b222fca63371ca16cbf6a0772d07759ff80e8d1369b926940074 23 hours ago 131.5 MB + 5ed6274db6ceb2397844896966ea239290555e74ef307030ebb01ff91b1914df 24 hours ago 1.089 GB + +## `import` + + Usage: docker import URL|- [REPOSITORY[:TAG]] + + Create an empty filesystem image and import the contents of the tarball + (.tar, .tar.gz, .tgz, .bzip, .tar.xz, .txz) into it, then optionally tag it. + +URLs must start with `http` and point to a single +file archive (.tar, .tar.gz, .tgz, .bzip, .tar.xz, or .txz) containing a +root filesystem. If you would like to import from a local directory or +archive, you can use the `-` parameter to take the +data from *stdin*. + +### Examples + +#### Import from a remote location + +This will create a new untagged image. + + $ sudo docker import http://example.com/exampleimage.tgz + +#### Import from a local file + +Import to docker via pipe and *stdin*. + + $ cat exampleimage.tgz | sudo docker import - exampleimagelocal:new + +#### Import from a local directory + + $ sudo tar -c . | docker import - exampleimagedir + +Note the `sudo` in this example – you must preserve +the ownership of the files (especially root ownership) during the +archiving with tar. If you are not root (or the sudo command) when you +tar, then the ownerships might not get preserved. + +## `info` + + Usage: docker info + + Display system-wide information. + + $ sudo docker info + Containers: 292 + Images: 194 + Debug mode (server): false + Debug mode (client): false + Fds: 22 + Goroutines: 67 + LXC Version: 0.9.0 + EventsListeners: 115 + Kernel Version: 3.8.0-33-generic + WARNING: No swap limit support + +When sending issue reports, please use `docker version` +and `docker info` to ensure we know how +your setup is configured. + +## `inspect` + + Usage: docker inspect CONTAINER|IMAGE [CONTAINER|IMAGE...] + + Return low-level information on a container/image + + -f, --format="": Format the output using the given go template. + +By default, this will render all results in a JSON array. If a format is +specified, the given template will be executed for each result. + +Go’s [text/template](http://golang.org/pkg/text/template/) package +describes all the details of the format. + +### Examples + +#### Get an instance’s IP Address + +For the most part, you can pick out any field from the JSON in a fairly +straightforward manner. + + $ sudo docker inspect --format='{{.NetworkSettings.IPAddress}}' $INSTANCE_ID + +#### List All Port Bindings + +One can loop over arrays and maps in the results to produce simple text +output: + + $ sudo docker inspect --format='{{range $p, $conf := .NetworkSettings.Ports}} {{$p}} -> {{(index $conf 0).HostPort}} {{end}}' $INSTANCE_ID + +#### Find a Specific Port Mapping + +The `.Field` syntax doesn’t work when the field name +begins with a number, but the template language’s `index` +function does. The `.NetworkSettings.Ports` +section contains a map of the internal port mappings to a list +of external address/port objects, so to grab just the numeric public +port, you use `index` to find the specific port map, +and then `index` 0 contains first object inside of +that. Then we ask for the `HostPort` field to get +the public address. + + $ sudo docker inspect --format='{{(index (index .NetworkSettings.Ports "8787/tcp") 0).HostPort}}' $INSTANCE_ID + +#### Get config + +The `.Field` syntax doesn’t work when the field +contains JSON data, but the template language’s custom `json` +function does. The `.config` section +contains complex json object, so to grab it as JSON, you use +`json` to convert config object into JSON + + $ sudo docker inspect --format='{{json .config}}' $INSTANCE_ID + +## `kill` + + Usage: docker kill [OPTIONS] CONTAINER [CONTAINER...] + + Kill a running container (send SIGKILL, or specified signal) + + -s, --signal="KILL": Signal to send to the container + +The main process inside the container will be sent SIGKILL, or any +signal specified with option `--signal`. + +### Known Issues (kill) + +- [Issue 197](https://github.com/dotcloud/docker/issues/197) indicates + that `docker kill` may leave directories behind + and make it difficult to remove the container. +- [Issue 3844](https://github.com/dotcloud/docker/issues/3844) lxc + 1.0.0 beta3 removed `lcx-kill` which is used by + Docker versions before 0.8.0; see the issue for a workaround. + +## `load` + + Usage: docker load + + Load an image from a tar archive on STDIN + + -i, --input="": Read from a tar archive file, instead of STDIN + +Loads a tarred repository from a file or the standard input stream. +Restores both images and tags. + + $ sudo docker images + REPOSITORY TAG IMAGE ID CREATED VIRTUAL SIZE + $ sudo docker load < busybox.tar + $ sudo docker images + REPOSITORY TAG IMAGE ID CREATED VIRTUAL SIZE + busybox latest 769b9341d937 7 weeks ago 2.489 MB + $ sudo docker load --input fedora.tar + $ sudo docker images + REPOSITORY TAG IMAGE ID CREATED VIRTUAL SIZE + busybox latest 769b9341d937 7 weeks ago 2.489 MB + fedora rawhide 0d20aec6529d 7 weeks ago 387 MB + fedora 20 58394af37342 7 weeks ago 385.5 MB + fedora heisenbug 58394af37342 7 weeks ago 385.5 MB + fedora latest 58394af37342 7 weeks ago 385.5 MB + +## `login` + + Usage: docker login [OPTIONS] [SERVER] + + Register or Login to the docker registry server + + -e, --email="": Email + -p, --password="": Password + -u, --username="": Username + + If you want to login to a private registry you can + specify this by adding the server name. + + example: + docker login localhost:8080 + +## `logs` + + Usage: docker logs [OPTIONS] CONTAINER + + Fetch the logs of a container + + -f, --follow=false: Follow log output + +The `docker logs` command batch-retrieves all logs +present at the time of execution. + +The `docker logs --follow` command combines `docker logs` and `docker +attach`: it will first return all logs from the beginning and then +continue streaming new output from the container’s stdout and stderr. + +## `port` + + Usage: docker port [OPTIONS] CONTAINER PRIVATE_PORT + + Lookup the public-facing port which is NAT-ed to PRIVATE_PORT + +## `ps` + + Usage: docker ps [OPTIONS] + + List containers + + -a, --all=false: Show all containers. Only running containers are shown by default. + --before="": Show only container created before Id or Name, include non-running ones. + -l, --latest=false: Show only the latest created container, include non-running ones. + -n=-1: Show n last created containers, include non-running ones. + --no-trunc=false: Don᾿t truncate output + -q, --quiet=false: Only display numeric IDs + -s, --size=false: Display sizes, not to be used with -q + --since="": Show only containers created since Id or Name, include non-running ones. + +Running `docker ps` showing 2 linked containers. + + $ docker ps + CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES + 4c01db0b339c ubuntu:12.04 bash 17 seconds ago Up 16 seconds webapp + d7886598dbe2 crosbymichael/redis:latest /redis-server --dir 33 minutes ago Up 33 minutes 6379/tcp redis,webapp/db + +`docker ps` will show only running containers by +default. To see all containers: `docker ps -a` + +## `pull` + + Usage: docker pull NAME[:TAG] + + Pull an image or a repository from the registry + +Most of your images will be created on top of a base image from the +\([https://index.docker.io](https://index.docker.io)). + +The Docker Index contains many pre-built images that you can +`pull` and try without needing to define and +configure your own. + +To download a particular image, or set of images (i.e., a repository), +use `docker pull`: + + $ docker pull debian + # will pull all the images in the debian repository + $ docker pull debian:testing + # will pull only the image named debian:testing and any intermediate layers + # it is based on. (typically the empty `scratch` image, a MAINTAINERs layer, + # and the un-tared base. + +## `push` + + Usage: docker push NAME[:TAG] + + Push an image or a repository to the registry + +Use `docker push` to share your images on public or +private registries. + +## `restart` + + Usage: docker restart [OPTIONS] NAME + + Restart a running container + + -t, --time=10: Number of seconds to try to stop for before killing the container. Once killed it will then be restarted. Default=10 + +## `rm` + + Usage: docker rm [OPTIONS] CONTAINER + + Remove one or more containers + -l, --link="": Remove the link instead of the actual container + -f, --force=false: Force removal of running container + -v, --volumes=false: Remove the volumes associated to the container + +### Known Issues (rm) + +- [Issue 197](https://github.com/dotcloud/docker/issues/197) indicates + that `docker kill` may leave directories behind + and make it difficult to remove the container. + +### Examples: + + $ sudo docker rm /redis + /redis + +This will remove the container referenced under the link +`/redis`. + + $ sudo docker rm --link /webapp/redis + /webapp/redis + +This will remove the underlying link between `/webapp` +and the `/redis` containers removing all +network communication. + + $ sudo docker rm $(docker ps -a -q) + +This command will delete all stopped containers. The command +`docker ps -a -q` will return all existing container +IDs and pass them to the `rm` command which will +delete them. Any running containers will not be deleted. + +## `rmi` + + Usage: docker rmi IMAGE [IMAGE...] + + Remove one or more images + + -f, --force=false: Force + --no-prune=false: Do not delete untagged parents + +### Removing tagged images + +Images can be removed either by their short or long ID’s, or their image +names. If an image has more than one name, each of them needs to be +removed before the image is removed. + + $ sudo docker images + REPOSITORY TAG IMAGE ID CREATED SIZE + test1 latest fd484f19954f 23 seconds ago 7 B (virtual 4.964 MB) + test latest fd484f19954f 23 seconds ago 7 B (virtual 4.964 MB) + test2 latest fd484f19954f 23 seconds ago 7 B (virtual 4.964 MB) + + $ sudo docker rmi fd484f19954f + Error: Conflict, cannot delete image fd484f19954f because it is tagged in multiple repositories + 2013/12/11 05:47:16 Error: failed to remove one or more images + + $ sudo docker rmi test1 + Untagged: fd484f19954f4920da7ff372b5067f5b7ddb2fd3830cecd17b96ea9e286ba5b8 + $ sudo docker rmi test2 + Untagged: fd484f19954f4920da7ff372b5067f5b7ddb2fd3830cecd17b96ea9e286ba5b8 + + $ sudo docker images + REPOSITORY TAG IMAGE ID CREATED SIZE + test1 latest fd484f19954f 23 seconds ago 7 B (virtual 4.964 MB) + $ sudo docker rmi test + Untagged: fd484f19954f4920da7ff372b5067f5b7ddb2fd3830cecd17b96ea9e286ba5b8 + Deleted: fd484f19954f4920da7ff372b5067f5b7ddb2fd3830cecd17b96ea9e286ba5b8 + +## `run` + + Usage: docker run [OPTIONS] IMAGE[:TAG] [COMMAND] [ARG...] + + Run a command in a new container + + -a, --attach=map[]: Attach to stdin, stdout or stderr + -c, --cpu-shares=0: CPU shares (relative weight) + --cidfile="": Write the container ID to the file + -d, --detach=false: Detached mode: Run container in the background, print new container id + -e, --env=[]: Set environment variables + --env-file="": Read in a line delimited file of ENV variables + -h, --hostname="": Container host name + -i, --interactive=false: Keep stdin open even if not attached + --privileged=false: Give extended privileges to this container + -m, --memory="": Memory limit (format: , where unit = b, k, m or g) + -n, --networking=true: Enable networking for this container + -p, --publish=[]: Map a network port to the container + --rm=false: Automatically remove the container when it exits (incompatible with -d) + -t, --tty=false: Allocate a pseudo-tty + -u, --user="": Username or UID + --dns=[]: Set custom dns servers for the container + --dns-search=[]: Set custom DNS search domains for the container + -v, --volume=[]: Create a bind mount to a directory or file with: [host-path]:[container-path]:[rw|ro]. If a directory "container-path" is missing, then docker creates a new volume. + --volumes-from="": Mount all volumes from the given container(s) + --entrypoint="": Overwrite the default entrypoint set by the image + -w, --workdir="": Working directory inside the container + --lxc-conf=[]: (lxc exec-driver only) Add custom lxc options --lxc-conf="lxc.cgroup.cpuset.cpus = 0,1" + --sig-proxy=true: Proxify all received signal to the process (even in non-tty mode) + --expose=[]: Expose a port from the container without publishing it to your host + --link="": Add link to another container (name:alias) + --name="": Assign the specified name to the container. If no name is specific docker will generate a random name + -P, --publish-all=false: Publish all exposed ports to the host interfaces + +The `docker run` command first `creates` +a writeable container layer over the specified image, and then +`starts` it using the specified command. That is, +`docker run` is equivalent to the API +`/containers/create` then +`/containers/(id)/start`. A stopped container can be +restarted with all its previous changes intact using +`docker start`. See `docker ps -a` +to view a list of all containers. + +The `docker run` command can be used in combination +with `docker commit` to [*change the command that a +container runs*](#commit-an-existing-container). + +See [*Redirect Ports*](../../../use/port_redirection/#port-redirection) +for more detailed information about the `--expose`, +`-p`, `-P` and +`--link` parameters, and [*Link +Containers*](../../../use/working_with_links_names/#working-with-links-names) +for specific examples using `--link`. + +### Known Issues (run –volumes-from) + +- [Issue 2702](https://github.com/dotcloud/docker/issues/2702): + "lxc-start: Permission denied - failed to mount" could indicate a + permissions problem with AppArmor. Please see the issue for a + workaround. + +### Examples: + + $ sudo docker run --cidfile /tmp/docker_test.cid ubuntu echo "test" + +This will create a container and print `test` to the +console. The `cidfile` flag makes Docker attempt to +create a new file and write the container ID to it. If the file exists +already, Docker will return an error. Docker will close this file when +`docker run` exits. + + $ sudo docker run -t -i --rm ubuntu bash + root@bc338942ef20:/# mount -t tmpfs none /mnt + mount: permission denied + +This will *not* work, because by default, most potentially dangerous +kernel capabilities are dropped; including `cap_sys_admin` +(which is required to mount filesystems). However, the +`--privileged` flag will allow it to run: + + $ sudo docker run --privileged ubuntu bash + root@50e3f57e16e6:/# mount -t tmpfs none /mnt + root@50e3f57e16e6:/# df -h + Filesystem Size Used Avail Use% Mounted on + none 1.9G 0 1.9G 0% /mnt + +The `--privileged` flag gives *all* capabilities to +the container, and it also lifts all the limitations enforced by the +`device` cgroup controller. In other words, the +container can then do almost everything that the host can do. This flag +exists to allow special use-cases, like running Docker within Docker. + + $ sudo docker run -w /path/to/dir/ -i -t ubuntu pwd + +The `-w` lets the command being executed inside +directory given, here `/path/to/dir/`. If the path +does not exists it is created inside the container. + + $ sudo docker run -v `pwd`:`pwd` -w `pwd` -i -t ubuntu pwd + +The `-v` flag mounts the current working directory +into the container. The `-w` lets the command being +executed inside the current working directory, by changing into the +directory to the value returned by `pwd`. So this +combination executes the command using the container, but inside the +current working directory. + + $ sudo docker run -v /doesnt/exist:/foo -w /foo -i -t ubuntu bash + +When the host directory of a bind-mounted volume doesn’t exist, Docker +will automatically create this directory on the host for you. In the +example above, Docker will create the `/doesnt/exist` +folder before starting your container. + + $ sudo docker run -t -i -v /var/run/docker.sock:/var/run/docker.sock -v ./static-docker:/usr/bin/docker busybox sh + +By bind-mounting the docker unix socket and statically linked docker +binary (such as that provided by +[https://get.docker.io](https://get.docker.io)), you give the container +the full access to create and manipulate the host’s docker daemon. + + $ sudo docker run -p 127.0.0.1:80:8080 ubuntu bash + +This binds port `8080` of the container to port +`80` on `127.0.0.1` of the host +machine. [*Redirect +Ports*](../../../use/port_redirection/#port-redirection) explains in +detail how to manipulate ports in Docker. + + $ sudo docker run --expose 80 ubuntu bash + +This exposes port `80` of the container for use +within a link without publishing the port to the host system’s +interfaces. [*Redirect +Ports*](../../../use/port_redirection/#port-redirection) explains in +detail how to manipulate ports in Docker. + + $ sudo docker run -e MYVAR1 --env MYVAR2=foo --env-file ./env.list ubuntu bash + +This sets environmental variables in the container. For illustration all +three flags are shown here. Where `-e`, +`--env` take an environment variable and value, or +if no "=" is provided, then that variable’s current value is passed +through (i.e. $MYVAR1 from the host is set to $MYVAR1 in the +container). All three flags, `-e`, `--env` +and `--env-file` can be repeated. + +Regardless of the order of these three flags, the `--env-file` +are processed first, and then `-e`, `--env` flags. This way, the +`-e` or `--env` will override variables as needed. + + $ cat ./env.list + TEST_FOO=BAR + $ sudo docker run --env TEST_FOO="This is a test" --env-file ./env.list busybox env | grep TEST_FOO + TEST_FOO=This is a test + +The `--env-file` flag takes a filename as an +argument and expects each line to be in the VAR=VAL format, mimicking +the argument passed to `--env`. Comment lines need +only be prefixed with `#` + +An example of a file passed with `--env-file` + + $ cat ./env.list + TEST_FOO=BAR + + # this is a comment + TEST_APP_DEST_HOST=10.10.0.127 + TEST_APP_DEST_PORT=8888 + + # pass through this variable from the caller + TEST_PASSTHROUGH + $ sudo TEST_PASSTHROUGH=howdy docker run --env-file ./env.list busybox env + HOME=/ + PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin + HOSTNAME=5198e0745561 + TEST_FOO=BAR + TEST_APP_DEST_HOST=10.10.0.127 + TEST_APP_DEST_PORT=8888 + TEST_PASSTHROUGH=howdy + + $ sudo docker run --name console -t -i ubuntu bash + +This will create and run a new container with the container name being +`console`. + + $ sudo docker run --link /redis:redis --name console ubuntu bash + +The `--link` flag will link the container named +`/redis` into the newly created container with the +alias `redis`. The new container can access the +network and environment of the redis container via environment +variables. The `--name` flag will assign the name +`console` to the newly created container. + + $ sudo docker run --volumes-from 777f7dc92da7,ba8c0c54f0f2:ro -i -t ubuntu pwd + +The `--volumes-from` flag mounts all the defined +volumes from the referenced containers. Containers can be specified by a +comma separated list or by repetitions of the `--volumes-from` +argument. The container ID may be optionally suffixed with +`:ro` or `:rw` to mount the +volumes in read-only or read-write mode, respectively. By default, the +volumes are mounted in the same mode (read write or read only) as the +reference container. + +The `-a` flag tells `docker run` +to bind to the container’s stdin, stdout or stderr. This makes it +possible to manipulate the output and input as needed. + + $ sudo echo "test" | docker run -i -a stdin ubuntu cat - + +This pipes data into a container and prints the container’s ID by +attaching only to the container’s stdin. + + $ sudo docker run -a stderr ubuntu echo test + +This isn’t going to print anything unless there’s an error because we’ve +only attached to the stderr of the container. The container’s logs still +store what’s been written to stderr and stdout. + + $ sudo cat somefile | docker run -i -a stdin mybuilder dobuild + +This is how piping a file into a container could be done for a build. +The container’s ID will be printed after the build is done and the build +logs could be retrieved using `docker logs`. This is +useful if you need to pipe a file or something else into a container and +retrieve the container’s ID once the container has finished running. + +#### A complete example + + $ sudo docker run -d --name static static-web-files sh + $ sudo docker run -d --expose=8098 --name riak riakserver + $ sudo docker run -d -m 100m -e DEVELOPMENT=1 -e BRANCH=example-code -v $(pwd):/app/bin:ro --name app appserver + $ sudo docker run -d -p 1443:443 --dns=dns.dev.org --dns-search=dev.org -v /var/log/httpd --volumes-from static --link riak --link app -h www.sven.dev.org --name web webserver + $ sudo docker run -t -i --rm --volumes-from web -w /var/log/httpd busybox tail -f access.log + +This example shows 5 containers that might be set up to test a web +application change: + +1. Start a pre-prepared volume image `static-web-files` + (in the background) that has CSS, image and static HTML in + it, (with a `VOLUME` instruction in the + `Dockerfile` to allow the web server to use + those files); +2. Start a pre-prepared `riakserver` image, give + the container name `riak` and expose port + `8098` to any containers that link to it; +3. Start the `appserver` image, restricting its + memory usage to 100MB, setting two environment variables + `DEVELOPMENT` and `BRANCH` + and bind-mounting the current directory (`$(pwd)` +) in the container in read-only mode as + `/app/bin`; +4. Start the `webserver`, mapping port + `443` in the container to port `1443` + on the Docker server, setting the DNS server to + `dns.dev.org` and DNS search domain to + `dev.org`, creating a volume to put the log + files into (so we can access it from another container), then + importing the files from the volume exposed by the + `static` container, and linking to all exposed + ports from `riak` and `app`. + Lastly, we set the hostname to `web.sven.dev.org` + so its consistent with the pre-generated SSL certificate; +5. Finally, we create a container that runs + `tail -f access.log` using the logs volume from + the `web` container, setting the workdir to + `/var/log/httpd`. The `--rm` + option means that when the container exits, the container’s layer is + removed. + +## `save` + + Usage: docker save IMAGE + + Save an image to a tar archive (streamed to stdout by default) + + -o, --output="": Write to an file, instead of STDOUT + +Produces a tarred repository to the standard output stream. Contains all +parent layers, and all tags + versions, or specified repo:tag. + +It is used to create a backup that can then be used with +`docker load` + + $ sudo docker save busybox > busybox.tar + $ ls -sh b.tar + 2.7M b.tar + $ sudo docker save --output busybox.tar busybox + $ ls -sh b.tar + 2.7M b.tar + $ sudo docker save -o fedora-all.tar fedora + $ sudo docker save -o fedora-latest.tar fedora:latest + +## `search` + + Usage: docker search TERM + + Search the docker index for images + + --no-trunc=false: Don᾿t truncate output + -s, --stars=0: Only displays with at least xxx stars + -t, --trusted=false: Only show trusted builds + +See [*Find Public Images on the Central +Index*](../../../use/workingwithrepository/#searching-central-index) for +more details on finding shared images from the commandline. + +## `start` + + Usage: docker start [OPTIONS] CONTAINER + + Start a stopped container + + -a, --attach=false: Attach container᾿s stdout/stderr and forward all signals to the process + -i, --interactive=false: Attach container᾿s stdin + +## `stop` + + Usage: docker stop [OPTIONS] CONTAINER [CONTAINER...] + + Stop a running container (Send SIGTERM, and then SIGKILL after grace period) + + -t, --time=10: Number of seconds to wait for the container to stop before killing it. + +The main process inside the container will receive SIGTERM, and after a +grace period, SIGKILL + +## `tag` + + Usage: docker tag [OPTIONS] IMAGE [REGISTRYHOST/][USERNAME/]NAME[:TAG] + + Tag an image into a repository + + -f, --force=false: Force + +You can group your images together using names and tags, and then upload +them to [*Share Images via +Repositories*](../../../use/workingwithrepository/#working-with-the-repository). + +## `top` + + Usage: docker top CONTAINER [ps OPTIONS] + + Lookup the running processes of a container + +## `version` + +Show the version of the Docker client, daemon, and latest released +version. + +## `wait` + + Usage: docker wait [OPTIONS] NAME + + Block until a container stops, then print its exit code. diff --git a/docs/sources/reference/commandline/cli.rst b/docs/sources/reference/commandline/cli.rst index 366d5bb251..87c08eb4b4 100644 --- a/docs/sources/reference/commandline/cli.rst +++ b/docs/sources/reference/commandline/cli.rst @@ -4,8 +4,8 @@ .. _cli: -Command Line Help ------------------ +Command Line +============ To list available commands, either run ``docker`` with no parameters or execute ``docker help``:: @@ -20,8 +20,8 @@ To list available commands, either run ``docker`` with no parameters or execute .. _cli_options: -Options -------- +Option types +------------ Single character commandline options can be combined, so rather than typing ``docker run -t -i --name test busybox sh``, you can write @@ -56,11 +56,6 @@ Options like ``--name=""`` expect a string, and they can only be specified once. Options like ``-c=0`` expect an integer, and they can only be specified once. ----- - -Commands --------- - .. _cli_daemon: ``daemon`` @@ -1343,8 +1338,8 @@ from the commandline. Start a stopped container - -a, --attach=false: Attach container's stdout/stderr and forward all signals to the process - -i, --interactive=false: Attach container's stdin + -a, --attach=false: Attach container᾿s stdout/stderr and forward all signals to the process + -i, --interactive=false: Attach container᾿s stdin .. _cli_stop: diff --git a/docs/sources/reference/run.md b/docs/sources/reference/run.md new file mode 100644 index 0000000000..236b8065b8 --- /dev/null +++ b/docs/sources/reference/run.md @@ -0,0 +1,416 @@ +page_title: Docker Run Reference +page_description: Configure containers at runtime +page_keywords: docker, run, configure, runtime + +# [Docker Run Reference](#id2) + +**Docker runs processes in isolated containers**. When an operator +executes `docker run`, she starts a process with its +own file system, its own networking, and its own isolated process tree. +The [*Image*](../../terms/image/#image-def) which starts the process may +define defaults related to the binary to run, the networking to expose, +and more, but `docker run` gives final control to +the operator who starts the container from the image. That’s the main +reason [*run*](../commandline/cli/#cli-run) has more options than any +other `docker` command. + +Every one of the [*Examples*](../../examples/#example-list) shows +running containers, and so here we try to give more in-depth guidance. + +## [General Form](#id3) + +As you’ve seen in the [*Examples*](../../examples/#example-list), the +basic run command takes this form: + + docker run [OPTIONS] IMAGE[:TAG] [COMMAND] [ARG...] + +To learn how to interpret the types of `[OPTIONS]`, +see [*Option types*](../commandline/cli/#cli-options). + +The list of `[OPTIONS]` breaks down into two groups: + +1. Settings exclusive to operators, including: + - Detached or Foreground running, + - Container Identification, + - Network settings, and + - Runtime Constraints on CPU and Memory + - Privileges and LXC Configuration + +2. Setting shared between operators and developers, where operators can + override defaults developers set in images at build time. + +Together, the `docker run [OPTIONS]` give complete +control over runtime behavior to the operator, allowing them to override +all defaults set by the developer during `docker build` +and nearly all the defaults set by the Docker runtime itself. + +## [Operator Exclusive Options](#id4) + +Only the operator (the person executing `docker run`) can set the +following options. + +- [Detached vs Foreground](#detached-vs-foreground) + - [Detached (-d)](#detached-d) + - [Foreground](#foreground) +- [Container Identification](#container-identification) + - [Name (–name)](#name-name) + - [PID Equivalent](#pid-equivalent) +- [Network Settings](#network-settings) +- [Clean Up (–rm)](#clean-up-rm) +- [Runtime Constraints on CPU and + Memory](#runtime-constraints-on-cpu-and-memory) +- [Runtime Privilege and LXC + Configuration](#runtime-privilege-and-lxc-configuration) + +### [Detached vs Foreground](#id2) + +When starting a Docker container, you must first decide if you want to +run the container in the background in a "detached" mode or in the +default foreground mode: + + -d=false: Detached mode: Run container in the background, print new container id + +#### [Detached (-d)](#id3) + +In detached mode (`-d=true` or just `-d`), all I/O should be done +through network connections or shared volumes because the container is +no longer listening to the commandline where you executed `docker run`. +You can reattach to a detached container with `docker` +[*attach*](../commandline/cli/#cli-attach). If you choose to run a +container in the detached mode, then you cannot use the `--rm` option. + +#### [Foreground](#id4) + +In foreground mode (the default when `-d` is not +specified), `docker run` can start the process in +the container and attach the console to the process’s standard input, +output, and standard error. It can even pretend to be a TTY (this is +what most commandline executables expect) and pass along signals. All of +that is configurable: + + -a=[] : Attach to ``stdin``, ``stdout`` and/or ``stderr`` + -t=false : Allocate a pseudo-tty + --sig-proxy=true: Proxify all received signal to the process (even in non-tty mode) + -i=false : Keep STDIN open even if not attached + +If you do not specify `-a` then Docker will [attach +everything +(stdin,stdout,stderr)](https://github.com/dotcloud/docker/blob/75a7f4d90cde0295bcfb7213004abce8d4779b75/commands.go#L1797). +You can specify to which of the three standard streams +(`stdin`, `stdout`, +`stderr`) you’d like to connect instead, as in: + + docker run -a stdin -a stdout -i -t ubuntu /bin/bash + +For interactive processes (like a shell) you will typically want a tty +as well as persistent standard input (`stdin`), so +you’ll use `-i -t` together in most interactive +cases. + +### [Container Identification](#id5) + +#### [Name (–name)](#id6) + +The operator can identify a container in three ways: + +- UUID long identifier + ("f78375b1c487e03c9438c729345e54db9d20cfa2ac1fc3494b6eb60872e74778") +- UUID short identifier ("f78375b1c487") +- Name ("evil\_ptolemy") + +The UUID identifiers come from the Docker daemon, and if you do not +assign a name to the container with `--name` then +the daemon will also generate a random string name too. The name can +become a handy way to add meaning to a container since you can use this +name when defining +[*links*](../../use/working_with_links_names/#working-with-links-names) +(or any other place you need to identify a container). This works for +both background and foreground Docker containers. + +#### [PID Equivalent](#id7) + +And finally, to help with automation, you can have Docker write the +container ID out to a file of your choosing. This is similar to how some +programs might write out their process ID to a file (you’ve seen them as +PID files): + + --cidfile="": Write the container ID to the file + +### [Network Settings](#id8) + + -n=true : Enable networking for this container + --dns=[] : Set custom dns servers for the container + +By default, all containers have networking enabled and they can make any +outgoing connections. The operator can completely disable networking +with `docker run -n` which disables all incoming and +outgoing networking. In cases like this, you would perform I/O through +files or STDIN/STDOUT only. + +Your container will use the same DNS servers as the host by default, but +you can override this with `--dns`. + +### [Clean Up (–rm)](#id9) + +By default a container’s file system persists even after the container +exits. This makes debugging a lot easier (since you can inspect the +final state) and you retain all your data by default. But if you are +running short-term **foreground** processes, these container file +systems can really pile up. If instead you’d like Docker to +**automatically clean up the container and remove the file system when +the container exits**, you can add the `--rm` flag: + + --rm=false: Automatically remove the container when it exits (incompatible with -d) + +### [Runtime Constraints on CPU and Memory](#id10) + +The operator can also adjust the performance parameters of the +container: + + -m="": Memory limit (format: , where unit = b, k, m or g) + -c=0 : CPU shares (relative weight) + +The operator can constrain the memory available to a container easily +with `docker run -m`. If the host supports swap +memory, then the `-m` memory setting can be larger +than physical RAM. + +Similarly the operator can increase the priority of this container with +the `-c` option. By default, all containers run at +the same priority and get the same proportion of CPU cycles, but you can +tell the kernel to give more shares of CPU time to one or more +containers when you start them via Docker. + +### [Runtime Privilege and LXC Configuration](#id11) + + --privileged=false: Give extended privileges to this container + --lxc-conf=[]: (lxc exec-driver only) Add custom lxc options --lxc-conf="lxc.cgroup.cpuset.cpus = 0,1" + +By default, Docker containers are "unprivileged" and cannot, for +example, run a Docker daemon inside a Docker container. This is because +by default a container is not allowed to access any devices, but a +"privileged" container is given access to all devices (see +[lxc-template.go](https://github.com/dotcloud/docker/blob/master/execdriver/lxc/lxc_template.go) +and documentation on [cgroups +devices](https://www.kernel.org/doc/Documentation/cgroups/devices.txt)). + +When the operator executes `docker run --privileged`, Docker will enable +to access to all devices on the host as well as set some configuration +in AppArmor to allow the container nearly all the same access to the +host as processes running outside containers on the host. Additional +information about running with `--privileged` is available on the +[Docker +Blog](http://blog.docker.io/2013/09/docker-can-now-run-within-docker/). + +If the Docker daemon was started using the `lxc` +exec-driver (`docker -d --exec-driver=lxc`) then the +operator can also specify LXC options using one or more +`--lxc-conf` parameters. These can be new parameters +or override existing parameters from the +[lxc-template.go](https://github.com/dotcloud/docker/blob/master/execdriver/lxc/lxc_template.go). +Note that in the future, a given host’s Docker daemon may not use LXC, +so this is an implementation-specific configuration meant for operators +already familiar with using LXC directly. + +## Overriding `Dockerfile` Image Defaults + +When a developer builds an image from a +[*Dockerfile*](../builder/#dockerbuilder) or when she commits it, the +developer can set a number of default parameters that take effect when +the image starts up as a container. + +Four of the `Dockerfile` commands cannot be +overridden at runtime: `FROM, MAINTAINER, RUN`, and +`ADD`. Everything else has a corresponding override +in `docker run`. We’ll go through what the developer +might have set in each `Dockerfile` instruction and +how the operator can override that setting. + +- [CMD (Default Command or Options)](#cmd-default-command-or-options) +- [ENTRYPOINT (Default Command to Execute at + Runtime](#entrypoint-default-command-to-execute-at-runtime) +- [EXPOSE (Incoming Ports)](#expose-incoming-ports) +- [ENV (Environment Variables)](#env-environment-variables) +- [VOLUME (Shared Filesystems)](#volume-shared-filesystems) +- [USER](#user) +- [WORKDIR](#workdir) + +### [CMD (Default Command or Options)](#id12) + +Recall the optional `COMMAND` in the Docker +commandline: + + docker run [OPTIONS] IMAGE[:TAG] [COMMAND] [ARG...] + +This command is optional because the person who created the +`IMAGE` may have already provided a default +`COMMAND` using the `Dockerfile` +`CMD`. As the operator (the person running a +container from the image), you can override that `CMD` +just by specifying a new `COMMAND`. + +If the image also specifies an `ENTRYPOINT` then the +`CMD` or `COMMAND` get appended +as arguments to the `ENTRYPOINT`. + +### [ENTRYPOINT (Default Command to Execute at Runtime](#id13) + + --entrypoint="": Overwrite the default entrypoint set by the image + +The ENTRYPOINT of an image is similar to a `COMMAND` because it +specifies what executable to run when the container starts, but it is +(purposely) more difficult to override. The `ENTRYPOINT` gives a +container its default nature or behavior, so that when you set an +`ENTRYPOINT` you can run the container *as if it were that binary*, +complete with default options, and you can pass in more options via the +`COMMAND`. But, sometimes an operator may want to run something else +inside the container, so you can override the default `ENTRYPOINT` at +runtime by using a string to specify the new `ENTRYPOINT`. Here is an +example of how to run a shell in a container that has been set up to +automatically run something else (like `/usr/bin/redis-server`): + + docker run -i -t --entrypoint /bin/bash example/redis + +or two examples of how to pass more parameters to that ENTRYPOINT: + + docker run -i -t --entrypoint /bin/bash example/redis -c ls -l + docker run -i -t --entrypoint /usr/bin/redis-cli example/redis --help + +### [EXPOSE (Incoming Ports)](#id14) + +The `Dockerfile` doesn’t give much control over +networking, only providing the `EXPOSE` instruction +to give a hint to the operator about what incoming ports might provide +services. The following options work with or override the +`Dockerfile`‘s exposed defaults: + + --expose=[]: Expose a port from the container + without publishing it to your host + -P=false : Publish all exposed ports to the host interfaces + -p=[] : Publish a container᾿s port to the host (format: + ip:hostPort:containerPort | ip::containerPort | + hostPort:containerPort) + (use 'docker port' to see the actual mapping) + --link="" : Add link to another container (name:alias) + +As mentioned previously, `EXPOSE` (and +`--expose`) make a port available **in** a container +for incoming connections. The port number on the inside of the container +(where the service listens) does not need to be the same number as the +port exposed on the outside of the container (where clients connect), so +inside the container you might have an HTTP service listening on port 80 +(and so you `EXPOSE 80` in the +`Dockerfile`), but outside the container the port +might be 42800. + +To help a new client container reach the server container’s internal +port operator `--expose`‘d by the operator or +`EXPOSE`‘d by the developer, the operator has three +choices: start the server container with `-P` or +`-p,` or start the client container with +`--link`. + +If the operator uses `-P` or `-p` +then Docker will make the exposed port accessible on the host +and the ports will be available to any client that can reach the host. +To find the map between the host ports and the exposed ports, use +`docker port`) + +If the operator uses `--link` when starting the new +client container, then the client container can access the exposed port +via a private networking interface. Docker will set some environment +variables in the client container to help indicate which interface and +port to use. + +### [ENV (Environment Variables)](#id15) + +The operator can **set any environment variable** in the container by +using one or more `-e` flags, even overriding those +already defined by the developer with a Dockefile `ENV`: + + $ docker run -e "deep=purple" --rm ubuntu /bin/bash -c export + declare -x HOME="/" + declare -x HOSTNAME="85bc26a0e200" + declare -x OLDPWD + declare -x PATH="/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin" + declare -x PWD="/" + declare -x SHLVL="1" + declare -x container="lxc" + declare -x deep="purple" + +Similarly the operator can set the **hostname** with `-h`. + +`--link name:alias` also sets environment variables, +using the *alias* string to define environment variables within the +container that give the IP and PORT information for connecting to the +service container. Let’s imagine we have a container running Redis: + + # Start the service container, named redis-name + $ docker run -d --name redis-name dockerfiles/redis + 4241164edf6f5aca5b0e9e4c9eccd899b0b8080c64c0cd26efe02166c73208f3 + + # The redis-name container exposed port 6379 + $ docker ps + CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES + 4241164edf6f dockerfiles/redis:latest /redis-stable/src/re 5 seconds ago Up 4 seconds 6379/tcp redis-name + + # Note that there are no public ports exposed since we didn᾿t use -p or -P + $ docker port 4241164edf6f 6379 + 2014/01/25 00:55:38 Error: No public port '6379' published for 4241164edf6f + +Yet we can get information about the Redis container’s exposed ports +with `--link`. Choose an alias that will form a +valid environment variable! + + $ docker run --rm --link redis-name:redis_alias --entrypoint /bin/bash dockerfiles/redis -c export + declare -x HOME="/" + declare -x HOSTNAME="acda7f7b1cdc" + declare -x OLDPWD + declare -x PATH="/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin" + declare -x PWD="/" + declare -x REDIS_ALIAS_NAME="/distracted_wright/redis" + declare -x REDIS_ALIAS_PORT="tcp://172.17.0.32:6379" + declare -x REDIS_ALIAS_PORT_6379_TCP="tcp://172.17.0.32:6379" + declare -x REDIS_ALIAS_PORT_6379_TCP_ADDR="172.17.0.32" + declare -x REDIS_ALIAS_PORT_6379_TCP_PORT="6379" + declare -x REDIS_ALIAS_PORT_6379_TCP_PROTO="tcp" + declare -x SHLVL="1" + declare -x container="lxc" + +And we can use that information to connect from another container as a +client: + + $ docker run -i -t --rm --link redis-name:redis_alias --entrypoint /bin/bash dockerfiles/redis -c '/redis-stable/src/redis-cli -h $REDIS_ALIAS_PORT_6379_TCP_ADDR -p $REDIS_ALIAS_PORT_6379_TCP_PORT' + 172.17.0.32:6379> + +### [VOLUME (Shared Filesystems)](#id16) + + -v=[]: Create a bind mount with: [host-dir]:[container-dir]:[rw|ro]. + If "container-dir" is missing, then docker creates a new volume. + --volumes-from="": Mount all volumes from the given container(s) + +The volumes commands are complex enough to have their own documentation +in section [*Share Directories via +Volumes*](../../use/working_with_volumes/#volume-def). A developer can +define one or more `VOLUME`s associated with an +image, but only the operator can give access from one container to +another (or from a container to a volume mounted on the host). + +### [USER](#id17) + +The default user within a container is `root` (id = +0), but if the developer created additional users, those are accessible +too. The developer can set a default user to run the first process with +the `Dockerfile USER` command, but the operator can +override it + + -u="": Username or UID + +### [WORKDIR](#id18) + +The default working directory for running binaries within a container is +the root directory (`/`), but the developer can set +a different default with the `Dockerfile WORKDIR` +command. The operator can override this with: + + -w="": Working directory inside the container diff --git a/docs/sources/reference/run.rst b/docs/sources/reference/run.rst index d2fe449c22..0e6247ea28 100644 --- a/docs/sources/reference/run.rst +++ b/docs/sources/reference/run.rst @@ -20,9 +20,6 @@ than any other ``docker`` command. Every one of the :ref:`example_list` shows running containers, and so here we try to give more in-depth guidance. -.. contents:: Table of Contents - :depth: 2 - .. _run_running: General Form diff --git a/docs/sources/robots.txt b/docs/sources/robots.txt new file mode 100644 index 0000000000..c2a49f4fb8 --- /dev/null +++ b/docs/sources/robots.txt @@ -0,0 +1,2 @@ +User-agent: * +Allow: / diff --git a/docs/sources/search.md b/docs/sources/search.md new file mode 100644 index 0000000000..0e2e13fb08 --- /dev/null +++ b/docs/sources/search.md @@ -0,0 +1,10 @@ +# Search + +*Please activate JavaScript to enable the search functionality.* + +## How To Search + +From here you can search these documents. Enter your search words into +the box below and click "search". Note that the search function will +automatically search for all of the words. Pages containing fewer words +won't appear in the result list. diff --git a/docs/sources/terms.md b/docs/sources/terms.md new file mode 100644 index 0000000000..59579d99a1 --- /dev/null +++ b/docs/sources/terms.md @@ -0,0 +1,13 @@ +# Glossary + +*Definitions of terms used in Docker documentation.* + +## Contents: + +- [File System](filesystem/) +- [Layers](layer/) +- [Image](image/) +- [Container](container/) +- [Registry](registry/) +- [Repository](repository/) + diff --git a/docs/sources/terms/container.md b/docs/sources/terms/container.md new file mode 100644 index 0000000000..92a0265d99 --- /dev/null +++ b/docs/sources/terms/container.md @@ -0,0 +1,46 @@ +page_title: Container +page_description: Definitions of a container +page_keywords: containers, lxc, concepts, explanation, image, container + +# Container + +## Introduction + +![](../../_images/docker-filesystems-busyboxrw.png) + +Once you start a process in Docker from an +[*Image*](../image/#image-def), Docker fetches the image and its +[*Parent Image*](../image/#parent-image-def), and repeats the process +until it reaches the [*Base Image*](../image/#base-image-def). Then the +[*Union File System*](../layer/#ufs-def) adds a read-write layer on top. +That read-write layer, plus the information about its [*Parent +Image*](../image/#parent-image-def) and some additional information like +its unique id, networking configuration, and resource limits is called a +**container**. + +## Container State + +Containers can change, and so they have state. A container may be +**running** or **exited**. + +When a container is running, the idea of a "container" also includes a +tree of processes running on the CPU, isolated from the other processes +running on the host. + +When the container is exited, the state of the file system and its exit +value is preserved. You can start, stop, and restart a container. The +processes restart from scratch (their memory state is **not** preserved +in a container), but the file system is just as it was when the +container was stopped. + +You can promote a container to an [*Image*](../image/#image-def) with +`docker commit`. Once a container is an image, you +can use it as a parent for new containers. + +## Container IDs + +All containers are identified by a 64 hexadecimal digit string +(internally a 256bit value). To simplify their use, a short ID of the +first 12 characters can be used on the commandline. There is a small +possibility of short id collisions, so the docker server will always +return the long ID. diff --git a/docs/sources/terms/filesystem.md b/docs/sources/terms/filesystem.md new file mode 100644 index 0000000000..2038d009e3 --- /dev/null +++ b/docs/sources/terms/filesystem.md @@ -0,0 +1,36 @@ +page_title: File Systems +page_description: How Linux organizes its persistent storage +page_keywords: containers, files, linux + +# File System + +## Introduction + +![](../../_images/docker-filesystems-generic.png) + +In order for a Linux system to run, it typically needs two [file +systems](http://en.wikipedia.org/wiki/Filesystem): + +1. boot file system (bootfs) +2. root file system (rootfs) + +The **boot file system** contains the bootloader and the kernel. The +user never makes any changes to the boot file system. In fact, soon +after the boot process is complete, the entire kernel is in memory, and +the boot file system is unmounted to free up the RAM associated with the +initrd disk image. + +The **root file system** includes the typical directory structure we +associate with Unix-like operating systems: +`/dev, /proc, /bin, /etc, /lib, /usr,` and +`/tmp` plus all the configuration files, binaries +and libraries required to run user applications (like bash, ls, and so +forth). + +While there can be important kernel differences between different Linux +distributions, the contents and organization of the root file system are +usually what make your software packages dependent on one distribution +versus another. Docker can help solve this problem by running multiple +distributions at the same time. + +![](../../_images/docker-filesystems-multiroot.png) diff --git a/docs/sources/terms/image.md b/docs/sources/terms/image.md new file mode 100644 index 0000000000..721d4c954c --- /dev/null +++ b/docs/sources/terms/image.md @@ -0,0 +1,40 @@ +page_title: Images +page_description: Definition of an image +page_keywords: containers, lxc, concepts, explanation, image, container + +# Image + +## Introduction + +![](../../_images/docker-filesystems-debian.png) + +In Docker terminology, a read-only [*Layer*](../layer/#layer-def) is +called an **image**. An image never changes. + +Since Docker uses a [*Union File System*](../layer/#ufs-def), the +processes think the whole file system is mounted read-write. But all the +changes go to the top-most writeable layer, and underneath, the original +file in the read-only image is unchanged. Since images don’t change, +images do not have state. + +![](../../_images/docker-filesystems-debianrw.png) + +## Parent Image + +![](../../_images/docker-filesystems-multilayer.png) + +Each image may depend on one more image which forms the layer beneath +it. We sometimes say that the lower image is the **parent** of the upper +image. + +## Base Image + +An image that has no parent is a **base image**. + +## Image IDs + +All images are identified by a 64 hexadecimal digit string (internally a +256bit value). To simplify their use, a short ID of the first 12 +characters can be used on the command line. There is a small possibility +of short id collisions, so the docker server will always return the long +ID. diff --git a/docs/sources/terms/layer.md b/docs/sources/terms/layer.md new file mode 100644 index 0000000000..7665467aae --- /dev/null +++ b/docs/sources/terms/layer.md @@ -0,0 +1,35 @@ +page_title: Layers +page_description: Organizing the Docker Root File System +page_keywords: containers, lxc, concepts, explanation, image, container + +# Layers + +## Introduction + +In a traditional Linux boot, the kernel first mounts the root [*File +System*](../filesystem/#filesystem-def) as read-only, checks its +integrity, and then switches the whole rootfs volume to read-write mode. + +## Layer + +When Docker mounts the rootfs, it starts read-only, as in a traditional +Linux boot, but then, instead of changing the file system to read-write +mode, it takes advantage of a [union +mount](http://en.wikipedia.org/wiki/Union_mount) to add a read-write +file system *over* the read-only file system. In fact there may be +multiple read-only file systems stacked on top of each other. We think +of each one of these file systems as a **layer**. + +![](../../_images/docker-filesystems-multilayer.png) + +At first, the top read-write layer has nothing in it, but any time a +process creates a file, this happens in the top layer. And if something +needs to update an existing file in a lower layer, then the file gets +copied to the upper layer and changes go into the copy. The version of +the file on the lower layer cannot be seen by the applications anymore, +but it is there, unchanged. + +## Union File System + +We call the union of the read-write layer and all the read-only layers a +**union file system**. diff --git a/docs/sources/terms/registry.md b/docs/sources/terms/registry.md new file mode 100644 index 0000000000..0d5af2c65d --- /dev/null +++ b/docs/sources/terms/registry.md @@ -0,0 +1,20 @@ +page_title: Registry +page_description: Definition of an Registry +page_keywords: containers, lxc, concepts, explanation, image, repository, container + +# Registry + +## Introduction + +A Registry is a hosted service containing +[*repositories*](../repository/#repository-def) of +[*images*](../image/#image-def) which responds to the Registry API. + +The default registry can be accessed using a browser at +[http://images.docker.io](http://images.docker.io) or using the +`sudo docker search` command. + +## Further Reading + +For more information see [*Working with +Repositories*](../../use/workingwithrepository/#working-with-the-repository) diff --git a/docs/sources/terms/repository.md b/docs/sources/terms/repository.md new file mode 100644 index 0000000000..7ccd69ad19 --- /dev/null +++ b/docs/sources/terms/repository.md @@ -0,0 +1,38 @@ +page_title: Repository +page_description: Definition of an Repository +page_keywords: containers, lxc, concepts, explanation, image, repository, container + +# Repository + +## Introduction + +A repository is a set of images either on your local Docker server, or +shared, by pushing it to a [*Registry*](../registry/#registry-def) +server. + +Images can be associated with a repository (or multiple) by giving them +an image name using one of three different commands: + +1. At build time (e.g. `sudo docker build -t IMAGENAME` +), +2. When committing a container (e.g. + `sudo docker commit CONTAINERID IMAGENAME`) or +3. When tagging an image id with an image name (e.g. + `sudo docker tag IMAGEID IMAGENAME`). + +A Fully Qualified Image Name (FQIN) can be made up of 3 parts: + +`[registry_hostname[:port]/][user_name/](repository_name:version_tag)` + +`username` and `registry_hostname` +default to an empty string. When `registry_hostname` +is an empty string, then `docker push` +will push to `index.docker.io:80`. + +If you create a new repository which you want to share, you will need to +set at least the `user_name`, as the ‘default’ blank +`user_name` prefix is reserved for official Docker +images. + +For more information see [*Working with +Repositories*](../../use/workingwithrepository/#working-with-the-repository) diff --git a/docs/sources/toctree.md b/docs/sources/toctree.md new file mode 100644 index 0000000000..e837c7e3af --- /dev/null +++ b/docs/sources/toctree.md @@ -0,0 +1,17 @@ +page_title: Documentation +page_description: -- todo: change me +page_keywords: todo, docker, documentation, installation, usage, examples, contributing, faq, command line, concepts + +# Documentation + +This documentation has the following resources: + +- [Installation](../installation/) +- [Use](../use/) +- [Examples](../examples/) +- [Reference Manual](../reference/) +- [Contributing](../contributing/) +- [Glossary](../terms/) +- [Articles](../articles/) +- [FAQ](../faq/) + diff --git a/docs/sources/toctree.rst b/docs/sources/toctree.rst index d1f98b6a5d..d09bcc313c 100644 --- a/docs/sources/toctree.rst +++ b/docs/sources/toctree.rst @@ -10,7 +10,6 @@ This documentation has the following resources: .. toctree:: :maxdepth: 1 - Introduction installation/index use/index examples/index diff --git a/docs/sources/use.md b/docs/sources/use.md new file mode 100644 index 0000000000..ce4a51025c --- /dev/null +++ b/docs/sources/use.md @@ -0,0 +1,13 @@ +# Use + +## Contents: + +- [First steps with Docker](basics/) +- [Share Images via Repositories](workingwithrepository/) +- [Redirect Ports](port_redirection/) +- [Configure Networking](networking/) +- [Automatically Start Containers](host_integration/) +- [Share Directories via Volumes](working_with_volumes/) +- [Link Containers](working_with_links_names/) +- [Link via an Ambassador Container](ambassador_pattern_linking/) +- [Using Puppet](puppet/) \ No newline at end of file diff --git a/docs/sources/use/ambassador_pattern_linking.md b/docs/sources/use/ambassador_pattern_linking.md new file mode 100644 index 0000000000..685d155917 --- /dev/null +++ b/docs/sources/use/ambassador_pattern_linking.md @@ -0,0 +1,156 @@ +page_title: Link via an Ambassador Container +page_description: Using the Ambassador pattern to abstract (network) services +page_keywords: Examples, Usage, links, docker, documentation, examples, names, name, container naming + +# Link via an Ambassador Container + +## Introduction + +Rather than hardcoding network links between a service consumer and +provider, Docker encourages service portability. + +eg, instead of + + (consumer) --> (redis) + +requiring you to restart the `consumer` to attach it +to a different `redis` service, you can add +ambassadors + + (consumer) --> (redis-ambassador) --> (redis) + + or + + (consumer) --> (redis-ambassador) ---network---> (redis-ambassador) --> (redis) + +When you need to rewire your consumer to talk to a different redis +server, you can just restart the `redis-ambassador` +container that the consumer is connected to. + +This pattern also allows you to transparently move the redis server to a +different docker host from the consumer. + +Using the `svendowideit/ambassador` container, the +link wiring is controlled entirely from the `docker run` +parameters. + +## Two host Example + +Start actual redis server on one Docker host + + big-server $ docker run -d -name redis crosbymichael/redis + +Then add an ambassador linked to the redis server, mapping a port to the +outside world + + big-server $ docker run -d -link redis:redis -name redis_ambassador -p 6379:6379 svendowideit/ambassador + +On the other host, you can set up another ambassador setting environment +variables for each remote port we want to proxy to the +`big-server` + + client-server $ docker run -d -name redis_ambassador -expose 6379 -e REDIS_PORT_6379_TCP=tcp://192.168.1.52:6379 svendowideit/ambassador + +Then on the `client-server` host, you can use a +redis client container to talk to the remote redis server, just by +linking to the local redis ambassador. + + client-server $ docker run -i -t -rm -link redis_ambassador:redis relateiq/redis-cli + redis 172.17.0.160:6379> ping + PONG + +## How it works + +The following example shows what the `svendowideit/ambassador` +container does automatically (with a tiny amount of +`sed`) + +On the docker host (192.168.1.52) that redis will run on: + + # start actual redis server + $ docker run -d -name redis crosbymichael/redis + + # get a redis-cli container for connection testing + $ docker pull relateiq/redis-cli + + # test the redis server by talking to it directly + $ docker run -t -i -rm -link redis:redis relateiq/redis-cli + redis 172.17.0.136:6379> ping + PONG + ^D + + # add redis ambassador + $ docker run -t -i -link redis:redis -name redis_ambassador -p 6379:6379 busybox sh + +in the redis\_ambassador container, you can see the linked redis +containers’s env + + $ env + REDIS_PORT=tcp://172.17.0.136:6379 + REDIS_PORT_6379_TCP_ADDR=172.17.0.136 + REDIS_NAME=/redis_ambassador/redis + HOSTNAME=19d7adf4705e + REDIS_PORT_6379_TCP_PORT=6379 + HOME=/ + REDIS_PORT_6379_TCP_PROTO=tcp + container=lxc + REDIS_PORT_6379_TCP=tcp://172.17.0.136:6379 + TERM=xterm + PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin + PWD=/ + +This environment is used by the ambassador socat script to expose redis +to the world (via the -p 6379:6379 port mapping) + + $ docker rm redis_ambassador + $ sudo ./contrib/mkimage-unittest.sh + $ docker run -t -i -link redis:redis -name redis_ambassador -p 6379:6379 docker-ut sh + + $ socat TCP4-LISTEN:6379,fork,reuseaddr TCP4:172.17.0.136:6379 + +then ping the redis server via the ambassador + +Now goto a different server + + $ sudo ./contrib/mkimage-unittest.sh + $ docker run -t -i -expose 6379 -name redis_ambassador docker-ut sh + + $ socat TCP4-LISTEN:6379,fork,reuseaddr TCP4:192.168.1.52:6379 + +and get the redis-cli image so we can talk over the ambassador bridge + + $ docker pull relateiq/redis-cli + $ docker run -i -t -rm -link redis_ambassador:redis relateiq/redis-cli + redis 172.17.0.160:6379> ping + PONG + +## The svendowideit/ambassador Dockerfile + +The `svendowideit/ambassador` image is a small +busybox image with `socat` built in. When you start +the container, it uses a small `sed` script to parse +out the (possibly multiple) link environment variables to set up the +port forwarding. On the remote host, you need to set the variable using +the `-e` command line option. + +`--expose 1234 -e REDIS_PORT_1234_TCP=tcp://192.168.1.52:6379` +will forward the local `1234` port to the +remote IP and port - in this case `192.168.1.52:6379`. + + # + # + # first you need to build the docker-ut image + # using ./contrib/mkimage-unittest.sh + # then + # docker build -t SvenDowideit/ambassador . + # docker tag SvenDowideit/ambassador ambassador + # then to run it (on the host that has the real backend on it) + # docker run -t -i -link redis:redis -name redis_ambassador -p 6379:6379 ambassador + # on the remote host, you can set up another ambassador + # docker run -t -i -name redis_ambassador -expose 6379 sh + + FROM docker-ut + MAINTAINER SvenDowideit@home.org.au + + + CMD env | grep _TCP= | sed 's/.*_PORT_\([0-9]*\)_TCP=tcp:\/\/\(.*\):\(.*\)/socat TCP4-LISTEN:\1,fork,reuseaddr TCP4:\2:\3 \&/' | sh && top diff --git a/docs/sources/use/basics.md b/docs/sources/use/basics.md new file mode 100644 index 0000000000..e283a9dec8 --- /dev/null +++ b/docs/sources/use/basics.md @@ -0,0 +1,176 @@ +page_title: First steps with Docker +page_description: Common usage and commands +page_keywords: Examples, Usage, basic commands, docker, documentation, examples + +# First steps with Docker + +## Check your Docker install + +This guide assumes you have a working installation of Docker. To check +your Docker install, run the following command: + + # Check that you have a working install + docker info + +If you get `docker: command not found` or something +like `/var/lib/docker/repositories: permission denied` +you may have an incomplete docker installation or insufficient +privileges to access Docker on your machine. + +Please refer to [*Installation*](../../installation/#installation-list) +for installation instructions. + +## Download a pre-built image + + # Download an ubuntu image + sudo docker pull ubuntu + +This will find the `ubuntu` image by name in the +[*Central Index*](../workingwithrepository/#searching-central-index) and +download it from the top-level Central Repository to a local image +cache. + +> **Note**: +> When the image has successfully downloaded, you will see a 12 character +> hash `539c0211cd76: Download complete` which is the +> short form of the image ID. These short image IDs are the first 12 +> characters of the full image ID - which can be found using +> `docker inspect` or `docker images --no-trunc=true` + +**If you’re using OS X** then you shouldn’t use `sudo`. + +## Running an interactive shell + + # Run an interactive shell in the ubuntu image, + # allocate a tty, attach stdin and stdout + # To detach the tty without exiting the shell, + # use the escape sequence Ctrl-p + Ctrl-q + # note: This will continue to exist in a stopped state once exited (see "docker ps -a") + sudo docker run -i -t ubuntu /bin/bash + +## Bind Docker to another host/port or a Unix socket + +> **Warning**: +> Changing the default `docker` daemon binding to a +> TCP port or Unix *docker* user group will increase your security risks +> by allowing non-root users to gain *root* access on the host. Make sure +> you control access to `docker`. If you are binding +> to a TCP port, anyone with access to that port has full Docker access; +> so it is not advisable on an open network. + +With `-H` it is possible to make the Docker daemon +to listen on a specific IP and port. By default, it will listen on +`unix:///var/run/docker.sock` to allow only local +connections by the *root* user. You *could* set it to +`0.0.0.0:4243` or a specific host IP to give access +to everybody, but that is **not recommended** because then it is trivial +for someone to gain root access to the host where the daemon is running. + +Similarly, the Docker client can use `-H` to connect +to a custom port. + +`-H` accepts host and port assignment in the +following format: `tcp://[host][:port]` or +`unix://path` + +For example: + +- `tcp://host:4243` -\> tcp connection on + host:4243 +- `unix://path/to/socket` -\> unix socket located + at `path/to/socket` + +`-H`, when empty, will default to the same value as +when no `-H` was passed in. + +`-H` also accepts short form for TCP bindings: +`host[:port]` or `:port` + + # Run docker in daemon mode + sudo /docker -H 0.0.0.0:5555 -d & + # Download an ubuntu image + sudo docker -H :5555 pull ubuntu + +You can use multiple `-H`, for example, if you want +to listen on both TCP and a Unix socket + + # Run docker in daemon mode + sudo /docker -H tcp://127.0.0.1:4243 -H unix:///var/run/docker.sock -d & + # Download an ubuntu image, use default Unix socket + sudo docker pull ubuntu + # OR use the TCP port + sudo docker -H tcp://127.0.0.1:4243 pull ubuntu + +## Starting a long-running worker process + + # Start a very useful long-running process + JOB=$(sudo docker run -d ubuntu /bin/sh -c "while true; do echo Hello world; sleep 1; done") + + # Collect the output of the job so far + sudo docker logs $JOB + + # Kill the job + sudo docker kill $JOB + +## Listing containers + + sudo docker ps # Lists only running containers + sudo docker ps -a # Lists all containers + +## Controlling containers + + # Start a new container + JOB=$(sudo docker run -d ubuntu /bin/sh -c "while true; do echo Hello world; sleep 1; done") + + # Stop the container + docker stop $JOB + + # Start the container + docker start $JOB + + # Restart the container + docker restart $JOB + + # SIGKILL a container + docker kill $JOB + + # Remove a container + docker stop $JOB # Container must be stopped to remove it + docker rm $JOB + +## Bind a service on a TCP port + + # Bind port 4444 of this container, and tell netcat to listen on it + JOB=$(sudo docker run -d -p 4444 ubuntu:12.10 /bin/nc -l 4444) + + # Which public port is NATed to my container? + PORT=$(sudo docker port $JOB 4444 | awk -F: '{ print $2 }') + + # Connect to the public port + echo hello world | nc 127.0.0.1 $PORT + + # Verify that the network connection worked + echo "Daemon received: $(sudo docker logs $JOB)" + +## Committing (saving) a container state + +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 the +`docker images` command. + + # Commit your container to a new named image + sudo docker commit + + # List your containers + sudo docker images + +You now have a image state from which you can create new instances. + +Read more about [*Share Images via +Repositories*](../workingwithrepository/#working-with-the-repository) or +continue to the complete [*Command +Line*](../../reference/commandline/cli/#cli) diff --git a/docs/sources/use/chef.md b/docs/sources/use/chef.md new file mode 100644 index 0000000000..87e3215ced --- /dev/null +++ b/docs/sources/use/chef.md @@ -0,0 +1,74 @@ +page_title: Chef Usage +page_description: Installation and using Docker via Chef +page_keywords: chef, installation, usage, docker, documentation + +# Using Chef + +> **Note**: +> Please note this is a community contributed installation path. The only +> ‘official’ installation is using the +> [*Ubuntu*](../../installation/ubuntulinux/#ubuntu-linux) installation +> path. This version may sometimes be out of date. + +## Requirements + +To use this guide you’ll need a working installation of +[Chef](http://www.getchef.com/). This cookbook supports a variety of +operating systems. + +## Installation + +The cookbook is available on the [Chef Community +Site](community.opscode.com/cookbooks/docker) and can be installed using +your favorite cookbook dependency manager. + +The source can be found on +[GitHub](https://github.com/bflad/chef-docker). + +## Usage + +The cookbook provides recipes for installing Docker, configuring init +for Docker, and resources for managing images and containers. It +supports almost all Docker functionality. + +### Installation + + include_recipe 'docker' + +### Images + +The next step is to pull a Docker image. For this, we have a resource: + + docker_image 'samalba/docker-registry' + +This is equivalent to running: + + docker pull samalba/docker-registry + +There are attributes available to control how long the cookbook will +allow for downloading (5 minute default). + +To remove images you no longer need: + + docker_image 'samalba/docker-registry' do + action :remove + end + +### Containers + +Now you have an image where you can run commands within a container +managed by Docker. + + docker_container 'samalba/docker-registry' do + detach true + port '5000:5000' + env 'SETTINGS_FLAVOR=local' + volume '/mnt/docker:/docker-storage' + end + +This is equivalent to running the following command, but under upstart: + + docker run --detach=true --publish='5000:5000' --env='SETTINGS_FLAVOR=local' --volume='/mnt/docker:/docker-storage' samalba/docker-registry + +The resources will accept a single string or an array of values for any +docker flags that allow multiple values. diff --git a/docs/sources/use/host_integration.md b/docs/sources/use/host_integration.md new file mode 100644 index 0000000000..0aa0dc8314 --- /dev/null +++ b/docs/sources/use/host_integration.md @@ -0,0 +1,63 @@ +page_title: Automatically Start Containers +page_description: How to generate scripts for upstart, systemd, etc. +page_keywords: systemd, upstart, supervisor, docker, documentation, host integration + +# Automatically Start Containers + +You can use your Docker containers with process managers like +`upstart`, `systemd` and +`supervisor`. + +## Introduction + +If you want a process manager to manage your containers you will need to +run the docker daemon with the `-r=false` so that +docker will not automatically restart your containers when the host is +restarted. + +When you have finished setting up your image and are happy with your +running container, you can then attach a process manager to manage it. +When your run `docker start -a` docker will +automatically attach to the running container, or start it if needed and +forward all signals so that the process manager can detect when a +container stops and correctly restart it. + +Here are a few sample scripts for systemd and upstart to integrate with +docker. + +## Sample Upstart Script + +In this example we’ve already created a container to run Redis with +`--name redis_server`. To create an upstart script +for our container, we create a file named +`/etc/init/redis.conf` and place the following into +it: + + description "Redis container" + author "Me" + start on filesystem and started docker + stop on runlevel [!2345] + respawn + script + /usr/bin/docker start -a redis_server + end script + +Next, we have to configure docker so that it’s run with the option +`-r=false`. Run the following command: + + $ sudo sh -c "echo 'DOCKER_OPTS=\"-r=false\"' > /etc/default/docker" + +## Sample systemd Script + + [Unit] + Description=Redis container + Author=Me + After=docker.service + + [Service] + Restart=always + ExecStart=/usr/bin/docker start -a redis_server + ExecStop=/usr/bin/docker stop -t 2 redis_server + + [Install] + WantedBy=local.target diff --git a/docs/sources/use/networking.md b/docs/sources/use/networking.md new file mode 100644 index 0000000000..3dfca0cb94 --- /dev/null +++ b/docs/sources/use/networking.md @@ -0,0 +1,140 @@ +page_title: Configure Networking +page_description: Docker networking +page_keywords: network, networking, bridge, docker, documentation + +# Configure Networking + +## Introduction + +Docker uses Linux bridge capabilities to provide network connectivity to +containers. The `docker0` bridge interface is +managed by Docker for this purpose. When the Docker daemon starts it : + +- creates the `docker0` bridge if not present +- searches for an IP address range which doesn’t overlap with an existing route +- picks an IP in the selected range +- assigns this IP to the `docker0` bridge + + + + # List host bridges + $ sudo brctl show + bridge name bridge id STP enabled interfaces + docker0 8000.000000000000 no + + # Show docker0 IP address + $ sudo ifconfig docker0 + docker0 Link encap:Ethernet HWaddr xx:xx:xx:xx:xx:xx + inet addr:172.17.42.1 Bcast:0.0.0.0 Mask:255.255.0.0 + +At runtime, a [*specific kind of virtual interface*](#vethxxxx-device) +is given to each container which is then bonded to the `docker0` bridge. +Each container also receives a dedicated IP address from the same range +as `docker0`. The `docker0` IP address is used as the default gateway +for the container. + + # Run a container + $ sudo docker run -t -i -d base /bin/bash + 52f811c5d3d69edddefc75aff5a4525fc8ba8bcfa1818132f9dc7d4f7c7e78b4 + + $ sudo brctl show + bridge name bridge id STP enabled interfaces + docker0 8000.fef213db5a66 no vethQCDY1N + +Above, `docker0` acts as a bridge for the `vethQCDY1N` interface which +is dedicated to the 52f811c5d3d6 container. + +## How to use a specific IP address range + +Docker will try hard to find an IP range that is not used by the host. +Even though it works for most cases, it’s not bullet-proof and sometimes +you need to have more control over the IP addressing scheme. + +For this purpose, Docker allows you to manage the `docker0` +bridge or your own one using the `-b=` +parameter. + +In this scenario: + +- ensure Docker is stopped +- create your own bridge (`bridge0` for example) +- assign a specific IP to this bridge +- start Docker with the `-b=bridge0` parameter + + + + # Stop Docker + $ sudo service docker stop + + # Clean docker0 bridge and + # add your very own bridge0 + $ sudo ifconfig docker0 down + $ sudo brctl addbr bridge0 + $ sudo ifconfig bridge0 192.168.227.1 netmask 255.255.255.0 + + # Edit your Docker startup file + $ echo "DOCKER_OPTS=\"-b=bridge0\"" >> /etc/default/docker + + # Start Docker + $ sudo service docker start + + # Ensure bridge0 IP is not changed by Docker + $ sudo ifconfig bridge0 + bridge0 Link encap:Ethernet HWaddr xx:xx:xx:xx:xx:xx + inet addr:192.168.227.1 Bcast:192.168.227.255 Mask:255.255.255.0 + + # Run a container + $ docker run -i -t base /bin/bash + + # Container IP in the 192.168.227/24 range + root@261c272cd7d5:/# ifconfig eth0 + eth0 Link encap:Ethernet HWaddr xx:xx:xx:xx:xx:xx + inet addr:192.168.227.5 Bcast:192.168.227.255 Mask:255.255.255.0 + + # bridge0 IP as the default gateway + root@261c272cd7d5:/# route -n + Kernel IP routing table + Destination Gateway Genmask Flags Metric Ref Use Iface + 0.0.0.0 192.168.227.1 0.0.0.0 UG 0 0 0 eth0 + 192.168.227.0 0.0.0.0 255.255.255.0 U 0 0 0 eth0 + + # hits CTRL+P then CTRL+Q to detach + + # Display bridge info + $ sudo brctl show + bridge name bridge id STP enabled interfaces + bridge0 8000.fe7c2e0faebd no vethAQI2QT + +## Container intercommunication + +The value of the Docker daemon’s `icc` parameter +determines whether containers can communicate with each other over the +bridge network. + +- The default, `-icc=true` allows containers to + communicate with each other. +- `-icc=false` means containers are isolated from + each other. + +Docker uses `iptables` under the hood to either +accept or drop communication between containers. + +## What is the vethXXXX device? + +Well. Things get complicated here. + +The `vethXXXX` interface is the host side of a +point-to-point link between the host and the corresponding container; +the other side of the link is the container’s `eth0` +interface. This pair (host `vethXXX` and container +`eth0`) are connected like a tube. Everything that +comes in one side will come out the other side. + +All the plumbing is delegated to Linux network capabilities (check the +ip link command) and the namespaces infrastructure. + +## I want more + +Jérôme Petazzoni has create `pipework` to connect +together containers in arbitrarily complex scenarios : +[https://github.com/jpetazzo/pipework](https://github.com/jpetazzo/pipework) diff --git a/docs/sources/use/port_redirection.md b/docs/sources/use/port_redirection.md new file mode 100644 index 0000000000..a85234f48f --- /dev/null +++ b/docs/sources/use/port_redirection.md @@ -0,0 +1,137 @@ +page_title: Redirect Ports +page_description: usage about port redirection +page_keywords: Usage, basic port, docker, documentation, examples + +# Redirect Ports + +## Introduction + +Interacting with a service is commonly done through a connection to a +port. When this service runs inside a container, one can connect to the +port after finding the IP address of the container as follows: + + # Find IP address of container with ID + docker inspect | grep IPAddress | cut -d '"' -f 4 + +However, this IP address is local to the host system and the container +port is not reachable by the outside world. Furthermore, even if the +port is used locally, e.g. by another container, this method is tedious +as the IP address of the container changes every time it starts. + +Docker addresses these two problems and give a simple and robust way to +access services running inside containers. + +To allow non-local clients to reach the service running inside the +container, Docker provide ways to bind the container port to an +interface of the host system. To simplify communication between +containers, Docker provides the linking mechanism. + +## Auto map all exposed ports on the host + +To bind all the exposed container ports to the host automatically, use +`docker run -P `. The mapped host ports +will be auto-selected from a pool of unused ports (49000..49900), and +you will need to use `docker ps`, +`docker inspect ` or +`docker port ` to determine +what they are. + +## Binding a port to a host interface + +To bind a port of the container to a specific interface of the host +system, use the `-p` parameter of the +`docker run` command: + + # General syntax + docker run -p [([:[host_port]])|():][/udp] + +When no host interface is provided, the port is bound to all available +interfaces of the host machine (aka INADDR\_ANY, or 0.0.0.0).When no +host port is provided, one is dynamically allocated. The possible +combinations of options for TCP port are the following: + + # Bind TCP port 8080 of the container to TCP port 80 on 127.0.0.1 of the host machine. + docker run -p 127.0.0.1:80:8080 + + # Bind TCP port 8080 of the container to a dynamically allocated TCP port on 127.0.0.1 of the host machine. + docker run -p 127.0.0.1::8080 + + # Bind TCP port 8080 of the container to TCP port 80 on all available interfaces of the host machine. + docker run -p 80:8080 + + # Bind TCP port 8080 of the container to a dynamically allocated TCP port on all available interfaces of the host machine. + docker run -p 8080 + +UDP ports can also be bound by adding a trailing `/udp`. All the +combinations described for TCP work. Here is only one example: + + # Bind UDP port 5353 of the container to UDP port 53 on 127.0.0.1 of the host machine. + docker run -p 127.0.0.1:53:5353/udp + +The command `docker port` lists the interface and +port on the host machine bound to a given container port. It is useful +when using dynamically allocated ports: + + # Bind to a dynamically allocated port + docker run -p 127.0.0.1::8080 --name dyn-bound + + # Lookup the actual port + docker port dyn-bound 8080 + 127.0.0.1:49160 + +## Linking a container + +Communication between two containers can also be established in a +docker-specific way called linking. + +To briefly present the concept of linking, let us consider two +containers: `server`, containing the service, and +`client`, accessing the service. Once +`server` is running, `client` is +started and links to server. Linking sets environment variables in +`client` giving it some information about +`server`. In this sense, linking is a method of +service discovery. + +Let us now get back to our topic of interest; communication between the +two containers. We mentioned that the tricky part about this +communication was that the IP address of `server` +was not fixed. Therefore, some of the environment variables are going to +be used to inform `client` about this IP address. +This process called exposure, is possible because `client` +is started after `server` has been +started. + +Here is a full example. On `server`, the port of +interest is exposed. The exposure is done either through the +`--expose` parameter to the `docker run` +command, or the `EXPOSE` build command in +a Dockerfile: + + # Expose port 80 + docker run --expose 80 --name server + +The `client` then links to the `server`: + + # Link + docker run --name client --link server:linked-server + +`client` locally refers to `server` +as `linked-server`. The following +environment variables, among others, are available on `client`: + + # The default protocol, ip, and port of the service running in the container + LINKED-SERVER_PORT=tcp://172.17.0.8:80 + + # A specific protocol, ip, and port of various services + LINKED-SERVER_PORT_80_TCP=tcp://172.17.0.8:80 + LINKED-SERVER_PORT_80_TCP_PROTO=tcp + LINKED-SERVER_PORT_80_TCP_ADDR=172.17.0.8 + LINKED-SERVER_PORT_80_TCP_PORT=80 + +This tells `client` that a service is running on +port 80 of `server` and that `server` +is accessible at the IP address 172.17.0.8 + +Note: Using the `-p` parameter also exposes the +port.. diff --git a/docs/sources/use/puppet.md b/docs/sources/use/puppet.md new file mode 100644 index 0000000000..55f16dd5bc --- /dev/null +++ b/docs/sources/use/puppet.md @@ -0,0 +1,92 @@ +page_title: Puppet Usage +page_description: Installating and using Puppet +page_keywords: puppet, installation, usage, docker, documentation + +# Using Puppet + +> *Note:* Please note this is a community contributed installation path. The only +> ‘official’ installation is using the +> [*Ubuntu*](../../installation/ubuntulinux/#ubuntu-linux) installation +> path. This version may sometimes be out of date. + +## Requirements + +To use this guide you’ll need a working installation of Puppet from +[Puppetlabs](https://www.puppetlabs.com) . + +The module also currently uses the official PPA so only works with +Ubuntu. + +## Installation + +The module is available on the [Puppet +Forge](https://forge.puppetlabs.com/garethr/docker/) and can be +installed using the built-in module tool. + + puppet module install garethr/docker + +It can also be found on +[GitHub](https://www.github.com/garethr/garethr-docker) if you would +rather download the source. + +## Usage + +The module provides a puppet class for installing Docker and two defined +types for managing images and containers. + +### Installation + + include 'docker' + +### Images + +The next step is probably to install a Docker image. For this, we have a +defined type which can be used like so: + + docker::image { 'ubuntu': } + +This is equivalent to running: + + docker pull ubuntu + +Note that it will only be downloaded if an image of that name does not +already exist. This is downloading a large binary so on first run can +take a while. For that reason this define turns off the default 5 minute +timeout for the exec type. Note that you can also remove images you no +longer need with: + + docker::image { 'ubuntu': + ensure => 'absent', + } + +### Containers + +Now you have an image where you can run commands within a container +managed by Docker. + + docker::run { 'helloworld': + image => 'ubuntu', + command => '/bin/sh -c "while true; do echo hello world; sleep 1; done"', + } + +This is equivalent to running the following command, but under upstart: + + docker run -d ubuntu /bin/sh -c "while true; do echo hello world; sleep 1; done" + +Run also contains a number of optional parameters: + + docker::run { 'helloworld': + image => 'ubuntu', + command => '/bin/sh -c "while true; do echo hello world; sleep 1; done"', + ports => ['4444', '4555'], + volumes => ['/var/lib/couchdb', '/var/log'], + volumes_from => '6446ea52fbc9', + memory_limit => 10485760, # bytes + username => 'example', + hostname => 'example.com', + env => ['FOO=BAR', 'FOO2=BAR2'], + dns => ['8.8.8.8', '8.8.4.4'], + } + +Note that ports, env, dns and volumes can be set with either a single +string or as above with an array of values. diff --git a/docs/sources/use/working_with_links_names.md b/docs/sources/use/working_with_links_names.md new file mode 100644 index 0000000000..67ca8004f1 --- /dev/null +++ b/docs/sources/use/working_with_links_names.md @@ -0,0 +1,119 @@ +page_title: Link Containers +page_description: How to create and use both links and names +page_keywords: Examples, Usage, links, linking, docker, documentation, examples, names, name, container naming + +# Link Containers + +## Introduction + +From version 0.6.5 you are now able to `name` a +container and `link` it to another container by +referring to its name. This will create a parent -\> child relationship +where the parent container can see selected information about its child. + +## Container Naming + +New in version v0.6.5. + +You can now name your container by using the `--name` +flag. If no name is provided, Docker will automatically +generate a name. You can see this name using the `docker ps` +command. + + # format is "sudo docker run --name " + $ sudo docker run --name test ubuntu /bin/bash + + # the flag "-a" Show all containers. Only running containers are shown by default. + $ sudo docker ps -a + CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES + 2522602a0d99 ubuntu:12.04 /bin/bash 14 seconds ago Exit 0 test + +## Links: service discovery for docker + +New in version v0.6.5. + +Links allow containers to discover and securely communicate with each +other by using the flag `-link name:alias`. +Inter-container communication can be disabled with the daemon flag +`-icc=false`. With this flag set to +`false`, Container A cannot access Container B +unless explicitly allowed via a link. This is a huge win for securing +your containers. When two containers are linked together Docker creates +a parent child relationship between the containers. The parent container +will be able to access information via environment variables of the +child such as name, exposed ports, IP and other selected environment +variables. + +When linking two containers Docker will use the exposed ports of the +container to create a secure tunnel for the parent to access. If a +database container only exposes port 8080 then the linked container will +only be allowed to access port 8080 and nothing else if inter-container +communication is set to false. + +For example, there is an image called `crosbymichael/redis` +that exposes the port 6379 and starts the Redis server. Let’s +name the container as `redis` based on that image +and run it as daemon. + + $ sudo docker run -d -name redis crosbymichael/redis + +We can issue all the commands that you would expect using the name +`redis`; start, stop, attach, using the name for our +container. The name also allows us to link other containers into this +one. + +Next, we can start a new web application that has a dependency on Redis +and apply a link to connect both containers. If you noticed when running +our Redis server we did not use the `-p` flag to +publish the Redis port to the host system. Redis exposed port 6379 and +this is all we need to establish a link. + + $ sudo docker run -t -i -link redis:db -name webapp ubuntu bash + +When you specified `-link redis:db` you are telling +Docker to link the container named `redis` into this +new container with the alias `db`. Environment +variables are prefixed with the alias so that the parent container can +access network and environment information from the containers that are +linked into it. + +If we inspect the environment variables of the second container, we +would see all the information about the child container. + + $ root@4c01db0b339c:/# env + + HOSTNAME=4c01db0b339c + DB_NAME=/webapp/db + TERM=xterm + DB_PORT=tcp://172.17.0.8:6379 + DB_PORT_6379_TCP=tcp://172.17.0.8:6379 + DB_PORT_6379_TCP_PROTO=tcp + DB_PORT_6379_TCP_ADDR=172.17.0.8 + DB_PORT_6379_TCP_PORT=6379 + PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin + PWD=/ + SHLVL=1 + HOME=/ + container=lxc + _=/usr/bin/env + root@4c01db0b339c:/# + +Accessing the network information along with the environment of the +child container allows us to easily connect to the Redis service on the +specific IP and port in the environment. + +> **Note**: +> These Environment variables are only set for the first process in the +> container. Similarly, some daemons (such as `sshd`) +> will scrub them when spawning shells for connection. + +You can work around this by storing the initial `env` +in a file, or looking at `/proc/1/environ`. + +Running `docker ps` shows the 2 containers, and the +`webapp/db` alias name for the Redis container. + + $ docker ps + CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES + 4c01db0b339c ubuntu:12.04 bash 17 seconds ago Up 16 seconds webapp + d7886598dbe2 crosbymichael/redis:latest /redis-server --dir 33 minutes ago Up 33 minutes 6379/tcp redis,webapp/db diff --git a/docs/sources/use/working_with_volumes.md b/docs/sources/use/working_with_volumes.md new file mode 100644 index 0000000000..e95d3786b1 --- /dev/null +++ b/docs/sources/use/working_with_volumes.md @@ -0,0 +1,178 @@ +page_title: Share Directories via Volumes +page_description: How to create and share volumes +page_keywords: Examples, Usage, volume, docker, documentation, examples + +# Share Directories via Volumes + +## Introduction + +A *data volume* is a specially-designated directory within one or more +containers that bypasses the [*Union File +System*](../../terms/layer/#ufs-def) to provide several useful features +for persistent or shared data: + +- **Data volumes can be shared and reused between containers:** + This is the feature that makes data volumes so powerful. You can + use it for anything from hot database upgrades to custom backup or + replication tools. See the example below. +- **Changes to a data volume are made directly:** + Without the overhead of a copy-on-write mechanism. This is good for + very large files. +- **Changes to a data volume will not be included at the next commit:** + Because they are not recorded as regular filesystem changes in the + top layer of the [*Union File System*](../../terms/layer/#ufs-def) +- **Volumes persist until no containers use them:** + As they are a reference counted resource. The container does not need to be + running to share its volumes, but running it can help protect it + against accidental removal via `docker rm`. + +Each container can have zero or more data volumes. + +New in version v0.3.0. + +## Getting Started + +Using data volumes is as simple as adding a `-v` +parameter to the `docker run` command. The +`-v` parameter can be used more than once in order +to create more volumes within the new container. To create a new +container with two new volumes: + + $ docker run -v /var/volume1 -v /var/volume2 busybox true + +This command will create the new container with two new volumes that +exits instantly (`true` is pretty much the smallest, +simplest program that you can run). Once created you can mount its +volumes in any other container using the `--volumes-from` +option; irrespective of whether the container is running or +not. + +Or, you can use the VOLUME instruction in a Dockerfile to add one or +more new volumes to any container created from that image: + + # BUILD-USING: docker build -t data . + # RUN-USING: docker run -name DATA data + FROM busybox + VOLUME ["/var/volume1", "/var/volume2"] + CMD ["/bin/true"] + +### Creating and mounting a Data Volume Container + +If you have some persistent data that you want to share between +containers, or want to use from non-persistent containers, its best to +create a named Data Volume Container, and then to mount the data from +it. + +Create a named container with volumes to share (`/var/volume1` +and `/var/volume2`): + + $ docker run -v /var/volume1 -v /var/volume2 -name DATA busybox true + +Then mount those data volumes into your application containers: + + $ docker run -t -i -rm -volumes-from DATA -name client1 ubuntu bash + +You can use multiple `-volumes-from` parameters to +bring together multiple data volumes from multiple containers. + +Interestingly, you can mount the volumes that came from the +`DATA` container in yet another container via the +`client1` middleman container: + + $ docker run -t -i -rm -volumes-from client1 -name client2 ubuntu bash + +This allows you to abstract the actual data source from users of that +data, similar to +[*ambassador\_pattern\_linking*](../ambassador_pattern_linking/#ambassador-pattern-linking). + +If you remove containers that mount volumes, including the initial DATA +container, or the middleman, the volumes will not be deleted until there +are no containers still referencing those volumes. This allows you to +upgrade, or effectively migrate data volumes between containers. + +### Mount a Host Directory as a Container Volume: + + -v=[]: Create a bind mount with: [host-dir]:[container-dir]:[rw|ro]. + +You must specify an absolute path for `host-dir`. If `host-dir` is missing from +the command, then Docker creates a new volume. If `host-dir` is present but +points to a non-existent directory on the host, Docker will automatically +create this directory and use it as the source of the bind-mount. + +Note that this is not available from a Dockerfile due the portability and +sharing purpose of it. The `host-dir` volumes are entirely host-dependent +and might not work on any other machine. + +For example: + + # Usage: + # sudo docker run [OPTIONS] -v /(dir. on host):/(dir. in container):(Read-Write or Read-Only) [ARG..] + # Example: + sudo docker run -i -t -v /var/log:/logs_from_host:ro ubuntu bash + +The command above mounts the host directory `/var/log` into the container +with *read only* permissions as `/logs_from_host`. + +New in version v0.5.0. + +### Note for OS/X users and remote daemon users: + +OS/X users run `boot2docker` to create a minimalist +virtual machine running the docker daemon. That virtual machine then +launches docker commands on behalf of the OS/X command line. The means +that `host directories` refer to directories in the +`boot2docker` virtual machine, not the OS/X +filesystem. + +Similarly, anytime when the docker daemon is on a remote machine, the +`host directories` always refer to directories on +the daemon’s machine. + +### Backup, restore, or migrate data volumes + +You cannot back up volumes using `docker export`, +`docker save` and `docker cp` +because they are external to images. Instead you can use +`--volumes-from` to start a new container that can +access the data-container’s volume. For example: + + $ sudo docker run -rm --volumes-from DATA -v $(pwd):/backup busybox tar cvf /backup/backup.tar /data + +- `-rm` - remove the container when it exits +- `--volumes-from DATA` - attach to the volumes + shared by the `DATA` container +- `-v $(pwd):/backup` - bind mount the current + directory into the container; to write the tar file to +- `busybox` - a small simpler image - good for + quick maintenance +- `tar cvf /backup/backup.tar /data` - creates an + uncompressed tar file of all the files in the `/data` + directory + +Then to restore to the same container, or another that you’ve made +elsewhere: + + # create a new data container + $ sudo docker run -v /data -name DATA2 busybox true + # untar the backup files into the new container᾿s data volume + $ sudo docker run -rm --volumes-from DATA2 -v $(pwd):/backup busybox tar xvf /backup/backup.tar + data/ + data/sven.txt + # compare to the original container + $ sudo docker run -rm --volumes-from DATA -v `pwd`:/backup busybox ls /data + sven.txt + +You can use the basic techniques above to automate backup, migration and +restore testing using your preferred tools. + +## Known Issues + +- [Issue 2702](https://github.com/dotcloud/docker/issues/2702): + "lxc-start: Permission denied - failed to mount" could indicate a + permissions problem with AppArmor. Please see the issue for a + workaround. +- [Issue 2528](https://github.com/dotcloud/docker/issues/2528): the + busybox container is used to make the resulting container as small + and simple as possible - whenever you need to interact with the data + in the volume you mount it into another container. + diff --git a/docs/sources/use/workingwithrepository.md b/docs/sources/use/workingwithrepository.md new file mode 100644 index 0000000000..c71aa60e10 --- /dev/null +++ b/docs/sources/use/workingwithrepository.md @@ -0,0 +1,235 @@ +page_title: Share Images via Repositories +page_description: Repositories allow users to share images. +page_keywords: repo, repositories, usage, pull image, push image, image, documentation + +# Share Images via Repositories + +## Introduction + +A *repository* is a shareable collection of tagged +[*images*](../../terms/image/#image-def) that together create the file +systems for containers. The repository’s name is a label that indicates +the provenance of the repository, i.e. who created it and where the +original copy is located. + +You can find one or more repositories hosted on a *registry*. There can +be an implicit or explicit host name as part of the repository tag. The +implicit registry is located at `index.docker.io`, +the home of "top-level" repositories and the Central Index. This +registry may also include public "user" repositories. + +Docker is not only a tool for creating and managing your own +[*containers*](../../terms/container/#container-def) – **Docker is also +a tool for sharing**. The Docker project provides a Central Registry to +host public repositories, namespaced by user, and a Central Index which +provides user authentication and search over all the public +repositories. You can host your own Registry too! Docker acts as a +client for these services via `docker search, pull, login` +and `push`. + +## Repositories + +### Local Repositories + +Docker images which have been created and labeled on your local Docker +server need to be pushed to a Public or Private registry to be shared. + +### Public Repositories + +There are two types of public repositories: *top-level* repositories +which are controlled by the Docker team, and *user* repositories created +by individual contributors. Anyone can read from these repositories – +they really help people get started quickly! You could also use +[*Trusted Builds*](#trusted-builds) if you need to keep +control of who accesses your images, but we will only refer to public +repositories in these examples. + +- 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 + `/`. This is what your + published images will look like if you push to the public Central + Registry. +- Only the authenticated user can push to their *username* namespace + on the Central Registry. +- User images are not checked, it is therefore up to you whether or + not you trust the creator of this image. + +## Find Public Images on the Central Index + +You can search the Central Index [online](https://index.docker.io) or +using the command line interface. Searching can find images by name, +user name or description: + + $ sudo docker help search + Usage: docker search NAME + + Search the docker index for images + + -notrunc=false: Don᾿t truncate output + $ sudo docker search centos + Found 25 results matching your query ("centos") + NAME DESCRIPTION + centos + slantview/centos-chef-solo CentOS 6.4 with chef-solo. + ... + +There you can see two example results: `centos` and +`slantview/centos-chef-solo`. The second result +shows that it comes from the public repository of a user, +`slantview/`, while the first result +(`centos`) doesn’t explicitly list a repository so +it comes from the trusted Central Repository. The `/` +character separates a user’s repository and the image name. + +Once you have found the image name, you can download it: + + # sudo docker pull + $ sudo docker pull centos + Pulling repository centos + 539c0211cd76: Download complete + +What can you do with that image? Check out the +[*Examples*](../../examples/#example-list) and, when you’re ready with +your own image, come back here to learn how to share it. + +## Contributing to the Central Registry + +Anyone can pull public images from the Central Registry, but if you +would like to share one of your own images, then you must register a +unique user name first. You can create your username and login on the +[central Docker Index online](https://index.docker.io/account/signup/), +or by running + + sudo docker login + +This will prompt you for a username, which will become a public +namespace for your public repositories. + +If your username is available then `docker` will +also prompt you to enter a password and your e-mail address. It will +then automatically log you in. Now you’re ready to commit and push your +own images! + +## Committing a Container to a Named Image + +When you make changes to an existing image, those changes get saved to a +container’s file system. You can then promote that container to become +an image by making a `commit`. In addition to +converting the container to an image, this is also your opportunity to +name the image, specifically a name that includes your user name from +the Central Docker Index (as you did a `login` +above) and a meaningful name for the image. + + # format is "sudo docker commit /" + $ sudo docker commit $CONTAINER_ID myname/kickassapp + +## Pushing a repository to its registry + +In order to push an repository to its registry you need to have named an +image, or committed your container to a named image (see above) + +Now you can push this repository to the registry designated by its name +or tag. + + # format is "docker push /" + $ sudo docker push myname/kickassapp + +## Trusted Builds + +Trusted Builds automate the building and updating of images from GitHub, +directly on `docker.io` servers. It works by adding +a commit hook to your selected repository, triggering a build and update +when you push a commit. + +### To setup a trusted build + +1. Create a [Docker Index account](https://index.docker.io/) and login. +2. Link your GitHub account through the `Link Accounts` + menu. +3. [Configure a Trusted build](https://index.docker.io/builds/). +4. Pick a GitHub project that has a `Dockerfile` + that you want to build. +5. Pick the branch you want to build (the default is the + `master` branch). +6. Give the Trusted Build a name. +7. Assign an optional Docker tag to the Build. +8. Specify where the `Dockerfile` is located. The + default is `/`. + +Once the Trusted Build is configured it will automatically trigger a +build, and in a few minutes, if there are no errors, you will see your +new trusted build on the Docker Index. It will will stay in sync with +your GitHub repo until you deactivate the Trusted Build. + +If you want to see the status of your Trusted Builds you can go to your +[Trusted Builds page](https://index.docker.io/builds/) on the Docker +index, and it will show you the status of your builds, and the build +history. + +Once you’ve created a Trusted Build you can deactivate or delete it. You +cannot however push to a Trusted Build with the `docker push` +command. You can only manage it by committing code to your +GitHub repository. + +You can create multiple Trusted Builds per repository and configure them +to point to specific `Dockerfile`‘s or Git branches. + +## Private Registry + +Private registries and private shared repositories are only possible by +hosting [your own +registry](https://github.com/dotcloud/docker-registry). To push or pull +to a repository on your own registry, you must prefix the tag with the +address of the registry’s host (a `.` or +`:` is used to identify a host), like this: + + # Tag to create a repository with the full registry location. + # The location (e.g. localhost.localdomain:5000) becomes + # a permanent part of the repository name + sudo docker tag 0u812deadbeef localhost.localdomain:5000/repo_name + + # Push the new repository to its home location on localhost + sudo docker push localhost.localdomain:5000/repo_name + +Once a repository has your registry’s host name as part of the tag, you +can push and pull it like any other repository, but it will **not** be +searchable (or indexed at all) in the Central Index, and there will be +no user name checking performed. Your registry will function completely +independently from the Central Index. + + + +See also + +[Docker Blog: How to use your own +registry](http://blog.docker.io/2013/07/how-to-use-your-own-registry/) + +## Authentication File + +The authentication is stored in a json file, `.dockercfg` +located in your home directory. It supports multiple registry +urls. + +`docker login` will create the +"[https://index.docker.io/v1/](https://index.docker.io/v1/)" key. + +`docker login https://my-registry.com` will create +the "[https://my-registry.com](https://my-registry.com)" key. + +For example: + + { + "https://index.docker.io/v1/": { + "auth": "xXxXxXxXxXx=", + "email": "email@example.com" + }, + "https://my-registry.com": { + "auth": "XxXxXxXxXxX=", + "email": "email@my-registry.com" + } + } + +The `auth` field represents +`base64(:)` diff --git a/docs/theme/docker/layout.html b/docs/theme/docker/layout.html index 7d78fb9c3c..0dac9e0680 100755 --- a/docs/theme/docker/layout.html +++ b/docs/theme/docker/layout.html @@ -63,48 +63,6 @@ -
-
-
-
- -
- -
- - -
-
-
- -
- - -
- -
-
-

DOCUMENTATION

-
- - {{ toctree(collapse=False, maxdepth=3) }} -
- -
-
-
-
@@ -114,111 +72,7 @@ {% block body %}{% endblock %} -
Edit this article on GitHub
-
-
- - -
- - - - - - - - - - - - - diff --git a/docs/theme/mkdocs/autoindex.html b/docs/theme/mkdocs/autoindex.html new file mode 100644 index 0000000000..cc4a41ec94 --- /dev/null +++ b/docs/theme/mkdocs/autoindex.html @@ -0,0 +1,12 @@ +# Table of Contents + +{% for nav_item in nav %} + {% if nav_item.children %} +## {{ nav_item.title }} {{ nav_item.url }} + + {% for nav_item in nav_item.children %} +- [{{ nav_item.title }}]({{ nav_item.url }}) + {% endfor %} + + {% endif %} +{% endfor %} diff --git a/docs/theme/mkdocs/base.html b/docs/theme/mkdocs/base.html new file mode 100644 index 0000000000..766afc0c8a --- /dev/null +++ b/docs/theme/mkdocs/base.html @@ -0,0 +1,70 @@ + + + + + + + {% if page_description %}{% endif %} + {% if site_author %}{% endif %} + {% if canonical_url %}{% endif %} + + + + + + + {% if page_title != '**HIDDEN** - '+site_name %}{{ page_title }}{% else %}{{ site_name }}{% endif %} + {% if page_title != '**HIDDEN** - Docker' %}{{ page_title }}{% else %}{{ site_name }}{% endif %} + + + {% if config.google_analytics %} + + {% endif %} + + +
+
+
{% include "nav.html" %}
+
+
+
+
+
+ {% include "toc.html" %} +
+
+ {% include "breadcrumbs.html" %} +
+ {{ content }} +
+
+
+
+
+
+
{% include "footer.html" %}
+
+
+ {% include "prev_next.html" %} + + + + + + + + + diff --git a/docs/theme/mkdocs/breadcrumbs.html b/docs/theme/mkdocs/breadcrumbs.html new file mode 100644 index 0000000000..3dc2dbbafb --- /dev/null +++ b/docs/theme/mkdocs/breadcrumbs.html @@ -0,0 +1,12 @@ +
    +
    2. + {% for section in nav %} + {% if section.active %} +
  2. {{ section.title }}
    3. + {% if section.children %} +
  3. {{ current_page.title }}
    4. + {% endif %} + {% endif %} + {% endfor %} +
  4. Edit on GitHub
    5. +
\ No newline at end of file diff --git a/docs/theme/mkdocs/css/base.css b/docs/theme/mkdocs/css/base.css new file mode 100644 index 0000000000..863c9cdb0b --- /dev/null +++ b/docs/theme/mkdocs/css/base.css @@ -0,0 +1,758 @@ +html, +body { + margin: 0; + font-size: 14px; + background-color: #F0F0F0; + height: 100%; + width: 100%; + font-family: "Cabin", "Helvetica Neue", Helvetica, Arial, sans-serif; +} + +h1, +h2, +h3, +h4, +h5, +h6, +.h1, +.h2, +.h3, +.h4, +.h5, +.h6 { + font-family: "Cabin", "Helvetica Neue", Helvetica, Arial, sans-serif; + font-weight: 500; + line-height: 1.1; + color: #0e6b8d; +} + + +/* Content rendering styles */ +#content { + font-size: 1.2em; + line-height: 1.8em; +} +#content h1 { + padding: 0.5em 0em 0em 0em; +} +#content h2 { + padding: 0.5em 0em 0.3em 0em; + /* Desktop click-to-scroll margin/padding fixes */ + padding-top: 2em !important; + margin-top: -2em !important; + pointer-events:none; +} +#content h3 { + padding: 0.7em 0em 0.3em 0em; +} +#content ul { + margin: 1em 0em 1.2em 0.3em; +} +#content li { + margin: 0.5em 0em 0.3em 0em; +} +#content p { + margin-bottom: 1.2em; +} +#content pre { + margin: 2em 0em; + padding: 1em 2em !important; + line-height: 1.8em; + font-size: 1em; +} +#content blockquote { + background: #f2f2f2; + border-left-color: #ccc; +} +#content blockquote p { + line-height: 1.6em; + margin-bottom: 0em !important; +} +#content .search_input { + height: 30px; + color: #5992a3; + font-weight: bold; + padding: 10px 5px; + border: 1px solid #71afc0; + -webkit-border-radius: 3px; + -moz-border-radius: 3px; + border-radius: 3px; + background: #fff; +} +#content .search_input:focus { + background: #fff; + outline: none; + border-color: #71afc0; +} +#content .search_input::-webkit-input-placeholder { + color: #71afc0; +} +/* Content rendering END */ + +/* Fix bootstrap madding (//padding) issue(s) */ +.row { + margin-left: 0; + margin-right: 0; +} +[class^="col-"] > [class^="col-"]:first-child, +[class^="col-"] > [class*=" col-"]:first-child +[class*=" col-"] > [class^="col-"]:first-child, +[class*=" col-"]> [class*=" col-"]:first-child, +.row > [class^="col-"]:first-child, +.row > [class*=" col-"]:first-child{ + padding-left: 0px; +} +[class^="col-"] > [class^="col-"]:last-child, +[class^="col-"] > [class*=" col-"]:last-child +[class*=" col-"] > [class^="col-"]:last-child, +[class*=" col-"]> [class*=" col-"]:last-child, +.row > [class^="col-"]:last-child, +.row > [class*=" col-"]:last-child{ + padding-right: 0px; +} + + +.navbar { + border: none; +} + +/* Previous & Next floating navigation */ +#nav_prev_next { + position: fixed; + bottom: 0; right: 1em; + background: #fff !important; + border: 1px solid #ccc; + border-bottom: none; + list-style: none; + -webkit-border-radius: 7px 7px 0px 0px; + -moz-border-radius: 7px 7px 0px 0px; + border-radius: 7px 7px 0px 0px; +} +#nav_prev_next > li:hover > a { + background: none; +} +#nav_prev_next > li:hover > a > span { + color: #8fb0ba; +} +#nav_prev_next > li.prev { + text-align: right; +} +#nav_prev_next > li.next { + text-align: left; +} +#nav_prev_next > li > a { + padding: 0.5em 0.7em !important; +} +#nav_prev_next > li > a > span { + display: block; + color: #a4c9d4; +} + +/* Scroll to top button */ +#scroll_to_top { + position: fixed; + bottom: 0; left: 1em; + background: #fff !important; + border: 1px solid #ccc; + border-bottom: none; + list-style: none; + -webkit-border-radius: 7px 7px 0px 0px; + -moz-border-radius: 7px 7px 0px 0px; + border-radius: 7px 7px 0px 0px; + font-weight: bold; +} +#scroll_to_top > li:hover > a { + background: none; +} +#scroll_to_top > li:hover > a > span { + color: #8fb0ba; +} +#scroll_to_top > li.prev { + text-align: right; +} +#scroll_to_top > li.next { + text-align: left; +} +#scroll_to_top > li > a { + padding: 0.5em 0.7em !important; +} +#scroll_to_top > li > a > span { + display: block; + color: #a4c9d4; + min-width: 75px; +} + +/* Top navigation from Docker IO */ +#header { + margin-bottom: 0; + width: 100%; + height: 70px; + z-index: 10; + background-color: #f2f2f2; +} +#header .brand > img { + height: 70px; +} +#header ul li a { + padding: 25px 15px 25px 15px; + color: #777777; +} +#header .navbar-nav { + float: right; +} +#header .navbar-inner { + padding-right: 0px; + padding-left: 0px; +} +#header ul li.active { + color: #555555; + background-color: #d8d8d8; +} +#header ul li.active a:hover { + background-color: #d8d8d8; +} +/* Horizontal Thin Sticky Menu */ +#horizontal_thin_menu { + width: 100%; + background-color: #5992a3; + height: 30px; + color: white; + text-align: right; + padding: 5px 10px; +} +#horizontal_thin_menu a { + display: inline-block; + color: white; + padding: 0px 10px; +} + +/* Submenu (dropdown) styling */ +.dd_menu { + cursor: pointer; +} +.dd_menu .dd_submenu { + display: none; + position: absolute; + top: 50px; + list-style: none; + margin: 0px; + margin-left: -15px; + font-size: 18px; + overflow-y: auto; + background: #fff; + border: 1px solid #ccc; + border-top: none; + border-bottom: 3px solid #ccc; + -webkit-border-radius: 0px 0px 4px 4px; + -moz-border-radius: 0px 0px 4px 4px; + border-radius: 0px 0px 4px 4px; + padding: 0px; +} +.dd_menu.dd_on_hover .dd_submenu { + display: block; +} +.dd_menu.dd_on_hover .dd_submenu > li:first-child { + border: none; +} +.dd_menu.dd_on_hover .dd_submenu > li { + border-top: 1px solid #ddd; +} +.dd_menu.dd_on_hover .dd_submenu > li.active > a { + border-color: #b1d5df; + color: #FF8100 !important; +} +.dd_menu.dd_on_hover .dd_submenu > li:hover { + background: #eee; +} +.dd_menu.dd_on_hover .dd_submenu > li > a { + padding: 0.6em 0.8em 0.4em 0.8em; + width: 100%; + display: block; +} + +/* Main Docs navigaton menu (horizontal) */ +#nav_menu { + position: relative; + width: 100%; + background-color: #71afc0; + padding: 0px 10px; + color: white; +} +#nav_menu > #docsnav > #nav_search_toggle { + display: none; + margin-top: 10px; +} +#nav_menu > #docsnav > #nav_search { + margin-top: 10px; +} +.search_input { + height: 30px; + color: #5992a3; + font-weight: bold; + padding: 10px 5px; + background: #b1d5df; + border: 1px solid #71afc0; + -webkit-border-radius: 3px; + -moz-border-radius: 3px; + border-radius: 3px; +} +.search_input:focus { + background: #fff; + outline: none; +} +.search_input::-webkit-input-placeholder { + color: #71afc0; +} +#nav_menu > #docsnav > #mobile_menu_button { + display: none; + float: left; + height: 50px; + font-size: 1.2em; + padding: 0em 14px; + padding-top: 12px; +} +#nav_menu > #docsnav > .arrow { + display: none; +} +#nav_menu > #docsnav > #main-nav { + height: 50px; + margin: 0px; + padding: 0em; +} +#nav_menu > #docsnav > #main-nav > li { + display: block; + padding: 0em 14px; + height: 100%; + padding-top: 12px; + color: #fff; + font-size: 1.2em; +} +#nav_menu > #docsnav > #main-nav > li.active { + background: #5992a3; +} +#nav_menu > #docsnav > #main-nav > li.dd_on_hover { + background: #b1d5df; + color: #5992a3; +} +#nav_menu > #docsnav > #main-nav > li > span > b { + border-top-color: #b1d5df !important; +} +#nav_menu > #docsnav > #main-nav > li.dd_on_hover > span > b { + border-top-color: #71afc0 !important; +} +#nav_menu > #docsnav > #main-nav > li form { + margin-top: -12px; +} +#nav_menu > #docsnav > #main-nav > li.home > a { + color: #fff; +} +#nav_menu > #docsnav > #main-nav > li.home:hover { + background: #b1d5df; +} +#nav_menu > #docsnav > #main-nav > li.home:hover > a { + color: #5992a3; +} + +/* TOC (Left) */ +#toc_table { + margin-right: 1em; +} +#toc_table > h2 { + margin: 0px; + font-size: 1.7em; + font-weight: bold; + color: #0e6b8d; +} +#toc_table > h2 > a > b { + display: none; + border-top-color: #0e6b8d !important; +} +#toc_table > h3 { + font-size: 1em; + color: #0e6b8d; +} +#toc_table > #toc_navigation { + display: block; + margin-top: 1.5em !important; + background: #fff; + border-bottom: 3px solid #ddd; + border: 1px solid #eee; + -webkit-border-radius: 4px; + -moz-border-radius: 4px; + border-radius: 4px; +} +#toc_table > #toc_navigation > li { + font-size: 1.2em; + padding-bottom: 0px; + padding: 0.2em 0.5em; + border-bottom: 1px solid #ddd; + text-align: left; +} +#toc_table > #toc_navigation > li > a { + padding: 0.4em 0.5em 0.4em 0em; +} +#toc_table > #toc_navigation > li > a:hover { + color: #71afc0; + background: none; + text-decoration: underline; +} +#toc_table > #toc_navigation > li > a > .active_icon { + display: none; + text-decoration: none; + width: 1.5em; + margin-top: 0.2em; +} +#toc_table > #toc_navigation > li.active > a > .active_icon { + display: block; + float: left; +} +#toc_table > #toc_navigation > li > a > .passive_icon { + text-decoration: none; + margin-right: 0.3em; + margin-top: 0.2em; +} +#toc_table > #toc_navigation > li.active > a > .passive_icon { + display: none; + float: left; +} + +#toc_table > #toc_navigation > li.active > a { + color: #FF8100; +} +#toc_table .bs-sidenav { + margin: 0; +} + +/* Main content area */ +#content { + margin-left: -15px; + min-height: 500px; +} +ol.breadcrumb { + margin-left: -15px; + background: #fff; + border-bottom: 3px solid #ccc; +} +ol.breadcrumb > li + li:before { + content: "\3E"; +} +ol.breadcrumb > li:last-child > a { + font-weight: bold; +} +ol.breadcrumb > li.edit-on-github:before { + content: none; +} +ol.breadcrumb > li.edit-on-github a { + color: #FF8100; +} +ol.breadcrumb > li.edit-on-github span { + margin-right: 0.25em; +} +#content h1 { + margin-top: 0px; +} + +/* Footer from original CSSs */ +@media (min-width: 960px) { + #footer { + height: 450px; + } + #footer .container { + max-width: 952px; + } + footer, + .footer { + margin-top: 160px; + } + footer .ligaturesymbols, + .footer .ligaturesymbols { + font-size: 30px; + color: black; + } + footer .ligaturesymbols a, + .footer .ligaturesymbols a { + color: black; + } + footer .footerlist, + .footer .footerlist { + float: left; + margin: 3px; + margin-right: 30px; + } + footer .footer-items-right, + .footer .footer-items-right { + text-align: right; + margin-top: -6px; + float: right; + } + footer .footer-licence, + .footer .footer-licence { + line-height: 2em; + } + footer form, + .footer form { + margin-bottom: 0px; + } + .footer-landscape-image { + bottom: 0; + width: 100%; + margin-bottom: 0; + background-image: url('../img/website-footer_clean.svg'); + background-repeat: repeat-x; + height: 450px; + position: relative; + clear: both + } + .social { + margin-left: 0px; + margin-top: 15px; + } + .social .twitter, + .social .github, + .social .googleplus, + .social .facebook, + .social .slideshare, + .social .linkedin, + .social .flickr, + .social .youtube, + .social .reddit { + background: url("../img/social/docker_social_logos.png") no-repeat transparent; + display: inline-block; + height: 32px; + overflow: hidden; + text-indent: 9999px; + width: 32px; + margin-right: 5px; + } + .social :hover { + -webkit-transform: rotate(-10deg); + -moz-transform: rotate(-10deg); + -o-transform: rotate(-10deg); + -ms-transform: rotate(-10deg); + transform: rotate(-10deg); + } + .social .twitter { + background-position: -160px 0px; + } + .social .reddit { + background-position: -256px 0px; + } + .social .github { + background-position: -64px 0px; + } + .social .googleplus { + background-position: -96px 0px; + } + .social .facebook { + background-position: 0px 0px; + } + .social .slideshare { + background-position: -128px 0px; + } + .social .youtube { + background-position: -192px 0px; + } + .social .flickr { + background-position: -32px 0px; + } + .social .linkedin { + background-position: -224px 0px; + } + ul.unstyled, + ol.unstyled { + margin-left: -40px; + list-style: none; + } +} + +/***************************** +* Mobile CSS Adjustments * +*****************************/ + +/* Horizontal nav. (menu & thin menu) convenience fix for Tablets */ +@media (min-width: 768px) and (max-width: 952px) { + + #docsnav, #horizontal_thin_menu { + width: 100% !important; + } + +} + +@media (max-width: 767px) { + + /* TOC Table (Left) */ + #toc_table { + padding: 1em; + margin: 0em -15px 15px 0em; + -webkit-border-radius: 4px; + -moz-border-radius: 4px; + border-radius: 4px; + cursor: pointer; + background: #fff; + border-bottom: 3px solid #ccc; + } + #toc_table > h2 { + margin-bottom: 0.3em; + font-size: 2em; + } + #toc_table > h2 > a > b { + display: inline-block; + } + #toc_table > h3 { + display: block; + margin: 0; + } + #toc_table > #toc_navigation { + display: none; + margin-top: 1em !important; + border: none; + background: #f2f2f2; + } + #toc_table > #toc_navigation > li > a > .passive_icon { + display: block; + display: inline-block; + } + #toc_table > #toc_navigation > li > a > .active_icon { + display: none; + } + +} + +/* Container responsiveness fixes to maximise realestate expenditure */ +.container { + width: 100% !important; +} +.container-standard-sized { + max-width: 1050px; +} +.container-better { + max-width: 1050px; +} + +@media (max-width: 900px) { + + #nav_menu { + padding-left: 0px !important; + padding-right: 0px !important; + } + + /* Dropdown Submenu adjust */ + .dd_menu .dd_submenu > li > a { + padding: 1em 0.8em 0.7em 0.8em !important; + min-width: 10em; + } + + /* Disable breadcrumbs */ + ol.breadcrumb { + display: none; + } + + /* Shrink main navigation menu to one item (i.e., form breadcrumbs) */ + #nav_menu > #docsnav > #main-nav > li { + display: none; + } + #nav_menu > #docsnav > #main-nav > .dd_menu.active { + display: block; + background: #71afc0; + } + #nav_menu > #docsnav > #main-nav > .dd_menu.active:hover { + background: #b1d5df; + } + #nav_menu > #docsnav > #mobile_menu_button { + display: block; + } + #nav_menu > #docsnav > #mobile_menu_button:hover { + background: #b1d5df; + } + #nav_menu > #docsnav > #mobile_menu_button > b { + border-top-color: #b1d5df !important; + } + #nav_menu > #docsnav > #mobile_menu_button:hover > b { + border-top-color: #71afc0 !important; + } + #nav_menu > #docsnav > .arrow { + display: block; + } + + /* Prev Next for Mobile */ + #nav_prev_next { + background: #f2f2f2; + border-bottom: none; + list-style: none; + -webkit-border-radius: 7px 0px 0px 7px; + -moz-border-radius: 7px 0px 0px 7px; + border-radius: 7px 0px 0px 7px; + border: 1px solid #ccc; + font-weight: bold !important; + } + #nav_prev_next > li > a { + padding: 0.5em 0.7em !important; + } + #nav_prev_next > li > a > span, i { + display: none; + } + + /* Scroll up */ + #scroll_to_top { + background: #f2f2f2; + border-bottom: none; + list-style: none; + -webkit-border-radius: 0px 7px 7px 0px; + -moz-border-radius: 0px 7px 7px 0px; + border-radius: 0px 7px 7px 0px; + border: 1px solid #ccc; + } + #scroll_to_top > li > a { + padding: 0.5em 0.7em !important; + } + #scroll_to_top > li > a > span, i { + display: none; + } + + /* Main Content Clip */ + #content { + max-width: 100%; + } + + /* Thin menu (login - signup) */ + #horizontal_thin_menu { display: none; } + + #header #nav_docker_io { + display: none; + } + + #header #condensed_docker_io_nav { + display: block; + } +} + +@media (min-width: 999px) { + /* Hide in-content search box for desktop */ + #content .search_input { + display: none; + } +} + +@media (max-width: 1025px) { + + /* Search on mobile */ + #nav_menu > #docsnav > #nav_search { + display: none; + } + #nav_menu > #docsnav > #nav_search_toggle { + display: block; + margin-top: 10px; + margin-right: 0.5em; + } + + /* Show in-content search box for desktop */ + #content .search_input { + display: block; + } + + #nav_menu > #docsnav { + padding-left: 0px !important; + padding-right: 0px !important; + } + +} \ No newline at end of file diff --git a/docs/theme/mkdocs/css/bootstrap-custom.css b/docs/theme/mkdocs/css/bootstrap-custom.css new file mode 100644 index 0000000000..6aef1f6fd6 --- /dev/null +++ b/docs/theme/mkdocs/css/bootstrap-custom.css @@ -0,0 +1,7098 @@ +/*! + * Bootstrap v3.0.2 by @fat and @mdo + * Copyright 2013 Twitter, Inc. + * Licensed under http://www.apache.org/licenses/LICENSE-2.0 + * + * Designed and built with all the love in the world by @mdo and @fat. + */ + +/*! normalize.css v2.1.3 | MIT License | git.io/normalize */ + +article, +aside, +details, +figcaption, +figure, +footer, +header, +hgroup, +main, +nav, +section, +summary { + display: block; +} + +audio, +canvas, +video { + display: inline-block; +} + +audio:not([controls]) { + display: none; + height: 0; +} + +[hidden], +template { + display: none; +} + +html { + font-family: sans-serif; + -webkit-text-size-adjust: 100%; + -ms-text-size-adjust: 100%; +} + +body { + margin: 0; +} + +a { + background: transparent; +} + +a:focus { + outline: thin dotted; +} + +a:active, +a:hover { + outline: 0; +} + +h1 { + margin: 0.67em 0; + font-size: 2em; +} + +abbr[title] { + border-bottom: 1px dotted; +} + +b, +strong { + font-weight: bold; +} + +dfn { + font-style: italic; +} + +hr { + height: 0; + -moz-box-sizing: content-box; + box-sizing: content-box; +} + +mark { + color: #000; + background: #ff0; +} + +code, +kbd, +pre, +samp { + font-family: monospace, serif; + font-size: 1em; +} + +pre { + white-space: pre-wrap; +} + +q { + quotes: "\201C" "\201D" "\2018" "\2019"; +} + +small { + font-size: 80%; +} + +sub, +sup { + position: relative; + font-size: 75%; + line-height: 0; + vertical-align: baseline; +} + +sup { + top: -0.5em; +} + +sub { + bottom: -0.25em; +} + +img { + border: 0; +} + +svg:not(:root) { + overflow: hidden; +} + +figure { + margin: 0; +} + +fieldset { + padding: 0.35em 0.625em 0.75em; + margin: 0 2px; + border: 1px solid #c0c0c0; +} + +legend { + padding: 0; + border: 0; +} + +button, +input, +select, +textarea { + margin: 0; + font-family: inherit; + font-size: 100%; +} + +button, +input { + line-height: normal; +} + +button, +select { + text-transform: none; +} + +button, +html input[type="button"], +input[type="reset"], +input[type="submit"] { + cursor: pointer; + -webkit-appearance: button; +} + +button[disabled], +html input[disabled] { + cursor: default; +} + +input[type="checkbox"], +input[type="radio"] { + padding: 0; + box-sizing: border-box; +} + +input[type="search"] { + -webkit-box-sizing: content-box; + -moz-box-sizing: content-box; + box-sizing: content-box; + -webkit-appearance: textfield; +} + +input[type="search"]::-webkit-search-cancel-button, +input[type="search"]::-webkit-search-decoration { + -webkit-appearance: none; +} + +button::-moz-focus-inner, +input::-moz-focus-inner { + padding: 0; + border: 0; +} + +textarea { + overflow: auto; + vertical-align: top; +} + +table { + border-collapse: collapse; + border-spacing: 0; +} + +@media print { + * { + color: #000 !important; + text-shadow: none !important; + background: transparent !important; + box-shadow: none !important; + } + a, + a:visited { + text-decoration: underline; + } + a[href]:after { + content: " (" attr(href) ")"; + } + abbr[title]:after { + content: " (" attr(title) ")"; + } + a[href^="javascript:"]:after, + a[href^="#"]:after { + content: ""; + } + pre, + blockquote { + border: 1px solid #999; + page-break-inside: avoid; + } + thead { + display: table-header-group; + } + tr, + img { + page-break-inside: avoid; + } + img { + max-width: 100% !important; + } + @page { + margin: 2cm .5cm; + } + p, + h2, + h3 { + orphans: 3; + widows: 3; + } + h2, + h3 { + page-break-after: avoid; + } + select { + background: #fff !important; + } + .navbar { + display: none; + } + .table td, + .table th { + background-color: #fff !important; + } + .btn > .caret, + .dropup > .btn > .caret { + border-top-color: #000 !important; + } + .label { + border: 1px solid #000; + } + .table { + border-collapse: collapse !important; + } + .table-bordered th, + .table-bordered td { + border: 1px solid #ddd !important; + } +} + +*, +*:before, +*:after { + -webkit-box-sizing: border-box; + -moz-box-sizing: border-box; + box-sizing: border-box; +} + +html { + font-size: 62.5%; + -webkit-tap-highlight-color: rgba(0, 0, 0, 0); +} + +body { + font-family: "Helvetica Neue", Helvetica, Arial, sans-serif; + font-size: 14px; + line-height: 1.428571429; + color: #333333; + background-color: #ffffff; +} + +input, +button, +select, +textarea { + font-family: inherit; + font-size: inherit; + line-height: inherit; +} + +a { + color: #428bca; + text-decoration: none; +} + +a:hover, +a:focus { + color: #2a6496; + text-decoration: underline; +} + +a:focus { + outline: thin dotted #333; + outline: 5px auto -webkit-focus-ring-color; + outline-offset: -2px; +} + +img { + vertical-align: middle; +} + +.img-responsive { + display: block; + height: auto; + max-width: 100%; +} + +.img-rounded { + border-radius: 6px; +} + +.img-thumbnail { + display: inline-block; + height: auto; + max-width: 100%; + padding: 4px; + line-height: 1.428571429; + background-color: #ffffff; + border: 1px solid #dddddd; + border-radius: 4px; + -webkit-transition: all 0.2s ease-in-out; + transition: all 0.2s ease-in-out; +} + +.img-circle { + border-radius: 50%; +} + +hr { + margin-top: 20px; + margin-bottom: 20px; + border: 0; + border-top: 1px solid #eeeeee; +} + +.sr-only { + position: absolute; + width: 1px; + height: 1px; + padding: 0; + margin: -1px; + overflow: hidden; + clip: rect(0, 0, 0, 0); + border: 0; +} + +p { + margin: 0 0 10px; +} + +.lead { + margin-bottom: 20px; + font-size: 16px; + font-weight: 200; + line-height: 1.4; +} + +@media (min-width: 768px) { + .lead { + font-size: 21px; + } +} + +small, +.small { + font-size: 85%; +} + +cite { + font-style: normal; +} + +.text-muted { + color: #999999; +} + +.text-primary { + color: #428bca; +} + +.text-primary:hover { + color: #3071a9; +} + +.text-warning { + color: #c09853; +} + +.text-warning:hover { + color: #a47e3c; +} + +.text-danger { + color: #b94a48; +} + +.text-danger:hover { + color: #953b39; +} + +.text-success { + color: #468847; +} + +.text-success:hover { + color: #356635; +} + +.text-info { + color: #3a87ad; +} + +.text-info:hover { + color: #2d6987; +} + +.text-left { + text-align: left; +} + +.text-right { + text-align: right; +} + +.text-center { + text-align: center; +} + +h1, +h2, +h3, +h4, +h5, +h6, +.h1, +.h2, +.h3, +.h4, +.h5, +.h6 { + font-family: "Helvetica Neue", Helvetica, Arial, sans-serif; + font-weight: 500; + line-height: 1.1; + color: inherit; +} + +h1 small, +h2 small, +h3 small, +h4 small, +h5 small, +h6 small, +.h1 small, +.h2 small, +.h3 small, +.h4 small, +.h5 small, +.h6 small, +h1 .small, +h2 .small, +h3 .small, +h4 .small, +h5 .small, +h6 .small, +.h1 .small, +.h2 .small, +.h3 .small, +.h4 .small, +.h5 .small, +.h6 .small { + font-weight: normal; + line-height: 1; + color: #999999; +} + +h1, +h2, +h3 { + margin-top: 20px; + margin-bottom: 10px; +} + +h1 small, +h2 small, +h3 small, +h1 .small, +h2 .small, +h3 .small { + font-size: 65%; +} + +h4, +h5, +h6 { + margin-top: 10px; + margin-bottom: 10px; +} + +h4 small, +h5 small, +h6 small, +h4 .small, +h5 .small, +h6 .small { + font-size: 75%; +} + +h1, +.h1 { + font-size: 36px; +} + +h2, +.h2 { + font-size: 30px; +} + +h3, +.h3 { + font-size: 24px; +} + +h4, +.h4 { + font-size: 18px; +} + +h5, +.h5 { + font-size: 14px; +} + +h6, +.h6 { + font-size: 12px; +} + +.page-header { + padding-bottom: 9px; + margin: 40px 0 20px; + border-bottom: 1px solid #eeeeee; +} + +ul, +ol { + margin-top: 0; + margin-bottom: 10px; +} + +ul ul, +ol ul, +ul ol, +ol ol { + margin-bottom: 0; +} + +.list-unstyled { + padding-left: 0; + list-style: none; +} + +.list-inline { + padding-left: 0; + list-style: none; +} + +.list-inline > li { + display: inline-block; + padding-right: 5px; + padding-left: 5px; +} + +.list-inline > li:first-child { + padding-left: 0; +} + +dl { + margin-bottom: 20px; +} + +dt, +dd { + line-height: 1.428571429; +} + +dt { + font-weight: bold; +} + +dd { + margin-left: 0; +} + +@media (min-width: 768px) { + .dl-horizontal dt { + float: left; + width: 160px; + overflow: hidden; + clear: left; + text-align: right; + text-overflow: ellipsis; + white-space: nowrap; + } + .dl-horizontal dd { + margin-left: 180px; + } + .dl-horizontal dd:before, + .dl-horizontal dd:after { + display: table; + content: " "; + } + .dl-horizontal dd:after { + clear: both; + } + .dl-horizontal dd:before, + .dl-horizontal dd:after { + display: table; + content: " "; + } + .dl-horizontal dd:after { + clear: both; + } +} + +abbr[title], +abbr[data-original-title] { + cursor: help; + border-bottom: 1px dotted #999999; +} + +abbr.initialism { + font-size: 90%; + text-transform: uppercase; +} + +blockquote { + padding: 10px 20px; + margin: 0 0 20px; + border-left: 5px solid #eeeeee; +} + +blockquote p { + font-size: 17.5px; + font-weight: 300; + line-height: 1.25; +} + +blockquote p:last-child { + margin-bottom: 0; +} + +blockquote small { + display: block; + line-height: 1.428571429; + color: #999999; +} + +blockquote small:before { + content: '\2014 \00A0'; +} + +blockquote.pull-right { + padding-right: 15px; + padding-left: 0; + border-right: 5px solid #eeeeee; + border-left: 0; +} + +blockquote.pull-right p, +blockquote.pull-right small, +blockquote.pull-right .small { + text-align: right; +} + +blockquote.pull-right small:before, +blockquote.pull-right .small:before { + content: ''; +} + +blockquote.pull-right small:after, +blockquote.pull-right .small:after { + content: '\00A0 \2014'; +} + +blockquote:before, +blockquote:after { + content: ""; +} + +address { + margin-bottom: 20px; + font-style: normal; + line-height: 1.428571429; +} + +code, +kbd, +pre, +samp { + font-family: Monaco, Menlo, Consolas, "Courier New", monospace; +} + +code { + padding: 2px 4px; + font-size: 90%; + color: #c7254e; + white-space: nowrap; + background-color: #f9f2f4; + border-radius: 4px; +} + +pre { + display: block; + padding: 9.5px; + margin: 0 0 10px; + font-size: 13px; + line-height: 1.428571429; + color: #333333; + word-break: break-all; + word-wrap: break-word; + background-color: #f5f5f5; + border: 1px solid #cccccc; + border-radius: 4px; +} + +pre code { + padding: 0; + font-size: inherit; + color: inherit; + white-space: pre-wrap; + background-color: transparent; + border-radius: 0; +} + +.pre-scrollable { + max-height: 340px; + overflow-y: scroll; +} + +.container { + padding-right: 15px; + padding-left: 15px; + margin-right: auto; + margin-left: auto; +} + +.container:before, +.container:after { + display: table; + content: " "; +} + +.container:after { + clear: both; +} + +.container:before, +.container:after { + display: table; + content: " "; +} + +.container:after { + clear: both; +} + +.row { + margin-right: -15px; + margin-left: -15px; +} + +.row:before, +.row:after { + display: table; + content: " "; +} + +.row:after { + clear: both; +} + +.row:before, +.row:after { + display: table; + content: " "; +} + +.row:after { + clear: both; +} + +.col-xs-1, +.col-sm-1, +.col-md-1, +.col-lg-1, +.col-xs-2, +.col-sm-2, +.col-md-2, +.col-lg-2, +.col-xs-3, +.col-sm-3, +.col-md-3, +.col-lg-3, +.col-xs-4, +.col-sm-4, +.col-md-4, +.col-lg-4, +.col-xs-5, +.col-sm-5, +.col-md-5, +.col-lg-5, +.col-xs-6, +.col-sm-6, +.col-md-6, +.col-lg-6, +.col-xs-7, +.col-sm-7, +.col-md-7, +.col-lg-7, +.col-xs-8, +.col-sm-8, +.col-md-8, +.col-lg-8, +.col-xs-9, +.col-sm-9, +.col-md-9, +.col-lg-9, +.col-xs-10, +.col-sm-10, +.col-md-10, +.col-lg-10, +.col-xs-11, +.col-sm-11, +.col-md-11, +.col-lg-11, +.col-xs-12, +.col-sm-12, +.col-md-12, +.col-lg-12 { + position: relative; + min-height: 1px; + padding-right: 15px; + padding-left: 15px; +} + +.col-xs-1, +.col-xs-2, +.col-xs-3, +.col-xs-4, +.col-xs-5, +.col-xs-6, +.col-xs-7, +.col-xs-8, +.col-xs-9, +.col-xs-10, +.col-xs-11 { + float: left; +} + +.col-xs-12 { + width: 100%; +} + +.col-xs-11 { + width: 91.66666666666666%; +} + +.col-xs-10 { + width: 83.33333333333334%; +} + +.col-xs-9 { + width: 75%; +} + +.col-xs-8 { + width: 66.66666666666666%; +} + +.col-xs-7 { + width: 58.333333333333336%; +} + +.col-xs-6 { + width: 50%; +} + +.col-xs-5 { + width: 41.66666666666667%; +} + +.col-xs-4 { + width: 33.33333333333333%; +} + +.col-xs-3 { + width: 25%; +} + +.col-xs-2 { + width: 16.666666666666664%; +} + +.col-xs-1 { + width: 8.333333333333332%; +} + +.col-xs-pull-12 { + right: 100%; +} + +.col-xs-pull-11 { + right: 91.66666666666666%; +} + +.col-xs-pull-10 { + right: 83.33333333333334%; +} + +.col-xs-pull-9 { + right: 75%; +} + +.col-xs-pull-8 { + right: 66.66666666666666%; +} + +.col-xs-pull-7 { + right: 58.333333333333336%; +} + +.col-xs-pull-6 { + right: 50%; +} + +.col-xs-pull-5 { + right: 41.66666666666667%; +} + +.col-xs-pull-4 { + right: 33.33333333333333%; +} + +.col-xs-pull-3 { + right: 25%; +} + +.col-xs-pull-2 { + right: 16.666666666666664%; +} + +.col-xs-pull-1 { + right: 8.333333333333332%; +} + +.col-xs-pull-0 { + right: 0; +} + +.col-xs-push-12 { + left: 100%; +} + +.col-xs-push-11 { + left: 91.66666666666666%; +} + +.col-xs-push-10 { + left: 83.33333333333334%; +} + +.col-xs-push-9 { + left: 75%; +} + +.col-xs-push-8 { + left: 66.66666666666666%; +} + +.col-xs-push-7 { + left: 58.333333333333336%; +} + +.col-xs-push-6 { + left: 50%; +} + +.col-xs-push-5 { + left: 41.66666666666667%; +} + +.col-xs-push-4 { + left: 33.33333333333333%; +} + +.col-xs-push-3 { + left: 25%; +} + +.col-xs-push-2 { + left: 16.666666666666664%; +} + +.col-xs-push-1 { + left: 8.333333333333332%; +} + +.col-xs-push-0 { + left: 0; +} + +.col-xs-offset-12 { + margin-left: 100%; +} + +.col-xs-offset-11 { + margin-left: 91.66666666666666%; +} + +.col-xs-offset-10 { + margin-left: 83.33333333333334%; +} + +.col-xs-offset-9 { + margin-left: 75%; +} + +.col-xs-offset-8 { + margin-left: 66.66666666666666%; +} + +.col-xs-offset-7 { + margin-left: 58.333333333333336%; +} + +.col-xs-offset-6 { + margin-left: 50%; +} + +.col-xs-offset-5 { + margin-left: 41.66666666666667%; +} + +.col-xs-offset-4 { + margin-left: 33.33333333333333%; +} + +.col-xs-offset-3 { + margin-left: 25%; +} + +.col-xs-offset-2 { + margin-left: 16.666666666666664%; +} + +.col-xs-offset-1 { + margin-left: 8.333333333333332%; +} + +.col-xs-offset-0 { + margin-left: 0; +} + +@media (min-width: 768px) { + .container { + width: 750px; + } + .col-sm-1, + .col-sm-2, + .col-sm-3, + .col-sm-4, + .col-sm-5, + .col-sm-6, + .col-sm-7, + .col-sm-8, + .col-sm-9, + .col-sm-10, + .col-sm-11 { + float: left; + } + .col-sm-12 { + width: 100%; + } + .col-sm-11 { + width: 91.66666666666666%; + } + .col-sm-10 { + width: 83.33333333333334%; + } + .col-sm-9 { + width: 75%; + } + .col-sm-8 { + width: 66.66666666666666%; + } + .col-sm-7 { + width: 58.333333333333336%; + } + .col-sm-6 { + width: 50%; + } + .col-sm-5 { + width: 41.66666666666667%; + } + .col-sm-4 { + width: 33.33333333333333%; + } + .col-sm-3 { + width: 25%; + } + .col-sm-2 { + width: 16.666666666666664%; + } + .col-sm-1 { + width: 8.333333333333332%; + } + .col-sm-pull-12 { + right: 100%; + } + .col-sm-pull-11 { + right: 91.66666666666666%; + } + .col-sm-pull-10 { + right: 83.33333333333334%; + } + .col-sm-pull-9 { + right: 75%; + } + .col-sm-pull-8 { + right: 66.66666666666666%; + } + .col-sm-pull-7 { + right: 58.333333333333336%; + } + .col-sm-pull-6 { + right: 50%; + } + .col-sm-pull-5 { + right: 41.66666666666667%; + } + .col-sm-pull-4 { + right: 33.33333333333333%; + } + .col-sm-pull-3 { + right: 25%; + } + .col-sm-pull-2 { + right: 16.666666666666664%; + } + .col-sm-pull-1 { + right: 8.333333333333332%; + } + .col-sm-pull-0 { + right: 0; + } + .col-sm-push-12 { + left: 100%; + } + .col-sm-push-11 { + left: 91.66666666666666%; + } + .col-sm-push-10 { + left: 83.33333333333334%; + } + .col-sm-push-9 { + left: 75%; + } + .col-sm-push-8 { + left: 66.66666666666666%; + } + .col-sm-push-7 { + left: 58.333333333333336%; + } + .col-sm-push-6 { + left: 50%; + } + .col-sm-push-5 { + left: 41.66666666666667%; + } + .col-sm-push-4 { + left: 33.33333333333333%; + } + .col-sm-push-3 { + left: 25%; + } + .col-sm-push-2 { + left: 16.666666666666664%; + } + .col-sm-push-1 { + left: 8.333333333333332%; + } + .col-sm-push-0 { + left: 0; + } + .col-sm-offset-12 { + margin-left: 100%; + } + .col-sm-offset-11 { + margin-left: 91.66666666666666%; + } + .col-sm-offset-10 { + margin-left: 83.33333333333334%; + } + .col-sm-offset-9 { + margin-left: 75%; + } + .col-sm-offset-8 { + margin-left: 66.66666666666666%; + } + .col-sm-offset-7 { + margin-left: 58.333333333333336%; + } + .col-sm-offset-6 { + margin-left: 50%; + } + .col-sm-offset-5 { + margin-left: 41.66666666666667%; + } + .col-sm-offset-4 { + margin-left: 33.33333333333333%; + } + .col-sm-offset-3 { + margin-left: 25%; + } + .col-sm-offset-2 { + margin-left: 16.666666666666664%; + } + .col-sm-offset-1 { + margin-left: 8.333333333333332%; + } + .col-sm-offset-0 { + margin-left: 0; + } +} + +@media (min-width: 992px) { + .container { + width: 970px; + } + .col-md-1, + .col-md-2, + .col-md-3, + .col-md-4, + .col-md-5, + .col-md-6, + .col-md-7, + .col-md-8, + .col-md-9, + .col-md-10, + .col-md-11 { + float: left; + } + .col-md-12 { + width: 100%; + } + .col-md-11 { + width: 91.66666666666666%; + } + .col-md-10 { + width: 83.33333333333334%; + } + .col-md-9 { + width: 75%; + } + .col-md-8 { + width: 66.66666666666666%; + } + .col-md-7 { + width: 58.333333333333336%; + } + .col-md-6 { + width: 50%; + } + .col-md-5 { + width: 41.66666666666667%; + } + .col-md-4 { + width: 33.33333333333333%; + } + .col-md-3 { + width: 25%; + } + .col-md-2 { + width: 16.666666666666664%; + } + .col-md-1 { + width: 8.333333333333332%; + } + .col-md-pull-12 { + right: 100%; + } + .col-md-pull-11 { + right: 91.66666666666666%; + } + .col-md-pull-10 { + right: 83.33333333333334%; + } + .col-md-pull-9 { + right: 75%; + } + .col-md-pull-8 { + right: 66.66666666666666%; + } + .col-md-pull-7 { + right: 58.333333333333336%; + } + .col-md-pull-6 { + right: 50%; + } + .col-md-pull-5 { + right: 41.66666666666667%; + } + .col-md-pull-4 { + right: 33.33333333333333%; + } + .col-md-pull-3 { + right: 25%; + } + .col-md-pull-2 { + right: 16.666666666666664%; + } + .col-md-pull-1 { + right: 8.333333333333332%; + } + .col-md-pull-0 { + right: 0; + } + .col-md-push-12 { + left: 100%; + } + .col-md-push-11 { + left: 91.66666666666666%; + } + .col-md-push-10 { + left: 83.33333333333334%; + } + .col-md-push-9 { + left: 75%; + } + .col-md-push-8 { + left: 66.66666666666666%; + } + .col-md-push-7 { + left: 58.333333333333336%; + } + .col-md-push-6 { + left: 50%; + } + .col-md-push-5 { + left: 41.66666666666667%; + } + .col-md-push-4 { + left: 33.33333333333333%; + } + .col-md-push-3 { + left: 25%; + } + .col-md-push-2 { + left: 16.666666666666664%; + } + .col-md-push-1 { + left: 8.333333333333332%; + } + .col-md-push-0 { + left: 0; + } + .col-md-offset-12 { + margin-left: 100%; + } + .col-md-offset-11 { + margin-left: 91.66666666666666%; + } + .col-md-offset-10 { + margin-left: 83.33333333333334%; + } + .col-md-offset-9 { + margin-left: 75%; + } + .col-md-offset-8 { + margin-left: 66.66666666666666%; + } + .col-md-offset-7 { + margin-left: 58.333333333333336%; + } + .col-md-offset-6 { + margin-left: 50%; + } + .col-md-offset-5 { + margin-left: 41.66666666666667%; + } + .col-md-offset-4 { + margin-left: 33.33333333333333%; + } + .col-md-offset-3 { + margin-left: 25%; + } + .col-md-offset-2 { + margin-left: 16.666666666666664%; + } + .col-md-offset-1 { + margin-left: 8.333333333333332%; + } + .col-md-offset-0 { + margin-left: 0; + } +} + +@media (min-width: 1200px) { + .container { + width: 1170px; + } + .col-lg-1, + .col-lg-2, + .col-lg-3, + .col-lg-4, + .col-lg-5, + .col-lg-6, + .col-lg-7, + .col-lg-8, + .col-lg-9, + .col-lg-10, + .col-lg-11 { + float: left; + } + .col-lg-12 { + width: 100%; + } + .col-lg-11 { + width: 91.66666666666666%; + } + .col-lg-10 { + width: 83.33333333333334%; + } + .col-lg-9 { + width: 75%; + } + .col-lg-8 { + width: 66.66666666666666%; + } + .col-lg-7 { + width: 58.333333333333336%; + } + .col-lg-6 { + width: 50%; + } + .col-lg-5 { + width: 41.66666666666667%; + } + .col-lg-4 { + width: 33.33333333333333%; + } + .col-lg-3 { + width: 25%; + } + .col-lg-2 { + width: 16.666666666666664%; + } + .col-lg-1 { + width: 8.333333333333332%; + } + .col-lg-pull-12 { + right: 100%; + } + .col-lg-pull-11 { + right: 91.66666666666666%; + } + .col-lg-pull-10 { + right: 83.33333333333334%; + } + .col-lg-pull-9 { + right: 75%; + } + .col-lg-pull-8 { + right: 66.66666666666666%; + } + .col-lg-pull-7 { + right: 58.333333333333336%; + } + .col-lg-pull-6 { + right: 50%; + } + .col-lg-pull-5 { + right: 41.66666666666667%; + } + .col-lg-pull-4 { + right: 33.33333333333333%; + } + .col-lg-pull-3 { + right: 25%; + } + .col-lg-pull-2 { + right: 16.666666666666664%; + } + .col-lg-pull-1 { + right: 8.333333333333332%; + } + .col-lg-pull-0 { + right: 0; + } + .col-lg-push-12 { + left: 100%; + } + .col-lg-push-11 { + left: 91.66666666666666%; + } + .col-lg-push-10 { + left: 83.33333333333334%; + } + .col-lg-push-9 { + left: 75%; + } + .col-lg-push-8 { + left: 66.66666666666666%; + } + .col-lg-push-7 { + left: 58.333333333333336%; + } + .col-lg-push-6 { + left: 50%; + } + .col-lg-push-5 { + left: 41.66666666666667%; + } + .col-lg-push-4 { + left: 33.33333333333333%; + } + .col-lg-push-3 { + left: 25%; + } + .col-lg-push-2 { + left: 16.666666666666664%; + } + .col-lg-push-1 { + left: 8.333333333333332%; + } + .col-lg-push-0 { + left: 0; + } + .col-lg-offset-12 { + margin-left: 100%; + } + .col-lg-offset-11 { + margin-left: 91.66666666666666%; + } + .col-lg-offset-10 { + margin-left: 83.33333333333334%; + } + .col-lg-offset-9 { + margin-left: 75%; + } + .col-lg-offset-8 { + margin-left: 66.66666666666666%; + } + .col-lg-offset-7 { + margin-left: 58.333333333333336%; + } + .col-lg-offset-6 { + margin-left: 50%; + } + .col-lg-offset-5 { + margin-left: 41.66666666666667%; + } + .col-lg-offset-4 { + margin-left: 33.33333333333333%; + } + .col-lg-offset-3 { + margin-left: 25%; + } + .col-lg-offset-2 { + margin-left: 16.666666666666664%; + } + .col-lg-offset-1 { + margin-left: 8.333333333333332%; + } + .col-lg-offset-0 { + margin-left: 0; + } +} + +table { + max-width: 100%; + background-color: transparent; +} + +th { + text-align: left; +} + +.table { + width: 100%; + margin-bottom: 20px; +} + +.table > thead > tr > th, +.table > tbody > tr > th, +.table > tfoot > tr > th, +.table > thead > tr > td, +.table > tbody > tr > td, +.table > tfoot > tr > td { + padding: 8px; + line-height: 1.428571429; + vertical-align: top; + border-top: 1px solid #dddddd; +} + +.table > thead > tr > th { + vertical-align: bottom; + border-bottom: 2px solid #dddddd; +} + +.table > caption + thead > tr:first-child > th, +.table > colgroup + thead > tr:first-child > th, +.table > thead:first-child > tr:first-child > th, +.table > caption + thead > tr:first-child > td, +.table > colgroup + thead > tr:first-child > td, +.table > thead:first-child > tr:first-child > td { + border-top: 0; +} + +.table > tbody + tbody { + border-top: 2px solid #dddddd; +} + +.table .table { + background-color: #ffffff; +} + +.table-condensed > thead > tr > th, +.table-condensed > tbody > tr > th, +.table-condensed > tfoot > tr > th, +.table-condensed > thead > tr > td, +.table-condensed > tbody > tr > td, +.table-condensed > tfoot > tr > td { + padding: 5px; +} + +.table-bordered { + border: 1px solid #dddddd; +} + +.table-bordered > thead > tr > th, +.table-bordered > tbody > tr > th, +.table-bordered > tfoot > tr > th, +.table-bordered > thead > tr > td, +.table-bordered > tbody > tr > td, +.table-bordered > tfoot > tr > td { + border: 1px solid #dddddd; +} + +.table-bordered > thead > tr > th, +.table-bordered > thead > tr > td { + border-bottom-width: 2px; +} + +.table-striped > tbody > tr:nth-child(odd) > td, +.table-striped > tbody > tr:nth-child(odd) > th { + background-color: #f9f9f9; +} + +.table-hover > tbody > tr:hover > td, +.table-hover > tbody > tr:hover > th { + background-color: #f5f5f5; +} + +table col[class*="col-"] { + display: table-column; + float: none; +} + +table td[class*="col-"], +table th[class*="col-"] { + display: table-cell; + float: none; +} + +.table > thead > tr > td.active, +.table > tbody > tr > td.active, +.table > tfoot > tr > td.active, +.table > thead > tr > th.active, +.table > tbody > tr > th.active, +.table > tfoot > tr > th.active, +.table > thead > tr.active > td, +.table > tbody > tr.active > td, +.table > tfoot > tr.active > td, +.table > thead > tr.active > th, +.table > tbody > tr.active > th, +.table > tfoot > tr.active > th { + background-color: #f5f5f5; +} + +.table > thead > tr > td.success, +.table > tbody > tr > td.success, +.table > tfoot > tr > td.success, +.table > thead > tr > th.success, +.table > tbody > tr > th.success, +.table > tfoot > tr > th.success, +.table > thead > tr.success > td, +.table > tbody > tr.success > td, +.table > tfoot > tr.success > td, +.table > thead > tr.success > th, +.table > tbody > tr.success > th, +.table > tfoot > tr.success > th { + background-color: #dff0d8; +} + +.table-hover > tbody > tr > td.success:hover, +.table-hover > tbody > tr > th.success:hover, +.table-hover > tbody > tr.success:hover > td, +.table-hover > tbody > tr.success:hover > th { + background-color: #d0e9c6; +} + +.table > thead > tr > td.danger, +.table > tbody > tr > td.danger, +.table > tfoot > tr > td.danger, +.table > thead > tr > th.danger, +.table > tbody > tr > th.danger, +.table > tfoot > tr > th.danger, +.table > thead > tr.danger > td, +.table > tbody > tr.danger > td, +.table > tfoot > tr.danger > td, +.table > thead > tr.danger > th, +.table > tbody > tr.danger > th, +.table > tfoot > tr.danger > th { + background-color: #f2dede; +} + +.table-hover > tbody > tr > td.danger:hover, +.table-hover > tbody > tr > th.danger:hover, +.table-hover > tbody > tr.danger:hover > td, +.table-hover > tbody > tr.danger:hover > th { + background-color: #ebcccc; +} + +.table > thead > tr > td.warning, +.table > tbody > tr > td.warning, +.table > tfoot > tr > td.warning, +.table > thead > tr > th.warning, +.table > tbody > tr > th.warning, +.table > tfoot > tr > th.warning, +.table > thead > tr.warning > td, +.table > tbody > tr.warning > td, +.table > tfoot > tr.warning > td, +.table > thead > tr.warning > th, +.table > tbody > tr.warning > th, +.table > tfoot > tr.warning > th { + background-color: #fcf8e3; +} + +.table-hover > tbody > tr > td.warning:hover, +.table-hover > tbody > tr > th.warning:hover, +.table-hover > tbody > tr.warning:hover > td, +.table-hover > tbody > tr.warning:hover > th { + background-color: #faf2cc; +} + +@media (max-width: 767px) { + .table-responsive { + width: 100%; + margin-bottom: 15px; + overflow-x: scroll; + overflow-y: hidden; + border: 1px solid #dddddd; + -ms-overflow-style: -ms-autohiding-scrollbar; + -webkit-overflow-scrolling: touch; + } + .table-responsive > .table { + margin-bottom: 0; + } + .table-responsive > .table > thead > tr > th, + .table-responsive > .table > tbody > tr > th, + .table-responsive > .table > tfoot > tr > th, + .table-responsive > .table > thead > tr > td, + .table-responsive > .table > tbody > tr > td, + .table-responsive > .table > tfoot > tr > td { + white-space: nowrap; + } + .table-responsive > .table-bordered { + border: 0; + } + .table-responsive > .table-bordered > thead > tr > th:first-child, + .table-responsive > .table-bordered > tbody > tr > th:first-child, + .table-responsive > .table-bordered > tfoot > tr > th:first-child, + .table-responsive > .table-bordered > thead > tr > td:first-child, + .table-responsive > .table-bordered > tbody > tr > td:first-child, + .table-responsive > .table-bordered > tfoot > tr > td:first-child { + border-left: 0; + } + .table-responsive > .table-bordered > thead > tr > th:last-child, + .table-responsive > .table-bordered > tbody > tr > th:last-child, + .table-responsive > .table-bordered > tfoot > tr > th:last-child, + .table-responsive > .table-bordered > thead > tr > td:last-child, + .table-responsive > .table-bordered > tbody > tr > td:last-child, + .table-responsive > .table-bordered > tfoot > tr > td:last-child { + border-right: 0; + } + .table-responsive > .table-bordered > tbody > tr:last-child > th, + .table-responsive > .table-bordered > tfoot > tr:last-child > th, + .table-responsive > .table-bordered > tbody > tr:last-child > td, + .table-responsive > .table-bordered > tfoot > tr:last-child > td { + border-bottom: 0; + } +} + +fieldset { + padding: 0; + margin: 0; + border: 0; +} + +legend { + display: block; + width: 100%; + padding: 0; + margin-bottom: 20px; + font-size: 21px; + line-height: inherit; + color: #333333; + border: 0; + border-bottom: 1px solid #e5e5e5; +} + +label { + display: inline-block; + margin-bottom: 5px; + font-weight: bold; +} + +input[type="search"] { + -webkit-box-sizing: border-box; + -moz-box-sizing: border-box; + box-sizing: border-box; +} + +input[type="radio"], +input[type="checkbox"] { + margin: 4px 0 0; + margin-top: 1px \9; + /* IE8-9 */ + + line-height: normal; +} + +input[type="file"] { + display: block; +} + +select[multiple], +select[size] { + height: auto; +} + +select optgroup { + font-family: inherit; + font-size: inherit; + font-style: inherit; +} + +input[type="file"]:focus, +input[type="radio"]:focus, +input[type="checkbox"]:focus { + outline: thin dotted #333; + outline: 5px auto -webkit-focus-ring-color; + outline-offset: -2px; +} + +input[type="number"]::-webkit-outer-spin-button, +input[type="number"]::-webkit-inner-spin-button { + height: auto; +} + +output { + display: block; + padding-top: 7px; + font-size: 14px; + line-height: 1.428571429; + color: #555555; + vertical-align: middle; +} + +.form-control { + display: block; + width: 100%; + height: 34px; + padding: 6px 12px; + font-size: 14px; + line-height: 1.428571429; + color: #555555; + vertical-align: middle; + background-color: #ffffff; + background-image: none; + border: 1px solid #cccccc; + border-radius: 4px; + -webkit-box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075); + box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075); + -webkit-transition: border-color ease-in-out 0.15s, box-shadow ease-in-out 0.15s; + transition: border-color ease-in-out 0.15s, box-shadow ease-in-out 0.15s; +} + +.form-control:focus { + border-color: #66afe9; + outline: 0; + -webkit-box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075), 0 0 8px rgba(102, 175, 233, 0.6); + box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075), 0 0 8px rgba(102, 175, 233, 0.6); +} + +.form-control:-moz-placeholder { + color: #999999; +} + +.form-control::-moz-placeholder { + color: #999999; +} + +.form-control:-ms-input-placeholder { + color: #999999; +} + +.form-control::-webkit-input-placeholder { + color: #999999; +} + +.form-control[disabled], +.form-control[readonly], +fieldset[disabled] .form-control { + cursor: not-allowed; + background-color: #eeeeee; +} + +textarea.form-control { + height: auto; +} + +.form-group { + margin-bottom: 15px; +} + +.radio, +.checkbox { + display: block; + min-height: 20px; + padding-left: 20px; + margin-top: 10px; + margin-bottom: 10px; + vertical-align: middle; +} + +.radio label, +.checkbox label { + display: inline; + margin-bottom: 0; + font-weight: normal; + cursor: pointer; +} + +.radio input[type="radio"], +.radio-inline input[type="radio"], +.checkbox input[type="checkbox"], +.checkbox-inline input[type="checkbox"] { + float: left; + margin-left: -20px; +} + +.radio + .radio, +.checkbox + .checkbox { + margin-top: -5px; +} + +.radio-inline, +.checkbox-inline { + display: inline-block; + padding-left: 20px; + margin-bottom: 0; + font-weight: normal; + vertical-align: middle; + cursor: pointer; +} + +.radio-inline + .radio-inline, +.checkbox-inline + .checkbox-inline { + margin-top: 0; + margin-left: 10px; +} + +input[type="radio"][disabled], +input[type="checkbox"][disabled], +.radio[disabled], +.radio-inline[disabled], +.checkbox[disabled], +.checkbox-inline[disabled], +fieldset[disabled] input[type="radio"], +fieldset[disabled] input[type="checkbox"], +fieldset[disabled] .radio, +fieldset[disabled] .radio-inline, +fieldset[disabled] .checkbox, +fieldset[disabled] .checkbox-inline { + cursor: not-allowed; +} + +.input-sm { + height: 30px; + padding: 5px 10px; + font-size: 12px; + line-height: 1.5; + border-radius: 3px; +} + +select.input-sm { + height: 30px; + line-height: 30px; +} + +textarea.input-sm { + height: auto; +} + +.input-lg { + height: 45px; + padding: 10px 16px; + font-size: 18px; + line-height: 1.33; + border-radius: 6px; +} + +select.input-lg { + height: 45px; + line-height: 45px; +} + +textarea.input-lg { + height: auto; +} + +.has-warning .help-block, +.has-warning .control-label, +.has-warning .radio, +.has-warning .checkbox, +.has-warning .radio-inline, +.has-warning .checkbox-inline { + color: #c09853; +} + +.has-warning .form-control { + border-color: #c09853; + -webkit-box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075); + box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075); +} + +.has-warning .form-control:focus { + border-color: #a47e3c; + -webkit-box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075), 0 0 6px #dbc59e; + box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075), 0 0 6px #dbc59e; +} + +.has-warning .input-group-addon { + color: #c09853; + background-color: #fcf8e3; + border-color: #c09853; +} + +.has-error .help-block, +.has-error .control-label, +.has-error .radio, +.has-error .checkbox, +.has-error .radio-inline, +.has-error .checkbox-inline { + color: #b94a48; +} + +.has-error .form-control { + border-color: #b94a48; + -webkit-box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075); + box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075); +} + +.has-error .form-control:focus { + border-color: #953b39; + -webkit-box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075), 0 0 6px #d59392; + box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075), 0 0 6px #d59392; +} + +.has-error .input-group-addon { + color: #b94a48; + background-color: #f2dede; + border-color: #b94a48; +} + +.has-success .help-block, +.has-success .control-label, +.has-success .radio, +.has-success .checkbox, +.has-success .radio-inline, +.has-success .checkbox-inline { + color: #468847; +} + +.has-success .form-control { + border-color: #468847; + -webkit-box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075); + box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075); +} + +.has-success .form-control:focus { + border-color: #356635; + -webkit-box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075), 0 0 6px #7aba7b; + box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075), 0 0 6px #7aba7b; +} + +.has-success .input-group-addon { + color: #468847; + background-color: #dff0d8; + border-color: #468847; +} + +.form-control-static { + margin-bottom: 0; +} + +.help-block { + display: block; + margin-top: 5px; + margin-bottom: 10px; + color: #737373; +} + +@media (min-width: 768px) { + .form-inline .form-group { + display: inline-block; + margin-bottom: 0; + vertical-align: middle; + } + .form-inline .form-control { + display: inline-block; + } + .form-inline .radio, + .form-inline .checkbox { + display: inline-block; + padding-left: 0; + margin-top: 0; + margin-bottom: 0; + } + .form-inline .radio input[type="radio"], + .form-inline .checkbox input[type="checkbox"] { + float: none; + margin-left: 0; + } +} + +.form-horizontal .control-label, +.form-horizontal .radio, +.form-horizontal .checkbox, +.form-horizontal .radio-inline, +.form-horizontal .checkbox-inline { + padding-top: 7px; + margin-top: 0; + margin-bottom: 0; +} + +.form-horizontal .form-group { + margin-right: -15px; + margin-left: -15px; +} + +.form-horizontal .form-group:before, +.form-horizontal .form-group:after { + display: table; + content: " "; +} + +.form-horizontal .form-group:after { + clear: both; +} + +.form-horizontal .form-group:before, +.form-horizontal .form-group:after { + display: table; + content: " "; +} + +.form-horizontal .form-group:after { + clear: both; +} + +.form-horizontal .form-control-static { + padding-top: 7px; +} + +@media (min-width: 768px) { + .form-horizontal .control-label { + text-align: right; + } +} + +.btn { + display: inline-block; + padding: 6px 12px; + margin-bottom: 0; + font-size: 14px; + font-weight: normal; + line-height: 1.428571429; + text-align: center; + white-space: nowrap; + vertical-align: middle; + cursor: pointer; + background-image: none; + border: 1px solid transparent; + border-radius: 4px; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + -o-user-select: none; + user-select: none; +} + +.btn:focus { + outline: thin dotted #333; + outline: 5px auto -webkit-focus-ring-color; + outline-offset: -2px; +} + +.btn:hover, +.btn:focus { + color: #333333; + text-decoration: none; +} + +.btn:active, +.btn.active { + background-image: none; + outline: 0; + -webkit-box-shadow: inset 0 3px 5px rgba(0, 0, 0, 0.125); + box-shadow: inset 0 3px 5px rgba(0, 0, 0, 0.125); +} + +.btn.disabled, +.btn[disabled], +fieldset[disabled] .btn { + pointer-events: none; + cursor: not-allowed; + opacity: 0.65; + filter: alpha(opacity=65); + -webkit-box-shadow: none; + box-shadow: none; +} + +.btn-default { + color: #333333; + background-color: #ffffff; + border-color: #cccccc; +} + +.btn-default:hover, +.btn-default:focus, +.btn-default:active, +.btn-default.active, +.open .dropdown-toggle.btn-default { + color: #333333; + background-color: #ebebeb; + border-color: #adadad; +} + +.btn-default:active, +.btn-default.active, +.open .dropdown-toggle.btn-default { + background-image: none; +} + +.btn-default.disabled, +.btn-default[disabled], +fieldset[disabled] .btn-default, +.btn-default.disabled:hover, +.btn-default[disabled]:hover, +fieldset[disabled] .btn-default:hover, +.btn-default.disabled:focus, +.btn-default[disabled]:focus, +fieldset[disabled] .btn-default:focus, +.btn-default.disabled:active, +.btn-default[disabled]:active, +fieldset[disabled] .btn-default:active, +.btn-default.disabled.active, +.btn-default[disabled].active, +fieldset[disabled] .btn-default.active { + background-color: #ffffff; + border-color: #cccccc; +} + +.btn-primary { + color: #ffffff; + background-color: #428bca; + border-color: #357ebd; +} + +.btn-primary:hover, +.btn-primary:focus, +.btn-primary:active, +.btn-primary.active, +.open .dropdown-toggle.btn-primary { + color: #ffffff; + background-color: #3276b1; + border-color: #285e8e; +} + +.btn-primary:active, +.btn-primary.active, +.open .dropdown-toggle.btn-primary { + background-image: none; +} + +.btn-primary.disabled, +.btn-primary[disabled], +fieldset[disabled] .btn-primary, +.btn-primary.disabled:hover, +.btn-primary[disabled]:hover, +fieldset[disabled] .btn-primary:hover, +.btn-primary.disabled:focus, +.btn-primary[disabled]:focus, +fieldset[disabled] .btn-primary:focus, +.btn-primary.disabled:active, +.btn-primary[disabled]:active, +fieldset[disabled] .btn-primary:active, +.btn-primary.disabled.active, +.btn-primary[disabled].active, +fieldset[disabled] .btn-primary.active { + background-color: #428bca; + border-color: #357ebd; +} + +.btn-warning { + color: #ffffff; + background-color: #f0ad4e; + border-color: #eea236; +} + +.btn-warning:hover, +.btn-warning:focus, +.btn-warning:active, +.btn-warning.active, +.open .dropdown-toggle.btn-warning { + color: #ffffff; + background-color: #ed9c28; + border-color: #d58512; +} + +.btn-warning:active, +.btn-warning.active, +.open .dropdown-toggle.btn-warning { + background-image: none; +} + +.btn-warning.disabled, +.btn-warning[disabled], +fieldset[disabled] .btn-warning, +.btn-warning.disabled:hover, +.btn-warning[disabled]:hover, +fieldset[disabled] .btn-warning:hover, +.btn-warning.disabled:focus, +.btn-warning[disabled]:focus, +fieldset[disabled] .btn-warning:focus, +.btn-warning.disabled:active, +.btn-warning[disabled]:active, +fieldset[disabled] .btn-warning:active, +.btn-warning.disabled.active, +.btn-warning[disabled].active, +fieldset[disabled] .btn-warning.active { + background-color: #f0ad4e; + border-color: #eea236; +} + +.btn-danger { + color: #ffffff; + background-color: #d9534f; + border-color: #d43f3a; +} + +.btn-danger:hover, +.btn-danger:focus, +.btn-danger:active, +.btn-danger.active, +.open .dropdown-toggle.btn-danger { + color: #ffffff; + background-color: #d2322d; + border-color: #ac2925; +} + +.btn-danger:active, +.btn-danger.active, +.open .dropdown-toggle.btn-danger { + background-image: none; +} + +.btn-danger.disabled, +.btn-danger[disabled], +fieldset[disabled] .btn-danger, +.btn-danger.disabled:hover, +.btn-danger[disabled]:hover, +fieldset[disabled] .btn-danger:hover, +.btn-danger.disabled:focus, +.btn-danger[disabled]:focus, +fieldset[disabled] .btn-danger:focus, +.btn-danger.disabled:active, +.btn-danger[disabled]:active, +fieldset[disabled] .btn-danger:active, +.btn-danger.disabled.active, +.btn-danger[disabled].active, +fieldset[disabled] .btn-danger.active { + background-color: #d9534f; + border-color: #d43f3a; +} + +.btn-success { + color: #ffffff; + background-color: #5cb85c; + border-color: #4cae4c; +} + +.btn-success:hover, +.btn-success:focus, +.btn-success:active, +.btn-success.active, +.open .dropdown-toggle.btn-success { + color: #ffffff; + background-color: #47a447; + border-color: #398439; +} + +.btn-success:active, +.btn-success.active, +.open .dropdown-toggle.btn-success { + background-image: none; +} + +.btn-success.disabled, +.btn-success[disabled], +fieldset[disabled] .btn-success, +.btn-success.disabled:hover, +.btn-success[disabled]:hover, +fieldset[disabled] .btn-success:hover, +.btn-success.disabled:focus, +.btn-success[disabled]:focus, +fieldset[disabled] .btn-success:focus, +.btn-success.disabled:active, +.btn-success[disabled]:active, +fieldset[disabled] .btn-success:active, +.btn-success.disabled.active, +.btn-success[disabled].active, +fieldset[disabled] .btn-success.active { + background-color: #5cb85c; + border-color: #4cae4c; +} + +.btn-info { + color: #ffffff; + background-color: #5bc0de; + border-color: #46b8da; +} + +.btn-info:hover, +.btn-info:focus, +.btn-info:active, +.btn-info.active, +.open .dropdown-toggle.btn-info { + color: #ffffff; + background-color: #39b3d7; + border-color: #269abc; +} + +.btn-info:active, +.btn-info.active, +.open .dropdown-toggle.btn-info { + background-image: none; +} + +.btn-info.disabled, +.btn-info[disabled], +fieldset[disabled] .btn-info, +.btn-info.disabled:hover, +.btn-info[disabled]:hover, +fieldset[disabled] .btn-info:hover, +.btn-info.disabled:focus, +.btn-info[disabled]:focus, +fieldset[disabled] .btn-info:focus, +.btn-info.disabled:active, +.btn-info[disabled]:active, +fieldset[disabled] .btn-info:active, +.btn-info.disabled.active, +.btn-info[disabled].active, +fieldset[disabled] .btn-info.active { + background-color: #5bc0de; + border-color: #46b8da; +} + +.btn-link { + font-weight: normal; + color: #428bca; + cursor: pointer; + border-radius: 0; +} + +.btn-link, +.btn-link:active, +.btn-link[disabled], +fieldset[disabled] .btn-link { + background-color: transparent; + -webkit-box-shadow: none; + box-shadow: none; +} + +.btn-link, +.btn-link:hover, +.btn-link:focus, +.btn-link:active { + border-color: transparent; +} + +.btn-link:hover, +.btn-link:focus { + color: #2a6496; + text-decoration: underline; + background-color: transparent; +} + +.btn-link[disabled]:hover, +fieldset[disabled] .btn-link:hover, +.btn-link[disabled]:focus, +fieldset[disabled] .btn-link:focus { + color: #999999; + text-decoration: none; +} + +.btn-lg { + padding: 10px 16px; + font-size: 18px; + line-height: 1.33; + border-radius: 6px; +} + +.btn-sm, +.btn-xs { + padding: 5px 10px; + font-size: 12px; + line-height: 1.5; + border-radius: 3px; +} + +.btn-xs { + padding: 1px 5px; +} + +.btn-block { + display: block; + width: 100%; + padding-right: 0; + padding-left: 0; +} + +.btn-block + .btn-block { + margin-top: 5px; +} + +input[type="submit"].btn-block, +input[type="reset"].btn-block, +input[type="button"].btn-block { + width: 100%; +} + +.fade { + opacity: 0; + -webkit-transition: opacity 0.15s linear; + transition: opacity 0.15s linear; +} + +.fade.in { + opacity: 1; +} + +.collapse { + display: none; +} + +.collapse.in { + display: block; +} + +.collapsing { + position: relative; + height: 0; + overflow: hidden; + -webkit-transition: height 0.35s ease; + transition: height 0.35s ease; +} + +@font-face { + font-family: 'Glyphicons Halflings'; + src: url('../fonts/glyphicons-halflings-regular.eot'); + src: url('../fonts/glyphicons-halflings-regular.eot?#iefix') format('embedded-opentype'), url('../fonts/glyphicons-halflings-regular.woff') format('woff'), url('../fonts/glyphicons-halflings-regular.ttf') format('truetype'), url('../fonts/glyphicons-halflings-regular.svg#glyphicons_halflingsregular') format('svg'); +} + +.glyphicon { + position: relative; + top: 1px; + display: inline-block; + font-family: 'Glyphicons Halflings'; + -webkit-font-smoothing: antialiased; + font-style: normal; + font-weight: normal; + line-height: 1; + -moz-osx-font-smoothing: grayscale; +} + +.glyphicon:empty { + width: 1em; +} + +.glyphicon-asterisk:before { + content: "\2a"; +} + +.glyphicon-plus:before { + content: "\2b"; +} + +.glyphicon-euro:before { + content: "\20ac"; +} + +.glyphicon-minus:before { + content: "\2212"; +} + +.glyphicon-cloud:before { + content: "\2601"; +} + +.glyphicon-envelope:before { + content: "\2709"; +} + +.glyphicon-pencil:before { + content: "\270f"; +} + +.glyphicon-glass:before { + content: "\e001"; +} + +.glyphicon-music:before { + content: "\e002"; +} + +.glyphicon-search:before { + content: "\e003"; +} + +.glyphicon-heart:before { + content: "\e005"; +} + +.glyphicon-star:before { + content: "\e006"; +} + +.glyphicon-star-empty:before { + content: "\e007"; +} + +.glyphicon-user:before { + content: "\e008"; +} + +.glyphicon-film:before { + content: "\e009"; +} + +.glyphicon-th-large:before { + content: "\e010"; +} + +.glyphicon-th:before { + content: "\e011"; +} + +.glyphicon-th-list:before { + content: "\e012"; +} + +.glyphicon-ok:before { + content: "\e013"; +} + +.glyphicon-remove:before { + content: "\e014"; +} + +.glyphicon-zoom-in:before { + content: "\e015"; +} + +.glyphicon-zoom-out:before { + content: "\e016"; +} + +.glyphicon-off:before { + content: "\e017"; +} + +.glyphicon-signal:before { + content: "\e018"; +} + +.glyphicon-cog:before { + content: "\e019"; +} + +.glyphicon-trash:before { + content: "\e020"; +} + +.glyphicon-home:before { + content: "\e021"; +} + +.glyphicon-file:before { + content: "\e022"; +} + +.glyphicon-time:before { + content: "\e023"; +} + +.glyphicon-road:before { + content: "\e024"; +} + +.glyphicon-download-alt:before { + content: "\e025"; +} + +.glyphicon-download:before { + content: "\e026"; +} + +.glyphicon-upload:before { + content: "\e027"; +} + +.glyphicon-inbox:before { + content: "\e028"; +} + +.glyphicon-play-circle:before { + content: "\e029"; +} + +.glyphicon-repeat:before { + content: "\e030"; +} + +.glyphicon-refresh:before { + content: "\e031"; +} + +.glyphicon-list-alt:before { + content: "\e032"; +} + +.glyphicon-lock:before { + content: "\e033"; +} + +.glyphicon-flag:before { + content: "\e034"; +} + +.glyphicon-headphones:before { + content: "\e035"; +} + +.glyphicon-volume-off:before { + content: "\e036"; +} + +.glyphicon-volume-down:before { + content: "\e037"; +} + +.glyphicon-volume-up:before { + content: "\e038"; +} + +.glyphicon-qrcode:before { + content: "\e039"; +} + +.glyphicon-barcode:before { + content: "\e040"; +} + +.glyphicon-tag:before { + content: "\e041"; +} + +.glyphicon-tags:before { + content: "\e042"; +} + +.glyphicon-book:before { + content: "\e043"; +} + +.glyphicon-bookmark:before { + content: "\e044"; +} + +.glyphicon-print:before { + content: "\e045"; +} + +.glyphicon-camera:before { + content: "\e046"; +} + +.glyphicon-font:before { + content: "\e047"; +} + +.glyphicon-bold:before { + content: "\e048"; +} + +.glyphicon-italic:before { + content: "\e049"; +} + +.glyphicon-text-height:before { + content: "\e050"; +} + +.glyphicon-text-width:before { + content: "\e051"; +} + +.glyphicon-align-left:before { + content: "\e052"; +} + +.glyphicon-align-center:before { + content: "\e053"; +} + +.glyphicon-align-right:before { + content: "\e054"; +} + +.glyphicon-align-justify:before { + content: "\e055"; +} + +.glyphicon-list:before { + content: "\e056"; +} + +.glyphicon-indent-left:before { + content: "\e057"; +} + +.glyphicon-indent-right:before { + content: "\e058"; +} + +.glyphicon-facetime-video:before { + content: "\e059"; +} + +.glyphicon-picture:before { + content: "\e060"; +} + +.glyphicon-map-marker:before { + content: "\e062"; +} + +.glyphicon-adjust:before { + content: "\e063"; +} + +.glyphicon-tint:before { + content: "\e064"; +} + +.glyphicon-edit:before { + content: "\e065"; +} + +.glyphicon-share:before { + content: "\e066"; +} + +.glyphicon-check:before { + content: "\e067"; +} + +.glyphicon-move:before { + content: "\e068"; +} + +.glyphicon-step-backward:before { + content: "\e069"; +} + +.glyphicon-fast-backward:before { + content: "\e070"; +} + +.glyphicon-backward:before { + content: "\e071"; +} + +.glyphicon-play:before { + content: "\e072"; +} + +.glyphicon-pause:before { + content: "\e073"; +} + +.glyphicon-stop:before { + content: "\e074"; +} + +.glyphicon-forward:before { + content: "\e075"; +} + +.glyphicon-fast-forward:before { + content: "\e076"; +} + +.glyphicon-step-forward:before { + content: "\e077"; +} + +.glyphicon-eject:before { + content: "\e078"; +} + +.glyphicon-chevron-left:before { + content: "\e079"; +} + +.glyphicon-chevron-right:before { + content: "\e080"; +} + +.glyphicon-plus-sign:before { + content: "\e081"; +} + +.glyphicon-minus-sign:before { + content: "\e082"; +} + +.glyphicon-remove-sign:before { + content: "\e083"; +} + +.glyphicon-ok-sign:before { + content: "\e084"; +} + +.glyphicon-question-sign:before { + content: "\e085"; +} + +.glyphicon-info-sign:before { + content: "\e086"; +} + +.glyphicon-screenshot:before { + content: "\e087"; +} + +.glyphicon-remove-circle:before { + content: "\e088"; +} + +.glyphicon-ok-circle:before { + content: "\e089"; +} + +.glyphicon-ban-circle:before { + content: "\e090"; +} + +.glyphicon-arrow-left:before { + content: "\e091"; +} + +.glyphicon-arrow-right:before { + content: "\e092"; +} + +.glyphicon-arrow-up:before { + content: "\e093"; +} + +.glyphicon-arrow-down:before { + content: "\e094"; +} + +.glyphicon-share-alt:before { + content: "\e095"; +} + +.glyphicon-resize-full:before { + content: "\e096"; +} + +.glyphicon-resize-small:before { + content: "\e097"; +} + +.glyphicon-exclamation-sign:before { + content: "\e101"; +} + +.glyphicon-gift:before { + content: "\e102"; +} + +.glyphicon-leaf:before { + content: "\e103"; +} + +.glyphicon-fire:before { + content: "\e104"; +} + +.glyphicon-eye-open:before { + content: "\e105"; +} + +.glyphicon-eye-close:before { + content: "\e106"; +} + +.glyphicon-warning-sign:before { + content: "\e107"; +} + +.glyphicon-plane:before { + content: "\e108"; +} + +.glyphicon-calendar:before { + content: "\e109"; +} + +.glyphicon-random:before { + content: "\e110"; +} + +.glyphicon-comment:before { + content: "\e111"; +} + +.glyphicon-magnet:before { + content: "\e112"; +} + +.glyphicon-chevron-up:before { + content: "\e113"; +} + +.glyphicon-chevron-down:before { + content: "\e114"; +} + +.glyphicon-retweet:before { + content: "\e115"; +} + +.glyphicon-shopping-cart:before { + content: "\e116"; +} + +.glyphicon-folder-close:before { + content: "\e117"; +} + +.glyphicon-folder-open:before { + content: "\e118"; +} + +.glyphicon-resize-vertical:before { + content: "\e119"; +} + +.glyphicon-resize-horizontal:before { + content: "\e120"; +} + +.glyphicon-hdd:before { + content: "\e121"; +} + +.glyphicon-bullhorn:before { + content: "\e122"; +} + +.glyphicon-bell:before { + content: "\e123"; +} + +.glyphicon-certificate:before { + content: "\e124"; +} + +.glyphicon-thumbs-up:before { + content: "\e125"; +} + +.glyphicon-thumbs-down:before { + content: "\e126"; +} + +.glyphicon-hand-right:before { + content: "\e127"; +} + +.glyphicon-hand-left:before { + content: "\e128"; +} + +.glyphicon-hand-up:before { + content: "\e129"; +} + +.glyphicon-hand-down:before { + content: "\e130"; +} + +.glyphicon-circle-arrow-right:before { + content: "\e131"; +} + +.glyphicon-circle-arrow-left:before { + content: "\e132"; +} + +.glyphicon-circle-arrow-up:before { + content: "\e133"; +} + +.glyphicon-circle-arrow-down:before { + content: "\e134"; +} + +.glyphicon-globe:before { + content: "\e135"; +} + +.glyphicon-wrench:before { + content: "\e136"; +} + +.glyphicon-tasks:before { + content: "\e137"; +} + +.glyphicon-filter:before { + content: "\e138"; +} + +.glyphicon-briefcase:before { + content: "\e139"; +} + +.glyphicon-fullscreen:before { + content: "\e140"; +} + +.glyphicon-dashboard:before { + content: "\e141"; +} + +.glyphicon-paperclip:before { + content: "\e142"; +} + +.glyphicon-heart-empty:before { + content: "\e143"; +} + +.glyphicon-link:before { + content: "\e144"; +} + +.glyphicon-phone:before { + content: "\e145"; +} + +.glyphicon-pushpin:before { + content: "\e146"; +} + +.glyphicon-usd:before { + content: "\e148"; +} + +.glyphicon-gbp:before { + content: "\e149"; +} + +.glyphicon-sort:before { + content: "\e150"; +} + +.glyphicon-sort-by-alphabet:before { + content: "\e151"; +} + +.glyphicon-sort-by-alphabet-alt:before { + content: "\e152"; +} + +.glyphicon-sort-by-order:before { + content: "\e153"; +} + +.glyphicon-sort-by-order-alt:before { + content: "\e154"; +} + +.glyphicon-sort-by-attributes:before { + content: "\e155"; +} + +.glyphicon-sort-by-attributes-alt:before { + content: "\e156"; +} + +.glyphicon-unchecked:before { + content: "\e157"; +} + +.glyphicon-expand:before { + content: "\e158"; +} + +.glyphicon-collapse-down:before { + content: "\e159"; +} + +.glyphicon-collapse-up:before { + content: "\e160"; +} + +.glyphicon-log-in:before { + content: "\e161"; +} + +.glyphicon-flash:before { + content: "\e162"; +} + +.glyphicon-log-out:before { + content: "\e163"; +} + +.glyphicon-new-window:before { + content: "\e164"; +} + +.glyphicon-record:before { + content: "\e165"; +} + +.glyphicon-save:before { + content: "\e166"; +} + +.glyphicon-open:before { + content: "\e167"; +} + +.glyphicon-saved:before { + content: "\e168"; +} + +.glyphicon-import:before { + content: "\e169"; +} + +.glyphicon-export:before { + content: "\e170"; +} + +.glyphicon-send:before { + content: "\e171"; +} + +.glyphicon-floppy-disk:before { + content: "\e172"; +} + +.glyphicon-floppy-saved:before { + content: "\e173"; +} + +.glyphicon-floppy-remove:before { + content: "\e174"; +} + +.glyphicon-floppy-save:before { + content: "\e175"; +} + +.glyphicon-floppy-open:before { + content: "\e176"; +} + +.glyphicon-credit-card:before { + content: "\e177"; +} + +.glyphicon-transfer:before { + content: "\e178"; +} + +.glyphicon-cutlery:before { + content: "\e179"; +} + +.glyphicon-header:before { + content: "\e180"; +} + +.glyphicon-compressed:before { + content: "\e181"; +} + +.glyphicon-earphone:before { + content: "\e182"; +} + +.glyphicon-phone-alt:before { + content: "\e183"; +} + +.glyphicon-tower:before { + content: "\e184"; +} + +.glyphicon-stats:before { + content: "\e185"; +} + +.glyphicon-sd-video:before { + content: "\e186"; +} + +.glyphicon-hd-video:before { + content: "\e187"; +} + +.glyphicon-subtitles:before { + content: "\e188"; +} + +.glyphicon-sound-stereo:before { + content: "\e189"; +} + +.glyphicon-sound-dolby:before { + content: "\e190"; +} + +.glyphicon-sound-5-1:before { + content: "\e191"; +} + +.glyphicon-sound-6-1:before { + content: "\e192"; +} + +.glyphicon-sound-7-1:before { + content: "\e193"; +} + +.glyphicon-copyright-mark:before { + content: "\e194"; +} + +.glyphicon-registration-mark:before { + content: "\e195"; +} + +.glyphicon-cloud-download:before { + content: "\e197"; +} + +.glyphicon-cloud-upload:before { + content: "\e198"; +} + +.glyphicon-tree-conifer:before { + content: "\e199"; +} + +.glyphicon-tree-deciduous:before { + content: "\e200"; +} + +.caret { + display: inline-block; + width: 0; + height: 0; + margin-left: 2px; + vertical-align: middle; + border-top: 4px solid #000000; + border-right: 4px solid transparent; + border-bottom: 0 dotted; + border-left: 4px solid transparent; +} + +.dropdown { + position: relative; +} + +.dropdown-toggle:focus { + outline: 0; +} + +.dropdown-menu { + position: absolute; + top: 100%; + left: 0; + z-index: 1000; + display: none; + float: left; + min-width: 160px; + padding: 5px 0; + margin: 2px 0 0; + font-size: 14px; + list-style: none; + background-color: #ffffff; + border: 1px solid #cccccc; + border: 1px solid rgba(0, 0, 0, 0.15); + border-radius: 4px; + -webkit-box-shadow: 0 6px 12px rgba(0, 0, 0, 0.175); + box-shadow: 0 6px 12px rgba(0, 0, 0, 0.175); + background-clip: padding-box; +} + +.dropdown-menu.pull-right { + right: 0; + left: auto; +} + +.dropdown-menu .divider { + height: 1px; + margin: 9px 0; + overflow: hidden; + background-color: #e5e5e5; +} + +.dropdown-menu > li > a { + display: block; + padding: 3px 20px; + clear: both; + font-weight: normal; + line-height: 1.428571429; + color: #333333; + white-space: nowrap; +} + +.dropdown-menu > li > a:hover, +.dropdown-menu > li > a:focus { + color: #262626; + text-decoration: none; + background-color: #f5f5f5; +} + +.dropdown-menu > .active > a, +.dropdown-menu > .active > a:hover, +.dropdown-menu > .active > a:focus { + color: #ffffff; + text-decoration: none; + background-color: #428bca; + outline: 0; +} + +.dropdown-menu > .disabled > a, +.dropdown-menu > .disabled > a:hover, +.dropdown-menu > .disabled > a:focus { + color: #999999; +} + +.dropdown-menu > .disabled > a:hover, +.dropdown-menu > .disabled > a:focus { + text-decoration: none; + cursor: not-allowed; + background-color: transparent; + background-image: none; + filter: progid:DXImageTransform.Microsoft.gradient(enabled=false); +} + +.open > .dropdown-menu { + display: block; +} + +.open > a { + outline: 0; +} + +.dropdown-header { + display: block; + padding: 3px 20px; + font-size: 12px; + line-height: 1.428571429; + color: #999999; +} + +.dropdown-backdrop { + position: fixed; + top: 0; + right: 0; + bottom: 0; + left: 0; + z-index: 990; +} + +.pull-right > .dropdown-menu { + right: 0; + left: auto; +} + +.dropup .caret, +.navbar-fixed-bottom .dropdown .caret { + border-top: 0 dotted; + border-bottom: 4px solid #000000; + content: ""; +} + +.dropup .dropdown-menu, +.navbar-fixed-bottom .dropdown .dropdown-menu { + top: auto; + bottom: 100%; + margin-bottom: 1px; +} + +@media (min-width: 768px) { + .navbar-right .dropdown-menu { + right: 0; + left: auto; + } +} + +.btn-default .caret { + border-top-color: #333333; +} + +.btn-primary .caret, +.btn-success .caret, +.btn-warning .caret, +.btn-danger .caret, +.btn-info .caret { + border-top-color: #fff; +} + +.dropup .btn-default .caret { + border-bottom-color: #333333; +} + +.dropup .btn-primary .caret, +.dropup .btn-success .caret, +.dropup .btn-warning .caret, +.dropup .btn-danger .caret, +.dropup .btn-info .caret { + border-bottom-color: #fff; +} + +.btn-group, +.btn-group-vertical { + position: relative; + display: inline-block; + vertical-align: middle; +} + +.btn-group > .btn, +.btn-group-vertical > .btn { + position: relative; + float: left; +} + +.btn-group > .btn:hover, +.btn-group-vertical > .btn:hover, +.btn-group > .btn:focus, +.btn-group-vertical > .btn:focus, +.btn-group > .btn:active, +.btn-group-vertical > .btn:active, +.btn-group > .btn.active, +.btn-group-vertical > .btn.active { + z-index: 2; +} + +.btn-group > .btn:focus, +.btn-group-vertical > .btn:focus { + outline: none; +} + +.btn-group .btn + .btn, +.btn-group .btn + .btn-group, +.btn-group .btn-group + .btn, +.btn-group .btn-group + .btn-group { + margin-left: -1px; +} + +.btn-toolbar:before, +.btn-toolbar:after { + display: table; + content: " "; +} + +.btn-toolbar:after { + clear: both; +} + +.btn-toolbar:before, +.btn-toolbar:after { + display: table; + content: " "; +} + +.btn-toolbar:after { + clear: both; +} + +.btn-toolbar .btn-group { + float: left; +} + +.btn-toolbar > .btn + .btn, +.btn-toolbar > .btn-group + .btn, +.btn-toolbar > .btn + .btn-group, +.btn-toolbar > .btn-group + .btn-group { + margin-left: 5px; +} + +.btn-group > .btn:not(:first-child):not(:last-child):not(.dropdown-toggle) { + border-radius: 0; +} + +.btn-group > .btn:first-child { + margin-left: 0; +} + +.btn-group > .btn:first-child:not(:last-child):not(.dropdown-toggle) { + border-top-right-radius: 0; + border-bottom-right-radius: 0; +} + +.btn-group > .btn:last-child:not(:first-child), +.btn-group > .dropdown-toggle:not(:first-child) { + border-bottom-left-radius: 0; + border-top-left-radius: 0; +} + +.btn-group > .btn-group { + float: left; +} + +.btn-group > .btn-group:not(:first-child):not(:last-child) > .btn { + border-radius: 0; +} + +.btn-group > .btn-group:first-child > .btn:last-child, +.btn-group > .btn-group:first-child > .dropdown-toggle { + border-top-right-radius: 0; + border-bottom-right-radius: 0; +} + +.btn-group > .btn-group:last-child > .btn:first-child { + border-bottom-left-radius: 0; + border-top-left-radius: 0; +} + +.btn-group .dropdown-toggle:active, +.btn-group.open .dropdown-toggle { + outline: 0; +} + +.btn-group-xs > .btn { + padding: 5px 10px; + padding: 1px 5px; + font-size: 12px; + line-height: 1.5; + border-radius: 3px; +} + +.btn-group-sm > .btn { + padding: 5px 10px; + font-size: 12px; + line-height: 1.5; + border-radius: 3px; +} + +.btn-group-lg > .btn { + padding: 10px 16px; + font-size: 18px; + line-height: 1.33; + border-radius: 6px; +} + +.btn-group > .btn + .dropdown-toggle { + padding-right: 8px; + padding-left: 8px; +} + +.btn-group > .btn-lg + .dropdown-toggle { + padding-right: 12px; + padding-left: 12px; +} + +.btn-group.open .dropdown-toggle { + -webkit-box-shadow: inset 0 3px 5px rgba(0, 0, 0, 0.125); + box-shadow: inset 0 3px 5px rgba(0, 0, 0, 0.125); +} + +.btn-group.open .dropdown-toggle.btn-link { + -webkit-box-shadow: none; + box-shadow: none; +} + +.btn .caret { + margin-left: 0; +} + +.btn-lg .caret { + border-width: 5px 5px 0; + border-bottom-width: 0; +} + +.dropup .btn-lg .caret { + border-width: 0 5px 5px; +} + +.btn-group-vertical > .btn, +.btn-group-vertical > .btn-group { + display: block; + float: none; + width: 100%; + max-width: 100%; +} + +.btn-group-vertical > .btn-group:before, +.btn-group-vertical > .btn-group:after { + display: table; + content: " "; +} + +.btn-group-vertical > .btn-group:after { + clear: both; +} + +.btn-group-vertical > .btn-group:before, +.btn-group-vertical > .btn-group:after { + display: table; + content: " "; +} + +.btn-group-vertical > .btn-group:after { + clear: both; +} + +.btn-group-vertical > .btn-group > .btn { + float: none; +} + +.btn-group-vertical > .btn + .btn, +.btn-group-vertical > .btn + .btn-group, +.btn-group-vertical > .btn-group + .btn, +.btn-group-vertical > .btn-group + .btn-group { + margin-top: -1px; + margin-left: 0; +} + +.btn-group-vertical > .btn:not(:first-child):not(:last-child) { + border-radius: 0; +} + +.btn-group-vertical > .btn:first-child:not(:last-child) { + border-top-right-radius: 4px; + border-bottom-right-radius: 0; + border-bottom-left-radius: 0; +} + +.btn-group-vertical > .btn:last-child:not(:first-child) { + border-top-right-radius: 0; + border-bottom-left-radius: 4px; + border-top-left-radius: 0; +} + +.btn-group-vertical > .btn-group:not(:first-child):not(:last-child) > .btn { + border-radius: 0; +} + +.btn-group-vertical > .btn-group:first-child > .btn:last-child, +.btn-group-vertical > .btn-group:first-child > .dropdown-toggle { + border-bottom-right-radius: 0; + border-bottom-left-radius: 0; +} + +.btn-group-vertical > .btn-group:last-child > .btn:first-child { + border-top-right-radius: 0; + border-top-left-radius: 0; +} + +.btn-group-justified { + display: table; + width: 100%; + border-collapse: separate; + table-layout: fixed; +} + +.btn-group-justified .btn { + display: table-cell; + float: none; + width: 1%; +} + +[data-toggle="buttons"] > .btn > input[type="radio"], +[data-toggle="buttons"] > .btn > input[type="checkbox"] { + display: none; +} + +.input-group { + position: relative; + display: table; + border-collapse: separate; +} + +.input-group.col { + float: none; + padding-right: 0; + padding-left: 0; +} + +.input-group .form-control { + width: 100%; + margin-bottom: 0; +} + +.input-group-lg > .form-control, +.input-group-lg > .input-group-addon, +.input-group-lg > .input-group-btn > .btn { + height: 45px; + padding: 10px 16px; + font-size: 18px; + line-height: 1.33; + border-radius: 6px; +} + +select.input-group-lg > .form-control, +select.input-group-lg > .input-group-addon, +select.input-group-lg > .input-group-btn > .btn { + height: 45px; + line-height: 45px; +} + +textarea.input-group-lg > .form-control, +textarea.input-group-lg > .input-group-addon, +textarea.input-group-lg > .input-group-btn > .btn { + height: auto; +} + +.input-group-sm > .form-control, +.input-group-sm > .input-group-addon, +.input-group-sm > .input-group-btn > .btn { + height: 30px; + padding: 5px 10px; + font-size: 12px; + line-height: 1.5; + border-radius: 3px; +} + +select.input-group-sm > .form-control, +select.input-group-sm > .input-group-addon, +select.input-group-sm > .input-group-btn > .btn { + height: 30px; + line-height: 30px; +} + +textarea.input-group-sm > .form-control, +textarea.input-group-sm > .input-group-addon, +textarea.input-group-sm > .input-group-btn > .btn { + height: auto; +} + +.input-group-addon, +.input-group-btn, +.input-group .form-control { + display: table-cell; +} + +.input-group-addon:not(:first-child):not(:last-child), +.input-group-btn:not(:first-child):not(:last-child), +.input-group .form-control:not(:first-child):not(:last-child) { + border-radius: 0; +} + +.input-group-addon, +.input-group-btn { + width: 1%; + white-space: nowrap; + vertical-align: middle; +} + +.input-group-addon { + padding: 6px 12px; + font-size: 14px; + font-weight: normal; + line-height: 1; + color: #555555; + text-align: center; + background-color: #eeeeee; + border: 1px solid #cccccc; + border-radius: 4px; +} + +.input-group-addon.input-sm { + padding: 5px 10px; + font-size: 12px; + border-radius: 3px; +} + +.input-group-addon.input-lg { + padding: 10px 16px; + font-size: 18px; + border-radius: 6px; +} + +.input-group-addon input[type="radio"], +.input-group-addon input[type="checkbox"] { + margin-top: 0; +} + +.input-group .form-control:first-child, +.input-group-addon:first-child, +.input-group-btn:first-child > .btn, +.input-group-btn:first-child > .dropdown-toggle, +.input-group-btn:last-child > .btn:not(:last-child):not(.dropdown-toggle) { + border-top-right-radius: 0; + border-bottom-right-radius: 0; +} + +.input-group-addon:first-child { + border-right: 0; +} + +.input-group .form-control:last-child, +.input-group-addon:last-child, +.input-group-btn:last-child > .btn, +.input-group-btn:last-child > .dropdown-toggle, +.input-group-btn:first-child > .btn:not(:first-child) { + border-bottom-left-radius: 0; + border-top-left-radius: 0; +} + +.input-group-addon:last-child { + border-left: 0; +} + +.input-group-btn { + position: relative; + white-space: nowrap; +} + +.input-group-btn:first-child > .btn { + margin-right: -1px; +} + +.input-group-btn:last-child > .btn { + margin-left: -1px; +} + +.input-group-btn > .btn { + position: relative; +} + +.input-group-btn > .btn + .btn { + margin-left: -4px; +} + +.input-group-btn > .btn:hover, +.input-group-btn > .btn:active { + z-index: 2; +} + +.nav { + padding-left: 0; + margin-bottom: 0; + list-style: none; +} + +.nav:before, +.nav:after { + display: table; + content: " "; +} + +.nav:after { + clear: both; +} + +.nav:before, +.nav:after { + display: table; + content: " "; +} + +.nav:after { + clear: both; +} + +.nav > li { + position: relative; + display: block; +} + +.nav > li > a { + position: relative; + display: block; + padding: 10px 15px; +} + +.nav > li > a:hover, +.nav > li > a:focus { + text-decoration: none; + background-color: #eeeeee; +} + +.nav > li.disabled > a { + color: #999999; +} + +.nav > li.disabled > a:hover, +.nav > li.disabled > a:focus { + color: #999999; + text-decoration: none; + cursor: not-allowed; + background-color: transparent; +} + +.nav .open > a, +.nav .open > a:hover, +.nav .open > a:focus { + background-color: #eeeeee; + border-color: #428bca; +} + +.nav .open > a .caret, +.nav .open > a:hover .caret, +.nav .open > a:focus .caret { + border-top-color: #2a6496; + border-bottom-color: #2a6496; +} + +.nav .nav-divider { + height: 1px; + margin: 9px 0; + overflow: hidden; + background-color: #e5e5e5; +} + +.nav > li > a > img { + max-width: none; +} + +.nav-tabs { + border-bottom: 1px solid #dddddd; +} + +.nav-tabs > li { + float: left; + margin-bottom: -1px; +} + +.nav-tabs > li > a { + margin-right: 2px; + line-height: 1.428571429; + border: 1px solid transparent; + border-radius: 4px 4px 0 0; +} + +.nav-tabs > li > a:hover { + border-color: #eeeeee #eeeeee #dddddd; +} + +.nav-tabs > li.active > a, +.nav-tabs > li.active > a:hover, +.nav-tabs > li.active > a:focus { + color: #555555; + cursor: default; + background-color: #ffffff; + border: 1px solid #dddddd; + border-bottom-color: transparent; +} + +.nav-tabs.nav-justified { + width: 100%; + border-bottom: 0; +} + +.nav-tabs.nav-justified > li { + float: none; +} + +.nav-tabs.nav-justified > li > a { + margin-bottom: 5px; + text-align: center; +} + +.nav-tabs.nav-justified > .dropdown .dropdown-menu { + top: auto; + left: auto; +} + +@media (min-width: 768px) { + .nav-tabs.nav-justified > li { + display: table-cell; + width: 1%; + } + .nav-tabs.nav-justified > li > a { + margin-bottom: 0; + } +} + +.nav-tabs.nav-justified > li > a { + margin-right: 0; + border-radius: 4px; +} + +.nav-tabs.nav-justified > .active > a, +.nav-tabs.nav-justified > .active > a:hover, +.nav-tabs.nav-justified > .active > a:focus { + border: 1px solid #dddddd; +} + +@media (min-width: 768px) { + .nav-tabs.nav-justified > li > a { + border-bottom: 1px solid #dddddd; + border-radius: 4px 4px 0 0; + } + .nav-tabs.nav-justified > .active > a, + .nav-tabs.nav-justified > .active > a:hover, + .nav-tabs.nav-justified > .active > a:focus { + border-bottom-color: #ffffff; + } +} + +.nav-pills > li { + float: left; +} + +.nav-pills > li > a { + border-radius: 4px; +} + +.nav-pills > li + li { + margin-left: 2px; +} + +.nav-pills > li.active > a, +.nav-pills > li.active > a:hover, +.nav-pills > li.active > a:focus { + color: #ffffff; + background-color: #428bca; +} + +.nav-pills > li.active > a .caret, +.nav-pills > li.active > a:hover .caret, +.nav-pills > li.active > a:focus .caret { + border-top-color: #ffffff; + border-bottom-color: #ffffff; +} + +.nav-stacked > li { + float: none; +} + +.nav-stacked > li + li { + margin-top: 2px; + margin-left: 0; +} + +.nav-justified { + width: 100%; +} + +.nav-justified > li { + float: none; +} + +.nav-justified > li > a { + margin-bottom: 5px; + text-align: center; +} + +.nav-justified > .dropdown .dropdown-menu { + top: auto; + left: auto; +} + +@media (min-width: 768px) { + .nav-justified > li { + display: table-cell; + width: 1%; + } + .nav-justified > li > a { + margin-bottom: 0; + } +} + +.nav-tabs-justified { + border-bottom: 0; +} + +.nav-tabs-justified > li > a { + margin-right: 0; + border-radius: 4px; +} + +.nav-tabs-justified > .active > a, +.nav-tabs-justified > .active > a:hover, +.nav-tabs-justified > .active > a:focus { + border: 1px solid #dddddd; +} + +@media (min-width: 768px) { + .nav-tabs-justified > li > a { + border-bottom: 1px solid #dddddd; + border-radius: 4px 4px 0 0; + } + .nav-tabs-justified > .active > a, + .nav-tabs-justified > .active > a:hover, + .nav-tabs-justified > .active > a:focus { + border-bottom-color: #ffffff; + } +} + +.tab-content > .tab-pane { + display: none; +} + +.tab-content > .active { + display: block; +} + +.nav .caret { + border-top-color: #428bca; + border-bottom-color: #428bca; +} + +.nav a:hover .caret { + border-top-color: #2a6496; + border-bottom-color: #2a6496; +} + +.nav-tabs .dropdown-menu { + margin-top: -1px; + border-top-right-radius: 0; + border-top-left-radius: 0; +} + +.navbar { + position: relative; + min-height: 50px; + margin-bottom: 20px; + border: 1px solid transparent; +} + +.navbar:before, +.navbar:after { + display: table; + content: " "; +} + +.navbar:after { + clear: both; +} + +.navbar:before, +.navbar:after { + display: table; + content: " "; +} + +.navbar:after { + clear: both; +} + +@media (min-width: 768px) { + .navbar { + border-radius: 4px; + } +} + +.navbar-header:before, +.navbar-header:after { + display: table; + content: " "; +} + +.navbar-header:after { + clear: both; +} + +.navbar-header:before, +.navbar-header:after { + display: table; + content: " "; +} + +.navbar-header:after { + clear: both; +} + +@media (min-width: 768px) { + .navbar-header { + float: left; + } +} + +.navbar-collapse { + max-height: 340px; + padding-right: 15px; + padding-left: 15px; + overflow-x: visible; + border-top: 1px solid transparent; + box-shadow: inset 0 1px 0 rgba(255, 255, 255, 0.1); + -webkit-overflow-scrolling: touch; +} + +.navbar-collapse:before, +.navbar-collapse:after { + display: table; + content: " "; +} + +.navbar-collapse:after { + clear: both; +} + +.navbar-collapse:before, +.navbar-collapse:after { + display: table; + content: " "; +} + +.navbar-collapse:after { + clear: both; +} + +.navbar-collapse.in { + overflow-y: auto; +} + +@media (min-width: 768px) { + .navbar-collapse { + width: auto; + border-top: 0; + box-shadow: none; + } + .navbar-collapse.collapse { + display: block !important; + height: auto !important; + padding-bottom: 0; + overflow: visible !important; + } + .navbar-collapse.in { + overflow-y: auto; + } + .navbar-collapse .navbar-nav.navbar-left:first-child { + margin-left: -15px; + } + .navbar-collapse .navbar-nav.navbar-right:last-child { + margin-right: -15px; + } + .navbar-collapse .navbar-text:last-child { + margin-right: 0; + } +} + +.container > .navbar-header, +.container > .navbar-collapse { + margin-right: -15px; + margin-left: -15px; +} + +@media (min-width: 768px) { + .container > .navbar-header, + .container > .navbar-collapse { + margin-right: 0; + margin-left: 0; + } +} + +.navbar-static-top { + z-index: 1000; + border-width: 0 0 1px; +} + +@media (min-width: 768px) { + .navbar-static-top { + border-radius: 0; + } +} + +.navbar-fixed-top, +.navbar-fixed-bottom { + position: fixed; + right: 0; + left: 0; + z-index: 1030; +} + +@media (min-width: 768px) { + .navbar-fixed-top, + .navbar-fixed-bottom { + border-radius: 0; + } +} + +.navbar-fixed-top { + top: 0; + border-width: 0 0 1px; +} + +.navbar-fixed-bottom { + bottom: 0; + margin-bottom: 0; + border-width: 1px 0 0; +} + +.navbar-brand { + float: left; + padding: 15px 15px; + font-size: 18px; + line-height: 20px; +} + +.navbar-brand:hover, +.navbar-brand:focus { + text-decoration: none; +} + +@media (min-width: 768px) { + .navbar > .container .navbar-brand { + margin-left: -15px; + } +} + +.navbar-toggle { + position: relative; + float: right; + padding: 9px 10px; + margin-top: 8px; + margin-right: 15px; + margin-bottom: 8px; + background-color: transparent; + border: 1px solid transparent; + border-radius: 4px; +} + +.navbar-toggle .icon-bar { + display: block; + width: 22px; + height: 2px; + border-radius: 1px; +} + +.navbar-toggle .icon-bar + .icon-bar { + margin-top: 4px; +} + +@media (min-width: 768px) { + .navbar-toggle { + display: none; + } +} + +.navbar-nav { + margin: 7.5px -15px; +} + +.navbar-nav > li > a { + padding-top: 10px; + padding-bottom: 10px; + line-height: 20px; +} + +@media (max-width: 767px) { + .navbar-nav .open .dropdown-menu { + position: static; + float: none; + width: auto; + margin-top: 0; + background-color: transparent; + border: 0; + box-shadow: none; + } + .navbar-nav .open .dropdown-menu > li > a, + .navbar-nav .open .dropdown-menu .dropdown-header { + padding: 5px 15px 5px 25px; + } + .navbar-nav .open .dropdown-menu > li > a { + line-height: 20px; + } + .navbar-nav .open .dropdown-menu > li > a:hover, + .navbar-nav .open .dropdown-menu > li > a:focus { + background-image: none; + } +} + +@media (min-width: 768px) { + .navbar-nav { + float: left; + margin: 0; + } + .navbar-nav > li { + float: left; + } + .navbar-nav > li > a { + padding-top: 15px; + padding-bottom: 15px; + } +} + +@media (min-width: 768px) { + .navbar-left { + float: left !important; + } + .navbar-right { + float: right !important; + } +} + +.navbar-form { + padding: 10px 15px; + margin-top: 8px; + margin-right: -15px; + margin-bottom: 8px; + margin-left: -15px; + border-top: 1px solid transparent; + border-bottom: 1px solid transparent; + -webkit-box-shadow: inset 0 1px 0 rgba(255, 255, 255, 0.1), 0 1px 0 rgba(255, 255, 255, 0.1); + box-shadow: inset 0 1px 0 rgba(255, 255, 255, 0.1), 0 1px 0 rgba(255, 255, 255, 0.1); +} + +@media (min-width: 768px) { + .navbar-form .form-group { + display: inline-block; + margin-bottom: 0; + vertical-align: middle; + } + .navbar-form .form-control { + display: inline-block; + } + .navbar-form .radio, + .navbar-form .checkbox { + display: inline-block; + padding-left: 0; + margin-top: 0; + margin-bottom: 0; + } + .navbar-form .radio input[type="radio"], + .navbar-form .checkbox input[type="checkbox"] { + float: none; + margin-left: 0; + } +} + +@media (max-width: 767px) { + .navbar-form .form-group { + margin-bottom: 5px; + } +} + +@media (min-width: 768px) { + .navbar-form { + width: auto; + padding-top: 0; + padding-bottom: 0; + margin-right: 0; + margin-left: 0; + border: 0; + -webkit-box-shadow: none; + box-shadow: none; + } +} + +.navbar-nav > li > .dropdown-menu { + margin-top: 0; + border-top-right-radius: 0; + border-top-left-radius: 0; +} + +.navbar-fixed-bottom .navbar-nav > li > .dropdown-menu { + border-bottom-right-radius: 0; + border-bottom-left-radius: 0; +} + +.navbar-nav.pull-right > li > .dropdown-menu, +.navbar-nav > li > .dropdown-menu.pull-right { + right: 0; + left: auto; +} + +.navbar-btn { + margin-top: 8px; + margin-bottom: 8px; +} + +.navbar-text { + float: left; + margin-top: 15px; + margin-bottom: 15px; +} + +@media (min-width: 768px) { + .navbar-text { + margin-right: 15px; + margin-left: 15px; + } +} + +.navbar-default { + background-color: #f8f8f8; + border-color: #e7e7e7; +} + +.navbar-default .navbar-brand { + color: #777777; +} + +.navbar-default .navbar-brand:hover, +.navbar-default .navbar-brand:focus { + color: #5e5e5e; + background-color: transparent; +} + +.navbar-default .navbar-text { + color: #777777; +} + +.navbar-default .navbar-nav > li > a { + color: #777777; +} + +.navbar-default .navbar-nav > li > a:hover, +.navbar-default .navbar-nav > li > a:focus { + color: #333333; + background-color: transparent; +} + +.navbar-default .navbar-nav > .active > a, +.navbar-default .navbar-nav > .active > a:hover, +.navbar-default .navbar-nav > .active > a:focus { + color: #555555; + background-color: #e7e7e7; +} + +.navbar-default .navbar-nav > .disabled > a, +.navbar-default .navbar-nav > .disabled > a:hover, +.navbar-default .navbar-nav > .disabled > a:focus { + color: #cccccc; + background-color: transparent; +} + +.navbar-default .navbar-toggle { + border-color: #dddddd; +} + +.navbar-default .navbar-toggle:hover, +.navbar-default .navbar-toggle:focus { + background-color: #dddddd; +} + +.navbar-default .navbar-toggle .icon-bar { + background-color: #cccccc; +} + +.navbar-default .navbar-collapse, +.navbar-default .navbar-form { + border-color: #e7e7e7; +} + +.navbar-default .navbar-nav > .dropdown > a:hover .caret, +.navbar-default .navbar-nav > .dropdown > a:focus .caret { + border-top-color: #333333; + border-bottom-color: #333333; +} + +.navbar-default .navbar-nav > .open > a, +.navbar-default .navbar-nav > .open > a:hover, +.navbar-default .navbar-nav > .open > a:focus { + color: #555555; + background-color: #e7e7e7; +} + +.navbar-default .navbar-nav > .open > a .caret, +.navbar-default .navbar-nav > .open > a:hover .caret, +.navbar-default .navbar-nav > .open > a:focus .caret { + border-top-color: #555555; + border-bottom-color: #555555; +} + +.navbar-default .navbar-nav > .dropdown > a .caret { + border-top-color: #777777; + border-bottom-color: #777777; +} + +@media (max-width: 767px) { + .navbar-default .navbar-nav .open .dropdown-menu > li > a { + color: #777777; + } + .navbar-default .navbar-nav .open .dropdown-menu > li > a:hover, + .navbar-default .navbar-nav .open .dropdown-menu > li > a:focus { + color: #333333; + background-color: transparent; + } + .navbar-default .navbar-nav .open .dropdown-menu > .active > a, + .navbar-default .navbar-nav .open .dropdown-menu > .active > a:hover, + .navbar-default .navbar-nav .open .dropdown-menu > .active > a:focus { + color: #555555; + background-color: #e7e7e7; + } + .navbar-default .navbar-nav .open .dropdown-menu > .disabled > a, + .navbar-default .navbar-nav .open .dropdown-menu > .disabled > a:hover, + .navbar-default .navbar-nav .open .dropdown-menu > .disabled > a:focus { + color: #cccccc; + background-color: transparent; + } +} + +.navbar-default .navbar-link { + color: #777777; +} + +.navbar-default .navbar-link:hover { + color: #333333; +} + +.navbar-inverse { + background-color: #222222; + border-color: #080808; +} + +.navbar-inverse .navbar-brand { + color: #999999; +} + +.navbar-inverse .navbar-brand:hover, +.navbar-inverse .navbar-brand:focus { + color: #ffffff; + background-color: transparent; +} + +.navbar-inverse .navbar-text { + color: #999999; +} + +.navbar-inverse .navbar-nav > li > a { + color: #999999; +} + +.navbar-inverse .navbar-nav > li > a:hover, +.navbar-inverse .navbar-nav > li > a:focus { + color: #ffffff; + background-color: transparent; +} + +.navbar-inverse .navbar-nav > .active > a, +.navbar-inverse .navbar-nav > .active > a:hover, +.navbar-inverse .navbar-nav > .active > a:focus { + color: #ffffff; + background-color: #080808; +} + +.navbar-inverse .navbar-nav > .disabled > a, +.navbar-inverse .navbar-nav > .disabled > a:hover, +.navbar-inverse .navbar-nav > .disabled > a:focus { + color: #444444; + background-color: transparent; +} + +.navbar-inverse .navbar-toggle { + border-color: #333333; +} + +.navbar-inverse .navbar-toggle:hover, +.navbar-inverse .navbar-toggle:focus { + background-color: #333333; +} + +.navbar-inverse .navbar-toggle .icon-bar { + background-color: #ffffff; +} + +.navbar-inverse .navbar-collapse, +.navbar-inverse .navbar-form { + border-color: #101010; +} + +.navbar-inverse .navbar-nav > .open > a, +.navbar-inverse .navbar-nav > .open > a:hover, +.navbar-inverse .navbar-nav > .open > a:focus { + color: #ffffff; + background-color: #080808; +} + +.navbar-inverse .navbar-nav > .dropdown > a:hover .caret { + border-top-color: #ffffff; + border-bottom-color: #ffffff; +} + +.navbar-inverse .navbar-nav > .dropdown > a .caret { + border-top-color: #999999; + border-bottom-color: #999999; +} + +.navbar-inverse .navbar-nav > .open > a .caret, +.navbar-inverse .navbar-nav > .open > a:hover .caret, +.navbar-inverse .navbar-nav > .open > a:focus .caret { + border-top-color: #ffffff; + border-bottom-color: #ffffff; +} + +@media (max-width: 767px) { + .navbar-inverse .navbar-nav .open .dropdown-menu > .dropdown-header { + border-color: #080808; + } + .navbar-inverse .navbar-nav .open .dropdown-menu > li > a { + color: #999999; + } + .navbar-inverse .navbar-nav .open .dropdown-menu > li > a:hover, + .navbar-inverse .navbar-nav .open .dropdown-menu > li > a:focus { + color: #ffffff; + background-color: transparent; + } + .navbar-inverse .navbar-nav .open .dropdown-menu > .active > a, + .navbar-inverse .navbar-nav .open .dropdown-menu > .active > a:hover, + .navbar-inverse .navbar-nav .open .dropdown-menu > .active > a:focus { + color: #ffffff; + background-color: #080808; + } + .navbar-inverse .navbar-nav .open .dropdown-menu > .disabled > a, + .navbar-inverse .navbar-nav .open .dropdown-menu > .disabled > a:hover, + .navbar-inverse .navbar-nav .open .dropdown-menu > .disabled > a:focus { + color: #444444; + background-color: transparent; + } +} + +.navbar-inverse .navbar-link { + color: #999999; +} + +.navbar-inverse .navbar-link:hover { + color: #ffffff; +} + +.breadcrumb { + padding: 8px 15px; + margin-bottom: 20px; + list-style: none; + background-color: #f5f5f5; + border-radius: 4px; +} + +.breadcrumb > li { + display: inline-block; +} + +.breadcrumb > li + li:before { + padding: 0 5px; + color: #cccccc; + content: "/\00a0"; +} + +.breadcrumb > .active { + color: #999999; +} + +.pagination { + display: inline-block; + padding-left: 0; + margin: 20px 0; + border-radius: 4px; +} + +.pagination > li { + display: inline; +} + +.pagination > li > a, +.pagination > li > span { + position: relative; + float: left; + padding: 6px 12px; + margin-left: -1px; + line-height: 1.428571429; + text-decoration: none; + background-color: #ffffff; + border: 1px solid #dddddd; +} + +.pagination > li:first-child > a, +.pagination > li:first-child > span { + margin-left: 0; + border-bottom-left-radius: 4px; + border-top-left-radius: 4px; +} + +.pagination > li:last-child > a, +.pagination > li:last-child > span { + border-top-right-radius: 4px; + border-bottom-right-radius: 4px; +} + +.pagination > li > a:hover, +.pagination > li > span:hover, +.pagination > li > a:focus, +.pagination > li > span:focus { + background-color: #eeeeee; +} + +.pagination > .active > a, +.pagination > .active > span, +.pagination > .active > a:hover, +.pagination > .active > span:hover, +.pagination > .active > a:focus, +.pagination > .active > span:focus { + z-index: 2; + color: #ffffff; + cursor: default; + background-color: #428bca; + border-color: #428bca; +} + +.pagination > .disabled > span, +.pagination > .disabled > span:hover, +.pagination > .disabled > span:focus, +.pagination > .disabled > a, +.pagination > .disabled > a:hover, +.pagination > .disabled > a:focus { + color: #999999; + cursor: not-allowed; + background-color: #ffffff; + border-color: #dddddd; +} + +.pagination-lg > li > a, +.pagination-lg > li > span { + padding: 10px 16px; + font-size: 18px; +} + +.pagination-lg > li:first-child > a, +.pagination-lg > li:first-child > span { + border-bottom-left-radius: 6px; + border-top-left-radius: 6px; +} + +.pagination-lg > li:last-child > a, +.pagination-lg > li:last-child > span { + border-top-right-radius: 6px; + border-bottom-right-radius: 6px; +} + +.pagination-sm > li > a, +.pagination-sm > li > span { + padding: 5px 10px; + font-size: 12px; +} + +.pagination-sm > li:first-child > a, +.pagination-sm > li:first-child > span { + border-bottom-left-radius: 3px; + border-top-left-radius: 3px; +} + +.pagination-sm > li:last-child > a, +.pagination-sm > li:last-child > span { + border-top-right-radius: 3px; + border-bottom-right-radius: 3px; +} + +.pager { + padding-left: 0; + margin: 20px 0; + text-align: center; + list-style: none; +} + +.pager:before, +.pager:after { + display: table; + content: " "; +} + +.pager:after { + clear: both; +} + +.pager:before, +.pager:after { + display: table; + content: " "; +} + +.pager:after { + clear: both; +} + +.pager li { + display: inline; +} + +.pager li > a, +.pager li > span { + display: inline-block; + padding: 5px 14px; + background-color: #ffffff; + border: 1px solid #dddddd; + border-radius: 15px; +} + +.pager li > a:hover, +.pager li > a:focus { + text-decoration: none; + background-color: #eeeeee; +} + +.pager .next > a, +.pager .next > span { + float: right; +} + +.pager .previous > a, +.pager .previous > span { + float: left; +} + +.pager .disabled > a, +.pager .disabled > a:hover, +.pager .disabled > a:focus, +.pager .disabled > span { + color: #999999; + cursor: not-allowed; + background-color: #ffffff; +} + +.label { + display: inline; + padding: .2em .6em .3em; + font-size: 75%; + font-weight: bold; + line-height: 1; + color: #ffffff; + text-align: center; + white-space: nowrap; + vertical-align: baseline; + border-radius: .25em; +} + +.label[href]:hover, +.label[href]:focus { + color: #ffffff; + text-decoration: none; + cursor: pointer; +} + +.label:empty { + display: none; +} + +.label-default { + background-color: #999999; +} + +.label-default[href]:hover, +.label-default[href]:focus { + background-color: #808080; +} + +.label-primary { + background-color: #428bca; +} + +.label-primary[href]:hover, +.label-primary[href]:focus { + background-color: #3071a9; +} + +.label-success { + background-color: #5cb85c; +} + +.label-success[href]:hover, +.label-success[href]:focus { + background-color: #449d44; +} + +.label-info { + background-color: #5bc0de; +} + +.label-info[href]:hover, +.label-info[href]:focus { + background-color: #31b0d5; +} + +.label-warning { + background-color: #f0ad4e; +} + +.label-warning[href]:hover, +.label-warning[href]:focus { + background-color: #ec971f; +} + +.label-danger { + background-color: #d9534f; +} + +.label-danger[href]:hover, +.label-danger[href]:focus { + background-color: #c9302c; +} + +.badge { + display: inline-block; + min-width: 10px; + padding: 3px 7px; + font-size: 12px; + font-weight: bold; + line-height: 1; + color: #ffffff; + text-align: center; + white-space: nowrap; + vertical-align: baseline; + background-color: #999999; + border-radius: 10px; +} + +.badge:empty { + display: none; +} + +a.badge:hover, +a.badge:focus { + color: #ffffff; + text-decoration: none; + cursor: pointer; +} + +.btn .badge { + position: relative; + top: -1px; +} + +a.list-group-item.active > .badge, +.nav-pills > .active > a > .badge { + color: #428bca; + background-color: #ffffff; +} + +.nav-pills > li > a > .badge { + margin-left: 3px; +} + +.jumbotron { + padding: 30px; + margin-bottom: 30px; + font-size: 21px; + font-weight: 200; + line-height: 2.1428571435; + color: inherit; + background-color: #eeeeee; +} + +.jumbotron h1 { + line-height: 1; + color: inherit; +} + +.jumbotron p { + line-height: 1.4; +} + +.container .jumbotron { + border-radius: 6px; +} + +@media screen and (min-width: 768px) { + .jumbotron { + padding-top: 48px; + padding-bottom: 48px; + } + .container .jumbotron { + padding-right: 60px; + padding-left: 60px; + } + .jumbotron h1 { + font-size: 63px; + } +} + +.thumbnail { + display: inline-block; + display: block; + height: auto; + max-width: 100%; + padding: 4px; + margin-bottom: 20px; + line-height: 1.428571429; + background-color: #ffffff; + border: 1px solid #dddddd; + border-radius: 4px; + -webkit-transition: all 0.2s ease-in-out; + transition: all 0.2s ease-in-out; +} + +.thumbnail > img { + display: block; + height: auto; + max-width: 100%; + margin-right: auto; + margin-left: auto; +} + +a.thumbnail:hover, +a.thumbnail:focus, +a.thumbnail.active { + border-color: #428bca; +} + +.thumbnail .caption { + padding: 9px; + color: #333333; +} + +.alert { + padding: 15px; + margin-bottom: 20px; + border: 1px solid transparent; + border-radius: 4px; +} + +.alert h4 { + margin-top: 0; + color: inherit; +} + +.alert .alert-link { + font-weight: bold; +} + +.alert > p, +.alert > ul { + margin-bottom: 0; +} + +.alert > p + p { + margin-top: 5px; +} + +.alert-dismissable { + padding-right: 35px; +} + +.alert-dismissable .close { + position: relative; + top: -2px; + right: -21px; + color: inherit; +} + +.alert-success { + color: #468847; + background-color: #dff0d8; + border-color: #d6e9c6; +} + +.alert-success hr { + border-top-color: #c9e2b3; +} + +.alert-success .alert-link { + color: #356635; +} + +.alert-info { + color: #3a87ad; + background-color: #d9edf7; + border-color: #bce8f1; +} + +.alert-info hr { + border-top-color: #a6e1ec; +} + +.alert-info .alert-link { + color: #2d6987; +} + +.alert-warning { + color: #c09853; + background-color: #fcf8e3; + border-color: #faebcc; +} + +.alert-warning hr { + border-top-color: #f7e1b5; +} + +.alert-warning .alert-link { + color: #a47e3c; +} + +.alert-danger { + color: #b94a48; + background-color: #f2dede; + border-color: #ebccd1; +} + +.alert-danger hr { + border-top-color: #e4b9c0; +} + +.alert-danger .alert-link { + color: #953b39; +} + +@-webkit-keyframes progress-bar-stripes { + from { + background-position: 40px 0; + } + to { + background-position: 0 0; + } +} + +@-moz-keyframes progress-bar-stripes { + from { + background-position: 40px 0; + } + to { + background-position: 0 0; + } +} + +@-o-keyframes progress-bar-stripes { + from { + background-position: 0 0; + } + to { + background-position: 40px 0; + } +} + +@keyframes progress-bar-stripes { + from { + background-position: 40px 0; + } + to { + background-position: 0 0; + } +} + +.progress { + height: 20px; + margin-bottom: 20px; + overflow: hidden; + background-color: #f5f5f5; + border-radius: 4px; + -webkit-box-shadow: inset 0 1px 2px rgba(0, 0, 0, 0.1); + box-shadow: inset 0 1px 2px rgba(0, 0, 0, 0.1); +} + +.progress-bar { + float: left; + width: 0; + height: 100%; + font-size: 12px; + line-height: 20px; + color: #ffffff; + text-align: center; + background-color: #428bca; + -webkit-box-shadow: inset 0 -1px 0 rgba(0, 0, 0, 0.15); + box-shadow: inset 0 -1px 0 rgba(0, 0, 0, 0.15); + -webkit-transition: width 0.6s ease; + transition: width 0.6s ease; +} + +.progress-striped .progress-bar { + background-image: -webkit-gradient(linear, 0 100%, 100% 0, color-stop(0.25, rgba(255, 255, 255, 0.15)), color-stop(0.25, transparent), color-stop(0.5, transparent), color-stop(0.5, rgba(255, 255, 255, 0.15)), color-stop(0.75, rgba(255, 255, 255, 0.15)), color-stop(0.75, transparent), to(transparent)); + background-image: -webkit-linear-gradient(45deg, rgba(255, 255, 255, 0.15) 25%, transparent 25%, transparent 50%, rgba(255, 255, 255, 0.15) 50%, rgba(255, 255, 255, 0.15) 75%, transparent 75%, transparent); + background-image: -moz-linear-gradient(45deg, rgba(255, 255, 255, 0.15) 25%, transparent 25%, transparent 50%, rgba(255, 255, 255, 0.15) 50%, rgba(255, 255, 255, 0.15) 75%, transparent 75%, transparent); + background-image: linear-gradient(45deg, rgba(255, 255, 255, 0.15) 25%, transparent 25%, transparent 50%, rgba(255, 255, 255, 0.15) 50%, rgba(255, 255, 255, 0.15) 75%, transparent 75%, transparent); + background-size: 40px 40px; +} + +.progress.active .progress-bar { + -webkit-animation: progress-bar-stripes 2s linear infinite; + animation: progress-bar-stripes 2s linear infinite; +} + +.progress-bar-success { + background-color: #5cb85c; +} + +.progress-striped .progress-bar-success { + background-image: -webkit-gradient(linear, 0 100%, 100% 0, color-stop(0.25, rgba(255, 255, 255, 0.15)), color-stop(0.25, transparent), color-stop(0.5, transparent), color-stop(0.5, rgba(255, 255, 255, 0.15)), color-stop(0.75, rgba(255, 255, 255, 0.15)), color-stop(0.75, transparent), to(transparent)); + background-image: -webkit-linear-gradient(45deg, rgba(255, 255, 255, 0.15) 25%, transparent 25%, transparent 50%, rgba(255, 255, 255, 0.15) 50%, rgba(255, 255, 255, 0.15) 75%, transparent 75%, transparent); + background-image: -moz-linear-gradient(45deg, rgba(255, 255, 255, 0.15) 25%, transparent 25%, transparent 50%, rgba(255, 255, 255, 0.15) 50%, rgba(255, 255, 255, 0.15) 75%, transparent 75%, transparent); + background-image: linear-gradient(45deg, rgba(255, 255, 255, 0.15) 25%, transparent 25%, transparent 50%, rgba(255, 255, 255, 0.15) 50%, rgba(255, 255, 255, 0.15) 75%, transparent 75%, transparent); +} + +.progress-bar-info { + background-color: #5bc0de; +} + +.progress-striped .progress-bar-info { + background-image: -webkit-gradient(linear, 0 100%, 100% 0, color-stop(0.25, rgba(255, 255, 255, 0.15)), color-stop(0.25, transparent), color-stop(0.5, transparent), color-stop(0.5, rgba(255, 255, 255, 0.15)), color-stop(0.75, rgba(255, 255, 255, 0.15)), color-stop(0.75, transparent), to(transparent)); + background-image: -webkit-linear-gradient(45deg, rgba(255, 255, 255, 0.15) 25%, transparent 25%, transparent 50%, rgba(255, 255, 255, 0.15) 50%, rgba(255, 255, 255, 0.15) 75%, transparent 75%, transparent); + background-image: -moz-linear-gradient(45deg, rgba(255, 255, 255, 0.15) 25%, transparent 25%, transparent 50%, rgba(255, 255, 255, 0.15) 50%, rgba(255, 255, 255, 0.15) 75%, transparent 75%, transparent); + background-image: linear-gradient(45deg, rgba(255, 255, 255, 0.15) 25%, transparent 25%, transparent 50%, rgba(255, 255, 255, 0.15) 50%, rgba(255, 255, 255, 0.15) 75%, transparent 75%, transparent); +} + +.progress-bar-warning { + background-color: #f0ad4e; +} + +.progress-striped .progress-bar-warning { + background-image: -webkit-gradient(linear, 0 100%, 100% 0, color-stop(0.25, rgba(255, 255, 255, 0.15)), color-stop(0.25, transparent), color-stop(0.5, transparent), color-stop(0.5, rgba(255, 255, 255, 0.15)), color-stop(0.75, rgba(255, 255, 255, 0.15)), color-stop(0.75, transparent), to(transparent)); + background-image: -webkit-linear-gradient(45deg, rgba(255, 255, 255, 0.15) 25%, transparent 25%, transparent 50%, rgba(255, 255, 255, 0.15) 50%, rgba(255, 255, 255, 0.15) 75%, transparent 75%, transparent); + background-image: -moz-linear-gradient(45deg, rgba(255, 255, 255, 0.15) 25%, transparent 25%, transparent 50%, rgba(255, 255, 255, 0.15) 50%, rgba(255, 255, 255, 0.15) 75%, transparent 75%, transparent); + background-image: linear-gradient(45deg, rgba(255, 255, 255, 0.15) 25%, transparent 25%, transparent 50%, rgba(255, 255, 255, 0.15) 50%, rgba(255, 255, 255, 0.15) 75%, transparent 75%, transparent); +} + +.progress-bar-danger { + background-color: #d9534f; +} + +.progress-striped .progress-bar-danger { + background-image: -webkit-gradient(linear, 0 100%, 100% 0, color-stop(0.25, rgba(255, 255, 255, 0.15)), color-stop(0.25, transparent), color-stop(0.5, transparent), color-stop(0.5, rgba(255, 255, 255, 0.15)), color-stop(0.75, rgba(255, 255, 255, 0.15)), color-stop(0.75, transparent), to(transparent)); + background-image: -webkit-linear-gradient(45deg, rgba(255, 255, 255, 0.15) 25%, transparent 25%, transparent 50%, rgba(255, 255, 255, 0.15) 50%, rgba(255, 255, 255, 0.15) 75%, transparent 75%, transparent); + background-image: -moz-linear-gradient(45deg, rgba(255, 255, 255, 0.15) 25%, transparent 25%, transparent 50%, rgba(255, 255, 255, 0.15) 50%, rgba(255, 255, 255, 0.15) 75%, transparent 75%, transparent); + background-image: linear-gradient(45deg, rgba(255, 255, 255, 0.15) 25%, transparent 25%, transparent 50%, rgba(255, 255, 255, 0.15) 50%, rgba(255, 255, 255, 0.15) 75%, transparent 75%, transparent); +} + +.media, +.media-body { + overflow: hidden; + zoom: 1; +} + +.media, +.media .media { + margin-top: 15px; +} + +.media:first-child { + margin-top: 0; +} + +.media-object { + display: block; +} + +.media-heading { + margin: 0 0 5px; +} + +.media > .pull-left { + margin-right: 10px; +} + +.media > .pull-right { + margin-left: 10px; +} + +.media-list { + padding-left: 0; + list-style: none; +} + +.list-group { + padding-left: 0; + margin-bottom: 20px; +} + +.list-group-item { + position: relative; + display: block; + padding: 10px 15px; + margin-bottom: -1px; + background-color: #ffffff; + border: 1px solid #dddddd; +} + +.list-group-item:first-child { + border-top-right-radius: 4px; + border-top-left-radius: 4px; +} + +.list-group-item:last-child { + margin-bottom: 0; + border-bottom-right-radius: 4px; + border-bottom-left-radius: 4px; +} + +.list-group-item > .badge { + float: right; +} + +.list-group-item > .badge + .badge { + margin-right: 5px; +} + +a.list-group-item { + color: #555555; +} + +a.list-group-item .list-group-item-heading { + color: #333333; +} + +a.list-group-item:hover, +a.list-group-item:focus { + text-decoration: none; + background-color: #f5f5f5; +} + +a.list-group-item.active, +a.list-group-item.active:hover, +a.list-group-item.active:focus { + z-index: 2; + color: #ffffff; + background-color: #428bca; + border-color: #428bca; +} + +a.list-group-item.active .list-group-item-heading, +a.list-group-item.active:hover .list-group-item-heading, +a.list-group-item.active:focus .list-group-item-heading { + color: inherit; +} + +a.list-group-item.active .list-group-item-text, +a.list-group-item.active:hover .list-group-item-text, +a.list-group-item.active:focus .list-group-item-text { + color: #e1edf7; +} + +.list-group-item-heading { + margin-top: 0; + margin-bottom: 5px; +} + +.list-group-item-text { + margin-bottom: 0; + line-height: 1.3; +} + +.panel { + margin-bottom: 20px; + background-color: #ffffff; + border: 1px solid transparent; + border-radius: 4px; + -webkit-box-shadow: 0 1px 1px rgba(0, 0, 0, 0.05); + box-shadow: 0 1px 1px rgba(0, 0, 0, 0.05); +} + +.panel-body { + padding: 15px; +} + +.panel-body:before, +.panel-body:after { + display: table; + content: " "; +} + +.panel-body:after { + clear: both; +} + +.panel-body:before, +.panel-body:after { + display: table; + content: " "; +} + +.panel-body:after { + clear: both; +} + +.panel > .list-group { + margin-bottom: 0; +} + +.panel > .list-group .list-group-item { + border-width: 1px 0; +} + +.panel > .list-group .list-group-item:first-child { + border-top-right-radius: 0; + border-top-left-radius: 0; +} + +.panel > .list-group .list-group-item:last-child { + border-bottom: 0; +} + +.panel-heading + .list-group .list-group-item:first-child { + border-top-width: 0; +} + +.panel > .table, +.panel > .table-responsive { + margin-bottom: 0; +} + +.panel > .panel-body + .table, +.panel > .panel-body + .table-responsive { + border-top: 1px solid #dddddd; +} + +.panel > .table-bordered, +.panel > .table-responsive > .table-bordered { + border: 0; +} + +.panel > .table-bordered > thead > tr > th:first-child, +.panel > .table-responsive > .table-bordered > thead > tr > th:first-child, +.panel > .table-bordered > tbody > tr > th:first-child, +.panel > .table-responsive > .table-bordered > tbody > tr > th:first-child, +.panel > .table-bordered > tfoot > tr > th:first-child, +.panel > .table-responsive > .table-bordered > tfoot > tr > th:first-child, +.panel > .table-bordered > thead > tr > td:first-child, +.panel > .table-responsive > .table-bordered > thead > tr > td:first-child, +.panel > .table-bordered > tbody > tr > td:first-child, +.panel > .table-responsive > .table-bordered > tbody > tr > td:first-child, +.panel > .table-bordered > tfoot > tr > td:first-child, +.panel > .table-responsive > .table-bordered > tfoot > tr > td:first-child { + border-left: 0; +} + +.panel > .table-bordered > thead > tr > th:last-child, +.panel > .table-responsive > .table-bordered > thead > tr > th:last-child, +.panel > .table-bordered > tbody > tr > th:last-child, +.panel > .table-responsive > .table-bordered > tbody > tr > th:last-child, +.panel > .table-bordered > tfoot > tr > th:last-child, +.panel > .table-responsive > .table-bordered > tfoot > tr > th:last-child, +.panel > .table-bordered > thead > tr > td:last-child, +.panel > .table-responsive > .table-bordered > thead > tr > td:last-child, +.panel > .table-bordered > tbody > tr > td:last-child, +.panel > .table-responsive > .table-bordered > tbody > tr > td:last-child, +.panel > .table-bordered > tfoot > tr > td:last-child, +.panel > .table-responsive > .table-bordered > tfoot > tr > td:last-child { + border-right: 0; +} + +.panel > .table-bordered > thead > tr:last-child > th, +.panel > .table-responsive > .table-bordered > thead > tr:last-child > th, +.panel > .table-bordered > tbody > tr:last-child > th, +.panel > .table-responsive > .table-bordered > tbody > tr:last-child > th, +.panel > .table-bordered > tfoot > tr:last-child > th, +.panel > .table-responsive > .table-bordered > tfoot > tr:last-child > th, +.panel > .table-bordered > thead > tr:last-child > td, +.panel > .table-responsive > .table-bordered > thead > tr:last-child > td, +.panel > .table-bordered > tbody > tr:last-child > td, +.panel > .table-responsive > .table-bordered > tbody > tr:last-child > td, +.panel > .table-bordered > tfoot > tr:last-child > td, +.panel > .table-responsive > .table-bordered > tfoot > tr:last-child > td { + border-bottom: 0; +} + +.panel-heading { + padding: 10px 15px; + border-bottom: 1px solid transparent; + border-top-right-radius: 3px; + border-top-left-radius: 3px; +} + +.panel-heading > .dropdown .dropdown-toggle { + color: inherit; +} + +.panel-title { + margin-top: 0; + margin-bottom: 0; + font-size: 16px; +} + +.panel-title > a { + color: inherit; +} + +.panel-footer { + padding: 10px 15px; + background-color: #f5f5f5; + border-top: 1px solid #dddddd; + border-bottom-right-radius: 3px; + border-bottom-left-radius: 3px; +} + +.panel-group .panel { + margin-bottom: 0; + overflow: hidden; + border-radius: 4px; +} + +.panel-group .panel + .panel { + margin-top: 5px; +} + +.panel-group .panel-heading { + border-bottom: 0; +} + +.panel-group .panel-heading + .panel-collapse .panel-body { + border-top: 1px solid #dddddd; +} + +.panel-group .panel-footer { + border-top: 0; +} + +.panel-group .panel-footer + .panel-collapse .panel-body { + border-bottom: 1px solid #dddddd; +} + +.panel-default { + border-color: #dddddd; +} + +.panel-default > .panel-heading { + color: #333333; + background-color: #f5f5f5; + border-color: #dddddd; +} + +.panel-default > .panel-heading + .panel-collapse .panel-body { + border-top-color: #dddddd; +} + +.panel-default > .panel-heading > .dropdown .caret { + border-color: #333333 transparent; +} + +.panel-default > .panel-footer + .panel-collapse .panel-body { + border-bottom-color: #dddddd; +} + +.panel-primary { + border-color: #428bca; +} + +.panel-primary > .panel-heading { + color: #ffffff; + background-color: #428bca; + border-color: #428bca; +} + +.panel-primary > .panel-heading + .panel-collapse .panel-body { + border-top-color: #428bca; +} + +.panel-primary > .panel-heading > .dropdown .caret { + border-color: #ffffff transparent; +} + +.panel-primary > .panel-footer + .panel-collapse .panel-body { + border-bottom-color: #428bca; +} + +.panel-success { + border-color: #d6e9c6; +} + +.panel-success > .panel-heading { + color: #468847; + background-color: #dff0d8; + border-color: #d6e9c6; +} + +.panel-success > .panel-heading + .panel-collapse .panel-body { + border-top-color: #d6e9c6; +} + +.panel-success > .panel-heading > .dropdown .caret { + border-color: #468847 transparent; +} + +.panel-success > .panel-footer + .panel-collapse .panel-body { + border-bottom-color: #d6e9c6; +} + +.panel-warning { + border-color: #faebcc; +} + +.panel-warning > .panel-heading { + color: #c09853; + background-color: #fcf8e3; + border-color: #faebcc; +} + +.panel-warning > .panel-heading + .panel-collapse .panel-body { + border-top-color: #faebcc; +} + +.panel-warning > .panel-heading > .dropdown .caret { + border-color: #c09853 transparent; +} + +.panel-warning > .panel-footer + .panel-collapse .panel-body { + border-bottom-color: #faebcc; +} + +.panel-danger { + border-color: #ebccd1; +} + +.panel-danger > .panel-heading { + color: #b94a48; + background-color: #f2dede; + border-color: #ebccd1; +} + +.panel-danger > .panel-heading + .panel-collapse .panel-body { + border-top-color: #ebccd1; +} + +.panel-danger > .panel-heading > .dropdown .caret { + border-color: #b94a48 transparent; +} + +.panel-danger > .panel-footer + .panel-collapse .panel-body { + border-bottom-color: #ebccd1; +} + +.panel-info { + border-color: #bce8f1; +} + +.panel-info > .panel-heading { + color: #3a87ad; + background-color: #d9edf7; + border-color: #bce8f1; +} + +.panel-info > .panel-heading + .panel-collapse .panel-body { + border-top-color: #bce8f1; +} + +.panel-info > .panel-heading > .dropdown .caret { + border-color: #3a87ad transparent; +} + +.panel-info > .panel-footer + .panel-collapse .panel-body { + border-bottom-color: #bce8f1; +} + +.well { + min-height: 20px; + padding: 19px; + margin-bottom: 20px; + background-color: #f5f5f5; + border: 1px solid #e3e3e3; + border-radius: 4px; + -webkit-box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.05); + box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.05); +} + +.well blockquote { + border-color: #ddd; + border-color: rgba(0, 0, 0, 0.15); +} + +.well-lg { + padding: 24px; + border-radius: 6px; +} + +.well-sm { + padding: 9px; + border-radius: 3px; +} + +.close { + float: right; + font-size: 21px; + font-weight: bold; + line-height: 1; + color: #000000; + text-shadow: 0 1px 0 #ffffff; + opacity: 0.2; + filter: alpha(opacity=20); +} + +.close:hover, +.close:focus { + color: #000000; + text-decoration: none; + cursor: pointer; + opacity: 0.5; + filter: alpha(opacity=50); +} + +button.close { + padding: 0; + cursor: pointer; + background: transparent; + border: 0; + -webkit-appearance: none; +} + +.modal-open { + overflow: hidden; +} + +.modal { + position: fixed; + top: 0; + right: 0; + bottom: 0; + left: 0; + z-index: 1040; + display: none; + overflow: auto; + overflow-y: scroll; +} + +.modal.fade .modal-dialog { + -webkit-transform: translate(0, -25%); + -ms-transform: translate(0, -25%); + transform: translate(0, -25%); + -webkit-transition: -webkit-transform 0.3s ease-out; + -moz-transition: -moz-transform 0.3s ease-out; + -o-transition: -o-transform 0.3s ease-out; + transition: transform 0.3s ease-out; +} + +.modal.in .modal-dialog { + -webkit-transform: translate(0, 0); + -ms-transform: translate(0, 0); + transform: translate(0, 0); +} + +.modal-dialog { + position: relative; + z-index: 1050; + width: auto; + padding: 10px; + margin-right: auto; + margin-left: auto; +} + +.modal-content { + position: relative; + background-color: #ffffff; + border: 1px solid #999999; + border: 1px solid rgba(0, 0, 0, 0.2); + border-radius: 6px; + outline: none; + -webkit-box-shadow: 0 3px 9px rgba(0, 0, 0, 0.5); + box-shadow: 0 3px 9px rgba(0, 0, 0, 0.5); + background-clip: padding-box; +} + +.modal-backdrop { + position: fixed; + top: 0; + right: 0; + bottom: 0; + left: 0; + z-index: 1030; + background-color: #000000; +} + +.modal-backdrop.fade { + opacity: 0; + filter: alpha(opacity=0); +} + +.modal-backdrop.in { + opacity: 0.5; + filter: alpha(opacity=50); +} + +.modal-header { + min-height: 16.428571429px; + padding: 15px; + border-bottom: 1px solid #e5e5e5; +} + +.modal-header .close { + margin-top: -2px; +} + +.modal-title { + margin: 0; + line-height: 1.428571429; +} + +.modal-body { + position: relative; + padding: 20px; +} + +.modal-footer { + padding: 19px 20px 20px; + margin-top: 15px; + text-align: right; + border-top: 1px solid #e5e5e5; +} + +.modal-footer:before, +.modal-footer:after { + display: table; + content: " "; +} + +.modal-footer:after { + clear: both; +} + +.modal-footer:before, +.modal-footer:after { + display: table; + content: " "; +} + +.modal-footer:after { + clear: both; +} + +.modal-footer .btn + .btn { + margin-bottom: 0; + margin-left: 5px; +} + +.modal-footer .btn-group .btn + .btn { + margin-left: -1px; +} + +.modal-footer .btn-block + .btn-block { + margin-left: 0; +} + +@media screen and (min-width: 768px) { + .modal-dialog { + width: 600px; + padding-top: 30px; + padding-bottom: 30px; + } + .modal-content { + -webkit-box-shadow: 0 5px 15px rgba(0, 0, 0, 0.5); + box-shadow: 0 5px 15px rgba(0, 0, 0, 0.5); + } +} + +.tooltip { + position: absolute; + z-index: 1030; + display: block; + font-size: 12px; + line-height: 1.4; + opacity: 0; + filter: alpha(opacity=0); + visibility: visible; +} + +.tooltip.in { + opacity: 0.9; + filter: alpha(opacity=90); +} + +.tooltip.top { + padding: 5px 0; + margin-top: -3px; +} + +.tooltip.right { + padding: 0 5px; + margin-left: 3px; +} + +.tooltip.bottom { + padding: 5px 0; + margin-top: 3px; +} + +.tooltip.left { + padding: 0 5px; + margin-left: -3px; +} + +.tooltip-inner { + max-width: 200px; + padding: 3px 8px; + color: #ffffff; + text-align: center; + text-decoration: none; + background-color: #000000; + border-radius: 4px; +} + +.tooltip-arrow { + position: absolute; + width: 0; + height: 0; + border-color: transparent; + border-style: solid; +} + +.tooltip.top .tooltip-arrow { + bottom: 0; + left: 50%; + margin-left: -5px; + border-top-color: #000000; + border-width: 5px 5px 0; +} + +.tooltip.top-left .tooltip-arrow { + bottom: 0; + left: 5px; + border-top-color: #000000; + border-width: 5px 5px 0; +} + +.tooltip.top-right .tooltip-arrow { + right: 5px; + bottom: 0; + border-top-color: #000000; + border-width: 5px 5px 0; +} + +.tooltip.right .tooltip-arrow { + top: 50%; + left: 0; + margin-top: -5px; + border-right-color: #000000; + border-width: 5px 5px 5px 0; +} + +.tooltip.left .tooltip-arrow { + top: 50%; + right: 0; + margin-top: -5px; + border-left-color: #000000; + border-width: 5px 0 5px 5px; +} + +.tooltip.bottom .tooltip-arrow { + top: 0; + left: 50%; + margin-left: -5px; + border-bottom-color: #000000; + border-width: 0 5px 5px; +} + +.tooltip.bottom-left .tooltip-arrow { + top: 0; + left: 5px; + border-bottom-color: #000000; + border-width: 0 5px 5px; +} + +.tooltip.bottom-right .tooltip-arrow { + top: 0; + right: 5px; + border-bottom-color: #000000; + border-width: 0 5px 5px; +} + +.popover { + position: absolute; + top: 0; + left: 0; + z-index: 1010; + display: none; + max-width: 276px; + padding: 1px; + text-align: left; + white-space: normal; + background-color: #ffffff; + border: 1px solid #cccccc; + border: 1px solid rgba(0, 0, 0, 0.2); + border-radius: 6px; + -webkit-box-shadow: 0 5px 10px rgba(0, 0, 0, 0.2); + box-shadow: 0 5px 10px rgba(0, 0, 0, 0.2); + background-clip: padding-box; +} + +.popover.top { + margin-top: -10px; +} + +.popover.right { + margin-left: 10px; +} + +.popover.bottom { + margin-top: 10px; +} + +.popover.left { + margin-left: -10px; +} + +.popover-title { + padding: 8px 14px; + margin: 0; + font-size: 14px; + font-weight: normal; + line-height: 18px; + background-color: #f7f7f7; + border-bottom: 1px solid #ebebeb; + border-radius: 5px 5px 0 0; +} + +.popover-content { + padding: 9px 14px; +} + +.popover .arrow, +.popover .arrow:after { + position: absolute; + display: block; + width: 0; + height: 0; + border-color: transparent; + border-style: solid; +} + +.popover .arrow { + border-width: 11px; +} + +.popover .arrow:after { + border-width: 10px; + content: ""; +} + +.popover.top .arrow { + bottom: -11px; + left: 50%; + margin-left: -11px; + border-top-color: #999999; + border-top-color: rgba(0, 0, 0, 0.25); + border-bottom-width: 0; +} + +.popover.top .arrow:after { + bottom: 1px; + margin-left: -10px; + border-top-color: #ffffff; + border-bottom-width: 0; + content: " "; +} + +.popover.right .arrow { + top: 50%; + left: -11px; + margin-top: -11px; + border-right-color: #999999; + border-right-color: rgba(0, 0, 0, 0.25); + border-left-width: 0; +} + +.popover.right .arrow:after { + bottom: -10px; + left: 1px; + border-right-color: #ffffff; + border-left-width: 0; + content: " "; +} + +.popover.bottom .arrow { + top: -11px; + left: 50%; + margin-left: -11px; + border-bottom-color: #999999; + border-bottom-color: rgba(0, 0, 0, 0.25); + border-top-width: 0; +} + +.popover.bottom .arrow:after { + top: 1px; + margin-left: -10px; + border-bottom-color: #ffffff; + border-top-width: 0; + content: " "; +} + +.popover.left .arrow { + top: 50%; + right: -11px; + margin-top: -11px; + border-left-color: #999999; + border-left-color: rgba(0, 0, 0, 0.25); + border-right-width: 0; +} + +.popover.left .arrow:after { + right: 1px; + bottom: -10px; + border-left-color: #ffffff; + border-right-width: 0; + content: " "; +} + +.carousel { + position: relative; +} + +.carousel-inner { + position: relative; + width: 100%; + overflow: hidden; +} + +.carousel-inner > .item { + position: relative; + display: none; + -webkit-transition: 0.6s ease-in-out left; + transition: 0.6s ease-in-out left; +} + +.carousel-inner > .item > img, +.carousel-inner > .item > a > img { + display: block; + height: auto; + max-width: 100%; + line-height: 1; +} + +.carousel-inner > .active, +.carousel-inner > .next, +.carousel-inner > .prev { + display: block; +} + +.carousel-inner > .active { + left: 0; +} + +.carousel-inner > .next, +.carousel-inner > .prev { + position: absolute; + top: 0; + width: 100%; +} + +.carousel-inner > .next { + left: 100%; +} + +.carousel-inner > .prev { + left: -100%; +} + +.carousel-inner > .next.left, +.carousel-inner > .prev.right { + left: 0; +} + +.carousel-inner > .active.left { + left: -100%; +} + +.carousel-inner > .active.right { + left: 100%; +} + +.carousel-control { + position: absolute; + top: 0; + bottom: 0; + left: 0; + width: 15%; + font-size: 20px; + color: #ffffff; + text-align: center; + text-shadow: 0 1px 2px rgba(0, 0, 0, 0.6); + opacity: 0.5; + filter: alpha(opacity=50); +} + +.carousel-control.left { + background-image: -webkit-gradient(linear, 0 top, 100% top, from(rgba(0, 0, 0, 0.5)), to(rgba(0, 0, 0, 0.0001))); + background-image: -webkit-linear-gradient(left, color-stop(rgba(0, 0, 0, 0.5) 0), color-stop(rgba(0, 0, 0, 0.0001) 100%)); + background-image: -moz-linear-gradient(left, rgba(0, 0, 0, 0.5) 0, rgba(0, 0, 0, 0.0001) 100%); + background-image: linear-gradient(to right, rgba(0, 0, 0, 0.5) 0, rgba(0, 0, 0, 0.0001) 100%); + background-repeat: repeat-x; + filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#80000000', endColorstr='#00000000', GradientType=1); +} + +.carousel-control.right { + right: 0; + left: auto; + background-image: -webkit-gradient(linear, 0 top, 100% top, from(rgba(0, 0, 0, 0.0001)), to(rgba(0, 0, 0, 0.5))); + background-image: -webkit-linear-gradient(left, color-stop(rgba(0, 0, 0, 0.0001) 0), color-stop(rgba(0, 0, 0, 0.5) 100%)); + background-image: -moz-linear-gradient(left, rgba(0, 0, 0, 0.0001) 0, rgba(0, 0, 0, 0.5) 100%); + background-image: linear-gradient(to right, rgba(0, 0, 0, 0.0001) 0, rgba(0, 0, 0, 0.5) 100%); + background-repeat: repeat-x; + filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#00000000', endColorstr='#80000000', GradientType=1); +} + +.carousel-control:hover, +.carousel-control:focus { + color: #ffffff; + text-decoration: none; + opacity: 0.9; + filter: alpha(opacity=90); +} + +.carousel-control .icon-prev, +.carousel-control .icon-next, +.carousel-control .glyphicon-chevron-left, +.carousel-control .glyphicon-chevron-right { + position: absolute; + top: 50%; + z-index: 5; + display: inline-block; +} + +.carousel-control .icon-prev, +.carousel-control .glyphicon-chevron-left { + left: 50%; +} + +.carousel-control .icon-next, +.carousel-control .glyphicon-chevron-right { + right: 50%; +} + +.carousel-control .icon-prev, +.carousel-control .icon-next { + width: 20px; + height: 20px; + margin-top: -10px; + margin-left: -10px; + font-family: serif; +} + +.carousel-control .icon-prev:before { + content: '\2039'; +} + +.carousel-control .icon-next:before { + content: '\203a'; +} + +.carousel-indicators { + position: absolute; + bottom: 10px; + left: 50%; + z-index: 15; + width: 60%; + padding-left: 0; + margin-left: -30%; + text-align: center; + list-style: none; +} + +.carousel-indicators li { + display: inline-block; + width: 10px; + height: 10px; + margin: 1px; + text-indent: -999px; + cursor: pointer; + background-color: #000 \9; + background-color: rgba(0, 0, 0, 0); + border: 1px solid #ffffff; + border-radius: 10px; +} + +.carousel-indicators .active { + width: 12px; + height: 12px; + margin: 0; + background-color: #ffffff; +} + +.carousel-caption { + position: absolute; + right: 15%; + bottom: 20px; + left: 15%; + z-index: 10; + padding-top: 20px; + padding-bottom: 20px; + color: #ffffff; + text-align: center; + text-shadow: 0 1px 2px rgba(0, 0, 0, 0.6); +} + +.carousel-caption .btn { + text-shadow: none; +} + +@media screen and (min-width: 768px) { + .carousel-control .glyphicons-chevron-left, + .carousel-control .glyphicons-chevron-right, + .carousel-control .icon-prev, + .carousel-control .icon-next { + width: 30px; + height: 30px; + margin-top: -15px; + margin-left: -15px; + font-size: 30px; + } + .carousel-caption { + right: 20%; + left: 20%; + padding-bottom: 30px; + } + .carousel-indicators { + bottom: 20px; + } +} + +.clearfix:before, +.clearfix:after { + display: table; + content: " "; +} + +.clearfix:after { + clear: both; +} + +.center-block { + display: block; + margin-right: auto; + margin-left: auto; +} + +.pull-right { + float: right !important; +} + +.pull-left { + float: left !important; +} + +.hide { + display: none !important; +} + +.show { + display: block !important; +} + +.invisible { + visibility: hidden; +} + +.text-hide { + font: 0/0 a; + color: transparent; + text-shadow: none; + background-color: transparent; + border: 0; +} + +.hidden { + display: none !important; + visibility: hidden !important; +} + +.affix { + position: fixed; +} + +@-ms-viewport { + width: device-width; +} + +.visible-xs, +tr.visible-xs, +th.visible-xs, +td.visible-xs { + display: none !important; +} + +@media (max-width: 767px) { + .visible-xs { + display: block !important; + } + tr.visible-xs { + display: table-row !important; + } + th.visible-xs, + td.visible-xs { + display: table-cell !important; + } +} + +@media (min-width: 768px) and (max-width: 991px) { + .visible-xs.visible-sm { + display: block !important; + } + tr.visible-xs.visible-sm { + display: table-row !important; + } + th.visible-xs.visible-sm, + td.visible-xs.visible-sm { + display: table-cell !important; + } +} + +@media (min-width: 992px) and (max-width: 1199px) { + .visible-xs.visible-md { + display: block !important; + } + tr.visible-xs.visible-md { + display: table-row !important; + } + th.visible-xs.visible-md, + td.visible-xs.visible-md { + display: table-cell !important; + } +} + +@media (min-width: 1200px) { + .visible-xs.visible-lg { + display: block !important; + } + tr.visible-xs.visible-lg { + display: table-row !important; + } + th.visible-xs.visible-lg, + td.visible-xs.visible-lg { + display: table-cell !important; + } +} + +.visible-sm, +tr.visible-sm, +th.visible-sm, +td.visible-sm { + display: none !important; +} + +@media (max-width: 767px) { + .visible-sm.visible-xs { + display: block !important; + } + tr.visible-sm.visible-xs { + display: table-row !important; + } + th.visible-sm.visible-xs, + td.visible-sm.visible-xs { + display: table-cell !important; + } +} + +@media (min-width: 768px) and (max-width: 991px) { + .visible-sm { + display: block !important; + } + tr.visible-sm { + display: table-row !important; + } + th.visible-sm, + td.visible-sm { + display: table-cell !important; + } +} + +@media (min-width: 992px) and (max-width: 1199px) { + .visible-sm.visible-md { + display: block !important; + } + tr.visible-sm.visible-md { + display: table-row !important; + } + th.visible-sm.visible-md, + td.visible-sm.visible-md { + display: table-cell !important; + } +} + +@media (min-width: 1200px) { + .visible-sm.visible-lg { + display: block !important; + } + tr.visible-sm.visible-lg { + display: table-row !important; + } + th.visible-sm.visible-lg, + td.visible-sm.visible-lg { + display: table-cell !important; + } +} + +.visible-md, +tr.visible-md, +th.visible-md, +td.visible-md { + display: none !important; +} + +@media (max-width: 767px) { + .visible-md.visible-xs { + display: block !important; + } + tr.visible-md.visible-xs { + display: table-row !important; + } + th.visible-md.visible-xs, + td.visible-md.visible-xs { + display: table-cell !important; + } +} + +@media (min-width: 768px) and (max-width: 991px) { + .visible-md.visible-sm { + display: block !important; + } + tr.visible-md.visible-sm { + display: table-row !important; + } + th.visible-md.visible-sm, + td.visible-md.visible-sm { + display: table-cell !important; + } +} + +@media (min-width: 992px) and (max-width: 1199px) { + .visible-md { + display: block !important; + } + tr.visible-md { + display: table-row !important; + } + th.visible-md, + td.visible-md { + display: table-cell !important; + } +} + +@media (min-width: 1200px) { + .visible-md.visible-lg { + display: block !important; + } + tr.visible-md.visible-lg { + display: table-row !important; + } + th.visible-md.visible-lg, + td.visible-md.visible-lg { + display: table-cell !important; + } +} + +.visible-lg, +tr.visible-lg, +th.visible-lg, +td.visible-lg { + display: none !important; +} + +@media (max-width: 767px) { + .visible-lg.visible-xs { + display: block !important; + } + tr.visible-lg.visible-xs { + display: table-row !important; + } + th.visible-lg.visible-xs, + td.visible-lg.visible-xs { + display: table-cell !important; + } +} + +@media (min-width: 768px) and (max-width: 991px) { + .visible-lg.visible-sm { + display: block !important; + } + tr.visible-lg.visible-sm { + display: table-row !important; + } + th.visible-lg.visible-sm, + td.visible-lg.visible-sm { + display: table-cell !important; + } +} + +@media (min-width: 992px) and (max-width: 1199px) { + .visible-lg.visible-md { + display: block !important; + } + tr.visible-lg.visible-md { + display: table-row !important; + } + th.visible-lg.visible-md, + td.visible-lg.visible-md { + display: table-cell !important; + } +} + +@media (min-width: 1200px) { + .visible-lg { + display: block !important; + } + tr.visible-lg { + display: table-row !important; + } + th.visible-lg, + td.visible-lg { + display: table-cell !important; + } +} + +.hidden-xs { + display: block !important; +} + +tr.hidden-xs { + display: table-row !important; +} + +th.hidden-xs, +td.hidden-xs { + display: table-cell !important; +} + +@media (max-width: 767px) { + .hidden-xs, + tr.hidden-xs, + th.hidden-xs, + td.hidden-xs { + display: none !important; + } +} + +@media (min-width: 768px) and (max-width: 991px) { + .hidden-xs.hidden-sm, + tr.hidden-xs.hidden-sm, + th.hidden-xs.hidden-sm, + td.hidden-xs.hidden-sm { + display: none !important; + } +} + +@media (min-width: 992px) and (max-width: 1199px) { + .hidden-xs.hidden-md, + tr.hidden-xs.hidden-md, + th.hidden-xs.hidden-md, + td.hidden-xs.hidden-md { + display: none !important; + } +} + +@media (min-width: 1200px) { + .hidden-xs.hidden-lg, + tr.hidden-xs.hidden-lg, + th.hidden-xs.hidden-lg, + td.hidden-xs.hidden-lg { + display: none !important; + } +} + +.hidden-sm { + display: block !important; +} + +tr.hidden-sm { + display: table-row !important; +} + +th.hidden-sm, +td.hidden-sm { + display: table-cell !important; +} + +@media (max-width: 767px) { + .hidden-sm.hidden-xs, + tr.hidden-sm.hidden-xs, + th.hidden-sm.hidden-xs, + td.hidden-sm.hidden-xs { + display: none !important; + } +} + +@media (min-width: 768px) and (max-width: 991px) { + .hidden-sm, + tr.hidden-sm, + th.hidden-sm, + td.hidden-sm { + display: none !important; + } +} + +@media (min-width: 992px) and (max-width: 1199px) { + .hidden-sm.hidden-md, + tr.hidden-sm.hidden-md, + th.hidden-sm.hidden-md, + td.hidden-sm.hidden-md { + display: none !important; + } +} + +@media (min-width: 1200px) { + .hidden-sm.hidden-lg, + tr.hidden-sm.hidden-lg, + th.hidden-sm.hidden-lg, + td.hidden-sm.hidden-lg { + display: none !important; + } +} + +.hidden-md { + display: block !important; +} + +tr.hidden-md { + display: table-row !important; +} + +th.hidden-md, +td.hidden-md { + display: table-cell !important; +} + +@media (max-width: 767px) { + .hidden-md.hidden-xs, + tr.hidden-md.hidden-xs, + th.hidden-md.hidden-xs, + td.hidden-md.hidden-xs { + display: none !important; + } +} + +@media (min-width: 768px) and (max-width: 991px) { + .hidden-md.hidden-sm, + tr.hidden-md.hidden-sm, + th.hidden-md.hidden-sm, + td.hidden-md.hidden-sm { + display: none !important; + } +} + +@media (min-width: 992px) and (max-width: 1199px) { + .hidden-md, + tr.hidden-md, + th.hidden-md, + td.hidden-md { + display: none !important; + } +} + +@media (min-width: 1200px) { + .hidden-md.hidden-lg, + tr.hidden-md.hidden-lg, + th.hidden-md.hidden-lg, + td.hidden-md.hidden-lg { + display: none !important; + } +} + +.hidden-lg { + display: block !important; +} + +tr.hidden-lg { + display: table-row !important; +} + +th.hidden-lg, +td.hidden-lg { + display: table-cell !important; +} + +@media (max-width: 767px) { + .hidden-lg.hidden-xs, + tr.hidden-lg.hidden-xs, + th.hidden-lg.hidden-xs, + td.hidden-lg.hidden-xs { + display: none !important; + } +} + +@media (min-width: 768px) and (max-width: 991px) { + .hidden-lg.hidden-sm, + tr.hidden-lg.hidden-sm, + th.hidden-lg.hidden-sm, + td.hidden-lg.hidden-sm { + display: none !important; + } +} + +@media (min-width: 992px) and (max-width: 1199px) { + .hidden-lg.hidden-md, + tr.hidden-lg.hidden-md, + th.hidden-lg.hidden-md, + td.hidden-lg.hidden-md { + display: none !important; + } +} + +@media (min-width: 1200px) { + .hidden-lg, + tr.hidden-lg, + th.hidden-lg, + td.hidden-lg { + display: none !important; + } +} + +.visible-print, +tr.visible-print, +th.visible-print, +td.visible-print { + display: none !important; +} + +@media print { + .visible-print { + display: block !important; + } + tr.visible-print { + display: table-row !important; + } + th.visible-print, + td.visible-print { + display: table-cell !important; + } + .hidden-print, + tr.hidden-print, + th.hidden-print, + td.hidden-print { + display: none !important; + } +} \ No newline at end of file diff --git a/docs/theme/mkdocs/css/bootstrap-custom.min.css b/docs/theme/mkdocs/css/bootstrap-custom.min.css new file mode 100644 index 0000000000..74ffc98dc4 --- /dev/null +++ b/docs/theme/mkdocs/css/bootstrap-custom.min.css @@ -0,0 +1,7 @@ +/*! + * Bootstrap v3.0.2 by @fat and @mdo + * Copyright 2013 Twitter, Inc. + * Licensed under http://www.apache.org/licenses/LICENSE-2.0 + * + * Designed and built with all the love in the world by @mdo and @fat. + *//*! normalize.css v2.1.3 | MIT License | git.io/normalize */article,aside,details,figcaption,figure,footer,header,hgroup,main,nav,section,summary{display:block}audio,canvas,video{display:inline-block}audio:not([controls]){display:none;height:0}[hidden],template{display:none}html{font-family:sans-serif;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a{background:transparent}a:focus{outline:thin dotted}a:active,a:hover{outline:0}h1{margin:.67em 0;font-size:2em}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:bold}dfn{font-style:italic}hr{height:0;-moz-box-sizing:content-box;box-sizing:content-box}mark{color:#000;background:#ff0}code,kbd,pre,samp{font-family:monospace,serif;font-size:1em}pre{white-space:pre-wrap}q{quotes:"\201C" "\201D" "\2018" "\2019"}small{font-size:80%}sub,sup{position:relative;font-size:75%;line-height:0;vertical-align:baseline}sup{top:-0.5em}sub{bottom:-0.25em}img{border:0}svg:not(:root){overflow:hidden}figure{margin:0}fieldset{padding:.35em .625em .75em;margin:0 2px;border:1px solid silver}legend{padding:0;border:0}button,input,select,textarea{margin:0;font-family:inherit;font-size:100%}button,input{line-height:normal}button,select{text-transform:none}button,html input[type="button"],input[type="reset"],input[type="submit"]{cursor:pointer;-webkit-appearance:button}button[disabled],html input[disabled]{cursor:default}input[type="checkbox"],input[type="radio"]{padding:0;box-sizing:border-box}input[type="search"]{-webkit-box-sizing:content-box;-moz-box-sizing:content-box;box-sizing:content-box;-webkit-appearance:textfield}input[type="search"]::-webkit-search-cancel-button,input[type="search"]::-webkit-search-decoration{-webkit-appearance:none}button::-moz-focus-inner,input::-moz-focus-inner{padding:0;border:0}textarea{overflow:auto;vertical-align:top}table{border-collapse:collapse;border-spacing:0}@media print{*{color:#000 !important;text-shadow:none !important;background:transparent !important;box-shadow:none !important}a,a:visited{text-decoration:underline}a[href]:after{content:" (" attr(href) ")"}abbr[title]:after{content:" (" attr(title) ")"}a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:2cm .5cm}p,h2,h3{orphans:3;widows:3}h2,h3{page-break-after:avoid}select{background:#fff !important}.navbar{display:none}.table td,.table th{background-color:#fff !important}.btn>.caret,.dropup>.btn>.caret{border-top-color:#000 !important}.label{border:1px solid #000}.table{border-collapse:collapse !important}.table-bordered th,.table-bordered td{border:1px solid #ddd !important}}*,*:before,*:after{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:62.5%;-webkit-tap-highlight-color:rgba(0,0,0,0)}body{font-family:"Helvetica Neue",Helvetica,Arial,sans-serif;font-size:14px;line-height:1.428571429;color:#333;background-color:#fff}input,button,select,textarea{font-family:inherit;font-size:inherit;line-height:inherit}a{color:#428bca;text-decoration:none}a:hover,a:focus{color:#2a6496;text-decoration:underline}a:focus{outline:thin dotted #333;outline:5px auto -webkit-focus-ring-color;outline-offset:-2px}img{vertical-align:middle}.img-responsive{display:block;height:auto;max-width:100%}.img-rounded{border-radius:6px}.img-thumbnail{display:inline-block;height:auto;max-width:100%;padding:4px;line-height:1.428571429;background-color:#fff;border:1px solid #ddd;border-radius:4px;-webkit-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.img-circle{border-radius:50%}hr{margin-top:20px;margin-bottom:20px;border:0;border-top:1px solid #eee}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);border:0}p{margin:0 0 10px}.lead{margin-bottom:20px;font-size:16px;font-weight:200;line-height:1.4}@media(min-width:768px){.lead{font-size:21px}}small,.small{font-size:85%}cite{font-style:normal}.text-muted{color:#999}.text-primary{color:#428bca}.text-primary:hover{color:#3071a9}.text-warning{color:#c09853}.text-warning:hover{color:#a47e3c}.text-danger{color:#b94a48}.text-danger:hover{color:#953b39}.text-success{color:#468847}.text-success:hover{color:#356635}.text-info{color:#3a87ad}.text-info:hover{color:#2d6987}.text-left{text-align:left}.text-right{text-align:right}.text-center{text-align:center}h1,h2,h3,h4,h5,h6,.h1,.h2,.h3,.h4,.h5,.h6{font-family:"Helvetica Neue",Helvetica,Arial,sans-serif;font-weight:500;line-height:1.1;color:inherit}h1 small,h2 small,h3 small,h4 small,h5 small,h6 small,.h1 small,.h2 small,.h3 small,.h4 small,.h5 small,.h6 small,h1 .small,h2 .small,h3 .small,h4 .small,h5 .small,h6 .small,.h1 .small,.h2 .small,.h3 .small,.h4 .small,.h5 .small,.h6 .small{font-weight:normal;line-height:1;color:#999}h1,h2,h3{margin-top:20px;margin-bottom:10px}h1 small,h2 small,h3 small,h1 .small,h2 .small,h3 .small{font-size:65%}h4,h5,h6{margin-top:10px;margin-bottom:10px}h4 small,h5 small,h6 small,h4 .small,h5 .small,h6 .small{font-size:75%}h1,.h1{font-size:36px}h2,.h2{font-size:30px}h3,.h3{font-size:24px}h4,.h4{font-size:18px}h5,.h5{font-size:14px}h6,.h6{font-size:12px}.page-header{padding-bottom:9px;margin:40px 0 20px;border-bottom:1px solid #eee}ul,ol{margin-top:0;margin-bottom:10px}ul ul,ol ul,ul ol,ol ol{margin-bottom:0}.list-unstyled{padding-left:0;list-style:none}.list-inline{padding-left:0;list-style:none}.list-inline>li{display:inline-block;padding-right:5px;padding-left:5px}.list-inline>li:first-child{padding-left:0}dl{margin-bottom:20px}dt,dd{line-height:1.428571429}dt{font-weight:bold}dd{margin-left:0}@media(min-width:768px){.dl-horizontal dt{float:left;width:160px;overflow:hidden;clear:left;text-align:right;text-overflow:ellipsis;white-space:nowrap}.dl-horizontal dd{margin-left:180px}.dl-horizontal dd:before,.dl-horizontal dd:after{display:table;content:" "}.dl-horizontal dd:after{clear:both}.dl-horizontal dd:before,.dl-horizontal dd:after{display:table;content:" "}.dl-horizontal dd:after{clear:both}}abbr[title],abbr[data-original-title]{cursor:help;border-bottom:1px dotted #999}abbr.initialism{font-size:90%;text-transform:uppercase}blockquote{padding:10px 20px;margin:0 0 20px;border-left:5px solid #eee}blockquote p{font-size:17.5px;font-weight:300;line-height:1.25}blockquote p:last-child{margin-bottom:0}blockquote small{display:block;line-height:1.428571429;color:#999}blockquote small:before{content:'\2014 \00A0'}blockquote.pull-right{padding-right:15px;padding-left:0;border-right:5px solid #eee;border-left:0}blockquote.pull-right p,blockquote.pull-right small,blockquote.pull-right .small{text-align:right}blockquote.pull-right small:before,blockquote.pull-right .small:before{content:''}blockquote.pull-right small:after,blockquote.pull-right .small:after{content:'\00A0 \2014'}blockquote:before,blockquote:after{content:""}address{margin-bottom:20px;font-style:normal;line-height:1.428571429}code,kbd,pre,samp{font-family:Monaco,Menlo,Consolas,"Courier New",monospace}code{padding:2px 4px;font-size:90%;color:#c7254e;white-space:nowrap;background-color:#f9f2f4;border-radius:4px}pre{display:block;padding:9.5px;margin:0 0 10px;font-size:13px;line-height:1.428571429;color:#333;word-break:break-all;word-wrap:break-word;background-color:#f5f5f5;border:1px solid #ccc;border-radius:4px}pre code{padding:0;font-size:inherit;color:inherit;white-space:pre-wrap;background-color:transparent;border-radius:0}.pre-scrollable{max-height:340px;overflow-y:scroll}.container{padding-right:15px;padding-left:15px;margin-right:auto;margin-left:auto}.container:before,.container:after{display:table;content:" "}.container:after{clear:both}.container:before,.container:after{display:table;content:" "}.container:after{clear:both}.row{margin-right:-15px;margin-left:-15px}.row:before,.row:after{display:table;content:" "}.row:after{clear:both}.row:before,.row:after{display:table;content:" "}.row:after{clear:both}.col-xs-1,.col-sm-1,.col-md-1,.col-lg-1,.col-xs-2,.col-sm-2,.col-md-2,.col-lg-2,.col-xs-3,.col-sm-3,.col-md-3,.col-lg-3,.col-xs-4,.col-sm-4,.col-md-4,.col-lg-4,.col-xs-5,.col-sm-5,.col-md-5,.col-lg-5,.col-xs-6,.col-sm-6,.col-md-6,.col-lg-6,.col-xs-7,.col-sm-7,.col-md-7,.col-lg-7,.col-xs-8,.col-sm-8,.col-md-8,.col-lg-8,.col-xs-9,.col-sm-9,.col-md-9,.col-lg-9,.col-xs-10,.col-sm-10,.col-md-10,.col-lg-10,.col-xs-11,.col-sm-11,.col-md-11,.col-lg-11,.col-xs-12,.col-sm-12,.col-md-12,.col-lg-12{position:relative;min-height:1px;padding-right:15px;padding-left:15px}.col-xs-1,.col-xs-2,.col-xs-3,.col-xs-4,.col-xs-5,.col-xs-6,.col-xs-7,.col-xs-8,.col-xs-9,.col-xs-10,.col-xs-11{float:left}.col-xs-12{width:100%}.col-xs-11{width:91.66666666666666%}.col-xs-10{width:83.33333333333334%}.col-xs-9{width:75%}.col-xs-8{width:66.66666666666666%}.col-xs-7{width:58.333333333333336%}.col-xs-6{width:50%}.col-xs-5{width:41.66666666666667%}.col-xs-4{width:33.33333333333333%}.col-xs-3{width:25%}.col-xs-2{width:16.666666666666664%}.col-xs-1{width:8.333333333333332%}.col-xs-pull-12{right:100%}.col-xs-pull-11{right:91.66666666666666%}.col-xs-pull-10{right:83.33333333333334%}.col-xs-pull-9{right:75%}.col-xs-pull-8{right:66.66666666666666%}.col-xs-pull-7{right:58.333333333333336%}.col-xs-pull-6{right:50%}.col-xs-pull-5{right:41.66666666666667%}.col-xs-pull-4{right:33.33333333333333%}.col-xs-pull-3{right:25%}.col-xs-pull-2{right:16.666666666666664%}.col-xs-pull-1{right:8.333333333333332%}.col-xs-pull-0{right:0}.col-xs-push-12{left:100%}.col-xs-push-11{left:91.66666666666666%}.col-xs-push-10{left:83.33333333333334%}.col-xs-push-9{left:75%}.col-xs-push-8{left:66.66666666666666%}.col-xs-push-7{left:58.333333333333336%}.col-xs-push-6{left:50%}.col-xs-push-5{left:41.66666666666667%}.col-xs-push-4{left:33.33333333333333%}.col-xs-push-3{left:25%}.col-xs-push-2{left:16.666666666666664%}.col-xs-push-1{left:8.333333333333332%}.col-xs-push-0{left:0}.col-xs-offset-12{margin-left:100%}.col-xs-offset-11{margin-left:91.66666666666666%}.col-xs-offset-10{margin-left:83.33333333333334%}.col-xs-offset-9{margin-left:75%}.col-xs-offset-8{margin-left:66.66666666666666%}.col-xs-offset-7{margin-left:58.333333333333336%}.col-xs-offset-6{margin-left:50%}.col-xs-offset-5{margin-left:41.66666666666667%}.col-xs-offset-4{margin-left:33.33333333333333%}.col-xs-offset-3{margin-left:25%}.col-xs-offset-2{margin-left:16.666666666666664%}.col-xs-offset-1{margin-left:8.333333333333332%}.col-xs-offset-0{margin-left:0}@media(min-width:768px){.container{width:750px}.col-sm-1,.col-sm-2,.col-sm-3,.col-sm-4,.col-sm-5,.col-sm-6,.col-sm-7,.col-sm-8,.col-sm-9,.col-sm-10,.col-sm-11{float:left}.col-sm-12{width:100%}.col-sm-11{width:91.66666666666666%}.col-sm-10{width:83.33333333333334%}.col-sm-9{width:75%}.col-sm-8{width:66.66666666666666%}.col-sm-7{width:58.333333333333336%}.col-sm-6{width:50%}.col-sm-5{width:41.66666666666667%}.col-sm-4{width:33.33333333333333%}.col-sm-3{width:25%}.col-sm-2{width:16.666666666666664%}.col-sm-1{width:8.333333333333332%}.col-sm-pull-12{right:100%}.col-sm-pull-11{right:91.66666666666666%}.col-sm-pull-10{right:83.33333333333334%}.col-sm-pull-9{right:75%}.col-sm-pull-8{right:66.66666666666666%}.col-sm-pull-7{right:58.333333333333336%}.col-sm-pull-6{right:50%}.col-sm-pull-5{right:41.66666666666667%}.col-sm-pull-4{right:33.33333333333333%}.col-sm-pull-3{right:25%}.col-sm-pull-2{right:16.666666666666664%}.col-sm-pull-1{right:8.333333333333332%}.col-sm-pull-0{right:0}.col-sm-push-12{left:100%}.col-sm-push-11{left:91.66666666666666%}.col-sm-push-10{left:83.33333333333334%}.col-sm-push-9{left:75%}.col-sm-push-8{left:66.66666666666666%}.col-sm-push-7{left:58.333333333333336%}.col-sm-push-6{left:50%}.col-sm-push-5{left:41.66666666666667%}.col-sm-push-4{left:33.33333333333333%}.col-sm-push-3{left:25%}.col-sm-push-2{left:16.666666666666664%}.col-sm-push-1{left:8.333333333333332%}.col-sm-push-0{left:0}.col-sm-offset-12{margin-left:100%}.col-sm-offset-11{margin-left:91.66666666666666%}.col-sm-offset-10{margin-left:83.33333333333334%}.col-sm-offset-9{margin-left:75%}.col-sm-offset-8{margin-left:66.66666666666666%}.col-sm-offset-7{margin-left:58.333333333333336%}.col-sm-offset-6{margin-left:50%}.col-sm-offset-5{margin-left:41.66666666666667%}.col-sm-offset-4{margin-left:33.33333333333333%}.col-sm-offset-3{margin-left:25%}.col-sm-offset-2{margin-left:16.666666666666664%}.col-sm-offset-1{margin-left:8.333333333333332%}.col-sm-offset-0{margin-left:0}}@media(min-width:992px){.container{width:970px}.col-md-1,.col-md-2,.col-md-3,.col-md-4,.col-md-5,.col-md-6,.col-md-7,.col-md-8,.col-md-9,.col-md-10,.col-md-11{float:left}.col-md-12{width:100%}.col-md-11{width:91.66666666666666%}.col-md-10{width:83.33333333333334%}.col-md-9{width:75%}.col-md-8{width:66.66666666666666%}.col-md-7{width:58.333333333333336%}.col-md-6{width:50%}.col-md-5{width:41.66666666666667%}.col-md-4{width:33.33333333333333%}.col-md-3{width:25%}.col-md-2{width:16.666666666666664%}.col-md-1{width:8.333333333333332%}.col-md-pull-12{right:100%}.col-md-pull-11{right:91.66666666666666%}.col-md-pull-10{right:83.33333333333334%}.col-md-pull-9{right:75%}.col-md-pull-8{right:66.66666666666666%}.col-md-pull-7{right:58.333333333333336%}.col-md-pull-6{right:50%}.col-md-pull-5{right:41.66666666666667%}.col-md-pull-4{right:33.33333333333333%}.col-md-pull-3{right:25%}.col-md-pull-2{right:16.666666666666664%}.col-md-pull-1{right:8.333333333333332%}.col-md-pull-0{right:0}.col-md-push-12{left:100%}.col-md-push-11{left:91.66666666666666%}.col-md-push-10{left:83.33333333333334%}.col-md-push-9{left:75%}.col-md-push-8{left:66.66666666666666%}.col-md-push-7{left:58.333333333333336%}.col-md-push-6{left:50%}.col-md-push-5{left:41.66666666666667%}.col-md-push-4{left:33.33333333333333%}.col-md-push-3{left:25%}.col-md-push-2{left:16.666666666666664%}.col-md-push-1{left:8.333333333333332%}.col-md-push-0{left:0}.col-md-offset-12{margin-left:100%}.col-md-offset-11{margin-left:91.66666666666666%}.col-md-offset-10{margin-left:83.33333333333334%}.col-md-offset-9{margin-left:75%}.col-md-offset-8{margin-left:66.66666666666666%}.col-md-offset-7{margin-left:58.333333333333336%}.col-md-offset-6{margin-left:50%}.col-md-offset-5{margin-left:41.66666666666667%}.col-md-offset-4{margin-left:33.33333333333333%}.col-md-offset-3{margin-left:25%}.col-md-offset-2{margin-left:16.666666666666664%}.col-md-offset-1{margin-left:8.333333333333332%}.col-md-offset-0{margin-left:0}}@media(min-width:1200px){.container{width:1170px}.col-lg-1,.col-lg-2,.col-lg-3,.col-lg-4,.col-lg-5,.col-lg-6,.col-lg-7,.col-lg-8,.col-lg-9,.col-lg-10,.col-lg-11{float:left}.col-lg-12{width:100%}.col-lg-11{width:91.66666666666666%}.col-lg-10{width:83.33333333333334%}.col-lg-9{width:75%}.col-lg-8{width:66.66666666666666%}.col-lg-7{width:58.333333333333336%}.col-lg-6{width:50%}.col-lg-5{width:41.66666666666667%}.col-lg-4{width:33.33333333333333%}.col-lg-3{width:25%}.col-lg-2{width:16.666666666666664%}.col-lg-1{width:8.333333333333332%}.col-lg-pull-12{right:100%}.col-lg-pull-11{right:91.66666666666666%}.col-lg-pull-10{right:83.33333333333334%}.col-lg-pull-9{right:75%}.col-lg-pull-8{right:66.66666666666666%}.col-lg-pull-7{right:58.333333333333336%}.col-lg-pull-6{right:50%}.col-lg-pull-5{right:41.66666666666667%}.col-lg-pull-4{right:33.33333333333333%}.col-lg-pull-3{right:25%}.col-lg-pull-2{right:16.666666666666664%}.col-lg-pull-1{right:8.333333333333332%}.col-lg-pull-0{right:0}.col-lg-push-12{left:100%}.col-lg-push-11{left:91.66666666666666%}.col-lg-push-10{left:83.33333333333334%}.col-lg-push-9{left:75%}.col-lg-push-8{left:66.66666666666666%}.col-lg-push-7{left:58.333333333333336%}.col-lg-push-6{left:50%}.col-lg-push-5{left:41.66666666666667%}.col-lg-push-4{left:33.33333333333333%}.col-lg-push-3{left:25%}.col-lg-push-2{left:16.666666666666664%}.col-lg-push-1{left:8.333333333333332%}.col-lg-push-0{left:0}.col-lg-offset-12{margin-left:100%}.col-lg-offset-11{margin-left:91.66666666666666%}.col-lg-offset-10{margin-left:83.33333333333334%}.col-lg-offset-9{margin-left:75%}.col-lg-offset-8{margin-left:66.66666666666666%}.col-lg-offset-7{margin-left:58.333333333333336%}.col-lg-offset-6{margin-left:50%}.col-lg-offset-5{margin-left:41.66666666666667%}.col-lg-offset-4{margin-left:33.33333333333333%}.col-lg-offset-3{margin-left:25%}.col-lg-offset-2{margin-left:16.666666666666664%}.col-lg-offset-1{margin-left:8.333333333333332%}.col-lg-offset-0{margin-left:0}}table{max-width:100%;background-color:transparent}th{text-align:left}.table{width:100%;margin-bottom:20px}.table>thead>tr>th,.table>tbody>tr>th,.table>tfoot>tr>th,.table>thead>tr>td,.table>tbody>tr>td,.table>tfoot>tr>td{padding:8px;line-height:1.428571429;vertical-align:top;border-top:1px solid #ddd}.table>thead>tr>th{vertical-align:bottom;border-bottom:2px solid #ddd}.table>caption+thead>tr:first-child>th,.table>colgroup+thead>tr:first-child>th,.table>thead:first-child>tr:first-child>th,.table>caption+thead>tr:first-child>td,.table>colgroup+thead>tr:first-child>td,.table>thead:first-child>tr:first-child>td{border-top:0}.table>tbody+tbody{border-top:2px solid #ddd}.table .table{background-color:#fff}.table-condensed>thead>tr>th,.table-condensed>tbody>tr>th,.table-condensed>tfoot>tr>th,.table-condensed>thead>tr>td,.table-condensed>tbody>tr>td,.table-condensed>tfoot>tr>td{padding:5px}.table-bordered{border:1px solid #ddd}.table-bordered>thead>tr>th,.table-bordered>tbody>tr>th,.table-bordered>tfoot>tr>th,.table-bordered>thead>tr>td,.table-bordered>tbody>tr>td,.table-bordered>tfoot>tr>td{border:1px solid #ddd}.table-bordered>thead>tr>th,.table-bordered>thead>tr>td{border-bottom-width:2px}.table-striped>tbody>tr:nth-child(odd)>td,.table-striped>tbody>tr:nth-child(odd)>th{background-color:#f9f9f9}.table-hover>tbody>tr:hover>td,.table-hover>tbody>tr:hover>th{background-color:#f5f5f5}table col[class*="col-"]{display:table-column;float:none}table td[class*="col-"],table th[class*="col-"]{display:table-cell;float:none}.table>thead>tr>td.active,.table>tbody>tr>td.active,.table>tfoot>tr>td.active,.table>thead>tr>th.active,.table>tbody>tr>th.active,.table>tfoot>tr>th.active,.table>thead>tr.active>td,.table>tbody>tr.active>td,.table>tfoot>tr.active>td,.table>thead>tr.active>th,.table>tbody>tr.active>th,.table>tfoot>tr.active>th{background-color:#f5f5f5}.table>thead>tr>td.success,.table>tbody>tr>td.success,.table>tfoot>tr>td.success,.table>thead>tr>th.success,.table>tbody>tr>th.success,.table>tfoot>tr>th.success,.table>thead>tr.success>td,.table>tbody>tr.success>td,.table>tfoot>tr.success>td,.table>thead>tr.success>th,.table>tbody>tr.success>th,.table>tfoot>tr.success>th{background-color:#dff0d8}.table-hover>tbody>tr>td.success:hover,.table-hover>tbody>tr>th.success:hover,.table-hover>tbody>tr.success:hover>td,.table-hover>tbody>tr.success:hover>th{background-color:#d0e9c6}.table>thead>tr>td.danger,.table>tbody>tr>td.danger,.table>tfoot>tr>td.danger,.table>thead>tr>th.danger,.table>tbody>tr>th.danger,.table>tfoot>tr>th.danger,.table>thead>tr.danger>td,.table>tbody>tr.danger>td,.table>tfoot>tr.danger>td,.table>thead>tr.danger>th,.table>tbody>tr.danger>th,.table>tfoot>tr.danger>th{background-color:#f2dede}.table-hover>tbody>tr>td.danger:hover,.table-hover>tbody>tr>th.danger:hover,.table-hover>tbody>tr.danger:hover>td,.table-hover>tbody>tr.danger:hover>th{background-color:#ebcccc}.table>thead>tr>td.warning,.table>tbody>tr>td.warning,.table>tfoot>tr>td.warning,.table>thead>tr>th.warning,.table>tbody>tr>th.warning,.table>tfoot>tr>th.warning,.table>thead>tr.warning>td,.table>tbody>tr.warning>td,.table>tfoot>tr.warning>td,.table>thead>tr.warning>th,.table>tbody>tr.warning>th,.table>tfoot>tr.warning>th{background-color:#fcf8e3}.table-hover>tbody>tr>td.warning:hover,.table-hover>tbody>tr>th.warning:hover,.table-hover>tbody>tr.warning:hover>td,.table-hover>tbody>tr.warning:hover>th{background-color:#faf2cc}@media(max-width:767px){.table-responsive{width:100%;margin-bottom:15px;overflow-x:scroll;overflow-y:hidden;border:1px solid #ddd;-ms-overflow-style:-ms-autohiding-scrollbar;-webkit-overflow-scrolling:touch}.table-responsive>.table{margin-bottom:0}.table-responsive>.table>thead>tr>th,.table-responsive>.table>tbody>tr>th,.table-responsive>.table>tfoot>tr>th,.table-responsive>.table>thead>tr>td,.table-responsive>.table>tbody>tr>td,.table-responsive>.table>tfoot>tr>td{white-space:nowrap}.table-responsive>.table-bordered{border:0}.table-responsive>.table-bordered>thead>tr>th:first-child,.table-responsive>.table-bordered>tbody>tr>th:first-child,.table-responsive>.table-bordered>tfoot>tr>th:first-child,.table-responsive>.table-bordered>thead>tr>td:first-child,.table-responsive>.table-bordered>tbody>tr>td:first-child,.table-responsive>.table-bordered>tfoot>tr>td:first-child{border-left:0}.table-responsive>.table-bordered>thead>tr>th:last-child,.table-responsive>.table-bordered>tbody>tr>th:last-child,.table-responsive>.table-bordered>tfoot>tr>th:last-child,.table-responsive>.table-bordered>thead>tr>td:last-child,.table-responsive>.table-bordered>tbody>tr>td:last-child,.table-responsive>.table-bordered>tfoot>tr>td:last-child{border-right:0}.table-responsive>.table-bordered>tbody>tr:last-child>th,.table-responsive>.table-bordered>tfoot>tr:last-child>th,.table-responsive>.table-bordered>tbody>tr:last-child>td,.table-responsive>.table-bordered>tfoot>tr:last-child>td{border-bottom:0}}fieldset{padding:0;margin:0;border:0}legend{display:block;width:100%;padding:0;margin-bottom:20px;font-size:21px;line-height:inherit;color:#333;border:0;border-bottom:1px solid #e5e5e5}label{display:inline-block;margin-bottom:5px;font-weight:bold}input[type="search"]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type="radio"],input[type="checkbox"]{margin:4px 0 0;margin-top:1px \9;line-height:normal}input[type="file"]{display:block}select[multiple],select[size]{height:auto}select optgroup{font-family:inherit;font-size:inherit;font-style:inherit}input[type="file"]:focus,input[type="radio"]:focus,input[type="checkbox"]:focus{outline:thin dotted #333;outline:5px auto -webkit-focus-ring-color;outline-offset:-2px}input[type="number"]::-webkit-outer-spin-button,input[type="number"]::-webkit-inner-spin-button{height:auto}output{display:block;padding-top:7px;font-size:14px;line-height:1.428571429;color:#555;vertical-align:middle}.form-control{display:block;width:100%;height:34px;padding:6px 12px;font-size:14px;line-height:1.428571429;color:#555;vertical-align:middle;background-color:#fff;background-image:none;border:1px solid #ccc;border-radius:4px;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,0.075);box-shadow:inset 0 1px 1px rgba(0,0,0,0.075);-webkit-transition:border-color ease-in-out .15s,box-shadow ease-in-out .15s;transition:border-color ease-in-out .15s,box-shadow ease-in-out .15s}.form-control:focus{border-color:#66afe9;outline:0;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,0.075),0 0 8px rgba(102,175,233,0.6);box-shadow:inset 0 1px 1px rgba(0,0,0,0.075),0 0 8px rgba(102,175,233,0.6)}.form-control:-moz-placeholder{color:#999}.form-control::-moz-placeholder{color:#999}.form-control:-ms-input-placeholder{color:#999}.form-control::-webkit-input-placeholder{color:#999}.form-control[disabled],.form-control[readonly],fieldset[disabled] .form-control{cursor:not-allowed;background-color:#eee}textarea.form-control{height:auto}.form-group{margin-bottom:15px}.radio,.checkbox{display:block;min-height:20px;padding-left:20px;margin-top:10px;margin-bottom:10px;vertical-align:middle}.radio label,.checkbox label{display:inline;margin-bottom:0;font-weight:normal;cursor:pointer}.radio input[type="radio"],.radio-inline input[type="radio"],.checkbox input[type="checkbox"],.checkbox-inline input[type="checkbox"]{float:left;margin-left:-20px}.radio+.radio,.checkbox+.checkbox{margin-top:-5px}.radio-inline,.checkbox-inline{display:inline-block;padding-left:20px;margin-bottom:0;font-weight:normal;vertical-align:middle;cursor:pointer}.radio-inline+.radio-inline,.checkbox-inline+.checkbox-inline{margin-top:0;margin-left:10px}input[type="radio"][disabled],input[type="checkbox"][disabled],.radio[disabled],.radio-inline[disabled],.checkbox[disabled],.checkbox-inline[disabled],fieldset[disabled] input[type="radio"],fieldset[disabled] input[type="checkbox"],fieldset[disabled] .radio,fieldset[disabled] .radio-inline,fieldset[disabled] .checkbox,fieldset[disabled] .checkbox-inline{cursor:not-allowed}.input-sm{height:30px;padding:5px 10px;font-size:12px;line-height:1.5;border-radius:3px}select.input-sm{height:30px;line-height:30px}textarea.input-sm{height:auto}.input-lg{height:45px;padding:10px 16px;font-size:18px;line-height:1.33;border-radius:6px}select.input-lg{height:45px;line-height:45px}textarea.input-lg{height:auto}.has-warning .help-block,.has-warning .control-label,.has-warning .radio,.has-warning .checkbox,.has-warning .radio-inline,.has-warning .checkbox-inline{color:#c09853}.has-warning .form-control{border-color:#c09853;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,0.075);box-shadow:inset 0 1px 1px rgba(0,0,0,0.075)}.has-warning .form-control:focus{border-color:#a47e3c;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,0.075),0 0 6px #dbc59e;box-shadow:inset 0 1px 1px rgba(0,0,0,0.075),0 0 6px #dbc59e}.has-warning .input-group-addon{color:#c09853;background-color:#fcf8e3;border-color:#c09853}.has-error .help-block,.has-error .control-label,.has-error .radio,.has-error .checkbox,.has-error .radio-inline,.has-error .checkbox-inline{color:#b94a48}.has-error .form-control{border-color:#b94a48;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,0.075);box-shadow:inset 0 1px 1px rgba(0,0,0,0.075)}.has-error .form-control:focus{border-color:#953b39;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,0.075),0 0 6px #d59392;box-shadow:inset 0 1px 1px rgba(0,0,0,0.075),0 0 6px #d59392}.has-error .input-group-addon{color:#b94a48;background-color:#f2dede;border-color:#b94a48}.has-success .help-block,.has-success .control-label,.has-success .radio,.has-success .checkbox,.has-success .radio-inline,.has-success .checkbox-inline{color:#468847}.has-success .form-control{border-color:#468847;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,0.075);box-shadow:inset 0 1px 1px rgba(0,0,0,0.075)}.has-success .form-control:focus{border-color:#356635;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,0.075),0 0 6px #7aba7b;box-shadow:inset 0 1px 1px rgba(0,0,0,0.075),0 0 6px #7aba7b}.has-success .input-group-addon{color:#468847;background-color:#dff0d8;border-color:#468847}.form-control-static{margin-bottom:0}.help-block{display:block;margin-top:5px;margin-bottom:10px;color:#737373}@media(min-width:768px){.form-inline .form-group{display:inline-block;margin-bottom:0;vertical-align:middle}.form-inline .form-control{display:inline-block}.form-inline .radio,.form-inline .checkbox{display:inline-block;padding-left:0;margin-top:0;margin-bottom:0}.form-inline .radio input[type="radio"],.form-inline .checkbox input[type="checkbox"]{float:none;margin-left:0}}.form-horizontal .control-label,.form-horizontal .radio,.form-horizontal .checkbox,.form-horizontal .radio-inline,.form-horizontal .checkbox-inline{padding-top:7px;margin-top:0;margin-bottom:0}.form-horizontal .form-group{margin-right:-15px;margin-left:-15px}.form-horizontal .form-group:before,.form-horizontal .form-group:after{display:table;content:" "}.form-horizontal .form-group:after{clear:both}.form-horizontal .form-group:before,.form-horizontal .form-group:after{display:table;content:" "}.form-horizontal .form-group:after{clear:both}.form-horizontal .form-control-static{padding-top:7px}@media(min-width:768px){.form-horizontal .control-label{text-align:right}}.btn{display:inline-block;padding:6px 12px;margin-bottom:0;font-size:14px;font-weight:normal;line-height:1.428571429;text-align:center;white-space:nowrap;vertical-align:middle;cursor:pointer;background-image:none;border:1px solid transparent;border-radius:4px;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;-o-user-select:none;user-select:none}.btn:focus{outline:thin dotted #333;outline:5px auto -webkit-focus-ring-color;outline-offset:-2px}.btn:hover,.btn:focus{color:#333;text-decoration:none}.btn:active,.btn.active{background-image:none;outline:0;-webkit-box-shadow:inset 0 3px 5px rgba(0,0,0,0.125);box-shadow:inset 0 3px 5px rgba(0,0,0,0.125)}.btn.disabled,.btn[disabled],fieldset[disabled] .btn{pointer-events:none;cursor:not-allowed;opacity:.65;filter:alpha(opacity=65);-webkit-box-shadow:none;box-shadow:none}.btn-default{color:#333;background-color:#fff;border-color:#ccc}.btn-default:hover,.btn-default:focus,.btn-default:active,.btn-default.active,.open .dropdown-toggle.btn-default{color:#333;background-color:#ebebeb;border-color:#adadad}.btn-default:active,.btn-default.active,.open .dropdown-toggle.btn-default{background-image:none}.btn-default.disabled,.btn-default[disabled],fieldset[disabled] .btn-default,.btn-default.disabled:hover,.btn-default[disabled]:hover,fieldset[disabled] .btn-default:hover,.btn-default.disabled:focus,.btn-default[disabled]:focus,fieldset[disabled] .btn-default:focus,.btn-default.disabled:active,.btn-default[disabled]:active,fieldset[disabled] .btn-default:active,.btn-default.disabled.active,.btn-default[disabled].active,fieldset[disabled] .btn-default.active{background-color:#fff;border-color:#ccc}.btn-primary{color:#fff;background-color:#428bca;border-color:#357ebd}.btn-primary:hover,.btn-primary:focus,.btn-primary:active,.btn-primary.active,.open .dropdown-toggle.btn-primary{color:#fff;background-color:#3276b1;border-color:#285e8e}.btn-primary:active,.btn-primary.active,.open .dropdown-toggle.btn-primary{background-image:none}.btn-primary.disabled,.btn-primary[disabled],fieldset[disabled] .btn-primary,.btn-primary.disabled:hover,.btn-primary[disabled]:hover,fieldset[disabled] .btn-primary:hover,.btn-primary.disabled:focus,.btn-primary[disabled]:focus,fieldset[disabled] .btn-primary:focus,.btn-primary.disabled:active,.btn-primary[disabled]:active,fieldset[disabled] .btn-primary:active,.btn-primary.disabled.active,.btn-primary[disabled].active,fieldset[disabled] .btn-primary.active{background-color:#428bca;border-color:#357ebd}.btn-warning{color:#fff;background-color:#f0ad4e;border-color:#eea236}.btn-warning:hover,.btn-warning:focus,.btn-warning:active,.btn-warning.active,.open .dropdown-toggle.btn-warning{color:#fff;background-color:#ed9c28;border-color:#d58512}.btn-warning:active,.btn-warning.active,.open .dropdown-toggle.btn-warning{background-image:none}.btn-warning.disabled,.btn-warning[disabled],fieldset[disabled] .btn-warning,.btn-warning.disabled:hover,.btn-warning[disabled]:hover,fieldset[disabled] .btn-warning:hover,.btn-warning.disabled:focus,.btn-warning[disabled]:focus,fieldset[disabled] .btn-warning:focus,.btn-warning.disabled:active,.btn-warning[disabled]:active,fieldset[disabled] .btn-warning:active,.btn-warning.disabled.active,.btn-warning[disabled].active,fieldset[disabled] .btn-warning.active{background-color:#f0ad4e;border-color:#eea236}.btn-danger{color:#fff;background-color:#d9534f;border-color:#d43f3a}.btn-danger:hover,.btn-danger:focus,.btn-danger:active,.btn-danger.active,.open .dropdown-toggle.btn-danger{color:#fff;background-color:#d2322d;border-color:#ac2925}.btn-danger:active,.btn-danger.active,.open .dropdown-toggle.btn-danger{background-image:none}.btn-danger.disabled,.btn-danger[disabled],fieldset[disabled] .btn-danger,.btn-danger.disabled:hover,.btn-danger[disabled]:hover,fieldset[disabled] .btn-danger:hover,.btn-danger.disabled:focus,.btn-danger[disabled]:focus,fieldset[disabled] .btn-danger:focus,.btn-danger.disabled:active,.btn-danger[disabled]:active,fieldset[disabled] .btn-danger:active,.btn-danger.disabled.active,.btn-danger[disabled].active,fieldset[disabled] .btn-danger.active{background-color:#d9534f;border-color:#d43f3a}.btn-success{color:#fff;background-color:#5cb85c;border-color:#4cae4c}.btn-success:hover,.btn-success:focus,.btn-success:active,.btn-success.active,.open .dropdown-toggle.btn-success{color:#fff;background-color:#47a447;border-color:#398439}.btn-success:active,.btn-success.active,.open .dropdown-toggle.btn-success{background-image:none}.btn-success.disabled,.btn-success[disabled],fieldset[disabled] .btn-success,.btn-success.disabled:hover,.btn-success[disabled]:hover,fieldset[disabled] .btn-success:hover,.btn-success.disabled:focus,.btn-success[disabled]:focus,fieldset[disabled] .btn-success:focus,.btn-success.disabled:active,.btn-success[disabled]:active,fieldset[disabled] .btn-success:active,.btn-success.disabled.active,.btn-success[disabled].active,fieldset[disabled] .btn-success.active{background-color:#5cb85c;border-color:#4cae4c}.btn-info{color:#fff;background-color:#5bc0de;border-color:#46b8da}.btn-info:hover,.btn-info:focus,.btn-info:active,.btn-info.active,.open .dropdown-toggle.btn-info{color:#fff;background-color:#39b3d7;border-color:#269abc}.btn-info:active,.btn-info.active,.open .dropdown-toggle.btn-info{background-image:none}.btn-info.disabled,.btn-info[disabled],fieldset[disabled] .btn-info,.btn-info.disabled:hover,.btn-info[disabled]:hover,fieldset[disabled] .btn-info:hover,.btn-info.disabled:focus,.btn-info[disabled]:focus,fieldset[disabled] .btn-info:focus,.btn-info.disabled:active,.btn-info[disabled]:active,fieldset[disabled] .btn-info:active,.btn-info.disabled.active,.btn-info[disabled].active,fieldset[disabled] .btn-info.active{background-color:#5bc0de;border-color:#46b8da}.btn-link{font-weight:normal;color:#428bca;cursor:pointer;border-radius:0}.btn-link,.btn-link:active,.btn-link[disabled],fieldset[disabled] .btn-link{background-color:transparent;-webkit-box-shadow:none;box-shadow:none}.btn-link,.btn-link:hover,.btn-link:focus,.btn-link:active{border-color:transparent}.btn-link:hover,.btn-link:focus{color:#2a6496;text-decoration:underline;background-color:transparent}.btn-link[disabled]:hover,fieldset[disabled] .btn-link:hover,.btn-link[disabled]:focus,fieldset[disabled] .btn-link:focus{color:#999;text-decoration:none}.btn-lg{padding:10px 16px;font-size:18px;line-height:1.33;border-radius:6px}.btn-sm,.btn-xs{padding:5px 10px;font-size:12px;line-height:1.5;border-radius:3px}.btn-xs{padding:1px 5px}.btn-block{display:block;width:100%;padding-right:0;padding-left:0}.btn-block+.btn-block{margin-top:5px}input[type="submit"].btn-block,input[type="reset"].btn-block,input[type="button"].btn-block{width:100%}.fade{opacity:0;-webkit-transition:opacity .15s linear;transition:opacity .15s linear}.fade.in{opacity:1}.collapse{display:none}.collapse.in{display:block}.collapsing{position:relative;height:0;overflow:hidden;-webkit-transition:height .35s ease;transition:height .35s ease}@font-face{font-family:'Glyphicons Halflings';src:url('../fonts/glyphicons-halflings-regular.eot');src:url('../fonts/glyphicons-halflings-regular.eot?#iefix') format('embedded-opentype'),url('../fonts/glyphicons-halflings-regular.woff') format('woff'),url('../fonts/glyphicons-halflings-regular.ttf') format('truetype'),url('../fonts/glyphicons-halflings-regular.svg#glyphicons_halflingsregular') format('svg')}.glyphicon{position:relative;top:1px;display:inline-block;font-family:'Glyphicons Halflings';-webkit-font-smoothing:antialiased;font-style:normal;font-weight:normal;line-height:1;-moz-osx-font-smoothing:grayscale}.glyphicon:empty{width:1em}.glyphicon-asterisk:before{content:"\2a"}.glyphicon-plus:before{content:"\2b"}.glyphicon-euro:before{content:"\20ac"}.glyphicon-minus:before{content:"\2212"}.glyphicon-cloud:before{content:"\2601"}.glyphicon-envelope:before{content:"\2709"}.glyphicon-pencil:before{content:"\270f"}.glyphicon-glass:before{content:"\e001"}.glyphicon-music:before{content:"\e002"}.glyphicon-search:before{content:"\e003"}.glyphicon-heart:before{content:"\e005"}.glyphicon-star:before{content:"\e006"}.glyphicon-star-empty:before{content:"\e007"}.glyphicon-user:before{content:"\e008"}.glyphicon-film:before{content:"\e009"}.glyphicon-th-large:before{content:"\e010"}.glyphicon-th:before{content:"\e011"}.glyphicon-th-list:before{content:"\e012"}.glyphicon-ok:before{content:"\e013"}.glyphicon-remove:before{content:"\e014"}.glyphicon-zoom-in:before{content:"\e015"}.glyphicon-zoom-out:before{content:"\e016"}.glyphicon-off:before{content:"\e017"}.glyphicon-signal:before{content:"\e018"}.glyphicon-cog:before{content:"\e019"}.glyphicon-trash:before{content:"\e020"}.glyphicon-home:before{content:"\e021"}.glyphicon-file:before{content:"\e022"}.glyphicon-time:before{content:"\e023"}.glyphicon-road:before{content:"\e024"}.glyphicon-download-alt:before{content:"\e025"}.glyphicon-download:before{content:"\e026"}.glyphicon-upload:before{content:"\e027"}.glyphicon-inbox:before{content:"\e028"}.glyphicon-play-circle:before{content:"\e029"}.glyphicon-repeat:before{content:"\e030"}.glyphicon-refresh:before{content:"\e031"}.glyphicon-list-alt:before{content:"\e032"}.glyphicon-lock:before{content:"\e033"}.glyphicon-flag:before{content:"\e034"}.glyphicon-headphones:before{content:"\e035"}.glyphicon-volume-off:before{content:"\e036"}.glyphicon-volume-down:before{content:"\e037"}.glyphicon-volume-up:before{content:"\e038"}.glyphicon-qrcode:before{content:"\e039"}.glyphicon-barcode:before{content:"\e040"}.glyphicon-tag:before{content:"\e041"}.glyphicon-tags:before{content:"\e042"}.glyphicon-book:before{content:"\e043"}.glyphicon-bookmark:before{content:"\e044"}.glyphicon-print:before{content:"\e045"}.glyphicon-camera:before{content:"\e046"}.glyphicon-font:before{content:"\e047"}.glyphicon-bold:before{content:"\e048"}.glyphicon-italic:before{content:"\e049"}.glyphicon-text-height:before{content:"\e050"}.glyphicon-text-width:before{content:"\e051"}.glyphicon-align-left:before{content:"\e052"}.glyphicon-align-center:before{content:"\e053"}.glyphicon-align-right:before{content:"\e054"}.glyphicon-align-justify:before{content:"\e055"}.glyphicon-list:before{content:"\e056"}.glyphicon-indent-left:before{content:"\e057"}.glyphicon-indent-right:before{content:"\e058"}.glyphicon-facetime-video:before{content:"\e059"}.glyphicon-picture:before{content:"\e060"}.glyphicon-map-marker:before{content:"\e062"}.glyphicon-adjust:before{content:"\e063"}.glyphicon-tint:before{content:"\e064"}.glyphicon-edit:before{content:"\e065"}.glyphicon-share:before{content:"\e066"}.glyphicon-check:before{content:"\e067"}.glyphicon-move:before{content:"\e068"}.glyphicon-step-backward:before{content:"\e069"}.glyphicon-fast-backward:before{content:"\e070"}.glyphicon-backward:before{content:"\e071"}.glyphicon-play:before{content:"\e072"}.glyphicon-pause:before{content:"\e073"}.glyphicon-stop:before{content:"\e074"}.glyphicon-forward:before{content:"\e075"}.glyphicon-fast-forward:before{content:"\e076"}.glyphicon-step-forward:before{content:"\e077"}.glyphicon-eject:before{content:"\e078"}.glyphicon-chevron-left:before{content:"\e079"}.glyphicon-chevron-right:before{content:"\e080"}.glyphicon-plus-sign:before{content:"\e081"}.glyphicon-minus-sign:before{content:"\e082"}.glyphicon-remove-sign:before{content:"\e083"}.glyphicon-ok-sign:before{content:"\e084"}.glyphicon-question-sign:before{content:"\e085"}.glyphicon-info-sign:before{content:"\e086"}.glyphicon-screenshot:before{content:"\e087"}.glyphicon-remove-circle:before{content:"\e088"}.glyphicon-ok-circle:before{content:"\e089"}.glyphicon-ban-circle:before{content:"\e090"}.glyphicon-arrow-left:before{content:"\e091"}.glyphicon-arrow-right:before{content:"\e092"}.glyphicon-arrow-up:before{content:"\e093"}.glyphicon-arrow-down:before{content:"\e094"}.glyphicon-share-alt:before{content:"\e095"}.glyphicon-resize-full:before{content:"\e096"}.glyphicon-resize-small:before{content:"\e097"}.glyphicon-exclamation-sign:before{content:"\e101"}.glyphicon-gift:before{content:"\e102"}.glyphicon-leaf:before{content:"\e103"}.glyphicon-fire:before{content:"\e104"}.glyphicon-eye-open:before{content:"\e105"}.glyphicon-eye-close:before{content:"\e106"}.glyphicon-warning-sign:before{content:"\e107"}.glyphicon-plane:before{content:"\e108"}.glyphicon-calendar:before{content:"\e109"}.glyphicon-random:before{content:"\e110"}.glyphicon-comment:before{content:"\e111"}.glyphicon-magnet:before{content:"\e112"}.glyphicon-chevron-up:before{content:"\e113"}.glyphicon-chevron-down:before{content:"\e114"}.glyphicon-retweet:before{content:"\e115"}.glyphicon-shopping-cart:before{content:"\e116"}.glyphicon-folder-close:before{content:"\e117"}.glyphicon-folder-open:before{content:"\e118"}.glyphicon-resize-vertical:before{content:"\e119"}.glyphicon-resize-horizontal:before{content:"\e120"}.glyphicon-hdd:before{content:"\e121"}.glyphicon-bullhorn:before{content:"\e122"}.glyphicon-bell:before{content:"\e123"}.glyphicon-certificate:before{content:"\e124"}.glyphicon-thumbs-up:before{content:"\e125"}.glyphicon-thumbs-down:before{content:"\e126"}.glyphicon-hand-right:before{content:"\e127"}.glyphicon-hand-left:before{content:"\e128"}.glyphicon-hand-up:before{content:"\e129"}.glyphicon-hand-down:before{content:"\e130"}.glyphicon-circle-arrow-right:before{content:"\e131"}.glyphicon-circle-arrow-left:before{content:"\e132"}.glyphicon-circle-arrow-up:before{content:"\e133"}.glyphicon-circle-arrow-down:before{content:"\e134"}.glyphicon-globe:before{content:"\e135"}.glyphicon-wrench:before{content:"\e136"}.glyphicon-tasks:before{content:"\e137"}.glyphicon-filter:before{content:"\e138"}.glyphicon-briefcase:before{content:"\e139"}.glyphicon-fullscreen:before{content:"\e140"}.glyphicon-dashboard:before{content:"\e141"}.glyphicon-paperclip:before{content:"\e142"}.glyphicon-heart-empty:before{content:"\e143"}.glyphicon-link:before{content:"\e144"}.glyphicon-phone:before{content:"\e145"}.glyphicon-pushpin:before{content:"\e146"}.glyphicon-usd:before{content:"\e148"}.glyphicon-gbp:before{content:"\e149"}.glyphicon-sort:before{content:"\e150"}.glyphicon-sort-by-alphabet:before{content:"\e151"}.glyphicon-sort-by-alphabet-alt:before{content:"\e152"}.glyphicon-sort-by-order:before{content:"\e153"}.glyphicon-sort-by-order-alt:before{content:"\e154"}.glyphicon-sort-by-attributes:before{content:"\e155"}.glyphicon-sort-by-attributes-alt:before{content:"\e156"}.glyphicon-unchecked:before{content:"\e157"}.glyphicon-expand:before{content:"\e158"}.glyphicon-collapse-down:before{content:"\e159"}.glyphicon-collapse-up:before{content:"\e160"}.glyphicon-log-in:before{content:"\e161"}.glyphicon-flash:before{content:"\e162"}.glyphicon-log-out:before{content:"\e163"}.glyphicon-new-window:before{content:"\e164"}.glyphicon-record:before{content:"\e165"}.glyphicon-save:before{content:"\e166"}.glyphicon-open:before{content:"\e167"}.glyphicon-saved:before{content:"\e168"}.glyphicon-import:before{content:"\e169"}.glyphicon-export:before{content:"\e170"}.glyphicon-send:before{content:"\e171"}.glyphicon-floppy-disk:before{content:"\e172"}.glyphicon-floppy-saved:before{content:"\e173"}.glyphicon-floppy-remove:before{content:"\e174"}.glyphicon-floppy-save:before{content:"\e175"}.glyphicon-floppy-open:before{content:"\e176"}.glyphicon-credit-card:before{content:"\e177"}.glyphicon-transfer:before{content:"\e178"}.glyphicon-cutlery:before{content:"\e179"}.glyphicon-header:before{content:"\e180"}.glyphicon-compressed:before{content:"\e181"}.glyphicon-earphone:before{content:"\e182"}.glyphicon-phone-alt:before{content:"\e183"}.glyphicon-tower:before{content:"\e184"}.glyphicon-stats:before{content:"\e185"}.glyphicon-sd-video:before{content:"\e186"}.glyphicon-hd-video:before{content:"\e187"}.glyphicon-subtitles:before{content:"\e188"}.glyphicon-sound-stereo:before{content:"\e189"}.glyphicon-sound-dolby:before{content:"\e190"}.glyphicon-sound-5-1:before{content:"\e191"}.glyphicon-sound-6-1:before{content:"\e192"}.glyphicon-sound-7-1:before{content:"\e193"}.glyphicon-copyright-mark:before{content:"\e194"}.glyphicon-registration-mark:before{content:"\e195"}.glyphicon-cloud-download:before{content:"\e197"}.glyphicon-cloud-upload:before{content:"\e198"}.glyphicon-tree-conifer:before{content:"\e199"}.glyphicon-tree-deciduous:before{content:"\e200"}.caret{display:inline-block;width:0;height:0;margin-left:2px;vertical-align:middle;border-top:4px solid #000;border-right:4px solid transparent;border-bottom:0 dotted;border-left:4px solid transparent}.dropdown{position:relative}.dropdown-toggle:focus{outline:0}.dropdown-menu{position:absolute;top:100%;left:0;z-index:1000;display:none;float:left;min-width:160px;padding:5px 0;margin:2px 0 0;font-size:14px;list-style:none;background-color:#fff;border:1px solid #ccc;border:1px solid rgba(0,0,0,0.15);border-radius:4px;-webkit-box-shadow:0 6px 12px rgba(0,0,0,0.175);box-shadow:0 6px 12px rgba(0,0,0,0.175);background-clip:padding-box}.dropdown-menu.pull-right{right:0;left:auto}.dropdown-menu .divider{height:1px;margin:9px 0;overflow:hidden;background-color:#e5e5e5}.dropdown-menu>li>a{display:block;padding:3px 20px;clear:both;font-weight:normal;line-height:1.428571429;color:#333;white-space:nowrap}.dropdown-menu>li>a:hover,.dropdown-menu>li>a:focus{color:#262626;text-decoration:none;background-color:#f5f5f5}.dropdown-menu>.active>a,.dropdown-menu>.active>a:hover,.dropdown-menu>.active>a:focus{color:#fff;text-decoration:none;background-color:#428bca;outline:0}.dropdown-menu>.disabled>a,.dropdown-menu>.disabled>a:hover,.dropdown-menu>.disabled>a:focus{color:#999}.dropdown-menu>.disabled>a:hover,.dropdown-menu>.disabled>a:focus{text-decoration:none;cursor:not-allowed;background-color:transparent;background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled=false)}.open>.dropdown-menu{display:block}.open>a{outline:0}.dropdown-header{display:block;padding:3px 20px;font-size:12px;line-height:1.428571429;color:#999}.dropdown-backdrop{position:fixed;top:0;right:0;bottom:0;left:0;z-index:990}.pull-right>.dropdown-menu{right:0;left:auto}.dropup .caret,.navbar-fixed-bottom .dropdown .caret{border-top:0 dotted;border-bottom:4px solid #000;content:""}.dropup .dropdown-menu,.navbar-fixed-bottom .dropdown .dropdown-menu{top:auto;bottom:100%;margin-bottom:1px}@media(min-width:768px){.navbar-right .dropdown-menu{right:0;left:auto}}.btn-default .caret{border-top-color:#333}.btn-primary .caret,.btn-success .caret,.btn-warning .caret,.btn-danger .caret,.btn-info .caret{border-top-color:#fff}.dropup .btn-default .caret{border-bottom-color:#333}.dropup .btn-primary .caret,.dropup .btn-success .caret,.dropup .btn-warning .caret,.dropup .btn-danger .caret,.dropup .btn-info .caret{border-bottom-color:#fff}.btn-group,.btn-group-vertical{position:relative;display:inline-block;vertical-align:middle}.btn-group>.btn,.btn-group-vertical>.btn{position:relative;float:left}.btn-group>.btn:hover,.btn-group-vertical>.btn:hover,.btn-group>.btn:focus,.btn-group-vertical>.btn:focus,.btn-group>.btn:active,.btn-group-vertical>.btn:active,.btn-group>.btn.active,.btn-group-vertical>.btn.active{z-index:2}.btn-group>.btn:focus,.btn-group-vertical>.btn:focus{outline:0}.btn-group .btn+.btn,.btn-group .btn+.btn-group,.btn-group .btn-group+.btn,.btn-group .btn-group+.btn-group{margin-left:-1px}.btn-toolbar:before,.btn-toolbar:after{display:table;content:" "}.btn-toolbar:after{clear:both}.btn-toolbar:before,.btn-toolbar:after{display:table;content:" "}.btn-toolbar:after{clear:both}.btn-toolbar .btn-group{float:left}.btn-toolbar>.btn+.btn,.btn-toolbar>.btn-group+.btn,.btn-toolbar>.btn+.btn-group,.btn-toolbar>.btn-group+.btn-group{margin-left:5px}.btn-group>.btn:not(:first-child):not(:last-child):not(.dropdown-toggle){border-radius:0}.btn-group>.btn:first-child{margin-left:0}.btn-group>.btn:first-child:not(:last-child):not(.dropdown-toggle){border-top-right-radius:0;border-bottom-right-radius:0}.btn-group>.btn:last-child:not(:first-child),.btn-group>.dropdown-toggle:not(:first-child){border-bottom-left-radius:0;border-top-left-radius:0}.btn-group>.btn-group{float:left}.btn-group>.btn-group:not(:first-child):not(:last-child)>.btn{border-radius:0}.btn-group>.btn-group:first-child>.btn:last-child,.btn-group>.btn-group:first-child>.dropdown-toggle{border-top-right-radius:0;border-bottom-right-radius:0}.btn-group>.btn-group:last-child>.btn:first-child{border-bottom-left-radius:0;border-top-left-radius:0}.btn-group .dropdown-toggle:active,.btn-group.open .dropdown-toggle{outline:0}.btn-group-xs>.btn{padding:5px 10px;padding:1px 5px;font-size:12px;line-height:1.5;border-radius:3px}.btn-group-sm>.btn{padding:5px 10px;font-size:12px;line-height:1.5;border-radius:3px}.btn-group-lg>.btn{padding:10px 16px;font-size:18px;line-height:1.33;border-radius:6px}.btn-group>.btn+.dropdown-toggle{padding-right:8px;padding-left:8px}.btn-group>.btn-lg+.dropdown-toggle{padding-right:12px;padding-left:12px}.btn-group.open .dropdown-toggle{-webkit-box-shadow:inset 0 3px 5px rgba(0,0,0,0.125);box-shadow:inset 0 3px 5px rgba(0,0,0,0.125)}.btn-group.open .dropdown-toggle.btn-link{-webkit-box-shadow:none;box-shadow:none}.btn .caret{margin-left:0}.btn-lg .caret{border-width:5px 5px 0;border-bottom-width:0}.dropup .btn-lg .caret{border-width:0 5px 5px}.btn-group-vertical>.btn,.btn-group-vertical>.btn-group{display:block;float:none;width:100%;max-width:100%}.btn-group-vertical>.btn-group:before,.btn-group-vertical>.btn-group:after{display:table;content:" "}.btn-group-vertical>.btn-group:after{clear:both}.btn-group-vertical>.btn-group:before,.btn-group-vertical>.btn-group:after{display:table;content:" "}.btn-group-vertical>.btn-group:after{clear:both}.btn-group-vertical>.btn-group>.btn{float:none}.btn-group-vertical>.btn+.btn,.btn-group-vertical>.btn+.btn-group,.btn-group-vertical>.btn-group+.btn,.btn-group-vertical>.btn-group+.btn-group{margin-top:-1px;margin-left:0}.btn-group-vertical>.btn:not(:first-child):not(:last-child){border-radius:0}.btn-group-vertical>.btn:first-child:not(:last-child){border-top-right-radius:4px;border-bottom-right-radius:0;border-bottom-left-radius:0}.btn-group-vertical>.btn:last-child:not(:first-child){border-top-right-radius:0;border-bottom-left-radius:4px;border-top-left-radius:0}.btn-group-vertical>.btn-group:not(:first-child):not(:last-child)>.btn{border-radius:0}.btn-group-vertical>.btn-group:first-child>.btn:last-child,.btn-group-vertical>.btn-group:first-child>.dropdown-toggle{border-bottom-right-radius:0;border-bottom-left-radius:0}.btn-group-vertical>.btn-group:last-child>.btn:first-child{border-top-right-radius:0;border-top-left-radius:0}.btn-group-justified{display:table;width:100%;border-collapse:separate;table-layout:fixed}.btn-group-justified .btn{display:table-cell;float:none;width:1%}[data-toggle="buttons"]>.btn>input[type="radio"],[data-toggle="buttons"]>.btn>input[type="checkbox"]{display:none}.input-group{position:relative;display:table;border-collapse:separate}.input-group.col{float:none;padding-right:0;padding-left:0}.input-group .form-control{width:100%;margin-bottom:0}.input-group-lg>.form-control,.input-group-lg>.input-group-addon,.input-group-lg>.input-group-btn>.btn{height:45px;padding:10px 16px;font-size:18px;line-height:1.33;border-radius:6px}select.input-group-lg>.form-control,select.input-group-lg>.input-group-addon,select.input-group-lg>.input-group-btn>.btn{height:45px;line-height:45px}textarea.input-group-lg>.form-control,textarea.input-group-lg>.input-group-addon,textarea.input-group-lg>.input-group-btn>.btn{height:auto}.input-group-sm>.form-control,.input-group-sm>.input-group-addon,.input-group-sm>.input-group-btn>.btn{height:30px;padding:5px 10px;font-size:12px;line-height:1.5;border-radius:3px}select.input-group-sm>.form-control,select.input-group-sm>.input-group-addon,select.input-group-sm>.input-group-btn>.btn{height:30px;line-height:30px}textarea.input-group-sm>.form-control,textarea.input-group-sm>.input-group-addon,textarea.input-group-sm>.input-group-btn>.btn{height:auto}.input-group-addon,.input-group-btn,.input-group .form-control{display:table-cell}.input-group-addon:not(:first-child):not(:last-child),.input-group-btn:not(:first-child):not(:last-child),.input-group .form-control:not(:first-child):not(:last-child){border-radius:0}.input-group-addon,.input-group-btn{width:1%;white-space:nowrap;vertical-align:middle}.input-group-addon{padding:6px 12px;font-size:14px;font-weight:normal;line-height:1;color:#555;text-align:center;background-color:#eee;border:1px solid #ccc;border-radius:4px}.input-group-addon.input-sm{padding:5px 10px;font-size:12px;border-radius:3px}.input-group-addon.input-lg{padding:10px 16px;font-size:18px;border-radius:6px}.input-group-addon input[type="radio"],.input-group-addon input[type="checkbox"]{margin-top:0}.input-group .form-control:first-child,.input-group-addon:first-child,.input-group-btn:first-child>.btn,.input-group-btn:first-child>.dropdown-toggle,.input-group-btn:last-child>.btn:not(:last-child):not(.dropdown-toggle){border-top-right-radius:0;border-bottom-right-radius:0}.input-group-addon:first-child{border-right:0}.input-group .form-control:last-child,.input-group-addon:last-child,.input-group-btn:last-child>.btn,.input-group-btn:last-child>.dropdown-toggle,.input-group-btn:first-child>.btn:not(:first-child){border-bottom-left-radius:0;border-top-left-radius:0}.input-group-addon:last-child{border-left:0}.input-group-btn{position:relative;white-space:nowrap}.input-group-btn:first-child>.btn{margin-right:-1px}.input-group-btn:last-child>.btn{margin-left:-1px}.input-group-btn>.btn{position:relative}.input-group-btn>.btn+.btn{margin-left:-4px}.input-group-btn>.btn:hover,.input-group-btn>.btn:active{z-index:2}.nav{padding-left:0;margin-bottom:0;list-style:none}.nav:before,.nav:after{display:table;content:" "}.nav:after{clear:both}.nav:before,.nav:after{display:table;content:" "}.nav:after{clear:both}.nav>li{position:relative;display:block}.nav>li>a{position:relative;display:block;padding:10px 15px}.nav>li>a:hover,.nav>li>a:focus{text-decoration:none;background-color:#eee}.nav>li.disabled>a{color:#999}.nav>li.disabled>a:hover,.nav>li.disabled>a:focus{color:#999;text-decoration:none;cursor:not-allowed;background-color:transparent}.nav .open>a,.nav .open>a:hover,.nav .open>a:focus{background-color:#eee;border-color:#428bca}.nav .open>a .caret,.nav .open>a:hover .caret,.nav .open>a:focus .caret{border-top-color:#2a6496;border-bottom-color:#2a6496}.nav .nav-divider{height:1px;margin:9px 0;overflow:hidden;background-color:#e5e5e5}.nav>li>a>img{max-width:none}.nav-tabs{border-bottom:1px solid #ddd}.nav-tabs>li{float:left;margin-bottom:-1px}.nav-tabs>li>a{margin-right:2px;line-height:1.428571429;border:1px solid transparent;border-radius:4px 4px 0 0}.nav-tabs>li>a:hover{border-color:#eee #eee #ddd}.nav-tabs>li.active>a,.nav-tabs>li.active>a:hover,.nav-tabs>li.active>a:focus{color:#555;cursor:default;background-color:#fff;border:1px solid #ddd;border-bottom-color:transparent}.nav-tabs.nav-justified{width:100%;border-bottom:0}.nav-tabs.nav-justified>li{float:none}.nav-tabs.nav-justified>li>a{margin-bottom:5px;text-align:center}.nav-tabs.nav-justified>.dropdown .dropdown-menu{top:auto;left:auto}@media(min-width:768px){.nav-tabs.nav-justified>li{display:table-cell;width:1%}.nav-tabs.nav-justified>li>a{margin-bottom:0}}.nav-tabs.nav-justified>li>a{margin-right:0;border-radius:4px}.nav-tabs.nav-justified>.active>a,.nav-tabs.nav-justified>.active>a:hover,.nav-tabs.nav-justified>.active>a:focus{border:1px solid #ddd}@media(min-width:768px){.nav-tabs.nav-justified>li>a{border-bottom:1px solid #ddd;border-radius:4px 4px 0 0}.nav-tabs.nav-justified>.active>a,.nav-tabs.nav-justified>.active>a:hover,.nav-tabs.nav-justified>.active>a:focus{border-bottom-color:#fff}}.nav-pills>li{float:left}.nav-pills>li>a{border-radius:4px}.nav-pills>li+li{margin-left:2px}.nav-pills>li.active>a,.nav-pills>li.active>a:hover,.nav-pills>li.active>a:focus{color:#fff;background-color:#428bca}.nav-pills>li.active>a .caret,.nav-pills>li.active>a:hover .caret,.nav-pills>li.active>a:focus .caret{border-top-color:#fff;border-bottom-color:#fff}.nav-stacked>li{float:none}.nav-stacked>li+li{margin-top:2px;margin-left:0}.nav-justified{width:100%}.nav-justified>li{float:none}.nav-justified>li>a{margin-bottom:5px;text-align:center}.nav-justified>.dropdown .dropdown-menu{top:auto;left:auto}@media(min-width:768px){.nav-justified>li{display:table-cell;width:1%}.nav-justified>li>a{margin-bottom:0}}.nav-tabs-justified{border-bottom:0}.nav-tabs-justified>li>a{margin-right:0;border-radius:4px}.nav-tabs-justified>.active>a,.nav-tabs-justified>.active>a:hover,.nav-tabs-justified>.active>a:focus{border:1px solid #ddd}@media(min-width:768px){.nav-tabs-justified>li>a{border-bottom:1px solid #ddd;border-radius:4px 4px 0 0}.nav-tabs-justified>.active>a,.nav-tabs-justified>.active>a:hover,.nav-tabs-justified>.active>a:focus{border-bottom-color:#fff}}.tab-content>.tab-pane{display:none}.tab-content>.active{display:block}.nav .caret{border-top-color:#428bca;border-bottom-color:#428bca}.nav a:hover .caret{border-top-color:#2a6496;border-bottom-color:#2a6496}.nav-tabs .dropdown-menu{margin-top:-1px;border-top-right-radius:0;border-top-left-radius:0}.navbar{position:relative;min-height:50px;margin-bottom:20px;border:1px solid transparent}.navbar:before,.navbar:after{display:table;content:" "}.navbar:after{clear:both}.navbar:before,.navbar:after{display:table;content:" "}.navbar:after{clear:both}@media(min-width:768px){.navbar{border-radius:4px}}.navbar-header:before,.navbar-header:after{display:table;content:" "}.navbar-header:after{clear:both}.navbar-header:before,.navbar-header:after{display:table;content:" "}.navbar-header:after{clear:both}@media(min-width:768px){.navbar-header{float:left}}.navbar-collapse{max-height:340px;padding-right:15px;padding-left:15px;overflow-x:visible;border-top:1px solid transparent;box-shadow:inset 0 1px 0 rgba(255,255,255,0.1);-webkit-overflow-scrolling:touch}.navbar-collapse:before,.navbar-collapse:after{display:table;content:" "}.navbar-collapse:after{clear:both}.navbar-collapse:before,.navbar-collapse:after{display:table;content:" "}.navbar-collapse:after{clear:both}.navbar-collapse.in{overflow-y:auto}@media(min-width:768px){.navbar-collapse{width:auto;border-top:0;box-shadow:none}.navbar-collapse.collapse{display:block !important;height:auto !important;padding-bottom:0;overflow:visible !important}.navbar-collapse.in{overflow-y:auto}.navbar-collapse .navbar-nav.navbar-left:first-child{margin-left:-15px}.navbar-collapse .navbar-nav.navbar-right:last-child{margin-right:-15px}.navbar-collapse .navbar-text:last-child{margin-right:0}}.container>.navbar-header,.container>.navbar-collapse{margin-right:-15px;margin-left:-15px}@media(min-width:768px){.container>.navbar-header,.container>.navbar-collapse{margin-right:0;margin-left:0}}.navbar-static-top{z-index:1000;border-width:0 0 1px}@media(min-width:768px){.navbar-static-top{border-radius:0}}.navbar-fixed-top,.navbar-fixed-bottom{position:fixed;right:0;left:0;z-index:1030}@media(min-width:768px){.navbar-fixed-top,.navbar-fixed-bottom{border-radius:0}}.navbar-fixed-top{top:0;border-width:0 0 1px}.navbar-fixed-bottom{bottom:0;margin-bottom:0;border-width:1px 0 0}.navbar-brand{float:left;padding:15px 15px;font-size:18px;line-height:20px}.navbar-brand:hover,.navbar-brand:focus{text-decoration:none}@media(min-width:768px){.navbar>.container .navbar-brand{margin-left:-15px}}.navbar-toggle{position:relative;float:right;padding:9px 10px;margin-top:8px;margin-right:15px;margin-bottom:8px;background-color:transparent;border:1px solid transparent;border-radius:4px}.navbar-toggle .icon-bar{display:block;width:22px;height:2px;border-radius:1px}.navbar-toggle .icon-bar+.icon-bar{margin-top:4px}@media(min-width:768px){.navbar-toggle{display:none}}.navbar-nav{margin:7.5px -15px}.navbar-nav>li>a{padding-top:10px;padding-bottom:10px;line-height:20px}@media(max-width:767px){.navbar-nav .open .dropdown-menu{position:static;float:none;width:auto;margin-top:0;background-color:transparent;border:0;box-shadow:none}.navbar-nav .open .dropdown-menu>li>a,.navbar-nav .open .dropdown-menu .dropdown-header{padding:5px 15px 5px 25px}.navbar-nav .open .dropdown-menu>li>a{line-height:20px}.navbar-nav .open .dropdown-menu>li>a:hover,.navbar-nav .open .dropdown-menu>li>a:focus{background-image:none}}@media(min-width:768px){.navbar-nav{float:left;margin:0}.navbar-nav>li{float:left}.navbar-nav>li>a{padding-top:15px;padding-bottom:15px}}@media(min-width:768px){.navbar-left{float:left !important}.navbar-right{float:right !important}}.navbar-form{padding:10px 15px;margin-top:8px;margin-right:-15px;margin-bottom:8px;margin-left:-15px;border-top:1px solid transparent;border-bottom:1px solid transparent;-webkit-box-shadow:inset 0 1px 0 rgba(255,255,255,0.1),0 1px 0 rgba(255,255,255,0.1);box-shadow:inset 0 1px 0 rgba(255,255,255,0.1),0 1px 0 rgba(255,255,255,0.1)}@media(min-width:768px){.navbar-form .form-group{display:inline-block;margin-bottom:0;vertical-align:middle}.navbar-form .form-control{display:inline-block}.navbar-form .radio,.navbar-form .checkbox{display:inline-block;padding-left:0;margin-top:0;margin-bottom:0}.navbar-form .radio input[type="radio"],.navbar-form .checkbox input[type="checkbox"]{float:none;margin-left:0}}@media(max-width:767px){.navbar-form .form-group{margin-bottom:5px}}@media(min-width:768px){.navbar-form{width:auto;padding-top:0;padding-bottom:0;margin-right:0;margin-left:0;border:0;-webkit-box-shadow:none;box-shadow:none}}.navbar-nav>li>.dropdown-menu{margin-top:0;border-top-right-radius:0;border-top-left-radius:0}.navbar-fixed-bottom .navbar-nav>li>.dropdown-menu{border-bottom-right-radius:0;border-bottom-left-radius:0}.navbar-nav.pull-right>li>.dropdown-menu,.navbar-nav>li>.dropdown-menu.pull-right{right:0;left:auto}.navbar-btn{margin-top:8px;margin-bottom:8px}.navbar-text{float:left;margin-top:15px;margin-bottom:15px}@media(min-width:768px){.navbar-text{margin-right:15px;margin-left:15px}}.navbar-default{background-color:#f8f8f8;border-color:#e7e7e7}.navbar-default .navbar-brand{color:#777}.navbar-default .navbar-brand:hover,.navbar-default .navbar-brand:focus{color:#5e5e5e;background-color:transparent}.navbar-default .navbar-text{color:#777}.navbar-default .navbar-nav>li>a{color:#777}.navbar-default .navbar-nav>li>a:hover,.navbar-default .navbar-nav>li>a:focus{color:#333;background-color:transparent}.navbar-default .navbar-nav>.active>a,.navbar-default .navbar-nav>.active>a:hover,.navbar-default .navbar-nav>.active>a:focus{color:#555;background-color:#e7e7e7}.navbar-default .navbar-nav>.disabled>a,.navbar-default .navbar-nav>.disabled>a:hover,.navbar-default .navbar-nav>.disabled>a:focus{color:#ccc;background-color:transparent}.navbar-default .navbar-toggle{border-color:#ddd}.navbar-default .navbar-toggle:hover,.navbar-default .navbar-toggle:focus{background-color:#ddd}.navbar-default .navbar-toggle .icon-bar{background-color:#ccc}.navbar-default .navbar-collapse,.navbar-default .navbar-form{border-color:#e7e7e7}.navbar-default .navbar-nav>.dropdown>a:hover .caret,.navbar-default .navbar-nav>.dropdown>a:focus .caret{border-top-color:#333;border-bottom-color:#333}.navbar-default .navbar-nav>.open>a,.navbar-default .navbar-nav>.open>a:hover,.navbar-default .navbar-nav>.open>a:focus{color:#555;background-color:#e7e7e7}.navbar-default .navbar-nav>.open>a .caret,.navbar-default .navbar-nav>.open>a:hover .caret,.navbar-default .navbar-nav>.open>a:focus .caret{border-top-color:#555;border-bottom-color:#555}.navbar-default .navbar-nav>.dropdown>a .caret{border-top-color:#777;border-bottom-color:#777}@media(max-width:767px){.navbar-default .navbar-nav .open .dropdown-menu>li>a{color:#777}.navbar-default .navbar-nav .open .dropdown-menu>li>a:hover,.navbar-default .navbar-nav .open .dropdown-menu>li>a:focus{color:#333;background-color:transparent}.navbar-default .navbar-nav .open .dropdown-menu>.active>a,.navbar-default .navbar-nav .open .dropdown-menu>.active>a:hover,.navbar-default .navbar-nav .open .dropdown-menu>.active>a:focus{color:#555;background-color:#e7e7e7}.navbar-default .navbar-nav .open .dropdown-menu>.disabled>a,.navbar-default .navbar-nav .open .dropdown-menu>.disabled>a:hover,.navbar-default .navbar-nav .open .dropdown-menu>.disabled>a:focus{color:#ccc;background-color:transparent}}.navbar-default .navbar-link{color:#777}.navbar-default .navbar-link:hover{color:#333}.navbar-inverse{background-color:#222;border-color:#080808}.navbar-inverse .navbar-brand{color:#999}.navbar-inverse .navbar-brand:hover,.navbar-inverse .navbar-brand:focus{color:#fff;background-color:transparent}.navbar-inverse .navbar-text{color:#999}.navbar-inverse .navbar-nav>li>a{color:#999}.navbar-inverse .navbar-nav>li>a:hover,.navbar-inverse .navbar-nav>li>a:focus{color:#fff;background-color:transparent}.navbar-inverse .navbar-nav>.active>a,.navbar-inverse .navbar-nav>.active>a:hover,.navbar-inverse .navbar-nav>.active>a:focus{color:#fff;background-color:#080808}.navbar-inverse .navbar-nav>.disabled>a,.navbar-inverse .navbar-nav>.disabled>a:hover,.navbar-inverse .navbar-nav>.disabled>a:focus{color:#444;background-color:transparent}.navbar-inverse .navbar-toggle{border-color:#333}.navbar-inverse .navbar-toggle:hover,.navbar-inverse .navbar-toggle:focus{background-color:#333}.navbar-inverse .navbar-toggle .icon-bar{background-color:#fff}.navbar-inverse .navbar-collapse,.navbar-inverse .navbar-form{border-color:#101010}.navbar-inverse .navbar-nav>.open>a,.navbar-inverse .navbar-nav>.open>a:hover,.navbar-inverse .navbar-nav>.open>a:focus{color:#fff;background-color:#080808}.navbar-inverse .navbar-nav>.dropdown>a:hover .caret{border-top-color:#fff;border-bottom-color:#fff}.navbar-inverse .navbar-nav>.dropdown>a .caret{border-top-color:#999;border-bottom-color:#999}.navbar-inverse .navbar-nav>.open>a .caret,.navbar-inverse .navbar-nav>.open>a:hover .caret,.navbar-inverse .navbar-nav>.open>a:focus .caret{border-top-color:#fff;border-bottom-color:#fff}@media(max-width:767px){.navbar-inverse .navbar-nav .open .dropdown-menu>.dropdown-header{border-color:#080808}.navbar-inverse .navbar-nav .open .dropdown-menu>li>a{color:#999}.navbar-inverse .navbar-nav .open .dropdown-menu>li>a:hover,.navbar-inverse .navbar-nav .open .dropdown-menu>li>a:focus{color:#fff;background-color:transparent}.navbar-inverse .navbar-nav .open .dropdown-menu>.active>a,.navbar-inverse .navbar-nav .open .dropdown-menu>.active>a:hover,.navbar-inverse .navbar-nav .open .dropdown-menu>.active>a:focus{color:#fff;background-color:#080808}.navbar-inverse .navbar-nav .open .dropdown-menu>.disabled>a,.navbar-inverse .navbar-nav .open .dropdown-menu>.disabled>a:hover,.navbar-inverse .navbar-nav .open .dropdown-menu>.disabled>a:focus{color:#444;background-color:transparent}}.navbar-inverse .navbar-link{color:#999}.navbar-inverse .navbar-link:hover{color:#fff}.breadcrumb{padding:8px 15px;margin-bottom:20px;list-style:none;background-color:#f5f5f5;border-radius:4px}.breadcrumb>li{display:inline-block}.breadcrumb>li+li:before{padding:0 5px;color:#ccc;content:"/\00a0"}.breadcrumb>.active{color:#999}.pagination{display:inline-block;padding-left:0;margin:20px 0;border-radius:4px}.pagination>li{display:inline}.pagination>li>a,.pagination>li>span{position:relative;float:left;padding:6px 12px;margin-left:-1px;line-height:1.428571429;text-decoration:none;background-color:#fff;border:1px solid #ddd}.pagination>li:first-child>a,.pagination>li:first-child>span{margin-left:0;border-bottom-left-radius:4px;border-top-left-radius:4px}.pagination>li:last-child>a,.pagination>li:last-child>span{border-top-right-radius:4px;border-bottom-right-radius:4px}.pagination>li>a:hover,.pagination>li>span:hover,.pagination>li>a:focus,.pagination>li>span:focus{background-color:#eee}.pagination>.active>a,.pagination>.active>span,.pagination>.active>a:hover,.pagination>.active>span:hover,.pagination>.active>a:focus,.pagination>.active>span:focus{z-index:2;color:#fff;cursor:default;background-color:#428bca;border-color:#428bca}.pagination>.disabled>span,.pagination>.disabled>span:hover,.pagination>.disabled>span:focus,.pagination>.disabled>a,.pagination>.disabled>a:hover,.pagination>.disabled>a:focus{color:#999;cursor:not-allowed;background-color:#fff;border-color:#ddd}.pagination-lg>li>a,.pagination-lg>li>span{padding:10px 16px;font-size:18px}.pagination-lg>li:first-child>a,.pagination-lg>li:first-child>span{border-bottom-left-radius:6px;border-top-left-radius:6px}.pagination-lg>li:last-child>a,.pagination-lg>li:last-child>span{border-top-right-radius:6px;border-bottom-right-radius:6px}.pagination-sm>li>a,.pagination-sm>li>span{padding:5px 10px;font-size:12px}.pagination-sm>li:first-child>a,.pagination-sm>li:first-child>span{border-bottom-left-radius:3px;border-top-left-radius:3px}.pagination-sm>li:last-child>a,.pagination-sm>li:last-child>span{border-top-right-radius:3px;border-bottom-right-radius:3px}.pager{padding-left:0;margin:20px 0;text-align:center;list-style:none}.pager:before,.pager:after{display:table;content:" "}.pager:after{clear:both}.pager:before,.pager:after{display:table;content:" "}.pager:after{clear:both}.pager li{display:inline}.pager li>a,.pager li>span{display:inline-block;padding:5px 14px;background-color:#fff;border:1px solid #ddd;border-radius:15px}.pager li>a:hover,.pager li>a:focus{text-decoration:none;background-color:#eee}.pager .next>a,.pager .next>span{float:right}.pager .previous>a,.pager .previous>span{float:left}.pager .disabled>a,.pager .disabled>a:hover,.pager .disabled>a:focus,.pager .disabled>span{color:#999;cursor:not-allowed;background-color:#fff}.label{display:inline;padding:.2em .6em .3em;font-size:75%;font-weight:bold;line-height:1;color:#fff;text-align:center;white-space:nowrap;vertical-align:baseline;border-radius:.25em}.label[href]:hover,.label[href]:focus{color:#fff;text-decoration:none;cursor:pointer}.label:empty{display:none}.label-default{background-color:#999}.label-default[href]:hover,.label-default[href]:focus{background-color:gray}.label-primary{background-color:#428bca}.label-primary[href]:hover,.label-primary[href]:focus{background-color:#3071a9}.label-success{background-color:#5cb85c}.label-success[href]:hover,.label-success[href]:focus{background-color:#449d44}.label-info{background-color:#5bc0de}.label-info[href]:hover,.label-info[href]:focus{background-color:#31b0d5}.label-warning{background-color:#f0ad4e}.label-warning[href]:hover,.label-warning[href]:focus{background-color:#ec971f}.label-danger{background-color:#d9534f}.label-danger[href]:hover,.label-danger[href]:focus{background-color:#c9302c}.badge{display:inline-block;min-width:10px;padding:3px 7px;font-size:12px;font-weight:bold;line-height:1;color:#fff;text-align:center;white-space:nowrap;vertical-align:baseline;background-color:#999;border-radius:10px}.badge:empty{display:none}a.badge:hover,a.badge:focus{color:#fff;text-decoration:none;cursor:pointer}.btn .badge{position:relative;top:-1px}a.list-group-item.active>.badge,.nav-pills>.active>a>.badge{color:#428bca;background-color:#fff}.nav-pills>li>a>.badge{margin-left:3px}.jumbotron{padding:30px;margin-bottom:30px;font-size:21px;font-weight:200;line-height:2.1428571435;color:inherit;background-color:#eee}.jumbotron h1{line-height:1;color:inherit}.jumbotron p{line-height:1.4}.container .jumbotron{border-radius:6px}@media screen and (min-width:768px){.jumbotron{padding-top:48px;padding-bottom:48px}.container .jumbotron{padding-right:60px;padding-left:60px}.jumbotron h1{font-size:63px}}.thumbnail{display:inline-block;display:block;height:auto;max-width:100%;padding:4px;margin-bottom:20px;line-height:1.428571429;background-color:#fff;border:1px solid #ddd;border-radius:4px;-webkit-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.thumbnail>img{display:block;height:auto;max-width:100%;margin-right:auto;margin-left:auto}a.thumbnail:hover,a.thumbnail:focus,a.thumbnail.active{border-color:#428bca}.thumbnail .caption{padding:9px;color:#333}.alert{padding:15px;margin-bottom:20px;border:1px solid transparent;border-radius:4px}.alert h4{margin-top:0;color:inherit}.alert .alert-link{font-weight:bold}.alert>p,.alert>ul{margin-bottom:0}.alert>p+p{margin-top:5px}.alert-dismissable{padding-right:35px}.alert-dismissable .close{position:relative;top:-2px;right:-21px;color:inherit}.alert-success{color:#468847;background-color:#dff0d8;border-color:#d6e9c6}.alert-success hr{border-top-color:#c9e2b3}.alert-success .alert-link{color:#356635}.alert-info{color:#3a87ad;background-color:#d9edf7;border-color:#bce8f1}.alert-info hr{border-top-color:#a6e1ec}.alert-info .alert-link{color:#2d6987}.alert-warning{color:#c09853;background-color:#fcf8e3;border-color:#faebcc}.alert-warning hr{border-top-color:#f7e1b5}.alert-warning .alert-link{color:#a47e3c}.alert-danger{color:#b94a48;background-color:#f2dede;border-color:#ebccd1}.alert-danger hr{border-top-color:#e4b9c0}.alert-danger .alert-link{color:#953b39}@-webkit-keyframes progress-bar-stripes{from{background-position:40px 0}to{background-position:0 0}}@-moz-keyframes progress-bar-stripes{from{background-position:40px 0}to{background-position:0 0}}@-o-keyframes progress-bar-stripes{from{background-position:0 0}to{background-position:40px 0}}@keyframes progress-bar-stripes{from{background-position:40px 0}to{background-position:0 0}}.progress{height:20px;margin-bottom:20px;overflow:hidden;background-color:#f5f5f5;border-radius:4px;-webkit-box-shadow:inset 0 1px 2px rgba(0,0,0,0.1);box-shadow:inset 0 1px 2px rgba(0,0,0,0.1)}.progress-bar{float:left;width:0;height:100%;font-size:12px;line-height:20px;color:#fff;text-align:center;background-color:#428bca;-webkit-box-shadow:inset 0 -1px 0 rgba(0,0,0,0.15);box-shadow:inset 0 -1px 0 rgba(0,0,0,0.15);-webkit-transition:width .6s ease;transition:width .6s ease}.progress-striped .progress-bar{background-image:-webkit-gradient(linear,0 100%,100% 0,color-stop(0.25,rgba(255,255,255,0.15)),color-stop(0.25,transparent),color-stop(0.5,transparent),color-stop(0.5,rgba(255,255,255,0.15)),color-stop(0.75,rgba(255,255,255,0.15)),color-stop(0.75,transparent),to(transparent));background-image:-webkit-linear-gradient(45deg,rgba(255,255,255,0.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,0.15) 50%,rgba(255,255,255,0.15) 75%,transparent 75%,transparent);background-image:-moz-linear-gradient(45deg,rgba(255,255,255,0.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,0.15) 50%,rgba(255,255,255,0.15) 75%,transparent 75%,transparent);background-image:linear-gradient(45deg,rgba(255,255,255,0.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,0.15) 50%,rgba(255,255,255,0.15) 75%,transparent 75%,transparent);background-size:40px 40px}.progress.active .progress-bar{-webkit-animation:progress-bar-stripes 2s linear infinite;animation:progress-bar-stripes 2s linear infinite}.progress-bar-success{background-color:#5cb85c}.progress-striped .progress-bar-success{background-image:-webkit-gradient(linear,0 100%,100% 0,color-stop(0.25,rgba(255,255,255,0.15)),color-stop(0.25,transparent),color-stop(0.5,transparent),color-stop(0.5,rgba(255,255,255,0.15)),color-stop(0.75,rgba(255,255,255,0.15)),color-stop(0.75,transparent),to(transparent));background-image:-webkit-linear-gradient(45deg,rgba(255,255,255,0.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,0.15) 50%,rgba(255,255,255,0.15) 75%,transparent 75%,transparent);background-image:-moz-linear-gradient(45deg,rgba(255,255,255,0.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,0.15) 50%,rgba(255,255,255,0.15) 75%,transparent 75%,transparent);background-image:linear-gradient(45deg,rgba(255,255,255,0.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,0.15) 50%,rgba(255,255,255,0.15) 75%,transparent 75%,transparent)}.progress-bar-info{background-color:#5bc0de}.progress-striped .progress-bar-info{background-image:-webkit-gradient(linear,0 100%,100% 0,color-stop(0.25,rgba(255,255,255,0.15)),color-stop(0.25,transparent),color-stop(0.5,transparent),color-stop(0.5,rgba(255,255,255,0.15)),color-stop(0.75,rgba(255,255,255,0.15)),color-stop(0.75,transparent),to(transparent));background-image:-webkit-linear-gradient(45deg,rgba(255,255,255,0.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,0.15) 50%,rgba(255,255,255,0.15) 75%,transparent 75%,transparent);background-image:-moz-linear-gradient(45deg,rgba(255,255,255,0.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,0.15) 50%,rgba(255,255,255,0.15) 75%,transparent 75%,transparent);background-image:linear-gradient(45deg,rgba(255,255,255,0.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,0.15) 50%,rgba(255,255,255,0.15) 75%,transparent 75%,transparent)}.progress-bar-warning{background-color:#f0ad4e}.progress-striped .progress-bar-warning{background-image:-webkit-gradient(linear,0 100%,100% 0,color-stop(0.25,rgba(255,255,255,0.15)),color-stop(0.25,transparent),color-stop(0.5,transparent),color-stop(0.5,rgba(255,255,255,0.15)),color-stop(0.75,rgba(255,255,255,0.15)),color-stop(0.75,transparent),to(transparent));background-image:-webkit-linear-gradient(45deg,rgba(255,255,255,0.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,0.15) 50%,rgba(255,255,255,0.15) 75%,transparent 75%,transparent);background-image:-moz-linear-gradient(45deg,rgba(255,255,255,0.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,0.15) 50%,rgba(255,255,255,0.15) 75%,transparent 75%,transparent);background-image:linear-gradient(45deg,rgba(255,255,255,0.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,0.15) 50%,rgba(255,255,255,0.15) 75%,transparent 75%,transparent)}.progress-bar-danger{background-color:#d9534f}.progress-striped .progress-bar-danger{background-image:-webkit-gradient(linear,0 100%,100% 0,color-stop(0.25,rgba(255,255,255,0.15)),color-stop(0.25,transparent),color-stop(0.5,transparent),color-stop(0.5,rgba(255,255,255,0.15)),color-stop(0.75,rgba(255,255,255,0.15)),color-stop(0.75,transparent),to(transparent));background-image:-webkit-linear-gradient(45deg,rgba(255,255,255,0.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,0.15) 50%,rgba(255,255,255,0.15) 75%,transparent 75%,transparent);background-image:-moz-linear-gradient(45deg,rgba(255,255,255,0.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,0.15) 50%,rgba(255,255,255,0.15) 75%,transparent 75%,transparent);background-image:linear-gradient(45deg,rgba(255,255,255,0.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,0.15) 50%,rgba(255,255,255,0.15) 75%,transparent 75%,transparent)}.media,.media-body{overflow:hidden;zoom:1}.media,.media .media{margin-top:15px}.media:first-child{margin-top:0}.media-object{display:block}.media-heading{margin:0 0 5px}.media>.pull-left{margin-right:10px}.media>.pull-right{margin-left:10px}.media-list{padding-left:0;list-style:none}.list-group{padding-left:0;margin-bottom:20px}.list-group-item{position:relative;display:block;padding:10px 15px;margin-bottom:-1px;background-color:#fff;border:1px solid #ddd}.list-group-item:first-child{border-top-right-radius:4px;border-top-left-radius:4px}.list-group-item:last-child{margin-bottom:0;border-bottom-right-radius:4px;border-bottom-left-radius:4px}.list-group-item>.badge{float:right}.list-group-item>.badge+.badge{margin-right:5px}a.list-group-item{color:#555}a.list-group-item .list-group-item-heading{color:#333}a.list-group-item:hover,a.list-group-item:focus{text-decoration:none;background-color:#f5f5f5}a.list-group-item.active,a.list-group-item.active:hover,a.list-group-item.active:focus{z-index:2;color:#fff;background-color:#428bca;border-color:#428bca}a.list-group-item.active .list-group-item-heading,a.list-group-item.active:hover .list-group-item-heading,a.list-group-item.active:focus .list-group-item-heading{color:inherit}a.list-group-item.active .list-group-item-text,a.list-group-item.active:hover .list-group-item-text,a.list-group-item.active:focus .list-group-item-text{color:#e1edf7}.list-group-item-heading{margin-top:0;margin-bottom:5px}.list-group-item-text{margin-bottom:0;line-height:1.3}.panel{margin-bottom:20px;background-color:#fff;border:1px solid transparent;border-radius:4px;-webkit-box-shadow:0 1px 1px rgba(0,0,0,0.05);box-shadow:0 1px 1px rgba(0,0,0,0.05)}.panel-body{padding:15px}.panel-body:before,.panel-body:after{display:table;content:" "}.panel-body:after{clear:both}.panel-body:before,.panel-body:after{display:table;content:" "}.panel-body:after{clear:both}.panel>.list-group{margin-bottom:0}.panel>.list-group .list-group-item{border-width:1px 0}.panel>.list-group .list-group-item:first-child{border-top-right-radius:0;border-top-left-radius:0}.panel>.list-group .list-group-item:last-child{border-bottom:0}.panel-heading+.list-group .list-group-item:first-child{border-top-width:0}.panel>.table,.panel>.table-responsive{margin-bottom:0}.panel>.panel-body+.table,.panel>.panel-body+.table-responsive{border-top:1px solid #ddd}.panel>.table-bordered,.panel>.table-responsive>.table-bordered{border:0}.panel>.table-bordered>thead>tr>th:first-child,.panel>.table-responsive>.table-bordered>thead>tr>th:first-child,.panel>.table-bordered>tbody>tr>th:first-child,.panel>.table-responsive>.table-bordered>tbody>tr>th:first-child,.panel>.table-bordered>tfoot>tr>th:first-child,.panel>.table-responsive>.table-bordered>tfoot>tr>th:first-child,.panel>.table-bordered>thead>tr>td:first-child,.panel>.table-responsive>.table-bordered>thead>tr>td:first-child,.panel>.table-bordered>tbody>tr>td:first-child,.panel>.table-responsive>.table-bordered>tbody>tr>td:first-child,.panel>.table-bordered>tfoot>tr>td:first-child,.panel>.table-responsive>.table-bordered>tfoot>tr>td:first-child{border-left:0}.panel>.table-bordered>thead>tr>th:last-child,.panel>.table-responsive>.table-bordered>thead>tr>th:last-child,.panel>.table-bordered>tbody>tr>th:last-child,.panel>.table-responsive>.table-bordered>tbody>tr>th:last-child,.panel>.table-bordered>tfoot>tr>th:last-child,.panel>.table-responsive>.table-bordered>tfoot>tr>th:last-child,.panel>.table-bordered>thead>tr>td:last-child,.panel>.table-responsive>.table-bordered>thead>tr>td:last-child,.panel>.table-bordered>tbody>tr>td:last-child,.panel>.table-responsive>.table-bordered>tbody>tr>td:last-child,.panel>.table-bordered>tfoot>tr>td:last-child,.panel>.table-responsive>.table-bordered>tfoot>tr>td:last-child{border-right:0}.panel>.table-bordered>thead>tr:last-child>th,.panel>.table-responsive>.table-bordered>thead>tr:last-child>th,.panel>.table-bordered>tbody>tr:last-child>th,.panel>.table-responsive>.table-bordered>tbody>tr:last-child>th,.panel>.table-bordered>tfoot>tr:last-child>th,.panel>.table-responsive>.table-bordered>tfoot>tr:last-child>th,.panel>.table-bordered>thead>tr:last-child>td,.panel>.table-responsive>.table-bordered>thead>tr:last-child>td,.panel>.table-bordered>tbody>tr:last-child>td,.panel>.table-responsive>.table-bordered>tbody>tr:last-child>td,.panel>.table-bordered>tfoot>tr:last-child>td,.panel>.table-responsive>.table-bordered>tfoot>tr:last-child>td{border-bottom:0}.panel-heading{padding:10px 15px;border-bottom:1px solid transparent;border-top-right-radius:3px;border-top-left-radius:3px}.panel-heading>.dropdown .dropdown-toggle{color:inherit}.panel-title{margin-top:0;margin-bottom:0;font-size:16px}.panel-title>a{color:inherit}.panel-footer{padding:10px 15px;background-color:#f5f5f5;border-top:1px solid #ddd;border-bottom-right-radius:3px;border-bottom-left-radius:3px}.panel-group .panel{margin-bottom:0;overflow:hidden;border-radius:4px}.panel-group .panel+.panel{margin-top:5px}.panel-group .panel-heading{border-bottom:0}.panel-group .panel-heading+.panel-collapse .panel-body{border-top:1px solid #ddd}.panel-group .panel-footer{border-top:0}.panel-group .panel-footer+.panel-collapse .panel-body{border-bottom:1px solid #ddd}.panel-default{border-color:#ddd}.panel-default>.panel-heading{color:#333;background-color:#f5f5f5;border-color:#ddd}.panel-default>.panel-heading+.panel-collapse .panel-body{border-top-color:#ddd}.panel-default>.panel-heading>.dropdown .caret{border-color:#333 transparent}.panel-default>.panel-footer+.panel-collapse .panel-body{border-bottom-color:#ddd}.panel-primary{border-color:#428bca}.panel-primary>.panel-heading{color:#fff;background-color:#428bca;border-color:#428bca}.panel-primary>.panel-heading+.panel-collapse .panel-body{border-top-color:#428bca}.panel-primary>.panel-heading>.dropdown .caret{border-color:#fff transparent}.panel-primary>.panel-footer+.panel-collapse .panel-body{border-bottom-color:#428bca}.panel-success{border-color:#d6e9c6}.panel-success>.panel-heading{color:#468847;background-color:#dff0d8;border-color:#d6e9c6}.panel-success>.panel-heading+.panel-collapse .panel-body{border-top-color:#d6e9c6}.panel-success>.panel-heading>.dropdown .caret{border-color:#468847 transparent}.panel-success>.panel-footer+.panel-collapse .panel-body{border-bottom-color:#d6e9c6}.panel-warning{border-color:#faebcc}.panel-warning>.panel-heading{color:#c09853;background-color:#fcf8e3;border-color:#faebcc}.panel-warning>.panel-heading+.panel-collapse .panel-body{border-top-color:#faebcc}.panel-warning>.panel-heading>.dropdown .caret{border-color:#c09853 transparent}.panel-warning>.panel-footer+.panel-collapse .panel-body{border-bottom-color:#faebcc}.panel-danger{border-color:#ebccd1}.panel-danger>.panel-heading{color:#b94a48;background-color:#f2dede;border-color:#ebccd1}.panel-danger>.panel-heading+.panel-collapse .panel-body{border-top-color:#ebccd1}.panel-danger>.panel-heading>.dropdown .caret{border-color:#b94a48 transparent}.panel-danger>.panel-footer+.panel-collapse .panel-body{border-bottom-color:#ebccd1}.panel-info{border-color:#bce8f1}.panel-info>.panel-heading{color:#3a87ad;background-color:#d9edf7;border-color:#bce8f1}.panel-info>.panel-heading+.panel-collapse .panel-body{border-top-color:#bce8f1}.panel-info>.panel-heading>.dropdown .caret{border-color:#3a87ad transparent}.panel-info>.panel-footer+.panel-collapse .panel-body{border-bottom-color:#bce8f1}.well{min-height:20px;padding:19px;margin-bottom:20px;background-color:#f5f5f5;border:1px solid #e3e3e3;border-radius:4px;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,0.05);box-shadow:inset 0 1px 1px rgba(0,0,0,0.05)}.well blockquote{border-color:#ddd;border-color:rgba(0,0,0,0.15)}.well-lg{padding:24px;border-radius:6px}.well-sm{padding:9px;border-radius:3px}.close{float:right;font-size:21px;font-weight:bold;line-height:1;color:#000;text-shadow:0 1px 0 #fff;opacity:.2;filter:alpha(opacity=20)}.close:hover,.close:focus{color:#000;text-decoration:none;cursor:pointer;opacity:.5;filter:alpha(opacity=50)}button.close{padding:0;cursor:pointer;background:transparent;border:0;-webkit-appearance:none}.modal-open{overflow:hidden}.modal{position:fixed;top:0;right:0;bottom:0;left:0;z-index:1040;display:none;overflow:auto;overflow-y:scroll}.modal.fade .modal-dialog{-webkit-transform:translate(0,-25%);-ms-transform:translate(0,-25%);transform:translate(0,-25%);-webkit-transition:-webkit-transform .3s ease-out;-moz-transition:-moz-transform .3s ease-out;-o-transition:-o-transform .3s ease-out;transition:transform .3s ease-out}.modal.in .modal-dialog{-webkit-transform:translate(0,0);-ms-transform:translate(0,0);transform:translate(0,0)}.modal-dialog{position:relative;z-index:1050;width:auto;padding:10px;margin-right:auto;margin-left:auto}.modal-content{position:relative;background-color:#fff;border:1px solid #999;border:1px solid rgba(0,0,0,0.2);border-radius:6px;outline:0;-webkit-box-shadow:0 3px 9px rgba(0,0,0,0.5);box-shadow:0 3px 9px rgba(0,0,0,0.5);background-clip:padding-box}.modal-backdrop{position:fixed;top:0;right:0;bottom:0;left:0;z-index:1030;background-color:#000}.modal-backdrop.fade{opacity:0;filter:alpha(opacity=0)}.modal-backdrop.in{opacity:.5;filter:alpha(opacity=50)}.modal-header{min-height:16.428571429px;padding:15px;border-bottom:1px solid #e5e5e5}.modal-header .close{margin-top:-2px}.modal-title{margin:0;line-height:1.428571429}.modal-body{position:relative;padding:20px}.modal-footer{padding:19px 20px 20px;margin-top:15px;text-align:right;border-top:1px solid #e5e5e5}.modal-footer:before,.modal-footer:after{display:table;content:" "}.modal-footer:after{clear:both}.modal-footer:before,.modal-footer:after{display:table;content:" "}.modal-footer:after{clear:both}.modal-footer .btn+.btn{margin-bottom:0;margin-left:5px}.modal-footer .btn-group .btn+.btn{margin-left:-1px}.modal-footer .btn-block+.btn-block{margin-left:0}@media screen and (min-width:768px){.modal-dialog{width:600px;padding-top:30px;padding-bottom:30px}.modal-content{-webkit-box-shadow:0 5px 15px rgba(0,0,0,0.5);box-shadow:0 5px 15px rgba(0,0,0,0.5)}}.tooltip{position:absolute;z-index:1030;display:block;font-size:12px;line-height:1.4;opacity:0;filter:alpha(opacity=0);visibility:visible}.tooltip.in{opacity:.9;filter:alpha(opacity=90)}.tooltip.top{padding:5px 0;margin-top:-3px}.tooltip.right{padding:0 5px;margin-left:3px}.tooltip.bottom{padding:5px 0;margin-top:3px}.tooltip.left{padding:0 5px;margin-left:-3px}.tooltip-inner{max-width:200px;padding:3px 8px;color:#fff;text-align:center;text-decoration:none;background-color:#000;border-radius:4px}.tooltip-arrow{position:absolute;width:0;height:0;border-color:transparent;border-style:solid}.tooltip.top .tooltip-arrow{bottom:0;left:50%;margin-left:-5px;border-top-color:#000;border-width:5px 5px 0}.tooltip.top-left .tooltip-arrow{bottom:0;left:5px;border-top-color:#000;border-width:5px 5px 0}.tooltip.top-right .tooltip-arrow{right:5px;bottom:0;border-top-color:#000;border-width:5px 5px 0}.tooltip.right .tooltip-arrow{top:50%;left:0;margin-top:-5px;border-right-color:#000;border-width:5px 5px 5px 0}.tooltip.left .tooltip-arrow{top:50%;right:0;margin-top:-5px;border-left-color:#000;border-width:5px 0 5px 5px}.tooltip.bottom .tooltip-arrow{top:0;left:50%;margin-left:-5px;border-bottom-color:#000;border-width:0 5px 5px}.tooltip.bottom-left .tooltip-arrow{top:0;left:5px;border-bottom-color:#000;border-width:0 5px 5px}.tooltip.bottom-right .tooltip-arrow{top:0;right:5px;border-bottom-color:#000;border-width:0 5px 5px}.popover{position:absolute;top:0;left:0;z-index:1010;display:none;max-width:276px;padding:1px;text-align:left;white-space:normal;background-color:#fff;border:1px solid #ccc;border:1px solid rgba(0,0,0,0.2);border-radius:6px;-webkit-box-shadow:0 5px 10px rgba(0,0,0,0.2);box-shadow:0 5px 10px rgba(0,0,0,0.2);background-clip:padding-box}.popover.top{margin-top:-10px}.popover.right{margin-left:10px}.popover.bottom{margin-top:10px}.popover.left{margin-left:-10px}.popover-title{padding:8px 14px;margin:0;font-size:14px;font-weight:normal;line-height:18px;background-color:#f7f7f7;border-bottom:1px solid #ebebeb;border-radius:5px 5px 0 0}.popover-content{padding:9px 14px}.popover .arrow,.popover .arrow:after{position:absolute;display:block;width:0;height:0;border-color:transparent;border-style:solid}.popover .arrow{border-width:11px}.popover .arrow:after{border-width:10px;content:""}.popover.top .arrow{bottom:-11px;left:50%;margin-left:-11px;border-top-color:#999;border-top-color:rgba(0,0,0,0.25);border-bottom-width:0}.popover.top .arrow:after{bottom:1px;margin-left:-10px;border-top-color:#fff;border-bottom-width:0;content:" "}.popover.right .arrow{top:50%;left:-11px;margin-top:-11px;border-right-color:#999;border-right-color:rgba(0,0,0,0.25);border-left-width:0}.popover.right .arrow:after{bottom:-10px;left:1px;border-right-color:#fff;border-left-width:0;content:" "}.popover.bottom .arrow{top:-11px;left:50%;margin-left:-11px;border-bottom-color:#999;border-bottom-color:rgba(0,0,0,0.25);border-top-width:0}.popover.bottom .arrow:after{top:1px;margin-left:-10px;border-bottom-color:#fff;border-top-width:0;content:" "}.popover.left .arrow{top:50%;right:-11px;margin-top:-11px;border-left-color:#999;border-left-color:rgba(0,0,0,0.25);border-right-width:0}.popover.left .arrow:after{right:1px;bottom:-10px;border-left-color:#fff;border-right-width:0;content:" "}.carousel{position:relative}.carousel-inner{position:relative;width:100%;overflow:hidden}.carousel-inner>.item{position:relative;display:none;-webkit-transition:.6s ease-in-out left;transition:.6s ease-in-out left}.carousel-inner>.item>img,.carousel-inner>.item>a>img{display:block;height:auto;max-width:100%;line-height:1}.carousel-inner>.active,.carousel-inner>.next,.carousel-inner>.prev{display:block}.carousel-inner>.active{left:0}.carousel-inner>.next,.carousel-inner>.prev{position:absolute;top:0;width:100%}.carousel-inner>.next{left:100%}.carousel-inner>.prev{left:-100%}.carousel-inner>.next.left,.carousel-inner>.prev.right{left:0}.carousel-inner>.active.left{left:-100%}.carousel-inner>.active.right{left:100%}.carousel-control{position:absolute;top:0;bottom:0;left:0;width:15%;font-size:20px;color:#fff;text-align:center;text-shadow:0 1px 2px rgba(0,0,0,0.6);opacity:.5;filter:alpha(opacity=50)}.carousel-control.left{background-image:-webkit-gradient(linear,0 top,100% top,from(rgba(0,0,0,0.5)),to(rgba(0,0,0,0.0001)));background-image:-webkit-linear-gradient(left,color-stop(rgba(0,0,0,0.5) 0),color-stop(rgba(0,0,0,0.0001) 100%));background-image:-moz-linear-gradient(left,rgba(0,0,0,0.5) 0,rgba(0,0,0,0.0001) 100%);background-image:linear-gradient(to right,rgba(0,0,0,0.5) 0,rgba(0,0,0,0.0001) 100%);background-repeat:repeat-x;filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#80000000',endColorstr='#00000000',GradientType=1)}.carousel-control.right{right:0;left:auto;background-image:-webkit-gradient(linear,0 top,100% top,from(rgba(0,0,0,0.0001)),to(rgba(0,0,0,0.5)));background-image:-webkit-linear-gradient(left,color-stop(rgba(0,0,0,0.0001) 0),color-stop(rgba(0,0,0,0.5) 100%));background-image:-moz-linear-gradient(left,rgba(0,0,0,0.0001) 0,rgba(0,0,0,0.5) 100%);background-image:linear-gradient(to right,rgba(0,0,0,0.0001) 0,rgba(0,0,0,0.5) 100%);background-repeat:repeat-x;filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#00000000',endColorstr='#80000000',GradientType=1)}.carousel-control:hover,.carousel-control:focus{color:#fff;text-decoration:none;opacity:.9;filter:alpha(opacity=90)}.carousel-control .icon-prev,.carousel-control .icon-next,.carousel-control .glyphicon-chevron-left,.carousel-control .glyphicon-chevron-right{position:absolute;top:50%;z-index:5;display:inline-block}.carousel-control .icon-prev,.carousel-control .glyphicon-chevron-left{left:50%}.carousel-control .icon-next,.carousel-control .glyphicon-chevron-right{right:50%}.carousel-control .icon-prev,.carousel-control .icon-next{width:20px;height:20px;margin-top:-10px;margin-left:-10px;font-family:serif}.carousel-control .icon-prev:before{content:'\2039'}.carousel-control .icon-next:before{content:'\203a'}.carousel-indicators{position:absolute;bottom:10px;left:50%;z-index:15;width:60%;padding-left:0;margin-left:-30%;text-align:center;list-style:none}.carousel-indicators li{display:inline-block;width:10px;height:10px;margin:1px;text-indent:-999px;cursor:pointer;background-color:#000 \9;background-color:rgba(0,0,0,0);border:1px solid #fff;border-radius:10px}.carousel-indicators .active{width:12px;height:12px;margin:0;background-color:#fff}.carousel-caption{position:absolute;right:15%;bottom:20px;left:15%;z-index:10;padding-top:20px;padding-bottom:20px;color:#fff;text-align:center;text-shadow:0 1px 2px rgba(0,0,0,0.6)}.carousel-caption .btn{text-shadow:none}@media screen and (min-width:768px){.carousel-control .glyphicons-chevron-left,.carousel-control .glyphicons-chevron-right,.carousel-control .icon-prev,.carousel-control .icon-next{width:30px;height:30px;margin-top:-15px;margin-left:-15px;font-size:30px}.carousel-caption{right:20%;left:20%;padding-bottom:30px}.carousel-indicators{bottom:20px}}.clearfix:before,.clearfix:after{display:table;content:" "}.clearfix:after{clear:both}.center-block{display:block;margin-right:auto;margin-left:auto}.pull-right{float:right !important}.pull-left{float:left !important}.hide{display:none !important}.show{display:block !important}.invisible{visibility:hidden}.text-hide{font:0/0 a;color:transparent;text-shadow:none;background-color:transparent;border:0}.hidden{display:none !important;visibility:hidden !important}.affix{position:fixed}@-ms-viewport{width:device-width}.visible-xs,tr.visible-xs,th.visible-xs,td.visible-xs{display:none !important}@media(max-width:767px){.visible-xs{display:block !important}tr.visible-xs{display:table-row !important}th.visible-xs,td.visible-xs{display:table-cell !important}}@media(min-width:768px) and (max-width:991px){.visible-xs.visible-sm{display:block !important}tr.visible-xs.visible-sm{display:table-row !important}th.visible-xs.visible-sm,td.visible-xs.visible-sm{display:table-cell !important}}@media(min-width:992px) and (max-width:1199px){.visible-xs.visible-md{display:block !important}tr.visible-xs.visible-md{display:table-row !important}th.visible-xs.visible-md,td.visible-xs.visible-md{display:table-cell !important}}@media(min-width:1200px){.visible-xs.visible-lg{display:block !important}tr.visible-xs.visible-lg{display:table-row !important}th.visible-xs.visible-lg,td.visible-xs.visible-lg{display:table-cell !important}}.visible-sm,tr.visible-sm,th.visible-sm,td.visible-sm{display:none !important}@media(max-width:767px){.visible-sm.visible-xs{display:block !important}tr.visible-sm.visible-xs{display:table-row !important}th.visible-sm.visible-xs,td.visible-sm.visible-xs{display:table-cell !important}}@media(min-width:768px) and (max-width:991px){.visible-sm{display:block !important}tr.visible-sm{display:table-row !important}th.visible-sm,td.visible-sm{display:table-cell !important}}@media(min-width:992px) and (max-width:1199px){.visible-sm.visible-md{display:block !important}tr.visible-sm.visible-md{display:table-row !important}th.visible-sm.visible-md,td.visible-sm.visible-md{display:table-cell !important}}@media(min-width:1200px){.visible-sm.visible-lg{display:block !important}tr.visible-sm.visible-lg{display:table-row !important}th.visible-sm.visible-lg,td.visible-sm.visible-lg{display:table-cell !important}}.visible-md,tr.visible-md,th.visible-md,td.visible-md{display:none !important}@media(max-width:767px){.visible-md.visible-xs{display:block !important}tr.visible-md.visible-xs{display:table-row !important}th.visible-md.visible-xs,td.visible-md.visible-xs{display:table-cell !important}}@media(min-width:768px) and (max-width:991px){.visible-md.visible-sm{display:block !important}tr.visible-md.visible-sm{display:table-row !important}th.visible-md.visible-sm,td.visible-md.visible-sm{display:table-cell !important}}@media(min-width:992px) and (max-width:1199px){.visible-md{display:block !important}tr.visible-md{display:table-row !important}th.visible-md,td.visible-md{display:table-cell !important}}@media(min-width:1200px){.visible-md.visible-lg{display:block !important}tr.visible-md.visible-lg{display:table-row !important}th.visible-md.visible-lg,td.visible-md.visible-lg{display:table-cell !important}}.visible-lg,tr.visible-lg,th.visible-lg,td.visible-lg{display:none !important}@media(max-width:767px){.visible-lg.visible-xs{display:block !important}tr.visible-lg.visible-xs{display:table-row !important}th.visible-lg.visible-xs,td.visible-lg.visible-xs{display:table-cell !important}}@media(min-width:768px) and (max-width:991px){.visible-lg.visible-sm{display:block !important}tr.visible-lg.visible-sm{display:table-row !important}th.visible-lg.visible-sm,td.visible-lg.visible-sm{display:table-cell !important}}@media(min-width:992px) and (max-width:1199px){.visible-lg.visible-md{display:block !important}tr.visible-lg.visible-md{display:table-row !important}th.visible-lg.visible-md,td.visible-lg.visible-md{display:table-cell !important}}@media(min-width:1200px){.visible-lg{display:block !important}tr.visible-lg{display:table-row !important}th.visible-lg,td.visible-lg{display:table-cell !important}}.hidden-xs{display:block !important}tr.hidden-xs{display:table-row !important}th.hidden-xs,td.hidden-xs{display:table-cell !important}@media(max-width:767px){.hidden-xs,tr.hidden-xs,th.hidden-xs,td.hidden-xs{display:none !important}}@media(min-width:768px) and (max-width:991px){.hidden-xs.hidden-sm,tr.hidden-xs.hidden-sm,th.hidden-xs.hidden-sm,td.hidden-xs.hidden-sm{display:none !important}}@media(min-width:992px) and (max-width:1199px){.hidden-xs.hidden-md,tr.hidden-xs.hidden-md,th.hidden-xs.hidden-md,td.hidden-xs.hidden-md{display:none !important}}@media(min-width:1200px){.hidden-xs.hidden-lg,tr.hidden-xs.hidden-lg,th.hidden-xs.hidden-lg,td.hidden-xs.hidden-lg{display:none !important}}.hidden-sm{display:block !important}tr.hidden-sm{display:table-row !important}th.hidden-sm,td.hidden-sm{display:table-cell !important}@media(max-width:767px){.hidden-sm.hidden-xs,tr.hidden-sm.hidden-xs,th.hidden-sm.hidden-xs,td.hidden-sm.hidden-xs{display:none !important}}@media(min-width:768px) and (max-width:991px){.hidden-sm,tr.hidden-sm,th.hidden-sm,td.hidden-sm{display:none !important}}@media(min-width:992px) and (max-width:1199px){.hidden-sm.hidden-md,tr.hidden-sm.hidden-md,th.hidden-sm.hidden-md,td.hidden-sm.hidden-md{display:none !important}}@media(min-width:1200px){.hidden-sm.hidden-lg,tr.hidden-sm.hidden-lg,th.hidden-sm.hidden-lg,td.hidden-sm.hidden-lg{display:none !important}}.hidden-md{display:block !important}tr.hidden-md{display:table-row !important}th.hidden-md,td.hidden-md{display:table-cell !important}@media(max-width:767px){.hidden-md.hidden-xs,tr.hidden-md.hidden-xs,th.hidden-md.hidden-xs,td.hidden-md.hidden-xs{display:none !important}}@media(min-width:768px) and (max-width:991px){.hidden-md.hidden-sm,tr.hidden-md.hidden-sm,th.hidden-md.hidden-sm,td.hidden-md.hidden-sm{display:none !important}}@media(min-width:992px) and (max-width:1199px){.hidden-md,tr.hidden-md,th.hidden-md,td.hidden-md{display:none !important}}@media(min-width:1200px){.hidden-md.hidden-lg,tr.hidden-md.hidden-lg,th.hidden-md.hidden-lg,td.hidden-md.hidden-lg{display:none !important}}.hidden-lg{display:block !important}tr.hidden-lg{display:table-row !important}th.hidden-lg,td.hidden-lg{display:table-cell !important}@media(max-width:767px){.hidden-lg.hidden-xs,tr.hidden-lg.hidden-xs,th.hidden-lg.hidden-xs,td.hidden-lg.hidden-xs{display:none !important}}@media(min-width:768px) and (max-width:991px){.hidden-lg.hidden-sm,tr.hidden-lg.hidden-sm,th.hidden-lg.hidden-sm,td.hidden-lg.hidden-sm{display:none !important}}@media(min-width:992px) and (max-width:1199px){.hidden-lg.hidden-md,tr.hidden-lg.hidden-md,th.hidden-lg.hidden-md,td.hidden-lg.hidden-md{display:none !important}}@media(min-width:1200px){.hidden-lg,tr.hidden-lg,th.hidden-lg,td.hidden-lg{display:none !important}}.visible-print,tr.visible-print,th.visible-print,td.visible-print{display:none !important}@media print{.visible-print{display:block !important}tr.visible-print{display:table-row !important}th.visible-print,td.visible-print{display:table-cell !important}.hidden-print,tr.hidden-print,th.hidden-print,td.hidden-print{display:none !important}} \ No newline at end of file diff --git a/docs/theme/mkdocs/css/prettify-1.0.css b/docs/theme/mkdocs/css/prettify-1.0.css new file mode 100644 index 0000000000..e0df245523 --- /dev/null +++ b/docs/theme/mkdocs/css/prettify-1.0.css @@ -0,0 +1,28 @@ +.com { color: #93a1a1; } +.lit { color: #195f91; } +.pun, .opn, .clo { color: #93a1a1; } +.fun { color: #dc322f; } +.str, .atv { color: #D14; } +.kwd, .prettyprint .tag { color: #1e347b; } +.typ, .atn, .dec, .var { color: teal; } +.pln { color: #48484c; } + +.prettyprint { + padding: 8px; +} +.prettyprint.linenums { + -webkit-box-shadow: inset 40px 0 0 #fbfbfc, inset 41px 0 0 #ececf0; + -moz-box-shadow: inset 40px 0 0 #fbfbfc, inset 41px 0 0 #ececf0; + box-shadow: inset 40px 0 0 #fbfbfc, inset 41px 0 0 #ececf0; +} + +/* Specify class=linenums on a pre to get line numbering */ +ol.linenums { + margin: 0 0 0 33px; /* IE indents via margin-left */ +} +ol.linenums li { + padding-left: 12px; + color: #bebec5; + line-height: 20px; + text-shadow: 0 1px 0 #fff; +} diff --git a/docs/theme/mkdocs/docker_io_nav.html b/docs/theme/mkdocs/docker_io_nav.html new file mode 100644 index 0000000000..814e1f5976 --- /dev/null +++ b/docs/theme/mkdocs/docker_io_nav.html @@ -0,0 +1,38 @@ + +
+
+ sign up + login +
+
\ No newline at end of file diff --git a/docs/theme/mkdocs/fonts/fontawesome-webfont.eot b/docs/theme/mkdocs/fonts/fontawesome-webfont.eot new file mode 100755 index 0000000000..7c79c6a6bc Binary files /dev/null and b/docs/theme/mkdocs/fonts/fontawesome-webfont.eot differ diff --git a/docs/theme/mkdocs/fonts/fontawesome-webfont.svg b/docs/theme/mkdocs/fonts/fontawesome-webfont.svg new file mode 100755 index 0000000000..45fdf33830 --- /dev/null +++ b/docs/theme/mkdocs/fonts/fontawesome-webfont.svg @@ -0,0 +1,414 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/theme/mkdocs/fonts/fontawesome-webfont.ttf b/docs/theme/mkdocs/fonts/fontawesome-webfont.ttf new file mode 100755 index 0000000000..e89738de5e Binary files /dev/null and b/docs/theme/mkdocs/fonts/fontawesome-webfont.ttf differ diff --git a/docs/theme/mkdocs/fonts/fontawesome-webfont.woff b/docs/theme/mkdocs/fonts/fontawesome-webfont.woff new file mode 100755 index 0000000000..8c1748aab7 Binary files /dev/null and b/docs/theme/mkdocs/fonts/fontawesome-webfont.woff differ diff --git a/docs/theme/mkdocs/fonts/glyphicons-halflings-regular.eot b/docs/theme/mkdocs/fonts/glyphicons-halflings-regular.eot new file mode 100644 index 0000000000..4a4ca865d6 Binary files /dev/null and b/docs/theme/mkdocs/fonts/glyphicons-halflings-regular.eot differ diff --git a/docs/theme/mkdocs/fonts/glyphicons-halflings-regular.svg b/docs/theme/mkdocs/fonts/glyphicons-halflings-regular.svg new file mode 100644 index 0000000000..e3e2dc739d --- /dev/null +++ b/docs/theme/mkdocs/fonts/glyphicons-halflings-regular.svg @@ -0,0 +1,229 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/theme/mkdocs/fonts/glyphicons-halflings-regular.ttf b/docs/theme/mkdocs/fonts/glyphicons-halflings-regular.ttf new file mode 100644 index 0000000000..67fa00bf83 Binary files /dev/null and b/docs/theme/mkdocs/fonts/glyphicons-halflings-regular.ttf differ diff --git a/docs/theme/mkdocs/fonts/glyphicons-halflings-regular.woff b/docs/theme/mkdocs/fonts/glyphicons-halflings-regular.woff new file mode 100644 index 0000000000..8c54182aa5 Binary files /dev/null and b/docs/theme/mkdocs/fonts/glyphicons-halflings-regular.woff differ diff --git a/docs/theme/mkdocs/footer.html b/docs/theme/mkdocs/footer.html new file mode 100644 index 0000000000..affaef0996 --- /dev/null +++ b/docs/theme/mkdocs/footer.html @@ -0,0 +1,84 @@ + + + \ No newline at end of file diff --git a/docs/theme/mkdocs/img/docs_nav_menu_arrow_1x.png b/docs/theme/mkdocs/img/docs_nav_menu_arrow_1x.png new file mode 100644 index 0000000000..9c209dd5ec Binary files /dev/null and b/docs/theme/mkdocs/img/docs_nav_menu_arrow_1x.png differ diff --git a/docs/theme/mkdocs/img/favicon.png b/docs/theme/mkdocs/img/favicon.png new file mode 100644 index 0000000000..ee01a5ee8a Binary files /dev/null and b/docs/theme/mkdocs/img/favicon.png differ diff --git a/docs/theme/mkdocs/img/logo.png b/docs/theme/mkdocs/img/logo.png new file mode 100644 index 0000000000..dce5155683 Binary files /dev/null and b/docs/theme/mkdocs/img/logo.png differ diff --git a/docs/theme/mkdocs/img/logo_compressed.png b/docs/theme/mkdocs/img/logo_compressed.png new file mode 100644 index 0000000000..717d09d773 Binary files /dev/null and b/docs/theme/mkdocs/img/logo_compressed.png differ diff --git a/docs/theme/mkdocs/img/social/docker_social_logos.png b/docs/theme/mkdocs/img/social/docker_social_logos.png new file mode 100644 index 0000000000..5bde456365 Binary files /dev/null and b/docs/theme/mkdocs/img/social/docker_social_logos.png differ diff --git a/docs/theme/mkdocs/img/website-footer_clean.svg b/docs/theme/mkdocs/img/website-footer_clean.svg new file mode 100644 index 0000000000..affc804c6d --- /dev/null +++ b/docs/theme/mkdocs/img/website-footer_clean.svg @@ -0,0 +1,197 @@ + + + + +Layer 1 + + + + + + + + + + + + + + + diff --git a/docs/theme/mkdocs/js/base.js b/docs/theme/mkdocs/js/base.js new file mode 100644 index 0000000000..c303f2a806 --- /dev/null +++ b/docs/theme/mkdocs/js/base.js @@ -0,0 +1,108 @@ +$(document).ready(function () +{ + + // Detect if the device is "touch" capable + var isTouchDevice = (('ontouchstart' in window) || (navigator.msMaxTouchPoints > 0)); + + // Tipue Search activation + $('#tipue_search_input').tipuesearch({ + 'mode': 'json', + 'contentLocation': '/search_content.json' + }); + + prettyPrint(); + + // Resizing + resizeMenuDropdown(); + checkToScrollTOC(); + $(window).resize(function() { + if(this.resizeTO) + { + clearTimeout(this.resizeTO); + } + this.resizeTO = setTimeout(function () + { + resizeMenuDropdown(); + checkToScrollTOC(); + }, 500); + }); + + /* Auto scroll */ + $('#nav_menu').scrollToFixed({ + dontSetWidth: true, + }); + + /* Toggle TOC view for Mobile */ + $('#toc_table > h2').on('click', function () + { + if ( $(window).width() <= 991 ) + { + $('#toc_table > #toc_navigation').slideToggle(); + } + }); + + // Submenu ensured drop-down functionality for desktops & mobiles + $('.dd_menu').on({ + click: function () + { + if (isTouchDevice) + { + $(this).toggleClass('dd_on_hover'); + } + }, + mouseenter: function () + { + if (!isTouchDevice) + { + $(this).addClass('dd_on_hover'); + } + }, + mouseleave: function () + { + $(this).removeClass('dd_on_hover'); + }, + }); + + /* Follow TOC links (ScrollSpy) */ + $('body').scrollspy({ + target: '#toc_table', + }); + + /* Prevent disabled link clicks */ + $("li.disabled a").click(function () + { + event.preventDefault(); + }); + +}); + +function resizeMenuDropdown () +{ + $('.dd_menu > .dd_submenu').css("max-height", ($('body').height() - 160) + 'px'); +} + +// https://github.com/bigspotteddog/ScrollToFixed +function checkToScrollTOC () +{ + if ( $(window).width() >= 768 ) + { + // If TOC is hidden, expand. + $('#toc_table > #toc_navigation').css("display", "block"); + // Then attach or detach fixed-scroll + if ( ($('#toc_table').height() + 100) >= $(window).height() ) + { + $('#toc_table').trigger('detach.ScrollToFixed'); + $('#toc_navigation > li.active').removeClass('active'); + } + else + { + $('#toc_table').scrollToFixed({ + marginTop: $('#nav_menu').height() + 14, + limit: function () { return $('#footer').offset().top - 450; }, + zIndex: 1, + minWidth: 768, + removeOffsets: true, + }); + } + } +} \ No newline at end of file diff --git a/docs/theme/mkdocs/js/bootstrap-3.0.3.min.js b/docs/theme/mkdocs/js/bootstrap-3.0.3.min.js new file mode 100644 index 0000000000..1a6258efcb --- /dev/null +++ b/docs/theme/mkdocs/js/bootstrap-3.0.3.min.js @@ -0,0 +1,7 @@ +/*! + * Bootstrap v3.0.3 (http://getbootstrap.com) + * Copyright 2013 Twitter, Inc. + * Licensed under http://www.apache.org/licenses/LICENSE-2.0 + */ + +if("undefined"==typeof jQuery)throw new Error("Bootstrap requires jQuery");+function(a){"use strict";function b(){var a=document.createElement("bootstrap"),b={WebkitTransition:"webkitTransitionEnd",MozTransition:"transitionend",OTransition:"oTransitionEnd otransitionend",transition:"transitionend"};for(var c in b)if(void 0!==a.style[c])return{end:b[c]}}a.fn.emulateTransitionEnd=function(b){var c=!1,d=this;a(this).one(a.support.transition.end,function(){c=!0});var e=function(){c||a(d).trigger(a.support.transition.end)};return setTimeout(e,b),this},a(function(){a.support.transition=b()})}(jQuery),+function(a){"use strict";var b='[data-dismiss="alert"]',c=function(c){a(c).on("click",b,this.close)};c.prototype.close=function(b){function c(){f.trigger("closed.bs.alert").remove()}var d=a(this),e=d.attr("data-target");e||(e=d.attr("href"),e=e&&e.replace(/.*(?=#[^\s]*$)/,""));var f=a(e);b&&b.preventDefault(),f.length||(f=d.hasClass("alert")?d:d.parent()),f.trigger(b=a.Event("close.bs.alert")),b.isDefaultPrevented()||(f.removeClass("in"),a.support.transition&&f.hasClass("fade")?f.one(a.support.transition.end,c).emulateTransitionEnd(150):c())};var d=a.fn.alert;a.fn.alert=function(b){return this.each(function(){var d=a(this),e=d.data("bs.alert");e||d.data("bs.alert",e=new c(this)),"string"==typeof b&&e[b].call(d)})},a.fn.alert.Constructor=c,a.fn.alert.noConflict=function(){return a.fn.alert=d,this},a(document).on("click.bs.alert.data-api",b,c.prototype.close)}(jQuery),+function(a){"use strict";var b=function(c,d){this.$element=a(c),this.options=a.extend({},b.DEFAULTS,d)};b.DEFAULTS={loadingText:"loading..."},b.prototype.setState=function(a){var b="disabled",c=this.$element,d=c.is("input")?"val":"html",e=c.data();a+="Text",e.resetText||c.data("resetText",c[d]()),c[d](e[a]||this.options[a]),setTimeout(function(){"loadingText"==a?c.addClass(b).attr(b,b):c.removeClass(b).removeAttr(b)},0)},b.prototype.toggle=function(){var a=this.$element.closest('[data-toggle="buttons"]'),b=!0;if(a.length){var c=this.$element.find("input");"radio"===c.prop("type")&&(c.prop("checked")&&this.$element.hasClass("active")?b=!1:a.find(".active").removeClass("active")),b&&c.prop("checked",!this.$element.hasClass("active")).trigger("change")}b&&this.$element.toggleClass("active")};var c=a.fn.button;a.fn.button=function(c){return this.each(function(){var d=a(this),e=d.data("bs.button"),f="object"==typeof c&&c;e||d.data("bs.button",e=new b(this,f)),"toggle"==c?e.toggle():c&&e.setState(c)})},a.fn.button.Constructor=b,a.fn.button.noConflict=function(){return a.fn.button=c,this},a(document).on("click.bs.button.data-api","[data-toggle^=button]",function(b){var c=a(b.target);c.hasClass("btn")||(c=c.closest(".btn")),c.button("toggle"),b.preventDefault()})}(jQuery),+function(a){"use strict";var b=function(b,c){this.$element=a(b),this.$indicators=this.$element.find(".carousel-indicators"),this.options=c,this.paused=this.sliding=this.interval=this.$active=this.$items=null,"hover"==this.options.pause&&this.$element.on("mouseenter",a.proxy(this.pause,this)).on("mouseleave",a.proxy(this.cycle,this))};b.DEFAULTS={interval:5e3,pause:"hover",wrap:!0},b.prototype.cycle=function(b){return b||(this.paused=!1),this.interval&&clearInterval(this.interval),this.options.interval&&!this.paused&&(this.interval=setInterval(a.proxy(this.next,this),this.options.interval)),this},b.prototype.getActiveIndex=function(){return this.$active=this.$element.find(".item.active"),this.$items=this.$active.parent().children(),this.$items.index(this.$active)},b.prototype.to=function(b){var c=this,d=this.getActiveIndex();return b>this.$items.length-1||0>b?void 0:this.sliding?this.$element.one("slid.bs.carousel",function(){c.to(b)}):d==b?this.pause().cycle():this.slide(b>d?"next":"prev",a(this.$items[b]))},b.prototype.pause=function(b){return b||(this.paused=!0),this.$element.find(".next, .prev").length&&a.support.transition.end&&(this.$element.trigger(a.support.transition.end),this.cycle(!0)),this.interval=clearInterval(this.interval),this},b.prototype.next=function(){return this.sliding?void 0:this.slide("next")},b.prototype.prev=function(){return this.sliding?void 0:this.slide("prev")},b.prototype.slide=function(b,c){var d=this.$element.find(".item.active"),e=c||d[b](),f=this.interval,g="next"==b?"left":"right",h="next"==b?"first":"last",i=this;if(!e.length){if(!this.options.wrap)return;e=this.$element.find(".item")[h]()}this.sliding=!0,f&&this.pause();var j=a.Event("slide.bs.carousel",{relatedTarget:e[0],direction:g});if(!e.hasClass("active")){if(this.$indicators.length&&(this.$indicators.find(".active").removeClass("active"),this.$element.one("slid.bs.carousel",function(){var b=a(i.$indicators.children()[i.getActiveIndex()]);b&&b.addClass("active")})),a.support.transition&&this.$element.hasClass("slide")){if(this.$element.trigger(j),j.isDefaultPrevented())return;e.addClass(b),e[0].offsetWidth,d.addClass(g),e.addClass(g),d.one(a.support.transition.end,function(){e.removeClass([b,g].join(" ")).addClass("active"),d.removeClass(["active",g].join(" ")),i.sliding=!1,setTimeout(function(){i.$element.trigger("slid.bs.carousel")},0)}).emulateTransitionEnd(600)}else{if(this.$element.trigger(j),j.isDefaultPrevented())return;d.removeClass("active"),e.addClass("active"),this.sliding=!1,this.$element.trigger("slid.bs.carousel")}return f&&this.cycle(),this}};var c=a.fn.carousel;a.fn.carousel=function(c){return this.each(function(){var d=a(this),e=d.data("bs.carousel"),f=a.extend({},b.DEFAULTS,d.data(),"object"==typeof c&&c),g="string"==typeof c?c:f.slide;e||d.data("bs.carousel",e=new b(this,f)),"number"==typeof c?e.to(c):g?e[g]():f.interval&&e.pause().cycle()})},a.fn.carousel.Constructor=b,a.fn.carousel.noConflict=function(){return a.fn.carousel=c,this},a(document).on("click.bs.carousel.data-api","[data-slide], [data-slide-to]",function(b){var c,d=a(this),e=a(d.attr("data-target")||(c=d.attr("href"))&&c.replace(/.*(?=#[^\s]+$)/,"")),f=a.extend({},e.data(),d.data()),g=d.attr("data-slide-to");g&&(f.interval=!1),e.carousel(f),(g=d.attr("data-slide-to"))&&e.data("bs.carousel").to(g),b.preventDefault()}),a(window).on("load",function(){a('[data-ride="carousel"]').each(function(){var b=a(this);b.carousel(b.data())})})}(jQuery),+function(a){"use strict";var b=function(c,d){this.$element=a(c),this.options=a.extend({},b.DEFAULTS,d),this.transitioning=null,this.options.parent&&(this.$parent=a(this.options.parent)),this.options.toggle&&this.toggle()};b.DEFAULTS={toggle:!0},b.prototype.dimension=function(){var a=this.$element.hasClass("width");return a?"width":"height"},b.prototype.show=function(){if(!this.transitioning&&!this.$element.hasClass("in")){var b=a.Event("show.bs.collapse");if(this.$element.trigger(b),!b.isDefaultPrevented()){var c=this.$parent&&this.$parent.find("> .panel > .in");if(c&&c.length){var d=c.data("bs.collapse");if(d&&d.transitioning)return;c.collapse("hide"),d||c.data("bs.collapse",null)}var e=this.dimension();this.$element.removeClass("collapse").addClass("collapsing")[e](0),this.transitioning=1;var f=function(){this.$element.removeClass("collapsing").addClass("in")[e]("auto"),this.transitioning=0,this.$element.trigger("shown.bs.collapse")};if(!a.support.transition)return f.call(this);var g=a.camelCase(["scroll",e].join("-"));this.$element.one(a.support.transition.end,a.proxy(f,this)).emulateTransitionEnd(350)[e](this.$element[0][g])}}},b.prototype.hide=function(){if(!this.transitioning&&this.$element.hasClass("in")){var b=a.Event("hide.bs.collapse");if(this.$element.trigger(b),!b.isDefaultPrevented()){var c=this.dimension();this.$element[c](this.$element[c]())[0].offsetHeight,this.$element.addClass("collapsing").removeClass("collapse").removeClass("in"),this.transitioning=1;var d=function(){this.transitioning=0,this.$element.trigger("hidden.bs.collapse").removeClass("collapsing").addClass("collapse")};return a.support.transition?(this.$element[c](0).one(a.support.transition.end,a.proxy(d,this)).emulateTransitionEnd(350),void 0):d.call(this)}}},b.prototype.toggle=function(){this[this.$element.hasClass("in")?"hide":"show"]()};var c=a.fn.collapse;a.fn.collapse=function(c){return this.each(function(){var d=a(this),e=d.data("bs.collapse"),f=a.extend({},b.DEFAULTS,d.data(),"object"==typeof c&&c);e||d.data("bs.collapse",e=new b(this,f)),"string"==typeof c&&e[c]()})},a.fn.collapse.Constructor=b,a.fn.collapse.noConflict=function(){return a.fn.collapse=c,this},a(document).on("click.bs.collapse.data-api","[data-toggle=collapse]",function(b){var c,d=a(this),e=d.attr("data-target")||b.preventDefault()||(c=d.attr("href"))&&c.replace(/.*(?=#[^\s]+$)/,""),f=a(e),g=f.data("bs.collapse"),h=g?"toggle":d.data(),i=d.attr("data-parent"),j=i&&a(i);g&&g.transitioning||(j&&j.find('[data-toggle=collapse][data-parent="'+i+'"]').not(d).addClass("collapsed"),d[f.hasClass("in")?"addClass":"removeClass"]("collapsed")),f.collapse(h)})}(jQuery),+function(a){"use strict";function b(){a(d).remove(),a(e).each(function(b){var d=c(a(this));d.hasClass("open")&&(d.trigger(b=a.Event("hide.bs.dropdown")),b.isDefaultPrevented()||d.removeClass("open").trigger("hidden.bs.dropdown"))})}function c(b){var c=b.attr("data-target");c||(c=b.attr("href"),c=c&&/#/.test(c)&&c.replace(/.*(?=#[^\s]*$)/,""));var d=c&&a(c);return d&&d.length?d:b.parent()}var d=".dropdown-backdrop",e="[data-toggle=dropdown]",f=function(b){a(b).on("click.bs.dropdown",this.toggle)};f.prototype.toggle=function(d){var e=a(this);if(!e.is(".disabled, :disabled")){var f=c(e),g=f.hasClass("open");if(b(),!g){if("ontouchstart"in document.documentElement&&!f.closest(".navbar-nav").length&&a('
').insertAfter(a(this)).on("click",b),f.trigger(d=a.Event("show.bs.dropdown")),d.isDefaultPrevented())return;f.toggleClass("open").trigger("shown.bs.dropdown"),e.focus()}return!1}},f.prototype.keydown=function(b){if(/(38|40|27)/.test(b.keyCode)){var d=a(this);if(b.preventDefault(),b.stopPropagation(),!d.is(".disabled, :disabled")){var f=c(d),g=f.hasClass("open");if(!g||g&&27==b.keyCode)return 27==b.which&&f.find(e).focus(),d.click();var h=a("[role=menu] li:not(.divider):visible a",f);if(h.length){var i=h.index(h.filter(":focus"));38==b.keyCode&&i>0&&i--,40==b.keyCode&&i').appendTo(document.body),this.$element.on("click.dismiss.modal",a.proxy(function(a){a.target===a.currentTarget&&("static"==this.options.backdrop?this.$element[0].focus.call(this.$element[0]):this.hide.call(this))},this)),d&&this.$backdrop[0].offsetWidth,this.$backdrop.addClass("in"),!b)return;d?this.$backdrop.one(a.support.transition.end,b).emulateTransitionEnd(150):b()}else!this.isShown&&this.$backdrop?(this.$backdrop.removeClass("in"),a.support.transition&&this.$element.hasClass("fade")?this.$backdrop.one(a.support.transition.end,b).emulateTransitionEnd(150):b()):b&&b()};var c=a.fn.modal;a.fn.modal=function(c,d){return this.each(function(){var e=a(this),f=e.data("bs.modal"),g=a.extend({},b.DEFAULTS,e.data(),"object"==typeof c&&c);f||e.data("bs.modal",f=new b(this,g)),"string"==typeof c?f[c](d):g.show&&f.show(d)})},a.fn.modal.Constructor=b,a.fn.modal.noConflict=function(){return a.fn.modal=c,this},a(document).on("click.bs.modal.data-api",'[data-toggle="modal"]',function(b){var c=a(this),d=c.attr("href"),e=a(c.attr("data-target")||d&&d.replace(/.*(?=#[^\s]+$)/,"")),f=e.data("modal")?"toggle":a.extend({remote:!/#/.test(d)&&d},e.data(),c.data());b.preventDefault(),e.modal(f,this).one("hide",function(){c.is(":visible")&&c.focus()})}),a(document).on("show.bs.modal",".modal",function(){a(document.body).addClass("modal-open")}).on("hidden.bs.modal",".modal",function(){a(document.body).removeClass("modal-open")})}(jQuery),+function(a){"use strict";var b=function(a,b){this.type=this.options=this.enabled=this.timeout=this.hoverState=this.$element=null,this.init("tooltip",a,b)};b.DEFAULTS={animation:!0,placement:"top",selector:!1,template:'
',trigger:"hover focus",title:"",delay:0,html:!1,container:!1},b.prototype.init=function(b,c,d){this.enabled=!0,this.type=b,this.$element=a(c),this.options=this.getOptions(d);for(var e=this.options.trigger.split(" "),f=e.length;f--;){var g=e[f];if("click"==g)this.$element.on("click."+this.type,this.options.selector,a.proxy(this.toggle,this));else if("manual"!=g){var h="hover"==g?"mouseenter":"focus",i="hover"==g?"mouseleave":"blur";this.$element.on(h+"."+this.type,this.options.selector,a.proxy(this.enter,this)),this.$element.on(i+"."+this.type,this.options.selector,a.proxy(this.leave,this))}}this.options.selector?this._options=a.extend({},this.options,{trigger:"manual",selector:""}):this.fixTitle()},b.prototype.getDefaults=function(){return b.DEFAULTS},b.prototype.getOptions=function(b){return b=a.extend({},this.getDefaults(),this.$element.data(),b),b.delay&&"number"==typeof b.delay&&(b.delay={show:b.delay,hide:b.delay}),b},b.prototype.getDelegateOptions=function(){var b={},c=this.getDefaults();return this._options&&a.each(this._options,function(a,d){c[a]!=d&&(b[a]=d)}),b},b.prototype.enter=function(b){var c=b instanceof this.constructor?b:a(b.currentTarget)[this.type](this.getDelegateOptions()).data("bs."+this.type);return clearTimeout(c.timeout),c.hoverState="in",c.options.delay&&c.options.delay.show?(c.timeout=setTimeout(function(){"in"==c.hoverState&&c.show()},c.options.delay.show),void 0):c.show()},b.prototype.leave=function(b){var c=b instanceof this.constructor?b:a(b.currentTarget)[this.type](this.getDelegateOptions()).data("bs."+this.type);return clearTimeout(c.timeout),c.hoverState="out",c.options.delay&&c.options.delay.hide?(c.timeout=setTimeout(function(){"out"==c.hoverState&&c.hide()},c.options.delay.hide),void 0):c.hide()},b.prototype.show=function(){var b=a.Event("show.bs."+this.type);if(this.hasContent()&&this.enabled){if(this.$element.trigger(b),b.isDefaultPrevented())return;var c=this.tip();this.setContent(),this.options.animation&&c.addClass("fade");var d="function"==typeof this.options.placement?this.options.placement.call(this,c[0],this.$element[0]):this.options.placement,e=/\s?auto?\s?/i,f=e.test(d);f&&(d=d.replace(e,"")||"top"),c.detach().css({top:0,left:0,display:"block"}).addClass(d),this.options.container?c.appendTo(this.options.container):c.insertAfter(this.$element);var g=this.getPosition(),h=c[0].offsetWidth,i=c[0].offsetHeight;if(f){var j=this.$element.parent(),k=d,l=document.documentElement.scrollTop||document.body.scrollTop,m="body"==this.options.container?window.innerWidth:j.outerWidth(),n="body"==this.options.container?window.innerHeight:j.outerHeight(),o="body"==this.options.container?0:j.offset().left;d="bottom"==d&&g.top+g.height+i-l>n?"top":"top"==d&&g.top-l-i<0?"bottom":"right"==d&&g.right+h>m?"left":"left"==d&&g.left-h

'}),b.prototype=a.extend({},a.fn.tooltip.Constructor.prototype),b.prototype.constructor=b,b.prototype.getDefaults=function(){return b.DEFAULTS},b.prototype.setContent=function(){var a=this.tip(),b=this.getTitle(),c=this.getContent();a.find(".popover-title")[this.options.html?"html":"text"](b),a.find(".popover-content")[this.options.html?"html":"text"](c),a.removeClass("fade top bottom left right in"),a.find(".popover-title").html()||a.find(".popover-title").hide()},b.prototype.hasContent=function(){return this.getTitle()||this.getContent()},b.prototype.getContent=function(){var a=this.$element,b=this.options;return a.attr("data-content")||("function"==typeof b.content?b.content.call(a[0]):b.content)},b.prototype.arrow=function(){return this.$arrow=this.$arrow||this.tip().find(".arrow")},b.prototype.tip=function(){return this.$tip||(this.$tip=a(this.options.template)),this.$tip};var c=a.fn.popover;a.fn.popover=function(c){return this.each(function(){var d=a(this),e=d.data("bs.popover"),f="object"==typeof c&&c;e||d.data("bs.popover",e=new b(this,f)),"string"==typeof c&&e[c]()})},a.fn.popover.Constructor=b,a.fn.popover.noConflict=function(){return a.fn.popover=c,this}}(jQuery),+function(a){"use strict";function b(c,d){var e,f=a.proxy(this.process,this);this.$element=a(c).is("body")?a(window):a(c),this.$body=a("body"),this.$scrollElement=this.$element.on("scroll.bs.scroll-spy.data-api",f),this.options=a.extend({},b.DEFAULTS,d),this.selector=(this.options.target||(e=a(c).attr("href"))&&e.replace(/.*(?=#[^\s]+$)/,"")||"")+" .nav li > a",this.offsets=a([]),this.targets=a([]),this.activeTarget=null,this.refresh(),this.process()}b.DEFAULTS={offset:10},b.prototype.refresh=function(){var b=this.$element[0]==window?"offset":"position";this.offsets=a([]),this.targets=a([]);var c=this;this.$body.find(this.selector).map(function(){var d=a(this),e=d.data("target")||d.attr("href"),f=/^#\w/.test(e)&&a(e);return f&&f.length&&[[f[b]().top+(!a.isWindow(c.$scrollElement.get(0))&&c.$scrollElement.scrollTop()),e]]||null}).sort(function(a,b){return a[0]-b[0]}).each(function(){c.offsets.push(this[0]),c.targets.push(this[1])})},b.prototype.process=function(){var a,b=this.$scrollElement.scrollTop()+this.options.offset,c=this.$scrollElement[0].scrollHeight||this.$body[0].scrollHeight,d=c-this.$scrollElement.height(),e=this.offsets,f=this.targets,g=this.activeTarget;if(b>=d)return g!=(a=f.last()[0])&&this.activate(a);for(a=e.length;a--;)g!=f[a]&&b>=e[a]&&(!e[a+1]||b<=e[a+1])&&this.activate(f[a])},b.prototype.activate=function(b){this.activeTarget=b,a(this.selector).parents(".active").removeClass("active");var c=this.selector+'[data-target="'+b+'"],'+this.selector+'[href="'+b+'"]',d=a(c).parents("li").addClass("active");d.parent(".dropdown-menu").length&&(d=d.closest("li.dropdown").addClass("active")),d.trigger("activate.bs.scrollspy")};var c=a.fn.scrollspy;a.fn.scrollspy=function(c){return this.each(function(){var d=a(this),e=d.data("bs.scrollspy"),f="object"==typeof c&&c;e||d.data("bs.scrollspy",e=new b(this,f)),"string"==typeof c&&e[c]()})},a.fn.scrollspy.Constructor=b,a.fn.scrollspy.noConflict=function(){return a.fn.scrollspy=c,this},a(window).on("load",function(){a('[data-spy="scroll"]').each(function(){var b=a(this);b.scrollspy(b.data())})})}(jQuery),+function(a){"use strict";var b=function(b){this.element=a(b)};b.prototype.show=function(){var b=this.element,c=b.closest("ul:not(.dropdown-menu)"),d=b.data("target");if(d||(d=b.attr("href"),d=d&&d.replace(/.*(?=#[^\s]*$)/,"")),!b.parent("li").hasClass("active")){var e=c.find(".active:last a")[0],f=a.Event("show.bs.tab",{relatedTarget:e});if(b.trigger(f),!f.isDefaultPrevented()){var g=a(d);this.activate(b.parent("li"),c),this.activate(g,g.parent(),function(){b.trigger({type:"shown.bs.tab",relatedTarget:e})})}}},b.prototype.activate=function(b,c,d){function e(){f.removeClass("active").find("> .dropdown-menu > .active").removeClass("active"),b.addClass("active"),g?(b[0].offsetWidth,b.addClass("in")):b.removeClass("fade"),b.parent(".dropdown-menu")&&b.closest("li.dropdown").addClass("active"),d&&d()}var f=c.find("> .active"),g=d&&a.support.transition&&f.hasClass("fade");g?f.one(a.support.transition.end,e).emulateTransitionEnd(150):e(),f.removeClass("in")};var c=a.fn.tab;a.fn.tab=function(c){return this.each(function(){var d=a(this),e=d.data("bs.tab");e||d.data("bs.tab",e=new b(this)),"string"==typeof c&&e[c]()})},a.fn.tab.Constructor=b,a.fn.tab.noConflict=function(){return a.fn.tab=c,this},a(document).on("click.bs.tab.data-api",'[data-toggle="tab"], [data-toggle="pill"]',function(b){b.preventDefault(),a(this).tab("show")})}(jQuery),+function(a){"use strict";var b=function(c,d){this.options=a.extend({},b.DEFAULTS,d),this.$window=a(window).on("scroll.bs.affix.data-api",a.proxy(this.checkPosition,this)).on("click.bs.affix.data-api",a.proxy(this.checkPositionWithEventLoop,this)),this.$element=a(c),this.affixed=this.unpin=null,this.checkPosition()};b.RESET="affix affix-top affix-bottom",b.DEFAULTS={offset:0},b.prototype.checkPositionWithEventLoop=function(){setTimeout(a.proxy(this.checkPosition,this),1)},b.prototype.checkPosition=function(){if(this.$element.is(":visible")){var c=a(document).height(),d=this.$window.scrollTop(),e=this.$element.offset(),f=this.options.offset,g=f.top,h=f.bottom;"object"!=typeof f&&(h=g=f),"function"==typeof g&&(g=f.top()),"function"==typeof h&&(h=f.bottom());var i=null!=this.unpin&&d+this.unpin<=e.top?!1:null!=h&&e.top+this.$element.height()>=c-h?"bottom":null!=g&&g>=d?"top":!1;this.affixed!==i&&(this.unpin&&this.$element.css("top",""),this.affixed=i,this.unpin="bottom"==i?e.top-d:null,this.$element.removeClass(b.RESET).addClass("affix"+(i?"-"+i:"")),"bottom"==i&&this.$element.offset({top:document.body.offsetHeight-h-this.$element.height()}))}};var c=a.fn.affix;a.fn.affix=function(c){return this.each(function(){var d=a(this),e=d.data("bs.affix"),f="object"==typeof c&&c;e||d.data("bs.affix",e=new b(this,f)),"string"==typeof c&&e[c]()})},a.fn.affix.Constructor=b,a.fn.affix.noConflict=function(){return a.fn.affix=c,this},a(window).on("load",function(){a('[data-spy="affix"]').each(function(){var b=a(this),c=b.data();c.offset=c.offset||{},c.offsetBottom&&(c.offset.bottom=c.offsetBottom),c.offsetTop&&(c.offset.top=c.offsetTop),b.affix(c)})})}(jQuery); \ No newline at end of file diff --git a/docs/theme/mkdocs/js/jquery-scrolltofixed-min.js b/docs/theme/mkdocs/js/jquery-scrolltofixed-min.js new file mode 100644 index 0000000000..5382c04485 --- /dev/null +++ b/docs/theme/mkdocs/js/jquery-scrolltofixed-min.js @@ -0,0 +1,8 @@ +/* + * ScrollToFixed + * https://github.com/bigspotteddog/ScrollToFixed + * + * Copyright (c) 2011 Joseph Cava-Lynch + * MIT license + */ +(function(a){a.isScrollToFixed=function(b){return !!a(b).data("ScrollToFixed")};a.ScrollToFixed=function(d,i){var l=this;l.$el=a(d);l.el=d;l.$el.data("ScrollToFixed",l);var c=false;var F=l.$el;var G;var D;var e;var C=0;var q=0;var j=-1;var f=-1;var t=null;var y;var g;function u(){F.trigger("preUnfixed.ScrollToFixed");k();F.trigger("unfixed.ScrollToFixed");f=-1;C=F.offset().top;q=F.offset().left;if(l.options.offsets){q+=(F.offset().left-F.position().left)}if(j==-1){j=q}G=F.css("position");c=true;if(l.options.bottom!=-1){F.trigger("preFixed.ScrollToFixed");w();F.trigger("fixed.ScrollToFixed")}}function n(){var H=l.options.limit;if(!H){return 0}if(typeof(H)==="function"){return H.apply(F)}return H}function p(){return G==="fixed"}function x(){return G==="absolute"}function h(){return !(p()||x())}function w(){if(!p()){t.css({display:F.css("display"),width:F.outerWidth(true),height:F.outerHeight(true),"float":F.css("float")});cssOptions={position:"fixed",top:l.options.bottom==-1?s():"",bottom:l.options.bottom==-1?"":l.options.bottom,"margin-left":"0px"};if(!l.options.dontSetWidth){cssOptions.width=F.width()}F.css(cssOptions);F.addClass(l.options.baseClassName);if(l.options.className){F.addClass(l.options.className)}G="fixed"}}function b(){var I=n();var H=q;if(l.options.removeOffsets){H="";I=I-C}cssOptions={position:"absolute",top:I,left:H,"margin-left":"0px",bottom:""};if(!l.options.dontSetWidth){cssOptions.width=F.width()}F.css(cssOptions);G="absolute"}function k(){if(!h()){f=-1;t.css("display","none");F.css({width:"",position:D,left:"",top:e,"margin-left":""});F.removeClass("scroll-to-fixed-fixed");if(l.options.className){F.removeClass(l.options.className)}G=null}}function v(H){if(H!=f){F.css("left",q-H);f=H}}function s(){var H=l.options.marginTop;if(!H){return 0}if(typeof(H)==="function"){return H.apply(F)}return H}function z(){if(!a.isScrollToFixed(F)){return}var J=c;if(!c){u()}var H=a(window).scrollLeft();var K=a(window).scrollTop();var I=n();if(l.options.minWidth&&a(window).width()l.options.maxWidth){if(!h()||!J){o();F.trigger("preUnfixed.ScrollToFixed");k();F.trigger("unfixed.ScrollToFixed")}}else{if(l.options.bottom==-1){if(I>0&&K>=I-s()){if(!x()||!J){o();F.trigger("preAbsolute.ScrollToFixed");b();F.trigger("unfixed.ScrollToFixed")}}else{if(K>=C-s()){if(!p()||!J){o();F.trigger("preFixed.ScrollToFixed");w();f=-1;F.trigger("fixed.ScrollToFixed")}v(H)}else{if(!h()||!J){o();F.trigger("preUnfixed.ScrollToFixed");k();F.trigger("unfixed.ScrollToFixed")}}}}else{if(I>0){if(K+a(window).height()-F.outerHeight(true)>=I-(s()||-m())){if(p()){o();F.trigger("preUnfixed.ScrollToFixed");if(D==="absolute"){b()}else{k()}F.trigger("unfixed.ScrollToFixed")}}else{if(!p()){o();F.trigger("preFixed.ScrollToFixed");w()}v(H);F.trigger("fixed.ScrollToFixed")}}else{v(H)}}}}}function m(){if(!l.options.bottom){return 0}return l.options.bottom}function o(){var H=F.css("position");if(H=="absolute"){F.trigger("postAbsolute.ScrollToFixed")}else{if(H=="fixed"){F.trigger("postFixed.ScrollToFixed")}else{F.trigger("postUnfixed.ScrollToFixed")}}}var B=function(H){if(F.is(":visible")){c=false;z()}};var E=function(H){z()};var A=function(){var I=document.body;if(document.createElement&&I&&I.appendChild&&I.removeChild){var K=document.createElement("div");if(!K.getBoundingClientRect){return null}K.innerHTML="x";K.style.cssText="position:fixed;top:100px;";I.appendChild(K);var L=I.style.height,M=I.scrollTop;I.style.height="3000px";I.scrollTop=500;var H=K.getBoundingClientRect().top;I.style.height=L;var J=(H===100);I.removeChild(K);I.scrollTop=M;return J}return null};var r=function(H){H=H||window.event;if(H.preventDefault){H.preventDefault()}H.returnValue=false};l.init=function(){l.options=a.extend({},a.ScrollToFixed.defaultOptions,i);l.$el.css("z-index",l.options.zIndex);t=a("
");G=F.css("position");D=F.css("position");e=F.css("top");if(h()){l.$el.after(t)}a(window).bind("resize.ScrollToFixed",B);a(window).bind("scroll.ScrollToFixed",E);if(l.options.preFixed){F.bind("preFixed.ScrollToFixed",l.options.preFixed)}if(l.options.postFixed){F.bind("postFixed.ScrollToFixed",l.options.postFixed)}if(l.options.preUnfixed){F.bind("preUnfixed.ScrollToFixed",l.options.preUnfixed)}if(l.options.postUnfixed){F.bind("postUnfixed.ScrollToFixed",l.options.postUnfixed)}if(l.options.preAbsolute){F.bind("preAbsolute.ScrollToFixed",l.options.preAbsolute)}if(l.options.postAbsolute){F.bind("postAbsolute.ScrollToFixed",l.options.postAbsolute)}if(l.options.fixed){F.bind("fixed.ScrollToFixed",l.options.fixed)}if(l.options.unfixed){F.bind("unfixed.ScrollToFixed",l.options.unfixed)}if(l.options.spacerClass){t.addClass(l.options.spacerClass)}F.bind("resize.ScrollToFixed",function(){t.height(F.height())});F.bind("scroll.ScrollToFixed",function(){F.trigger("preUnfixed.ScrollToFixed");k();F.trigger("unfixed.ScrollToFixed");z()});F.bind("detach.ScrollToFixed",function(H){r(H);F.trigger("preUnfixed.ScrollToFixed");k();F.trigger("unfixed.ScrollToFixed");a(window).unbind("resize.ScrollToFixed",B);a(window).unbind("scroll.ScrollToFixed",E);F.unbind(".ScrollToFixed");t.remove();l.$el.removeData("ScrollToFixed")});B()};l.init()};a.ScrollToFixed.defaultOptions={marginTop:0,limit:0,bottom:-1,zIndex:1000,baseClassName:"scroll-to-fixed-fixed"};a.fn.scrollToFixed=function(b){return this.each(function(){(new a.ScrollToFixed(this,b))})}})(jQuery); diff --git a/docs/theme/mkdocs/js/prettify-1.0.min.js b/docs/theme/mkdocs/js/prettify-1.0.min.js new file mode 100644 index 0000000000..eef5ad7e6a --- /dev/null +++ b/docs/theme/mkdocs/js/prettify-1.0.min.js @@ -0,0 +1,28 @@ +var q=null;window.PR_SHOULD_USE_CONTINUATION=!0; +(function(){function L(a){function m(a){var f=a.charCodeAt(0);if(f!==92)return f;var b=a.charAt(1);return(f=r[b])?f:"0"<=b&&b<="7"?parseInt(a.substring(1),8):b==="u"||b==="x"?parseInt(a.substring(2),16):a.charCodeAt(1)}function e(a){if(a<32)return(a<16?"\\x0":"\\x")+a.toString(16);a=String.fromCharCode(a);if(a==="\\"||a==="-"||a==="["||a==="]")a="\\"+a;return a}function h(a){for(var f=a.substring(1,a.length-1).match(/\\u[\dA-Fa-f]{4}|\\x[\dA-Fa-f]{2}|\\[0-3][0-7]{0,2}|\\[0-7]{1,2}|\\[\S\s]|[^\\]/g),a= +[],b=[],o=f[0]==="^",c=o?1:0,i=f.length;c122||(d<65||j>90||b.push([Math.max(65,j)|32,Math.min(d,90)|32]),d<97||j>122||b.push([Math.max(97,j)&-33,Math.min(d,122)&-33]))}}b.sort(function(a,f){return a[0]-f[0]||f[1]-a[1]});f=[];j=[NaN,NaN];for(c=0;ci[0]&&(i[1]+1>i[0]&&b.push("-"),b.push(e(i[1])));b.push("]");return b.join("")}function y(a){for(var f=a.source.match(/\[(?:[^\\\]]|\\[\S\s])*]|\\u[\dA-Fa-f]{4}|\\x[\dA-Fa-f]{2}|\\\d+|\\[^\dux]|\(\?[!:=]|[()^]|[^()[\\^]+/g),b=f.length,d=[],c=0,i=0;c=2&&a==="["?f[c]=h(j):a!=="\\"&&(f[c]=j.replace(/[A-Za-z]/g,function(a){a=a.charCodeAt(0);return"["+String.fromCharCode(a&-33,a|32)+"]"}));return f.join("")}for(var t=0,s=!1,l=!1,p=0,d=a.length;p=5&&"lang-"===b.substring(0,5))&&!(o&&typeof o[1]==="string"))c=!1,b="src";c||(r[f]=b)}i=d;d+=f.length;if(c){c=o[1];var j=f.indexOf(c),k=j+c.length;o[2]&&(k=f.length-o[2].length,j=k-c.length);b=b.substring(5);B(l+i,f.substring(0,j),e,p);B(l+i+j,c,C(b,c),p);B(l+i+k,f.substring(k),e,p)}else p.push(l+i,b)}a.e=p}var h={},y;(function(){for(var e=a.concat(m), +l=[],p={},d=0,g=e.length;d=0;)h[n.charAt(k)]=r;r=r[1];n=""+r;p.hasOwnProperty(n)||(l.push(r),p[n]=q)}l.push(/[\S\s]/);y=L(l)})();var t=m.length;return e}function u(a){var m=[],e=[];a.tripleQuotedStrings?m.push(["str",/^(?:'''(?:[^'\\]|\\[\S\s]|''?(?=[^']))*(?:'''|$)|"""(?:[^"\\]|\\[\S\s]|""?(?=[^"]))*(?:"""|$)|'(?:[^'\\]|\\[\S\s])*(?:'|$)|"(?:[^"\\]|\\[\S\s])*(?:"|$))/,q,"'\""]):a.multiLineStrings?m.push(["str",/^(?:'(?:[^'\\]|\\[\S\s])*(?:'|$)|"(?:[^"\\]|\\[\S\s])*(?:"|$)|`(?:[^\\`]|\\[\S\s])*(?:`|$))/, +q,"'\"`"]):m.push(["str",/^(?:'(?:[^\n\r'\\]|\\.)*(?:'|$)|"(?:[^\n\r"\\]|\\.)*(?:"|$))/,q,"\"'"]);a.verbatimStrings&&e.push(["str",/^@"(?:[^"]|"")*(?:"|$)/,q]);var h=a.hashComments;h&&(a.cStyleComments?(h>1?m.push(["com",/^#(?:##(?:[^#]|#(?!##))*(?:###|$)|.*)/,q,"#"]):m.push(["com",/^#(?:(?:define|elif|else|endif|error|ifdef|include|ifndef|line|pragma|undef|warning)\b|[^\n\r]*)/,q,"#"]),e.push(["str",/^<(?:(?:(?:\.\.\/)*|\/?)(?:[\w-]+(?:\/[\w-]+)+)?[\w-]+\.h|[a-z]\w*)>/,q])):m.push(["com",/^#[^\n\r]*/, +q,"#"]));a.cStyleComments&&(e.push(["com",/^\/\/[^\n\r]*/,q]),e.push(["com",/^\/\*[\S\s]*?(?:\*\/|$)/,q]));a.regexLiterals&&e.push(["lang-regex",/^(?:^^\.?|[!+-]|!=|!==|#|%|%=|&|&&|&&=|&=|\(|\*|\*=|\+=|,|-=|->|\/|\/=|:|::|;|<|<<|<<=|<=|=|==|===|>|>=|>>|>>=|>>>|>>>=|[?@[^]|\^=|\^\^|\^\^=|{|\||\|=|\|\||\|\|=|~|break|case|continue|delete|do|else|finally|instanceof|return|throw|try|typeof)\s*(\/(?=[^*/])(?:[^/[\\]|\\[\S\s]|\[(?:[^\\\]]|\\[\S\s])*(?:]|$))+\/)/]);(h=a.types)&&e.push(["typ",h]);a=(""+a.keywords).replace(/^ | $/g, +"");a.length&&e.push(["kwd",RegExp("^(?:"+a.replace(/[\s,]+/g,"|")+")\\b"),q]);m.push(["pln",/^\s+/,q," \r\n\t\xa0"]);e.push(["lit",/^@[$_a-z][\w$@]*/i,q],["typ",/^(?:[@_]?[A-Z]+[a-z][\w$@]*|\w+_t\b)/,q],["pln",/^[$_a-z][\w$@]*/i,q],["lit",/^(?:0x[\da-f]+|(?:\d(?:_\d+)*\d*(?:\.\d*)?|\.\d\+)(?:e[+-]?\d+)?)[a-z]*/i,q,"0123456789"],["pln",/^\\[\S\s]?/,q],["pun",/^.[^\s\w"-$'./@\\`]*/,q]);return x(m,e)}function D(a,m){function e(a){switch(a.nodeType){case 1:if(k.test(a.className))break;if("BR"===a.nodeName)h(a), +a.parentNode&&a.parentNode.removeChild(a);else for(a=a.firstChild;a;a=a.nextSibling)e(a);break;case 3:case 4:if(p){var b=a.nodeValue,d=b.match(t);if(d){var c=b.substring(0,d.index);a.nodeValue=c;(b=b.substring(d.index+d[0].length))&&a.parentNode.insertBefore(s.createTextNode(b),a.nextSibling);h(a);c||a.parentNode.removeChild(a)}}}}function h(a){function b(a,d){var e=d?a.cloneNode(!1):a,f=a.parentNode;if(f){var f=b(f,1),g=a.nextSibling;f.appendChild(e);for(var h=g;h;h=g)g=h.nextSibling,f.appendChild(h)}return e} +for(;!a.nextSibling;)if(a=a.parentNode,!a)return;for(var a=b(a.nextSibling,0),e;(e=a.parentNode)&&e.nodeType===1;)a=e;d.push(a)}var k=/(?:^|\s)nocode(?:\s|$)/,t=/\r\n?|\n/,s=a.ownerDocument,l;a.currentStyle?l=a.currentStyle.whiteSpace:window.getComputedStyle&&(l=s.defaultView.getComputedStyle(a,q).getPropertyValue("white-space"));var p=l&&"pre"===l.substring(0,3);for(l=s.createElement("LI");a.firstChild;)l.appendChild(a.firstChild);for(var d=[l],g=0;g=0;){var h=m[e];A.hasOwnProperty(h)?window.console&&console.warn("cannot override language handler %s",h):A[h]=a}}function C(a,m){if(!a||!A.hasOwnProperty(a))a=/^\s*=o&&(h+=2);e>=c&&(a+=2)}}catch(w){"console"in window&&console.log(w&&w.stack?w.stack:w)}}var v=["break,continue,do,else,for,if,return,while"],w=[[v,"auto,case,char,const,default,double,enum,extern,float,goto,int,long,register,short,signed,sizeof,static,struct,switch,typedef,union,unsigned,void,volatile"], +"catch,class,delete,false,import,new,operator,private,protected,public,this,throw,true,try,typeof"],F=[w,"alignof,align_union,asm,axiom,bool,concept,concept_map,const_cast,constexpr,decltype,dynamic_cast,explicit,export,friend,inline,late_check,mutable,namespace,nullptr,reinterpret_cast,static_assert,static_cast,template,typeid,typename,using,virtual,where"],G=[w,"abstract,boolean,byte,extends,final,finally,implements,import,instanceof,null,native,package,strictfp,super,synchronized,throws,transient"], +H=[G,"as,base,by,checked,decimal,delegate,descending,dynamic,event,fixed,foreach,from,group,implicit,in,interface,internal,into,is,lock,object,out,override,orderby,params,partial,readonly,ref,sbyte,sealed,stackalloc,string,select,uint,ulong,unchecked,unsafe,ushort,var"],w=[w,"debugger,eval,export,function,get,null,set,undefined,var,with,Infinity,NaN"],I=[v,"and,as,assert,class,def,del,elif,except,exec,finally,from,global,import,in,is,lambda,nonlocal,not,or,pass,print,raise,try,with,yield,False,True,None"], +J=[v,"alias,and,begin,case,class,def,defined,elsif,end,ensure,false,in,module,next,nil,not,or,redo,rescue,retry,self,super,then,true,undef,unless,until,when,yield,BEGIN,END"],v=[v,"case,done,elif,esac,eval,fi,function,in,local,set,then,until"],K=/^(DIR|FILE|vector|(de|priority_)?queue|list|stack|(const_)?iterator|(multi)?(set|map)|bitset|u?(int|float)\d*)/,N=/\S/,O=u({keywords:[F,H,w,"caller,delete,die,do,dump,elsif,eval,exit,foreach,for,goto,if,import,last,local,my,next,no,our,print,package,redo,require,sub,undef,unless,until,use,wantarray,while,BEGIN,END"+ +I,J,v],hashComments:!0,cStyleComments:!0,multiLineStrings:!0,regexLiterals:!0}),A={};k(O,["default-code"]);k(x([],[["pln",/^[^]*(?:>|$)/],["com",/^<\!--[\S\s]*?(?:--\>|$)/],["lang-",/^<\?([\S\s]+?)(?:\?>|$)/],["lang-",/^<%([\S\s]+?)(?:%>|$)/],["pun",/^(?:<[%?]|[%?]>)/],["lang-",/^]*>([\S\s]+?)<\/xmp\b[^>]*>/i],["lang-js",/^]*>([\S\s]*?)(<\/script\b[^>]*>)/i],["lang-css",/^]*>([\S\s]*?)(<\/style\b[^>]*>)/i],["lang-in.tag",/^(<\/?[a-z][^<>]*>)/i]]), +["default-markup","htm","html","mxml","xhtml","xml","xsl"]);k(x([["pln",/^\s+/,q," \t\r\n"],["atv",/^(?:"[^"]*"?|'[^']*'?)/,q,"\"'"]],[["tag",/^^<\/?[a-z](?:[\w-.:]*\w)?|\/?>$/i],["atn",/^(?!style[\s=]|on)[a-z](?:[\w:-]*\w)?/i],["lang-uq.val",/^=\s*([^\s"'>]*(?:[^\s"'/>]|\/(?=\s)))/],["pun",/^[/<->]+/],["lang-js",/^on\w+\s*=\s*"([^"]+)"/i],["lang-js",/^on\w+\s*=\s*'([^']+)'/i],["lang-js",/^on\w+\s*=\s*([^\s"'>]+)/i],["lang-css",/^style\s*=\s*"([^"]+)"/i],["lang-css",/^style\s*=\s*'([^']+)'/i],["lang-css", +/^style\s*=\s*([^\s"'>]+)/i]]),["in.tag"]);k(x([],[["atv",/^[\S\s]+/]]),["uq.val"]);k(u({keywords:F,hashComments:!0,cStyleComments:!0,types:K}),["c","cc","cpp","cxx","cyc","m"]);k(u({keywords:"null,true,false"}),["json"]);k(u({keywords:H,hashComments:!0,cStyleComments:!0,verbatimStrings:!0,types:K}),["cs"]);k(u({keywords:G,cStyleComments:!0}),["java"]);k(u({keywords:v,hashComments:!0,multiLineStrings:!0}),["bsh","csh","sh"]);k(u({keywords:I,hashComments:!0,multiLineStrings:!0,tripleQuotedStrings:!0}), +["cv","py"]);k(u({keywords:"caller,delete,die,do,dump,elsif,eval,exit,foreach,for,goto,if,import,last,local,my,next,no,our,print,package,redo,require,sub,undef,unless,until,use,wantarray,while,BEGIN,END",hashComments:!0,multiLineStrings:!0,regexLiterals:!0}),["perl","pl","pm"]);k(u({keywords:J,hashComments:!0,multiLineStrings:!0,regexLiterals:!0}),["rb"]);k(u({keywords:w,cStyleComments:!0,regexLiterals:!0}),["js"]);k(u({keywords:"all,and,by,catch,class,else,extends,false,finally,for,if,in,is,isnt,loop,new,no,not,null,of,off,on,or,return,super,then,true,try,unless,until,when,while,yes", +hashComments:3,cStyleComments:!0,multilineStrings:!0,tripleQuotedStrings:!0,regexLiterals:!0}),["coffee"]);k(x([],[["str",/^[\S\s]+/]]),["regex"]);window.prettyPrintOne=function(a,m,e){var h=document.createElement("PRE");h.innerHTML=a;e&&D(h,e);E({g:m,i:e,h:h});return h.innerHTML};window.prettyPrint=function(a){function m(){for(var e=window.PR_SHOULD_USE_CONTINUATION?l.now()+250:Infinity;p=0){var k=k.match(g),f,b;if(b= +!k){b=n;for(var o=void 0,c=b.firstChild;c;c=c.nextSibling)var i=c.nodeType,o=i===1?o?b:c:i===3?N.test(c.nodeValue)?b:o:o;b=(f=o===b?void 0:o)&&"CODE"===f.tagName}b&&(k=f.className.match(g));k&&(k=k[1]);b=!1;for(o=n.parentNode;o;o=o.parentNode)if((o.tagName==="pre"||o.tagName==="code"||o.tagName==="xmp")&&o.className&&o.className.indexOf("prettyprint")>=0){b=!0;break}b||((b=(b=n.className.match(/\blinenums\b(?::(\d+))?/))?b[1]&&b[1].length?+b[1]:!0:!1)&&D(n,b),d={g:k,h:n,i:b},E(d))}}p +
+ Sections +
    +
  • + Home +
    • + {% for menu in nav %} + {% if menu.title != '**HIDDEN**' %} +
  • + {% if menu.children %} + {% for item in menu.children[:1] %} + {{ menu.title }} + {% endfor %} + {% endif %} +
    • + {% endif %} + {% endfor %} +
+ + + + + + + +
+
+ diff --git a/docs/theme/mkdocs/prev_next.html b/docs/theme/mkdocs/prev_next.html new file mode 100644 index 0000000000..693bfbcaa4 --- /dev/null +++ b/docs/theme/mkdocs/prev_next.html @@ -0,0 +1,22 @@ + + + \ No newline at end of file diff --git a/docs/theme/mkdocs/tipuesearch/img/loader.gif b/docs/theme/mkdocs/tipuesearch/img/loader.gif new file mode 100644 index 0000000000..9c97738a27 Binary files /dev/null and b/docs/theme/mkdocs/tipuesearch/img/loader.gif differ diff --git a/docs/theme/mkdocs/tipuesearch/img/search.png b/docs/theme/mkdocs/tipuesearch/img/search.png new file mode 100755 index 0000000000..9ab0f2c1a9 Binary files /dev/null and b/docs/theme/mkdocs/tipuesearch/img/search.png differ diff --git a/docs/theme/mkdocs/tipuesearch/tipuesearch.css b/docs/theme/mkdocs/tipuesearch/tipuesearch.css new file mode 100755 index 0000000000..d5847d22dc --- /dev/null +++ b/docs/theme/mkdocs/tipuesearch/tipuesearch.css @@ -0,0 +1,136 @@ + +/* +Tipue Search 3.1 +Copyright (c) 2013 Tipue +Tipue Search is released under the MIT License +http://www.tipue.com/search +*/ + +#tipue_search_button +{ + width: 70px; + height: 36px; + border: 0; + border-radius: 1px; + background: #75a8fb url('img/search.png') no-repeat center; + outline: none; +} +#tipue_search_button:hover +{ + background-color: #5193fb; +} + +#tipue_search_content +{ + clear: left; + max-width: 650px; + padding: 25px 0 13px 0; + margin: 0; +} +#tipue_search_loading +{ + padding-top: 60px; + background: #fff url('img/loader.gif') no-repeat left; +} + +#tipue_search_warning_head +{ + font: 300 16px/1.6 'Open Sans', sans-serif; +} +#tipue_search_warning +{ + font: 13px/1.6 'Open Sans', sans-serif; + margin: 7px 0; +} +#tipue_search_warning a +{ + font-weight: 300; + text-decoration: none; +} +#tipue_search_warning a:hover +{ +} +#tipue_search_results_count +{ + font: 13px/1.6 'Open Sans', sans-serif; +} +.tipue_search_content_title +{ + font: 300 23px/1.6 'Open Sans', sans-serif; + text-rendering: optimizelegibility; + margin-top: 23px; +} +.tipue_search_content_title a +{ + text-decoration: none; +} +.tipue_search_content_title a:hover +{ +} +.tipue_search_content_text +{ + font: 13px/1.7 'Open Sans', sans-serif; + padding: 13px 0; + word-break: break-all; + word-break: break-word; + -webkit-hyphens: auto; + -moz-hyphens: auto; + hyphens: auto; +} +.tipue_search_content_loc +{ + font: 300 13px/1.7 'Open Sans', sans-serif; + word-break: break-all; + word-break: break-word; + -webkit-hyphens: auto; + -moz-hyphens: auto; + hyphens: auto; +} +.tipue_search_content_loc a +{ + text-decoration: none; +} +.tipue_search_content_loc a:hover +{ +} +#tipue_search_foot +{ + margin: 51px 0 21px 0; +} +#tipue_search_foot_boxes +{ + padding: 0; + margin: 0; + font: 12px/1 'Open Sans', sans-serif; +} +#tipue_search_foot_boxes li +{ + list-style: none; + margin: 0; + padding: 0; + display: inline; +} +#tipue_search_foot_boxes li a +{ + padding: 9px 15px 10px 15px; + background-color: #f1f1f1; + border: 1px solid #dcdcdc; + border-radius: 1px; + margin-right: 7px; + text-decoration: none; + text-align: center; +} +#tipue_search_foot_boxes li.current +{ + padding: 9px 15px 10px 15px; + background: #fff; + border: 1px solid #dcdcdc; + border-radius: 1px; + margin-right: 7px; + text-align: center; +} +#tipue_search_foot_boxes li a:hover +{ + border: 1px solid #ccc; + background-color: #f3f3f3; +} diff --git a/docs/theme/mkdocs/tipuesearch/tipuesearch.js b/docs/theme/mkdocs/tipuesearch/tipuesearch.js new file mode 100644 index 0000000000..01c09f2b8c --- /dev/null +++ b/docs/theme/mkdocs/tipuesearch/tipuesearch.js @@ -0,0 +1,383 @@ + +/* +Tipue Search 3.1 +Copyright (c) 2013 Tipue +Tipue Search is released under the MIT License +http://www.tipue.com/search +*/ + + +(function($) { + + $.fn.tipuesearch = function(options) { + + var set = $.extend( { + + 'show' : 7, + 'newWindow' : false, + 'showURL' : true, + 'minimumLength' : 3, + 'descriptiveWords' : 25, + 'highlightTerms' : true, + 'highlightEveryTerm' : false, + 'mode' : 'static', + 'liveDescription' : '*', + 'liveContent' : '*', + 'contentLocation' : 'tipuesearch/tipuesearch_content.json' + + }, options); + + return this.each(function() { + + var tipuesearch_in = { + pages: [] + }; + $.ajaxSetup({ + async: false + }); + + if (set.mode == 'live') + { + for (var i = 0; i < tipuesearch_pages.length; i++) + { + $.get(tipuesearch_pages[i], '', + function (html) + { + var cont = $(set.liveContent, html).text(); + cont = cont.replace(/\s+/g, ' '); + var desc = $(set.liveDescription, html).text(); + desc = desc.replace(/\s+/g, ' '); + + var t_1 = html.toLowerCase().indexOf(''); + var t_2 = html.toLowerCase().indexOf('', t_1 + 7); + if (t_1 != -1 && t_2 != -1) + { + var tit = html.slice(t_1 + 7, t_2); + } + else + { + var tit = 'No title'; + } + + tipuesearch_in.pages.push({ + "title": tit, + "text": desc, + "tags": cont, + "loc": tipuesearch_pages[i] + }); + } + ); + } + } + + if (set.mode == 'json') + { + $.getJSON(set.contentLocation, + function(json) + { + tipuesearch_in = $.extend({}, json); + } + ); + } + + if (set.mode == 'static') + { + tipuesearch_in = $.extend({}, tipuesearch); + } + + var tipue_search_w = ''; + if (set.newWindow) + { + tipue_search_w = ' target="_blank"'; + } + + function getURLP(name) + { + return decodeURIComponent((new RegExp('[?|&]' + name + '=' + '([^&;]+?)(&|#|;|$)').exec(location.search)||[,""])[1].replace(/\+/g, '%20')) || null; + } + if (getURLP('q')) + { + $('#tipue_search_input').val(getURLP('q')); + getTipueSearch(0, true); + } + + $('#tipue_search_button').click(function() + { + getTipueSearch(0, true); + }); + $(this).keyup(function(event) + { + if(event.keyCode == '13') + { + getTipueSearch(0, true); + } + }); + + function getTipueSearch(start, replace) + { + $('#tipue_search_content').hide(); + var out = ''; + var results = ''; + var show_replace = false; + var show_stop = false; + + var d = $('#tipue_search_input').val().toLowerCase(); + d = $.trim(d); + var d_w = d.split(' '); + d = ''; + for (var i = 0; i < d_w.length; i++) + { + var a_w = true; + for (var f = 0; f < tipuesearch_stop_words.length; f++) + { + if (d_w[i] == tipuesearch_stop_words[f]) + { + a_w = false; + show_stop = true; + } + } + if (a_w) + { + d = d + ' ' + d_w[i]; + } + } + d = $.trim(d); + d_w = d.split(' '); + + if (d.length >= set.minimumLength) + { + if (replace) + { + var d_r = d; + for (var i = 0; i < d_w.length; i++) + { + for (var f = 0; f < tipuesearch_replace.words.length; f++) + { + if (d_w[i] == tipuesearch_replace.words[f].word) + { + d = d.replace(d_w[i], tipuesearch_replace.words[f].replace_with); + show_replace = true; + } + } + } + d_w = d.split(' '); + } + + var d_t = d; + for (var i = 0; i < d_w.length; i++) + { + for (var f = 0; f < tipuesearch_stem.words.length; f++) + { + if (d_w[i] == tipuesearch_stem.words[f].word) + { + d_t = d_t + ' ' + tipuesearch_stem.words[f].stem; + } + } + } + d_w = d_t.split(' '); + + var c = 0; + found = new Array(); + for (var i = 0; i < tipuesearch_in.pages.length; i++) + { + var score = 1000000000; + var s_t = tipuesearch_in.pages[i].text; + for (var f = 0; f < d_w.length; f++) + { + var pat = new RegExp(d_w[f], 'i'); + if (tipuesearch_in.pages[i].title.search(pat) != -1) + { + score -= (200000 - i); + } + if (tipuesearch_in.pages[i].text.search(pat) != -1) + { + score -= (150000 - i); + } + + if (set.highlightTerms) + { + if (set.highlightEveryTerm) + { + var patr = new RegExp('(' + d_w[f] + ')', 'gi'); + } + else + { + var patr = new RegExp('(' + d_w[f] + ')', 'i'); + } + s_t = s_t.replace(patr, "$1"); + } + if (tipuesearch_in.pages[i].tags.search(pat) != -1) + { + score -= (100000 - i); + } + + } + if (score < 1000000000) + { + found[c++] = score + '^' + tipuesearch_in.pages[i].title + '^' + s_t + '^' + tipuesearch_in.pages[i].loc; + } + } + + if (c != 0) + { + if (show_replace == 1) + { + out += '
Showing results for ' + d + '
'; + out += '
Search for ' + d_r + '
'; + } + if (c == 1) + { + out += '
1 result
'; + } + else + { + c_c = c.toString().replace(/\B(?=(\d{3})+(?!\d))/g, ","); + out += '
' + c_c + ' results
'; + } + + found.sort(); + var l_o = 0; + for (var i = 0; i < found.length; i++) + { + var fo = found[i].split('^'); + if (l_o >= start && l_o < set.show + start) + { + out += '
' + fo[1] + '
'; + + var t = fo[2]; + var t_d = ''; + var t_w = t.split(' '); + if (t_w.length < set.descriptiveWords) + { + t_d = t; + } + else + { + for (var f = 0; f < set.descriptiveWords; f++) + { + t_d += t_w[f] + ' '; + } + } + t_d = $.trim(t_d); + if (t_d.charAt(t_d.length - 1) != '.') + { + t_d += ' ...'; + } + out += '
' + t_d + '
'; + + if (set.showURL) + { + out += '
' + fo[3] + '
'; + } + } + l_o++; + } + + if (c > set.show) + { + var pages = Math.ceil(c / set.show); + var page = (start / set.show); + out += '
    '; + + if (start > 0) + { + out += '
  • « Prev
    • '; + } + + if (page <= 2) + { + var p_b = pages; + if (pages > 3) + { + p_b = 3; + } + for (var f = 0; f < p_b; f++) + { + if (f == page) + { + out += '
  • ' + (f + 1) + '
    • '; + } + else + { + out += '
  • ' + (f + 1) + '
    • '; + } + } + } + else + { + var p_b = pages + 2; + if (p_b > pages) + { + p_b = pages; + } + for (var f = page; f < p_b; f++) + { + if (f == page) + { + out += '
  • ' + (f + 1) + '
    • '; + } + else + { + out += '
  • ' + (f + 1) + '
    • '; + } + } + } + + if (page + 1 != pages) + { + out += '
  • Next »
    • '; + } + + out += '
'; + } + } + else + { + out += '
Nothing found
'; + } + } + else + { + if (show_stop) + { + out += '
Nothing found
Common words are largely ignored
'; + } + else + { + out += '
Search too short
'; + if (set.minimumLength == 1) + { + out += '
Should be one character or more
'; + } + else + { + out += '
Should be ' + set.minimumLength + ' characters or more
'; + } + } + } + + $('#tipue_search_content').html(out); + $('#tipue_search_content').slideDown(200); + + $('#tipue_search_replaced').click(function() + { + getTipueSearch(0, false); + }); + + $('.tipue_search_foot_box').click(function() + { + var id_v = $(this).attr('id'); + var id_a = id_v.split('_'); + + getTipueSearch(parseInt(id_a[0]), id_a[1]); + }); + } + + }); + }; + +})(jQuery); + + + + diff --git a/docs/theme/mkdocs/tipuesearch/tipuesearch.min.js b/docs/theme/mkdocs/tipuesearch/tipuesearch.min.js new file mode 100644 index 0000000000..bfc66f1f64 --- /dev/null +++ b/docs/theme/mkdocs/tipuesearch/tipuesearch.min.js @@ -0,0 +1,12 @@ +(function($){$.fn.tipuesearch=function(options){var set=$.extend({"show":7,"newWindow":false,"showURL":true,"minimumLength":3,"descriptiveWords":25,"highlightTerms":true,"highlightEveryTerm":false,"mode":"static","liveDescription":"*","liveContent":"*","contentLocation":"tipuesearch/tipuesearch_content.json"},options);return this.each(function(){var tipuesearch_in={pages:[]};$.ajaxSetup({async:false});if(set.mode=="live")for(var i=0;i");var t_2=html.toLowerCase().indexOf("",t_1+7);if(t_1!=-1&&t_2!=-1)var tit=html.slice(t_1+7,t_2);else var tit="No title";tipuesearch_in.pages.push({"title":tit,"text":desc,"tags":cont,"loc":tipuesearch_pages[i]})});if(set.mode=="json")$.getJSON(set.contentLocation,function(json){tipuesearch_in=$.extend({},json)}); +if(set.mode=="static")tipuesearch_in=$.extend({},tipuesearch);var tipue_search_w="";if(set.newWindow)tipue_search_w=' target="_blank"';function getURLP(name){return decodeURIComponent(((new RegExp("[?|&]"+name+"="+"([^&;]+?)(&|#|;|$)")).exec(location.search)||[,""])[1].replace(/\+/g,"%20"))||null}if(getURLP("q")){$("#tipue_search_input").val(getURLP("q"));getTipueSearch(0,true)}$("#tipue_search_button").click(function(){getTipueSearch(0,true)});$(this).keyup(function(event){if(event.keyCode=="13")getTipueSearch(0, +true)});function getTipueSearch(start,replace){$("#tipue_search_content").hide();var out="";var results="";var show_replace=false;var show_stop=false;var d=$("#tipue_search_input").val().toLowerCase();d=$.trim(d);var d_w=d.split(" ");d="";for(var i=0;i=set.minimumLength){if(replace){var d_r=d;for(var i= +0;i$1")}if(tipuesearch_in.pages[i].tags.search(pat)!=-1)score-=1E5-i}if(score<1E9)found[c++]=score+"^"+tipuesearch_in.pages[i].title+"^"+s_t+"^"+tipuesearch_in.pages[i].loc}if(c!= +0){if(show_replace==1){out+='
Showing results for '+d+"
";out+='
Search for '+d_r+"
"}if(c==1)out+='
1 result
';else{c_c=c.toString().replace(/\B(?=(\d{3})+(?!\d))/g,",");out+='
'+c_c+" results
"}found.sort();var l_o=0;for(var i=0;i= +start&&l_o"+fo[1]+"
";var t=fo[2];var t_d="";var t_w=t.split(" ");if(t_w.length";if(set.showURL)out+='
"+fo[3]+ +"
"}l_o++}if(c>set.show){var pages=Math.ceil(c/set.show);var page=start/set.show;out+='
    ';if(start>0)out+='
  • « Prev
    • ';if(page<=2){var p_b=pages;if(pages>3)p_b=3;for(var f=0;f'+(f+1)+"";else out+='
  • '+(f+1)+"
    • "}else{var p_b=pages+2;if(p_b>pages)p_b=pages;for(var f=page;f'+(f+1)+"";else out+='
  • '+(f+1)+"
    • "}if(page+1!=pages)out+='
  • Next »
    • ';out+="
"}}else out+='
Nothing found
'}else if(show_stop)out+= +'
Nothing found
Common words are largely ignored
';else{out+='
Search too short
';if(set.minimumLength==1)out+='
Should be one character or more
';else out+='
Should be '+set.minimumLength+" characters or more
"}$("#tipue_search_content").html(out);$("#tipue_search_content").slideDown(200);$("#tipue_search_replaced").click(function(){getTipueSearch(0, +false)});$(".tipue_search_foot_box").click(function(){var id_v=$(this).attr("id");var id_a=id_v.split("_");getTipueSearch(parseInt(id_a[0]),id_a[1])})}})}})(jQuery); diff --git a/docs/theme/mkdocs/tipuesearch/tipuesearch_content.js b/docs/theme/mkdocs/tipuesearch/tipuesearch_content.js new file mode 100644 index 0000000000..f20d45a42b --- /dev/null +++ b/docs/theme/mkdocs/tipuesearch/tipuesearch_content.js @@ -0,0 +1,13 @@ +var tipuesearch = {"pages": [ + {"title": "Tipue Search, a site search engine jQuery plugin", "text": "Tipue Search is a site search engine jQuery plugin. Tipue Search is open source and released under the MIT License, which means it's free for both commercial and non-commercial use. Tipue Search is responsive and works on all reasonably modern browsers.", "tags": "JavaScript", "loc": "http://www.tipue.com/search"}, + {"title": "Tipue Search Static mode demo", "text": "This is a demo of Tipue Search Static mode.", "tags": "", "loc": "http://www.tipue.com/search/demos/static"}, + {"title": "Tipue Image Search demo", "text": "This is a demo of Tipue Image Search.", "tags": "", "loc": "http://www.tipue.com/search/demos/images"}, + {"title": "Tipue Search docs", "text": "If you haven't already done so, download Tipue Search. Copy the tipuesearch folder to your site.", "tags": "documentation", "loc": "http://www.tipue.com/search/docs"}, + {"title": "Tipue drop, a search suggestion box jQuery plugin", "text": "Tipue drop is a search suggestion box jQuery plugin. Tipue drop is open source and released under the MIT License, which means it's free for both commercial and non-commercial use. Tipue drop is responsive and works on all reasonably modern browsers.", "tags": "JavaScript", "loc": "http://www.tipue.com/drop"}, + {"title": "Tipue drop demo", "text": "Tipue drop demo. Tipue drop is a search suggestion box jQuery plugin.", "tags": "JavaScript", "loc": "http://www.tipue.com/drop/demo"}, + {"title": "Support plans", "text": "Stuck? We offer a range of flexible support plans for our jQuery plugins.", "tags": "", "loc": "http://www.tipue.com/support"}, + {"title": "About Tipue", "text": "Tipue is a small web development studio based in North London. We've been around for over a decade. We like Perl, MySQL and jQuery.", "tags": "", "loc": "http://www.tipue.com/about"} +]}; + + + diff --git a/docs/theme/mkdocs/tipuesearch/tipuesearch_set.js b/docs/theme/mkdocs/tipuesearch/tipuesearch_set.js new file mode 100644 index 0000000000..6bda3fad66 --- /dev/null +++ b/docs/theme/mkdocs/tipuesearch/tipuesearch_set.js @@ -0,0 +1,23 @@ + +/* +Tipue Search 3.1 +Copyright (c) 2013 Tipue +Tipue Search is released under the MIT License +http://www.tipue.com/search +*/ + + +var tipuesearch_stop_words = ["and", "be", "by", "do", "for", "he", "how", "if", "is", "it", "my", "not", "of", "or", "the", "to", "up", "what", "when"]; + +var tipuesearch_replace = {"words": [ + {"word": "tipua", replace_with: "tipue"}, + {"word": "javscript", replace_with: "javascript"} +]}; + +var tipuesearch_stem = {"words": [ + {"word": "e-mail", stem: "email"}, + {"word": "javascript", stem: "script"}, + {"word": "javascript", stem: "js"} +]}; + + diff --git a/docs/theme/mkdocs/toc.html b/docs/theme/mkdocs/toc.html new file mode 100644 index 0000000000..e53310d829 --- /dev/null +++ b/docs/theme/mkdocs/toc.html @@ -0,0 +1,13 @@ + diff --git a/engine/engine.go b/engine/engine.go index 685924077c..6a54b3591e 100644 --- a/engine/engine.go +++ b/engine/engine.go @@ -44,6 +44,7 @@ type Engine struct { Stdout io.Writer Stderr io.Writer Stdin io.Reader + Logging bool } func (eng *Engine) Root() string { @@ -96,6 +97,7 @@ func New(root string) (*Engine, error) { Stdout: os.Stdout, Stderr: os.Stderr, Stdin: os.Stdin, + Logging: true, } eng.Register("commands", func(job *Job) Status { for _, name := range eng.commands() { @@ -137,7 +139,9 @@ func (eng *Engine) Job(name string, args ...string) *Job { Stderr: NewOutput(), env: &Env{}, } - job.Stderr.Add(utils.NopWriteCloser(eng.Stderr)) + if eng.Logging { + job.Stderr.Add(utils.NopWriteCloser(eng.Stderr)) + } handler, exists := eng.handlers[name] if exists { job.handler = handler @@ -188,9 +192,9 @@ func (eng *Engine) ParseJob(input string) (*Job, error) { } func (eng *Engine) Logf(format string, args ...interface{}) (n int, err error) { - if os.Getenv("TEST") == "" { - prefixedFormat := fmt.Sprintf("[%s] %s\n", eng, strings.TrimRight(format, "\n")) - return fmt.Fprintf(eng.Stderr, prefixedFormat, args...) + if !eng.Logging { + return 0, nil } - return 0, nil + prefixedFormat := fmt.Sprintf("[%s] %s\n", eng, strings.TrimRight(format, "\n")) + return fmt.Fprintf(eng.Stderr, prefixedFormat, args...) } diff --git a/engine/job.go b/engine/job.go index e83e18e4d7..50d64011f9 100644 --- a/engine/job.go +++ b/engine/job.go @@ -3,7 +3,6 @@ package engine import ( "fmt" "io" - "os" "strings" "time" ) @@ -189,11 +188,8 @@ func (job *Job) Environ() map[string]string { } func (job *Job) Logf(format string, args ...interface{}) (n int, err error) { - if os.Getenv("TEST") == "" { - prefixedFormat := fmt.Sprintf("[%s] %s\n", job, strings.TrimRight(format, "\n")) - return fmt.Fprintf(job.Stderr, prefixedFormat, args...) - } - return 0, nil + prefixedFormat := fmt.Sprintf("[%s] %s\n", job, strings.TrimRight(format, "\n")) + return fmt.Fprintf(job.Stderr, prefixedFormat, args...) } func (job *Job) Printf(format string, args ...interface{}) (n int, err error) { diff --git a/graph/graph.go b/graph/graph.go index eeac8ecd27..5c3a94bab7 100644 --- a/graph/graph.go +++ b/graph/graph.go @@ -3,10 +3,10 @@ package graph import ( "fmt" "github.com/dotcloud/docker/archive" + "github.com/dotcloud/docker/daemon/graphdriver" "github.com/dotcloud/docker/dockerversion" "github.com/dotcloud/docker/image" "github.com/dotcloud/docker/runconfig" - "github.com/dotcloud/docker/runtime/graphdriver" "github.com/dotcloud/docker/utils" "io" "io/ioutil" diff --git a/graph/tags_unit_test.go b/graph/tags_unit_test.go index 17773912cf..bc438131ca 100644 --- a/graph/tags_unit_test.go +++ b/graph/tags_unit_test.go @@ -2,9 +2,9 @@ package graph import ( "bytes" + "github.com/dotcloud/docker/daemon/graphdriver" + _ "github.com/dotcloud/docker/daemon/graphdriver/vfs" // import the vfs driver so it is used in the tests "github.com/dotcloud/docker/image" - "github.com/dotcloud/docker/runtime/graphdriver" - _ "github.com/dotcloud/docker/runtime/graphdriver/vfs" // import the vfs driver so it is used in the tests "github.com/dotcloud/docker/utils" "github.com/dotcloud/docker/vendor/src/code.google.com/p/go/src/pkg/archive/tar" "io" diff --git a/hack/PACKAGERS.md b/hack/PACKAGERS.md index 7170c5ad25..9edb4a3e14 100644 --- a/hack/PACKAGERS.md +++ b/hack/PACKAGERS.md @@ -265,6 +265,7 @@ To function properly, the Docker daemon needs the following software to be installed and available at runtime: * iptables version 1.4 or later +* procps (or similar provider of a "ps" executable) * XZ Utils version 4.9 or later * a [properly mounted](https://github.com/tianon/cgroupfs-mount/blob/master/cgroupfs-mount) diff --git a/hack/make/test-integration-cli b/hack/make/test-integration-cli index 93330d7b09..703c9cd95c 100644 --- a/hack/make/test-integration-cli +++ b/hack/make/test-integration-cli @@ -31,7 +31,11 @@ bundle_test_integration_cli() { sleep 2 if ! docker inspect busybox &> /dev/null; then - ( set -x; docker pull busybox ) + if [ -d /docker-busybox ]; then + ( set -x; docker build -t busybox /docker-busybox ) + else + ( set -x; docker pull busybox ) + fi fi bundle_test_integration_cli diff --git a/image/graph.go b/image/graph.go index dd0136b00e..64a38d7a29 100644 --- a/image/graph.go +++ b/image/graph.go @@ -1,7 +1,7 @@ package image import ( - "github.com/dotcloud/docker/runtime/graphdriver" + "github.com/dotcloud/docker/daemon/graphdriver" ) type Graph interface { diff --git a/image/image.go b/image/image.go index 33503bad5a..239e5cc055 100644 --- a/image/image.go +++ b/image/image.go @@ -4,8 +4,8 @@ import ( "encoding/json" "fmt" "github.com/dotcloud/docker/archive" + "github.com/dotcloud/docker/daemon/graphdriver" "github.com/dotcloud/docker/runconfig" - "github.com/dotcloud/docker/runtime/graphdriver" "github.com/dotcloud/docker/utils" "io/ioutil" "os" diff --git a/integration-cli/docker_cli_attach_test.go b/integration-cli/docker_cli_attach_test.go new file mode 100644 index 0000000000..1480b807aa --- /dev/null +++ b/integration-cli/docker_cli_attach_test.go @@ -0,0 +1,51 @@ +package main + +import ( + "os/exec" + "strings" + "sync" + "testing" + "time" +) + +func TestMultipleAttachRestart(t *testing.T) { + cmd := exec.Command(dockerBinary, "run", "--name", "attacher", "-d", "busybox", + "/bin/sh", "-c", "sleep 1 && echo hello") + + group := sync.WaitGroup{} + group.Add(4) + + go func() { + defer group.Done() + out, _, err := runCommandWithOutput(cmd) + if err != nil { + t.Fatal(err, out) + } + }() + time.Sleep(500 * time.Millisecond) + + for i := 0; i < 3; i++ { + go func() { + defer group.Done() + c := exec.Command(dockerBinary, "attach", "attacher") + + out, _, err := runCommandWithOutput(c) + if err != nil { + t.Fatal(err, out) + } + if actual := strings.Trim(out, "\r\n"); actual != "hello" { + t.Fatalf("unexpected output %s expected hello", actual) + } + }() + } + + group.Wait() + + cmd = exec.Command(dockerBinary, "kill", "attacher") + if _, err := runCommand(cmd); err != nil { + t.Fatal(err) + } + deleteAllContainers() + + logDone("run - multiple attach") +} diff --git a/integration-cli/docker_cli_commit_test.go b/integration-cli/docker_cli_commit_test.go index 51adaac9df..e99379231e 100644 --- a/integration-cli/docker_cli_commit_test.go +++ b/integration-cli/docker_cli_commit_test.go @@ -3,6 +3,7 @@ package main import ( "fmt" "os/exec" + "strings" "testing" ) @@ -32,3 +33,32 @@ func TestCommitAfterContainerIsDone(t *testing.T) { logDone("commit - echo foo and commit the image") } + +func TestCommitNewFile(t *testing.T) { + cmd := exec.Command(dockerBinary, "run", "--name", "commiter", "busybox", "/bin/sh", "-c", "echo koye > /foo") + if _, err := runCommand(cmd); err != nil { + t.Fatal(err) + } + + cmd = exec.Command(dockerBinary, "commit", "commiter") + imageId, _, err := runCommandWithOutput(cmd) + if err != nil { + t.Fatal(err) + } + imageId = strings.Trim(imageId, "\r\n") + + cmd = exec.Command(dockerBinary, "run", imageId, "cat", "/foo") + + out, _, err := runCommandWithOutput(cmd) + if err != nil { + t.Fatal(err, out) + } + if actual := strings.Trim(out, "\r\n"); actual != "koye" { + t.Fatalf("expected output koye received %s", actual) + } + + deleteAllContainers() + deleteImages(imageId) + + logDone("commit - commit file and read") +} diff --git a/integration-cli/docker_cli_nat_test.go b/integration-cli/docker_cli_nat_test.go new file mode 100644 index 0000000000..90af933be9 --- /dev/null +++ b/integration-cli/docker_cli_nat_test.go @@ -0,0 +1,84 @@ +package main + +import ( + "encoding/json" + "fmt" + "github.com/dotcloud/docker/daemon" + "net" + "os/exec" + "path/filepath" + "testing" +) + +func TestNetworkNat(t *testing.T) { + ncPath, err := exec.LookPath("nc") + if err != nil { + t.Skip("Test not running with `make test`. Netcat not found: %s", err) + } + ncPath, err = filepath.EvalSymlinks(ncPath) + if err != nil { + t.Fatalf("Error resolving netcat symlink: %s", err) + } + iface, err := net.InterfaceByName("eth0") + if err != nil { + t.Skip("Test not running with `make test`. Interface eth0 not found: %s", err) + } + + ifaceAddrs, err := iface.Addrs() + if err != nil || len(ifaceAddrs) == 0 { + t.Fatalf("Error retrieving addresses for eth0: %v (%d addresses)", err, len(ifaceAddrs)) + } + + ifaceIp, _, err := net.ParseCIDR(ifaceAddrs[0].String()) + if err != nil { + t.Fatalf("Error retrieving the up for eth0: %s", err) + } + + runCmd := exec.Command(dockerBinary, "run", "-d", + "-v", ncPath+":/bin/nc", + "-v", "/lib/x86_64-linux-gnu/libc.so.6:/lib/libc.so.6", "-v", "/lib/x86_64-linux-gnu/libresolv.so.2:/lib/libresolv.so.2", "-v", "/lib/x86_64-linux-gnu/libbsd.so.0:/lib/libbsd.so.0", "-v", "/lib/x86_64-linux-gnu/ld-linux-x86-64.so.2:/lib/ld-linux-x86-64.so.2", + "-p", "8080", "busybox", "/bin/nc", "-lp", "8080") + out, _, err := runCommandWithOutput(runCmd) + errorOut(err, t, fmt.Sprintf("run1 failed with errors: %v (%s)", err, out)) + + cleanedContainerID := stripTrailingCharacters(out) + + inspectCmd := exec.Command(dockerBinary, "inspect", cleanedContainerID) + inspectOut, _, err := runCommandWithOutput(inspectCmd) + errorOut(err, t, fmt.Sprintf("out should've been a container id: %v %v", inspectOut, err)) + + containers := []*daemon.Container{} + if err := json.Unmarshal([]byte(inspectOut), &containers); err != nil { + t.Fatalf("Error inspecting the container: %s", err) + } + if len(containers) != 1 { + t.Fatalf("Unepexted container count. Expected 0, recieved: %d", len(containers)) + } + + port8080, exists := containers[0].NetworkSettings.Ports["8080/tcp"] + if !exists || len(port8080) == 0 { + t.Fatal("Port 8080/tcp not found in NetworkSettings") + } + + runCmd = exec.Command(dockerBinary, "run", + "-v", ncPath+":/bin/nc", + "-v", "/lib/x86_64-linux-gnu/libc.so.6:/lib/libc.so.6", "-v", "/lib/x86_64-linux-gnu/libresolv.so.2:/lib/libresolv.so.2", "-v", "/lib/x86_64-linux-gnu/libbsd.so.0:/lib/libbsd.so.0", "-v", "/lib/x86_64-linux-gnu/ld-linux-x86-64.so.2:/lib/ld-linux-x86-64.so.2", + "-p", "8080", "busybox", "sh", "-c", fmt.Sprintf("echo hello world | /bin/nc -w 30 %s %s", ifaceIp, port8080[0].HostPort)) + out, _, err = runCommandWithOutput(runCmd) + errorOut(err, t, fmt.Sprintf("run2 failed with errors: %v (%s)", err, out)) + + runCmd = exec.Command(dockerBinary, "logs", cleanedContainerID) + out, _, err = runCommandWithOutput(runCmd) + errorOut(err, t, fmt.Sprintf("failed to retrieve logs for container: %v %v", cleanedContainerID, err)) + + if expected := "hello world\n"; out != expected { + t.Fatalf("Unexpected output. Expected: %s, recieved: -->%s<--", expected, out) + } + + killCmd := exec.Command(dockerBinary, "kill", cleanedContainerID) + out, _, err = runCommandWithOutput(killCmd) + errorOut(err, t, fmt.Sprintf("failed to kill container: %v %v", out, err)) + deleteAllContainers() + + logDone("network - make sure nat works through the host") +} diff --git a/integration-cli/docker_cli_rm_test.go b/integration-cli/docker_cli_rm_test.go new file mode 100644 index 0000000000..e25c9991de --- /dev/null +++ b/integration-cli/docker_cli_rm_test.go @@ -0,0 +1,66 @@ +package main + +import ( + "os" + "os/exec" + "testing" +) + +func TestRemoveContainerWithRemovedVolume(t *testing.T) { + cmd := exec.Command(dockerBinary, "run", "--name", "losemyvolumes", "-v", "/tmp/testing:/test", "busybox", "true") + if _, err := runCommand(cmd); err != nil { + t.Fatal(err) + } + + if err := os.Remove("/tmp/testing"); err != nil { + t.Fatal(err) + } + + cmd = exec.Command(dockerBinary, "rm", "-v", "losemyvolumes") + if _, err := runCommand(cmd); err != nil { + t.Fatal(err) + } + + deleteAllContainers() + + logDone("rm - removed volume") +} + +func TestRemoveContainerWithVolume(t *testing.T) { + cmd := exec.Command(dockerBinary, "run", "--name", "foo", "-v", "/srv", "busybox", "true") + if _, err := runCommand(cmd); err != nil { + t.Fatal(err) + } + + cmd = exec.Command(dockerBinary, "rm", "-v", "foo") + if _, err := runCommand(cmd); err != nil { + t.Fatal(err) + } + + deleteAllContainers() + + logDone("rm - volume") +} + +func TestRemoveContainerRunning(t *testing.T) { + cmd := exec.Command(dockerBinary, "run", "-d", "--name", "foo", "busybox", "sleep", "300") + if _, err := runCommand(cmd); err != nil { + t.Fatal(err) + } + + // Test cannot remove running container + cmd = exec.Command(dockerBinary, "rm", "foo") + if _, err := runCommand(cmd); err == nil { + t.Fatalf("Expected error, can't rm a running container") + } + + // Remove with -f + cmd = exec.Command(dockerBinary, "rm", "-f", "foo") + if _, err := runCommand(cmd); err != nil { + t.Fatal(err) + } + + deleteAllContainers() + + logDone("rm - running container") +} diff --git a/integration-cli/docker_cli_run_test.go b/integration-cli/docker_cli_run_test.go index b0805dd35c..d356f5f4de 100644 --- a/integration-cli/docker_cli_run_test.go +++ b/integration-cli/docker_cli_run_test.go @@ -2,8 +2,12 @@ package main import ( "fmt" + "os" "os/exec" + "regexp" + "sort" "strings" + "sync" "testing" ) @@ -384,3 +388,280 @@ func TestMultipleVolumesFrom(t *testing.T) { logDone("run - multiple volumes from") } + +// this tests verifies the ID format for the container +func TestVerifyContainerID(t *testing.T) { + cmd := exec.Command(dockerBinary, "run", "-d", "busybox", "true") + out, exit, err := runCommandWithOutput(cmd) + if err != nil { + t.Fatal(err) + } + if exit != 0 { + t.Fatalf("expected exit code 0 received %d", exit) + } + match, err := regexp.MatchString("^[0-9a-f]{64}$", strings.TrimSuffix(out, "\n")) + if err != nil { + t.Fatal(err) + } + if !match { + t.Fatalf("Invalid container ID: %s", out) + } + + deleteAllContainers() + + logDone("run - verify container ID") +} + +// Test that creating a container with a volume doesn't crash. Regression test for #995. +func TestCreateVolume(t *testing.T) { + cmd := exec.Command(dockerBinary, "run", "-v", "/var/lib/data", "busybox", "true") + if _, err := runCommand(cmd); err != nil { + t.Fatal(err) + } + + deleteAllContainers() + + logDone("run - create docker mangaed volume") +} + +func TestExitCode(t *testing.T) { + cmd := exec.Command(dockerBinary, "run", "busybox", "/bin/sh", "-c", "exit 72") + + exit, err := runCommand(cmd) + if err == nil { + t.Fatal("should not have a non nil error") + } + if exit != 72 { + t.Fatalf("expected exit code 72 received %d", exit) + } + + deleteAllContainers() + + logDone("run - correct exit code") +} + +func TestUserDefaultsToRoot(t *testing.T) { + cmd := exec.Command(dockerBinary, "run", "busybox", "id") + + out, _, err := runCommandWithOutput(cmd) + if err != nil { + t.Fatal(err, out) + } + if !strings.Contains(out, "uid=0(root) gid=0(root)") { + t.Fatalf("expected root user got %s", out) + } + deleteAllContainers() + + logDone("run - default user") +} + +func TestUserByName(t *testing.T) { + cmd := exec.Command(dockerBinary, "run", "-u", "root", "busybox", "id") + + out, _, err := runCommandWithOutput(cmd) + if err != nil { + t.Fatal(err, out) + } + if !strings.Contains(out, "uid=0(root) gid=0(root)") { + t.Fatalf("expected root user got %s", out) + } + deleteAllContainers() + + logDone("run - user by name") +} + +func TestUserByID(t *testing.T) { + cmd := exec.Command(dockerBinary, "run", "-u", "1", "busybox", "id") + + out, _, err := runCommandWithOutput(cmd) + if err != nil { + t.Fatal(err, out) + } + if !strings.Contains(out, "uid=1(daemon) gid=1(daemon)") { + t.Fatalf("expected daemon user got %s", out) + } + deleteAllContainers() + + logDone("run - user by id") +} + +func TestUserNotFound(t *testing.T) { + cmd := exec.Command(dockerBinary, "run", "-u", "notme", "busybox", "id") + + _, err := runCommand(cmd) + if err == nil { + t.Fatal("unknown user should cause container to fail") + } + deleteAllContainers() + + logDone("run - user not found") +} + +func TestRunTwoConcurrentContainers(t *testing.T) { + group := sync.WaitGroup{} + group.Add(2) + + for i := 0; i < 2; i++ { + go func() { + defer group.Done() + cmd := exec.Command(dockerBinary, "run", "busybox", "sleep", "2") + if _, err := runCommand(cmd); err != nil { + t.Fatal(err) + } + }() + } + + group.Wait() + + deleteAllContainers() + + logDone("run - two concurrent containers") +} + +func TestEnvironment(t *testing.T) { + cmd := exec.Command(dockerBinary, "run", "-h", "testing", "-e=FALSE=true", "-e=TRUE", "-e=TRICKY", "busybox", "env") + cmd.Env = append(os.Environ(), + "TRUE=false", + "TRICKY=tri\ncky\n", + ) + + out, _, err := runCommandWithOutput(cmd) + if err != nil { + t.Fatal(err, out) + } + + actualEnv := strings.Split(out, "\n") + if actualEnv[len(actualEnv)-1] == "" { + actualEnv = actualEnv[:len(actualEnv)-1] + } + sort.Strings(actualEnv) + + goodEnv := []string{ + "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin", + "HOME=/", + "HOSTNAME=testing", + "FALSE=true", + "TRUE=false", + "TRICKY=tri", + "cky", + "", + } + sort.Strings(goodEnv) + if len(goodEnv) != len(actualEnv) { + t.Fatalf("Wrong environment: should be %d variables, not: '%s'\n", len(goodEnv), strings.Join(actualEnv, ", ")) + } + for i := range goodEnv { + if actualEnv[i] != goodEnv[i] { + t.Fatalf("Wrong environment variable: should be %s, not %s", goodEnv[i], actualEnv[i]) + } + } + + deleteAllContainers() + + logDone("run - verify environment") +} + +func TestContainerNetwork(t *testing.T) { + cmd := exec.Command(dockerBinary, "run", "busybox", "ping", "-c", "1", "127.0.0.1") + if _, err := runCommand(cmd); err != nil { + t.Fatal(err) + } + + deleteAllContainers() + + logDone("run - test container network via ping") +} + +// Issue #4681 +func TestLoopbackWhenNetworkDisabled(t *testing.T) { + cmd := exec.Command(dockerBinary, "run", "--networking=false", "busybox", "ping", "-c", "1", "127.0.0.1") + if _, err := runCommand(cmd); err != nil { + t.Fatal(err) + } + + deleteAllContainers() + + logDone("run - test container loopback when networking disabled") +} + +func TestLoopbackOnlyExistsWhenNetworkingDisabled(t *testing.T) { + cmd := exec.Command(dockerBinary, "run", "--networking=false", "busybox", "ip", "a", "show", "up") + out, _, err := runCommandWithOutput(cmd) + if err != nil { + t.Fatal(err, out) + } + + interfaces := regexp.MustCompile(`(?m)^[0-9]+: [a-zA-Z0-9]+`).FindAllString(out, -1) + if len(interfaces) != 1 { + t.Fatalf("Wrong interface count in test container: expected [*: lo], got %s", interfaces) + } + if !strings.HasSuffix(interfaces[0], ": lo") { + t.Fatalf("Wrong interface in test container: expected [*: lo], got %s", interfaces) + } + + deleteAllContainers() + + logDone("run - test loopback only exists when networking disabled") +} + +func TestPrivilegedCanMknod(t *testing.T) { + cmd := exec.Command(dockerBinary, "run", "--privileged", "busybox", "sh", "-c", "mknod /tmp/sda b 8 0 && echo ok") + out, _, err := runCommandWithOutput(cmd) + if err != nil { + t.Fatal(err) + } + + if actual := strings.Trim(out, "\r\n"); actual != "ok" { + t.Fatalf("expected output ok received %s", actual) + } + deleteAllContainers() + + logDone("run - test privileged can mknod") +} + +func TestUnPrivilegedCanMknod(t *testing.T) { + cmd := exec.Command(dockerBinary, "run", "busybox", "sh", "-c", "mknod /tmp/sda b 8 0 && echo ok") + out, _, err := runCommandWithOutput(cmd) + if err != nil { + t.Fatal(err) + } + + if actual := strings.Trim(out, "\r\n"); actual != "ok" { + t.Fatalf("expected output ok received %s", actual) + } + deleteAllContainers() + + logDone("run - test un-privileged can mknod") +} + +func TestPrivilegedCanMount(t *testing.T) { + cmd := exec.Command(dockerBinary, "run", "--privileged", "busybox", "sh", "-c", "mount -t tmpfs none /tmp && echo ok") + + out, _, err := runCommandWithOutput(cmd) + if err != nil { + t.Fatal(err) + } + + if actual := strings.Trim(out, "\r\n"); actual != "ok" { + t.Fatalf("expected output ok received %s", actual) + } + deleteAllContainers() + + logDone("run - test privileged can mount") +} + +func TestUnPrivilegedCannotMount(t *testing.T) { + cmd := exec.Command(dockerBinary, "run", "busybox", "sh", "-c", "mount -t tmpfs none /tmp && echo ok") + + out, _, err := runCommandWithOutput(cmd) + if err == nil { + t.Fatal(err, out) + } + + if actual := strings.Trim(out, "\r\n"); actual == "ok" { + t.Fatalf("expected output not ok received %s", actual) + } + deleteAllContainers() + + logDone("run - test un-privileged cannot mount") +} diff --git a/integration-cli/docker_cli_top_test.go b/integration-cli/docker_cli_top_test.go index d75ec54217..6535473430 100644 --- a/integration-cli/docker_cli_top_test.go +++ b/integration-cli/docker_cli_top_test.go @@ -18,14 +18,22 @@ func TestTopNonPrivileged(t *testing.T) { out, _, err = runCommandWithOutput(topCmd) errorOut(err, t, fmt.Sprintf("failed to run top: %v %v", out, err)) + topCmd = exec.Command(dockerBinary, "top", cleanedContainerID) + out2, _, err2 := runCommandWithOutput(topCmd) + errorOut(err, t, fmt.Sprintf("failed to run top: %v %v", out2, err2)) + killCmd := exec.Command(dockerBinary, "kill", cleanedContainerID) _, err = runCommand(killCmd) errorOut(err, t, fmt.Sprintf("failed to kill container: %v", err)) deleteContainer(cleanedContainerID) - if !strings.Contains(out, "sleep 20") { - t.Fatal("top should've listed sleep 20 in the process list") + if !strings.Contains(out, "sleep 20") && !strings.Contains(out2, "sleep 20") { + t.Fatal("top should've listed `sleep 20` in the process list, but failed twice") + } else if !strings.Contains(out, "sleep 20") { + t.Fatal("top should've listed `sleep 20` in the process list, but failed the first time") + } else if !strings.Contains(out2, "sleep 20") { + t.Fatal("top should've listed `sleep 20` in the process list, but failed the second itime") } logDone("top - sleep process should be listed in non privileged mode") @@ -42,14 +50,22 @@ func TestTopPrivileged(t *testing.T) { out, _, err = runCommandWithOutput(topCmd) errorOut(err, t, fmt.Sprintf("failed to run top: %v %v", out, err)) + topCmd = exec.Command(dockerBinary, "top", cleanedContainerID) + out2, _, err2 := runCommandWithOutput(topCmd) + errorOut(err, t, fmt.Sprintf("failed to run top: %v %v", out2, err2)) + killCmd := exec.Command(dockerBinary, "kill", cleanedContainerID) _, err = runCommand(killCmd) errorOut(err, t, fmt.Sprintf("failed to kill container: %v", err)) deleteContainer(cleanedContainerID) - if !strings.Contains(out, "sleep 20") { - t.Fatal("top should've listed sleep 20 in the process list") + if !strings.Contains(out, "sleep 20") && !strings.Contains(out2, "sleep 20") { + t.Fatal("top should've listed `sleep 20` in the process list, but failed twice") + } else if !strings.Contains(out, "sleep 20") { + t.Fatal("top should've listed `sleep 20` in the process list, but failed the first time") + } else if !strings.Contains(out2, "sleep 20") { + t.Fatal("top should've listed `sleep 20` in the process list, but failed the second itime") } logDone("top - sleep process should be listed in privileged mode") diff --git a/integration/api_test.go b/integration/api_test.go index 26441a2668..04611dfe3d 100644 --- a/integration/api_test.go +++ b/integration/api_test.go @@ -16,10 +16,10 @@ import ( "github.com/dotcloud/docker/api" "github.com/dotcloud/docker/api/server" + "github.com/dotcloud/docker/daemon" "github.com/dotcloud/docker/engine" "github.com/dotcloud/docker/image" "github.com/dotcloud/docker/runconfig" - "github.com/dotcloud/docker/runtime" "github.com/dotcloud/docker/utils" "github.com/dotcloud/docker/vendor/src/code.google.com/p/go/src/pkg/archive/tar" ) @@ -27,10 +27,10 @@ import ( func TestGetEvents(t *testing.T) { eng := NewTestEngine(t) srv := mkServerFromEngine(eng, t) - // FIXME: we might not need runtime, why not simply nuke + // FIXME: we might not need daemon, why not simply nuke // the engine? - runtime := mkRuntimeFromEngine(eng, t) - defer nuke(runtime) + daemon := mkDaemonFromEngine(eng, t) + defer nuke(daemon) var events []*utils.JSONMessage for _, parts := range [][3]string{ @@ -72,7 +72,7 @@ func TestGetEvents(t *testing.T) { func TestGetImagesJSON(t *testing.T) { eng := NewTestEngine(t) - defer mkRuntimeFromEngine(eng, t).Nuke() + defer mkDaemonFromEngine(eng, t).Nuke() job := eng.Job("images") initialImages, err := job.Stdout.AddListTable() @@ -175,7 +175,7 @@ func TestGetImagesJSON(t *testing.T) { func TestGetImagesHistory(t *testing.T) { eng := NewTestEngine(t) - defer mkRuntimeFromEngine(eng, t).Nuke() + defer mkDaemonFromEngine(eng, t).Nuke() r := httptest.NewRecorder() @@ -199,7 +199,7 @@ func TestGetImagesHistory(t *testing.T) { func TestGetImagesByName(t *testing.T) { eng := NewTestEngine(t) - defer mkRuntimeFromEngine(eng, t).Nuke() + defer mkDaemonFromEngine(eng, t).Nuke() req, err := http.NewRequest("GET", "/images/"+unitTestImageName+"/json", nil) if err != nil { @@ -223,7 +223,7 @@ func TestGetImagesByName(t *testing.T) { func TestGetContainersJSON(t *testing.T) { eng := NewTestEngine(t) - defer mkRuntimeFromEngine(eng, t).Nuke() + defer mkDaemonFromEngine(eng, t).Nuke() job := eng.Job("containers") job.SetenvBool("all", true) @@ -269,7 +269,7 @@ func TestGetContainersJSON(t *testing.T) { func TestGetContainersExport(t *testing.T) { eng := NewTestEngine(t) - defer mkRuntimeFromEngine(eng, t).Nuke() + defer mkDaemonFromEngine(eng, t).Nuke() // Create a container and remove a file containerID := createTestContainer(eng, @@ -317,7 +317,7 @@ func TestGetContainersExport(t *testing.T) { func TestSaveImageAndThenLoad(t *testing.T) { eng := NewTestEngine(t) - defer mkRuntimeFromEngine(eng, t).Nuke() + defer mkDaemonFromEngine(eng, t).Nuke() // save image r := httptest.NewRecorder() @@ -388,7 +388,7 @@ func TestSaveImageAndThenLoad(t *testing.T) { func TestGetContainersChanges(t *testing.T) { eng := NewTestEngine(t) - defer mkRuntimeFromEngine(eng, t).Nuke() + defer mkDaemonFromEngine(eng, t).Nuke() // Create a container and remove a file containerID := createTestContainer(eng, @@ -428,7 +428,7 @@ func TestGetContainersChanges(t *testing.T) { func TestGetContainersTop(t *testing.T) { eng := NewTestEngine(t) - defer mkRuntimeFromEngine(eng, t).Nuke() + defer mkDaemonFromEngine(eng, t).Nuke() containerID := createTestContainer(eng, &runconfig.Config{ @@ -439,7 +439,7 @@ func TestGetContainersTop(t *testing.T) { t, ) defer func() { - // Make sure the process dies before destroying runtime + // Make sure the process dies before destroying daemon containerKill(eng, containerID, t) containerWait(eng, containerID, t) }() @@ -504,7 +504,7 @@ func TestGetContainersTop(t *testing.T) { func TestGetContainersByName(t *testing.T) { eng := NewTestEngine(t) - defer mkRuntimeFromEngine(eng, t).Nuke() + defer mkDaemonFromEngine(eng, t).Nuke() // Create a container and remove a file containerID := createTestContainer(eng, @@ -524,7 +524,7 @@ func TestGetContainersByName(t *testing.T) { t.Fatal(err) } assertHttpNotError(r, t) - outContainer := &runtime.Container{} + outContainer := &daemon.Container{} if err := json.Unmarshal(r.Body.Bytes(), outContainer); err != nil { t.Fatal(err) } @@ -535,7 +535,7 @@ func TestGetContainersByName(t *testing.T) { func TestPostCommit(t *testing.T) { eng := NewTestEngine(t) - defer mkRuntimeFromEngine(eng, t).Nuke() + defer mkDaemonFromEngine(eng, t).Nuke() srv := mkServerFromEngine(eng, t) // Create a container and remove a file @@ -574,7 +574,7 @@ func TestPostCommit(t *testing.T) { func TestPostContainersCreate(t *testing.T) { eng := NewTestEngine(t) - defer mkRuntimeFromEngine(eng, t).Nuke() + defer mkDaemonFromEngine(eng, t).Nuke() configJSON, err := json.Marshal(&runconfig.Config{ Image: unitTestImageID, @@ -615,7 +615,7 @@ func TestPostContainersCreate(t *testing.T) { func TestPostContainersKill(t *testing.T) { eng := NewTestEngine(t) - defer mkRuntimeFromEngine(eng, t).Nuke() + defer mkDaemonFromEngine(eng, t).Nuke() containerID := createTestContainer(eng, &runconfig.Config{ @@ -654,7 +654,7 @@ func TestPostContainersKill(t *testing.T) { func TestPostContainersRestart(t *testing.T) { eng := NewTestEngine(t) - defer mkRuntimeFromEngine(eng, t).Nuke() + defer mkDaemonFromEngine(eng, t).Nuke() containerID := createTestContainer(eng, &runconfig.Config{ @@ -699,7 +699,7 @@ func TestPostContainersRestart(t *testing.T) { func TestPostContainersStart(t *testing.T) { eng := NewTestEngine(t) - defer mkRuntimeFromEngine(eng, t).Nuke() + defer mkDaemonFromEngine(eng, t).Nuke() containerID := createTestContainer( eng, @@ -752,7 +752,7 @@ func TestPostContainersStart(t *testing.T) { // Expected behaviour: using / as a bind mount source should throw an error func TestRunErrorBindMountRootSource(t *testing.T) { eng := NewTestEngine(t) - defer mkRuntimeFromEngine(eng, t).Nuke() + defer mkDaemonFromEngine(eng, t).Nuke() containerID := createTestContainer( eng, @@ -787,7 +787,7 @@ func TestRunErrorBindMountRootSource(t *testing.T) { func TestPostContainersStop(t *testing.T) { eng := NewTestEngine(t) - defer mkRuntimeFromEngine(eng, t).Nuke() + defer mkDaemonFromEngine(eng, t).Nuke() containerID := createTestContainer(eng, &runconfig.Config{ @@ -827,7 +827,7 @@ func TestPostContainersStop(t *testing.T) { func TestPostContainersWait(t *testing.T) { eng := NewTestEngine(t) - defer mkRuntimeFromEngine(eng, t).Nuke() + defer mkDaemonFromEngine(eng, t).Nuke() containerID := createTestContainer(eng, &runconfig.Config{ @@ -865,7 +865,7 @@ func TestPostContainersWait(t *testing.T) { func TestPostContainersAttach(t *testing.T) { eng := NewTestEngine(t) - defer mkRuntimeFromEngine(eng, t).Nuke() + defer mkDaemonFromEngine(eng, t).Nuke() containerID := createTestContainer(eng, &runconfig.Config{ @@ -943,7 +943,7 @@ func TestPostContainersAttach(t *testing.T) { func TestPostContainersAttachStderr(t *testing.T) { eng := NewTestEngine(t) - defer mkRuntimeFromEngine(eng, t).Nuke() + defer mkDaemonFromEngine(eng, t).Nuke() containerID := createTestContainer(eng, &runconfig.Config{ @@ -1024,7 +1024,7 @@ func TestPostContainersAttachStderr(t *testing.T) { // FIXME: Test deleting volume in use by other container func TestDeleteContainers(t *testing.T) { eng := NewTestEngine(t) - defer mkRuntimeFromEngine(eng, t).Nuke() + defer mkDaemonFromEngine(eng, t).Nuke() containerID := createTestContainer(eng, &runconfig.Config{ @@ -1050,7 +1050,7 @@ func TestDeleteContainers(t *testing.T) { func TestOptionsRoute(t *testing.T) { eng := NewTestEngine(t) - defer mkRuntimeFromEngine(eng, t).Nuke() + defer mkDaemonFromEngine(eng, t).Nuke() r := httptest.NewRecorder() req, err := http.NewRequest("OPTIONS", "/", nil) @@ -1068,7 +1068,7 @@ func TestOptionsRoute(t *testing.T) { func TestGetEnabledCors(t *testing.T) { eng := NewTestEngine(t) - defer mkRuntimeFromEngine(eng, t).Nuke() + defer mkDaemonFromEngine(eng, t).Nuke() r := httptest.NewRecorder() @@ -1103,7 +1103,7 @@ func TestDeleteImages(t *testing.T) { eng := NewTestEngine(t) //we expect errors, so we disable stderr eng.Stderr = ioutil.Discard - defer mkRuntimeFromEngine(eng, t).Nuke() + defer mkDaemonFromEngine(eng, t).Nuke() initialImages := getImages(eng, t, true, "") @@ -1160,7 +1160,7 @@ func TestDeleteImages(t *testing.T) { func TestPostContainersCopy(t *testing.T) { eng := NewTestEngine(t) - defer mkRuntimeFromEngine(eng, t).Nuke() + defer mkDaemonFromEngine(eng, t).Nuke() // Create a container and remove a file containerID := createTestContainer(eng, @@ -1218,7 +1218,7 @@ func TestPostContainersCopy(t *testing.T) { func TestPostContainersCopyWhenContainerNotFound(t *testing.T) { eng := NewTestEngine(t) - defer mkRuntimeFromEngine(eng, t).Nuke() + defer mkDaemonFromEngine(eng, t).Nuke() r := httptest.NewRecorder() diff --git a/integration/buildfile_test.go b/integration/buildfile_test.go index 0c5335426c..81580ec98c 100644 --- a/integration/buildfile_test.go +++ b/integration/buildfile_test.go @@ -365,7 +365,7 @@ func TestBuild(t *testing.T) { func buildImage(context testContextTemplate, t *testing.T, eng *engine.Engine, useCache bool) (*image.Image, error) { if eng == nil { eng = NewTestEngine(t) - runtime := mkRuntimeFromEngine(eng, t) + runtime := mkDaemonFromEngine(eng, t) // FIXME: we might not need runtime, why not simply nuke // the engine? defer nuke(runtime) @@ -547,7 +547,7 @@ func TestBuildEntrypoint(t *testing.T) { // utilizing cache func TestBuildEntrypointRunCleanup(t *testing.T) { eng := NewTestEngine(t) - defer nuke(mkRuntimeFromEngine(eng, t)) + defer nuke(mkDaemonFromEngine(eng, t)) img, err := buildImage(testContextTemplate{` from {IMAGE} @@ -576,7 +576,7 @@ func TestBuildEntrypointRunCleanup(t *testing.T) { func checkCacheBehavior(t *testing.T, template testContextTemplate, expectHit bool) (imageId string) { eng := NewTestEngine(t) - defer nuke(mkRuntimeFromEngine(eng, t)) + defer nuke(mkDaemonFromEngine(eng, t)) img, err := buildImage(template, t, eng, true) if err != nil { @@ -660,7 +660,7 @@ func TestBuildADDLocalFileWithCache(t *testing.T) { }, nil} eng := NewTestEngine(t) - defer nuke(mkRuntimeFromEngine(eng, t)) + defer nuke(mkDaemonFromEngine(eng, t)) id1 := checkCacheBehaviorFromEngime(t, template, true, eng) template.files = append(template.files, [2]string{"bar", "hello2"}) @@ -796,7 +796,7 @@ func TestBuildADDLocalAndRemoteFilesWithoutCache(t *testing.T) { func TestForbiddenContextPath(t *testing.T) { eng := NewTestEngine(t) - defer nuke(mkRuntimeFromEngine(eng, t)) + defer nuke(mkDaemonFromEngine(eng, t)) srv := mkServerFromEngine(eng, t) context := testContextTemplate{` @@ -844,7 +844,7 @@ func TestForbiddenContextPath(t *testing.T) { func TestBuildADDFileNotFound(t *testing.T) { eng := NewTestEngine(t) - defer nuke(mkRuntimeFromEngine(eng, t)) + defer nuke(mkDaemonFromEngine(eng, t)) context := testContextTemplate{` from {IMAGE} @@ -890,7 +890,7 @@ func TestBuildADDFileNotFound(t *testing.T) { func TestBuildInheritance(t *testing.T) { eng := NewTestEngine(t) - defer nuke(mkRuntimeFromEngine(eng, t)) + defer nuke(mkDaemonFromEngine(eng, t)) img, err := buildImage(testContextTemplate{` from {IMAGE} @@ -1012,7 +1012,7 @@ func TestBuildOnBuildForbiddenMaintainerTrigger(t *testing.T) { // gh #2446 func TestBuildAddToSymlinkDest(t *testing.T) { eng := NewTestEngine(t) - defer nuke(mkRuntimeFromEngine(eng, t)) + defer nuke(mkDaemonFromEngine(eng, t)) _, err := buildImage(testContextTemplate{` from {IMAGE} diff --git a/integration/commands_test.go b/integration/commands_test.go index 15bb61b49c..5b967b68cc 100644 --- a/integration/commands_test.go +++ b/integration/commands_test.go @@ -4,10 +4,10 @@ import ( "bufio" "fmt" "github.com/dotcloud/docker/api/client" + "github.com/dotcloud/docker/daemon" "github.com/dotcloud/docker/engine" "github.com/dotcloud/docker/image" "github.com/dotcloud/docker/pkg/term" - "github.com/dotcloud/docker/runtime" "github.com/dotcloud/docker/utils" "io" "io/ioutil" @@ -36,7 +36,7 @@ func closeWrap(args ...io.Closer) error { return nil } -func setRaw(t *testing.T, c *runtime.Container) *term.State { +func setRaw(t *testing.T, c *daemon.Container) *term.State { pty, err := c.GetPtyMaster() if err != nil { t.Fatal(err) @@ -48,7 +48,7 @@ func setRaw(t *testing.T, c *runtime.Container) *term.State { return state } -func unsetRaw(t *testing.T, c *runtime.Container, state *term.State) { +func unsetRaw(t *testing.T, c *daemon.Container, state *term.State) { pty, err := c.GetPtyMaster() if err != nil { t.Fatal(err) @@ -56,12 +56,12 @@ func unsetRaw(t *testing.T, c *runtime.Container, state *term.State) { term.RestoreTerminal(pty.Fd(), state) } -func waitContainerStart(t *testing.T, timeout time.Duration) *runtime.Container { - var container *runtime.Container +func waitContainerStart(t *testing.T, timeout time.Duration) *daemon.Container { + var container *daemon.Container setTimeout(t, "Waiting for the container to be started timed out", timeout, func() { for { - l := globalRuntime.List() + l := globalDaemon.List() if len(l) == 1 && l[0].State.IsRunning() { container = l[0] break @@ -142,7 +142,7 @@ func TestRunHostname(t *testing.T) { } }) - container := globalRuntime.List()[0] + container := globalDaemon.List()[0] setTimeout(t, "CmdRun timed out", 10*time.Second, func() { <-c @@ -187,7 +187,7 @@ func TestRunWorkdir(t *testing.T) { } }) - container := globalRuntime.List()[0] + container := globalDaemon.List()[0] setTimeout(t, "CmdRun timed out", 10*time.Second, func() { <-c @@ -232,7 +232,7 @@ func TestRunWorkdirExists(t *testing.T) { } }) - container := globalRuntime.List()[0] + container := globalDaemon.List()[0] setTimeout(t, "CmdRun timed out", 5*time.Second, func() { <-c @@ -290,7 +290,7 @@ func TestRunExit(t *testing.T) { } }) - container := globalRuntime.List()[0] + container := globalDaemon.List()[0] // Closing /bin/cat stdin, expect it to exit if err := stdin.Close(); err != nil { @@ -359,7 +359,7 @@ func TestRunDisconnect(t *testing.T) { // Client disconnect after run -i should cause stdin to be closed, which should // cause /bin/cat to exit. setTimeout(t, "Waiting for /bin/cat to exit timed out", 2*time.Second, func() { - container := globalRuntime.List()[0] + container := globalDaemon.List()[0] container.Wait() if container.State.IsRunning() { t.Fatalf("/bin/cat is still running after closing stdin") @@ -445,7 +445,7 @@ func TestRunAttachStdin(t *testing.T) { } }) - container := globalRuntime.List()[0] + container := globalDaemon.List()[0] // Check output setTimeout(t, "Reading command output time out", 10*time.Second, func() { @@ -701,7 +701,7 @@ func TestAttachDisconnect(t *testing.T) { setTimeout(t, "Waiting for the container to be started timed out", 10*time.Second, func() { for { - l := globalRuntime.List() + l := globalDaemon.List() if len(l) == 1 && l[0].State.IsRunning() { break } @@ -709,7 +709,7 @@ func TestAttachDisconnect(t *testing.T) { } }) - container := globalRuntime.List()[0] + container := globalDaemon.List()[0] // Attach to it c1 := make(chan struct{}) @@ -781,7 +781,7 @@ func TestRunAutoRemove(t *testing.T) { time.Sleep(500 * time.Millisecond) - if len(globalRuntime.List()) > 0 { + if len(globalDaemon.List()) > 0 { t.Fatalf("failed to remove container automatically: container %s still exists", temporaryContainerID) } } @@ -798,7 +798,7 @@ func TestCmdLogs(t *testing.T) { t.Fatal(err) } - if err := cli.CmdLogs(globalRuntime.List()[0].ID); err != nil { + if err := cli.CmdLogs(globalDaemon.List()[0].ID); err != nil { t.Fatal(err) } } diff --git a/integration/container_test.go b/integration/container_test.go index 43f51c1e5f..67b2783ce9 100644 --- a/integration/container_test.go +++ b/integration/container_test.go @@ -1,445 +1,23 @@ package docker import ( - "bufio" "fmt" "github.com/dotcloud/docker/runconfig" - "github.com/dotcloud/docker/utils" "io" "io/ioutil" "os" "path" - "regexp" - "sort" "strings" "testing" "time" ) -func TestIDFormat(t *testing.T) { - runtime := mkRuntime(t) - defer nuke(runtime) - container1, _, err := runtime.Create( - &runconfig.Config{ - Image: GetTestImage(runtime).ID, - Cmd: []string{"/bin/sh", "-c", "echo hello world"}, - }, - "", - ) - if err != nil { - t.Fatal(err) - } - match, err := regexp.Match("^[0-9a-f]{64}$", []byte(container1.ID)) - if err != nil { - t.Fatal(err) - } - if !match { - t.Fatalf("Invalid container ID: %s", container1.ID) - } -} - -func TestMultipleAttachRestart(t *testing.T) { - runtime := mkRuntime(t) - defer nuke(runtime) - container, _, _ := mkContainer( - runtime, - []string{"_", "/bin/sh", "-c", "i=1; while [ $i -le 5 ]; do i=`expr $i + 1`; echo hello; done"}, - t, - ) - defer runtime.Destroy(container) - - // Simulate 3 client attaching to the container and stop/restart - - stdout1, err := container.StdoutPipe() - if err != nil { - t.Fatal(err) - } - stdout2, err := container.StdoutPipe() - if err != nil { - t.Fatal(err) - } - stdout3, err := container.StdoutPipe() - if err != nil { - t.Fatal(err) - } - if err := container.Start(); err != nil { - t.Fatal(err) - } - l1, err := bufio.NewReader(stdout1).ReadString('\n') - if err != nil { - t.Fatal(err) - } - if strings.Trim(l1, " \r\n") != "hello" { - t.Fatalf("Unexpected output. Expected [%s], received [%s]", "hello", l1) - } - l2, err := bufio.NewReader(stdout2).ReadString('\n') - if err != nil { - t.Fatal(err) - } - if strings.Trim(l2, " \r\n") != "hello" { - t.Fatalf("Unexpected output. Expected [%s], received [%s]", "hello", l2) - } - l3, err := bufio.NewReader(stdout3).ReadString('\n') - if err != nil { - t.Fatal(err) - } - if strings.Trim(l3, " \r\n") != "hello" { - t.Fatalf("Unexpected output. Expected [%s], received [%s]", "hello", l3) - } - - if err := container.Stop(10); err != nil { - t.Fatal(err) - } - - stdout1, err = container.StdoutPipe() - if err != nil { - t.Fatal(err) - } - stdout2, err = container.StdoutPipe() - if err != nil { - t.Fatal(err) - } - stdout3, err = container.StdoutPipe() - if err != nil { - t.Fatal(err) - } - if err := container.Start(); err != nil { - t.Fatal(err) - } - - setTimeout(t, "Timeout reading from the process", 3*time.Second, func() { - l1, err = bufio.NewReader(stdout1).ReadString('\n') - if err != nil { - t.Fatal(err) - } - if strings.Trim(l1, " \r\n") != "hello" { - t.Fatalf("Unexpected output. Expected [%s], received [%s]", "hello", l1) - } - l2, err = bufio.NewReader(stdout2).ReadString('\n') - if err != nil { - t.Fatal(err) - } - if strings.Trim(l2, " \r\n") != "hello" { - t.Fatalf("Unexpected output. Expected [%s], received [%s]", "hello", l2) - } - l3, err = bufio.NewReader(stdout3).ReadString('\n') - if err != nil { - t.Fatal(err) - } - if strings.Trim(l3, " \r\n") != "hello" { - t.Fatalf("Unexpected output. Expected [%s], received [%s]", "hello", l3) - } - }) - container.Wait() -} - -func TestDiff(t *testing.T) { - eng := NewTestEngine(t) - runtime := mkRuntimeFromEngine(eng, t) - defer nuke(runtime) - // Create a container and remove a file - container1, _, _ := mkContainer(runtime, []string{"_", "/bin/rm", "/etc/passwd"}, t) - defer runtime.Destroy(container1) - - // The changelog should be empty and not fail before run. See #1705 - c, err := container1.Changes() - if err != nil { - t.Fatal(err) - } - if len(c) != 0 { - t.Fatalf("Changelog should be empty before run") - } - - if err := container1.Run(); err != nil { - t.Fatal(err) - } - - // Check the changelog - c, err = container1.Changes() - if err != nil { - t.Fatal(err) - } - success := false - for _, elem := range c { - if elem.Path == "/etc/passwd" && elem.Kind == 2 { - success = true - } - } - if !success { - t.Fatalf("/etc/passwd as been removed but is not present in the diff") - } - - // Commit the container - img, err := runtime.Commit(container1, "", "", "unit test commited image - diff", "", nil) - if err != nil { - t.Fatal(err) - } - - // Create a new container from the commited image - container2, _, _ := mkContainer(runtime, []string{img.ID, "cat", "/etc/passwd"}, t) - defer runtime.Destroy(container2) - - if err := container2.Run(); err != nil { - t.Fatal(err) - } - - // Check the changelog - c, err = container2.Changes() - if err != nil { - t.Fatal(err) - } - for _, elem := range c { - if elem.Path == "/etc/passwd" { - t.Fatalf("/etc/passwd should not be present in the diff after commit.") - } - } - - // Create a new container - container3, _, _ := mkContainer(runtime, []string{"_", "rm", "/bin/httpd"}, t) - defer runtime.Destroy(container3) - - if err := container3.Run(); err != nil { - t.Fatal(err) - } - - // Check the changelog - c, err = container3.Changes() - if err != nil { - t.Fatal(err) - } - success = false - for _, elem := range c { - if elem.Path == "/bin/httpd" && elem.Kind == 2 { - success = true - } - } - if !success { - t.Fatalf("/bin/httpd should be present in the diff after commit.") - } -} - -func TestCommitAutoRun(t *testing.T) { - runtime := mkRuntime(t) - defer nuke(runtime) - container1, _, _ := mkContainer(runtime, []string{"_", "/bin/sh", "-c", "echo hello > /world"}, t) - defer runtime.Destroy(container1) - - if container1.State.IsRunning() { - t.Errorf("Container shouldn't be running") - } - if err := container1.Run(); err != nil { - t.Fatal(err) - } - if container1.State.IsRunning() { - t.Errorf("Container shouldn't be running") - } - - img, err := runtime.Commit(container1, "", "", "unit test commited image", "", &runconfig.Config{Cmd: []string{"cat", "/world"}}) - if err != nil { - t.Error(err) - } - - // FIXME: Make a TestCommit that stops here and check docker.root/layers/img.id/world - container2, _, _ := mkContainer(runtime, []string{img.ID}, t) - defer runtime.Destroy(container2) - stdout, err := container2.StdoutPipe() - if err != nil { - t.Fatal(err) - } - stderr, err := container2.StderrPipe() - if err != nil { - t.Fatal(err) - } - if err := container2.Start(); err != nil { - t.Fatal(err) - } - container2.Wait() - output, err := ioutil.ReadAll(stdout) - if err != nil { - t.Fatal(err) - } - output2, err := ioutil.ReadAll(stderr) - if err != nil { - t.Fatal(err) - } - if err := stdout.Close(); err != nil { - t.Fatal(err) - } - if err := stderr.Close(); err != nil { - t.Fatal(err) - } - if string(output) != "hello\n" { - t.Fatalf("Unexpected output. Expected %s, received: %s (err: %s)", "hello\n", output, output2) - } -} - -func TestCommitRun(t *testing.T) { - runtime := mkRuntime(t) - defer nuke(runtime) - - container1, _, _ := mkContainer(runtime, []string{"_", "/bin/sh", "-c", "echo hello > /world"}, t) - defer runtime.Destroy(container1) - - if container1.State.IsRunning() { - t.Errorf("Container shouldn't be running") - } - if err := container1.Run(); err != nil { - t.Fatal(err) - } - if container1.State.IsRunning() { - t.Errorf("Container shouldn't be running") - } - - img, err := runtime.Commit(container1, "", "", "unit test commited image", "", nil) - if err != nil { - t.Error(err) - } - - // FIXME: Make a TestCommit that stops here and check docker.root/layers/img.id/world - container2, _, _ := mkContainer(runtime, []string{img.ID, "cat", "/world"}, t) - defer runtime.Destroy(container2) - stdout, err := container2.StdoutPipe() - if err != nil { - t.Fatal(err) - } - stderr, err := container2.StderrPipe() - if err != nil { - t.Fatal(err) - } - if err := container2.Start(); err != nil { - t.Fatal(err) - } - container2.Wait() - output, err := ioutil.ReadAll(stdout) - if err != nil { - t.Fatal(err) - } - output2, err := ioutil.ReadAll(stderr) - if err != nil { - t.Fatal(err) - } - if err := stdout.Close(); err != nil { - t.Fatal(err) - } - if err := stderr.Close(); err != nil { - t.Fatal(err) - } - if string(output) != "hello\n" { - t.Fatalf("Unexpected output. Expected %s, received: %s (err: %s)", "hello\n", output, output2) - } -} - -func TestStart(t *testing.T) { - runtime := mkRuntime(t) - defer nuke(runtime) - container, _, _ := mkContainer(runtime, []string{"-i", "_", "/bin/cat"}, t) - defer runtime.Destroy(container) - - cStdin, err := container.StdinPipe() - if err != nil { - t.Fatal(err) - } - - if err := container.Start(); err != nil { - t.Fatal(err) - } - - // Give some time to the process to start - container.WaitTimeout(500 * time.Millisecond) - - if !container.State.IsRunning() { - t.Errorf("Container should be running") - } - if err := container.Start(); err != nil { - t.Fatalf("A running container should be able to be started") - } - - // Try to avoid the timeout in destroy. Best effort, don't check error - cStdin.Close() - container.WaitTimeout(2 * time.Second) -} - -func TestCpuShares(t *testing.T) { - _, err1 := os.Stat("/sys/fs/cgroup/cpuacct,cpu") - _, err2 := os.Stat("/sys/fs/cgroup/cpu,cpuacct") - if err1 == nil || err2 == nil { - t.Skip("Fixme. Setting cpu cgroup shares doesn't work in dind on a Fedora host. The lxc utils are confused by the cpu,cpuacct mount.") - } - runtime := mkRuntime(t) - defer nuke(runtime) - container, _, _ := mkContainer(runtime, []string{"-m", "33554432", "-c", "1000", "-i", "_", "/bin/cat"}, t) - defer runtime.Destroy(container) - - cStdin, err := container.StdinPipe() - if err != nil { - t.Fatal(err) - } - - if err := container.Start(); err != nil { - t.Fatal(err) - } - - // Give some time to the process to start - container.WaitTimeout(500 * time.Millisecond) - - if !container.State.IsRunning() { - t.Errorf("Container should be running") - } - if err := container.Start(); err != nil { - t.Fatalf("A running container should be able to be started") - } - - // Try to avoid the timeout in destroy. Best effort, don't check error - cStdin.Close() - container.WaitTimeout(2 * time.Second) -} - -func TestRun(t *testing.T) { - runtime := mkRuntime(t) - defer nuke(runtime) - container, _, _ := mkContainer(runtime, []string{"_", "ls", "-al"}, t) - defer runtime.Destroy(container) - - if container.State.IsRunning() { - t.Errorf("Container shouldn't be running") - } - if err := container.Run(); err != nil { - t.Fatal(err) - } - if container.State.IsRunning() { - t.Errorf("Container shouldn't be running") - } -} - -func TestOutput(t *testing.T) { - runtime := mkRuntime(t) - defer nuke(runtime) - container, _, err := runtime.Create( - &runconfig.Config{ - Image: GetTestImage(runtime).ID, - Cmd: []string{"echo", "-n", "foobar"}, - }, - "", - ) - if err != nil { - t.Fatal(err) - } - defer runtime.Destroy(container) - output, err := container.Output() - if err != nil { - t.Fatal(err) - } - if string(output) != "foobar" { - t.Fatalf("%s != %s", string(output), "foobar") - } -} - func TestKillDifferentUser(t *testing.T) { - runtime := mkRuntime(t) - defer nuke(runtime) + daemon := mkDaemon(t) + defer nuke(daemon) - container, _, err := runtime.Create(&runconfig.Config{ - Image: GetTestImage(runtime).ID, + container, _, err := daemon.Create(&runconfig.Config{ + Image: GetTestImage(daemon).ID, Cmd: []string{"cat"}, OpenStdin: true, User: "daemon", @@ -449,7 +27,7 @@ func TestKillDifferentUser(t *testing.T) { if err != nil { t.Fatal(err) } - defer runtime.Destroy(container) + defer daemon.Destroy(container) // FIXME @shykes: this seems redundant, but is very old, I'm leaving it in case // there is a side effect I'm not seeing. // defer container.stdin.Close() @@ -492,124 +70,11 @@ func TestKillDifferentUser(t *testing.T) { } } -// Test that creating a container with a volume doesn't crash. Regression test for #995. -func TestCreateVolume(t *testing.T) { - eng := NewTestEngine(t) - runtime := mkRuntimeFromEngine(eng, t) - defer nuke(runtime) - - config, hc, _, err := runconfig.Parse([]string{"-v", "/var/lib/data", unitTestImageID, "echo", "hello", "world"}, nil) - if err != nil { - t.Fatal(err) - } - jobCreate := eng.Job("create") - if err := jobCreate.ImportEnv(config); err != nil { - t.Fatal(err) - } - var id string - jobCreate.Stdout.AddString(&id) - if err := jobCreate.Run(); err != nil { - t.Fatal(err) - } - jobStart := eng.Job("start", id) - if err := jobStart.ImportEnv(hc); err != nil { - t.Fatal(err) - } - if err := jobStart.Run(); err != nil { - t.Fatal(err) - } - // FIXME: this hack can be removed once Wait is a job - c := runtime.Get(id) - if c == nil { - t.Fatalf("Couldn't retrieve container %s from runtime", id) - } - c.WaitTimeout(500 * time.Millisecond) - c.Wait() -} - -func TestKill(t *testing.T) { - runtime := mkRuntime(t) - defer nuke(runtime) - container, _, err := runtime.Create(&runconfig.Config{ - Image: GetTestImage(runtime).ID, - Cmd: []string{"sleep", "2"}, - }, - "", - ) - if err != nil { - t.Fatal(err) - } - defer runtime.Destroy(container) - - if container.State.IsRunning() { - t.Errorf("Container shouldn't be running") - } - if err := container.Start(); err != nil { - t.Fatal(err) - } - - // Give some time to lxc to spawn the process - container.WaitTimeout(500 * time.Millisecond) - - if !container.State.IsRunning() { - t.Errorf("Container should be running") - } - if err := container.Kill(); err != nil { - t.Fatal(err) - } - if container.State.IsRunning() { - t.Errorf("Container shouldn't be running") - } - container.Wait() - if container.State.IsRunning() { - t.Errorf("Container shouldn't be running") - } - // Try stopping twice - if err := container.Kill(); err != nil { - t.Fatal(err) - } -} - -func TestExitCode(t *testing.T) { - runtime := mkRuntime(t) - defer nuke(runtime) - - trueContainer, _, err := runtime.Create(&runconfig.Config{ - Image: GetTestImage(runtime).ID, - Cmd: []string{"/bin/true"}, - }, "") - if err != nil { - t.Fatal(err) - } - defer runtime.Destroy(trueContainer) - if err := trueContainer.Run(); err != nil { - t.Fatal(err) - } - if code := trueContainer.State.GetExitCode(); code != 0 { - t.Fatalf("Unexpected exit code %d (expected 0)", code) - } - - falseContainer, _, err := runtime.Create(&runconfig.Config{ - Image: GetTestImage(runtime).ID, - Cmd: []string{"/bin/false"}, - }, "") - if err != nil { - t.Fatal(err) - } - defer runtime.Destroy(falseContainer) - if err := falseContainer.Run(); err != nil { - t.Fatal(err) - } - if code := falseContainer.State.GetExitCode(); code != 1 { - t.Fatalf("Unexpected exit code %d (expected 1)", code) - } -} - func TestRestart(t *testing.T) { - runtime := mkRuntime(t) - defer nuke(runtime) - container, _, err := runtime.Create(&runconfig.Config{ - Image: GetTestImage(runtime).ID, + daemon := mkDaemon(t) + defer nuke(daemon) + container, _, err := daemon.Create(&runconfig.Config{ + Image: GetTestImage(daemon).ID, Cmd: []string{"echo", "-n", "foobar"}, }, "", @@ -617,7 +82,7 @@ func TestRestart(t *testing.T) { if err != nil { t.Fatal(err) } - defer runtime.Destroy(container) + defer daemon.Destroy(container) output, err := container.Output() if err != nil { t.Fatal(err) @@ -637,10 +102,10 @@ func TestRestart(t *testing.T) { } func TestRestartStdin(t *testing.T) { - runtime := mkRuntime(t) - defer nuke(runtime) - container, _, err := runtime.Create(&runconfig.Config{ - Image: GetTestImage(runtime).ID, + daemon := mkDaemon(t) + defer nuke(daemon) + container, _, err := daemon.Create(&runconfig.Config{ + Image: GetTestImage(daemon).ID, Cmd: []string{"cat"}, OpenStdin: true, @@ -650,7 +115,7 @@ func TestRestartStdin(t *testing.T) { if err != nil { t.Fatal(err) } - defer runtime.Destroy(container) + defer daemon.Destroy(container) stdin, err := container.StdinPipe() if err != nil { @@ -712,195 +177,11 @@ func TestRestartStdin(t *testing.T) { } } -func TestUser(t *testing.T) { - runtime := mkRuntime(t) - defer nuke(runtime) - - // Default user must be root - container, _, err := runtime.Create(&runconfig.Config{ - Image: GetTestImage(runtime).ID, - Cmd: []string{"id"}, - }, - "", - ) - if err != nil { - t.Fatal(err) - } - defer runtime.Destroy(container) - output, err := container.Output() - if err != nil { - t.Fatal(err) - } - if !strings.Contains(string(output), "uid=0(root) gid=0(root)") { - t.Error(string(output)) - } - - // Set a username - container, _, err = runtime.Create(&runconfig.Config{ - Image: GetTestImage(runtime).ID, - Cmd: []string{"id"}, - - User: "root", - }, - "", - ) - if err != nil { - t.Fatal(err) - } - defer runtime.Destroy(container) - output, err = container.Output() - if code := container.State.GetExitCode(); err != nil || code != 0 { - t.Fatal(err) - } - if !strings.Contains(string(output), "uid=0(root) gid=0(root)") { - t.Error(string(output)) - } - - // Set a UID - container, _, err = runtime.Create(&runconfig.Config{ - Image: GetTestImage(runtime).ID, - Cmd: []string{"id"}, - - User: "0", - }, - "", - ) - if code := container.State.GetExitCode(); err != nil || code != 0 { - t.Fatal(err) - } - defer runtime.Destroy(container) - output, err = container.Output() - if code := container.State.GetExitCode(); err != nil || code != 0 { - t.Fatal(err) - } - if !strings.Contains(string(output), "uid=0(root) gid=0(root)") { - t.Error(string(output)) - } - - // Set a different user by uid - container, _, err = runtime.Create(&runconfig.Config{ - Image: GetTestImage(runtime).ID, - Cmd: []string{"id"}, - - User: "1", - }, - "", - ) - if err != nil { - t.Fatal(err) - } - defer runtime.Destroy(container) - output, err = container.Output() - if err != nil { - t.Fatal(err) - } else if code := container.State.GetExitCode(); code != 0 { - t.Fatalf("Container exit code is invalid: %d\nOutput:\n%s\n", code, output) - } - if !strings.Contains(string(output), "uid=1(daemon) gid=1(daemon)") { - t.Error(string(output)) - } - - // Set a different user by username - container, _, err = runtime.Create(&runconfig.Config{ - Image: GetTestImage(runtime).ID, - Cmd: []string{"id"}, - - User: "daemon", - }, - "", - ) - if err != nil { - t.Fatal(err) - } - defer runtime.Destroy(container) - output, err = container.Output() - if code := container.State.GetExitCode(); err != nil || code != 0 { - t.Fatal(err) - } - if !strings.Contains(string(output), "uid=1(daemon) gid=1(daemon)") { - t.Error(string(output)) - } - - // Test an wrong username - container, _, err = runtime.Create(&runconfig.Config{ - Image: GetTestImage(runtime).ID, - Cmd: []string{"id"}, - - User: "unknownuser", - }, - "", - ) - if err != nil { - t.Fatal(err) - } - defer runtime.Destroy(container) - output, err = container.Output() - if container.State.GetExitCode() == 0 { - t.Fatal("Starting container with wrong uid should fail but it passed.") - } -} - -func TestMultipleContainers(t *testing.T) { - runtime := mkRuntime(t) - defer nuke(runtime) - - container1, _, err := runtime.Create(&runconfig.Config{ - Image: GetTestImage(runtime).ID, - Cmd: []string{"sleep", "2"}, - }, - "", - ) - if err != nil { - t.Fatal(err) - } - defer runtime.Destroy(container1) - - container2, _, err := runtime.Create(&runconfig.Config{ - Image: GetTestImage(runtime).ID, - Cmd: []string{"sleep", "2"}, - }, - "", - ) - if err != nil { - t.Fatal(err) - } - defer runtime.Destroy(container2) - - // Start both containers - if err := container1.Start(); err != nil { - t.Fatal(err) - } - if err := container2.Start(); err != nil { - t.Fatal(err) - } - - // Make sure they are running before trying to kill them - container1.WaitTimeout(250 * time.Millisecond) - container2.WaitTimeout(250 * time.Millisecond) - - // If we are here, both containers should be running - if !container1.State.IsRunning() { - t.Fatal("Container not running") - } - if !container2.State.IsRunning() { - t.Fatal("Container not running") - } - - // Kill them - if err := container1.Kill(); err != nil { - t.Fatal(err) - } - - if err := container2.Kill(); err != nil { - t.Fatal(err) - } -} - func TestStdin(t *testing.T) { - runtime := mkRuntime(t) - defer nuke(runtime) - container, _, err := runtime.Create(&runconfig.Config{ - Image: GetTestImage(runtime).ID, + daemon := mkDaemon(t) + defer nuke(daemon) + container, _, err := daemon.Create(&runconfig.Config{ + Image: GetTestImage(daemon).ID, Cmd: []string{"cat"}, OpenStdin: true, @@ -910,7 +191,7 @@ func TestStdin(t *testing.T) { if err != nil { t.Fatal(err) } - defer runtime.Destroy(container) + defer daemon.Destroy(container) stdin, err := container.StdinPipe() if err != nil { @@ -942,10 +223,10 @@ func TestStdin(t *testing.T) { } func TestTty(t *testing.T) { - runtime := mkRuntime(t) - defer nuke(runtime) - container, _, err := runtime.Create(&runconfig.Config{ - Image: GetTestImage(runtime).ID, + daemon := mkDaemon(t) + defer nuke(daemon) + container, _, err := daemon.Create(&runconfig.Config{ + Image: GetTestImage(daemon).ID, Cmd: []string{"cat"}, OpenStdin: true, @@ -955,7 +236,7 @@ func TestTty(t *testing.T) { if err != nil { t.Fatal(err) } - defer runtime.Destroy(container) + defer daemon.Destroy(container) stdin, err := container.StdinPipe() if err != nil { @@ -986,66 +267,12 @@ func TestTty(t *testing.T) { } } -func TestEnv(t *testing.T) { - os.Setenv("TRUE", "false") - os.Setenv("TRICKY", "tri\ncky\n") - runtime := mkRuntime(t) - defer nuke(runtime) - config, _, _, err := runconfig.Parse([]string{"-e=FALSE=true", "-e=TRUE", "-e=TRICKY", GetTestImage(runtime).ID, "env"}, nil) - if err != nil { - t.Fatal(err) - } - container, _, err := runtime.Create(config, "") - if err != nil { - t.Fatal(err) - } - defer runtime.Destroy(container) - - stdout, err := container.StdoutPipe() - if err != nil { - t.Fatal(err) - } - defer stdout.Close() - if err := container.Start(); err != nil { - t.Fatal(err) - } - container.Wait() - output, err := ioutil.ReadAll(stdout) - if err != nil { - t.Fatal(err) - } - actualEnv := strings.Split(string(output), "\n") - if actualEnv[len(actualEnv)-1] == "" { - actualEnv = actualEnv[:len(actualEnv)-1] - } - sort.Strings(actualEnv) - goodEnv := []string{ - "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin", - "HOME=/", - "HOSTNAME=" + utils.TruncateID(container.ID), - "FALSE=true", - "TRUE=false", - "TRICKY=tri", - "cky", - "", - } - sort.Strings(goodEnv) - if len(goodEnv) != len(actualEnv) { - t.Fatalf("Wrong environment: should be %d variables, not: '%s'\n", len(goodEnv), strings.Join(actualEnv, ", ")) - } - for i := range goodEnv { - if actualEnv[i] != goodEnv[i] { - t.Fatalf("Wrong environment variable: should be %s, not %s", goodEnv[i], actualEnv[i]) - } - } -} - func TestEntrypoint(t *testing.T) { - runtime := mkRuntime(t) - defer nuke(runtime) - container, _, err := runtime.Create( + daemon := mkDaemon(t) + defer nuke(daemon) + container, _, err := daemon.Create( &runconfig.Config{ - Image: GetTestImage(runtime).ID, + Image: GetTestImage(daemon).ID, Entrypoint: []string{"/bin/echo"}, Cmd: []string{"-n", "foobar"}, }, @@ -1054,7 +281,7 @@ func TestEntrypoint(t *testing.T) { if err != nil { t.Fatal(err) } - defer runtime.Destroy(container) + defer daemon.Destroy(container) output, err := container.Output() if err != nil { t.Fatal(err) @@ -1065,11 +292,11 @@ func TestEntrypoint(t *testing.T) { } func TestEntrypointNoCmd(t *testing.T) { - runtime := mkRuntime(t) - defer nuke(runtime) - container, _, err := runtime.Create( + daemon := mkDaemon(t) + defer nuke(daemon) + container, _, err := daemon.Create( &runconfig.Config{ - Image: GetTestImage(runtime).ID, + Image: GetTestImage(daemon).ID, Entrypoint: []string{"/bin/echo", "foobar"}, }, "", @@ -1077,7 +304,7 @@ func TestEntrypointNoCmd(t *testing.T) { if err != nil { t.Fatal(err) } - defer runtime.Destroy(container) + defer daemon.Destroy(container) output, err := container.Output() if err != nil { t.Fatal(err) @@ -1088,11 +315,11 @@ func TestEntrypointNoCmd(t *testing.T) { } func BenchmarkRunSequential(b *testing.B) { - runtime := mkRuntime(b) - defer nuke(runtime) + daemon := mkDaemon(b) + defer nuke(daemon) for i := 0; i < b.N; i++ { - container, _, err := runtime.Create(&runconfig.Config{ - Image: GetTestImage(runtime).ID, + container, _, err := daemon.Create(&runconfig.Config{ + Image: GetTestImage(daemon).ID, Cmd: []string{"echo", "-n", "foo"}, }, "", @@ -1100,7 +327,7 @@ func BenchmarkRunSequential(b *testing.B) { if err != nil { b.Fatal(err) } - defer runtime.Destroy(container) + defer daemon.Destroy(container) output, err := container.Output() if err != nil { b.Fatal(err) @@ -1108,15 +335,15 @@ func BenchmarkRunSequential(b *testing.B) { if string(output) != "foo" { b.Fatalf("Unexpected output: %s", output) } - if err := runtime.Destroy(container); err != nil { + if err := daemon.Destroy(container); err != nil { b.Fatal(err) } } } func BenchmarkRunParallel(b *testing.B) { - runtime := mkRuntime(b) - defer nuke(runtime) + daemon := mkDaemon(b) + defer nuke(daemon) var tasks []chan error @@ -1124,8 +351,8 @@ func BenchmarkRunParallel(b *testing.B) { complete := make(chan error) tasks = append(tasks, complete) go func(i int, complete chan error) { - container, _, err := runtime.Create(&runconfig.Config{ - Image: GetTestImage(runtime).ID, + container, _, err := daemon.Create(&runconfig.Config{ + Image: GetTestImage(daemon).ID, Cmd: []string{"echo", "-n", "foo"}, }, "", @@ -1134,7 +361,7 @@ func BenchmarkRunParallel(b *testing.B) { complete <- err return } - defer runtime.Destroy(container) + defer daemon.Destroy(container) if err := container.Start(); err != nil { complete <- err return @@ -1146,7 +373,7 @@ func BenchmarkRunParallel(b *testing.B) { // if string(output) != "foo" { // complete <- fmt.Errorf("Unexecpted output: %v", string(output)) // } - if err := runtime.Destroy(container); err != nil { + if err := daemon.Destroy(container); err != nil { complete <- err return } @@ -1176,7 +403,7 @@ func tempDir(t *testing.T) string { // Test for #1737 func TestCopyVolumeUidGid(t *testing.T) { eng := NewTestEngine(t) - r := mkRuntimeFromEngine(eng, t) + r := mkDaemonFromEngine(eng, t) defer r.Nuke() // Add directory not owned by root @@ -1210,7 +437,7 @@ func TestCopyVolumeUidGid(t *testing.T) { // Test for #1582 func TestCopyVolumeContent(t *testing.T) { eng := NewTestEngine(t) - r := mkRuntimeFromEngine(eng, t) + r := mkDaemonFromEngine(eng, t) defer r.Nuke() // Put some content in a directory of a container and commit it @@ -1243,7 +470,7 @@ func TestCopyVolumeContent(t *testing.T) { func TestBindMounts(t *testing.T) { eng := NewTestEngine(t) - r := mkRuntimeFromEngine(eng, t) + r := mkDaemonFromEngine(eng, t) defer r.Nuke() tmpDir := tempDir(t) @@ -1275,11 +502,11 @@ func TestBindMounts(t *testing.T) { // Test that restarting a container with a volume does not create a new volume on restart. Regression test for #819. func TestRestartWithVolumes(t *testing.T) { - runtime := mkRuntime(t) - defer nuke(runtime) + daemon := mkDaemon(t) + defer nuke(daemon) - container, _, err := runtime.Create(&runconfig.Config{ - Image: GetTestImage(runtime).ID, + container, _, err := daemon.Create(&runconfig.Config{ + Image: GetTestImage(daemon).ID, Cmd: []string{"echo", "-n", "foobar"}, Volumes: map[string]struct{}{"/test": {}}, }, @@ -1288,7 +515,7 @@ func TestRestartWithVolumes(t *testing.T) { if err != nil { t.Fatal(err) } - defer runtime.Destroy(container) + defer daemon.Destroy(container) for key := range container.Config.Volumes { if key != "/test" { @@ -1316,139 +543,3 @@ func TestRestartWithVolumes(t *testing.T) { t.Fatalf("Expected volume path: %s Actual path: %s", expected, actual) } } - -func TestContainerNetwork(t *testing.T) { - runtime := mkRuntime(t) - defer nuke(runtime) - container, _, err := runtime.Create( - &runconfig.Config{ - Image: GetTestImage(runtime).ID, - // If I change this to ping 8.8.8.8 it fails. Any idea why? - timthelion - Cmd: []string{"ping", "-c", "1", "127.0.0.1"}, - }, - "", - ) - if err != nil { - t.Fatal(err) - } - defer runtime.Destroy(container) - if err := container.Run(); err != nil { - t.Fatal(err) - } - if code := container.State.GetExitCode(); code != 0 { - t.Fatalf("Unexpected ping 127.0.0.1 exit code %d (expected 0)", code) - } -} - -// Issue #4681 -func TestLoopbackFunctionsWhenNetworkingIsDissabled(t *testing.T) { - runtime := mkRuntime(t) - defer nuke(runtime) - container, _, err := runtime.Create( - &runconfig.Config{ - Image: GetTestImage(runtime).ID, - Cmd: []string{"ping", "-c", "1", "127.0.0.1"}, - NetworkDisabled: true, - }, - "", - ) - if err != nil { - t.Fatal(err) - } - defer runtime.Destroy(container) - if err := container.Run(); err != nil { - t.Fatal(err) - } - if code := container.State.GetExitCode(); code != 0 { - t.Fatalf("Unexpected ping 127.0.0.1 exit code %d (expected 0)", code) - } -} - -func TestOnlyLoopbackExistsWhenUsingDisableNetworkOption(t *testing.T) { - eng := NewTestEngine(t) - runtime := mkRuntimeFromEngine(eng, t) - defer nuke(runtime) - - config, hc, _, err := runconfig.Parse([]string{"-n=false", GetTestImage(runtime).ID, "ip", "addr", "show", "up"}, nil) - if err != nil { - t.Fatal(err) - } - - jobCreate := eng.Job("create") - if err := jobCreate.ImportEnv(config); err != nil { - t.Fatal(err) - } - var id string - jobCreate.Stdout.AddString(&id) - if err := jobCreate.Run(); err != nil { - t.Fatal(err) - } - // FIXME: this hack can be removed once Wait is a job - c := runtime.Get(id) - if c == nil { - t.Fatalf("Couldn't retrieve container %s from runtime", id) - } - stdout, err := c.StdoutPipe() - if err != nil { - t.Fatal(err) - } - - jobStart := eng.Job("start", id) - if err := jobStart.ImportEnv(hc); err != nil { - t.Fatal(err) - } - if err := jobStart.Run(); err != nil { - t.Fatal(err) - } - - c.WaitTimeout(500 * time.Millisecond) - c.Wait() - output, err := ioutil.ReadAll(stdout) - if err != nil { - t.Fatal(err) - } - - interfaces := regexp.MustCompile(`(?m)^[0-9]+: [a-zA-Z0-9]+`).FindAllString(string(output), -1) - if len(interfaces) != 1 { - t.Fatalf("Wrong interface count in test container: expected [*: lo], got %s", interfaces) - } - if !strings.HasSuffix(interfaces[0], ": lo") { - t.Fatalf("Wrong interface in test container: expected [*: lo], got %s", interfaces) - } -} - -func TestPrivilegedCanMknod(t *testing.T) { - eng := NewTestEngine(t) - runtime := mkRuntimeFromEngine(eng, t) - defer runtime.Nuke() - if output, err := runContainer(eng, runtime, []string{"--privileged", "_", "sh", "-c", "mknod /tmp/sda b 8 0 && echo ok"}, t); output != "ok\n" { - t.Fatalf("Could not mknod into privileged container %s %v", output, err) - } -} - -func TestPrivilegedCanMount(t *testing.T) { - eng := NewTestEngine(t) - runtime := mkRuntimeFromEngine(eng, t) - defer runtime.Nuke() - if output, _ := runContainer(eng, runtime, []string{"--privileged", "_", "sh", "-c", "mount -t tmpfs none /tmp && echo ok"}, t); output != "ok\n" { - t.Fatal("Could not mount into privileged container") - } -} - -func TestUnprivilegedCanMknod(t *testing.T) { - eng := NewTestEngine(t) - runtime := mkRuntimeFromEngine(eng, t) - defer runtime.Nuke() - if output, _ := runContainer(eng, runtime, []string{"_", "sh", "-c", "mknod /tmp/sda b 8 0 && echo ok"}, t); output != "ok\n" { - t.Fatal("Couldn't mknod into secure container") - } -} - -func TestUnprivilegedCannotMount(t *testing.T) { - eng := NewTestEngine(t) - runtime := mkRuntimeFromEngine(eng, t) - defer runtime.Nuke() - if output, _ := runContainer(eng, runtime, []string{"_", "sh", "-c", "mount -t tmpfs none /tmp || echo ok"}, t); output != "ok\n" { - t.Fatal("Could mount into secure container") - } -} diff --git a/integration/graph_test.go b/integration/graph_test.go index 5602b3938d..a7a8137284 100644 --- a/integration/graph_test.go +++ b/integration/graph_test.go @@ -3,10 +3,10 @@ package docker import ( "errors" "github.com/dotcloud/docker/archive" + "github.com/dotcloud/docker/daemon/graphdriver" "github.com/dotcloud/docker/dockerversion" "github.com/dotcloud/docker/graph" "github.com/dotcloud/docker/image" - "github.com/dotcloud/docker/runtime/graphdriver" "github.com/dotcloud/docker/utils" "io" "io/ioutil" diff --git a/integration/iptables_test.go b/integration/iptables_test.go deleted file mode 100644 index 1dd4194350..0000000000 --- a/integration/iptables_test.go +++ /dev/null @@ -1,22 +0,0 @@ -package docker - -import ( - "github.com/dotcloud/docker/pkg/iptables" - "os" - "testing" -) - -// FIXME: this test should be a unit test. -// For example by mocking os/exec to make sure iptables is not actually called. - -func TestIptables(t *testing.T) { - if _, err := iptables.Raw("-L"); err != nil { - t.Fatal(err) - } - path := os.Getenv("PATH") - os.Setenv("PATH", "") - defer os.Setenv("PATH", path) - if _, err := iptables.Raw("-L"); err == nil { - t.Fatal("Not finding iptables in the PATH should cause an error") - } -} diff --git a/integration/runtime_test.go b/integration/runtime_test.go index 6058d8f3e8..38b3277afd 100644 --- a/integration/runtime_test.go +++ b/integration/runtime_test.go @@ -3,11 +3,11 @@ package docker import ( "bytes" "fmt" + "github.com/dotcloud/docker/daemon" "github.com/dotcloud/docker/engine" "github.com/dotcloud/docker/image" "github.com/dotcloud/docker/nat" "github.com/dotcloud/docker/runconfig" - "github.com/dotcloud/docker/runtime" "github.com/dotcloud/docker/sysinit" "github.com/dotcloud/docker/utils" "io" @@ -38,8 +38,8 @@ const ( ) var ( - // FIXME: globalRuntime is deprecated by globalEngine. All tests should be converted. - globalRuntime *runtime.Runtime + // FIXME: globalDaemon is deprecated by globalEngine. All tests should be converted. + globalDaemon *daemon.Daemon globalEngine *engine.Engine globalHttpsEngine *engine.Engine globalRogueHttpsEngine *engine.Engine @@ -47,17 +47,17 @@ var ( startGoroutines int ) -// FIXME: nuke() is deprecated by Runtime.Nuke() -func nuke(runtime *runtime.Runtime) error { - return runtime.Nuke() +// FIXME: nuke() is deprecated by Daemon.Nuke() +func nuke(daemon *daemon.Daemon) error { + return daemon.Nuke() } // FIXME: cleanup and nuke are redundant. func cleanup(eng *engine.Engine, t *testing.T) error { - runtime := mkRuntimeFromEngine(eng, t) - for _, container := range runtime.List() { + daemon := mkDaemonFromEngine(eng, t) + for _, container := range daemon.List() { container.Kill() - runtime.Destroy(container) + daemon.Destroy(container) } job := eng.Job("images") images, err := job.Stdout.AddTable() @@ -119,11 +119,11 @@ func init() { src.Close() } - // Setup the base runtime, which will be duplicated for each test. + // Setup the base daemon, which will be duplicated for each test. // (no tests are run directly in the base) setupBaseImage() - // Create the "global runtime" with a long-running daemons for integration tests + // Create the "global daemon" with a long-running daemons for integration tests spawnGlobalDaemon() spawnLegitHttpsDaemon() spawnRogueHttpsDaemon() @@ -146,14 +146,14 @@ func setupBaseImage() { } func spawnGlobalDaemon() { - if globalRuntime != nil { - utils.Debugf("Global runtime already exists. Skipping.") + if globalDaemon != nil { + utils.Debugf("Global daemon already exists. Skipping.") return } t := log.New(os.Stderr, "", 0) eng := NewTestEngine(t) globalEngine = eng - globalRuntime = mkRuntimeFromEngine(eng, t) + globalDaemon = mkDaemonFromEngine(eng, t) // Spawn a Daemon go func() { @@ -235,8 +235,8 @@ func spawnHttpsDaemon(addr, cacert, cert, key string) *engine.Engine { // FIXME: test that ImagePull(json=true) send correct json output -func GetTestImage(runtime *runtime.Runtime) *image.Image { - imgs, err := runtime.Graph().Map() +func GetTestImage(daemon *daemon.Daemon) *image.Image { + imgs, err := daemon.Graph().Map() if err != nil { log.Fatalf("Unable to get the test image: %s", err) } @@ -245,21 +245,21 @@ func GetTestImage(runtime *runtime.Runtime) *image.Image { return image } } - log.Fatalf("Test image %v not found in %s: %s", unitTestImageID, runtime.Graph().Root, imgs) + log.Fatalf("Test image %v not found in %s: %s", unitTestImageID, daemon.Graph().Root, imgs) return nil } -func TestRuntimeCreate(t *testing.T) { - runtime := mkRuntime(t) - defer nuke(runtime) +func TestDaemonCreate(t *testing.T) { + daemon := mkDaemon(t) + defer nuke(daemon) // Make sure we start we 0 containers - if len(runtime.List()) != 0 { - t.Errorf("Expected 0 containers, %v found", len(runtime.List())) + if len(daemon.List()) != 0 { + t.Errorf("Expected 0 containers, %v found", len(daemon.List())) } - container, _, err := runtime.Create(&runconfig.Config{ - Image: GetTestImage(runtime).ID, + container, _, err := daemon.Create(&runconfig.Config{ + Image: GetTestImage(daemon).ID, Cmd: []string{"ls", "-al"}, }, "", @@ -269,56 +269,56 @@ func TestRuntimeCreate(t *testing.T) { } defer func() { - if err := runtime.Destroy(container); err != nil { + if err := daemon.Destroy(container); err != nil { t.Error(err) } }() // Make sure we can find the newly created container with List() - if len(runtime.List()) != 1 { - t.Errorf("Expected 1 container, %v found", len(runtime.List())) + if len(daemon.List()) != 1 { + t.Errorf("Expected 1 container, %v found", len(daemon.List())) } // Make sure the container List() returns is the right one - if runtime.List()[0].ID != container.ID { - t.Errorf("Unexpected container %v returned by List", runtime.List()[0]) + if daemon.List()[0].ID != container.ID { + t.Errorf("Unexpected container %v returned by List", daemon.List()[0]) } // Make sure we can get the container with Get() - if runtime.Get(container.ID) == nil { + if daemon.Get(container.ID) == nil { t.Errorf("Unable to get newly created container") } // Make sure it is the right container - if runtime.Get(container.ID) != container { + if daemon.Get(container.ID) != container { t.Errorf("Get() returned the wrong container") } // Make sure Exists returns it as existing - if !runtime.Exists(container.ID) { + if !daemon.Exists(container.ID) { t.Errorf("Exists() returned false for a newly created container") } // Test that conflict error displays correct details - testContainer, _, _ := runtime.Create( + testContainer, _, _ := daemon.Create( &runconfig.Config{ - Image: GetTestImage(runtime).ID, + Image: GetTestImage(daemon).ID, Cmd: []string{"ls", "-al"}, }, "conflictname", ) - if _, _, err := runtime.Create(&runconfig.Config{Image: GetTestImage(runtime).ID, Cmd: []string{"ls", "-al"}}, testContainer.Name); err == nil || !strings.Contains(err.Error(), utils.TruncateID(testContainer.ID)) { + if _, _, err := daemon.Create(&runconfig.Config{Image: GetTestImage(daemon).ID, Cmd: []string{"ls", "-al"}}, testContainer.Name); err == nil || !strings.Contains(err.Error(), utils.TruncateID(testContainer.ID)) { t.Fatalf("Name conflict error doesn't include the correct short id. Message was: %s", err.Error()) } // Make sure create with bad parameters returns an error - if _, _, err = runtime.Create(&runconfig.Config{Image: GetTestImage(runtime).ID}, ""); err == nil { + if _, _, err = daemon.Create(&runconfig.Config{Image: GetTestImage(daemon).ID}, ""); err == nil { t.Fatal("Builder.Create should throw an error when Cmd is missing") } - if _, _, err := runtime.Create( + if _, _, err := daemon.Create( &runconfig.Config{ - Image: GetTestImage(runtime).ID, + Image: GetTestImage(daemon).ID, Cmd: []string{}, }, "", @@ -327,20 +327,20 @@ func TestRuntimeCreate(t *testing.T) { } config := &runconfig.Config{ - Image: GetTestImage(runtime).ID, + Image: GetTestImage(daemon).ID, Cmd: []string{"/bin/ls"}, PortSpecs: []string{"80"}, } - container, _, err = runtime.Create(config, "") + container, _, err = daemon.Create(config, "") - _, err = runtime.Commit(container, "testrepo", "testtag", "", "", config) + _, err = daemon.Commit(container, "testrepo", "testtag", "", "", config) if err != nil { t.Error(err) } // test expose 80:8000 - container, warnings, err := runtime.Create(&runconfig.Config{ - Image: GetTestImage(runtime).ID, + container, warnings, err := daemon.Create(&runconfig.Config{ + Image: GetTestImage(daemon).ID, Cmd: []string{"ls", "-al"}, PortSpecs: []string{"80:8000"}, }, @@ -355,83 +355,83 @@ func TestRuntimeCreate(t *testing.T) { } func TestDestroy(t *testing.T) { - runtime := mkRuntime(t) - defer nuke(runtime) + daemon := mkDaemon(t) + defer nuke(daemon) - container, _, err := runtime.Create(&runconfig.Config{ - Image: GetTestImage(runtime).ID, + container, _, err := daemon.Create(&runconfig.Config{ + Image: GetTestImage(daemon).ID, Cmd: []string{"ls", "-al"}, }, "") if err != nil { t.Fatal(err) } // Destroy - if err := runtime.Destroy(container); err != nil { + if err := daemon.Destroy(container); err != nil { t.Error(err) } - // Make sure runtime.Exists() behaves correctly - if runtime.Exists("test_destroy") { + // Make sure daemon.Exists() behaves correctly + if daemon.Exists("test_destroy") { t.Errorf("Exists() returned true") } - // Make sure runtime.List() doesn't list the destroyed container - if len(runtime.List()) != 0 { - t.Errorf("Expected 0 container, %v found", len(runtime.List())) + // Make sure daemon.List() doesn't list the destroyed container + if len(daemon.List()) != 0 { + t.Errorf("Expected 0 container, %v found", len(daemon.List())) } - // Make sure runtime.Get() refuses to return the unexisting container - if runtime.Get(container.ID) != nil { + // Make sure daemon.Get() refuses to return the unexisting container + if daemon.Get(container.ID) != nil { t.Errorf("Unable to get newly created container") } // Test double destroy - if err := runtime.Destroy(container); err == nil { + if err := daemon.Destroy(container); err == nil { // It should have failed t.Errorf("Double destroy did not fail") } } func TestGet(t *testing.T) { - runtime := mkRuntime(t) - defer nuke(runtime) + daemon := mkDaemon(t) + defer nuke(daemon) - container1, _, _ := mkContainer(runtime, []string{"_", "ls", "-al"}, t) - defer runtime.Destroy(container1) + container1, _, _ := mkContainer(daemon, []string{"_", "ls", "-al"}, t) + defer daemon.Destroy(container1) - container2, _, _ := mkContainer(runtime, []string{"_", "ls", "-al"}, t) - defer runtime.Destroy(container2) + container2, _, _ := mkContainer(daemon, []string{"_", "ls", "-al"}, t) + defer daemon.Destroy(container2) - container3, _, _ := mkContainer(runtime, []string{"_", "ls", "-al"}, t) - defer runtime.Destroy(container3) + container3, _, _ := mkContainer(daemon, []string{"_", "ls", "-al"}, t) + defer daemon.Destroy(container3) - if runtime.Get(container1.ID) != container1 { - t.Errorf("Get(test1) returned %v while expecting %v", runtime.Get(container1.ID), container1) + if daemon.Get(container1.ID) != container1 { + t.Errorf("Get(test1) returned %v while expecting %v", daemon.Get(container1.ID), container1) } - if runtime.Get(container2.ID) != container2 { - t.Errorf("Get(test2) returned %v while expecting %v", runtime.Get(container2.ID), container2) + if daemon.Get(container2.ID) != container2 { + t.Errorf("Get(test2) returned %v while expecting %v", daemon.Get(container2.ID), container2) } - if runtime.Get(container3.ID) != container3 { - t.Errorf("Get(test3) returned %v while expecting %v", runtime.Get(container3.ID), container3) + if daemon.Get(container3.ID) != container3 { + t.Errorf("Get(test3) returned %v while expecting %v", daemon.Get(container3.ID), container3) } } -func startEchoServerContainer(t *testing.T, proto string) (*runtime.Runtime, *runtime.Container, string) { +func startEchoServerContainer(t *testing.T, proto string) (*daemon.Daemon, *daemon.Container, string) { var ( err error id string strPort string eng = NewTestEngine(t) - runtime = mkRuntimeFromEngine(eng, t) + daemon = mkDaemonFromEngine(eng, t) port = 5554 p nat.Port ) defer func() { if err != nil { - runtime.Nuke() + daemon.Nuke() } }() @@ -459,7 +459,7 @@ func startEchoServerContainer(t *testing.T, proto string) (*runtime.Runtime, *ru if err := jobCreate.Run(); err != nil { t.Fatal(err) } - // FIXME: this relies on the undocumented behavior of runtime.Create + // FIXME: this relies on the undocumented behavior of daemon.Create // which will return a nil error AND container if the exposed ports // are invalid. That behavior should be fixed! if id != "" { @@ -481,7 +481,7 @@ func startEchoServerContainer(t *testing.T, proto string) (*runtime.Runtime, *ru t.Fatal(err) } - container := runtime.Get(id) + container := daemon.Get(id) if container == nil { t.Fatalf("Couldn't fetch test container %s", id) } @@ -496,13 +496,13 @@ func startEchoServerContainer(t *testing.T, proto string) (*runtime.Runtime, *ru container.WaitTimeout(500 * time.Millisecond) strPort = container.NetworkSettings.Ports[p][0].HostPort - return runtime, container, strPort + return daemon, container, strPort } // Run a container with a TCP port allocated, and test that it can receive connections on localhost func TestAllocateTCPPortLocalhost(t *testing.T) { - runtime, container, port := startEchoServerContainer(t, "tcp") - defer nuke(runtime) + daemon, container, port := startEchoServerContainer(t, "tcp") + defer nuke(daemon) defer container.Kill() for i := 0; i != 10; i++ { @@ -550,8 +550,8 @@ func TestAllocateTCPPortLocalhost(t *testing.T) { // Run a container with an UDP port allocated, and test that it can receive connections on localhost func TestAllocateUDPPortLocalhost(t *testing.T) { - runtime, container, port := startEchoServerContainer(t, "udp") - defer nuke(runtime) + daemon, container, port := startEchoServerContainer(t, "udp") + defer nuke(daemon) defer container.Kill() conn, err := net.Dial("udp", fmt.Sprintf("localhost:%v", port)) @@ -586,15 +586,15 @@ func TestAllocateUDPPortLocalhost(t *testing.T) { func TestRestore(t *testing.T) { eng := NewTestEngine(t) - runtime1 := mkRuntimeFromEngine(eng, t) - defer runtime1.Nuke() + daemon1 := mkDaemonFromEngine(eng, t) + defer daemon1.Nuke() // Create a container with one instance of docker - container1, _, _ := mkContainer(runtime1, []string{"_", "ls", "-al"}, t) - defer runtime1.Destroy(container1) + container1, _, _ := mkContainer(daemon1, []string{"_", "ls", "-al"}, t) + defer daemon1.Destroy(container1) // Create a second container meant to be killed - container2, _, _ := mkContainer(runtime1, []string{"-i", "_", "/bin/cat"}, t) - defer runtime1.Destroy(container2) + container2, _, _ := mkContainer(daemon1, []string{"-i", "_", "/bin/cat"}, t) + defer daemon1.Destroy(container2) // Start the container non blocking if err := container2.Start(); err != nil { @@ -614,8 +614,8 @@ func TestRestore(t *testing.T) { container2.State.SetRunning(42) container2.ToDisk() - if len(runtime1.List()) != 2 { - t.Errorf("Expected 2 container, %v found", len(runtime1.List())) + if len(daemon1.List()) != 2 { + t.Errorf("Expected 2 container, %v found", len(daemon1.List())) } if err := container1.Run(); err != nil { t.Fatal(err) @@ -628,12 +628,12 @@ func TestRestore(t *testing.T) { // Here are are simulating a docker restart - that is, reloading all containers // from scratch eng = newTestEngine(t, false, eng.Root()) - runtime2 := mkRuntimeFromEngine(eng, t) - if len(runtime2.List()) != 2 { - t.Errorf("Expected 2 container, %v found", len(runtime2.List())) + daemon2 := mkDaemonFromEngine(eng, t) + if len(daemon2.List()) != 2 { + t.Errorf("Expected 2 container, %v found", len(daemon2.List())) } runningCount := 0 - for _, c := range runtime2.List() { + for _, c := range daemon2.List() { if c.State.IsRunning() { t.Errorf("Running container found: %v (%v)", c.ID, c.Path) runningCount++ @@ -642,7 +642,7 @@ func TestRestore(t *testing.T) { if runningCount != 0 { t.Fatalf("Expected 0 container alive, %d found", runningCount) } - container3 := runtime2.Get(container1.ID) + container3 := daemon2.Get(container1.ID) if container3 == nil { t.Fatal("Unable to Get container") } @@ -654,22 +654,22 @@ func TestRestore(t *testing.T) { func TestDefaultContainerName(t *testing.T) { eng := NewTestEngine(t) - runtime := mkRuntimeFromEngine(eng, t) - defer nuke(runtime) + daemon := mkDaemonFromEngine(eng, t) + defer nuke(daemon) config, _, _, err := runconfig.Parse([]string{unitTestImageID, "echo test"}, nil) if err != nil { t.Fatal(err) } - container := runtime.Get(createNamedTestContainer(eng, config, t, "some_name")) + container := daemon.Get(createNamedTestContainer(eng, config, t, "some_name")) containerID := container.ID if container.Name != "/some_name" { t.Fatalf("Expect /some_name got %s", container.Name) } - if c := runtime.Get("/some_name"); c == nil { + if c := daemon.Get("/some_name"); c == nil { t.Fatalf("Couldn't retrieve test container as /some_name") } else if c.ID != containerID { t.Fatalf("Container /some_name has ID %s instead of %s", c.ID, containerID) @@ -678,22 +678,22 @@ func TestDefaultContainerName(t *testing.T) { func TestRandomContainerName(t *testing.T) { eng := NewTestEngine(t) - runtime := mkRuntimeFromEngine(eng, t) - defer nuke(runtime) + daemon := mkDaemonFromEngine(eng, t) + defer nuke(daemon) - config, _, _, err := runconfig.Parse([]string{GetTestImage(runtime).ID, "echo test"}, nil) + config, _, _, err := runconfig.Parse([]string{GetTestImage(daemon).ID, "echo test"}, nil) if err != nil { t.Fatal(err) } - container := runtime.Get(createTestContainer(eng, config, t)) + container := daemon.Get(createTestContainer(eng, config, t)) containerID := container.ID if container.Name == "" { t.Fatalf("Expected not empty container name") } - if c := runtime.Get(container.Name); c == nil { + if c := daemon.Get(container.Name); c == nil { log.Fatalf("Could not lookup container %s by its name", container.Name) } else if c.ID != containerID { log.Fatalf("Looking up container name %s returned id %s instead of %s", container.Name, c.ID, containerID) @@ -702,8 +702,8 @@ func TestRandomContainerName(t *testing.T) { func TestContainerNameValidation(t *testing.T) { eng := NewTestEngine(t) - runtime := mkRuntimeFromEngine(eng, t) - defer nuke(runtime) + daemon := mkDaemonFromEngine(eng, t) + defer nuke(daemon) for _, test := range []struct { Name string @@ -733,13 +733,13 @@ func TestContainerNameValidation(t *testing.T) { t.Fatal(err) } - container := runtime.Get(shortID) + container := daemon.Get(shortID) if container.Name != "/"+test.Name { t.Fatalf("Expect /%s got %s", test.Name, container.Name) } - if c := runtime.Get("/" + test.Name); c == nil { + if c := daemon.Get("/" + test.Name); c == nil { t.Fatalf("Couldn't retrieve test container as /%s", test.Name) } else if c.ID != container.ID { t.Fatalf("Container /%s has ID %s instead of %s", test.Name, c.ID, container.ID) @@ -750,17 +750,17 @@ func TestContainerNameValidation(t *testing.T) { func TestLinkChildContainer(t *testing.T) { eng := NewTestEngine(t) - runtime := mkRuntimeFromEngine(eng, t) - defer nuke(runtime) + daemon := mkDaemonFromEngine(eng, t) + defer nuke(daemon) config, _, _, err := runconfig.Parse([]string{unitTestImageID, "echo test"}, nil) if err != nil { t.Fatal(err) } - container := runtime.Get(createNamedTestContainer(eng, config, t, "/webapp")) + container := daemon.Get(createNamedTestContainer(eng, config, t, "/webapp")) - webapp, err := runtime.GetByName("/webapp") + webapp, err := daemon.GetByName("/webapp") if err != nil { t.Fatal(err) } @@ -769,19 +769,19 @@ func TestLinkChildContainer(t *testing.T) { t.Fatalf("Expect webapp id to match container id: %s != %s", webapp.ID, container.ID) } - config, _, _, err = runconfig.Parse([]string{GetTestImage(runtime).ID, "echo test"}, nil) + config, _, _, err = runconfig.Parse([]string{GetTestImage(daemon).ID, "echo test"}, nil) if err != nil { t.Fatal(err) } - childContainer := runtime.Get(createTestContainer(eng, config, t)) + childContainer := daemon.Get(createTestContainer(eng, config, t)) - if err := runtime.RegisterLink(webapp, childContainer, "db"); err != nil { + if err := daemon.RegisterLink(webapp, childContainer, "db"); err != nil { t.Fatal(err) } // Get the child by it's new name - db, err := runtime.GetByName("/webapp/db") + db, err := daemon.GetByName("/webapp/db") if err != nil { t.Fatal(err) } @@ -792,17 +792,17 @@ func TestLinkChildContainer(t *testing.T) { func TestGetAllChildren(t *testing.T) { eng := NewTestEngine(t) - runtime := mkRuntimeFromEngine(eng, t) - defer nuke(runtime) + daemon := mkDaemonFromEngine(eng, t) + defer nuke(daemon) config, _, _, err := runconfig.Parse([]string{unitTestImageID, "echo test"}, nil) if err != nil { t.Fatal(err) } - container := runtime.Get(createNamedTestContainer(eng, config, t, "/webapp")) + container := daemon.Get(createNamedTestContainer(eng, config, t, "/webapp")) - webapp, err := runtime.GetByName("/webapp") + webapp, err := daemon.GetByName("/webapp") if err != nil { t.Fatal(err) } @@ -816,13 +816,13 @@ func TestGetAllChildren(t *testing.T) { t.Fatal(err) } - childContainer := runtime.Get(createTestContainer(eng, config, t)) + childContainer := daemon.Get(createTestContainer(eng, config, t)) - if err := runtime.RegisterLink(webapp, childContainer, "db"); err != nil { + if err := daemon.RegisterLink(webapp, childContainer, "db"); err != nil { t.Fatal(err) } - children, err := runtime.Children("/webapp") + children, err := daemon.Children("/webapp") if err != nil { t.Fatal(err) } @@ -845,11 +845,11 @@ func TestGetAllChildren(t *testing.T) { } func TestDestroyWithInitLayer(t *testing.T) { - runtime := mkRuntime(t) - defer nuke(runtime) + daemon := mkDaemon(t) + defer nuke(daemon) - container, _, err := runtime.Create(&runconfig.Config{ - Image: GetTestImage(runtime).ID, + container, _, err := daemon.Create(&runconfig.Config{ + Image: GetTestImage(daemon).ID, Cmd: []string{"ls", "-al"}, }, "") @@ -857,21 +857,21 @@ func TestDestroyWithInitLayer(t *testing.T) { t.Fatal(err) } // Destroy - if err := runtime.Destroy(container); err != nil { + if err := daemon.Destroy(container); err != nil { t.Fatal(err) } - // Make sure runtime.Exists() behaves correctly - if runtime.Exists("test_destroy") { + // Make sure daemon.Exists() behaves correctly + if daemon.Exists("test_destroy") { t.Fatalf("Exists() returned true") } - // Make sure runtime.List() doesn't list the destroyed container - if len(runtime.List()) != 0 { - t.Fatalf("Expected 0 container, %v found", len(runtime.List())) + // Make sure daemon.List() doesn't list the destroyed container + if len(daemon.List()) != 0 { + t.Fatalf("Expected 0 container, %v found", len(daemon.List())) } - driver := runtime.Graph().Driver() + driver := daemon.Graph().Driver() // Make sure that the container does not exist in the driver if _, err := driver.Get(container.ID); err == nil { diff --git a/integration/server_test.go b/integration/server_test.go index 9137e8031b..cb3063ded7 100644 --- a/integration/server_test.go +++ b/integration/server_test.go @@ -9,56 +9,9 @@ import ( "time" ) -func TestCreateRm(t *testing.T) { - eng := NewTestEngine(t) - defer mkRuntimeFromEngine(eng, t).Nuke() - - config, _, _, err := runconfig.Parse([]string{unitTestImageID, "echo test"}, nil) - if err != nil { - t.Fatal(err) - } - - id := createTestContainer(eng, config, t) - - job := eng.Job("containers") - job.SetenvBool("all", true) - outs, err := job.Stdout.AddListTable() - if err != nil { - t.Fatal(err) - } - if err := job.Run(); err != nil { - t.Fatal(err) - } - - if len(outs.Data) != 1 { - t.Errorf("Expected 1 container, %v found", len(outs.Data)) - } - - job = eng.Job("container_delete", id) - job.SetenvBool("removeVolume", true) - if err := job.Run(); err != nil { - t.Fatal(err) - } - - job = eng.Job("containers") - job.SetenvBool("all", true) - outs, err = job.Stdout.AddListTable() - if err != nil { - t.Fatal(err) - } - if err := job.Run(); err != nil { - t.Fatal(err) - } - - if len(outs.Data) != 0 { - t.Errorf("Expected 0 container, %v found", len(outs.Data)) - } - -} - func TestCreateNumberHostname(t *testing.T) { eng := NewTestEngine(t) - defer mkRuntimeFromEngine(eng, t).Nuke() + defer mkDaemonFromEngine(eng, t).Nuke() config, _, _, err := runconfig.Parse([]string{"-h", "web.0", unitTestImageID, "echo test"}, nil) if err != nil { @@ -70,7 +23,7 @@ func TestCreateNumberHostname(t *testing.T) { func TestCreateNumberUsername(t *testing.T) { eng := NewTestEngine(t) - defer mkRuntimeFromEngine(eng, t).Nuke() + defer mkDaemonFromEngine(eng, t).Nuke() config, _, _, err := runconfig.Parse([]string{"-u", "1002", unitTestImageID, "echo test"}, nil) if err != nil { @@ -80,143 +33,9 @@ func TestCreateNumberUsername(t *testing.T) { createTestContainer(eng, config, t) } -func TestCreateRmVolumes(t *testing.T) { - eng := NewTestEngine(t) - defer mkRuntimeFromEngine(eng, t).Nuke() - - config, hostConfig, _, err := runconfig.Parse([]string{"-v", "/srv", unitTestImageID, "echo", "test"}, nil) - if err != nil { - t.Fatal(err) - } - - id := createTestContainer(eng, config, t) - - job := eng.Job("containers") - job.SetenvBool("all", true) - outs, err := job.Stdout.AddListTable() - if err != nil { - t.Fatal(err) - } - if err := job.Run(); err != nil { - t.Fatal(err) - } - - if len(outs.Data) != 1 { - t.Errorf("Expected 1 container, %v found", len(outs.Data)) - } - - job = eng.Job("start", id) - if err := job.ImportEnv(hostConfig); err != nil { - t.Fatal(err) - } - if err := job.Run(); err != nil { - t.Fatal(err) - } - - job = eng.Job("stop", id) - job.SetenvInt("t", 1) - if err := job.Run(); err != nil { - t.Fatal(err) - } - - job = eng.Job("container_delete", id) - job.SetenvBool("removeVolume", true) - if err := job.Run(); err != nil { - t.Fatal(err) - } - - job = eng.Job("containers") - job.SetenvBool("all", true) - outs, err = job.Stdout.AddListTable() - if err != nil { - t.Fatal(err) - } - if err := job.Run(); err != nil { - t.Fatal(err) - } - - if len(outs.Data) != 0 { - t.Errorf("Expected 0 container, %v found", len(outs.Data)) - } -} - -func TestCreateRmRunning(t *testing.T) { - eng := NewTestEngine(t) - defer mkRuntimeFromEngine(eng, t).Nuke() - - config, hostConfig, _, err := runconfig.Parse([]string{"--name", "foo", unitTestImageID, "sleep 300"}, nil) - if err != nil { - t.Fatal(err) - } - - id := createTestContainer(eng, config, t) - - job := eng.Job("start", id) - if err := job.ImportEnv(hostConfig); err != nil { - t.Fatal(err) - } - if err := job.Run(); err != nil { - t.Fatal(err) - } - - job = eng.Job("containers") - outs, err := job.Stdout.AddListTable() - if err != nil { - t.Fatal(err) - } - if err := job.Run(); err != nil { - t.Fatal(err) - } - - if len(outs.Data) != 1 { - t.Errorf("Expected 1 container, %v found", len(outs.Data)) - } - - // Test cannot remove running container - job = eng.Job("container_delete", id) - job.SetenvBool("forceRemove", false) - if err := job.Run(); err == nil { - t.Fatal("Expected container delete to fail") - } - - job = eng.Job("containers") - outs, err = job.Stdout.AddListTable() - if err != nil { - t.Fatal(err) - } - if err := job.Run(); err != nil { - t.Fatal(err) - } - - if len(outs.Data) != 1 { - t.Errorf("Expected 1 container, %v found", len(outs.Data)) - } - - // Test can force removal of running container - job = eng.Job("container_delete", id) - job.SetenvBool("forceRemove", true) - if err := job.Run(); err != nil { - t.Fatal(err) - } - - job = eng.Job("containers") - job.SetenvBool("all", true) - outs, err = job.Stdout.AddListTable() - if err != nil { - t.Fatal(err) - } - if err := job.Run(); err != nil { - t.Fatal(err) - } - - if len(outs.Data) != 0 { - t.Errorf("Expected 0 container, %v found", len(outs.Data)) - } -} - func TestCommit(t *testing.T) { eng := NewTestEngine(t) - defer mkRuntimeFromEngine(eng, t).Nuke() + defer mkDaemonFromEngine(eng, t).Nuke() config, _, _, err := runconfig.Parse([]string{unitTestImageID, "/bin/cat"}, nil) if err != nil { @@ -236,7 +55,7 @@ func TestCommit(t *testing.T) { func TestMergeConfigOnCommit(t *testing.T) { eng := NewTestEngine(t) - runtime := mkRuntimeFromEngine(eng, t) + runtime := mkDaemonFromEngine(eng, t) defer runtime.Nuke() container1, _, _ := mkContainer(runtime, []string{"-e", "FOO=bar", unitTestImageID, "echo test > /tmp/foo"}, t) @@ -294,7 +113,7 @@ func TestMergeConfigOnCommit(t *testing.T) { func TestRestartKillWait(t *testing.T) { eng := NewTestEngine(t) srv := mkServerFromEngine(eng, t) - runtime := mkRuntimeFromEngine(eng, t) + runtime := mkDaemonFromEngine(eng, t) defer runtime.Nuke() config, hostConfig, _, err := runconfig.Parse([]string{"-i", unitTestImageID, "/bin/cat"}, nil) @@ -360,7 +179,7 @@ func TestRestartKillWait(t *testing.T) { func TestCreateStartRestartStopStartKillRm(t *testing.T) { eng := NewTestEngine(t) srv := mkServerFromEngine(eng, t) - defer mkRuntimeFromEngine(eng, t).Nuke() + defer mkDaemonFromEngine(eng, t).Nuke() config, hostConfig, _, err := runconfig.Parse([]string{"-i", unitTestImageID, "/bin/cat"}, nil) if err != nil { @@ -439,7 +258,7 @@ func TestCreateStartRestartStopStartKillRm(t *testing.T) { func TestRunWithTooLowMemoryLimit(t *testing.T) { eng := NewTestEngine(t) - defer mkRuntimeFromEngine(eng, t).Nuke() + defer mkDaemonFromEngine(eng, t).Nuke() // Try to create a container with a memory limit of 1 byte less than the minimum allowed limit. job := eng.Job("create") @@ -457,7 +276,7 @@ func TestRunWithTooLowMemoryLimit(t *testing.T) { func TestRmi(t *testing.T) { eng := NewTestEngine(t) srv := mkServerFromEngine(eng, t) - defer mkRuntimeFromEngine(eng, t).Nuke() + defer mkDaemonFromEngine(eng, t).Nuke() initialImages := getAllImages(eng, t) @@ -542,7 +361,7 @@ func TestRmi(t *testing.T) { func TestImagesFilter(t *testing.T) { eng := NewTestEngine(t) - defer nuke(mkRuntimeFromEngine(eng, t)) + defer nuke(mkDaemonFromEngine(eng, t)) if err := eng.Job("tag", unitTestImageName, "utest", "tag1").Run(); err != nil { t.Fatal(err) @@ -584,7 +403,7 @@ func TestImagesFilter(t *testing.T) { // FIXE: 'insert' is deprecated and should be removed in a future version. func TestImageInsert(t *testing.T) { eng := NewTestEngine(t) - defer mkRuntimeFromEngine(eng, t).Nuke() + defer mkDaemonFromEngine(eng, t).Nuke() srv := mkServerFromEngine(eng, t) // bad image name fails @@ -606,7 +425,7 @@ func TestImageInsert(t *testing.T) { func TestListContainers(t *testing.T) { eng := NewTestEngine(t) srv := mkServerFromEngine(eng, t) - defer mkRuntimeFromEngine(eng, t).Nuke() + defer mkDaemonFromEngine(eng, t).Nuke() config := runconfig.Config{ Image: unitTestImageID, @@ -721,7 +540,7 @@ func assertContainerList(srv *server.Server, all bool, limit int, since, before // container func TestDeleteTagWithExistingContainers(t *testing.T) { eng := NewTestEngine(t) - defer nuke(mkRuntimeFromEngine(eng, t)) + defer nuke(mkDaemonFromEngine(eng, t)) srv := mkServerFromEngine(eng, t) diff --git a/integration/sorter_test.go b/integration/sorter_test.go index 3ce1225ca4..610fe9b3ab 100644 --- a/integration/sorter_test.go +++ b/integration/sorter_test.go @@ -8,7 +8,7 @@ import ( func TestServerListOrderedImagesByCreationDate(t *testing.T) { eng := NewTestEngine(t) - defer mkRuntimeFromEngine(eng, t).Nuke() + defer mkDaemonFromEngine(eng, t).Nuke() if err := generateImage("", eng); err != nil { t.Fatal(err) @@ -23,7 +23,7 @@ func TestServerListOrderedImagesByCreationDate(t *testing.T) { func TestServerListOrderedImagesByCreationDateAndTag(t *testing.T) { eng := NewTestEngine(t) - defer mkRuntimeFromEngine(eng, t).Nuke() + defer mkDaemonFromEngine(eng, t).Nuke() err := generateImage("bar", eng) if err != nil { diff --git a/integration/utils_test.go b/integration/utils_test.go index 8ad6ccb123..ab9ca5b72d 100644 --- a/integration/utils_test.go +++ b/integration/utils_test.go @@ -15,9 +15,9 @@ import ( "time" "github.com/dotcloud/docker/builtins" + "github.com/dotcloud/docker/daemon" "github.com/dotcloud/docker/engine" "github.com/dotcloud/docker/runconfig" - "github.com/dotcloud/docker/runtime" "github.com/dotcloud/docker/server" "github.com/dotcloud/docker/utils" ) @@ -26,11 +26,11 @@ import ( // It has to be named XXX_test.go, apparently, in other to access private functions // from other XXX_test.go functions. -// Create a temporary runtime suitable for unit testing. +// Create a temporary daemon suitable for unit testing. // Call t.Fatal() at the first error. -func mkRuntime(f utils.Fataler) *runtime.Runtime { +func mkDaemon(f utils.Fataler) *daemon.Daemon { eng := newTestEngine(f, false, "") - return mkRuntimeFromEngine(eng, f) + return mkDaemonFromEngine(eng, f) // FIXME: // [...] // Mtu: docker.GetDefaultNetworkMtu(), @@ -116,8 +116,8 @@ func containerAssertExists(eng *engine.Engine, id string, t utils.Fataler) { } func containerAssertNotExists(eng *engine.Engine, id string, t utils.Fataler) { - runtime := mkRuntimeFromEngine(eng, t) - if c := runtime.Get(id); c != nil { + daemon := mkDaemonFromEngine(eng, t) + if c := daemon.Get(id); c != nil { t.Fatal(fmt.Errorf("Container %s should not exist", id)) } } @@ -140,9 +140,9 @@ func assertHttpError(r *httptest.ResponseRecorder, t utils.Fataler) { } } -func getContainer(eng *engine.Engine, id string, t utils.Fataler) *runtime.Container { - runtime := mkRuntimeFromEngine(eng, t) - c := runtime.Get(id) +func getContainer(eng *engine.Engine, id string, t utils.Fataler) *daemon.Container { + daemon := mkDaemonFromEngine(eng, t) + c := daemon.Get(id) if c == nil { t.Fatal(fmt.Errorf("No such container: %s", id)) } @@ -161,16 +161,16 @@ func mkServerFromEngine(eng *engine.Engine, t utils.Fataler) *server.Server { return srv } -func mkRuntimeFromEngine(eng *engine.Engine, t utils.Fataler) *runtime.Runtime { - iRuntime := eng.Hack_GetGlobalVar("httpapi.runtime") - if iRuntime == nil { - panic("Legacy runtime field not set in engine") +func mkDaemonFromEngine(eng *engine.Engine, t utils.Fataler) *daemon.Daemon { + iDaemon := eng.Hack_GetGlobalVar("httpapi.daemon") + if iDaemon == nil { + panic("Legacy daemon field not set in engine") } - runtime, ok := iRuntime.(*runtime.Runtime) + daemon, ok := iDaemon.(*daemon.Daemon) if !ok { - panic("Legacy runtime field in engine does not cast to *runtime.Runtime") + panic("Legacy daemon field in engine does not cast to *daemon.Daemon") } - return runtime + return daemon } func newTestEngine(t utils.Fataler, autorestart bool, root string) *engine.Engine { @@ -245,12 +245,12 @@ func readFile(src string, t *testing.T) (content string) { return string(data) } -// Create a test container from the given runtime `r` and run arguments `args`. +// Create a test container from the given daemon `r` and run arguments `args`. // If the image name is "_", (eg. []string{"-i", "-t", "_", "bash"}, it is // dynamically replaced by the current test image. // The caller is responsible for destroying the container. // Call t.Fatal() at the first error. -func mkContainer(r *runtime.Runtime, args []string, t *testing.T) (*runtime.Container, *runconfig.HostConfig, error) { +func mkContainer(r *daemon.Daemon, args []string, t *testing.T) (*daemon.Container, *runconfig.HostConfig, error) { config, hc, _, err := runconfig.Parse(args, nil) defer func() { if err != nil && t != nil { @@ -281,7 +281,7 @@ func mkContainer(r *runtime.Runtime, args []string, t *testing.T) (*runtime.Cont // and return its standard output as a string. // The image name (eg. the XXX in []string{"-i", "-t", "XXX", "bash"}, is dynamically replaced by the current test image. // If t is not nil, call t.Fatal() at the first error. Otherwise return errors normally. -func runContainer(eng *engine.Engine, r *runtime.Runtime, args []string, t *testing.T) (output string, err error) { +func runContainer(eng *engine.Engine, r *daemon.Daemon, args []string, t *testing.T) (output string, err error) { defer func() { if err != nil && t != nil { t.Fatal(err) diff --git a/integration/z_final_test.go b/integration/z_final_test.go index 837b5d13e6..6065230b92 100644 --- a/integration/z_final_test.go +++ b/integration/z_final_test.go @@ -11,7 +11,7 @@ func displayFdGoroutines(t *testing.T) { } func TestFinal(t *testing.T) { - nuke(globalRuntime) + nuke(globalDaemon) t.Logf("Start Fds: %d, Start Goroutines: %d", startFds, startGoroutines) displayFdGoroutines(t) } diff --git a/pkg/cgroups/apply_raw.go b/pkg/cgroups/apply_raw.go index 1700294bea..471d3fcf53 100644 --- a/pkg/cgroups/apply_raw.go +++ b/pkg/cgroups/apply_raw.go @@ -135,6 +135,7 @@ func (raw *rawCgroup) setupDevices(c *Cgroup, pid int) (err error) { func (raw *rawCgroup) setupMemory(c *Cgroup, pid int) (err error) { dir, err := raw.join("memory", pid) + // only return an error for memory if it was not specified if err != nil && (c.Memory != 0 || c.MemorySwap != 0) { return err } @@ -145,7 +146,6 @@ func (raw *rawCgroup) setupMemory(c *Cgroup, pid int) (err error) { }() if c.Memory != 0 || c.MemorySwap != 0 { - if c.Memory != 0 { if err := writeFile(dir, "memory.limit_in_bytes", strconv.FormatInt(c.Memory, 10)); err != nil { return err @@ -202,26 +202,34 @@ func (raw *rawCgroup) setupCpuset(c *Cgroup, pid int) (err error) { func (raw *rawCgroup) setupCpuacct(c *Cgroup, pid int) error { // we just want to join this group even though we don't set anything - _, err := raw.join("cpuacct", pid) - return err + if _, err := raw.join("cpuacct", pid); err != nil && err != ErrNotFound { + return err + } + return nil } func (raw *rawCgroup) setupBlkio(c *Cgroup, pid int) error { // we just want to join this group even though we don't set anything - _, err := raw.join("blkio", pid) - return err + if _, err := raw.join("blkio", pid); err != nil && err != ErrNotFound { + return err + } + return nil } func (raw *rawCgroup) setupPerfevent(c *Cgroup, pid int) error { // we just want to join this group even though we don't set anything - _, err := raw.join("perf_event", pid) - return err + if _, err := raw.join("perf_event", pid); err != nil && err != ErrNotFound { + return err + } + return nil } func (raw *rawCgroup) setupFreezer(c *Cgroup, pid int) error { // we just want to join this group even though we don't set anything - _, err := raw.join("freezer", pid) - return err + if _, err := raw.join("freezer", pid); err != nil && err != ErrNotFound { + return err + } + return nil } func (raw *rawCgroup) Cleanup() error { diff --git a/pkg/cgroups/cgroups.go b/pkg/cgroups/cgroups.go index 5fe10346df..e5e8f82db6 100644 --- a/pkg/cgroups/cgroups.go +++ b/pkg/cgroups/cgroups.go @@ -2,7 +2,7 @@ package cgroups import ( "bufio" - "fmt" + "errors" "github.com/dotcloud/docker/pkg/mount" "io" "io/ioutil" @@ -11,6 +11,10 @@ import ( "strings" ) +var ( + ErrNotFound = errors.New("mountpoint not found") +) + type Cgroup struct { Name string `json:"name,omitempty"` Parent string `json:"parent,omitempty"` @@ -44,7 +48,7 @@ func FindCgroupMountpoint(subsystem string) (string, error) { } } } - return "", fmt.Errorf("cgroup mountpoint not found for %s", subsystem) + return "", ErrNotFound } // Returns the relative path to the cgroup docker is running in. @@ -82,7 +86,7 @@ func parseCgroupFile(subsystem string, r io.Reader) (string, error) { } } } - return "", fmt.Errorf("cgroup '%s' not found in /proc/self/cgroup", subsystem) + return "", ErrNotFound } func writeFile(dir, file, data string) error { diff --git a/registry/registry.go b/registry/registry.go index 817c08afa9..451f30f670 100644 --- a/registry/registry.go +++ b/registry/registry.go @@ -101,17 +101,12 @@ func ResolveRepositoryName(reposName string) (string, string, error) { return "", "", ErrInvalidRepositoryName } nameParts := strings.SplitN(reposName, "/", 2) - if !strings.Contains(nameParts[0], ".") && !strings.Contains(nameParts[0], ":") && - nameParts[0] != "localhost" { + if len(nameParts) == 1 || (!strings.Contains(nameParts[0], ".") && !strings.Contains(nameParts[0], ":") && + nameParts[0] != "localhost") { // This is a Docker Index repos (ex: samalba/hipache or ubuntu) err := validateRepositoryName(reposName) return IndexServerAddress(), reposName, err } - if len(nameParts) < 2 { - // There is a dot in repos name (and no registry address) - // Is it a Registry address without repos name? - return "", "", ErrInvalidRepositoryName - } hostname := nameParts[0] reposName = nameParts[1] if strings.Contains(hostname, "index.docker.io") { diff --git a/registry/registry_test.go b/registry/registry_test.go index c072da41c5..cb56502fc1 100644 --- a/registry/registry_test.go +++ b/registry/registry_test.go @@ -146,6 +146,13 @@ func TestResolveRepositoryName(t *testing.T) { } assertEqual(t, ep, u, "Expected endpoint to be "+u) assertEqual(t, repo, "private/moonbase", "Expected endpoint to be private/moonbase") + + ep, repo, err = ResolveRepositoryName("ubuntu-12.04-base") + if err != nil { + t.Fatal(err) + } + assertEqual(t, ep, IndexServerAddress(), "Expected endpoint to be "+IndexServerAddress()) + assertEqual(t, repo, "ubuntu-12.04-base", "Expected endpoint to be ubuntu-12.04-base") } func TestPushRegistryTag(t *testing.T) { diff --git a/runtime/runtime_btrfs.go b/runtime/runtime_btrfs.go deleted file mode 100644 index c59b103ff9..0000000000 --- a/runtime/runtime_btrfs.go +++ /dev/null @@ -1,7 +0,0 @@ -// +build !exclude_graphdriver_btrfs - -package runtime - -import ( - _ "github.com/dotcloud/docker/runtime/graphdriver/btrfs" -) diff --git a/runtime/runtime_devicemapper.go b/runtime/runtime_devicemapper.go deleted file mode 100644 index 5b418b377a..0000000000 --- a/runtime/runtime_devicemapper.go +++ /dev/null @@ -1,7 +0,0 @@ -// +build !exclude_graphdriver_devicemapper - -package runtime - -import ( - _ "github.com/dotcloud/docker/runtime/graphdriver/devmapper" -) diff --git a/server/buildfile.go b/server/buildfile.go index 6340999cda..8466f4290e 100644 --- a/server/buildfile.go +++ b/server/buildfile.go @@ -7,10 +7,10 @@ import ( "errors" "fmt" "github.com/dotcloud/docker/archive" + "github.com/dotcloud/docker/daemon" "github.com/dotcloud/docker/nat" "github.com/dotcloud/docker/registry" "github.com/dotcloud/docker/runconfig" - "github.com/dotcloud/docker/runtime" "github.com/dotcloud/docker/utils" "io" "io/ioutil" @@ -35,8 +35,8 @@ type BuildFile interface { } type buildFile struct { - runtime *runtime.Runtime - srv *Server + daemon *daemon.Daemon + srv *Server image string maintainer string @@ -64,8 +64,8 @@ type buildFile struct { func (b *buildFile) clearTmp(containers map[string]struct{}) { for c := range containers { - tmp := b.runtime.Get(c) - if err := b.runtime.Destroy(tmp); err != nil { + tmp := b.daemon.Get(c) + if err := b.daemon.Destroy(tmp); err != nil { fmt.Fprintf(b.outStream, "Error removing intermediate container %s: %s\n", utils.TruncateID(c), err.Error()) } else { delete(containers, c) @@ -75,9 +75,9 @@ func (b *buildFile) clearTmp(containers map[string]struct{}) { } func (b *buildFile) CmdFrom(name string) error { - image, err := b.runtime.Repositories().LookupImage(name) + image, err := b.daemon.Repositories().LookupImage(name) if err != nil { - if b.runtime.Graph().IsNotExist(err) { + if b.daemon.Graph().IsNotExist(err) { remote, tag := utils.ParseRepositoryTag(name) job := b.srv.Eng.Job("pull", remote, tag) job.SetenvBool("json", b.sf.Json()) @@ -87,7 +87,7 @@ func (b *buildFile) CmdFrom(name string) error { if err := job.Run(); err != nil { return err } - image, err = b.runtime.Repositories().LookupImage(name) + image, err = b.daemon.Repositories().LookupImage(name) if err != nil { return err } @@ -101,7 +101,7 @@ func (b *buildFile) CmdFrom(name string) error { b.config = image.Config } if b.config.Env == nil || len(b.config.Env) == 0 { - b.config.Env = append(b.config.Env, "HOME=/", "PATH="+runtime.DefaultPathEnv) + b.config.Env = append(b.config.Env, "HOME=/", "PATH="+daemon.DefaultPathEnv) } // Process ONBUILD triggers if they exist if nTriggers := len(b.config.OnBuild); nTriggers != 0 { @@ -383,7 +383,7 @@ func (b *buildFile) checkPathForAddition(orig string) error { return nil } -func (b *buildFile) addContext(container *runtime.Container, orig, dest string, remote bool) error { +func (b *buildFile) addContext(container *daemon.Container, orig, dest string, remote bool) error { var ( err error origPath = path.Join(b.contextPath, orig) @@ -599,7 +599,7 @@ func (b *buildFile) CmdAdd(args string) error { } // Create the container and start it - container, _, err := b.runtime.Create(b.config, "") + container, _, err := b.daemon.Create(b.config, "") if err != nil { return err } @@ -621,14 +621,14 @@ func (b *buildFile) CmdAdd(args string) error { return nil } -func (b *buildFile) create() (*runtime.Container, error) { +func (b *buildFile) create() (*daemon.Container, error) { if b.image == "" { return nil, fmt.Errorf("Please provide a source image with `from` prior to run") } b.config.Image = b.image // Create the container and start it - c, _, err := b.runtime.Create(b.config, "") + c, _, err := b.daemon.Create(b.config, "") if err != nil { return nil, err } @@ -642,7 +642,7 @@ func (b *buildFile) create() (*runtime.Container, error) { return c, nil } -func (b *buildFile) run(c *runtime.Container) error { +func (b *buildFile) run(c *daemon.Container) error { var errCh chan error if b.verbose { @@ -693,7 +693,7 @@ func (b *buildFile) commit(id string, autoCmd []string, comment string) error { return nil } - container, warnings, err := b.runtime.Create(b.config, "") + container, warnings, err := b.daemon.Create(b.config, "") if err != nil { return err } @@ -709,7 +709,7 @@ func (b *buildFile) commit(id string, autoCmd []string, comment string) error { } defer container.Unmount() } - container := b.runtime.Get(id) + container := b.daemon.Get(id) if container == nil { return fmt.Errorf("An error occured while creating the container") } @@ -718,7 +718,7 @@ func (b *buildFile) commit(id string, autoCmd []string, comment string) error { autoConfig := *b.config autoConfig.Cmd = autoCmd // Commit the container - image, err := b.runtime.Commit(container, "", "", "", b.maintainer, &autoConfig) + image, err := b.daemon.Commit(container, "", "", "", b.maintainer, &autoConfig) if err != nil { return err } @@ -823,7 +823,7 @@ func stripComments(raw []byte) string { func NewBuildFile(srv *Server, outStream, errStream io.Writer, verbose, utilizeCache, rm bool, outOld io.Writer, sf *utils.StreamFormatter, configFile *registry.ConfigFile) BuildFile { return &buildFile{ - runtime: srv.runtime, + daemon: srv.daemon, srv: srv, config: &runconfig.Config{}, outStream: outStream, diff --git a/server/server.go b/server/server.go index 2de7dbc872..72244f4e6b 100644 --- a/server/server.go +++ b/server/server.go @@ -5,6 +5,7 @@ import ( "fmt" "github.com/dotcloud/docker/api" "github.com/dotcloud/docker/archive" + "github.com/dotcloud/docker/daemon" "github.com/dotcloud/docker/daemonconfig" "github.com/dotcloud/docker/dockerversion" "github.com/dotcloud/docker/engine" @@ -14,7 +15,6 @@ import ( "github.com/dotcloud/docker/pkg/signal" "github.com/dotcloud/docker/registry" "github.com/dotcloud/docker/runconfig" - "github.com/dotcloud/docker/runtime" "github.com/dotcloud/docker/utils" "io" "io/ioutil" @@ -43,9 +43,9 @@ func InitServer(job *engine.Job) engine.Status { if err != nil { return job.Error(err) } - if srv.runtime.Config().Pidfile != "" { + if srv.daemon.Config().Pidfile != "" { job.Logf("Creating pidfile") - if err := utils.CreatePidFile(srv.runtime.Config().Pidfile); err != nil { + if err := utils.CreatePidFile(srv.daemon.Config().Pidfile); err != nil { // FIXME: do we need fatal here instead of returning a job error? log.Fatal(err) } @@ -65,7 +65,7 @@ func InitServer(job *engine.Job) engine.Status { interruptCount++ // Initiate the cleanup only once if interruptCount == 1 { - utils.RemovePidFile(srv.runtime.Config().Pidfile) + utils.RemovePidFile(srv.daemon.Config().Pidfile) srv.Close() } else { return @@ -80,7 +80,7 @@ func InitServer(job *engine.Job) engine.Status { } }() job.Eng.Hack_SetGlobalVar("httpapi.server", srv) - job.Eng.Hack_SetGlobalVar("httpapi.runtime", srv.runtime) + job.Eng.Hack_SetGlobalVar("httpapi.daemon", srv.daemon) // FIXME: 'insert' is deprecated and should be removed in a future version. for name, handler := range map[string]engine.Handler{ @@ -172,13 +172,13 @@ func (srv *Server) ContainerKill(job *engine.Job) engine.Status { } } - if container := srv.runtime.Get(name); container != nil { + if container := srv.daemon.Get(name); container != nil { // If no signal is passed, or SIGKILL, perform regular Kill (SIGKILL + wait()) if sig == 0 || syscall.Signal(sig) == syscall.SIGKILL { if err := container.Kill(); err != nil { return job.Errorf("Cannot kill container %s: %s", name, err) } - srv.LogEvent("kill", container.ID, srv.runtime.Repositories().ImageName(container.Image)) + srv.LogEvent("kill", container.ID, srv.daemon.Repositories().ImageName(container.Image)) } else { // Otherwise, just send the requested signal if err := container.KillSig(int(sig)); err != nil { @@ -294,7 +294,7 @@ func (srv *Server) ContainerExport(job *engine.Job) engine.Status { return job.Errorf("Usage: %s container_id", job.Name) } name := job.Args[0] - if container := srv.runtime.Get(name); container != nil { + if container := srv.daemon.Get(name); container != nil { data, err := container.Export() if err != nil { return job.Errorf("%s: %s", name, err) @@ -306,7 +306,7 @@ func (srv *Server) ContainerExport(job *engine.Job) engine.Status { return job.Errorf("%s: %s", name, err) } // FIXME: factor job-specific LogEvent to engine.Job.Run() - srv.LogEvent("export", container.ID, srv.runtime.Repositories().ImageName(container.Image)) + srv.LogEvent("export", container.ID, srv.daemon.Repositories().ImageName(container.Image)) return engine.StatusOK } return job.Errorf("No such container: %s", name) @@ -331,7 +331,7 @@ func (srv *Server) ImageExport(job *engine.Job) engine.Status { utils.Debugf("Serializing %s", name) - rootRepo, err := srv.runtime.Repositories().Get(name) + rootRepo, err := srv.daemon.Repositories().Get(name) if err != nil { return job.Error(err) } @@ -510,7 +510,7 @@ func (srv *Server) Build(job *engine.Job) engine.Status { return job.Error(err) } if repoName != "" { - srv.runtime.Repositories().Set(repoName, tag, id, false) + srv.daemon.Repositories().Set(repoName, tag, id, false) } return engine.StatusOK } @@ -571,7 +571,7 @@ func (srv *Server) ImageLoad(job *engine.Job) engine.Status { for imageName, tagMap := range repositories { for tag, address := range tagMap { - if err := srv.runtime.Repositories().Set(imageName, tag, address, true); err != nil { + if err := srv.daemon.Repositories().Set(imageName, tag, address, true); err != nil { return job.Error(err) } } @@ -604,13 +604,13 @@ func (srv *Server) recursiveLoad(address, tmpImageDir string) error { return err } if img.Parent != "" { - if !srv.runtime.Graph().Exists(img.Parent) { + if !srv.daemon.Graph().Exists(img.Parent) { if err := srv.recursiveLoad(img.Parent, tmpImageDir); err != nil { return err } } } - if err := srv.runtime.Graph().Register(imageJson, layer, img); err != nil { + if err := srv.daemon.Graph().Register(imageJson, layer, img); err != nil { return err } } @@ -668,7 +668,7 @@ func (srv *Server) ImageInsert(job *engine.Job) engine.Status { sf := utils.NewStreamFormatter(job.GetenvBool("json")) out := utils.NewWriteFlusher(job.Stdout) - img, err := srv.runtime.Repositories().LookupImage(name) + img, err := srv.daemon.Repositories().LookupImage(name) if err != nil { return job.Error(err) } @@ -679,12 +679,12 @@ func (srv *Server) ImageInsert(job *engine.Job) engine.Status { } defer file.Body.Close() - config, _, _, err := runconfig.Parse([]string{img.ID, "echo", "insert", url, path}, srv.runtime.SystemConfig()) + config, _, _, err := runconfig.Parse([]string{img.ID, "echo", "insert", url, path}, srv.daemon.SystemConfig()) if err != nil { return job.Error(err) } - c, _, err := srv.runtime.Create(config, "") + c, _, err := srv.daemon.Create(config, "") if err != nil { return job.Error(err) } @@ -693,7 +693,7 @@ func (srv *Server) ImageInsert(job *engine.Job) engine.Status { return job.Error(err) } // FIXME: Handle custom repo, tag comment, author - img, err = srv.runtime.Commit(c, "", "", img.Comment, img.Author, nil) + img, err = srv.daemon.Commit(c, "", "", img.Comment, img.Author, nil) if err != nil { out.Write(sf.FormatError(err)) return engine.StatusErr @@ -703,7 +703,7 @@ func (srv *Server) ImageInsert(job *engine.Job) engine.Status { } func (srv *Server) ImagesViz(job *engine.Job) engine.Status { - images, _ := srv.runtime.Graph().Map() + images, _ := srv.daemon.Graph().Map() if images == nil { return engine.StatusOK } @@ -727,7 +727,7 @@ func (srv *Server) ImagesViz(job *engine.Job) engine.Status { reporefs := make(map[string][]string) - for name, repository := range srv.runtime.Repositories().Repositories { + for name, repository := range srv.daemon.Repositories().Repositories { for tag, id := range repository { reporefs[utils.TruncateID(id)] = append(reporefs[utils.TruncateID(id)], fmt.Sprintf("%s:%s", name, tag)) } @@ -746,22 +746,22 @@ func (srv *Server) Images(job *engine.Job) engine.Status { err error ) if job.GetenvBool("all") { - allImages, err = srv.runtime.Graph().Map() + allImages, err = srv.daemon.Graph().Map() } else { - allImages, err = srv.runtime.Graph().Heads() + allImages, err = srv.daemon.Graph().Heads() } if err != nil { return job.Error(err) } lookup := make(map[string]*engine.Env) - for name, repository := range srv.runtime.Repositories().Repositories { + for name, repository := range srv.daemon.Repositories().Repositories { if job.Getenv("filter") != "" { if match, _ := path.Match(job.Getenv("filter"), name); !match { continue } } for tag, id := range repository { - image, err := srv.runtime.Graph().Get(id) + image, err := srv.daemon.Graph().Get(id) if err != nil { log.Printf("Warning: couldn't load %s from %s/%s: %s", id, name, tag, err) continue @@ -811,7 +811,7 @@ func (srv *Server) Images(job *engine.Job) engine.Status { } func (srv *Server) DockerInfo(job *engine.Job) engine.Status { - images, _ := srv.runtime.Graph().Map() + images, _ := srv.daemon.Graph().Map() var imgcount int if images == nil { imgcount = 0 @@ -826,22 +826,22 @@ func (srv *Server) DockerInfo(job *engine.Job) engine.Status { // if we still have the original dockerinit binary from before we copied it locally, let's return the path to that, since that's more intuitive (the copied path is trivial to derive by hand given VERSION) initPath := utils.DockerInitPath("") if initPath == "" { - // if that fails, we'll just return the path from the runtime - initPath = srv.runtime.SystemInitPath() + // if that fails, we'll just return the path from the daemon + initPath = srv.daemon.SystemInitPath() } v := &engine.Env{} - v.SetInt("Containers", len(srv.runtime.List())) + v.SetInt("Containers", len(srv.daemon.List())) v.SetInt("Images", imgcount) - v.Set("Driver", srv.runtime.GraphDriver().String()) - v.SetJson("DriverStatus", srv.runtime.GraphDriver().Status()) - v.SetBool("MemoryLimit", srv.runtime.SystemConfig().MemoryLimit) - v.SetBool("SwapLimit", srv.runtime.SystemConfig().SwapLimit) - v.SetBool("IPv4Forwarding", !srv.runtime.SystemConfig().IPv4ForwardingDisabled) + v.Set("Driver", srv.daemon.GraphDriver().String()) + v.SetJson("DriverStatus", srv.daemon.GraphDriver().Status()) + v.SetBool("MemoryLimit", srv.daemon.SystemConfig().MemoryLimit) + v.SetBool("SwapLimit", srv.daemon.SystemConfig().SwapLimit) + v.SetBool("IPv4Forwarding", !srv.daemon.SystemConfig().IPv4ForwardingDisabled) v.SetBool("Debug", os.Getenv("DEBUG") != "") v.SetInt("NFd", utils.GetTotalUsedFds()) v.SetInt("NGoroutines", goruntime.NumGoroutine()) - v.Set("ExecutionDriver", srv.runtime.ExecutionDriver().Name()) + v.Set("ExecutionDriver", srv.daemon.ExecutionDriver().Name()) v.SetInt("NEventsListener", len(srv.listeners)) v.Set("KernelVersion", kernelVersion) v.Set("IndexServerAddress", registry.IndexServerAddress()) @@ -875,13 +875,13 @@ func (srv *Server) ImageHistory(job *engine.Job) engine.Status { return job.Errorf("Usage: %s IMAGE", job.Name) } name := job.Args[0] - foundImage, err := srv.runtime.Repositories().LookupImage(name) + foundImage, err := srv.daemon.Repositories().LookupImage(name) if err != nil { return job.Error(err) } lookupMap := make(map[string][]string) - for name, repository := range srv.runtime.Repositories().Repositories { + for name, repository := range srv.daemon.Repositories().Repositories { for tag, id := range repository { // If the ID already has a reverse lookup, do not update it unless for "latest" if _, exists := lookupMap[id]; !exists { @@ -922,11 +922,11 @@ func (srv *Server) ContainerTop(job *engine.Job) engine.Status { psArgs = job.Args[1] } - if container := srv.runtime.Get(name); container != nil { + if container := srv.daemon.Get(name); container != nil { if !container.State.IsRunning() { return job.Errorf("Container %s is not running", name) } - pids, err := srv.runtime.ExecutionDriver().GetPidsForContainer(container.ID) + pids, err := srv.daemon.ExecutionDriver().GetPidsForContainer(container.ID) if err != nil { return job.Error(err) } @@ -984,7 +984,7 @@ func (srv *Server) ContainerChanges(job *engine.Job) engine.Status { return job.Errorf("Usage: %s CONTAINER", job.Name) } name := job.Args[0] - if container := srv.runtime.Get(name); container != nil { + if container := srv.daemon.Get(name); container != nil { outs := engine.NewTable("", 0) changes, err := container.Changes() if err != nil { @@ -1019,27 +1019,27 @@ func (srv *Server) Containers(job *engine.Job) engine.Status { outs := engine.NewTable("Created", 0) names := map[string][]string{} - srv.runtime.ContainerGraph().Walk("/", func(p string, e *graphdb.Entity) error { + srv.daemon.ContainerGraph().Walk("/", func(p string, e *graphdb.Entity) error { names[e.ID()] = append(names[e.ID()], p) return nil }, -1) - var beforeCont, sinceCont *runtime.Container + var beforeCont, sinceCont *daemon.Container if before != "" { - beforeCont = srv.runtime.Get(before) + beforeCont = srv.daemon.Get(before) if beforeCont == nil { return job.Error(fmt.Errorf("Could not find container with name or id %s", before)) } } if since != "" { - sinceCont = srv.runtime.Get(since) + sinceCont = srv.daemon.Get(since) if sinceCont == nil { return job.Error(fmt.Errorf("Could not find container with name or id %s", since)) } } - for _, container := range srv.runtime.List() { + for _, container := range srv.daemon.List() { if !container.State.IsRunning() && !all && n <= 0 && since == "" && before == "" { continue } @@ -1061,9 +1061,19 @@ func (srv *Server) Containers(job *engine.Job) engine.Status { out := &engine.Env{} out.Set("Id", container.ID) out.SetList("Names", names[container.ID]) - out.Set("Image", srv.runtime.Repositories().ImageName(container.Image)) + out.Set("Image", srv.daemon.Repositories().ImageName(container.Image)) if len(container.Args) > 0 { - out.Set("Command", fmt.Sprintf("\"%s %s\"", container.Path, container.ArgsAsString())) + args := []string{} + for _, arg := range container.Args { + if strings.Contains(arg, " ") { + args = append(args, fmt.Sprintf("'%s'", arg)) + } else { + args = append(args, arg) + } + } + argsAsString := strings.Join(args, " ") + + out.Set("Command", fmt.Sprintf("\"%s %s\"", container.Path, argsAsString)) } else { out.Set("Command", fmt.Sprintf("\"%s\"", container.Path)) } @@ -1094,7 +1104,7 @@ func (srv *Server) ContainerCommit(job *engine.Job) engine.Status { } name := job.Args[0] - container := srv.runtime.Get(name) + container := srv.daemon.Get(name) if container == nil { return job.Errorf("No such container: %s", name) } @@ -1108,7 +1118,7 @@ func (srv *Server) ContainerCommit(job *engine.Job) engine.Status { return job.Error(err) } - img, err := srv.runtime.Commit(container, job.Getenv("repo"), job.Getenv("tag"), job.Getenv("comment"), job.Getenv("author"), &newConfig) + img, err := srv.daemon.Commit(container, job.Getenv("repo"), job.Getenv("tag"), job.Getenv("comment"), job.Getenv("author"), &newConfig) if err != nil { return job.Error(err) } @@ -1124,7 +1134,7 @@ func (srv *Server) ImageTag(job *engine.Job) engine.Status { if len(job.Args) == 3 { tag = job.Args[2] } - if err := srv.runtime.Repositories().Set(job.Args[1], tag, job.Args[0], job.GetenvBool("force")); err != nil { + if err := srv.daemon.Repositories().Set(job.Args[1], tag, job.Args[0], job.GetenvBool("force")); err != nil { return job.Error(err) } return engine.StatusOK @@ -1149,7 +1159,7 @@ func (srv *Server) pullImage(r *registry.Registry, out io.Writer, imgID, endpoin } defer srv.poolRemove("pull", "layer:"+id) - if !srv.runtime.Graph().Exists(id) { + if !srv.daemon.Graph().Exists(id) { out.Write(sf.FormatProgress(utils.TruncateID(id), "Pulling metadata", nil)) var ( imgJSON []byte @@ -1187,7 +1197,7 @@ func (srv *Server) pullImage(r *registry.Registry, out io.Writer, imgID, endpoin return err } defer layer.Close() - if err := srv.runtime.Graph().Register(imgJSON, utils.ProgressReader(layer, imgSize, out, sf, false, utils.TruncateID(id), "Downloading"), img); err != nil { + if err := srv.daemon.Graph().Register(imgJSON, utils.ProgressReader(layer, imgSize, out, sf, false, utils.TruncateID(id), "Downloading"), img); err != nil { out.Write(sf.FormatProgress(utils.TruncateID(id), "Error downloading dependent layers", nil)) return err } @@ -1277,7 +1287,7 @@ func (srv *Server) pullRepository(r *registry.Registry, out io.Writer, localName for _, ep := range repoData.Endpoints { out.Write(sf.FormatProgress(utils.TruncateID(img.ID), fmt.Sprintf("Pulling image (%s) from %s, endpoint: %s", img.Tag, localName, ep), nil)) if err := srv.pullImage(r, out, img.ID, ep, repoData.Tokens, sf); err != nil { - // Its not ideal that only the last error is returned, it would be better to concatenate the errors. + // It's not ideal that only the last error is returned, it would be better to concatenate the errors. // As the error is also given to the output stream the user will see the error. lastErr = err out.Write(sf.FormatProgress(utils.TruncateID(img.ID), fmt.Sprintf("Error pulling image (%s) from %s, endpoint: %s, %s", img.Tag, localName, ep, err), nil)) @@ -1322,11 +1332,11 @@ func (srv *Server) pullRepository(r *registry.Registry, out io.Writer, localName if askedTag != "" && tag != askedTag { continue } - if err := srv.runtime.Repositories().Set(localName, tag, id, true); err != nil { + if err := srv.daemon.Repositories().Set(localName, tag, id, true); err != nil { return err } } - if err := srv.runtime.Repositories().Save(); err != nil { + if err := srv.daemon.Repositories().Save(); err != nil { return err } @@ -1457,7 +1467,7 @@ func (srv *Server) getImageList(localRepo map[string]string, requestedTag string tagsByImage[id] = append(tagsByImage[id], tag) - for img, err := srv.runtime.Graph().Get(id); img != nil; img, err = img.GetParent() { + for img, err := srv.daemon.Graph().Get(id); img != nil; img, err = img.GetParent() { if err != nil { return nil, nil, err } @@ -1572,7 +1582,7 @@ func (srv *Server) pushRepository(r *registry.Registry, out io.Writer, localName func (srv *Server) pushImage(r *registry.Registry, out io.Writer, remote, imgID, ep string, token []string, sf *utils.StreamFormatter) (checksum string, err error) { out = utils.NewWriteFlusher(out) - jsonRaw, err := ioutil.ReadFile(path.Join(srv.runtime.Graph().Root, imgID, "json")) + jsonRaw, err := ioutil.ReadFile(path.Join(srv.daemon.Graph().Root, imgID, "json")) if err != nil { return "", fmt.Errorf("Cannot retrieve the path for {%s}: %s", imgID, err) } @@ -1591,7 +1601,7 @@ func (srv *Server) pushImage(r *registry.Registry, out io.Writer, remote, imgID, return "", err } - layerData, err := srv.runtime.Graph().TempLayerArchive(imgID, archive.Uncompressed, sf, out) + layerData, err := srv.daemon.Graph().TempLayerArchive(imgID, archive.Uncompressed, sf, out) if err != nil { return "", fmt.Errorf("Failed to generate layer archive: %s", err) } @@ -1646,7 +1656,7 @@ func (srv *Server) ImagePush(job *engine.Job) engine.Status { return job.Error(err) } - img, err := srv.runtime.Graph().Get(localName) + img, err := srv.daemon.Graph().Get(localName) r, err2 := registry.NewRegistry(authConfig, srv.HTTPRequestFactory(metaHeaders), endpoint) if err2 != nil { return job.Error(err2) @@ -1655,11 +1665,11 @@ func (srv *Server) ImagePush(job *engine.Job) engine.Status { if err != nil { reposLen := 1 if tag == "" { - reposLen = len(srv.runtime.Repositories().Repositories[localName]) + reposLen = len(srv.daemon.Repositories().Repositories[localName]) } job.Stdout.Write(sf.FormatStatus("", "The push refers to a repository [%s] (len: %d)", localName, reposLen)) // If it fails, try to get the repository - if localRepo, exists := srv.runtime.Repositories().Repositories[localName]; exists { + if localRepo, exists := srv.daemon.Repositories().Repositories[localName]; exists { if err := srv.pushRepository(r, job.Stdout, localName, remoteName, localRepo, tag, sf); err != nil { return job.Error(err) } @@ -1715,13 +1725,13 @@ func (srv *Server) ImageImport(job *engine.Job) engine.Status { defer progressReader.Close() archive = progressReader } - img, err := srv.runtime.Graph().Create(archive, "", "", "Imported from "+src, "", nil, nil) + img, err := srv.daemon.Graph().Create(archive, "", "", "Imported from "+src, "", nil, nil) if err != nil { return job.Error(err) } // Optionally register the image at REPO/TAG if repo != "" { - if err := srv.runtime.Repositories().Set(repo, tag, img.ID, true); err != nil { + if err := srv.daemon.Repositories().Set(repo, tag, img.ID, true); err != nil { return job.Error(err) } } @@ -1740,17 +1750,17 @@ func (srv *Server) ContainerCreate(job *engine.Job) engine.Status { if config.Memory != 0 && config.Memory < 524288 { return job.Errorf("Minimum memory limit allowed is 512k") } - if config.Memory > 0 && !srv.runtime.SystemConfig().MemoryLimit { + if config.Memory > 0 && !srv.daemon.SystemConfig().MemoryLimit { job.Errorf("Your kernel does not support memory limit capabilities. Limitation discarded.\n") config.Memory = 0 } - if config.Memory > 0 && !srv.runtime.SystemConfig().SwapLimit { + if config.Memory > 0 && !srv.daemon.SystemConfig().SwapLimit { job.Errorf("Your kernel does not support swap limit capabilities. Limitation discarded.\n") config.MemorySwap = -1 } - container, buildWarnings, err := srv.runtime.Create(config, name) + container, buildWarnings, err := srv.daemon.Create(config, name) if err != nil { - if srv.runtime.Graph().IsNotExist(err) { + if srv.daemon.Graph().IsNotExist(err) { _, tag := utils.ParseRepositoryTag(config.Image) if tag == "" { tag = graph.DEFAULTTAG @@ -1759,11 +1769,11 @@ func (srv *Server) ContainerCreate(job *engine.Job) engine.Status { } return job.Error(err) } - if !container.Config.NetworkDisabled && srv.runtime.SystemConfig().IPv4ForwardingDisabled { + if !container.Config.NetworkDisabled && srv.daemon.SystemConfig().IPv4ForwardingDisabled { job.Errorf("IPv4 forwarding is disabled.\n") } - srv.LogEvent("create", container.ID, srv.runtime.Repositories().ImageName(container.Image)) - // FIXME: this is necessary because runtime.Create might return a nil container + srv.LogEvent("create", container.ID, srv.daemon.Repositories().ImageName(container.Image)) + // FIXME: this is necessary because daemon.Create might return a nil container // with a non-nil error. This should not happen! Once it's fixed we // can remove this workaround. if container != nil { @@ -1786,11 +1796,11 @@ func (srv *Server) ContainerRestart(job *engine.Job) engine.Status { if job.EnvExists("t") { t = job.GetenvInt("t") } - if container := srv.runtime.Get(name); container != nil { + if container := srv.daemon.Get(name); container != nil { if err := container.Restart(int(t)); err != nil { return job.Errorf("Cannot restart container %s: %s\n", name, err) } - srv.LogEvent("restart", container.ID, srv.runtime.Repositories().ImageName(container.Image)) + srv.LogEvent("restart", container.ID, srv.daemon.Repositories().ImageName(container.Image)) } else { return job.Errorf("No such container: %s\n", name) } @@ -1806,13 +1816,13 @@ func (srv *Server) ContainerDestroy(job *engine.Job) engine.Status { removeLink := job.GetenvBool("removeLink") forceRemove := job.GetenvBool("forceRemove") - container := srv.runtime.Get(name) + container := srv.daemon.Get(name) if removeLink { if container == nil { return job.Errorf("No such link: %s", name) } - name, err := runtime.GetFullContainerName(name) + name, err := daemon.GetFullContainerName(name) if err != nil { job.Error(err) } @@ -1820,17 +1830,17 @@ func (srv *Server) ContainerDestroy(job *engine.Job) engine.Status { if parent == "/" { return job.Errorf("Conflict, cannot remove the default name of the container") } - pe := srv.runtime.ContainerGraph().Get(parent) + pe := srv.daemon.ContainerGraph().Get(parent) if pe == nil { return job.Errorf("Cannot get parent %s for name %s", parent, name) } - parentContainer := srv.runtime.Get(pe.ID()) + parentContainer := srv.daemon.Get(pe.ID()) if parentContainer != nil { parentContainer.DisableLink(n) } - if err := srv.runtime.ContainerGraph().Delete(name); err != nil { + if err := srv.daemon.ContainerGraph().Delete(name); err != nil { return job.Error(err) } return engine.StatusOK @@ -1846,16 +1856,16 @@ func (srv *Server) ContainerDestroy(job *engine.Job) engine.Status { return job.Errorf("Impossible to remove a running container, please stop it first or use -f") } } - if err := srv.runtime.Destroy(container); err != nil { + if err := srv.daemon.Destroy(container); err != nil { return job.Errorf("Cannot destroy container %s: %s", name, err) } - srv.LogEvent("destroy", container.ID, srv.runtime.Repositories().ImageName(container.Image)) + srv.LogEvent("destroy", container.ID, srv.daemon.Repositories().ImageName(container.Image)) if removeVolume { var ( volumes = make(map[string]struct{}) binds = make(map[string]struct{}) - usedVolumes = make(map[string]*runtime.Container) + usedVolumes = make(map[string]*daemon.Container) ) // the volume id is always the base of the path @@ -1867,13 +1877,16 @@ func (srv *Server) ContainerDestroy(job *engine.Job) engine.Status { for _, bind := range container.HostConfig().Binds { source := strings.Split(bind, ":")[0] // TODO: refactor all volume stuff, all of it - // this is very important that we eval the link - // or comparing the keys to container.Volumes will not work + // it is very important that we eval the link or comparing the keys to container.Volumes will not work + // + // eval symlink can fail, ref #5244 if we receive an is not exist error we can ignore it p, err := filepath.EvalSymlinks(source) - if err != nil { + if err != nil && !os.IsNotExist(err) { return job.Error(err) } - source = p + if p != "" { + source = p + } binds[source] = struct{}{} } @@ -1890,7 +1903,7 @@ func (srv *Server) ContainerDestroy(job *engine.Job) engine.Status { } // Retrieve all volumes from all remaining containers - for _, container := range srv.runtime.List() { + for _, container := range srv.daemon.List() { for _, containerVolumeId := range container.Volumes { containerVolumeId = getVolumeId(containerVolumeId) usedVolumes[containerVolumeId] = container @@ -1903,7 +1916,7 @@ func (srv *Server) ContainerDestroy(job *engine.Job) engine.Status { log.Printf("The volume %s is used by the container %s. Impossible to remove it. Skipping.\n", volumeId, c.ID) continue } - if err := srv.runtime.Volumes().Delete(volumeId); err != nil { + if err := srv.daemon.Volumes().Delete(volumeId); err != nil { return job.Errorf("Error calling volumes.Delete(%q): %v", volumeId, err) } } @@ -1925,9 +1938,9 @@ func (srv *Server) DeleteImage(name string, imgs *engine.Table, first, force, no tag = graph.DEFAULTTAG } - img, err := srv.runtime.Repositories().LookupImage(name) + img, err := srv.daemon.Repositories().LookupImage(name) if err != nil { - if r, _ := srv.runtime.Repositories().Get(repoName); r != nil { + if r, _ := srv.daemon.Repositories().Get(repoName); r != nil { return fmt.Errorf("No such image: %s:%s", repoName, tag) } return fmt.Errorf("No such image: %s", name) @@ -1938,14 +1951,14 @@ func (srv *Server) DeleteImage(name string, imgs *engine.Table, first, force, no tag = "" } - byParents, err := srv.runtime.Graph().ByParent() + byParents, err := srv.daemon.Graph().ByParent() if err != nil { return err } //If delete by id, see if the id belong only to one repository if repoName == "" { - for _, repoAndTag := range srv.runtime.Repositories().ByID()[img.ID] { + for _, repoAndTag := range srv.daemon.Repositories().ByID()[img.ID] { parsedRepo, parsedTag := utils.ParseRepositoryTag(repoAndTag) if repoName == "" || repoName == parsedRepo { repoName = parsedRepo @@ -1968,7 +1981,7 @@ func (srv *Server) DeleteImage(name string, imgs *engine.Table, first, force, no //Untag the current image for _, tag := range tags { - tagDeleted, err := srv.runtime.Repositories().Delete(repoName, tag) + tagDeleted, err := srv.daemon.Repositories().Delete(repoName, tag) if err != nil { return err } @@ -1979,16 +1992,16 @@ func (srv *Server) DeleteImage(name string, imgs *engine.Table, first, force, no srv.LogEvent("untag", img.ID, "") } } - tags = srv.runtime.Repositories().ByID()[img.ID] + tags = srv.daemon.Repositories().ByID()[img.ID] if (len(tags) <= 1 && repoName == "") || len(tags) == 0 { if len(byParents[img.ID]) == 0 { if err := srv.canDeleteImage(img.ID); err != nil { return err } - if err := srv.runtime.Repositories().DeleteAll(img.ID); err != nil { + if err := srv.daemon.Repositories().DeleteAll(img.ID); err != nil { return err } - if err := srv.runtime.Graph().Delete(img.ID); err != nil { + if err := srv.daemon.Graph().Delete(img.ID); err != nil { return err } out := &engine.Env{} @@ -2026,8 +2039,8 @@ func (srv *Server) ImageDelete(job *engine.Job) engine.Status { } func (srv *Server) canDeleteImage(imgID string) error { - for _, container := range srv.runtime.List() { - parent, err := srv.runtime.Repositories().LookupImage(container.Image) + for _, container := range srv.daemon.List() { + parent, err := srv.daemon.Repositories().LookupImage(container.Image) if err != nil { return err } @@ -2046,7 +2059,7 @@ func (srv *Server) canDeleteImage(imgID string) error { func (srv *Server) ImageGetCached(imgID string, config *runconfig.Config) (*image.Image, error) { // Retrieve all images - images, err := srv.runtime.Graph().Map() + images, err := srv.daemon.Graph().Map() if err != nil { return nil, err } @@ -2063,7 +2076,7 @@ func (srv *Server) ImageGetCached(imgID string, config *runconfig.Config) (*imag // Loop on the children of the given image and check the config var match *image.Image for elem := range imageMap[imgID] { - img, err := srv.runtime.Graph().Get(elem) + img, err := srv.daemon.Graph().Get(elem) if err != nil { return nil, err } @@ -2076,8 +2089,8 @@ func (srv *Server) ImageGetCached(imgID string, config *runconfig.Config) (*imag return match, nil } -func (srv *Server) RegisterLinks(container *runtime.Container, hostConfig *runconfig.HostConfig) error { - runtime := srv.runtime +func (srv *Server) RegisterLinks(container *daemon.Container, hostConfig *runconfig.HostConfig) error { + daemon := srv.daemon if hostConfig != nil && hostConfig.Links != nil { for _, l := range hostConfig.Links { @@ -2085,19 +2098,19 @@ func (srv *Server) RegisterLinks(container *runtime.Container, hostConfig *runco if err != nil { return err } - child, err := srv.runtime.GetByName(parts["name"]) + child, err := srv.daemon.GetByName(parts["name"]) if err != nil { return err } if child == nil { return fmt.Errorf("Could not get container for %s", parts["name"]) } - if err := runtime.RegisterLink(container, child, parts["alias"]); err != nil { + if err := daemon.RegisterLink(container, child, parts["alias"]); err != nil { return err } } - // After we load all the links into the runtime + // After we load all the links into the daemon // set them to nil on the hostconfig hostConfig.Links = nil if err := container.WriteHostConfig(); err != nil { @@ -2113,8 +2126,8 @@ func (srv *Server) ContainerStart(job *engine.Job) engine.Status { } var ( name = job.Args[0] - runtime = srv.runtime - container = runtime.Get(name) + daemon = srv.daemon + container = daemon.Get(name) ) if container == nil { @@ -2156,7 +2169,7 @@ func (srv *Server) ContainerStart(job *engine.Job) engine.Status { if err := container.Start(); err != nil { return job.Errorf("Cannot start container %s: %s", name, err) } - srv.LogEvent("start", container.ID, runtime.Repositories().ImageName(container.Image)) + srv.LogEvent("start", container.ID, daemon.Repositories().ImageName(container.Image)) return engine.StatusOK } @@ -2172,11 +2185,11 @@ func (srv *Server) ContainerStop(job *engine.Job) engine.Status { if job.EnvExists("t") { t = job.GetenvInt("t") } - if container := srv.runtime.Get(name); container != nil { + if container := srv.daemon.Get(name); container != nil { if err := container.Stop(int(t)); err != nil { return job.Errorf("Cannot stop container %s: %s\n", name, err) } - srv.LogEvent("stop", container.ID, srv.runtime.Repositories().ImageName(container.Image)) + srv.LogEvent("stop", container.ID, srv.daemon.Repositories().ImageName(container.Image)) } else { return job.Errorf("No such container: %s\n", name) } @@ -2188,7 +2201,7 @@ func (srv *Server) ContainerWait(job *engine.Job) engine.Status { return job.Errorf("Usage: %s", job.Name) } name := job.Args[0] - if container := srv.runtime.Get(name); container != nil { + if container := srv.daemon.Get(name); container != nil { status := container.Wait() job.Printf("%d\n", status) return engine.StatusOK @@ -2209,7 +2222,7 @@ func (srv *Server) ContainerResize(job *engine.Job) engine.Status { if err != nil { return job.Error(err) } - if container := srv.runtime.Get(name); container != nil { + if container := srv.daemon.Get(name); container != nil { if err := container.Resize(height, width); err != nil { return job.Error(err) } @@ -2232,7 +2245,7 @@ func (srv *Server) ContainerAttach(job *engine.Job) engine.Status { stderr = job.GetenvBool("stderr") ) - container := srv.runtime.Get(name) + container := srv.daemon.Get(name) if container == nil { return job.Errorf("No such container: %s", name) } @@ -2284,10 +2297,6 @@ func (srv *Server) ContainerAttach(job *engine.Job) engine.Status { //stream if stream { - if container.State.IsGhost() { - return job.Errorf("Impossible to attach to a ghost container") - } - var ( cStdin io.ReadCloser cStdout, cStderr io.Writer @@ -2322,15 +2331,15 @@ func (srv *Server) ContainerAttach(job *engine.Job) engine.Status { return engine.StatusOK } -func (srv *Server) ContainerInspect(name string) (*runtime.Container, error) { - if container := srv.runtime.Get(name); container != nil { +func (srv *Server) ContainerInspect(name string) (*daemon.Container, error) { + if container := srv.daemon.Get(name); container != nil { return container, nil } return nil, fmt.Errorf("No such container: %s", name) } func (srv *Server) ImageInspect(name string) (*image.Image, error) { - if image, err := srv.runtime.Repositories().LookupImage(name); err == nil && image != nil { + if image, err := srv.daemon.Repositories().LookupImage(name); err == nil && image != nil { return image, nil } return nil, fmt.Errorf("No such image: %s", name) @@ -2365,7 +2374,7 @@ func (srv *Server) JobInspect(job *engine.Job) engine.Status { return job.Error(errContainer) } object = &struct { - *runtime.Container + *daemon.Container HostConfig *runconfig.HostConfig }{container, container.HostConfig()} default: @@ -2390,7 +2399,7 @@ func (srv *Server) ContainerCopy(job *engine.Job) engine.Status { resource = job.Args[1] ) - if container := srv.runtime.Get(name); container != nil { + if container := srv.daemon.Get(name); container != nil { data, err := container.Copy(resource) if err != nil { @@ -2407,20 +2416,20 @@ func (srv *Server) ContainerCopy(job *engine.Job) engine.Status { } func NewServer(eng *engine.Engine, config *daemonconfig.Config) (*Server, error) { - runtime, err := runtime.NewRuntime(config, eng) + daemon, err := daemon.NewDaemon(config, eng) if err != nil { return nil, err } srv := &Server{ Eng: eng, - runtime: runtime, + daemon: daemon, pullingPool: make(map[string]chan struct{}), pushingPool: make(map[string]chan struct{}), events: make([]utils.JSONMessage, 0, 64), //only keeps the 64 last events listeners: make(map[string]chan utils.JSONMessage), running: true, } - runtime.SetServer(srv) + daemon.SetServer(srv) return srv, nil } @@ -2485,15 +2494,15 @@ func (srv *Server) Close() error { return nil } srv.SetRunning(false) - if srv.runtime == nil { + if srv.daemon == nil { return nil } - return srv.runtime.Close() + return srv.daemon.Close() } type Server struct { sync.RWMutex - runtime *runtime.Runtime + daemon *daemon.Daemon pullingPool map[string]chan struct{} pushingPool map[string]chan struct{} events []utils.JSONMessage diff --git a/sysinit/sysinit.go b/sysinit/sysinit.go index 50c858296f..62e89ce9e7 100644 --- a/sysinit/sysinit.go +++ b/sysinit/sysinit.go @@ -3,9 +3,9 @@ package sysinit import ( "flag" "fmt" - "github.com/dotcloud/docker/runtime/execdriver" - _ "github.com/dotcloud/docker/runtime/execdriver/lxc" - _ "github.com/dotcloud/docker/runtime/execdriver/native" + "github.com/dotcloud/docker/daemon/execdriver" + _ "github.com/dotcloud/docker/daemon/execdriver/lxc" + _ "github.com/dotcloud/docker/daemon/execdriver/native" "log" "os" ) diff --git a/utils/fs.go b/utils/fs.go index 46f64903b3..e07ced75d7 100644 --- a/utils/fs.go +++ b/utils/fs.go @@ -10,7 +10,7 @@ import ( // TreeSize walks a directory tree and returns its total size in bytes. func TreeSize(dir string) (size int64, err error) { - data := make(map[uint64]bool) + data := make(map[uint64]struct{}) err = filepath.Walk(dir, func(d string, fileInfo os.FileInfo, e error) error { // Ignore directory sizes if fileInfo == nil { @@ -29,7 +29,7 @@ func TreeSize(dir string) (size int64, err error) { return nil } // inode is not a uint64 on all platforms. Cast it to avoid issues. - data[uint64(inode)] = false + data[uint64(inode)] = struct{}{} size += s