Rename all references to kpod to podman

The decision is in, kpod is going to be named podman.

Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>

Closes: #145
Approved by: umohnani8
This commit is contained in:
Daniel J Walsh
2017-12-15 16:58:36 -05:00
committed by Atomic Bot
parent de3468e120
commit 5770dc2640
149 changed files with 2389 additions and 20841 deletions

View File

@ -36,7 +36,7 @@ Briefly describe the problem you are having in a few paragraphs.
**Additional information you deem important (e.g. issue happens only occasionally):** **Additional information you deem important (e.g. issue happens only occasionally):**
**Output of `kpod version`:** **Output of `podman version`:**
``` ```
(paste your output here) (paste your output here)

View File

@ -12,7 +12,7 @@ required: true
timeout: 45m timeout: 45m
tests: tests:
- CRIO_ROOT=/var/tmp/checkout KPOD_BINARY=/usr/bin/kpod CONMON_BINARY=/usr/libexec/crio/conmon PAPR=1 sh .papr.sh - CRIO_ROOT=/var/tmp/checkout PODMAN_BINARY=/usr/bin/podman CONMON_BINARY=/usr/libexec/crio/conmon PAPR=1 sh .papr.sh
packages: packages:
- bats - bats

View File

@ -42,6 +42,6 @@ ${LINTER} \
--exclude='duplicate of.*_test.go.*\(dupl\)$'\ --exclude='duplicate of.*_test.go.*\(dupl\)$'\
--exclude='cmd\/client\/.*\.go.*\(dupl\)$'\ --exclude='cmd\/client\/.*\.go.*\(dupl\)$'\
--exclude='vendor\/.*'\ --exclude='vendor\/.*'\
--exclude='kpod\/.*'\ --exclude='podman\/.*'\
--exclude='server\/seccomp\/.*\.go.*$'\ --exclude='server\/seccomp\/.*\.go.*$'\
${PKGS[@]} ${PKGS[@]}

View File

