github.com/ijc/containerd@v0.2.5/README.md (about)

     1  # containerd
     2  
     3  containerd is a daemon to control runC, built for performance and density. 
     4  containerd leverages runC's advanced features such as seccomp and user namespace support as well
     5  as checkpoint and restore for cloning and live migration of containers.
     6  
     7  ## Getting started
     8  
     9  The easiest way to start using containerd is to download binaries from the [releases page](https://github.com/docker/containerd/releases).
    10  
    11  The included `ctr` command-line tool allows you interact with the containerd daemon:
    12  
    13  ```
    14  $ sudo ctr containers start redis /containers/redis
    15  $ sudo ctr containers list
    16  ID                  PATH                STATUS              PROCESSES
    17  redis               /containers/redis   running             14063
    18  ```
    19  
    20  `/containers/redis` is the path to an OCI bundle. [See the docs for more information.](docs/bundle.md)
    21  
    22  ## Docs
    23  
    24   * [Client CLI reference (`ctr`)](docs/cli.md)
    25   * [Daemon CLI reference (`containerd`)](docs/daemon.md)
    26   * [Creating OCI bundles](docs/bundle.md)
    27   * [containerd changes to the bundle](docs/bundle-changes.md)
    28   * [Attaching to STDIO or TTY](docs/attach.md)
    29   * [Telemetry and metrics](docs/telemetry.md)
    30  
    31  All documentation is contained in the `/docs` directory in this repository.
    32  
    33  ## Building
    34  
    35  You will need to make sure that you have Go installed on your system and the containerd repository is cloned
    36  in your `$GOPATH`.  You will also need to make sure that you have all the dependencies cloned as well.
    37  Currently, contributing to containerd is not for the first time devs as many dependencies are not vendored and 
    38  work is being completed at a high rate.  
    39  
    40  After that just run `make` and the binaries for the daemon and client will be localed in the `bin/` directory.
    41  
    42  ## Performance
    43  
    44  Starting 1000 containers concurrently runs at 126-140 containers per second.
    45  
    46  Overall start times:
    47  
    48  ```
    49  [containerd] 2015/12/04 15:00:54   count:        1000
    50  [containerd] 2015/12/04 14:59:54   min:          23ms
    51  [containerd] 2015/12/04 14:59:54   max:         355ms
    52  [containerd] 2015/12/04 14:59:54   mean:         78ms
    53  [containerd] 2015/12/04 14:59:54   stddev:       34ms
    54  [containerd] 2015/12/04 14:59:54   median:       73ms
    55  [containerd] 2015/12/04 14:59:54   75%:          91ms
    56  [containerd] 2015/12/04 14:59:54   95%:         123ms
    57  [containerd] 2015/12/04 14:59:54   99%:         287ms
    58  [containerd] 2015/12/04 14:59:54   99.9%:       355ms
    59  ```
    60  
    61  ## Roadmap
    62  
    63  The current roadmap and milestones for alpha and beta completion are in the github issues on this repository.  Please refer to these issues for what is being worked on and completed for the various stages of development.
    64  
    65  ## Copyright and license
    66  
    67  Copyright © 2016 Docker, Inc. All rights reserved, except as follows. Code
    68  is released under the Apache 2.0 license. The README.md file, and files in the
    69  "docs" folder are licensed under the Creative Commons Attribution 4.0
    70  International License under the terms and conditions set forth in the file
    71  "LICENSE.docs". You may obtain a duplicate copy of the same license, titled
    72  CC-BY-SA-4.0, at http://creativecommons.org/licenses/by/4.0/.