diff options
author | OpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com> | 2019-02-17 22:44:04 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-02-17 22:44:04 +0100 |
commit | 3f32eae56fed23e93c45d7da53da33702e954a26 (patch) | |
tree | cf3b89fca4fbbe365f2ebca71ed26980c5307523 | |
parent | 6aaf8d39a9a26510e40fd54399e97fe177afadde (diff) | |
parent | b62c0e703d70439c677205fb423e81491e8d1cf9 (diff) | |
download | podman-3f32eae56fed23e93c45d7da53da33702e954a26.tar.gz podman-3f32eae56fed23e93c45d7da53da33702e954a26.tar.bz2 podman-3f32eae56fed23e93c45d7da53da33702e954a26.zip |
Merge pull request #2357 from TomSweeneyRedHat/dev/tsweeney/cobrahelp3
Add 3rd chunk of Cobra examples
-rw-r--r-- | cmd/podman/build.go | 4 | ||||
-rw-r--r-- | cmd/podman/play_kube.go | 3 | ||||
-rw-r--r-- | cmd/podman/pod_stop.go | 4 | ||||
-rw-r--r-- | cmd/podman/pull.go | 4 | ||||
-rw-r--r-- | cmd/podman/push.go | 4 | ||||
-rw-r--r-- | cmd/podman/rm.go | 4 | ||||
-rw-r--r-- | cmd/podman/rmi.go | 4 | ||||
-rw-r--r-- | cmd/podman/run.go | 4 | ||||
-rw-r--r-- | cmd/podman/start.go | 4 | ||||
-rw-r--r-- | cmd/podman/stop.go | 4 | ||||
-rw-r--r-- | docs/podman-start.1.md | 4 | ||||
-rw-r--r-- | docs/podman-stop.1.md | 6 |
12 files changed, 34 insertions, 15 deletions
diff --git a/cmd/podman/build.go b/cmd/podman/build.go index 30a734377..bb252f171 100644 --- a/cmd/podman/build.go +++ b/cmd/podman/build.go @@ -40,7 +40,9 @@ var ( buildCommand.NameSpaceResults = &namespaceValues return buildCmd(&buildCommand) }, - Example: "CONTEXT-DIRECTORY | URL", + Example: `podman build . + podman build --cert-dir ~/auth --creds=username:password -t imageName -f Dockerfile.simple . + podman build --layers --force-rm --tag imageName .`, } ) diff --git a/cmd/podman/play_kube.go b/cmd/podman/play_kube.go index 97ab7afd4..9fc06dde9 100644 --- a/cmd/podman/play_kube.go +++ b/cmd/podman/play_kube.go @@ -37,7 +37,8 @@ var ( playKubeCommand.GlobalFlags = MainGlobalOpts return playKubeYAMLCmd(&playKubeCommand) }, - Example: "Kubernetes YAML file", + Example: `podman play kube demo.yml + podman play kube --cert-dir /mycertsdir --tls-verify=true --quiet myWebPod`, } ) diff --git a/cmd/podman/pod_stop.go b/cmd/podman/pod_stop.go index 80082045d..a9237347e 100644 --- a/cmd/podman/pod_stop.go +++ b/cmd/podman/pod_stop.go @@ -27,7 +27,9 @@ var ( podStopCommand.GlobalFlags = MainGlobalOpts return podStopCmd(&podStopCommand) }, - Example: "POD-NAME [POD-NAME ...]", + Example: `podman pod stop mywebserverpod + podman pod stop --latest + podman pod stop --timeout 0 490eb 3557fb`, } ) diff --git a/cmd/podman/pull.go b/cmd/podman/pull.go index 6e060d6f5..859228cbd 100644 --- a/cmd/podman/pull.go +++ b/cmd/podman/pull.go @@ -36,7 +36,9 @@ specified, the image with the 'latest' tag (if it exists) is pulled pullCommand.GlobalFlags = MainGlobalOpts return pullCmd(&pullCommand) }, - Example: "", + Example: `podman pull imageName + podman pull --cert-dir image/certs --authfile temp-auths/myauths.json docker://docker.io/myrepo/finaltest + podman pull fedora:latest`, } ) diff --git a/cmd/podman/push.go b/cmd/podman/push.go index bbe8a4027..881d8cebc 100644 --- a/cmd/podman/push.go +++ b/cmd/podman/push.go @@ -34,7 +34,9 @@ var ( pushCommand.GlobalFlags = MainGlobalOpts return pushCmd(&pushCommand) }, - Example: "IMAGE DESTINATION", + Example: `podman push imageID docker://registry.example.com/repository:tag + podman push imageID oci-archive:/path/to/layout:image:tag + podman push --authfile temp-auths/myauths.json alpine docker://docker.io/myrepo/alpine`, } ) diff --git a/cmd/podman/rm.go b/cmd/podman/rm.go index d170e5357..2e5fe1dc0 100644 --- a/cmd/podman/rm.go +++ b/cmd/podman/rm.go @@ -28,7 +28,9 @@ Running containers will not be removed without the -f option. rmCommand.GlobalFlags = MainGlobalOpts return rmCmd(&rmCommand) }, - Example: "", + Example: `podman rm imageID + podman rm mywebserver myflaskserver 860a4b23 + podman rm --force --all`, } ) diff --git a/cmd/podman/rmi.go b/cmd/podman/rmi.go index c5bd1e190..fb27772f5 100644 --- a/cmd/podman/rmi.go +++ b/cmd/podman/rmi.go @@ -23,7 +23,9 @@ var ( rmiCommand.GlobalFlags = MainGlobalOpts return rmiCmd(&rmiCommand) }, - Example: "IMAGE-NAME-OR-ID [...]", + Example: `podman rmi imageID + podman rmi --force alpine + podman rmi c4dfb1609ee2 93fd78260bd1 c0ed59d05ff7`, } ) diff --git a/cmd/podman/run.go b/cmd/podman/run.go index 45fc8df76..ff4c3b418 100644 --- a/cmd/podman/run.go +++ b/cmd/podman/run.go @@ -30,7 +30,9 @@ var ( runCommand.GlobalFlags = MainGlobalOpts return runCmd(&runCommand) }, - Example: "IMAGE [COMMAND [ARG...]]", + Example: `podman run imageID ls -alF /etc + podman run --net=host imageID dnf -y install java + podman run --volume /var/hostdir:/var/ctrdir -i -t fedora /bin/bash`, } ) diff --git a/cmd/podman/start.go b/cmd/podman/start.go index bbb4e87d2..f3639cb23 100644 --- a/cmd/podman/start.go +++ b/cmd/podman/start.go @@ -28,7 +28,9 @@ var ( startCommand.GlobalFlags = MainGlobalOpts return startCmd(&startCommand) }, - Example: "CONTAINER-NAME [CONTAINER-NAME ...]", + Example: `podman start --latest + podman start 860a4b231279 5421ab43b45 + podman start --interactive --attach imageID`, } ) diff --git a/cmd/podman/stop.go b/cmd/podman/stop.go index 134d8a069..15c3984f4 100644 --- a/cmd/podman/stop.go +++ b/cmd/podman/stop.go @@ -31,7 +31,9 @@ var ( stopCommand.GlobalFlags = MainGlobalOpts return stopCmd(&stopCommand) }, - Example: "CONTAINER-NAME [CONTAINER-NAME ...]", + Example: `podman stop ctrID + podman stop --latest + podman stop --timeout 2 mywebserver 6e534f14da9d`, } ) diff --git a/docs/podman-start.1.md b/docs/podman-start.1.md index 8316fe83d..786936721 100644 --- a/docs/podman-start.1.md +++ b/docs/podman-start.1.md @@ -42,9 +42,9 @@ Proxy received signals to the process (non-TTY mode only). SIGCHLD, SIGSTOP, and podman start mywebserver -podman start 860a4b23 5421ab4 +podman start 860a4b231279 5421ab43b45 -podman start -i -a 860a4b23 +podman start --interactive --attach 860a4b231279 podman start -i -l diff --git a/docs/podman-stop.1.md b/docs/podman-stop.1.md index 813f0ef9e..e36265d5e 100644 --- a/docs/podman-stop.1.md +++ b/docs/podman-stop.1.md @@ -32,11 +32,11 @@ Timeout to wait before forcibly stopping the container podman stop mywebserver -podman stop 860a4b23 +podman stop 860a4b235279 -podman stop mywebserver 860a4b23 +podman stop mywebserver 860a4b235279 -podman stop --timeout 2 860a4b23 +podman stop --timeout 2 860a4b235279 podman stop -a |