vbatts/containerd
1
0
Fork 0
Code Pull requests Releases Activity

Add getting started section to readme

Browse source 
Signed-off-by: Ben Firshman <ben@firshman.co.uk>
This commit is contained in:
Ben Firshman 2016-04-06 11:43:23 -07:00
parent 5e5daf2b33
commit a3d09df648
1 changed files with 16 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -4,6 +4,21 @@ Containerd is a daemon to control runC, built for performance and density.
Containerd leverages runC's advanced features such as seccomp and user namespace support as well Containerd leverages runC's advanced features such as seccomp and user namespace support as well
as checkpoint and restore for cloning and live migration of containers. as checkpoint and restore for cloning and live migration of containers.
## Getting started
The easiest way to start using containerd is to download binaries from the [releases page](https://github.com/docker/containerd/releases).
The included `ctr` command-line tool allows you interact with the containerd daemon:
```
$ sudo ctr containers start redis /containers/redis
$ sudo ctr containers list
ID PATH STATUS PROCESSES
1 /containers/redis running 14063
```
`/containers/redis` is the path to an OCI bundle. [See the docs for more information.](docs/bundle.md)
## Docs ## Docs
For more documentation on various subjects refer to the `/docs` directory in this repository. For more documentation on various subjects refer to the `/docs` directory in this repository.
@ -17,11 +32,6 @@ work is being completed at a high rate.
After that just run `make` and the binaries for the daemon and client will be localed in the `bin/` directory. After that just run `make` and the binaries for the daemon and client will be localed in the `bin/` directory.
## Downloads
The easy way to test and use containerd is to view the [releases page](https://github.com/docker/containerd/releases) for binary downloads.
We encourage everyone to use containerd this way until it is out of alpha status.
## Performance ## Performance
Starting 1000 containers concurrently runs at 126-140 containers per second. Starting 1000 containers concurrently runs at 126-140 containers per second.
@ -106,9 +116,7 @@ GLOBAL OPTIONS:
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. 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.
# API ## API
## GRPC API
The API for containerd is with GRPC over a unix socket located at the default location of `/run/containerd/containerd.sock`. The API for containerd is with GRPC over a unix socket located at the default location of `/run/containerd/containerd.sock`.