diff options
| author | TomSweeneyRedHat <tsweeney@redhat.com> | 2020-06-10 18:28:05 -0400 |
|---|---|---|
| committer | TomSweeneyRedHat <tsweeney@redhat.com> | 2020-06-11 09:15:51 -0400 |
| commit | dee1bf0d2f99389e0906568f5379ff89ef4ea1fe (patch) | |
| tree | 730e934113c86fa4cfd0e30ac66c22dfc484e232 /pkg/api/server/docs.go | |
| parent | 5f3e64f64317d05ba457b2912c85c177635eb558 (diff) | |
| download | podman-dee1bf0d2f99389e0906568f5379ff89ef4ea1fe.tar.gz podman-dee1bf0d2f99389e0906568f5379ff89ef4ea1fe.tar.bz2 podman-dee1bf0d2f99389e0906568f5379ff89ef4ea1fe.zip | |
[CI:DOCS] Add quick start directions to APIv2 Dock
Adds some quick start up directions to the top of the
API v2 documentation and a few examples.
This strongly leverages comments from @jgallucci32 in #6535.
Fixes: #6535
Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>
Diffstat (limited to 'pkg/api/server/docs.go')
| -rw-r--r-- | pkg/api/server/docs.go | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/pkg/api/server/docs.go b/pkg/api/server/docs.go index c989c7927..d9e0a7eba 100644 --- a/pkg/api/server/docs.go +++ b/pkg/api/server/docs.go @@ -4,6 +4,24 @@ // only as experimental as this point. The endpoints, parameters, inputs, and // return values can all change. // +// To start the service and keep it running for 5,000 seconds (-t 0 runs forever): +// podman system service -t 5000 & +// +// You can then use cURL on the socket using requests documented below. +// +// NOTE: if you install the package podman-docker, it will create a symbolic +// link for /var/run/docker.sock to /run/podman/podman.sock +// +// See podman-service(1) for more information. +// +// Quick Examples: +// 'podman info' +// curl --unix-socket /run/podman/podman.sock http://d/v1.0.0/libpod/info +// 'podman pull quay.io/containers/podman' +// curl -XPOST --unix-socket /run/podman/podman.sock -v 'http://d/v1.0.0/images/create?fromImage=quay.io%2Fcontainers%2Fpodman' +// 'podman list images' +// curl --unix-socket /run/podman/podman.sock -v 'http://d/v1.0.0/libpod/images/json' | jq +// // Terms Of Service: // // Schemes: http, https |