vbatts/cri-o
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

docs: update documentation

Browse source 
Add documentation for the new configuration file format, as well as the
new `ocid config` subcommand and the changed --socket option.

Signed-off-by: Aleksa Sarai <asarai@suse.de>
This commit is contained in:
Aleksa Sarai 2016-10-10 04:36:43 +11:00
parent 9fb23bf0dc
commit 6860fe154a
No known key found for this signature in database
GPG key ID: 9E18AA267DDB8DB4
4 changed files with 107 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

38
docs/ocid.8.md
View file

@ -10,14 +10,14 @@ ocid - Enable OCI Kubernetes Container Runtime daemon
[**--containerdir**=[*value*]]
[**--debug**]
[**--help**|**-h**]
[**--listen**=[*value*]]
[**--log**=[*value*]]
[**--log-format value**]
[**--pause**=[*value*]]
[**--root**=[*value*]]
[**--runtime**=[*value*]]
[**--sandboxdir**=[*value*]]
[**--selinux-enabled**]
[**--socket**=[*value*]]
[**--selinux**]
[**--version**|**-v**]
# DESCRIPTION
@ -32,9 +32,11 @@ ocid is meant to provide an integration path between OCI conformant runtimes and
* Monitoring and logging required to satisfy the CRI
* Resource isolation as required by the CRI
**ocid [OPTIONS]**
**ocid [GLOBAL OPTIONS]**
# OPTIONS
**ocid [GLOBAL OPTIONS] config [OPTIONS]**
# GLOBAL OPTIONS
**--conmon**=""
path to the conmon executable (default: "/usr/libexec/ocid/conmon")
@ -48,6 +50,9 @@ ocid is meant to provide an integration path between OCI conformant runtimes and
**--help, -h**
Print usage statement
**--listen**=""
Path to ocid socket (default: "/var/run/ocid.sock")
**--log**=""
Set the log file path where internal debug information is written
@ -66,14 +71,27 @@ ocid is meant to provide an integration path between OCI conformant runtimes and
**--sandboxdir**=""
OCID pod sandbox dir (default: "/var/lib/ocid/sandboxes")
**--selinux-enabled**
Enable selinux support
**--socket**=""
Path to ocid socket (default: "/var/run/ocid.sock")
**--selinux**
Enable selinux support (default: false)
**--version, -v**
Print the version
# COMMANDS
OCID's default command is to start the daemon. However, it currently offers a
single additional subcommand.
## config
Outputs a commented version of the configuration file that would've been used
by OCID. This allows you to save you current configuration setup and then load
it later with **--config**. Global options will modify the output.
**--default**
Output the default configuration (without taking into account any configuration options).
# SEE ALSO
ocid.conf(5)
# HISTORY
Sept 2016, Originally compiled by Dan Walsh <dwalsh@redhat.com>
Sept 2016, Originally compiled by Dan Walsh <dwalsh@redhat.com> and Aleksa Sarai <asarai@suse.de>

67
docs/ocid.conf.5.md Normal file
View file

@ -0,0 +1,67 @@
% ocid.conf(5) Open Container Initiative Daemon
% Aleksa Sarai
% OCTOBER 2016
# NAME
ocid.conf - Syntax of OCID configuration file
# DESCRIPTION
The OCID configuration file specifies all of the available command-line options
for the ocid(8) program, but in a TOML format that can be more easily modified
and versioned.
# FORMAT
The [TOML format][toml] is used as the encoding of the configuration file.
Every option and subtable listed here is nested under a global "ocid" table.
No bare options are used. The format of TOML can be simplified to:
[table]
option = value
[table.subtable1]
option = value
[table.subtable2]
option = value
## OCID TABLE
The `ocid` table supports the following options:
**container_dir**=""
OCID container dir (default: "/var/lib/ocid/containers")
**root**=""
OCID root dir (default: "/var/lib/ocid")
**sandbox_dir**=""
OCID pod sandbox dir (default: "/var/lib/ocid/sandboxes")
## OCID.API TABLE
**listen**=""
Path to ocid socket (default: "/var/run/ocid.sock")
## OCID.RUNTIME TABLE
**conmon**=""
path to the conmon executable (default: "/usr/libexec/ocid/conmon")
**runtime**=""
OCI runtime path (default: "/usr/bin/runc")
**selinux**
Enable selinux support (default: false)
## OCID.IMAGE TABLE
**pause**=""
Path to the pause executable (default: "/usr/libexec/ocid/pause")
# SEE ALSO
ocid(8)
# HISTORY
Oct 2016, Originally compiled by Aleksa Sarai <asarai@suse.de>