containers
/
podman
mirror of https://github.com/containers/podman.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[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>
This commit is contained in:
TomSweeneyRedHat 2020-06-10 18:28:05 -04:00
parent 5f3e64f643
commit dee1bf0d2f
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
pkg/api/server/docs.go
View File

@ -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