@ -24,7 +24,7 @@ COMMIT_NO := $(shell git rev-parse HEAD 2> /dev/null || true)
GIT_COMMIT := $(if $(shell git status --porcelain --untracked-files=no),"${COMMIT_NO}-dirty","${COMMIT_NO}") GIT_COMMIT := $(if $(shell git status --porcelain --untracked-files=no),"${COMMIT_NO}-dirty","${COMMIT_NO}")
BUILD_INFO := $(shell date +%s) BUILD_INFO := $(shell date +%s)
KPOD_VERSION := ${shell cat ./KPOD_VERSION} PODMAN_VERSION := ${shell cat ./PODMAN_VERSION}
# If GOPATH not specified, use one in the local directory # If GOPATH not specified, use one in the local directory
ifeq ($(GOPATH),) ifeq ($(GOPATH),)
@ -38,9 +38,9 @@ GOPKGBASEDIR := $(shell dirname "$(GOPKGDIR)")
VPATH := $(VPATH):$(GOPATH) VPATH := $(VPATH):$(GOPATH)
SHRINKFLAGS := -s -w SHRINKFLAGS := -s -w
BASE_LDFLAGS := ${SHRINKFLAGS} -X main.gitCommit=${GIT_COMMIT} -X main.buildInfo=${BUILD_INFO} BASE_LDFLAGS := ${SHRINKFLAGS} -X main.gitCommit=${GIT_COMMIT} -X main.buildInfo=${BUILD_INFO}
KPOD_LDFLAGS := -X main.kpodVersion=${KPOD_VERSION} PODMAN_LDFLAGS := -X main.podmanVersion=${PODMAN_VERSION}
LDFLAGS := -ldflags '${BASE_LDFLAGS}' LDFLAGS := -ldflags '${BASE_LDFLAGS}'
LDFLAGS_KPOD := -ldflags '${BASE_LDFLAGS} ${KPOD_LDFLAGS}' LDFLAGS_PODMAN := -ldflags '${BASE_LDFLAGS} ${PODMAN_LDFLAGS}'
BOX="fedora_atomic" BOX="fedora_atomic"
@ -52,7 +52,7 @@ help:
@echo "Usage: make <target>" @echo "Usage: make <target>"
@echo @echo
@echo " * 'install' - Install binaries to system locations" @echo " * 'install' - Install binaries to system locations"
@echo " * 'binaries' - Build conmon and kpod" @echo " * 'binaries' - Build conmon and podman"
@echo " * 'integration' - Execute integration tests" @echo " * 'integration' - Execute integration tests"
@echo " * 'clean' - Clean artifacts" @echo " * 'clean' - Clean artifacts"
@echo " * 'lint' - Execute the source code linter" @echo " * 'lint' - Execute the source code linter"
@ -87,8 +87,8 @@ test/copyimg/copyimg: .gopathok $(wildcard test/copyimg/*.go)
test/checkseccomp/checkseccomp: .gopathok $(wildcard test/checkseccomp/*.go) test/checkseccomp/checkseccomp: .gopathok $(wildcard test/checkseccomp/*.go)
$(GO) build $(LDFLAGS) -tags "$(BUILDTAGS) containers_image_ostree_stub" -o $@ $(PROJECT)/test/checkseccomp $(GO) build $(LDFLAGS) -tags "$(BUILDTAGS) containers_image_ostree_stub" -o $@ $(PROJECT)/test/checkseccomp
kpod: .gopathok $(shell hack/find-godeps.sh $(GOPKGDIR) cmd/kpod $(PROJECT)) podman: .gopathok $(shell hack/find-godeps.sh $(GOPKGDIR) cmd/podman $(PROJECT))
$(GO) build -i $(LDFLAGS_KPOD) -tags "$(BUILDTAGS)" -o bin/$@ $(PROJECT)/cmd/kpod $(GO) build -i $(LDFLAGS_PODMAN) -tags "$(BUILDTAGS)" -o bin/$@ $(PROJECT)/cmd/podman
clean: clean:
ifneq ($(GOPATH),) ifneq ($(GOPATH),)
@ -99,7 +99,7 @@ endif
rm -fr test/testdata/redis-image rm -fr test/testdata/redis-image
find . -name \*~ -delete find . -name \*~ -delete
find . -name \#\* -delete find . -name \#\* -delete
rm -f bin/kpod rm -f bin/podman
make -C conmon clean make -C conmon clean
rm -f test/bin2img/bin2img rm -f test/bin2img/bin2img
rm -f test/copyimg/copyimg rm -f test/copyimg/copyimg
@ -123,7 +123,7 @@ localintegration: test-binaries
vagrant-check: vagrant-check:
BOX=$(BOX) sh ./vagrant.sh BOX=$(BOX) sh ./vagrant.sh
binaries: conmon kpod binaries: conmon podman
test-binaries: test/bin2img/bin2img test/copyimg/copyimg test/checkseccomp/checkseccomp test-binaries: test/bin2img/bin2img test/copyimg/copyimg test/checkseccomp/checkseccomp
@ -138,7 +138,7 @@ docs: $(MANPAGES)
install: .gopathok install.bin install.man install: .gopathok install.bin install.man
install.bin: install.bin:
install ${SELINUXOPT} -D -m 755 bin/kpod $(BINDIR)/kpod install ${SELINUXOPT} -D -m 755 bin/podman $(BINDIR)/podman
install ${SELINUXOPT} -D -m 755 bin/conmon $(LIBEXECDIR)/crio/conmon install ${SELINUXOPT} -D -m 755 bin/conmon $(LIBEXECDIR)/crio/conmon
install.man: install.man:
@ -151,7 +151,7 @@ install.config:
install.completions: install.completions:
install ${SELINUXOPT} -d -m 755 ${BASHINSTALLDIR} install ${SELINUXOPT} -d -m 755 ${BASHINSTALLDIR}
install ${SELINUXOPT} -m 644 -D completions/bash/kpod ${BASHINSTALLDIR} install ${SELINUXOPT} -m 644 -D completions/bash/podman ${BASHINSTALLDIR}
uninstall: uninstall:
rm -f $(LIBEXECDIR)/crio/conmon rm -f $(LIBEXECDIR)/crio/conmon

View File

@ -1,4 +1,4 @@
![KPOD logo](https://cdn.rawgit.com/kubernetes-incubator/cri-o/master/logo/crio-logo.svg) ![PODMAN logo](https://cdn.rawgit.com/kubernetes-incubator/cri-o/master/logo/crio-logo.svg)
# libpod - library for running OCI-based containers in Pods # libpod - library for running OCI-based containers in Pods
### Status: Development ### Status: Development
@ -6,9 +6,9 @@
## What is the scope of this project? ## What is the scope of this project?
libpod provides a library for applications looking to use the Container Pod concept popularized by Kubernetes. libpod provides a library for applications looking to use the Container Pod concept popularized by Kubernetes.
libpod also contains a tool kpod, which allows you to manage Pods, Containers, and Container Images. libpod also contains a tool podman, which allows you to manage Pods, Containers, and Container Images.
At a high level, we expect the scope of libpod/kpod to the following functionalities: At a high level, we expect the scope of libpod/podman to the following functionalities:
* Support multiple image formats including the existing Docker/OCI image formats * Support multiple image formats including the existing Docker/OCI image formats
* Support for multiple means to download images including trust & image verification * Support for multiple means to download images including trust & image verification
@ -33,53 +33,53 @@ libpod is currently in active development.
## Commands ## Commands
| Command | Description | Demo| | Command | Description | Demo|
| ---------------------------------------------------- | --------------------------------------------------------------------------|-----| | ---------------------------------------------------- | --------------------------------------------------------------------------|-----|
| [kpod(1)](/docs/kpod.1.md) | Simple management tool for pods and images || | [podman(1)](/docs/podman.1.md) | Simple management tool for pods and images ||
| [kpod-attach(1)](/docs/kpod-attach.1.md) | Attach to a running container. | [podman-attach(1)](/docs/podman-attach.1.md) | Attach to a running container.
| [kpod-cp(1)](/docs/kpod-cp.1.md) | Instead of providing a `kpod cp` command, the man page `kpod-cp` describes how to use the `kpod mount` command to have even more flexibility and functionality.|| | [podman-cp(1)](/docs/podman-cp.1.md) | Instead of providing a `podman cp` command, the man page `podman-cp` describes how to use the `podman mount` command to have even more flexibility and functionality.||
| [kpod-diff(1)](/docs/kpod-diff.1.md) | Inspect changes on a container or image's filesystem |[![...](/docs/play.png)](https://asciinema.org/a/FXfWB9CKYFwYM4EfqW3NSZy1G)| | [podman-diff(1)](/docs/podman-diff.1.md) | Inspect changes on a container or image's filesystem |[![...](/docs/play.png)](https://asciinema.org/a/FXfWB9CKYFwYM4EfqW3NSZy1G)|
| [kpod-exec(1)](/docs/kpod-exec.1.md) | Execute a command in a running container. | [podman-exec(1)](/docs/podman-exec.1.md) | Execute a command in a running container.
| [kpod-export(1)](/docs/kpod-export.1.md) | Export container's filesystem contents as a tar archive |[![...](/docs/play.png)](https://asciinema.org/a/913lBIRAg5hK8asyIhhkQVLtV)| | [podman-export(1)](/docs/podman-export.1.md) | Export container's filesystem contents as a tar archive |[![...](/docs/play.png)](https://asciinema.org/a/913lBIRAg5hK8asyIhhkQVLtV)|
| [kpod-history(1)](/docs/kpod-history.1.md) | Shows the history of an image |[![...](/docs/play.png)](https://asciinema.org/a/bCvUQJ6DkxInMELZdc5DinNSx)| | [podman-history(1)](/docs/podman-history.1.md) | Shows the history of an image |[![...](/docs/play.png)](https://asciinema.org/a/bCvUQJ6DkxInMELZdc5DinNSx)|
| [kpod-images(1)](/docs/kpod-images.1.md) | List images in local storage |[![...](/docs/play.png)](https://asciinema.org/a/133649)| | [podman-images(1)](/docs/podman-images.1.md) | List images in local storage |[![...](/docs/play.png)](https://asciinema.org/a/133649)|
| [kpod-info(1)](/docs/kpod-info.1.md) | Display system information || | [podman-info(1)](/docs/podman-info.1.md) | Display system information ||
| [kpod-inspect(1)](/docs/kpod-inspect.1.md) | Display the configuration of a container or image |[![...](/docs/play.png)](https://asciinema.org/a/133418)| | [podman-inspect(1)](/docs/podman-inspect.1.md) | Display the configuration of a container or image |[![...](/docs/play.png)](https://asciinema.org/a/133418)|
| [kpod-kill(1)](/docs/kpod-kill.1.md) | Kill the main process in one or more running containers |[![...](/docs/play.png)](https://asciinema.org/a/3jNos0A5yzO4hChu7ddKkUPw7)| | [podman-kill(1)](/docs/podman-kill.1.md) | Kill the main process in one or more running containers |[![...](/docs/play.png)](https://asciinema.org/a/3jNos0A5yzO4hChu7ddKkUPw7)|
| [kpod-load(1)](/docs/kpod-load.1.md) | Load an image from docker archive or oci |[![...](/docs/play.png)](https://asciinema.org/a/kp8kOaexEhEa20P1KLZ3L5X4g)| | [podman-load(1)](/docs/podman-load.1.md) | Load an image from docker archive or oci |[![...](/docs/play.png)](https://asciinema.org/a/kp8kOaexEhEa20P1KLZ3L5X4g)|
| [kpod-login(1)](/docs/kpod-login.1.md) | Login to a container registry |[![...](/docs/play.png)](https://asciinema.org/a/oNiPgmfo1FjV2YdesiLpvihtV)| | [podman-login(1)](/docs/podman-login.1.md) | Login to a container registry |[![...](/docs/play.png)](https://asciinema.org/a/oNiPgmfo1FjV2YdesiLpvihtV)|
| [kpod-logout(1)](/docs/kpod-logout.1.md) | Logout of a container registry |[![...](/docs/play.png)](https://asciinema.org/a/oNiPgmfo1FjV2YdesiLpvihtV)| | [podman-logout(1)](/docs/podman-logout.1.md) | Logout of a container registry |[![...](/docs/play.png)](https://asciinema.org/a/oNiPgmfo1FjV2YdesiLpvihtV)|
| [kpod-logs(1)](/docs/kpod-logs.1.md) | Display the logs of a container || | [podman-logs(1)](/docs/podman-logs.1.md) | Display the logs of a container ||
| [kpod-mount(1)](/docs/kpod-mount.1.md) | Mount a working container's root filesystem || | [podman-mount(1)](/docs/podman-mount.1.md) | Mount a working container's root filesystem ||
| [kpod-pause(1)](/docs/kpod-pause.1.md) | Pause one or more running containers |[![...](/docs/play.png)](https://asciinema.org/a/141292)| | [podman-pause(1)](/docs/podman-pause.1.md) | Pause one or more running containers |[![...](/docs/play.png)](https://asciinema.org/a/141292)|
| [kpod-ps(1)](/docs/kpod-ps.1.md) | Prints out information about containers |[![...](/docs/play.png)](https://asciinema.org/a/bbT41kac6CwZ5giESmZLIaTLR)| | [podman-ps(1)](/docs/podman-ps.1.md) | Prints out information about containers |[![...](/docs/play.png)](https://asciinema.org/a/bbT41kac6CwZ5giESmZLIaTLR)|
| [kpod-pull(1)](/docs/kpod-pull.1.md) | Pull an image from a registry |[![...](/docs/play.png)](https://asciinema.org/a/lr4zfoynHJOUNu1KaXa1dwG2X)| | [podman-pull(1)](/docs/podman-pull.1.md) | Pull an image from a registry |[![...](/docs/play.png)](https://asciinema.org/a/lr4zfoynHJOUNu1KaXa1dwG2X)|
| [kpod-push(1)](/docs/kpod-push.1.md) | Push an image to a specified destination |[![...](/docs/play.png)](https://asciinema.org/a/133276)| | [podman-push(1)](/docs/podman-push.1.md) | Push an image to a specified destination |[![...](/docs/play.png)](https://asciinema.org/a/133276)|
| [kpod-rename(1)](/docs/kpod-rename.1.md) | Rename a container || | [podman-rename(1)](/docs/podman-rename.1.md) | Rename a container ||
| [kpod-rm(1)](/docs/kpod-rm.1.md) | Removes one or more containers |[![...](/docs/play.png)](https://asciinema.org/a/7EMk22WrfGtKWmgHJX9Nze1Qp)| | [podman-rm(1)](/docs/podman-rm.1.md) | Removes one or more containers |[![...](/docs/play.png)](https://asciinema.org/a/7EMk22WrfGtKWmgHJX9Nze1Qp)|
| [kpod-rmi(1)](/docs/kpod-rmi.1.md) | Removes one or more images |[![...](/docs/play.png)](https://asciinema.org/a/133799)| | [podman-rmi(1)](/docs/podman-rmi.1.md) | Removes one or more images |[![...](/docs/play.png)](https://asciinema.org/a/133799)|
| [kpod-save(1)](/docs/kpod-save.1.md) | Saves an image to an archive |[![...](/docs/play.png)](https://asciinema.org/a/kp8kOaexEhEa20P1KLZ3L5X4g)| | [podman-save(1)](/docs/podman-save.1.md) | Saves an image to an archive |[![...](/docs/play.png)](https://asciinema.org/a/kp8kOaexEhEa20P1KLZ3L5X4g)|
| [kpod-start(1)](/docs/kpod-start.1.md) | Starts one or more containers | [podman-start(1)](/docs/podman-start.1.md) | Starts one or more containers
| [kpod-stats(1)](/docs/kpod-stats.1.md) | Display a live stream of one or more containers' resource usage statistics|| | [podman-stats(1)](/docs/podman-stats.1.md) | Display a live stream of one or more containers' resource usage statistics||
| [kpod-stop(1)](/docs/kpod-stop.1.md) | Stops one or more running containers || | [podman-stop(1)](/docs/podman-stop.1.md) | Stops one or more running containers ||
| [kpod-tag(1)](/docs/kpod-tag.1.md) | Add an additional name to a local image |[![...](/docs/play.png)](https://asciinema.org/a/133803)| | [podman-tag(1)](/docs/podman-tag.1.md) | Add an additional name to a local image |[![...](/docs/play.png)](https://asciinema.org/a/133803)|
| [kpod-top(1)](/docs/kpod-top.1.md) | Display the running processes of a container | [podman-top(1)](/docs/podman-top.1.md) | Display the running processes of a container
| [kpod-umount(1)](/docs/kpod-umount.1.md) | Unmount a working container's root filesystem || | [podman-umount(1)](/docs/podman-umount.1.md) | Unmount a working container's root filesystem ||
| [kpod-unpause(1)](/docs/kpod-unpause.1.md) | Unpause one or more running containers |[![...](/docs/play.png)](https://asciinema.org/a/141292)| | [podman-unpause(1)](/docs/podman-unpause.1.md) | Unpause one or more running containers |[![...](/docs/play.png)](https://asciinema.org/a/141292)|
| [kpod-version(1)](/docs/kpod-version.1.md) | Display the version information |[![...](/docs/play.png)](https://asciinema.org/a/mfrn61pjZT9Fc8L4NbfdSqfgu)| | [podman-version(1)](/docs/podman-version.1.md) | Display the version information |[![...](/docs/play.png)](https://asciinema.org/a/mfrn61pjZT9Fc8L4NbfdSqfgu)|
| [kpod-wait(1)](/docs/kpod-wait.1.md) | Wait on one or more containers to stop and print their exit codes|| | [podman-wait(1)](/docs/podman-wait.1.md) | Wait on one or more containers to stop and print their exit codes||
## OCI Hooks Support ## OCI Hooks Support
[KPOD configures OCI Hooks to run when launching a container](./hooks.md) [PODMAN configures OCI Hooks to run when launching a container](./hooks.md)
## KPOD Usage Transfer ## PODMAN Usage Transfer
[Useful information for ops and dev transfer as it relates to infrastructure that utilizes KPOD](/transfer.md) [Useful information for ops and dev transfer as it relates to infrastructure that utilizes PODMAN](/transfer.md)
## Communication ## Communication
For async communication and long running discussions please use issues and pull requests on the github repo. This will be the best place to discuss design and implementation. For async communication and long running discussions please use issues and pull requests on the github repo. This will be the best place to discuss design and implementation.
For sync communication we have an IRC channel #KPOD, on chat.freenode.net, that everyone is welcome to join and chat about development. For sync communication we have an IRC channel #PODMAN, on chat.freenode.net, that everyone is welcome to join and chat about development.
## [Installation Instructions](install.md) ## [Installation Instructions](install.md)

View File

@ -1,8 +1,8 @@
# kpod - Simple debugging tool for pods and images # podman - Simple debugging tool for pods and images
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 podman 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 failing. A shared API layer could be created to share code between the daemon and podman. podman does not require any daemon running. podman
utilizes the same underlying components that crio uses i.e. containers/image, container/storage, oci-runtime-tool/generate, runc or 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. any other OCI compatible runtime. podman shares state with crio and so has the capability to debug pods/images created by crio.
## Use cases ## Use cases
1. List pods. 1. List pods.

View File

@ -20,7 +20,7 @@ var (
Usage: "Do not attach STDIN. The default is false.", Usage: "Do not attach STDIN. The default is false.",
}, },
} }
attachDescription = "The kpod attach command allows you to attach to a running container using the container's ID or name, either to view its ongoing output or to control it interactively." attachDescription = "The podman attach command allows you to attach to a running container using the container's ID or name, either to view its ongoing output or to control it interactively."
attachCommand = cli.Command{ attachCommand = cli.Command{
Name: "attach", Name: "attach",
Usage: "Attach to a running container", Usage: "Attach to a running container",

View File

@ -12,7 +12,7 @@ import (
func TestGetStore(t *testing.T) { func TestGetStore(t *testing.T) {
t.Skip("FIX THIS!") t.Skip("FIX THIS!")
//cmd/kpod/common_test.go:27: cannot use c (type *cli.Context) as type *libkpod.Config in argument to getStore //cmd/podman/common_test.go:27: cannot use c (type *cli.Context) as type *libkpod.Config in argument to getStore
// Make sure the tests are running as root // Make sure the tests are running as root
skipTestIfNotRoot(t) skipTestIfNotRoot(t)

View File

@ -128,7 +128,7 @@ type createConfig struct {
var createDescription = "Creates a new container from the given image or" + var createDescription = "Creates a new container from the given image or" +
" storage and prepares it for running the specified command. The" + " storage and prepares it for running the specified command. The" +
" container ID is then printed to stdout. You can then start it at" + " container ID is then printed to stdout. You can then start it at" +
" any time with the kpod start <container_id> command. The container" + " any time with the podman start <container_id> command. The container" +
" will be created with the initial state 'created'." " will be created with the initial state 'created'."
var createCommand = cli.Command{ var createCommand = cli.Command{

View File

@ -5,7 +5,7 @@ import (
"github.com/containers/storage/pkg/archive" "github.com/containers/storage/pkg/archive"
"github.com/pkg/errors" "github.com/pkg/errors"
"github.com/projectatomic/libpod/cmd/kpod/formats" "github.com/projectatomic/libpod/cmd/podman/formats"
"github.com/urfave/cli" "github.com/urfave/cli"
) )
@ -79,7 +79,7 @@ func diffCmd(c *cli.Context) error {
} }
if len(c.Args()) != 1 { if len(c.Args()) != 1 {
return errors.Errorf("container, image, or layer name must be specified: kpod diff [options [...]] ID-NAME") return errors.Errorf("container, image, or layer name must be specified: podman diff [options [...]] ID-NAME")
} }
runtime, err := getRuntime(c) runtime, err := getRuntime(c)

View File

@ -29,7 +29,7 @@ var (
}, },
} }
execDescription = ` execDescription = `
kpod exec podman exec
Run a command in a running container Run a command in a running container
` `

View File

@ -10,7 +10,7 @@ import (
units "github.com/docker/go-units" units "github.com/docker/go-units"
"github.com/opencontainers/image-spec/specs-go/v1" "github.com/opencontainers/image-spec/specs-go/v1"
"github.com/pkg/errors" "github.com/pkg/errors"
"github.com/projectatomic/libpod/cmd/kpod/formats" "github.com/projectatomic/libpod/cmd/podman/formats"
"github.com/urfave/cli" "github.com/urfave/cli"
) )
@ -99,7 +99,7 @@ func historyCmd(c *cli.Context) error {
return errors.Errorf("an image name must be specified") return errors.Errorf("an image name must be specified")
} }
if len(args) > 1 { if len(args) > 1 {
return errors.Errorf("Kpod history takes at most 1 argument") return errors.Errorf("podman history takes at most 1 argument")
} }
imgName := args[0] imgName := args[0]

View File

@ -10,7 +10,7 @@ import (
"github.com/docker/go-units" "github.com/docker/go-units"
digest "github.com/opencontainers/go-digest" digest "github.com/opencontainers/go-digest"
"github.com/pkg/errors" "github.com/pkg/errors"
"github.com/projectatomic/libpod/cmd/kpod/formats" "github.com/projectatomic/libpod/cmd/podman/formats"
"github.com/projectatomic/libpod/libpod" "github.com/projectatomic/libpod/libpod"
"github.com/projectatomic/libpod/libpod/common" "github.com/projectatomic/libpod/libpod/common"
"github.com/urfave/cli" "github.com/urfave/cli"
@ -107,7 +107,7 @@ func imagesCmd(c *cli.Context) error {
imageInput = c.Args().Get(0) imageInput = c.Args().Get(0)
} }
if len(c.Args()) > 1 { if len(c.Args()) > 1 {
return errors.New("'kpod images' requires at most 1 argument") return errors.New("'podman images' requires at most 1 argument")
} }
params, err := runtime.ParseImageFilter(imageInput, c.String("filter")) params, err := runtime.ParseImageFilter(imageInput, c.String("filter"))

View File

@ -4,7 +4,7 @@ import (
"runtime" "runtime"
"github.com/pkg/errors" "github.com/pkg/errors"
"github.com/projectatomic/libpod/cmd/kpod/formats" "github.com/projectatomic/libpod/cmd/podman/formats"
"github.com/projectatomic/libpod/libpod" "github.com/projectatomic/libpod/libpod"
"github.com/urfave/cli" "github.com/urfave/cli"
) )
@ -14,7 +14,7 @@ var (
infoCommand = cli.Command{ infoCommand = cli.Command{
Name: "info", Name: "info",
Usage: infoDescription, Usage: infoDescription,
Description: `Information display here pertain to the host, current storage stats, and build of kpod. Useful for the user and when reporting issues.`, Description: `Information display here pertain to the host, current storage stats, and build of podman. Useful for the user and when reporting issues.`,
Flags: infoFlags, Flags: infoFlags,
Action: infoCmd, Action: infoCmd,
ArgsUsage: "", ArgsUsage: "",
@ -78,7 +78,7 @@ func debugInfo(c *cli.Context) map[string]interface{} {
info := map[string]interface{}{} info := map[string]interface{}{}
info["compiler"] = runtime.Compiler info["compiler"] = runtime.Compiler
info["go version"] = runtime.Version() info["go version"] = runtime.Version()
info["kpod version"] = c.App.Version info["podman version"] = c.App.Version
info["git commit"] = gitCommit info["git commit"] = gitCommit
return info return info
} }

View File

@ -5,7 +5,7 @@ import (
specs "github.com/opencontainers/runtime-spec/specs-go" specs "github.com/opencontainers/runtime-spec/specs-go"
"github.com/pkg/errors" "github.com/pkg/errors"
"github.com/projectatomic/libpod/cmd/kpod/formats" "github.com/projectatomic/libpod/cmd/podman/formats"
"github.com/projectatomic/libpod/libpod" "github.com/projectatomic/libpod/libpod"
"github.com/sirupsen/logrus" "github.com/sirupsen/logrus"
"github.com/urfave/cli" "github.com/urfave/cli"
@ -47,7 +47,7 @@ var (
func inspectCmd(c *cli.Context) error { func inspectCmd(c *cli.Context) error {
args := c.Args() args := c.Args()
if len(args) == 0 { if len(args) == 0 {
return errors.Errorf("container or image name must be specified: kpod inspect [options [...]] name") return errors.Errorf("container or image name must be specified: podman inspect [options [...]] name")
} }
if len(args) > 1 { if len(args) > 1 {
return errors.Errorf("too many arguments specified") return errors.Errorf("too many arguments specified")
@ -269,7 +269,7 @@ func getCgroup(spec *specs.Spec) string {
return cgroup return cgroup
} }
// ContainerData holds the kpod inspect data for a container // ContainerData holds the podman inspect data for a container
type ContainerData struct { type ContainerData struct {
CtrInspectData *libpod.ContainerInspectData `json:"CtrInspectData"` CtrInspectData *libpod.ContainerInspectData `json:"CtrInspectData"`
HostConfig *HostConfig `json:"HostConfig"` HostConfig *HostConfig `json:"HostConfig"`

View File

@ -69,7 +69,7 @@ func loadCmd(c *cli.Context) error {
} }
// checking if loading from pipe // checking if loading from pipe
if !fi.Mode().IsRegular() { if !fi.Mode().IsRegular() {
outFile, err := ioutil.TempFile("/var/tmp", "kpod") outFile, err := ioutil.TempFile("/var/tmp", "podman")
if err != nil { if err != nil {
return errors.Errorf("error creating file %v", err) return errors.Errorf("error creating file %v", err)
} }

View File

@ -38,8 +38,8 @@ var (
Usage: "Output the specified number of LINES at the end of the logs. Defaults to 0, which prints all lines", Usage: "Output the specified number of LINES at the end of the logs. Defaults to 0, which prints all lines",
}, },
} }
logsDescription = "The kpod logs command batch-retrieves whatever logs are present for a container at the time of execution. This does not guarantee execution" + logsDescription = "The podman logs command batch-retrieves whatever logs are present for a container at the time of execution. This does not guarantee execution" +
"order when combined with kpod run (i.e. your run may not have generated any logs at the time you execute kpod logs" "order when combined with podman run (i.e. your run may not have generated any logs at the time you execute podman logs"
logsCommand = cli.Command{ logsCommand = cli.Command{
Name: "logs", Name: "logs",
Usage: "Fetch the logs of a container", Usage: "Fetch the logs of a container",
@ -63,7 +63,7 @@ func logsCmd(c *cli.Context) error {
args := c.Args() args := c.Args()
if len(args) != 1 { if len(args) != 1 {
return errors.Errorf("'kpod logs' requires exactly one container name/ID") return errors.Errorf("'podman logs' requires exactly one container name/ID")
} }
sinceTime := time.Time{} sinceTime := time.Time{}

View File

@ -13,7 +13,7 @@ import (
// This is populated by the Makefile from the VERSION file // This is populated by the Makefile from the VERSION file
// in the repository // in the repository
var kpodVersion = "" var podmanVersion = ""
func main() { func main() {
debug := false debug := false
@ -24,12 +24,12 @@ func main() {
} }
app := cli.NewApp() app := cli.NewApp()
app.Name = "kpod" app.Name = "podman"
app.Usage = "manage pods and images" app.Usage = "manage pods and images"
var v string var v string
if kpodVersion != "" { if podmanVersion != "" {
v = kpodVersion v = podmanVersion
} }
app.Version = v app.Version = v

View File

@ -5,16 +5,16 @@ import (
"fmt" "fmt"
"github.com/pkg/errors" "github.com/pkg/errors"
of "github.com/projectatomic/libpod/cmd/kpod/formats" of "github.com/projectatomic/libpod/cmd/podman/formats"
"github.com/urfave/cli" "github.com/urfave/cli"
) )
var ( var (
mountDescription = ` mountDescription = `
kpod mount podman mount
Lists all mounted containers mount points Lists all mounted containers mount points
kpod mount CONTAINER-NAME-OR-ID podman mount CONTAINER-NAME-OR-ID
Mounts the specified container and outputs the mountpoint Mounts the specified container and outputs the mountpoint
` `

View File

@ -10,7 +10,7 @@ import (
var ( var (
pauseDescription = ` pauseDescription = `
kpod pause podman pause
Pauses one or more running containers. The container name or ID can be used. Pauses one or more running containers. The container name or ID can be used.
` `

View File

@ -13,7 +13,7 @@ import (
"github.com/docker/go-units" "github.com/docker/go-units"
specs "github.com/opencontainers/runtime-spec/specs-go" specs "github.com/opencontainers/runtime-spec/specs-go"
"github.com/pkg/errors" "github.com/pkg/errors"
"github.com/projectatomic/libpod/cmd/kpod/formats" "github.com/projectatomic/libpod/cmd/podman/formats"
"github.com/projectatomic/libpod/libpod" "github.com/projectatomic/libpod/libpod"
"github.com/urfave/cli" "github.com/urfave/cli"
"k8s.io/apimachinery/pkg/fields" "k8s.io/apimachinery/pkg/fields"

View File

@ -64,7 +64,7 @@ var (
pushDescription = fmt.Sprintf(` pushDescription = fmt.Sprintf(`
Pushes an image to a specified location. Pushes an image to a specified location.
The Image "DESTINATION" uses a "transport":"details" format. The Image "DESTINATION" uses a "transport":"details" format.
See kpod-push(1) section "DESTINATION" for the expected format`) See podman-push(1) section "DESTINATION" for the expected format`)
pushCommand = cli.Command{ pushCommand = cli.Command{
Name: "push", Name: "push",
@ -81,7 +81,7 @@ func pushCmd(c *cli.Context) error {
args := c.Args() args := c.Args()
if len(args) < 2 { if len(args) < 2 {
return errors.New("kpod push requires exactly 2 arguments") return errors.New("podman push requires exactly 2 arguments")
} }
if err := validateFlags(c, pushFlags); err != nil { if err := validateFlags(c, pushFlags); err != nil {
return err return err

View File

@ -23,7 +23,7 @@ var (
rmDescription = "Remove one or more containers" rmDescription = "Remove one or more containers"
rmCommand = cli.Command{ rmCommand = cli.Command{
Name: "rm", Name: "rm",
Usage: fmt.Sprintf(`kpod rm will remove one or more containers from the host. The container name or ID can be used. Usage: fmt.Sprintf(`podman rm will remove one or more containers from the host. The container name or ID can be used.
This does not remove images. Running containers will not be removed without the -f option.`), This does not remove images. Running containers will not be removed without the -f option.`),
Description: rmDescription, Description: rmDescription,
Flags: rmFlags, Flags: rmFlags,

View File

@ -28,7 +28,7 @@ var (
}, },
} }
startDescription = ` startDescription = `
kpod start podman start
Starts one or more containers. The container name or ID can be used. Starts one or more containers. The container name or ID can be used.
` `

View File

@ -9,7 +9,7 @@ import (
tm "github.com/buger/goterm" tm "github.com/buger/goterm"
"github.com/docker/go-units" "github.com/docker/go-units"
"github.com/pkg/errors" "github.com/pkg/errors"
"github.com/projectatomic/libpod/cmd/kpod/formats" "github.com/projectatomic/libpod/cmd/podman/formats"
"github.com/projectatomic/libpod/libpod" "github.com/projectatomic/libpod/libpod"
"github.com/urfave/cli" "github.com/urfave/cli"
) )

View File

@ -24,7 +24,7 @@ var (
}, },
} }
stopDescription = ` stopDescription = `
kpod stop podman stop
Stops one or more running containers. The container name or ID can be used. Stops one or more running containers. The container name or ID can be used.
A timeout to forcibly stop the container can also be set but defaults to 10 A timeout to forcibly stop the container can also be set but defaults to 10

View File

@ -6,7 +6,7 @@ import (
"strings" "strings"
"github.com/pkg/errors" "github.com/pkg/errors"
"github.com/projectatomic/libpod/cmd/kpod/formats" "github.com/projectatomic/libpod/cmd/podman/formats"
"github.com/projectatomic/libpod/libpod" "github.com/projectatomic/libpod/libpod"
"github.com/urfave/cli" "github.com/urfave/cli"
) )
@ -19,7 +19,7 @@ var (
}, },
} }
topDescription = ` topDescription = `
kpod top podman top
Display the running processes of the container. Display the running processes of the container.
` `

View File

@ -10,7 +10,7 @@ import (
var ( var (
unpauseDescription = ` unpauseDescription = `
kpod unpause podman unpause
Unpauses one or more running containers. The container name or ID can be used. Unpauses one or more running containers. The container name or ID can be used.
` `

View File

@ -40,9 +40,9 @@ func versionCmd(c *cli.Context) error {
return nil return nil
} }
// Cli command to print out the full version of kpod // Cli command to print out the full version of podman
var versionCommand = cli.Command{ var versionCommand = cli.Command{
Name: "version", Name: "version",
Usage: "Display the KPOD Version Information", Usage: "Display the PODMAN Version Information",
Action: versionCmd, Action: versionCmd,
} }

View File

@ -10,7 +10,7 @@ import (
var ( var (
waitDescription = ` waitDescription = `
kpod wait podman wait
Block until one or more containers stop and then print their exit codes Block until one or more containers stop and then print their exit codes
` `

File diff suppressed because it is too large Load Diff

View File

@ -1,44 +0,0 @@
% kpod(1) kpod-export - Simple tool to export a container's filesystem as a tarball
% Urvashi Mohnani
# kpod-export "1" "July 2017" "kpod"
## NAME
kpod-export - Export container's filesystem contents as a tar archive
## SYNOPSIS
**kpod export**
**CONTAINER**
[**--output**|**-o**]
[**--help**|**-h**]
## DESCRIPTION
**kpod export** exports the filesystem of a container and saves it as a tarball
on the local machine. **kpod export** writes to STDOUT by default and can be
redirected to a file using the **output flag**.
**kpod [GLOBAL OPTIONS]**
**kpod export [GLOBAL OPTIONS]**
**kpod export [OPTIONS] CONTAINER**
## OPTIONS
**--output, -o**
Write to a file, default is STDOUT
## EXAMPLES
```
# kpod export -o redis-container.tar 883504668ec465463bc0fe7e63d53154ac3b696ea8d7b233748918664ea90e57
```
```
# kpod export > redis-container.tar 883504668ec465463bc0fe7e63d53154ac3b696ea8d7b233748918664ea90e57
```
## SEE ALSO
kpod(1), kpod-import(1), crio(8), crio.conf(5)
## HISTORY
August 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com>

View File

@ -1,36 +0,0 @@
% kpod(1) kpod-version - Simple tool to view version information
% Vincent Batts
% kpod-version "1" "JULY 2017" "kpod"
## NAME
kpod-info - Display system information
## SYNOPSIS
**kpod** **info** [*options* [...]]
## DESCRIPTION
Information display here pertain to the host, current storage stats, and build of kpod. Useful for the user and when reporting issues.
## OPTIONS
**--debug, -D**
Show additional information
**--format**
Change output format to "json" or a Go template.
## EXAMPLE
`kpod info`
`kpod info --debug --format json| jq .host.kernel`
## SEE ALSO
crio(8), crio.conf(5)

View File

@ -1,24 +0,0 @@
% kpod(1) kpod-pause - Pause one or more containers
% Dan Walsh
# kpod-pause "1" "September 2017" "kpod"
## NAME
kpod pause - Pause one or more containers
## SYNOPSIS
**kpod pause [OPTIONS] CONTAINER [...]**
## DESCRIPTION
Pauses all the processes in one or more containers. You may use container IDs or names as input.
## EXAMPLE
kpod pause mywebserver
kpod pause 860a4b23
## SEE ALSO
kpod(1), kpod-unpause(1)
## HISTORY
September 2017, Originally compiled by Dan Walsh <dwalsh@redhat.com>

View File

@ -1,38 +0,0 @@
% kpod(1) kpod-rm - Remove one or more containers
% Ryan Cole
# kpod-rm "1" "August 2017" "kpod"
## NAME
kpod rm - Remove one or more containers
## SYNOPSIS
**kpod** **rm** [*options* [...]] container
## DESCRIPTION
kpod rm will remove one or more containers from the host. The container name or ID can be used. This does not remove images. Running containers will not be removed without the -f option
## OPTIONS
**--force, f**
Force the removal of a running container
**--all, a**
Remove all containers. Can be used in conjunction with -f as well.
## EXAMPLE
kpod rm mywebserver
kpod rm mywebserver myflaskserver 860a4b23
kpod rm -f 860a4b23
kpod rm -f -a
## SEE ALSO
kpod(1), kpod-rmi(1)
## HISTORY
August 2017, Originally compiled by Ryan Cole <rycole@redhat.com>

View File

@ -1,19 +0,0 @@
% kpod(1) kpod-umount - Unmount a working container's root filesystem.
% Dan Walsh
# kpod-umount "1" "July 2017" "kpod"
## NAME
kpod umount - Unmount a working container's root file system
## SYNOPSIS
**kpod** **umount** **containerID**
## DESCRIPTION
Unmounts the specified container's root file system.
## EXAMPLE
kpod umount containerID
## SEE ALSO
kpod(1), kpod-mount(1)

View File

@ -1,24 +0,0 @@
% kpod(1) kpod-unpause - Unpause one or more containers
% Dan Walsh
# kpod-unpause "1" "September 2017" "kpod"
## NAME
kpod unpause - Unpause one or more containers
## SYNOPSIS
**kpod unpause [OPTIONS] CONTAINER [...]**
## DESCRIPTION
Unpauses the processes in one or more containers. You may use container IDs or names as input.
## EXAMPLE
kpod unpause mywebserver
kpod unpause 860a4b23
## SEE ALSO
kpod(1), kpod-pause(1)
## HISTORY
September 2017, Originally compiled by Dan Walsh <dwalsh@redhat.com>

View File

@ -1,36 +0,0 @@
% kpod(1) kpod-wait - Waits on a container
% Brent Baude
# kpod-wait "1" "September 2017" "kpod"
## NAME
kpod wait - Waits on one or more containers to stop and prints exit code
## SYNOPSIS
**kpod wait**
[**--help**|**-h**]
## DESCRIPTION
Waits on one or more containers to stop. The container can be referred to by its
name or ID. In the case of multiple containers, kpod will wait on each consecutively.
After the container stops, the container's return code is printed.
**kpod [GLOBAL OPTIONS] wait **
## GLOBAL OPTIONS
**--help, -h**
Print usage statement
## EXAMPLES
kpod wait mywebserver
kpod wait 860a4b23
kpod wait mywebserver myftpserver
## SEE ALSO
kpod(1), crio(8), crio.conf(5)
## HISTORY
September 2017, Originally compiled by Brent Baude<bbaude@redhat.com>

View File

@ -1,12 +1,12 @@
% kpod(1) kpod-attach - See the output of pid 1 of a container or enter the container % podman(1) podman-attach - See the output of pid 1 of a container or enter the container
% Dan Walsh % Dan Walsh
# kpod-attach "1" "December 2017" "kpod" # podman-attach "1" "December 2017" "podman"
## NAME ## NAME
kpod-attach - Attach to a running container podman-attach - Attach to a running container
## SYNOPSIS ## SYNOPSIS
**kpod attach [OPTIONS] CONTAINER** **podman attach [OPTIONS] CONTAINER**
## DESCRIPTION ## DESCRIPTION
The attach command allows you to attach to a running container using the container's ID The attach command allows you to attach to a running container using the container's ID
@ -26,15 +26,15 @@ Do not attach STDIN. The default is false.
## EXAMPLES ## ## EXAMPLES ##
``` ```
kpod attach foobar podman attach foobar
[root@localhost /]# [root@localhost /]#
``` ```
``` ```
kpod attach 1234 podman attach 1234
[root@localhost /]# [root@localhost /]#
``` ```
``` ```
kpod attach --no-stdin foobar podman attach --no-stdin foobar
``` ```
## SEE ALSO ## SEE ALSO
kpod(1), kpod-exec(1), kpod-run(1) podman(1), podman-exec(1), podman-run(1)

View File

@ -1,14 +1,14 @@
% kpod(1) kpod-cp - Copy content between container's file system and the host % podman(1) podman-cp - Copy content between container's file system and the host
% Dan Walsh % Dan Walsh
# kpod-cp "1" "August 2017" "kpod" # podman-cp "1" "August 2017" "podman"
## NAME ## NAME
kpod-cp - Copy files/folders between a container and the local filesystem. podman-cp - Copy files/folders between a container and the local filesystem.
## Description ## Description
We chose not to implement the `cp` feature in `kpod` even though the upstream Docker We chose not to implement the `cp` feature in `podman` even though the upstream Docker
project has it. We have a much stronger capability. Using standard kpod-mount project has it. We have a much stronger capability. Using standard podman-mount
and kpod-umount, we can take advantage of the entire linux tool chain, rather and podman-umount, we can take advantage of the entire linux tool chain, rather
then just cp. then just cp.
If a user wants to copy contents out of a container or into a container, they If a user wants to copy contents out of a container or into a container, they
@ -20,27 +20,27 @@ reverse, from the local filesystem to the container.
If you want to copy the /etc/foobar directory out of a container and onto /tmp If you want to copy the /etc/foobar directory out of a container and onto /tmp
on the host, you could execute the following commands: on the host, you could execute the following commands:
mnt=$(kpod mount CONTAINERID) mnt=$(podman mount CONTAINERID)
cp -R ${mnt}/etc/foobar /tmp cp -R ${mnt}/etc/foobar /tmp
kpod umount CONTAINERID podman umount CONTAINERID
If you want to untar a tar ball into a container, you can execute these commands: If you want to untar a tar ball into a container, you can execute these commands:
mnt=$(kpod mount CONTAINERID) mnt=$(podman mount CONTAINERID)
tar xf content.tgz -C ${mnt} tar xf content.tgz -C ${mnt}
kpod umount CONTAINERID podman umount CONTAINERID
One last example, if you want to install a package into a container that One last example, if you want to install a package into a container that
does not have dnf installed, you could execute something like: does not have dnf installed, you could execute something like:
mnt=$(kpod mount CONTAINERID) mnt=$(podman mount CONTAINERID)
dnf install --installroot=${mnt} httpd dnf install --installroot=${mnt} httpd
chroot ${mnt} rm -rf /var/log/dnf /var/cache/dnf chroot ${mnt} rm -rf /var/log/dnf /var/cache/dnf
kpod umount CONTAINERID podman umount CONTAINERID
This shows that using `kpod mount` and `kpod umount` you can use all of the This shows that using `podman mount` and `podman umount` you can use all of the
standard linux tools for moving files into and out of containers, not just standard linux tools for moving files into and out of containers, not just
the cp command. the cp command.
## SEE ALSO ## SEE ALSO
kpod(1), kpod-mount(1), kpod-umount(1) podman(1), podman-mount(1), podman-umount(1)

View File

@ -1,19 +1,19 @@
% kpod(1) kpod-create - Create a new container % podman(1) podman-create - Create a new container
% Dan Walsh % Dan Walsh
kpod-create - Create a new container podman-create - Create a new container
# SYNOPSIS # SYNOPSIS
**kpod create** [*options* [...]] IMAGE [COMMAND] [ARG...] **podman create** [*options* [...]] IMAGE [COMMAND] [ARG...]
# DESCRIPTION # DESCRIPTION
Creates a writeable container layer over the specified image and prepares it for Creates a writeable container layer over the specified image and prepares it for
running the specified command. The container ID is then printed to STDOUT. This running the specified command. The container ID is then printed to STDOUT. This
is similar to **kpod run -d** except the container is never started. You can is similar to **podman run -d** except the container is never started. You can
then use the **kpod start <container_id>** command to start the container at then use the **podman start <container_id>** command to start the container at
any point. any point.
The initial status of the container created with **kpod create** is 'created'. The initial status of the container created with **podman create** is 'created'.
# OPTIONS # OPTIONS
**--add-host**=[] **--add-host**=[]
@ -26,7 +26,7 @@ option can be set multiple times.
Attach to STDIN, STDOUT or STDERR. Attach to STDIN, STDOUT or STDERR.
In foreground mode (the default when **-d** In foreground mode (the default when **-d**
is not specified), **kpod run** can start the process in the container is not specified), **podman run** can start the process in the container
and attach the console to the process's standard input, output, and standard and attach the console to the process's standard input, output, and standard
error. It can even pretend to be a TTY (this is what most commandline error. It can even pretend to be a TTY (this is what most commandline
executables expect) and pass along signals. The **-a** option can be set for executables expect) and pass along signals. The **-a** option can be set for
@ -134,9 +134,9 @@ two memory nodes.
**-d**, **--detach**=*true*|*false* **-d**, **--detach**=*true*|*false*
Detached mode: run the container in the background and print the new container ID. The default is *false*. Detached mode: run the container in the background and print the new container ID. The default is *false*.
At any time you can run **kpod ps** in At any time you can run **podman ps** in
the other shell to view a list of the running containers. You can reattach to a the other shell to view a list of the running containers. You can reattach to a
detached container with **kpod attach**. If you choose to run a container in detached container with **podman attach**. If you choose to run a container in
the detached mode, then you cannot use the **-rm** option. the detached mode, then you cannot use the **-rm** option.
When attached in the tty mode, you can detach from the container (and leave it When attached in the tty mode, you can detach from the container (and leave it
@ -253,7 +253,7 @@ millions of trillions.
**--log-driver**="*json-file*|*syslog*|*journald*|*gelf*|*fluentd*|*awslogs*|*splunk*|*etwlogs*|*gcplogs*|*none*" **--log-driver**="*json-file*|*syslog*|*journald*|*gelf*|*fluentd*|*awslogs*|*splunk*|*etwlogs*|*gcplogs*|*none*"
Logging driver for the container. Default is defined by daemon `--log-driver` flag. Logging driver for the container. Default is defined by daemon `--log-driver` flag.
**Warning**: the `kpod logs` command works only for the `json-file` and **Warning**: the `podman logs` command works only for the `json-file` and
`journald` logging drivers. `journald` logging drivers.
**--log-opt**=[] **--log-opt**=[]
@ -305,7 +305,7 @@ unit, `b` is used. Set LIMIT to `-1` to enable unlimited swap.
UUID short identifier (“f78375b1c487”) UUID short identifier (“f78375b1c487”)
Name (“jonah”) Name (“jonah”)
kpod generates a UUID for each container, and if a name is not assigned podman generates a UUID for each container, and if a name is not assigned
to the container with **--name** then the daemon will also generate a random to the container with **--name** then the daemon will also generate a random
string name. The name is useful any place you need to identify a container. string name. The name is useful any place you need to identify a container.
This works for both background and foreground containers. This works for both background and foreground containers.
@ -315,7 +315,7 @@ This works for both background and foreground containers.
'bridge': create a network stack on the default bridge 'bridge': create a network stack on the default bridge
'none': no networking 'none': no networking
'container:<name|id>': reuse another container's network stack 'container:<name|id>': reuse another container's network stack
'host': use the kpod host network stack. Note: the host mode gives the container full access to local system services such as D-bus and is therefore considered insecure. 'host': use the podman host network stack. Note: the host mode gives the container full access to local system services such as D-bus and is therefore considered insecure.
'<network-name>|<network-id>': connect to a user-defined network '<network-name>|<network-id>': connect to a user-defined network
**--network-alias**=[] **--network-alias**=[]
@ -342,12 +342,12 @@ This works for both background and foreground containers.
**--privileged**=*true*|*false* **--privileged**=*true*|*false*
Give extended privileges to this container. The default is *false*. Give extended privileges to this container. The default is *false*.
By default, kpod containers are By default, podman containers are
“unprivileged” (=false) and cannot, for example, modify parts of the kernel. “unprivileged” (=false) and cannot, for example, modify parts of the kernel.
This is because by default a container is not allowed to access any devices. This is because by default a container is not allowed to access any devices.
A “privileged” container is given access to all devices. A “privileged” container is given access to all devices.
When the operator executes **kpod run --privileged**, kpod enables access When the operator executes **podman run --privileged**, podman enables access
to all devices on the host as well as set turn off most of the security messurs to all devices on the host as well as set turn off most of the security messurs
protecting the host from the container. protecting the host from the container.
@ -357,21 +357,21 @@ protecting the host from the container.
Format: `ip:hostPort:containerPort | ip::containerPort | hostPort:containerPort | containerPort` Format: `ip:hostPort:containerPort | ip::containerPort | hostPort:containerPort | containerPort`
Both hostPort and containerPort can be specified as a range of ports. Both hostPort and containerPort can be specified as a range of ports.
When specifying ranges for both, the number of container ports in the range must match the number of host ports in the range. When specifying ranges for both, the number of container ports in the range must match the number of host ports in the range.
(e.g., `kpod run -p 1234-1236:1222-1224 --name thisWorks -t busybox` (e.g., `podman run -p 1234-1236:1222-1224 --name thisWorks -t busybox`
but not `kpod run -p 1230-1236:1230-1240 --name RangeContainerPortsBiggerThanRangeHostPorts -t busybox`) but not `podman run -p 1230-1236:1230-1240 --name RangeContainerPortsBiggerThanRangeHostPorts -t busybox`)
With ip: `kpod run -p 127.0.0.1:$HOSTPORT:$CONTAINERPORT --name CONTAINER -t someimage` With ip: `podman run -p 127.0.0.1:$HOSTPORT:$CONTAINERPORT --name CONTAINER -t someimage`
Use `kpod port` to see the actual mapping: `kpod port CONTAINER $CONTAINERPORT` Use `podman port` to see the actual mapping: `podman port CONTAINER $CONTAINERPORT`
**-P**, **--publish-all**=*true*|*false* **-P**, **--publish-all**=*true*|*false*
Publish all exposed ports to random ports on the host interfaces. The default is *false*. Publish all exposed ports to random ports on the host interfaces. The default is *false*.
When set to true publish all exposed ports to the host interfaces. The When set to true publish all exposed ports to the host interfaces. The
default is false. If the operator uses -P (or -p) then kpod will make the default is false. If the operator uses -P (or -p) then podman will make the
exposed port accessible on the host and the ports will be available to any exposed port accessible on the host and the ports will be available to any
client that can reach the host. When using -P, kpod will bind any exposed client that can reach the host. When using -P, podman will bind any exposed
port to a random port on the host within an *ephemeral port range* defined by port to a random port on the host within an *ephemeral port range* defined by
`/proc/sys/net/ipv4/ip_local_port_range`. To find the mapping between the host `/proc/sys/net/ipv4/ip_local_port_range`. To find the mapping between the host
ports and the exposed ports, use `kpod port`. ports and the exposed ports, use `podman port`.
**--read-only**=*true*|*false* **--read-only**=*true*|*false*
Mount the container's root filesystem as read only. Mount the container's root filesystem as read only.
@ -419,7 +419,7 @@ incompatible with any restart policy other than `none`.
**--storage-opt**=[] **--storage-opt**=[]
Storage driver options per container Storage driver options per container
$ kpod create -it --storage-opt size=120G fedora /bin/bash $ podman create -it --storage-opt size=120G fedora /bin/bash
This (size) will allow to set the container rootfs size to 120G at creation time. This (size) will allow to set the container rootfs size to 120G at creation time.
This option is only available for the `devicemapper`, `btrfs`, `overlay2` and `zfs` graph drivers. This option is only available for the `devicemapper`, `btrfs`, `overlay2` and `zfs` graph drivers.
@ -446,7 +446,7 @@ incompatible with any restart policy other than `none`.
Mount a temporary filesystem (`tmpfs`) mount into a container, for example: Mount a temporary filesystem (`tmpfs`) mount into a container, for example:
$ kpod run -d --tmpfs /tmp:rw,size=787448k,mode=1777 my_image $ podman run -d --tmpfs /tmp:rw,size=787448k,mode=1777 my_image
This command mounts a `tmpfs` at `/tmp` within the container. The supported mount This command mounts a `tmpfs` at `/tmp` within the container. The supported mount
options are the same as the Linux default `mount` flags. If you do not specify options are the same as the Linux default `mount` flags. If you do not specify
@ -456,11 +456,11 @@ any options, the systems uses the following options:
**-t**, **--tty**=*true*|*false* **-t**, **--tty**=*true*|*false*
Allocate a pseudo-TTY. The default is *false*. Allocate a pseudo-TTY. The default is *false*.
When set to true kpod will allocate a pseudo-tty and attach to the standard When set to true podman will allocate a pseudo-tty and attach to the standard
input of the container. This can be used, for example, to run a throwaway input of the container. This can be used, for example, to run a throwaway
interactive shell. The default is false. interactive shell. The default is false.
Note: The **-t** option is incompatible with a redirection of the kpod client Note: The **-t** option is incompatible with a redirection of the podman client
standard input. standard input.
**--ulimit**=[] **--ulimit**=[]
@ -484,8 +484,8 @@ standard input.
Note: the host mode gives the container access to changing the host's hostname and is therefore considered insecure. Note: the host mode gives the container access to changing the host's hostname and is therefore considered insecure.
**-v**|**--volume**[=*[HOST-DIR:CONTAINER-DIR[:OPTIONS]]*] **-v**|**--volume**[=*[HOST-DIR:CONTAINER-DIR[:OPTIONS]]*]
Create a bind mount. If you specify, ` -v /HOST-DIR:/CONTAINER-DIR`, kpod Create a bind mount. If you specify, ` -v /HOST-DIR:/CONTAINER-DIR`, podman
bind mounts `/HOST-DIR` in the host to `/CONTAINER-DIR` in the kpod bind mounts `/HOST-DIR` in the host to `/CONTAINER-DIR` in the podman
container. The `OPTIONS` are a comma delimited list and can be: container. The `OPTIONS` are a comma delimited list and can be:
* [rw|ro] * [rw|ro]
@ -493,8 +493,8 @@ standard input.
* [`[r]shared`|`[r]slave`|`[r]private`] * [`[r]shared`|`[r]slave`|`[r]private`]
The `CONTAINER-DIR` must be an absolute path such as `/src/docs`. The `HOST-DIR` The `CONTAINER-DIR` must be an absolute path such as `/src/docs`. The `HOST-DIR`
must be an absolute path as well. kpod bind-mounts the `HOST-DIR` to the must be an absolute path as well. podman bind-mounts the `HOST-DIR` to the
path you specify. For example, if you supply the `/foo` value, kpod creates a bind-mount. path you specify. For example, if you supply the `/foo` value, podman creates a bind-mount.
You can specify multiple **-v** options to mount one or more mounts to a You can specify multiple **-v** options to mount one or more mounts to a
container. container.
@ -506,14 +506,14 @@ See examples.
Labeling systems like SELinux require that proper labels are placed on volume Labeling systems like SELinux require that proper labels are placed on volume
content mounted into a container. Without a label, the security system might content mounted into a container. Without a label, the security system might
prevent the processes running inside the container from using the content. By prevent the processes running inside the container from using the content. By
default, kpod does not change the labels set by the OS. default, podman does not change the labels set by the OS.
To change a label in the container context, you can add either of two suffixes To change a label in the container context, you can add either of two suffixes
`:z` or `:Z` to the volume mount. These suffixes tell kpod to relabel file `:z` or `:Z` to the volume mount. These suffixes tell podman to relabel file
objects on the shared volumes. The `z` option tells kpod that two containers objects on the shared volumes. The `z` option tells podman that two containers
share the volume content. As a result, kpod labels the content with a shared share the volume content. As a result, podman labels the content with a shared
content label. Shared volume labels allow all containers to read/write content. content label. Shared volume labels allow all containers to read/write content.
The `Z` option tells kpod to label the content with a private unshared label. The `Z` option tells podman to label the content with a private unshared label.
Only the current container can use a private volume. Only the current container can use a private volume.
By default bind mounted volumes are `private`. That means any mounts done By default bind mounted volumes are `private`. That means any mounts done
@ -563,4 +563,4 @@ can override the working directory by using the **-w** option.
August 2014, updated by Sven Dowideit <SvenDowideit@home.org.au> August 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
September 2014, updated by Sven Dowideit <SvenDowideit@home.org.au> September 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
November 2014, updated by Sven Dowideit <SvenDowideit@home.org.au> November 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
October 2017, converted from Docker documentation to kpod by Dan Walsh for kpod <dwalsh@redhat.com> October 2017, converted from Docker documentation to podman by Dan Walsh for podman <dwalsh@redhat.com>

View File

@ -1,12 +1,12 @@
% kpod(1) kpod-diff - Inspect changes on a container or image's filesystem % podman(1) podman-diff - Inspect changes on a container or image's filesystem
% Dan Walsh % Dan Walsh
# kpod-diff "1" "August 2017" "kpod" # podman-diff "1" "August 2017" "podman"
## NAME ## NAME
kpod diff - Inspect changes on a container or image's filesystem podman diff - Inspect changes on a container or image's filesystem
## SYNOPSIS ## SYNOPSIS
**kpod** **diff** [*options* [...]] NAME **podman** **diff** [*options* [...]] NAME
## DESCRIPTION ## DESCRIPTION
Displays changes on a container or image's filesystem. The container or image will be compared to its parent layer Displays changes on a container or image's filesystem. The container or image will be compared to its parent layer
@ -20,13 +20,13 @@ Alter the output into a different format. The only valid format for diff is `js
## EXAMPLE ## EXAMPLE
kpod diff redis:alpine podman diff redis:alpine
C /usr C /usr
C /usr/local C /usr/local
C /usr/local/bin C /usr/local/bin
A /usr/local/bin/docker-entrypoint.sh A /usr/local/bin/docker-entrypoint.sh
kpod diff --format json redis:alpine podman diff --format json redis:alpine
{ {
"changed": [ "changed": [
"/usr", "/usr",
@ -39,7 +39,7 @@ kpod diff --format json redis:alpine
} }
## SEE ALSO ## SEE ALSO
kpod(1) podman(1)
## HISTORY ## HISTORY
August 2017, Originally compiled by Ryan Cole <rycole@redhat.com> August 2017, Originally compiled by Ryan Cole <rycole@redhat.com>

View File

@ -1,18 +1,18 @@
% kpod(1) kpod-exec - Execute a command in a running container % podman(1) podman-exec - Execute a command in a running container
% Brent Baude % Brent Baude
# kpod-exec "1" "December 2017" "kpod" # podman-exec "1" "December 2017" "podman"
## NAME ## NAME
kpod-exec - Execute a command in a running container podman-exec - Execute a command in a running container
## SYNOPSIS ## SYNOPSIS
**kpod exec** **podman exec**
**CONTAINER** **CONTAINER**
[COMMAND] [ARG...] [COMMAND] [ARG...]
[**--help**|**-h**] [**--help**|**-h**]
## DESCRIPTION ## DESCRIPTION
**kpod exec** executes a command in a running container. **podman exec** executes a command in a running container.
## OPTIONS ## OPTIONS
**--env, e** **--env, e**
@ -37,7 +37,7 @@ The following examples are all valid:
## SEE ALSO ## SEE ALSO
kpod(1), kpod-run(1) podman(1), podman-run(1)
## HISTORY ## HISTORY
December 2017, Originally compiled by Brent Baude<bbaude@redhat.com> December 2017, Originally compiled by Brent Baude<bbaude@redhat.com>

44
docs/podman-export.1.md Normal file
View File

@ -0,0 +1,44 @@
% podman(1) podman-export - Simple tool to export a container's filesystem as a tarball
% Urvashi Mohnani
# podman-export "1" "July 2017" "podman"
## NAME
podman-export - Export container's filesystem contents as a tar archive
## SYNOPSIS
**podman export**
**CONTAINER**
[**--output**|**-o**]
[**--help**|**-h**]
## DESCRIPTION
**podman export** exports the filesystem of a container and saves it as a tarball
on the local machine. **podman export** writes to STDOUT by default and can be
redirected to a file using the **output flag**.
**podman [GLOBAL OPTIONS]**
**podman export [GLOBAL OPTIONS]**
**podman export [OPTIONS] CONTAINER**
## OPTIONS
**--output, -o**
Write to a file, default is STDOUT
## EXAMPLES
```
# podman export -o redis-container.tar 883504668ec465463bc0fe7e63d53154ac3b696ea8d7b233748918664ea90e57
```
```
# podman export > redis-container.tar 883504668ec465463bc0fe7e63d53154ac3b696ea8d7b233748918664ea90e57
```
## SEE ALSO
podman(1), podman-import(1), crio(8), crio.conf(5)
## HISTORY
August 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com>

View File

@ -1,12 +1,12 @@
% kpod(1) kpod-history - Simple tool to view the history of an image % podman(1) podman-history - Simple tool to view the history of an image
% Urvashi Mohnani % Urvashi Mohnani
% kpod-history "1" "JULY 2017" "kpod" % podman-history "1" "JULY 2017" "podman"
## NAME ## NAME
kpod-history - Shows the history of an image podman-history - Shows the history of an image
## SYNOPSIS ## SYNOPSIS
**kpod history** **podman history**
**IMAGE[:TAG|DIGEST]** **IMAGE[:TAG|DIGEST]**
[**--human**|**-H**] [**--human**|**-H**]
[**--no-trunc**] [**--no-trunc**]
@ -15,7 +15,7 @@ kpod-history - Shows the history of an image
[**--help**|**-h**] [**--help**|**-h**]
## DESCRIPTION ## DESCRIPTION
**kpod history** displays the history of an image by printing out information **podman history** displays the history of an image by printing out information
about each layer used in the image. The information printed out for each layer about each layer used in the image. The information printed out for each layer
include Created (time and date), Created By, Size, and Comment. The output can include Created (time and date), Created By, Size, and Comment. The output can
be truncated or not using the **--no-trunc** flag. If the **--human** flag is be truncated or not using the **--no-trunc** flag. If the **--human** flag is
@ -33,11 +33,11 @@ Valid placeholders for the Go template are listed below:
| .Size | Size of layer on disk | | .Size | Size of layer on disk |
| .Comment | Comment for the layer | | .Comment | Comment for the layer |
**kpod [GLOBAL OPTIONS]** **podman [GLOBAL OPTIONS]**
**kpod history [GLOBAL OPTIONS]** **podman history [GLOBAL OPTIONS]**
**kpod history [OPTIONS] IMAGE[:TAG|DIGEST]** **podman history [OPTIONS] IMAGE[:TAG|DIGEST]**
## OPTIONS ## OPTIONS
@ -57,27 +57,27 @@ Valid placeholders for the Go template are listed below:
## EXAMPLES ## EXAMPLES
``` ```
# kpod history debian # podman history debian
ID CREATED CREATED BY SIZE COMMENT ID CREATED CREATED BY SIZE COMMENT
b676ca55e4f2c 9 weeks ago /bin/sh -c #(nop) CMD ["bash"] 0 B b676ca55e4f2c 9 weeks ago /bin/sh -c #(nop) CMD ["bash"] 0 B
<missing> 9 weeks ago /bin/sh -c #(nop) ADD file:ebba725fb97cea4... 45.14 MB <missing> 9 weeks ago /bin/sh -c #(nop) ADD file:ebba725fb97cea4... 45.14 MB
``` ```
``` ```
# kpod history --no-trunc=true --human=false debian # podman history --no-trunc=true --human=false debian
ID CREATED CREATED BY SIZE COMMENT ID CREATED CREATED BY SIZE COMMENT
b676ca55e4f2c 2017-07-24T16:52:55Z /bin/sh -c #(nop) CMD ["bash"] 0 b676ca55e4f2c 2017-07-24T16:52:55Z /bin/sh -c #(nop) CMD ["bash"] 0
<missing> 2017-07-24T16:52:54Z /bin/sh -c #(nop) ADD file:ebba725fb97cea4... 45142935 <missing> 2017-07-24T16:52:54Z /bin/sh -c #(nop) ADD file:ebba725fb97cea4... 45142935
``` ```
``` ```
# kpod history --format "{{.ID}} {{.Created}}" debian # podman history --format "{{.ID}} {{.Created}}" debian
b676ca55e4f2c 9 weeks ago b676ca55e4f2c 9 weeks ago
<missing> 9 weeks ago <missing> 9 weeks ago
``` ```
``` ```
# kpod history --format json debian # podman history --format json debian
[ [
{ {
"id": "b676ca55e4f2c0ce53d0636438c5372d3efeb5ae99b676fa5a5d1581bad46060", "id": "b676ca55e4f2c0ce53d0636438c5372d3efeb5ae99b676fa5a5d1581bad46060",
@ -100,7 +100,7 @@ b676ca55e4f2c 9 weeks ago
Show the history of an image Show the history of an image
## SEE ALSO ## SEE ALSO
kpod(1), crio(8), crio.conf(5) podman(1), crio(8), crio.conf(5)
## HISTORY ## HISTORY
July 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com> July 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com>

View File

@ -1,12 +1,12 @@
% kpod(1) kpod-images - List images in local storage % podman(1) podman-images - List images in local storage
% Dan Walsh % Dan Walsh
# kpod-images "1" "March 2017" "kpod" # podman-images "1" "March 2017" "podman"
## NAME ## NAME
kpod images - List images in local storage podman images - List images in local storage
## SYNOPSIS ## SYNOPSIS
**kpod** **images** [*options* [...]] **podman** **images** [*options* [...]]
## DESCRIPTION ## DESCRIPTION
Displays locally stored images, their names, and their IDs. Displays locally stored images, their names, and their IDs.
@ -42,7 +42,7 @@ Lists only the image IDs.
## EXAMPLE ## EXAMPLE
``` ```
# kpod images # podman images
REPOSITORY TAG IMAGE ID CREATED SIZE REPOSITORY TAG IMAGE ID CREATED SIZE
docker.io/kubernetes/pause latest e3d42bcaf643 3 years ago 251kB docker.io/kubernetes/pause latest e3d42bcaf643 3 years ago 251kB
<none> <none> ebb91b73692b 4 weeks ago 27.2MB <none> <none> ebb91b73692b 4 weeks ago 27.2MB
@ -50,21 +50,21 @@ docker.io/library/ubuntu latest 4526339ae51c 6 weeks ago
``` ```
``` ```
# kpod images --quiet # podman images --quiet
e3d42bcaf643 e3d42bcaf643
ebb91b73692b ebb91b73692b
4526339ae51c 4526339ae51c
``` ```
``` ```
# kpod images --noheading # podman images --noheading
docker.io/kubernetes/pause latest e3d42bcaf643 3 years ago 251kB docker.io/kubernetes/pause latest e3d42bcaf643 3 years ago 251kB
<none> <none> ebb91b73692b 4 weeks ago 27.2MB <none> <none> ebb91b73692b 4 weeks ago 27.2MB
docker.io/library/ubuntu latest 4526339ae51c 6 weeks ago 126MB docker.io/library/ubuntu latest 4526339ae51c 6 weeks ago 126MB
``` ```
``` ```
# kpod images --no-trunc # podman images --no-trunc
REPOSITORY TAG IMAGE ID CREATED SIZE REPOSITORY TAG IMAGE ID CREATED SIZE
docker.io/kubernetes/pause latest sha256:e3d42bcaf643097dd1bb0385658ae8cbe100a80f773555c44690d22c25d16b27 3 years ago 251kB docker.io/kubernetes/pause latest sha256:e3d42bcaf643097dd1bb0385658ae8cbe100a80f773555c44690d22c25d16b27 3 years ago 251kB
<none> <none> sha256:ebb91b73692bd27890685846412ae338d13552165eacf7fcd5f139bfa9c2d6d9 4 weeks ago 27.2MB <none> <none> sha256:ebb91b73692bd27890685846412ae338d13552165eacf7fcd5f139bfa9c2d6d9 4 weeks ago 27.2MB
@ -72,7 +72,7 @@ docker.io/library/ubuntu latest sha256:4526339ae51c3cdc979
``` ```
``` ```
# kpod images --format "table {{.ID}} {{.Repository}} {{.Tag}}" # podman images --format "table {{.ID}} {{.Repository}} {{.Tag}}"
IMAGE ID REPOSITORY TAG IMAGE ID REPOSITORY TAG
e3d42bcaf643 docker.io/kubernetes/pause latest e3d42bcaf643 docker.io/kubernetes/pause latest
ebb91b73692b <none> <none> ebb91b73692b <none> <none>
@ -80,13 +80,13 @@ ebb91b73692b <none> <none>
``` ```
``` ```
# kpod images --filter dangling=true # podman images --filter dangling=true
REPOSITORY TAG IMAGE ID CREATED SIZE REPOSITORY TAG IMAGE ID CREATED SIZE
<none> <none> ebb91b73692b 4 weeks ago 27.2MB <none> <none> ebb91b73692b 4 weeks ago 27.2MB
``` ```
``` ```
# kpod images --format json # podman images --format json
[ [
{ {
"id": "e3d42bcaf643097dd1bb0385658ae8cbe100a80f773555c44690d22c25d16b27", "id": "e3d42bcaf643097dd1bb0385658ae8cbe100a80f773555c44690d22c25d16b27",
@ -119,7 +119,7 @@ REPOSITORY TAG IMAGE ID CREATED SIZE
``` ```
## SEE ALSO ## SEE ALSO
kpod(1) podman(1)
## HISTORY ## HISTORY
March 2017, Originally compiled by Dan Walsh <dwalsh@redhat.com> March 2017, Originally compiled by Dan Walsh <dwalsh@redhat.com>

View File

@ -1,28 +1,28 @@
% kpod(1) kpod-import - Simple tool to import a tarball as an image % podman(1) podman-import - Simple tool to import a tarball as an image
% Urvashi Mohnani % Urvashi Mohnani
# kpod-import "1" "November 2017" "kpod" # podman-import "1" "November 2017" "podman"
## NAME ## NAME
kpod-import - import a tarball and save it as a filesystem image podman-import - import a tarball and save it as a filesystem image
## SYNOPSIS ## SYNOPSIS
**kpod import** **podman import**
**TARBALL** **TARBALL**
[**--change**|**-c**] [**--change**|**-c**]
[**--message**|**-m**] [**--message**|**-m**]
[**--help**|**-h**] [**--help**|**-h**]
## DESCRIPTION ## DESCRIPTION
**kpod import** imports a tarball (.tar, .tar.gz, .tgz, .bzip, .tar.xz, .txz) **podman import** imports a tarball (.tar, .tar.gz, .tgz, .bzip, .tar.xz, .txz)
and saves it as a filesystem image. Remote tarballs can be specified using a URL. and saves it as a filesystem image. Remote tarballs can be specified using a URL.
Various image instructions can be configured with the **--change** flag and Various image instructions can be configured with the **--change** flag and
a commit message can be set using the **--message** flag. a commit message can be set using the **--message** flag.
**kpod [GLOBAL OPTIONS]** **podman [GLOBAL OPTIONS]**
**kpod import [GLOBAL OPTIONS]** **podman import [GLOBAL OPTIONS]**
**kpod import [OPTIONS] CONTAINER** **podman import [OPTIONS] CONTAINER**
## OPTIONS ## OPTIONS
@ -37,7 +37,7 @@ Set commit message for imported image
## EXAMPLES ## EXAMPLES
``` ```
# kpod import --change CMD=/bin/bash --change ENTRYPOINT=/bin/sh --change LABEL=blue=image ctr.tar image-imported # podman import --change CMD=/bin/bash --change ENTRYPOINT=/bin/sh --change LABEL=blue=image ctr.tar image-imported
Getting image source signatures Getting image source signatures
Copying blob sha256:b41deda5a2feb1f03a5c1bb38c598cbc12c9ccd675f438edc6acd815f7585b86 Copying blob sha256:b41deda5a2feb1f03a5c1bb38c598cbc12c9ccd675f438edc6acd815f7585b86
25.80 MB / 25.80 MB [======================================================] 0s 25.80 MB / 25.80 MB [======================================================] 0s
@ -48,7 +48,7 @@ Storing signatures
``` ```
``` ```
# cat ctr.tar | kpod import --message "importing the ctr.tar tarball" - image-imported # cat ctr.tar | podman import --message "importing the ctr.tar tarball" - image-imported
Getting image source signatures Getting image source signatures
Copying blob sha256:b41deda5a2feb1f03a5c1bb38c598cbc12c9ccd675f438edc6acd815f7585b86 Copying blob sha256:b41deda5a2feb1f03a5c1bb38c598cbc12c9ccd675f438edc6acd815f7585b86
25.80 MB / 25.80 MB [======================================================] 0s 25.80 MB / 25.80 MB [======================================================] 0s
@ -59,7 +59,7 @@ Storing signatures
``` ```
``` ```
# cat ctr.tar | kpod import - # cat ctr.tar | podman import -
Getting image source signatures Getting image source signatures
Copying blob sha256:b41deda5a2feb1f03a5c1bb38c598cbc12c9ccd675f438edc6acd815f7585b86 Copying blob sha256:b41deda5a2feb1f03a5c1bb38c598cbc12c9ccd675f438edc6acd815f7585b86
25.80 MB / 25.80 MB [======================================================] 0s 25.80 MB / 25.80 MB [======================================================] 0s
@ -70,7 +70,7 @@ Storing signatures
``` ```
``` ```
kpod import http://example.com/ctr.tar url-image podman import http://example.com/ctr.tar url-image
Downloading from "http://example.com/ctr.tar" Downloading from "http://example.com/ctr.tar"
Getting image source signatures Getting image source signatures
Copying blob sha256:b41deda5a2feb1f03a5c1bb38c598cbc12c9ccd675f438edc6acd815f7585b86 Copying blob sha256:b41deda5a2feb1f03a5c1bb38c598cbc12c9ccd675f438edc6acd815f7585b86
@ -82,7 +82,7 @@ Storing signatures
``` ```
## SEE ALSO ## SEE ALSO
kpod(1), kpod-export(1), crio(8), crio.conf(5) podman(1), podman-export(1), crio(8), crio.conf(5)
## HISTORY ## HISTORY
November 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com> November 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com>

36
docs/podman-info.1.md Normal file
View File

@ -0,0 +1,36 @@
% podman(1) podman-version - Simple tool to view version information
% Vincent Batts
% podman-version "1" "JULY 2017" "podman"
## NAME
podman-info - Display system information
## SYNOPSIS
**podman** **info** [*options* [...]]
## DESCRIPTION
Information display here pertain to the host, current storage stats, and build of podman. Useful for the user and when reporting issues.
## OPTIONS
**--debug, -D**
Show additional information
**--format**
Change output format to "json" or a Go template.
## EXAMPLE
`podman info`
`podman info --debug --format json| jq .host.kernel`
## SEE ALSO
crio(8), crio.conf(5)

View File

@ -1,12 +1,12 @@
% kpod(1) kpod-inspect - Display a container or image's configuration % podman(1) podman-inspect - Display a container or image's configuration
% Dan Walsh % Dan Walsh
# kpod-inspect "1" "July 2017" "kpod" # podman-inspect "1" "July 2017" "podman"
## NAME ## NAME
kpod inspect - Display a container or image's configuration podman inspect - Display a container or image's configuration
## SYNOPSIS ## SYNOPSIS
**kpod** **inspect** [*options* [...]] name **podman** **inspect** [*options* [...]] name
## DESCRIPTION ## DESCRIPTION
This displays the low-level information on containers and images identified by name or ID. By default, this will render all results in a JSON array. If the container and image have the same name, this will return container JSON for unspecified type. If a format is specified, the given template will be executed for each result. This displays the low-level information on containers and images identified by name or ID. By default, this will render all results in a JSON array. If the container and image have the same name, this will return container JSON for unspecified type. If a format is specified, the given template will be executed for each result.
@ -29,7 +29,7 @@ Display the total file size if the type is a container
## EXAMPLE ## EXAMPLE
``` ```
# kpod inspect fedora # podman inspect fedora
{ {
"Id": "422dc563ca3260ad9ef5c47a1c246f5065d7f177ce51f4dd208efd82967ff182", "Id": "422dc563ca3260ad9ef5c47a1c246f5065d7f177ce51f4dd208efd82967ff182",
"Digest": "sha256:1b9bfb4e634dc1e5c19d0fa1eb2e5a28a5c2b498e3d3e4ac742bd7f5dae08611", "Digest": "sha256:1b9bfb4e634dc1e5c19d0fa1eb2e5a28a5c2b498e3d3e4ac742bd7f5dae08611",
@ -76,7 +76,7 @@ Display the total file size if the type is a container
``` ```
## SEE ALSO ## SEE ALSO
kpod(1) podman(1)
## HISTORY ## HISTORY
July 2017, Originally compiled by Dan Walsh <dwalsh@redhat.com> July 2017, Originally compiled by Dan Walsh <dwalsh@redhat.com>

View File

@ -1,12 +1,12 @@
% kpod(1) kpod-kill- Kill one or more containers with a signal % podman(1) podman-kill- Kill one or more containers with a signal
% Brent Baude % Brent Baude
# kpod-kill"1" "September 2017" "kpod" # podman-kill"1" "September 2017" "podman"
## NAME ## NAME
kpod kill - Kills one or more containers with a signal podman kill - Kills one or more containers with a signal
## SYNOPSIS ## SYNOPSIS
**kpod kill [OPTIONS] CONTAINER [...]** **podman kill [OPTIONS] CONTAINER [...]**
## DESCRIPTION ## DESCRIPTION
The main process inside each container specified will be sent SIGKILL, or any signal specified with option --signal. The main process inside each container specified will be sent SIGKILL, or any signal specified with option --signal.
@ -20,14 +20,14 @@ Signal to send to the container. For more information on Linux signals, refer to
## EXAMPLE ## EXAMPLE
kpod kill mywebserver podman kill mywebserver
kpod kill 860a4b23 podman kill 860a4b23
kpod kill --signal TERM 860a4b23 podman kill --signal TERM 860a4b23
## SEE ALSO ## SEE ALSO
kpod(1), kpod-stop(1) podman(1), podman-stop(1)
## HISTORY ## HISTORY
September 2017, Originally compiled by Brent Baude <bbaude@redhat.com> September 2017, Originally compiled by Brent Baude <bbaude@redhat.com>

View File

@ -1,27 +1,27 @@
% kpod(1) kpod-load - Simple tool to load an image from an archive to containers-storage % podman(1) podman-load - Simple tool to load an image from an archive to containers-storage
% Urvashi Mohnani % Urvashi Mohnani
# kpod-load "1" "July 2017" "kpod" # podman-load "1" "July 2017" "podman"
## NAME ## NAME
kpod-load - Load an image from docker archive podman-load - Load an image from docker archive
## SYNOPSIS ## SYNOPSIS
**kpod load** **podman load**
**NAME[:TAG|@DIGEST]** **NAME[:TAG|@DIGEST]**
[**--input**|**-i**] [**--input**|**-i**]
[**--quiet**|**-q**] [**--quiet**|**-q**]
[**--help**|**-h**] [**--help**|**-h**]
## DESCRIPTION ## DESCRIPTION
**kpod load** copies an image from either **docker-archive** or **oci-archive** stored **podman load** copies an image from either **docker-archive** or **oci-archive** stored
on the local machine. **kpod load** reads from stdin by default or a file if the **input** flag is set. on the local machine. **podman load** reads from stdin by default or a file if the **input** flag is set.
The **quiet** flag suppresses the output when set. The **quiet** flag suppresses the output when set.
**kpod [GLOBAL OPTIONS]** **podman [GLOBAL OPTIONS]**
**kpod load [GLOBAL OPTIONS]** **podman load [GLOBAL OPTIONS]**
**kpod load [OPTIONS] NAME[:TAG|@DIGEST]** **podman load [OPTIONS] NAME[:TAG|@DIGEST]**
## OPTIONS ## OPTIONS
@ -40,15 +40,15 @@ option be used, as the default behavior of using the system-wide default policy
## EXAMPLES ## EXAMPLES
``` ```
# kpod load --quiet -i fedora.tar # podman load --quiet -i fedora.tar
``` ```
``` ```
# kpod load -q --signature-policy /etc/containers/policy.json -i fedora.tar # podman load -q --signature-policy /etc/containers/policy.json -i fedora.tar
``` ```
``` ```
# kpod load < fedora.tar # podman load < fedora.tar
Getting image source signatures Getting image source signatures
Copying blob sha256:5bef08742407efd622d243692b79ba0055383bbce12900324f75e56f589aedb0 Copying blob sha256:5bef08742407efd622d243692b79ba0055383bbce12900324f75e56f589aedb0
0 B / 4.03 MB [---------------------------------------------------------------] 0 B / 4.03 MB [---------------------------------------------------------------]
@ -60,7 +60,7 @@ Loaded image: registry.fedoraproject.org/fedora:latest
``` ```
``` ```
# cat fedora.tar | kpod load # cat fedora.tar | podman load
Getting image source signatures Getting image source signatures
Copying blob sha256:5bef08742407efd622d243692b79ba0055383bbce12900324f75e56f589aedb0 Copying blob sha256:5bef08742407efd622d243692b79ba0055383bbce12900324f75e56f589aedb0
0 B / 4.03 MB [---------------------------------------------------------------] 0 B / 4.03 MB [---------------------------------------------------------------]
@ -72,7 +72,7 @@ Loaded image: registry.fedoraproject.org/fedora:latest
``` ```
## SEE ALSO ## SEE ALSO
kpod(1), kpod-save(1), crio(8), crio.conf(5) podman(1), podman-save(1), crio(8), crio.conf(5)
## HISTORY ## HISTORY
July 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com> July 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com>

View File

@ -1,12 +1,12 @@
% kpod(1) kpod-login - Simple tool to login to a registry server % podman(1) podman-login - Simple tool to login to a registry server
% Urvashi Mohnani % Urvashi Mohnani
# kpod-login "1" "August 2017" "kpod" # podman-login "1" "August 2017" "podman"
## NAME ## NAME
kpod-login - Login to a container registry podman-login - Login to a container registry
## SYNOPSIS ## SYNOPSIS
**kpod login** **podman login**
[**--help**|**-h**] [**--help**|**-h**]
[**--authfile**] [**--authfile**]
[**--user**|**-u**] [**--user**|**-u**]
@ -14,17 +14,17 @@ kpod-login - Login to a container registry
**REGISTRY** **REGISTRY**
## DESCRIPTION ## DESCRIPTION
**kpod login** logs into a specified registry server with the correct username **podman login** logs into a specified registry server with the correct username
and password. **kpod login** reads in the username and password from STDIN. and password. **podman login** reads in the username and password from STDIN.
The username and password can also be set using the **username** and **password** flags. The username and password can also be set using the **username** and **password** flags.
The path of the authentication file can be specified by the user by setting the **authfile** The path of the authentication file can be specified by the user by setting the **authfile**
flag. The default path used is **${XDG\_RUNTIME_DIR}/containers/auth.json**. flag. The default path used is **${XDG\_RUNTIME_DIR}/containers/auth.json**.
**kpod [GLOBAL OPTIONS]** **podman [GLOBAL OPTIONS]**
**kpod login [GLOBAL OPTIONS]** **podman login [GLOBAL OPTIONS]**
**kpod login [OPTIONS] REGISTRY [GLOBAL OPTIONS]** **podman login [OPTIONS] REGISTRY [GLOBAL OPTIONS]**
## OPTIONS ## OPTIONS
@ -40,26 +40,26 @@ Path of the authentication file. Default is ${XDG_\RUNTIME\_DIR}/containers/auth
## EXAMPLES ## EXAMPLES
``` ```
# kpod login docker.io # podman login docker.io
Username: umohnani Username: umohnani
Password: Password:
Login Succeeded! Login Succeeded!
``` ```
``` ```
# kpod login -u testuser -p testpassword localhost:5000 # podman login -u testuser -p testpassword localhost:5000
Login Succeeded! Login Succeeded!
``` ```
``` ```
# kpod login --authfile authdir/myauths.json docker.io # podman login --authfile authdir/myauths.json docker.io
Username: umohnani Username: umohnani
Password: Password:
Login Succeeded! Login Succeeded!
``` ```
## SEE ALSO ## SEE ALSO
kpod(1), kpod-logout(1), crio(8), crio.conf(5) podman(1), podman-logout(1), crio(8), crio.conf(5)
## HISTORY ## HISTORY
August 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com> August 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com>

View File

@ -1,28 +1,28 @@
% kpod(1) kpod-logout - Simple tool to logout of a registry server % podman(1) podman-logout - Simple tool to logout of a registry server
% Urvashi Mohnani % Urvashi Mohnani
# kpod-logout "1" "August 2017" "kpod" # podman-logout "1" "August 2017" "podman"
## NAME ## NAME
kpod-logout - Logout of a container registry podman-logout - Logout of a container registry
## SYNOPSIS ## SYNOPSIS
**kpod logout** **podman logout**
[**--help**|**-h**] [**--help**|**-h**]
[**--authfile**] [**--authfile**]
[**--all**|**-a**] [**--all**|**-a**]
**REGISTRY** **REGISTRY**
## DESCRIPTION ## DESCRIPTION
**kpod logout** logs out of a specified registry server by deleting the cached credentials **podman logout** logs out of a specified registry server by deleting the cached credentials
stored in the **auth.json** file. The path of the authentication file can be overrriden by the user by setting the **authfile** flag. stored in the **auth.json** file. The path of the authentication file can be overrriden by the user by setting the **authfile** flag.
The default path used is **${XDG\_RUNTIME_DIR}/containers/auth.json**. The default path used is **${XDG\_RUNTIME_DIR}/containers/auth.json**.
All the cached credentials can be removed by setting the **all** flag. All the cached credentials can be removed by setting the **all** flag.
**kpod [GLOBAL OPTIONS]** **podman [GLOBAL OPTIONS]**
**kpod logout [GLOBAL OPTIONS]** **podman logout [GLOBAL OPTIONS]**
**kpod logout [OPTIONS] REGISTRY [GLOBAL OPTIONS]** **podman logout [OPTIONS] REGISTRY [GLOBAL OPTIONS]**
## OPTIONS ## OPTIONS
@ -35,22 +35,22 @@ Remove the cached credentials for all registries in the auth file
## EXAMPLES ## EXAMPLES
``` ```
# kpod logout docker.io # podman logout docker.io
Remove login credentials for https://registry-1.docker.io/v2/ Remove login credentials for https://registry-1.docker.io/v2/
``` ```
``` ```
# kpod logout --authfile authdir/myauths.json docker.io # podman logout --authfile authdir/myauths.json docker.io
Remove login credentials for https://registry-1.docker.io/v2/ Remove login credentials for https://registry-1.docker.io/v2/
``` ```
``` ```
# kpod logout --all # podman logout --all
Remove login credentials for all registries Remove login credentials for all registries
``` ```
## SEE ALSO ## SEE ALSO
kpod(1), kpod-login(1), crio(8), crio.conf(5) podman(1), podman-login(1), crio(8), crio.conf(5)
## HISTORY ## HISTORY
August 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com> August 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com>

View File

@ -1,15 +1,15 @@
% kpod(1) kpod-logs - Fetch the logs of a container % podman(1) podman-logs - Fetch the logs of a container
% Ryan Cole % Ryan Cole
# kpod-logs "1" "March 2017" "kpod" # podman-logs "1" "March 2017" "podman"
## NAME ## NAME
kpod logs - Fetch the logs of a container podman logs - Fetch the logs of a container
## SYNOPSIS ## SYNOPSIS
**kpod** **logs** [*options* [...]] container **podman** **logs** [*options* [...]] container
## DESCRIPTION ## DESCRIPTION
The kpod logs command batch-retrieves whatever logs are present for a container at the time of execution. This does not guarantee execution order when combined with kpod run (i.e. your run may not have generated any logs at the time you execute kpod logs The podman logs command batch-retrieves whatever logs are present for a container at the time of execution. This does not guarantee execution order when combined with podman run (i.e. your run may not have generated any logs at the time you execute podman logs
## OPTIONS ## OPTIONS
@ -27,7 +27,7 @@ Ouput the specified number of LINES at the end of the logs. LINES must be a pos
## EXAMPLE ## EXAMPLE
kpod logs b3f2436bdb978c1d33b1387afb5d7ba7e3243ed2ce908db431ac0069da86cb45 podman logs b3f2436bdb978c1d33b1387afb5d7ba7e3243ed2ce908db431ac0069da86cb45
2017/08/07 10:16:21 Seeked /var/log/crio/pods/eb296bd56fab164d4d3cc46e5776b54414af3bf543d138746b25832c816b933b/c49f49788da14f776b7aa93fb97a2a71f9912f4e5a3e30397fca7dfe0ee0367b.log - &{Offset:0 Whence:0} 2017/08/07 10:16:21 Seeked /var/log/crio/pods/eb296bd56fab164d4d3cc46e5776b54414af3bf543d138746b25832c816b933b/c49f49788da14f776b7aa93fb97a2a71f9912f4e5a3e30397fca7dfe0ee0367b.log - &{Offset:0 Whence:0}
1:C 07 Aug 14:10:09.055 # oO0OoO0OoO0Oo Redis is starting oO0OoO0OoO0Oo 1:C 07 Aug 14:10:09.055 # oO0OoO0OoO0Oo Redis is starting oO0OoO0OoO0Oo
@ -41,12 +41,12 @@ kpod logs b3f2436bdb978c1d33b1387afb5d7ba7e3243ed2ce908db431ac0069da86cb45
1:M 07 Aug 14:10:09.056 # Server initialized 1:M 07 Aug 14:10:09.056 # Server initialized
kpod logs --tail 2 b3f2436bdb97 podman logs --tail 2 b3f2436bdb97
1:M 07 Aug 14:10:09.056 # WARNING: The TCP backlog setting of 511 cannot be enforced because /proc/sys/net/core/somaxconn is set to the lower value of 128. 1:M 07 Aug 14:10:09.056 # WARNING: The TCP backlog setting of 511 cannot be enforced because /proc/sys/net/core/somaxconn is set to the lower value of 128.
1:M 07 Aug 14:10:09.056 # Server initialized 1:M 07 Aug 14:10:09.056 # Server initialized
kpod logs 224c375f27cd --since 2017-08-07T10:10:09.055837383-04:00 myserver podman logs 224c375f27cd --since 2017-08-07T10:10:09.055837383-04:00 myserver
1:M 07 Aug 14:10:09.055 # Server can't set maximum open files to 10032 because of OS error: Operation not permitted. 1:M 07 Aug 14:10:09.055 # Server can't set maximum open files to 10032 because of OS error: Operation not permitted.
1:M 07 Aug 14:10:09.055 # Current maximum open files is 4096. maxclients has been reduced to 4064 to compensate for low ulimit. If you need higher maxclients increase 'ulimit -n'. 1:M 07 Aug 14:10:09.055 # Current maximum open files is 4096. maxclients has been reduced to 4064 to compensate for low ulimit. If you need higher maxclients increase 'ulimit -n'.
@ -55,7 +55,7 @@ kpod logs 224c375f27cd --since 2017-08-07T10:10:09.055837383-04:00 myserver
1:M 07 Aug 14:10:09.056 # Server initialized 1:M 07 Aug 14:10:09.056 # Server initialized
## SEE ALSO ## SEE ALSO
kpod(1) podman(1)
## HISTORY ## HISTORY
August 2017, Originally compiled by Ryan Cole <rycole@redhat.com> August 2017, Originally compiled by Ryan Cole <rycole@redhat.com>

View File

@ -1,14 +1,14 @@
% kpod(1) kpod-mount - Mount a working container's root filesystem. % podman(1) podman-mount - Mount a working container's root filesystem.
% Dan Walsh % Dan Walsh
# kpod-mount "1" "July 2017" "kpod" # podman-mount "1" "July 2017" "podman"
## NAME ## NAME
kpod mount - Mount a working container's root filesystem podman mount - Mount a working container's root filesystem
## SYNOPSIS ## SYNOPSIS
**kpod** **mount** **podman** **mount**
**kpod** **mount** **containerID** **podman** **mount** **containerID**
## DESCRIPTION ## DESCRIPTION
Mounts the specified container's root file system in a location which can be Mounts the specified container's root file system in a location which can be
@ -36,15 +36,15 @@ SELinux label for the mount point
## EXAMPLE ## EXAMPLE
kpod mount c831414b10a3 podman mount c831414b10a3
/var/lib/containers/storage/overlay/f3ac502d97b5681989dff84dfedc8354239bcecbdc2692f9a639f4e080a02364/merged /var/lib/containers/storage/overlay/f3ac502d97b5681989dff84dfedc8354239bcecbdc2692f9a639f4e080a02364/merged
kpod mount podman mount
c831414b10a3 /var/lib/containers/storage/overlay/f3ac502d97b5681989dff84dfedc8354239bcecbdc2692f9a639f4e080a02364/merged c831414b10a3 /var/lib/containers/storage/overlay/f3ac502d97b5681989dff84dfedc8354239bcecbdc2692f9a639f4e080a02364/merged
a7060253093b /var/lib/containers/storage/overlay/0ff7d7ca68bed1ace424f9df154d2dd7b5a125c19d887f17653cbcd5b6e30ba1/merged a7060253093b /var/lib/containers/storage/overlay/0ff7d7ca68bed1ace424f9df154d2dd7b5a125c19d887f17653cbcd5b6e30ba1/merged
## SEE ALSO ## SEE ALSO
kpod(1), kpod-umount(1), mount(8) podman(1), podman-umount(1), mount(8)

24
docs/podman-pause.1.md Normal file
View File

@ -0,0 +1,24 @@
% podman(1) podman-pause - Pause one or more containers
% Dan Walsh
# podman-pause "1" "September 2017" "podman"
## NAME
podman pause - Pause one or more containers
## SYNOPSIS
**podman pause [OPTIONS] CONTAINER [...]**
## DESCRIPTION
Pauses all the processes in one or more containers. You may use container IDs or names as input.
## EXAMPLE
podman pause mywebserver
podman pause 860a4b23
## SEE ALSO
podman(1), podman-unpause(1)
## HISTORY
September 2017, Originally compiled by Dan Walsh <dwalsh@redhat.com>

View File

@ -1,12 +1,12 @@
% kpod(1) kpod-ps - Simple tool to list containers % podman(1) podman-ps - Simple tool to list containers
% Urvashi Mohnani % Urvashi Mohnani
% kpod-ps "1" "AUGUST 2017" "kpod" % podman-ps "1" "AUGUST 2017" "podman"
## NAME ## NAME
kpod-ps - Prints out information about containers podman-ps - Prints out information about containers
## SYNOPSIS ## SYNOPSIS
**kpod ps** **podman ps**
[**--all**|**-a**] [**--all**|**-a**]
[**--no-trunc**] [**--no-trunc**]
[**--quiet**|**-q**] [**--quiet**|**-q**]
@ -14,7 +14,7 @@ kpod-ps - Prints out information about containers
[**--help**|**-h**] [**--help**|**-h**]
## DESCRIPTION ## DESCRIPTION
**kpod ps** lists the running containers on the system. Use the **--all** flag to view **podman ps** lists the running containers on the system. Use the **--all** flag to view
all the containers information. By default it lists: all the containers information. By default it lists:
* container id * container id
@ -25,11 +25,11 @@ all the containers information. By default it lists:
* port mappings the container is using * port mappings the container is using
* alternative names for the container * alternative names for the container
**kpod [GLOBAL OPTIONS]** **podman [GLOBAL OPTIONS]**
**kpod ps [GLOBAL OPTIONS]** **podman ps [GLOBAL OPTIONS]**
**kpod ps [OPTIONS]** **podman ps [OPTIONS]**
## OPTIONS ## OPTIONS
@ -94,27 +94,27 @@ Valid filters are listed below:
## EXAMPLES ## EXAMPLES
``` ```
sudo kpod ps -a sudo podman ps -a
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
02f65160e14ca redis:alpine "redis-server" 19 hours ago Exited (-1) 19 hours ago 6379/tcp k8s_podsandbox1-redis_podsandbox1_redhat.test.crio_redhat-test-crio_0 02f65160e14ca redis:alpine "redis-server" 19 hours ago Exited (-1) 19 hours ago 6379/tcp k8s_podsandbox1-redis_podsandbox1_redhat.test.crio_redhat-test-crio_0
69ed779d8ef9f redis:alpine "redis-server" 25 hours ago Created 6379/tcp k8s_container1_podsandbox1_redhat.test.crio_redhat-test-crio_1 69ed779d8ef9f redis:alpine "redis-server" 25 hours ago Created 6379/tcp k8s_container1_podsandbox1_redhat.test.crio_redhat-test-crio_1
``` ```
``` ```
sudo kpod ps -a -s sudo podman ps -a -s
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES SIZE CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES SIZE
02f65160e14ca redis:alpine "redis-server" 20 hours ago Exited (-1) 20 hours ago 6379/tcp k8s_podsandbox1-redis_podsandbox1_redhat.test.crio_redhat-test-crio_0 27.49 MB 02f65160e14ca redis:alpine "redis-server" 20 hours ago Exited (-1) 20 hours ago 6379/tcp k8s_podsandbox1-redis_podsandbox1_redhat.test.crio_redhat-test-crio_0 27.49 MB
69ed779d8ef9f redis:alpine "redis-server" 25 hours ago Created 6379/tcp k8s_container1_podsandbox1_redhat.test.crio_redhat-test-crio_1 27.49 MB 69ed779d8ef9f redis:alpine "redis-server" 25 hours ago Created 6379/tcp k8s_container1_podsandbox1_redhat.test.crio_redhat-test-crio_1 27.49 MB
``` ```
``` ```
sudo kpod ps -a --format "{{.ID}} {{.Image}} {{.Labels}} {{.Mounts}}" sudo podman ps -a --format "{{.ID}} {{.Image}} {{.Labels}} {{.Mounts}}"
02f65160e14ca redis:alpine tier=backend proc,tmpfs,devpts,shm,mqueue,sysfs,cgroup,/var/run/,/var/run/ 02f65160e14ca redis:alpine tier=backend proc,tmpfs,devpts,shm,mqueue,sysfs,cgroup,/var/run/,/var/run/
69ed779d8ef9f redis:alpine batch=no,type=small proc,tmpfs,devpts,shm,mqueue,sysfs,cgroup,/var/run/,/var/run/ 69ed779d8ef9f redis:alpine batch=no,type=small proc,tmpfs,devpts,shm,mqueue,sysfs,cgroup,/var/run/,/var/run/
``` ```
``` ```
sudo kpod ps --ns -a sudo podman ps --ns -a
CONTAINER ID NAMES PID CGROUP IPC MNT NET PIDNS USER UTS CONTAINER ID NAMES PID CGROUP IPC MNT NET PIDNS USER UTS
3557d882a82e3 k8s_container2_podsandbox1_redhat.test.crio_redhat-test-crio_1 29910 4026531835 4026532585 4026532593 4026532508 4026532595 4026531837 4026532594 3557d882a82e3 k8s_container2_podsandbox1_redhat.test.crio_redhat-test-crio_1 29910 4026531835 4026532585 4026532593 4026532508 4026532595 4026531837 4026532594
09564cdae0bec k8s_container1_podsandbox1_redhat.test.crio_redhat-test-crio_1 29851 4026531835 4026532585 4026532590 4026532508 4026532592 4026531837 4026532591 09564cdae0bec k8s_container1_podsandbox1_redhat.test.crio_redhat-test-crio_1 29851 4026531835 4026532585 4026532590 4026532508 4026532592 4026531837 4026532591
@ -125,7 +125,7 @@ a31ebbee9cee7 k8s_podsandbox1-redis_podsandbox1_redhat.test.crio_redhat-test-c
Print a list of containers Print a list of containers
## SEE ALSO ## SEE ALSO
kpod(1), crio(8), crio.conf(5) podman(1), crio(8), crio.conf(5)
## HISTORY ## HISTORY
August 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com> August 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com>

View File

@ -1,21 +1,21 @@
% kpod(1) kpod-pull - Simple tool to pull an image from a registry % podman(1) podman-pull - Simple tool to pull an image from a registry
% Urvashi Mohnani % Urvashi Mohnani
# kpod-pull "1" "July 2017" "kpod" # podman-pull "1" "July 2017" "podman"
## NAME ## NAME
kpod-pull - Pull an image from a registry podman-pull - Pull an image from a registry
## SYNOPSIS ## SYNOPSIS
**kpod pull** **podman pull**
**NAME[:TAG|@DIGEST]** **NAME[:TAG|@DIGEST]**
[**--help**|**-h**] [**--help**|**-h**]
## DESCRIPTION ## DESCRIPTION
Copies an image from a registry onto the local machine. **kpod pull** pulls an Copies an image from a registry onto the local machine. **podman pull** pulls an
image from Docker Hub if a registry is not specified in the command line argument. image from Docker Hub if a registry is not specified in the command line argument.
If an image tag is not specified, **kpod pull** defaults to the image with the If an image tag is not specified, **podman pull** defaults to the image with the
**latest** tag (if it exists) and pulls it. **kpod pull** can also pull an image **latest** tag (if it exists) and pulls it. **podman pull** can also pull an image
using its digest **kpod pull [image]@[digest]**. **kpod pull** can be used to pull using its digest **podman pull [image]@[digest]**. **podman pull** can be used to pull
images from archives and local storage using different transports. images from archives and local storage using different transports.
## imageID ## imageID
@ -32,7 +32,7 @@ Image stored in local container/storage
An existing local directory _path_ storing the manifest, layer tarballs and signatures as individual files. This is a non-standardized format, primarily useful for debugging or noninvasive container inspection. An existing local directory _path_ storing the manifest, layer tarballs and signatures as individual files. This is a non-standardized format, primarily useful for debugging or noninvasive container inspection.
**docker://**_docker-reference_ **docker://**_docker-reference_
An image in a registry implementing the "Docker Registry HTTP API V2". By default, uses the authorization state in `$XDG_RUNTIME_DIR/containers/auth.json`, which is set using `(kpod login)`. If the authorization state is not found there, `$HOME/.docker/config.json` is checked, which is set using `(docker login)`. An image in a registry implementing the "Docker Registry HTTP API V2". By default, uses the authorization state in `$XDG_RUNTIME_DIR/containers/auth.json`, which is set using `(podman login)`. If the authorization state is not found there, `$HOME/.docker/config.json` is checked, which is set using `(docker login)`.
**docker-archive:**_path_[**:**_docker-reference_] **docker-archive:**_path_[**:**_docker-reference_]
An image is stored in the `docker save` formatted file. _docker-reference_ is only used when creating such a file, and it must not contain a digest. An image is stored in the `docker save` formatted file. _docker-reference_ is only used when creating such a file, and it must not contain a digest.
@ -46,17 +46,17 @@ Image stored in local container/storage
**ostree:**_image_[**@**_/absolute/repo/path_] **ostree:**_image_[**@**_/absolute/repo/path_]
An image in local OSTree repository. _/absolute/repo/path_ defaults to _/ostree/repo_. An image in local OSTree repository. _/absolute/repo/path_ defaults to _/ostree/repo_.
**kpod [GLOBAL OPTIONS]** **podman [GLOBAL OPTIONS]**
**kpod pull [GLOBAL OPTIONS]** **podman pull [GLOBAL OPTIONS]**
**kpod pull NAME[:TAG|@DIGEST]** **podman pull NAME[:TAG|@DIGEST]**
## OPTIONS ## OPTIONS
**--authfile** **--authfile**
Path of the authentication file. Default is ${XDG_RUNTIME\_DIR}/containers/auth.json, which is set using `kpod login`. Path of the authentication file. Default is ${XDG_RUNTIME\_DIR}/containers/auth.json, which is set using `podman login`.
If the authorization state is not found there, $HOME/.docker/config.json is checked, which is set using `docker login`. If the authorization state is not found there, $HOME/.docker/config.json is checked, which is set using `docker login`.
**--cert-dir** **--cert-dir**
@ -84,7 +84,7 @@ Require HTTPS and verify certificates when contacting registries (default: true)
## EXAMPLES ## EXAMPLES
``` ```
# kpod pull --signature-policy /etc/containers/policy.json alpine:latest # podman pull --signature-policy /etc/containers/policy.json alpine:latest
Trying to pull registry.access.redhat.com/alpine:latest... Failed Trying to pull registry.access.redhat.com/alpine:latest... Failed
Trying to pull registry.fedoraproject.org/alpine:latest... Failed Trying to pull registry.fedoraproject.org/alpine:latest... Failed
Trying to pull docker.io/library/alpine:latest...Getting image source signatures Trying to pull docker.io/library/alpine:latest...Getting image source signatures
@ -97,7 +97,7 @@ Storing signatures
``` ```
``` ```
# kpod pull --authfile temp-auths/myauths.json docker://docker.io/umohnani/finaltest # podman pull --authfile temp-auths/myauths.json docker://docker.io/umohnani/finaltest
Trying to pull docker.io/umohnani/finaltest:latest...Getting image source signatures Trying to pull docker.io/umohnani/finaltest:latest...Getting image source signatures
Copying blob sha256:6d987f6f42797d81a318c40d442369ba3dc124883a0964d40b0c8f4f7561d913 Copying blob sha256:6d987f6f42797d81a318c40d442369ba3dc124883a0964d40b0c8f4f7561d913
1.90 MB / 1.90 MB [========================================================] 0s 1.90 MB / 1.90 MB [========================================================] 0s
@ -108,7 +108,7 @@ Storing signatures
``` ```
``` ```
# kpod pull --creds testuser:testpassword docker.io/umohnani/finaltest # podman pull --creds testuser:testpassword docker.io/umohnani/finaltest
Trying to pull docker.io/umohnani/finaltest:latest...Getting image source signatures Trying to pull docker.io/umohnani/finaltest:latest...Getting image source signatures
Copying blob sha256:6d987f6f42797d81a318c40d442369ba3dc124883a0964d40b0c8f4f7561d913 Copying blob sha256:6d987f6f42797d81a318c40d442369ba3dc124883a0964d40b0c8f4f7561d913
1.90 MB / 1.90 MB [========================================================] 0s 1.90 MB / 1.90 MB [========================================================] 0s
@ -119,7 +119,7 @@ Storing signatures
``` ```
``` ```
# kpod pull --tls-verify=false --cert-dir image/certs docker.io/umohnani/finaltest # podman pull --tls-verify=false --cert-dir image/certs docker.io/umohnani/finaltest
Trying to pull docker.io/umohnani/finaltest:latest...Getting image source signatures Trying to pull docker.io/umohnani/finaltest:latest...Getting image source signatures
Copying blob sha256:6d987f6f42797d81a318c40d442369ba3dc124883a0964d40b0c8f4f7561d913 Copying blob sha256:6d987f6f42797d81a318c40d442369ba3dc124883a0964d40b0c8f4f7561d913
1.90 MB / 1.90 MB [========================================================] 0s 1.90 MB / 1.90 MB [========================================================] 0s
@ -130,7 +130,7 @@ Storing signatures
``` ```
## SEE ALSO ## SEE ALSO
kpod(1), kpod-push(1), crio(8), crio.conf(5), docker-login(1) podman(1), podman-push(1), crio(8), crio.conf(5), docker-login(1)
## HISTORY ## HISTORY
July 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com> July 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com>

View File

@ -1,16 +1,16 @@
% kpod(1) kpod-push - Push an image from local storage to elsewhere % podman(1) podman-push - Push an image from local storage to elsewhere
% Dan Walsh % Dan Walsh
# kpod-push "1" "June 2017" "kpod" # podman-push "1" "June 2017" "podman"
## NAME ## NAME
kpod push - Push an image from local storage to elsewhere podman push - Push an image from local storage to elsewhere
## SYNOPSIS ## SYNOPSIS
**kpod** **push** [*options* [...]] **imageID** [**destination**] **podman** **push** [*options* [...]] **imageID** [**destination**]
## DESCRIPTION ## DESCRIPTION
Pushes an image from local storage to a specified destination. Pushes an image from local storage to a specified destination.
Push is mainly used to push images to registries, however **kpod push** Push is mainly used to push images to registries, however **podman push**
can be used to save images to tarballs and directories using the following can be used to save images to tarballs and directories using the following
transports: **dir:**, **docker-archive:**, **docker-daemon:**, **oci-archive:**, and **ostree:**. transports: **dir:**, **docker-archive:**, **docker-daemon:**, **oci-archive:**, and **ostree:**.
@ -21,7 +21,7 @@ Image stored in local container/storage
The DESTINATION is a location to store container images The DESTINATION is a location to store container images
The Image "DESTINATION" uses a "transport":"details" format. The Image "DESTINATION" uses a "transport":"details" format.
If a transport is not given, kpod push will attempt to push If a transport is not given, podman push will attempt to push
to a registry. to a registry.
Multiple transports are supported: Multiple transports are supported:
@ -30,7 +30,7 @@ Image stored in local container/storage
An existing local directory _path_ storing the manifest, layer tarballs and signatures as individual files. This is a non-standardized format, primarily useful for debugging or noninvasive container inspection. An existing local directory _path_ storing the manifest, layer tarballs and signatures as individual files. This is a non-standardized format, primarily useful for debugging or noninvasive container inspection.
**docker://**_docker-reference_ **docker://**_docker-reference_
An image in a registry implementing the "Docker Registry HTTP API V2". By default, uses the authorization state in `$XDG_RUNTIME_DIR/containers/auth.json`, which is set using `(kpod login)`. If the authorization state is not found there, `$HOME/.docker/config.json` is checked, which is set using `(docker login)`. An image in a registry implementing the "Docker Registry HTTP API V2". By default, uses the authorization state in `$XDG_RUNTIME_DIR/containers/auth.json`, which is set using `(podman login)`. If the authorization state is not found there, `$HOME/.docker/config.json` is checked, which is set using `(docker login)`.
**docker-archive:**_path_[**:**_docker-reference_] **docker-archive:**_path_[**:**_docker-reference_]
An image is stored in the `docker save` formatted file. _docker-reference_ is only used when creating such a file, and it must not contain a digest. An image is stored in the `docker save` formatted file. _docker-reference_ is only used when creating such a file, and it must not contain a digest.
@ -48,7 +48,7 @@ Image stored in local container/storage
**--authfile** **--authfile**
Path of the authentication file. Default is ${XDG_RUNTIME\_DIR}/containers/auth.json, which is set using `kpod login`. Path of the authentication file. Default is ${XDG_RUNTIME\_DIR}/containers/auth.json, which is set using `podman login`.
If the authorization state is not found there, $HOME/.docker/config.json is checked, which is set using `docker login`. If the authorization state is not found there, $HOME/.docker/config.json is checked, which is set using `docker login`.
**--creds="CREDENTIALS"** **--creds="CREDENTIALS"**
@ -95,25 +95,25 @@ Require HTTPS and verify certificates when contacting registries (default: true)
This example extracts the imageID image to a local directory in docker format. This example extracts the imageID image to a local directory in docker format.
`# kpod push imageID dir:/path/to/image` `# podman push imageID dir:/path/to/image`
This example extracts the imageID image to a local directory in oci format. This example extracts the imageID image to a local directory in oci format.
`# kpod push imageID oci-archive:/path/to/layout:image:tag` `# podman push imageID oci-archive:/path/to/layout:image:tag`
This example extracts the imageID image to a container registry named registry.example.com This example extracts the imageID image to a container registry named registry.example.com
`# kpod push imageID docker://registry.example.com/repository:tag` `# podman push imageID docker://registry.example.com/repository:tag`
This example extracts the imageID image and puts into the local docker container store This example extracts the imageID image and puts into the local docker container store
`# kpod push imageID docker-daemon:image:tag` `# podman push imageID docker-daemon:image:tag`
This example pushes the alpine image to umohnani/alpine on dockerhub and reads the creds from This example pushes the alpine image to umohnani/alpine on dockerhub and reads the creds from
the path given to --authfile the path given to --authfile
``` ```
# kpod push --authfile temp-auths/myauths.json alpine docker://docker.io/umohnani/alpine # podman push --authfile temp-auths/myauths.json alpine docker://docker.io/umohnani/alpine
Getting image source signatures Getting image source signatures
Copying blob sha256:5bef08742407efd622d243692b79ba0055383bbce12900324f75e56f589aedb0 Copying blob sha256:5bef08742407efd622d243692b79ba0055383bbce12900324f75e56f589aedb0
4.03 MB / 4.03 MB [========================================================] 1s 4.03 MB / 4.03 MB [========================================================] 1s
@ -125,7 +125,7 @@ Storing signatures
This example pushes the rhel7 image to rhel7-dir with the "oci" manifest type This example pushes the rhel7 image to rhel7-dir with the "oci" manifest type
``` ```
# kpod push --format oci registry.access.redhat.com/rhel7 dir:rhel7-dir # podman push --format oci registry.access.redhat.com/rhel7 dir:rhel7-dir
Getting image source signatures Getting image source signatures
Copying blob sha256:9cadd93b16ff2a0c51ac967ea2abfadfac50cfa3af8b5bf983d89b8f8647f3e4 Copying blob sha256:9cadd93b16ff2a0c51ac967ea2abfadfac50cfa3af8b5bf983d89b8f8647f3e4
71.41 MB / 71.41 MB [======================================================] 9s 71.41 MB / 71.41 MB [======================================================] 9s
@ -138,4 +138,4 @@ Storing signatures
``` ```
## SEE ALSO ## SEE ALSO
kpod(1), kpod-pull(1), crio(8), crio.conf(5), docker-login(1) podman(1), podman-pull(1), crio(8), crio.conf(5), docker-login(1)

38
docs/podman-rm.1.md Normal file
View File

@ -0,0 +1,38 @@
% podman(1) podman-rm - Remove one or more containers
% Ryan Cole
# podman-rm "1" "August 2017" "podman"
## NAME
podman rm - Remove one or more containers
## SYNOPSIS
**podman** **rm** [*options* [...]] container
## DESCRIPTION
podman rm will remove one or more containers from the host. The container name or ID can be used. This does not remove images. Running containers will not be removed without the -f option
## OPTIONS
**--force, f**
Force the removal of a running container
**--all, a**
Remove all containers. Can be used in conjunction with -f as well.
## EXAMPLE
podman rm mywebserver
podman rm mywebserver myflaskserver 860a4b23
podman rm -f 860a4b23
podman rm -f -a
## SEE ALSO
podman(1), podman-rmi(1)
## HISTORY
August 2017, Originally compiled by Ryan Cole <rycole@redhat.com>

View File

@ -1,12 +1,12 @@
% kpod(1) kpod-rmi - Removes one or more images % podman(1) podman-rmi - Removes one or more images
% Dan Walsh % Dan Walsh
# kpod-rmi "1" "March 2017" "kpod" # podman-rmi "1" "March 2017" "podman"
## NAME ## NAME
kpod rmi - Removes one or more images podman rmi - Removes one or more images
## SYNOPSIS ## SYNOPSIS
**kpod** **rmi** **imageID [...]** **podman** **rmi** **imageID [...]**
## DESCRIPTION ## DESCRIPTION
Removes one or more locally stored images. Removes one or more locally stored images.
@ -22,16 +22,16 @@ Executing this command will stop all containers that are using the image and rem
## EXAMPLE ## EXAMPLE
kpod rmi imageID podman rmi imageID
kpod rmi --force imageID podman rmi --force imageID
kpod rmi imageID1 imageID2 imageID3 podman rmi imageID1 imageID2 imageID3
kpod rmi -a -f podman rmi -a -f
## SEE ALSO ## SEE ALSO
kpod(1) podman(1)
## HISTORY ## HISTORY
March 2017, Originally compiled by Dan Walsh <dwalsh@redhat.com> March 2017, Originally compiled by Dan Walsh <dwalsh@redhat.com>

View File

@ -1,22 +1,22 @@
% kpod(1) kpod-run - Run a command in a container % podman(1) podman-run - Run a command in a container
% Dan Walsh % Dan Walsh
kpod-run - Run a command in a new container podman-run - Run a command in a new container
# SYNOPSIS # SYNOPSIS
**kpod run** [*options* [...]] IMAGE [COMMAND] [ARG...] **podman run** [*options* [...]] IMAGE [COMMAND] [ARG...]
# DESCRIPTION # DESCRIPTION
Run a process in a new container. **kpod run** starts a process with its own Run a process in a new container. **podman run** starts a process with its own
file system, its own networking, and its own isolated process tree. The IMAGE file system, its own networking, and its own isolated process tree. The IMAGE
which starts the process may define defaults related to the process that will be which starts the process may define defaults related to the process that will be
run in the container, the networking to expose, and more, but **kpod run** run in the container, the networking to expose, and more, but **podman run**
gives final control to the operator or administrator who starts the container gives final control to the operator or administrator who starts the container
from the image. For that reason **kpod run** has more options than any other from the image. For that reason **podman run** has more options than any other
kpod command. podman command.
If the IMAGE is not already loaded then **kpod run** will pull the IMAGE, and If the IMAGE is not already loaded then **podman run** will pull the IMAGE, and
all image dependencies, from the repository in the same way running **kpod all image dependencies, from the repository in the same way running **podman
pull** IMAGE, before it starts the container from that image. pull** IMAGE, before it starts the container from that image.
# OPTIONS # OPTIONS
@ -30,7 +30,7 @@ option can be set multiple times.
Attach to STDIN, STDOUT or STDERR. Attach to STDIN, STDOUT or STDERR.
In foreground mode (the default when **-d** In foreground mode (the default when **-d**
is not specified), **kpod run** can start the process in the container is not specified), **podman run** can start the process in the container
and attach the console to the process's standard input, output, and standard and attach the console to the process's standard input, output, and standard
error. It can even pretend to be a TTY (this is what most commandline error. It can even pretend to be a TTY (this is what most commandline
executables expect) and pass along signals. The **-a** option can be set for executables expect) and pass along signals. The **-a** option can be set for
@ -138,9 +138,9 @@ two memory nodes.
**-d**, **--detach**=*true*|*false* **-d**, **--detach**=*true*|*false*
Detached mode: run the container in the background and print the new container ID. The default is *false*. Detached mode: run the container in the background and print the new container ID. The default is *false*.
At any time you can run **kpod ps** in At any time you can run **podman ps** in
the other shell to view a list of the running containers. You can reattach to a the other shell to view a list of the running containers. You can reattach to a
detached container with **kpod attach**. If you choose to run a container in detached container with **podman attach**. If you choose to run a container in
the detached mode, then you cannot use the **-rm** option. the detached mode, then you cannot use the **-rm** option.
When attached in the tty mode, you can detach from the container (and leave it When attached in the tty mode, you can detach from the container (and leave it
@ -259,7 +259,7 @@ millions of trillions.
**--log-driver**="*json-file*|*syslog*|*journald*|*gelf*|*fluentd*|*awslogs*|*splunk*|*etwlogs*|*gcplogs*|*none*" **--log-driver**="*json-file*|*syslog*|*journald*|*gelf*|*fluentd*|*awslogs*|*splunk*|*etwlogs*|*gcplogs*|*none*"
Logging driver for the container. Default is defined by daemon `--log-driver` flag. Logging driver for the container. Default is defined by daemon `--log-driver` flag.
**Warning**: the `kpod logs` command works only for the `json-file` and **Warning**: the `podman logs` command works only for the `json-file` and
`journald` logging drivers. `journald` logging drivers.
**--log-opt**=[] **--log-opt**=[]
@ -311,7 +311,7 @@ unit, `b` is used. Set LIMIT to `-1` to enable unlimited swap.
UUID short identifier (“f78375b1c487”) UUID short identifier (“f78375b1c487”)
Name (“jonah”) Name (“jonah”)
kpod generates a UUID for each container, and if a name is not assigned podman generates a UUID for each container, and if a name is not assigned
to the container with **--name** then the daemon will also generate a random to the container with **--name** then the daemon will also generate a random
string name. The name is useful any place you need to identify a container. string name. The name is useful any place you need to identify a container.
This works for both background and foreground containers. This works for both background and foreground containers.
@ -321,7 +321,7 @@ This works for both background and foreground containers.
'bridge': create a network stack on the default bridge 'bridge': create a network stack on the default bridge
'none': no networking 'none': no networking
'container:<name|id>': reuse another container's network stack 'container:<name|id>': reuse another container's network stack
'host': use the kpod host network stack. Note: the host mode gives the container full access to local system services such as D-bus and is therefore considered insecure. 'host': use the podman host network stack. Note: the host mode gives the container full access to local system services such as D-bus and is therefore considered insecure.
'<network-name>|<network-id>': connect to a user-defined network '<network-name>|<network-id>': connect to a user-defined network
**--network-alias**=[] **--network-alias**=[]
@ -348,12 +348,12 @@ This works for both background and foreground containers.
**--privileged**=*true*|*false* **--privileged**=*true*|*false*
Give extended privileges to this container. The default is *false*. Give extended privileges to this container. The default is *false*.
By default, kpod containers are By default, podman containers are
“unprivileged” (=false) and cannot, for example, modify parts of the kernel. “unprivileged” (=false) and cannot, for example, modify parts of the kernel.
This is because by default a container is not allowed to access any devices. This is because by default a container is not allowed to access any devices.
A “privileged” container is given access to all devices. A “privileged” container is given access to all devices.
When the operator executes **kpod run --privileged**, kpod enables access When the operator executes **podman run --privileged**, podman enables access
to all devices on the host as well as set turn off most of the security messurs to all devices on the host as well as set turn off most of the security messurs
protecting the host from the container. protecting the host from the container.
@ -363,21 +363,21 @@ protecting the host from the container.
Format: `ip:hostPort:containerPort | ip::containerPort | hostPort:containerPort | containerPort` Format: `ip:hostPort:containerPort | ip::containerPort | hostPort:containerPort | containerPort`
Both hostPort and containerPort can be specified as a range of ports. Both hostPort and containerPort can be specified as a range of ports.
When specifying ranges for both, the number of container ports in the range must match the number of host ports in the range. When specifying ranges for both, the number of container ports in the range must match the number of host ports in the range.
(e.g., `kpod run -p 1234-1236:1222-1224 --name thisWorks -t busybox` (e.g., `podman run -p 1234-1236:1222-1224 --name thisWorks -t busybox`
but not `kpod run -p 1230-1236:1230-1240 --name RangeContainerPortsBiggerThanRangeHostPorts -t busybox`) but not `podman run -p 1230-1236:1230-1240 --name RangeContainerPortsBiggerThanRangeHostPorts -t busybox`)
With ip: `kpod run -p 127.0.0.1:$HOSTPORT:$CONTAINERPORT --name CONTAINER -t someimage` With ip: `podman run -p 127.0.0.1:$HOSTPORT:$CONTAINERPORT --name CONTAINER -t someimage`
Use `kpod port` to see the actual mapping: `kpod port CONTAINER $CONTAINERPORT` Use `podman port` to see the actual mapping: `podman port CONTAINER $CONTAINERPORT`
**-P**, **--publish-all**=*true*|*false* **-P**, **--publish-all**=*true*|*false*
Publish all exposed ports to random ports on the host interfaces. The default is *false*. Publish all exposed ports to random ports on the host interfaces. The default is *false*.
When set to true publish all exposed ports to the host interfaces. The When set to true publish all exposed ports to the host interfaces. The
default is false. If the operator uses -P (or -p) then kpod will make the default is false. If the operator uses -P (or -p) then podman will make the
exposed port accessible on the host and the ports will be available to any exposed port accessible on the host and the ports will be available to any
client that can reach the host. When using -P, kpod will bind any exposed client that can reach the host. When using -P, podman will bind any exposed
port to a random port on the host within an *ephemeral port range* defined by port to a random port on the host within an *ephemeral port range* defined by
`/proc/sys/net/ipv4/ip_local_port_range`. To find the mapping between the host `/proc/sys/net/ipv4/ip_local_port_range`. To find the mapping between the host
ports and the exposed ports, use `kpod port`. ports and the exposed ports, use `podman port`.
**--read-only**=*true*|*false* **--read-only**=*true*|*false*
Mount the container's root filesystem as read only. Mount the container's root filesystem as read only.
@ -424,7 +424,7 @@ incompatible with any restart policy other than `none`.
**--storage-opt**=[] **--storage-opt**=[]
Storage driver options per container Storage driver options per container
$ kpod run -it --storage-opt size=120G fedora /bin/bash $ podman run -it --storage-opt size=120G fedora /bin/bash
This (size) will allow to set the container rootfs size to 120G at creation time. This (size) will allow to set the container rootfs size to 120G at creation time.
This option is only available for the `devicemapper`, `btrfs`, `overlay2` and `zfs` graph drivers. This option is only available for the `devicemapper`, `btrfs`, `overlay2` and `zfs` graph drivers.
@ -451,7 +451,7 @@ incompatible with any restart policy other than `none`.
Mount a temporary filesystem (`tmpfs`) mount into a container, for example: Mount a temporary filesystem (`tmpfs`) mount into a container, for example:
$ kpod run -d --tmpfs /tmp:rw,size=787448k,mode=1777 my_image $ podman run -d --tmpfs /tmp:rw,size=787448k,mode=1777 my_image
This command mounts a `tmpfs` at `/tmp` within the container. The supported mount This command mounts a `tmpfs` at `/tmp` within the container. The supported mount
options are the same as the Linux default `mount` flags. If you do not specify options are the same as the Linux default `mount` flags. If you do not specify
@ -461,11 +461,11 @@ any options, the systems uses the following options:
**-t**, **--tty**=*true*|*false* **-t**, **--tty**=*true*|*false*
Allocate a pseudo-TTY. The default is *false*. Allocate a pseudo-TTY. The default is *false*.
When set to true kpod will allocate a pseudo-tty and attach to the standard When set to true podman will allocate a pseudo-tty and attach to the standard
input of the container. This can be used, for example, to run a throwaway input of the container. This can be used, for example, to run a throwaway
interactive shell. The default is false. interactive shell. The default is false.
Note: The **-t** option is incompatible with a redirection of the kpod client Note: The **-t** option is incompatible with a redirection of the podman client
standard input. standard input.
**--ulimit**=[] **--ulimit**=[]
@ -489,8 +489,8 @@ standard input.
Note: the host mode gives the container access to changing the host's hostname and is therefore considered insecure. Note: the host mode gives the container access to changing the host's hostname and is therefore considered insecure.
**-v**|**--volume**[=*[HOST-DIR:CONTAINER-DIR[:OPTIONS]]*] **-v**|**--volume**[=*[HOST-DIR:CONTAINER-DIR[:OPTIONS]]*]
Create a bind mount. If you specify, ` -v /HOST-DIR:/CONTAINER-DIR`, kpod Create a bind mount. If you specify, ` -v /HOST-DIR:/CONTAINER-DIR`, podman
bind mounts `/HOST-DIR` in the host to `/CONTAINER-DIR` in the kpod bind mounts `/HOST-DIR` in the host to `/CONTAINER-DIR` in the podman
container. The `OPTIONS` are a comma delimited list and can be: container. The `OPTIONS` are a comma delimited list and can be:
* [rw|ro] * [rw|ro]
@ -498,8 +498,8 @@ standard input.
* [`[r]shared`|`[r]slave`|`[r]private`] * [`[r]shared`|`[r]slave`|`[r]private`]
The `CONTAINER-DIR` must be an absolute path such as `/src/docs`. The `HOST-DIR` The `CONTAINER-DIR` must be an absolute path such as `/src/docs`. The `HOST-DIR`
must be an absolute path as well. kpod bind-mounts the `HOST-DIR` to the must be an absolute path as well. podman bind-mounts the `HOST-DIR` to the
path you specify. For example, if you supply the `/foo` value, kpod creates a bind-mount. path you specify. For example, if you supply the `/foo` value, podman creates a bind-mount.
You can specify multiple **-v** options to mount one or more mounts to a You can specify multiple **-v** options to mount one or more mounts to a
container. container.
@ -511,14 +511,14 @@ See examples.
Labeling systems like SELinux require that proper labels are placed on volume Labeling systems like SELinux require that proper labels are placed on volume
content mounted into a container. Without a label, the security system might content mounted into a container. Without a label, the security system might
prevent the processes running inside the container from using the content. By prevent the processes running inside the container from using the content. By
default, kpod does not change the labels set by the OS. default, podman does not change the labels set by the OS.
To change a label in the container context, you can add either of two suffixes To change a label in the container context, you can add either of two suffixes
`:z` or `:Z` to the volume mount. These suffixes tell kpod to relabel file `:z` or `:Z` to the volume mount. These suffixes tell podman to relabel file
objects on the shared volumes. The `z` option tells kpod that two containers objects on the shared volumes. The `z` option tells podman that two containers
share the volume content. As a result, kpod labels the content with a shared share the volume content. As a result, podman labels the content with a shared
content label. Shared volume labels allow all containers to read/write content. content label. Shared volume labels allow all containers to read/write content.
The `Z` option tells kpod to label the content with a private unshared label. The `Z` option tells podman to label the content with a private unshared label.
Only the current container can use a private volume. Only the current container can use a private volume.
By default bind mounted volumes are `private`. That means any mounts done By default bind mounted volumes are `private`. That means any mounts done
@ -564,34 +564,34 @@ can override the working directory by using the **-w** option.
# Exit Status # Exit Status
The exit code from `kpod run` gives information about why the container The exit code from `podman run` gives information about why the container
failed to run or why it exited. When `kpod run` exits with a non-zero code, failed to run or why it exited. When `podman run` exits with a non-zero code,
the exit codes follow the `chroot` standard, see below: the exit codes follow the `chroot` standard, see below:
**_125_** if the error is with kpod **_itself_** **_125_** if the error is with podman **_itself_**
$ kpod run --foo busybox; echo $? $ podman run --foo busybox; echo $?
# flag provided but not defined: --foo # flag provided but not defined: --foo
See 'kpod run --help'. See 'podman run --help'.
125 125
**_126_** if the **_contained command_** cannot be invoked **_126_** if the **_contained command_** cannot be invoked
$ kpod run busybox /etc; echo $? $ podman run busybox /etc; echo $?
# exec: "/etc": permission denied # exec: "/etc": permission denied
kpod: Error response from daemon: Contained command could not be invoked podman: Error response from daemon: Contained command could not be invoked
126 126
**_127_** if the **_contained command_** cannot be found **_127_** if the **_contained command_** cannot be found
$ kpod run busybox foo; echo $? $ podman run busybox foo; echo $?
# exec: "foo": executable file not found in $PATH # exec: "foo": executable file not found in $PATH
kpod: Error response from daemon: Contained command not found or does not exist podman: Error response from daemon: Contained command not found or does not exist
127 127
**_Exit code_** of **_contained command_** otherwise **_Exit code_** of **_contained command_** otherwise
$ kpod run busybox /bin/sh -c 'exit 3' $ podman run busybox /bin/sh -c 'exit 3'
# 3 # 3
# EXAMPLES # EXAMPLES
@ -607,14 +607,14 @@ This protects the containers image from modification. Read only containers may
still need to write temporary data. The best way to handle this is to mount still need to write temporary data. The best way to handle this is to mount
tmpfs directories on /run and /tmp. tmpfs directories on /run and /tmp.
# kpod run --read-only --tmpfs /run --tmpfs /tmp -i -t fedora /bin/bash # podman run --read-only --tmpfs /run --tmpfs /tmp -i -t fedora /bin/bash
## Exposing log messages from the container to the host's log ## Exposing log messages from the container to the host's log
If you want messages that are logged in your container to show up in the host's If you want messages that are logged in your container to show up in the host's
syslog/journal then you should bind mount the /dev/log directory as follows. syslog/journal then you should bind mount the /dev/log directory as follows.
# kpod run -v /dev/log:/dev/log -i -t fedora /bin/bash # podman run -v /dev/log:/dev/log -i -t fedora /bin/bash
From inside the container you can test this by sending a message to the log. From inside the container you can test this by sending a message to the log.
@ -630,11 +630,11 @@ This should list the message sent to logger.
## Attaching to one or more from STDIN, STDOUT, STDERR ## Attaching to one or more from STDIN, STDOUT, STDERR
If you do not specify -a then kpod will attach everything (stdin,stdout,stderr) If you do not specify -a then podman will attach everything (stdin,stdout,stderr)
. You can specify to which of the three standard streams (stdin, stdout, stderr) . You can specify to which of the three standard streams (stdin, stdout, stderr)
you'd like to connect instead, as in: you'd like to connect instead, as in:
# kpod run -a stdin -a stdout -i -t fedora /bin/bash # podman run -a stdin -a stdout -i -t fedora /bin/bash
## Sharing IPC between containers ## Sharing IPC between containers
@ -655,7 +655,7 @@ Host shows a shared memory segment with 7 pids attached, happens to be from http
Now run a regular container, and it correctly does NOT see the shared memory segment from the host: Now run a regular container, and it correctly does NOT see the shared memory segment from the host:
``` ```
$ kpod run -it shm ipcs -m $ podman run -it shm ipcs -m
------ Shared Memory Segments -------- ------ Shared Memory Segments --------
key shmid owner perms bytes nattch status key shmid owner perms bytes nattch status
@ -664,7 +664,7 @@ Now run a regular container, and it correctly does NOT see the shared memory seg
Run a container with the new `--ipc=host` option, and it now sees the shared memory segment from the host httpd: Run a container with the new `--ipc=host` option, and it now sees the shared memory segment from the host httpd:
``` ```
$ kpod run -it --ipc=host shm ipcs -m $ podman run -it --ipc=host shm ipcs -m
------ Shared Memory Segments -------- ------ Shared Memory Segments --------
key shmid owner perms bytes nattch status key shmid owner perms bytes nattch status
@ -674,7 +674,7 @@ Testing `--ipc=container:CONTAINERID` mode:
Start a container with a program to create a shared memory segment: Start a container with a program to create a shared memory segment:
``` ```
$ kpod run -it shm bash $ podman run -it shm bash
$ sudo shm/shm_server & $ sudo shm/shm_server &
$ sudo ipcs -m $ sudo ipcs -m
@ -684,7 +684,7 @@ Start a container with a program to create a shared memory segment:
``` ```
Create a 2nd container correctly shows no shared memory segment from 1st container: Create a 2nd container correctly shows no shared memory segment from 1st container:
``` ```
$ kpod run shm ipcs -m $ podman run shm ipcs -m
------ Shared Memory Segments -------- ------ Shared Memory Segments --------
key shmid owner perms bytes nattch status key shmid owner perms bytes nattch status
@ -693,7 +693,7 @@ Create a 2nd container correctly shows no shared memory segment from 1st contain
Create a 3rd container using the new --ipc=container:CONTAINERID option, now it shows the shared memory segment from the first: Create a 3rd container using the new --ipc=container:CONTAINERID option, now it shows the shared memory segment from the first:
``` ```
$ kpod run -it --ipc=container:ed735b2264ac shm ipcs -m $ podman run -it --ipc=container:ed735b2264ac shm ipcs -m
$ sudo ipcs -m $ sudo ipcs -m
------ Shared Memory Segments -------- ------ Shared Memory Segments --------
@ -707,7 +707,7 @@ The exposed port of an application can be mapped to a host port using the **-p**
flag. For example, an httpd port 80 can be mapped to the host port 8080 using the flag. For example, an httpd port 80 can be mapped to the host port 8080 using the
following: following:
# kpod run -p 8080:80 -d -i -t fedora/httpd # podman run -p 8080:80 -d -i -t fedora/httpd
## Mounting External Volumes ## Mounting External Volumes
@ -715,7 +715,7 @@ To mount a host directory as a container volume, specify the absolute path to
the directory and the absolute path for the container directory separated by a the directory and the absolute path for the container directory separated by a
colon: colon:
# kpod run -v /var/db:/data1 -i -t fedora bash # podman run -v /var/db:/data1 -i -t fedora bash
When using SELinux, be aware that the host has no knowledge of container SELinux When using SELinux, be aware that the host has no knowledge of container SELinux
policy. Therefore, in the above example, if SELinux policy is enforced, the policy. Therefore, in the above example, if SELinux policy is enforced, the
@ -740,23 +740,23 @@ the `--security-opt` flag. For example, you can specify the MCS/MLS level, a
requirement for MLS systems. Specifying the level in the following command requirement for MLS systems. Specifying the level in the following command
allows you to share the same content between containers. allows you to share the same content between containers.
# kpod run --security-opt label=level:s0:c100,c200 -i -t fedora bash # podman run --security-opt label=level:s0:c100,c200 -i -t fedora bash
An MLS example might be: An MLS example might be:
# kpod run --security-opt label=level:TopSecret -i -t rhel7 bash # podman run --security-opt label=level:TopSecret -i -t rhel7 bash
To disable the security labeling for this container versus running with the To disable the security labeling for this container versus running with the
`--permissive` flag, use the following command: `--permissive` flag, use the following command:
# kpod run --security-opt label=disable -i -t fedora bash # podman run --security-opt label=disable -i -t fedora bash
If you want a tighter security policy on the processes within a container, If you want a tighter security policy on the processes within a container,
you can specify an alternate type for the container. You could run a container you can specify an alternate type for the container. You could run a container
that is only allowed to listen on Apache ports by executing the following that is only allowed to listen on Apache ports by executing the following
command: command:
# kpod run --security-opt label=type:svirt_apache_t -i -t centos bash # podman run --security-opt label=type:svirt_apache_t -i -t centos bash
Note: Note:
@ -767,10 +767,10 @@ You would have to write policy defining a `svirt_apache_t` type.
If you want to set `/dev/sda` device weight to `200`, you can specify the device If you want to set `/dev/sda` device weight to `200`, you can specify the device
weight by `--blkio-weight-device` flag. Use the following command: weight by `--blkio-weight-device` flag. Use the following command:
# kpod run -it --blkio-weight-device "/dev/sda:200" ubuntu # podman run -it --blkio-weight-device "/dev/sda:200" ubuntu
``` ```
$ kpod run -d busybox top $ podman run -d busybox top
``` ```
## Setting Namespaced Kernel Parameters (Sysctls) ## Setting Namespaced Kernel Parameters (Sysctls)
@ -779,11 +779,11 @@ The `--sysctl` sets namespaced kernel parameters (sysctls) in the
container. For example, to turn on IP forwarding in the containers container. For example, to turn on IP forwarding in the containers
network namespace, run this command: network namespace, run this command:
$ kpod run --sysctl net.ipv4.ip_forward=1 someimage $ podman run --sysctl net.ipv4.ip_forward=1 someimage
Note: Note:
Not all sysctls are namespaced. kpod does not support changing sysctls Not all sysctls are namespaced. podman does not support changing sysctls
inside of a container that also modify the host system. As the kernel inside of a container that also modify the host system. As the kernel
evolves we expect to see more sysctls become namespaced. evolves we expect to see more sysctls become namespaced.
@ -796,4 +796,4 @@ based on docker.com source material and internal work.
June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au> June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
July 2014, updated by Sven Dowideit <SvenDowideit@home.org.au> July 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
November 2015, updated by Sally O'Malley <somalley@redhat.com> November 2015, updated by Sally O'Malley <somalley@redhat.com>
October 2017, converted from Docker documentation to kpod by Dan Walsh for kpod <dwalsh@redhat.com> October 2017, converted from Docker documentation to podman by Dan Walsh for podman <dwalsh@redhat.com>

View File

@ -1,12 +1,12 @@
% kpod(1) kpod-save - Simple tool to save an image to an archive % podman(1) podman-save - Simple tool to save an image to an archive
% Urvashi Mohnani % Urvashi Mohnani
# kpod-save "1" "July 2017" "kpod" # podman-save "1" "July 2017" "podman"
## NAME ## NAME
kpod-save - Save an image to docker-archive or oci-archive podman-save - Save an image to docker-archive or oci-archive
## SYNOPSIS ## SYNOPSIS
**kpod save** **podman save**
**NAME[:TAG]** **NAME[:TAG]**
[**--quiet**|**-q**] [**--quiet**|**-q**]
[**--format**] [**--format**]
@ -14,16 +14,16 @@ kpod-save - Save an image to docker-archive or oci-archive
[**--help**|**-h**] [**--help**|**-h**]
## DESCRIPTION ## DESCRIPTION
**kpod save** saves an image to either **docker-archive**, **oci-archive**, **oci-dir** (directory **podman save** saves an image to either **docker-archive**, **oci-archive**, **oci-dir** (directory
with oci manifest type), or **docker-dir** (directory with v2s2 manifest type) on the local machine, with oci manifest type), or **docker-dir** (directory with v2s2 manifest type) on the local machine,
default is **docker-archive**. **kpod save** writes to STDOUT by default and can be redirected to a default is **docker-archive**. **podman save** writes to STDOUT by default and can be redirected to a
file using the **output** flag. The **quiet** flag suppresses the output when set. file using the **output** flag. The **quiet** flag suppresses the output when set.
**kpod [GLOBAL OPTIONS]** **podman [GLOBAL OPTIONS]**
**kpod save [GLOBAL OPTIONS]** **podman save [GLOBAL OPTIONS]**
**kpod save [OPTIONS] NAME[:TAG]** **podman save [OPTIONS] NAME[:TAG]**
## OPTIONS ## OPTIONS
@ -49,19 +49,19 @@ Suppress the output
## EXAMPLES ## EXAMPLES
``` ```
# kpod save --quiet -o alpine.tar alpine:2.6 # podman save --quiet -o alpine.tar alpine:2.6
``` ```
``` ```
# kpod save > alpine-all.tar alpine # podman save > alpine-all.tar alpine
``` ```
``` ```
# kpod save -o oci-alpine.tar --format oci-archive alpine # podman save -o oci-alpine.tar --format oci-archive alpine
``` ```
``` ```
# kpod save --compress --format oci-dir -o alp-dir alpine # podman save --compress --format oci-dir -o alp-dir alpine
Getting image source signatures Getting image source signatures
Copying blob sha256:2fdfe1cd78c20d05774f0919be19bc1a3e4729bce219968e4188e7e0f1af679d Copying blob sha256:2fdfe1cd78c20d05774f0919be19bc1a3e4729bce219968e4188e7e0f1af679d
1.97 MB / 1.97 MB [========================================================] 0s 1.97 MB / 1.97 MB [========================================================] 0s
@ -72,7 +72,7 @@ Storing signatures
``` ```
``` ```
# kpod save --format docker-dir -o ubuntu-dir ubuntu # podman save --format docker-dir -o ubuntu-dir ubuntu
Getting image source signatures Getting image source signatures
Copying blob sha256:660c48dd555dcbfdfe19c80a30f557ac57a15f595250e67bfad1e5663c1725bb Copying blob sha256:660c48dd555dcbfdfe19c80a30f557ac57a15f595250e67bfad1e5663c1725bb
45.55 MB / 45.55 MB [======================================================] 8s 45.55 MB / 45.55 MB [======================================================] 8s
@ -91,7 +91,7 @@ Storing signatures
``` ```
## SEE ALSO ## SEE ALSO
kpod(1), kpod-load(1), crio(8), crio.conf(5) podman(1), podman-load(1), crio(8), crio.conf(5)
## HISTORY ## HISTORY
July 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com> July 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com>

View File

@ -1,12 +1,12 @@
% kpod(1) kpod-start - Stop one or more containers % podman(1) podman-start - Stop one or more containers
% Brent Baude % Brent Baude
# kpod-start "1" "November 2017" "kpod" # podman-start "1" "November 2017" "podman"
## NAME ## NAME
kpod start - Start one or more containers podman start - Start one or more containers
## SYNOPSIS ## SYNOPSIS
**kpod start [OPTIONS] CONTAINER [...]** **podman start [OPTIONS] CONTAINER [...]**
## DESCRIPTION ## DESCRIPTION
Start one or more containers. You may use container IDs or names as input. The *attach* and *interactive* Start one or more containers. You may use container IDs or names as input. The *attach* and *interactive*
@ -32,14 +32,14 @@ Attach container's STDIN. The default is false.
## EXAMPLE ## EXAMPLE
kpod start mywebserver podman start mywebserver
kpod start 860a4b23 5421ab4 podman start 860a4b23 5421ab4
kpod start -i -a 860a4b23 podman start -i -a 860a4b23
## SEE ALSO ## SEE ALSO
kpod(1), kpod-create(1) podman(1), podman-create(1)
## HISTORY ## HISTORY
November 2018, Originally compiled by Brent Baude <bbaude@redhat.com> November 2018, Originally compiled by Brent Baude <bbaude@redhat.com>

View File

@ -1,12 +1,12 @@
% kpod(1) kpod-stats - Display a live stream of 1 or more containers' resource usage statistics % podman(1) podman-stats - Display a live stream of 1 or more containers' resource usage statistics
% Ryan Cole % Ryan Cole
# kpod-stats "1" "July 2017" "kpod" # podman-stats "1" "July 2017" "podman"
## NAME ## NAME
kpod-stats - Display a live stream of 1 or more containers' resource usage statistics podman-stats - Display a live stream of 1 or more containers' resource usage statistics
## SYNOPSIS ## SYNOPSIS
**kpod** **stats** [*options* [...]] [container] **podman** **stats** [*options* [...]] [container]
## DESCRIPTION ## DESCRIPTION
Display a live stream of one or more containers' resource usage statistics Display a live stream of one or more containers' resource usage statistics
@ -33,7 +33,7 @@ Pretty-print images using a Go template
## EXAMPLE ## EXAMPLE
``` ```
# kpod stats -a --no-stream # podman stats -a --no-stream
CONTAINER CPU % MEM USAGE / LIMIT MEM % NET IO BLOCK IO PIDS CONTAINER CPU % MEM USAGE / LIMIT MEM % NET IO BLOCK IO PIDS
132ade621b5d 0.00% 1.618MB / 33.08GB 0.00% 0B / 0B 0B / 0B 0 132ade621b5d 0.00% 1.618MB / 33.08GB 0.00% 0B / 0B 0B / 0B 0
@ -46,14 +46,14 @@ f5a62a71b07b 0.00% 5.669MB / 33.08GB 0.02% 0B / 0B 0B / 0B 3
``` ```
``` ```
# kpod stats --no-stream 31eab2cf93f4 # podman stats --no-stream 31eab2cf93f4
CONTAINER CPU % MEM USAGE / LIMIT MEM % NET IO BLOCK IO PIDS CONTAINER CPU % MEM USAGE / LIMIT MEM % NET IO BLOCK IO PIDS
31eab2cf93f4 0.00% 16.42MB / 33.08GB 0.05% 0B / 0B 22.43MB / 0B 0 31eab2cf93f4 0.00% 16.42MB / 33.08GB 0.05% 0B / 0B 22.43MB / 0B 0
# #
``` ```
``` ```
# kpod stats --no-stream --format=json 31eab2cf93f4 # podman stats --no-stream --format=json 31eab2cf93f4
[ [
{ {
"name": "31eab2cf93f4", "name": "31eab2cf93f4",
@ -71,7 +71,7 @@ CONTAINER CPU % MEM USAGE / LIMIT MEM % NET IO BLOCK IO PIDS
## SEE ALSO ## SEE ALSO
kpod(1) podman(1)
## HISTORY ## HISTORY
July 2017, Originally compiled by Ryan Cole <rycole@redhat.com> July 2017, Originally compiled by Ryan Cole <rycole@redhat.com>

View File

@ -1,12 +1,12 @@
% kpod(1) kpod-stop - Stop one or more containers % podman(1) podman-stop - Stop one or more containers
% Brent Baude % Brent Baude
# kpod-stop "1" "September 2017" "kpod" # podman-stop "1" "September 2017" "podman"
## NAME ## NAME
kpod stop - Stop one or more containers podman stop - Stop one or more containers
## SYNOPSIS ## SYNOPSIS
**kpod stop [OPTIONS] CONTAINER [...]** **podman stop [OPTIONS] CONTAINER [...]**
## DESCRIPTION ## DESCRIPTION
Stops one or more containers. You may use container IDs or names as input. The **--timeout** switch Stops one or more containers. You may use container IDs or names as input. The **--timeout** switch
@ -26,18 +26,18 @@ Stop all running containers. This does not include paused containers.
## EXAMPLE ## EXAMPLE
kpod stop mywebserver podman stop mywebserver
kpod stop 860a4b23 podman stop 860a4b23
kpod stop mywebserver 860a4b23 podman stop mywebserver 860a4b23
kpod stop --timeout 2 860a4b23 podman stop --timeout 2 860a4b23
kpod stop -a podman stop -a
## SEE ALSO ## SEE ALSO
kpod(1), kpod-rm(1) podman(1), podman-rm(1)
## HISTORY ## HISTORY
September 2018, Originally compiled by Brent Baude <bbaude@redhat.com> September 2018, Originally compiled by Brent Baude <bbaude@redhat.com>

View File

@ -1,20 +1,20 @@
% kpod(1) kpod-tag - Add tags to an image % podman(1) podman-tag - Add tags to an image
% Ryan Cole % Ryan Cole
# kpod-tag "1" "July 2017" "kpod" # podman-tag "1" "July 2017" "podman"
## NAME ## NAME
kpod tag - Add an additional name to a local image podman tag - Add an additional name to a local image
## SYNOPSIS ## SYNOPSIS
**kpod tag** **podman tag**
[**--help**|**-h**] [**--help**|**-h**]
## DESCRIPTION ## DESCRIPTION
Assigns a new alias to an image in a registry. An alias refers to the entire image name, including the optional **TAG** after the ':' Assigns a new alias to an image in a registry. An alias refers to the entire image name, including the optional **TAG** after the ':'
**kpod [GLOBAL OPTIONS]** **podman [GLOBAL OPTIONS]**
**kpod [GLOBAL OPTIONS] tag [OPTIONS]** **podman [GLOBAL OPTIONS] tag [OPTIONS]**
## GLOBAL OPTIONS ## GLOBAL OPTIONS
@ -23,12 +23,12 @@ Assigns a new alias to an image in a registry. An alias refers to the entire im
## EXAMPLES ## EXAMPLES
kpod tag 0e3bbc2 fedora:latest podman tag 0e3bbc2 fedora:latest
kpod tag httpd myregistryhost:5000/fedora/httpd:v2 podman tag httpd myregistryhost:5000/fedora/httpd:v2
## SEE ALSO ## SEE ALSO
kpod(1), crio(8), crio.conf(5) podman(1), crio(8), crio.conf(5)
## HISTORY ## HISTORY
July 2017, Originally compiled by Ryan Cole <rycole@redhat.com> July 2017, Originally compiled by Ryan Cole <rycole@redhat.com>

View File

@ -1,17 +1,17 @@
% kpod(1) kpod-top - display the running processes of a container % podman(1) podman-top - display the running processes of a container
% Brent Baude % Brent Baude
## NAME ## NAME
kpod top - Display the running processes of a container podman top - Display the running processes of a container
## SYNOPSIS ## SYNOPSIS
**kpod top** **podman top**
[**--help**|**-h**] [**--help**|**-h**]
## DESCRIPTION ## DESCRIPTION
Display the running process of the container. ps-OPTION can be any of the options you would pass to a Linux ps command Display the running process of the container. ps-OPTION can be any of the options you would pass to a Linux ps command
**kpod [GLOBAL OPTIONS] top [OPTIONS]** **podman [GLOBAL OPTIONS] top [OPTIONS]**
## OPTIONS ## OPTIONS
@ -24,7 +24,7 @@ Display the running process of the container. ps-OPTION can be any of the option
## EXAMPLES ## EXAMPLES
``` ```
# kpod top f5a62a71b07 # podman top f5a62a71b07
UID PID PPID %CPU STIME TT TIME CMD UID PID PPID %CPU STIME TT TIME CMD
0 18715 18705 0.0 10:35 pts/0 00:00:00 /bin/bash 0 18715 18705 0.0 10:35 pts/0 00:00:00 /bin/bash
0 18741 18715 0.0 10:35 pts/0 00:00:00 vi 0 18741 18715 0.0 10:35 pts/0 00:00:00 vi
@ -32,14 +32,14 @@ Display the running process of the container. ps-OPTION can be any of the option
``` ```
``` ```
#kpod --log-level=debug top f5a62a71b07 -o fuser,f,comm,label #podman --log-level=debug top f5a62a71b07 -o fuser,f,comm,label
FUSER F COMMAND LABEL FUSER F COMMAND LABEL
root 4 bash system_u:system_r:container_t:s0:c429,c1016 root 4 bash system_u:system_r:container_t:s0:c429,c1016
root 0 vi system_u:system_r:container_t:s0:c429,c1016 root 0 vi system_u:system_r:container_t:s0:c429,c1016
# #
``` ```
``` ```
# kpod top --format=json f5a62a71b07b -o %cpu,%mem,command,blocked # podman top --format=json f5a62a71b07b -o %cpu,%mem,command,blocked
[ [
{ {
"CPU": "0.0", "CPU": "0.0",
@ -53,7 +53,7 @@ root 0 vi system_u:system_r:container_t:s0:c429,c1016
... ...
``` ```
## SEE ALSO ## SEE ALSO
kpod(1), ps(1) podman(1), ps(1)
## HISTORY ## HISTORY
December 2017, Originally compiled by Brent Baude<bbaude@redhat.com> December 2017, Originally compiled by Brent Baude<bbaude@redhat.com>

19
docs/podman-umount.1.md Normal file
View File

@ -0,0 +1,19 @@
% podman(1) podman-umount - Unmount a working container's root filesystem.
% Dan Walsh
# podman-umount "1" "July 2017" "podman"
## NAME
podman umount - Unmount a working container's root file system
## SYNOPSIS
**podman** **umount** **containerID**
## DESCRIPTION
Unmounts the specified container's root file system.
## EXAMPLE
podman umount containerID
## SEE ALSO
podman(1), podman-mount(1)

24
docs/podman-unpause.1.md Normal file
View File

@ -0,0 +1,24 @@
% podman(1) podman-unpause - Unpause one or more containers
% Dan Walsh
# podman-unpause "1" "September 2017" "podman"
## NAME
podman unpause - Unpause one or more containers
## SYNOPSIS
**podman unpause [OPTIONS] CONTAINER [...]**
## DESCRIPTION
Unpauses the processes in one or more containers. You may use container IDs or names as input.
## EXAMPLE
podman unpause mywebserver
podman unpause 860a4b23
## SEE ALSO
podman(1), podman-pause(1)
## HISTORY
September 2017, Originally compiled by Dan Walsh <dwalsh@redhat.com>

View File

@ -1,24 +1,24 @@
% kpod(1) kpod-version - Simple tool to view version information % podman(1) podman-version - Simple tool to view version information
% Urvashi Mohnani % Urvashi Mohnani
# kpod-version "1" "July 2017" "kpod" # podman-version "1" "July 2017" "podman"
## NAME ## NAME
kpod-version - Display the KPOD Version Information podman-version - Display the PODMAN Version Information
## SYNOPSIS ## SYNOPSIS
**kpod version** **podman version**
[**--help**|**-h**] [**--help**|**-h**]
## DESCRIPTION ## DESCRIPTION
Shows the the following information: Version, Go Version, Git Commit, Build Time, Shows the the following information: Version, Go Version, Git Commit, Build Time,
OS, and Architecture. OS, and Architecture.
**kpod [GLOBAL OPTIONS]** **podman [GLOBAL OPTIONS]**
**kpod version** **podman version**
## SEE ALSO ## SEE ALSO
kpod(1), crio(8), crio.conf(5) podman(1), crio(8), crio.conf(5)
## HISTORY ## HISTORY
July 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com> July 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com>

36
docs/podman-wait.1.md Normal file
View File

@ -0,0 +1,36 @@
% podman(1) podman-wait - Waits on a container
% Brent Baude
# podman-wait "1" "September 2017" "podman"
## NAME
podman wait - Waits on one or more containers to stop and prints exit code
## SYNOPSIS
**podman wait**
[**--help**|**-h**]
## DESCRIPTION
Waits on one or more containers to stop. The container can be referred to by its
name or ID. In the case of multiple containers, podman will wait on each consecutively.
After the container stops, the container's return code is printed.
**podman [GLOBAL OPTIONS] wait **
## GLOBAL OPTIONS
**--help, -h**
Print usage statement
## EXAMPLES
podman wait mywebserver
podman wait 860a4b23
podman wait mywebserver myftpserver
## SEE ALSO
podman(1), crio(8), crio.conf(5)
## HISTORY
September 2017, Originally compiled by Brent Baude<bbaude@redhat.com>

View File

@ -1,22 +1,22 @@
% kpod(1) kpod - Simple management tool for pods and images % podman(1) podman - Simple management tool for pods and images
% Dan Walsh % Dan Walsh
# kpod "1" "September 2016" "kpod" # podman "1" "September 2016" "podman"
## NAME ## NAME
kpod - Simple management tool for containers and images podman - Simple management tool for containers and images
## SYNOPSIS ## SYNOPSIS
**kpod** [*options*] COMMAND **podman** [*options*] COMMAND
# DESCRIPTION # DESCRIPTION
kpod is a simple client only tool to help with debugging issues when daemons podman 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 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 layer could be created to share code between the daemon and podman. podman does not
require any daemon running. kpod utilizes the same underlying components that require any daemon running. podman utilizes the same underlying components that
crio uses i.e. containers/image, container/storage, oci-runtime-tool/generate, 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 runc or any other OCI compatible runtime. podman shares state with crio and so
has the capability to debug pods/images created by crio. has the capability to debug pods/images created by crio.
**kpod [GLOBAL OPTIONS]** **podman [GLOBAL OPTIONS]**
## GLOBAL OPTIONS ## GLOBAL OPTIONS

View File

@ -33,7 +33,7 @@ The post-stop hooks MUST be called after the container is deleted but before the
## CRI-O configuration files for automatically enabling Hooks ## CRI-O configuration files for automatically enabling Hooks
The way you enable the hooks above is by editing the OCI Specification to add your hook before running the oci runtime, like runc. But this is what `CRI-O` and `Kpod create` do for you, so we wanted a way for developers to drop configuration files onto the system, so that their hooks would be able to be plugged in. The way you enable the hooks above is by editing the OCI Specification to add your hook before running the oci runtime, like runc. But this is what `CRI-O` and `podman create` do for you, so we wanted a way for developers to drop configuration files onto the system, so that their hooks would be able to be plugged in.
One problem with hooks is that the runtime actually stalls execution of the container before running the hooks and stalls completion of the container, until all hooks complete. This can cause some performance issues. Also a lot of hooks just check if certain configuration is set and then exit early, without doing anything. For example the [oci-systemd-hook](https://github.com/projectatomic/oci-systemd-hook) only executes if the command is `init` or `systemd`, otherwise it just exits. This means if we automatically enable all hooks, every container will have to execute oci-systemd-hook, even if they don't run systemd inside of the container. Also since there are three stages, prestart, poststart, poststop each hook gets executed three times. One problem with hooks is that the runtime actually stalls execution of the container before running the hooks and stalls completion of the container, until all hooks complete. This can cause some performance issues. Also a lot of hooks just check if certain configuration is set and then exit early, without doing anything. For example the [oci-systemd-hook](https://github.com/projectatomic/oci-systemd-hook) only executes if the command is `init` or `systemd`, otherwise it just exits. This means if we automatically enable all hooks, every container will have to execute oci-systemd-hook, even if they don't run systemd inside of the container. Also since there are three stages, prestart, poststart, poststop each hook gets executed three times.

View File

@ -4,7 +4,7 @@
#### runc installed #### runc installed
The latest version of `runc` is expected to be installed on the system. It is picked up as the default runtime by kpod. The latest version of `runc` is expected to be installed on the system. It is picked up as the default runtime by podman.
#### Setup CNI networking #### Setup CNI networking
@ -83,7 +83,7 @@ apt-get install -y \
### Get Source Code ### Get Source Code
As with other Go projects, KPOD must be cloned into a directory structure like: As with other Go projects, PODMAN must be cloned into a directory structure like:
``` ```
GOPATH GOPATH
@ -117,7 +117,7 @@ make
sudo make install sudo make install
``` ```
Otherwise, if you do not want to build `kpod` with seccomp support you can add `BUILDTAGS=""` when running make. Otherwise, if you do not want to build `podman` with seccomp support you can add `BUILDTAGS=""` when running make.
```bash ```bash
make BUILDTAGS="" make BUILDTAGS=""
@ -126,7 +126,7 @@ sudo make install
#### Build Tags #### Build Tags
`kpod` supports optional build tags for compiling support of various features. `podman` supports optional build tags for compiling support of various features.
To add build tags to the make option the `BUILDTAGS` variable must be set. To add build tags to the make option the `BUILDTAGS` variable must be set.
```bash ```bash

File diff suppressed because it is too large Load Diff

View File

@ -1,18 +1,19 @@
package libkpod package libkpod
/*
import ( import (
"encoding/json" "encoding/json"
"io/ioutil" "io/ioutil"
"os" "os"
"path/filepath" "path/filepath"
"regexp" "regexp"
"strings" "strings"
"syscall" "syscall"
"github.com/pkg/errors" "github.com/pkg/errors"
"github.com/sirupsen/logrus" "github.com/sirupsen/logrus"
) )
*/
const ( const (
// DefaultHooksDirPath Default directory containing hooks config files // DefaultHooksDirPath Default directory containing hooks config files
DefaultHooksDirPath = "/usr/share/containers/oci/hooks.d" DefaultHooksDirPath = "/usr/share/containers/oci/hooks.d"

View File

@ -16,7 +16,7 @@
cgroup_manager = "cgroupfs" cgroup_manager = "cgroupfs"
hooks_dir_path = "/usr/share/containers/oci/hooks.d" hooks_dir_path = "/usr/share/containers/oci/hooks.d"
pids_limit = 2048 pids_limit = 2048
container_exits_dir = "/var/run/kpod/exits" container_exits_dir = "/var/run/podman/exits"
[crio.image] [crio.image]
default_transport = "docker://" default_transport = "docker://"
pause_image = "kubernetes/pause" pause_image = "kubernetes/pause"

Some files were not shown because too many files have changed in this diff Show More