464d6852de
Also set default level of logging to errors, we should not see info messages in the kpod command line. While adding this patch, I found missing options in kpod command line and bash completions, so I added them in. Also fixed some sorting issues in the way commands are displayer in help or in bash completions. Finally fixed the error message to be output on failure using logrus.Errorf, so we don't get the stack any longer. Also updated README.md with missing kpod commands. Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
65 lines
1.7 KiB
Markdown
65 lines
1.7 KiB
Markdown
% kpod(1) kpod - Simple management tool for pods and images
|
|
% Dan Walsh
|
|
# kpod "1" "September 2016" "kpod"
|
|
## NAME
|
|
kpod - Simple management tool for containers and images
|
|
|
|
## SYNOPSIS
|
|
**kpod** [*options*] COMMAND
|
|
|
|
# DESCRIPTION
|
|
kpod is a simple client only tool to help with debugging issues when daemons
|
|
such as CRI runtime and the kubelet are not responding or failing. A shared API
|
|
layer could be created to share code between the daemon and kpod. kpod does not
|
|
require any daemon running. kpod utilizes the same underlying components that
|
|
crio uses i.e. containers/image, container/storage, oci-runtime-tool/generate,
|
|
runc or any other OCI compatible runtime. kpod shares state with crio and so
|
|
has the capability to debug pods/images created by crio.
|
|
|
|
**kpod [GLOBAL OPTIONS]**
|
|
|
|
## GLOBAL OPTIONS
|
|
|
|
**--help, -h**
|
|
Print usage statement
|
|
|
|
**--config value, -c**=**"config.file"**
|
|
Path of a config file detailing container server configuration options
|
|
|
|
**--debug**
|
|
Print debugging information
|
|
|
|
**--root**=**value**
|
|
Path to the root directory in which data, including images, is stored
|
|
|
|
**--runroot**=**value**
|
|
Path to the 'run directory' where all state information is stored
|
|
|
|
**--storage-driver, -s**=**value**
|
|
Select which storage driver is used to manage storage of images and containers (default is overlay)
|
|
|
|
**--storage-opt**=**value**
|
|
Used to pass an option to the storage driver
|
|
|
|
**--version, -v**
|
|
Print the version
|
|
|
|
## COMMANDS
|
|
|
|
### images
|
|
List images in local storage
|
|
|
|
### rmi
|
|
Removes one or more locally stored images
|
|
|
|
### tag
|
|
Add one or more additional names to locally-stored image
|
|
|
|
### info
|
|
Displays system information
|
|
|
|
## SEE ALSO
|
|
crio(8), crio.conf(5)
|
|
|
|
## HISTORY
|
|
Dec 2016, Originally compiled by Dan Walsh <dwalsh@redhat.com>
|