Merge pull request #641 from nathwill/man-libpod

add libpod.conf man page (closes #537)
This commit is contained in:
Daniel J Walsh
2018-04-23 20:49:30 -04:00
committed by GitHub
3 changed files with 66 additions and 0 deletions

54
docs/libpod.conf.5.md Normal file
View File

@ -0,0 +1,54 @@
% libpod.conf(5) library for running OCI-based containers in Pods
% Nathan Williams
% APRIL 2018
# NAME
libpod.conf - libpod configuration file
# DESCRIPTION
The libpod.conf file is the default configuration file for all tools using
libpod to manage containers.
# OPTIONS
**image_default_transport**=""
Default transport method for pulling and pushing images
**runtime_path**=""
Paths to search for a valid OCI runtime binary
**conmon_path**=""
Paths to search for the Conmon container manager binary
**conmon_env_vars**=""
Environment variables to pass into Conmon
**cgroup_manager**=""
Specify the CGroup Manager to use; valid values are "systemd" and "cgroupfs"
**static_dir**=""
Directory for persistent libpod files (database, etc)
By default this will be configured relative to where containers/storage
stores containers
**tmp_dir**=""
Directory for temporary files
Must be a tmpfs (wiped after reboot)
**max_log_size**=""
Maximum size of log files (in bytes)
**no_pivot_root**=""
Whether to use chroot instead of pivot_root in the runtime
**cni_config_dir**=""
Directory containing CNI plugin configuration files
**cni_plugin_dir**=""
Directories where CNI plugin binaries may be located
# FILES
/etc/containers/libpod.conf, default libpod configuration path
# HISTORY
Apr 2018, Originally compiled by Nathan Williams <nath.e.will@gmail.com>