Move docs in readme to separate pages
Signed-off-by: Ben Firshman <ben@firshman.co.uk>
This commit is contained in:
Ben Firshman
parent
a3d09df648
commit
6228054b6f
6 changed files with 233 additions and 234 deletions
242
README.md
242
README.md
|
|
@ -21,7 +21,14 @@ ID PATH STATUS PROCESSES
|
|||
|
||||
## Docs
|
||||
|
||||
For more documentation on various subjects refer to the `/docs` directory in this repository.
|
||||
* [Client CLI reference (`ctr`)](docs/cli.md)
|
||||
* [Daemon CLI reference (`containerd`)](docs/daemon.md)
|
||||
* [Creating OCI bundles](docs/bundle.md)
|
||||
* [containerd changes to the bundle](docs/bundle-changes.md)
|
||||
* [Attaching to STDIO or TTY](docs/attach.md)
|
||||
* [Telemetry and metrics](docs/telemetry.md)
|
||||
|
||||
All documentation is contained in the `/docs` directory in this repository.
|
||||
|
||||
## Building
|
||||
|
||||
|
|
@ -51,241 +58,10 @@ Overall start times:
|
|||
[containerd] 2015/12/04 14:59:54 99.9%: 355ms
|
||||
```
|
||||
|
||||
## Telemetry
|
||||
|
||||
Currently containerd only outputs metrics to stdout but will support dumping to various backends in the future.
|
||||
|
||||
```
|
||||
[containerd] 2015/12/16 11:48:28 timer container-start-time
|
||||
[containerd] 2015/12/16 11:48:28 count: 22
|
||||
[containerd] 2015/12/16 11:48:28 min: 25425883
|
||||
[containerd] 2015/12/16 11:48:28 max: 113077691
|
||||
[containerd] 2015/12/16 11:48:28 mean: 68386923.27
|
||||
[containerd] 2015/12/16 11:48:28 stddev: 20928453.26
|
||||
[containerd] 2015/12/16 11:48:28 median: 65489003.50
|
||||
[containerd] 2015/12/16 11:48:28 75%: 82393210.50
|
||||
[containerd] 2015/12/16 11:48:28 95%: 112267814.75
|
||||
[containerd] 2015/12/16 11:48:28 99%: 113077691.00
|
||||
[containerd] 2015/12/16 11:48:28 99.9%: 113077691.00
|
||||
[containerd] 2015/12/16 11:48:28 1-min rate: 0.00
|
||||
[containerd] 2015/12/16 11:48:28 5-min rate: 0.01
|
||||
[containerd] 2015/12/16 11:48:28 15-min rate: 0.01
|
||||
[containerd] 2015/12/16 11:48:28 mean rate: 0.03
|
||||
[containerd] 2015/12/16 11:48:28 counter containers
|
||||
[containerd] 2015/12/16 11:48:28 count: 1
|
||||
[containerd] 2015/12/16 11:48:28 counter events
|
||||
[containerd] 2015/12/16 11:48:28 count: 87
|
||||
[containerd] 2015/12/16 11:48:28 counter events-subscribers
|
||||
[containerd] 2015/12/16 11:48:28 count: 2
|
||||
[containerd] 2015/12/16 11:48:28 gauge goroutines
|
||||
[containerd] 2015/12/16 11:48:28 value: 38
|
||||
[containerd] 2015/12/16 11:48:28 gauge fds
|
||||
[containerd] 2015/12/16 11:48:28 value: 18
|
||||
```
|
||||
|
||||
## Daemon options
|
||||
|
||||
|
||||
```
|
||||
$ containerd -h
|
||||
|
||||
NAME:
|
||||
containerd - High performance container daemon
|
||||
|
||||
USAGE:
|
||||
containerd [global options] command [command options] [arguments...]
|
||||
|
||||
VERSION:
|
||||
0.1.0 commit: 54c213e8a719d734001beb2cb8f130c84cc3bd20
|
||||
|
||||
COMMANDS:
|
||||
help, h Shows a list of commands or help for one command
|
||||
|
||||
GLOBAL OPTIONS:
|
||||
--debug enable debug output in the logs
|
||||
--state-dir "/run/containerd" runtime state directory
|
||||
--metrics-interval "5m0s" interval for flushing metrics to the store
|
||||
--listen, -l "/run/containerd/containerd.sock" Address on which GRPC API will listen
|
||||
--runtime, -r "runc" name of the OCI compliant runtime to use when executing containers
|
||||
--graphite-address Address of graphite server
|
||||
--help, -h show help
|
||||
--version, -v print the version
|
||||
```
|
||||
|
||||
# Roadmap
|
||||
## Roadmap
|
||||
|
||||
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
|
||||
|
||||
The API for containerd is with GRPC over a unix socket located at the default location of `/run/containerd/containerd.sock`.
|
||||
|
||||
At this time please refer to the [proto at](https://github.com/docker/containerd/blob/master/api/grpc/types/api.proto) for the API methods and types.
|
||||
There is a Go implementation and types checked into this repository but alternate language implementations can be created using the grpc and protoc toolchain.
|
||||
|
||||
|
||||
## containerd CLI
|
||||
|
||||
There is a default cli named `ctr` based on the GRPC api.
|
||||
This cli will allow you to create and manage containers run with containerd.
|
||||
|
||||
```
|
||||
$ ctr -h
|
||||
NAME:
|
||||
ctr - High performance container daemon cli
|
||||
|
||||
USAGE:
|
||||
ctr [global options] command [command options] [arguments...]
|
||||
|
||||
VERSION:
|
||||
0.1.0 commit: 54c213e8a719d734001beb2cb8f130c84cc3bd20
|
||||
|
||||
COMMANDS:
|
||||
checkpoints list all checkpoints
|
||||
containers interact with running containers
|
||||
events receive events from the containerd daemon
|
||||
state get a raw dump of the containerd state
|
||||
help, h Shows a list of commands or help for one command
|
||||
|
||||
GLOBAL OPTIONS:
|
||||
--debug enable debug output in the logs
|
||||
--address "/run/containerd/containerd.sock" address of GRPC API
|
||||
--help, -h show help
|
||||
--version, -v print the version
|
||||
```
|
||||
|
||||
### Starting a container
|
||||
|
||||
```
|
||||
$ ctr containers start -h
|
||||
NAME:
|
||||
ctr containers start - start a container
|
||||
|
||||
USAGE:
|
||||
ctr containers start [command options] [arguments...]
|
||||
|
||||
OPTIONS:
|
||||
--checkpoint, -c checkpoint to start the container from
|
||||
--attach, -a connect to the stdio of the container
|
||||
--label, -l [--label option --label option] set labels for the container
|
||||
```
|
||||
|
||||
```bash
|
||||
$ sudo ctr containers start redis /containers/redis
|
||||
```
|
||||
Note: `/containers/redis` is the path of bundle you have to prepare before
|
||||
running a contianer, see [bundle](docs/bundle.md) to get more information.
|
||||
|
||||
|
||||
### Listing containers
|
||||
|
||||
```bash
|
||||
$ sudo ctr containers
|
||||
ID PATH STATUS PROCESSES
|
||||
1 /containers/redis running 14063
|
||||
19 /containers/redis running 14100
|
||||
14 /containers/redis running 14117
|
||||
4 /containers/redis running 14030
|
||||
16 /containers/redis running 14061
|
||||
3 /containers/redis running 14024
|
||||
12 /containers/redis running 14097
|
||||
10 /containers/redis running 14131
|
||||
18 /containers/redis running 13977
|
||||
13 /containers/redis running 13979
|
||||
15 /containers/redis running 13998
|
||||
5 /containers/redis running 14021
|
||||
9 /containers/redis running 14075
|
||||
6 /containers/redis running 14107
|
||||
2 /containers/redis running 14135
|
||||
11 /containers/redis running 13978
|
||||
17 /containers/redis running 13989
|
||||
8 /containers/redis running 14053
|
||||
7 /containers/redis running 14022
|
||||
0 /containers/redis running 14006
|
||||
```
|
||||
|
||||
### Kill a container's process
|
||||
|
||||
```
|
||||
$ ctr containers kill -h
|
||||
NAME:
|
||||
ctr containers kill - send a signal to a container or its processes
|
||||
|
||||
USAGE:
|
||||
ctr containers kill [command options] [arguments...]
|
||||
|
||||
OPTIONS:
|
||||
--pid, -p "init" pid of the process to signal within the container
|
||||
--signal, -s "15" signal to send to the container
|
||||
```
|
||||
|
||||
### Exec another process into a container
|
||||
|
||||
```
|
||||
$ ctr containers exec -h
|
||||
NAME:
|
||||
ctr containers exec - exec another process in an existing container
|
||||
|
||||
USAGE:
|
||||
ctr containers exec [command options] [arguments...]
|
||||
|
||||
OPTIONS:
|
||||
--id container id to add the process to
|
||||
--pid process id for the new process
|
||||
--attach, -a connect to the stdio of the container
|
||||
--cwd current working directory for the process
|
||||
--tty, -t create a terminal for the process
|
||||
--env, -e [--env option --env option] environment variables for the process
|
||||
--uid, -u "0" user id of the user for the process
|
||||
--gid, -g "0" group id of the user for the process
|
||||
```
|
||||
|
||||
### Stats for a container
|
||||
|
||||
```
|
||||
$ ctr containers stats -h
|
||||
NAME:
|
||||
ctr containers stats - get stats for running container
|
||||
|
||||
USAGE:
|
||||
ctr containers stats [arguments...]
|
||||
```
|
||||
|
||||
### List checkpoints
|
||||
|
||||
```
|
||||
$ sudo ctr checkpoints redis
|
||||
NAME TCP UNIX SOCKETS SHELL
|
||||
test false false false
|
||||
test2 false false false
|
||||
```
|
||||
|
||||
### Create a new checkpoint
|
||||
|
||||
```
|
||||
$ ctr checkpoints create -h
|
||||
NAME:
|
||||
ctr checkpoints create - create a new checkpoint for the container
|
||||
|
||||
USAGE:
|
||||
ctr checkpoints create [command options] [arguments...]
|
||||
|
||||
OPTIONS:
|
||||
--tcp persist open tcp connections
|
||||
--unix-sockets perist unix sockets
|
||||
--exit exit the container after the checkpoint completes successfully
|
||||
--shell checkpoint shell jobs
|
||||
```
|
||||
|
||||
### Get events
|
||||
|
||||
```
|
||||
$ sudo ctr events
|
||||
TYPE ID PID STATUS
|
||||
exit redis 24761 0
|
||||
```
|
||||
|
||||
|
||||
### Sign your work
|
||||
|
||||
The sign-off is a simple line at the end of the explanation for the patch. Your
|
||||
|
|
|
|||
6
docs/api.md
Normal file
6
docs/api.md
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
# API
|
||||
|
||||
The API for containerd is with GRPC over a unix socket located at the default location of `/run/containerd/containerd.sock`.
|
||||
|
||||
At this time please refer to the [proto at](https://github.com/docker/containerd/blob/master/api/grpc/types/api.proto) for the API methods and types.
|
||||
There is a Go implementation and types checked into this repository but alternate language implementations can be created using the grpc and protoc toolchain.
|
||||
|
|
@ -1,4 +1,4 @@
|
|||
# OCI Bundle
|
||||
# Creating OCI bundles
|
||||
|
||||
Since containerd consumes the OCI bundle format containers and configuration will have to be created
|
||||
on the machine that containerd is running on. The easiest way to do this is to download an image
|
||||
|
|
|
|||
159
docs/cli.md
Normal file
159
docs/cli.md
Normal file
|
|
@ -0,0 +1,159 @@
|
|||
# Client CLI
|
||||
|
||||
There is a default cli named `ctr` based on the GRPC api.
|
||||
This cli will allow you to create and manage containers run with containerd.
|
||||
|
||||
```
|
||||
$ ctr -h
|
||||
NAME:
|
||||
ctr - High performance container daemon cli
|
||||
|
||||
USAGE:
|
||||
ctr [global options] command [command options] [arguments...]
|
||||
|
||||
VERSION:
|
||||
0.1.0 commit: 54c213e8a719d734001beb2cb8f130c84cc3bd20
|
||||
|
||||
COMMANDS:
|
||||
checkpoints list all checkpoints
|
||||
containers interact with running containers
|
||||
events receive events from the containerd daemon
|
||||
state get a raw dump of the containerd state
|
||||
help, h Shows a list of commands or help for one command
|
||||
|
||||
GLOBAL OPTIONS:
|
||||
--debug enable debug output in the logs
|
||||
--address "/run/containerd/containerd.sock" address of GRPC API
|
||||
--help, -h show help
|
||||
--version, -v print the version
|
||||
```
|
||||
|
||||
## Starting a container
|
||||
|
||||
```
|
||||
$ ctr containers start -h
|
||||
NAME:
|
||||
ctr containers start - start a container
|
||||
|
||||
USAGE:
|
||||
ctr containers start [command options] [arguments...]
|
||||
|
||||
OPTIONS:
|
||||
--checkpoint, -c checkpoint to start the container from
|
||||
--attach, -a connect to the stdio of the container
|
||||
--label, -l [--label option --label option] set labels for the container
|
||||
```
|
||||
|
||||
```bash
|
||||
$ sudo ctr containers start redis /containers/redis
|
||||
```
|
||||
|
||||
`/containers/redis` is the path to an OCI bundle. [See the bundle docs for more information.](bundle.md)
|
||||
|
||||
## Listing containers
|
||||
|
||||
```bash
|
||||
$ sudo ctr containers
|
||||
ID PATH STATUS PROCESSES
|
||||
1 /containers/redis running 14063
|
||||
19 /containers/redis running 14100
|
||||
14 /containers/redis running 14117
|
||||
4 /containers/redis running 14030
|
||||
16 /containers/redis running 14061
|
||||
3 /containers/redis running 14024
|
||||
12 /containers/redis running 14097
|
||||
10 /containers/redis running 14131
|
||||
18 /containers/redis running 13977
|
||||
13 /containers/redis running 13979
|
||||
15 /containers/redis running 13998
|
||||
5 /containers/redis running 14021
|
||||
9 /containers/redis running 14075
|
||||
6 /containers/redis running 14107
|
||||
2 /containers/redis running 14135
|
||||
11 /containers/redis running 13978
|
||||
17 /containers/redis running 13989
|
||||
8 /containers/redis running 14053
|
||||
7 /containers/redis running 14022
|
||||
0 /containers/redis running 14006
|
||||
```
|
||||
|
||||
## Kill a container's process
|
||||
|
||||
```
|
||||
$ ctr containers kill -h
|
||||
NAME:
|
||||
ctr containers kill - send a signal to a container or its processes
|
||||
|
||||
USAGE:
|
||||
ctr containers kill [command options] [arguments...]
|
||||
|
||||
OPTIONS:
|
||||
--pid, -p "init" pid of the process to signal within the container
|
||||
--signal, -s "15" signal to send to the container
|
||||
```
|
||||
|
||||
## Exec another process into a container
|
||||
|
||||
```
|
||||
$ ctr containers exec -h
|
||||
NAME:
|
||||
ctr containers exec - exec another process in an existing container
|
||||
|
||||
USAGE:
|
||||
ctr containers exec [command options] [arguments...]
|
||||
|
||||
OPTIONS:
|
||||
--id container id to add the process to
|
||||
--pid process id for the new process
|
||||
--attach, -a connect to the stdio of the container
|
||||
--cwd current working directory for the process
|
||||
--tty, -t create a terminal for the process
|
||||
--env, -e [--env option --env option] environment variables for the process
|
||||
--uid, -u "0" user id of the user for the process
|
||||
--gid, -g "0" group id of the user for the process
|
||||
```
|
||||
|
||||
## Stats for a container
|
||||
|
||||
```
|
||||
$ ctr containers stats -h
|
||||
NAME:
|
||||
ctr containers stats - get stats for running container
|
||||
|
||||
USAGE:
|
||||
ctr containers stats [arguments...]
|
||||
```
|
||||
|
||||
## List checkpoints
|
||||
|
||||
```
|
||||
$ sudo ctr checkpoints redis
|
||||
NAME TCP UNIX SOCKETS SHELL
|
||||
test false false false
|
||||
test2 false false false
|
||||
```
|
||||
|
||||
## Create a new checkpoint
|
||||
|
||||
```
|
||||
$ ctr checkpoints create -h
|
||||
NAME:
|
||||
ctr checkpoints create - create a new checkpoint for the container
|
||||
|
||||
USAGE:
|
||||
ctr checkpoints create [command options] [arguments...]
|
||||
|
||||
OPTIONS:
|
||||
--tcp persist open tcp connections
|
||||
--unix-sockets perist unix sockets
|
||||
--exit exit the container after the checkpoint completes successfully
|
||||
--shell checkpoint shell jobs
|
||||
```
|
||||
|
||||
## Get events
|
||||
|
||||
```
|
||||
$ sudo ctr events
|
||||
TYPE ID PID STATUS
|
||||
exit redis 24761 0
|
||||
```
|
||||
27
docs/daemon.md
Normal file
27
docs/daemon.md
Normal file
|
|
@ -0,0 +1,27 @@
|
|||
# Daemon options
|
||||
|
||||
```
|
||||
$ containerd -h
|
||||
|
||||
NAME:
|
||||
containerd - High performance container daemon
|
||||
|
||||
USAGE:
|
||||
containerd [global options] command [command options] [arguments...]
|
||||
|
||||
VERSION:
|
||||
0.1.0 commit: 54c213e8a719d734001beb2cb8f130c84cc3bd20
|
||||
|
||||
COMMANDS:
|
||||
help, h Shows a list of commands or help for one command
|
||||
|
||||
GLOBAL OPTIONS:
|
||||
--debug enable debug output in the logs
|
||||
--state-dir "/run/containerd" runtime state directory
|
||||
--metrics-interval "5m0s" interval for flushing metrics to the store
|
||||
--listen, -l "/run/containerd/containerd.sock" Address on which GRPC API will listen
|
||||
--runtime, -r "runc" name of the OCI compliant runtime to use when executing containers
|
||||
--graphite-address Address of graphite server
|
||||
--help, -h show help
|
||||
--version, -v print the version
|
||||
```
|
||||
31
docs/telemetry.md
Normal file
31
docs/telemetry.md
Normal file
|
|
@ -0,0 +1,31 @@
|
|||
# Telemetry
|
||||
|
||||
Currently containerd only outputs metrics to stdout but will support dumping to various backends in the future.
|
||||
|
||||
```
|
||||
[containerd] 2015/12/16 11:48:28 timer container-start-time
|
||||
[containerd] 2015/12/16 11:48:28 count: 22
|
||||
[containerd] 2015/12/16 11:48:28 min: 25425883
|
||||
[containerd] 2015/12/16 11:48:28 max: 113077691
|
||||
[containerd] 2015/12/16 11:48:28 mean: 68386923.27
|
||||
[containerd] 2015/12/16 11:48:28 stddev: 20928453.26
|
||||
[containerd] 2015/12/16 11:48:28 median: 65489003.50
|
||||
[containerd] 2015/12/16 11:48:28 75%: 82393210.50
|
||||
[containerd] 2015/12/16 11:48:28 95%: 112267814.75
|
||||
[containerd] 2015/12/16 11:48:28 99%: 113077691.00
|
||||
[containerd] 2015/12/16 11:48:28 99.9%: 113077691.00
|
||||
[containerd] 2015/12/16 11:48:28 1-min rate: 0.00
|
||||
[containerd] 2015/12/16 11:48:28 5-min rate: 0.01
|
||||
[containerd] 2015/12/16 11:48:28 15-min rate: 0.01
|
||||
[containerd] 2015/12/16 11:48:28 mean rate: 0.03
|
||||
[containerd] 2015/12/16 11:48:28 counter containers
|
||||
[containerd] 2015/12/16 11:48:28 count: 1
|
||||
[containerd] 2015/12/16 11:48:28 counter events
|
||||
[containerd] 2015/12/16 11:48:28 count: 87
|
||||
[containerd] 2015/12/16 11:48:28 counter events-subscribers
|
||||
[containerd] 2015/12/16 11:48:28 count: 2
|
||||
[containerd] 2015/12/16 11:48:28 gauge goroutines
|
||||
[containerd] 2015/12/16 11:48:28 value: 38
|
||||
[containerd] 2015/12/16 11:48:28 gauge fds
|
||||
[containerd] 2015/12/16 11:48:28 value: 18
|
||||
```
|
||||
Loading…
Reference in a new issue