diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/source/markdown/podman-play-kube.1.md | 12 | ||||
| -rw-r--r-- | docs/tutorials/podman-go-bindings.md | 27 | ||||
| -rw-r--r-- | docs/tutorials/rootless_tutorial.md | 6 |
3 files changed, 23 insertions, 22 deletions
diff --git a/docs/source/markdown/podman-play-kube.1.md b/docs/source/markdown/podman-play-kube.1.md index 2de261f66..3795e954c 100644 --- a/docs/source/markdown/podman-play-kube.1.md +++ b/docs/source/markdown/podman-play-kube.1.md @@ -4,12 +4,10 @@ podman-play-kube - Create pods and containers based on Kubernetes YAML ## SYNOPSIS -**podman play kube** [*options*] *file*__.yml__ +**podman play kube** [*options*] *file.yml|-* ## DESCRIPTION -**podman play kube** will read in a structured file of Kubernetes YAML. It will then recreate -the pod and containers described in the YAML. The containers within the pod are then started and -the ID of the new Pod is output. +**podman play kube** will read in a structured file of Kubernetes YAML. It will then recreate the pod and containers described in the YAML. The containers within the pod are then started and the ID of the new Pod is output. If the yaml file is specified as "-" then `podman play kube` with read the yaml file from stdin. Ideally the input file would be one created by Podman (see podman-generate-kube(1)). This would guarantee a smooth import and expected results. @@ -82,6 +80,12 @@ $ podman play kube demo.yml 52182811df2b1e73f36476003a66ec872101ea59034ac0d4d3a7b40903b955a6 ``` +Recreate the pod and containers as described in a file `demo.yml` sent to stdin +``` +$ cat demo.yml | podman play kube - +52182811df2b1e73f36476003a66ec872101ea59034ac0d4d3a7b40903b955a6 +``` + Provide `configmap-foo.yml` and `configmap-bar.yml` as sources for environment variables within the containers. ``` $ podman play kube demo.yml --configmap configmap-foo.yml,configmap-bar.yml diff --git a/docs/tutorials/podman-go-bindings.md b/docs/tutorials/podman-go-bindings.md index ddebf7e99..24381c75c 100644 --- a/docs/tutorials/podman-go-bindings.md +++ b/docs/tutorials/podman-go-bindings.md @@ -35,11 +35,8 @@ $ cd $HOME $ mkdir example && cd example $ go mod init example.com go: creating new go.mod: module example.com -$ go get github.com/containers/podman/v2@v2.0.4 -go: downloading github.com/containers/podman/v2 v2.0.4 -go get: github.com/containers/podman/v2@v2.0.4: parsing go.mod: - module declares its path as: github.com/containers/libpod/v2 - but was required as: github.com/containers/podman/v2 +$ go get github.com/containers/podman/v3 +[...] ``` This creates a new `go.mod` file in the current directory that looks as follows: @@ -47,9 +44,9 @@ This creates a new `go.mod` file in the current directory that looks as follows: ```bash module example.com -go 1.14 +go 1.16 -require github.com/containers/libpod/v2 v2.0.4 // indirect +require github.com/containers/libpod/v3 v3.0.1 // indirect ``` You can also try a demo application with the Go modules created already: @@ -136,12 +133,12 @@ import ( "fmt" "os" - "github.com/containers/libpod/v2/libpod/define" - "github.com/containers/libpod/v2/pkg/bindings" - "github.com/containers/libpod/v2/pkg/bindings/containers" - "github.com/containers/libpod/v2/pkg/bindings/images" - "github.com/containers/libpod/v2/pkg/domain/entities" - "github.com/containers/libpod/v2/pkg/specgen" + "github.com/containers/libpod/v3/libpod/define" + "github.com/containers/libpod/v3/pkg/bindings" + "github.com/containers/libpod/v3/pkg/bindings/containers" + "github.com/containers/libpod/v3/pkg/bindings/images" + "github.com/containers/libpod/v3/pkg/domain/entities" + "github.com/containers/libpod/v3/pkg/specgen" ) func main() { @@ -530,7 +527,7 @@ $ ## Wrap Up -Podman v2 provides a set of Go bindings to allow developers to integrate Podman +Podman provides a set of Go bindings to allow developers to integrate Podman functionality conveniently in their Go application. These Go bindings require the Podman system service to be running in the background and this can easily be achieved using systemd socket activation. Once set up, you are able to use a @@ -539,7 +536,7 @@ containers and pods in a way which fits very nicely in many production environme ## References -- Podman v2 is available for most major distributions along with MacOS and Windows. +- Podman is available for most major distributions along with MacOS and Windows. Installation details are available on the [Podman official website](https://podman.io/getting-started/). - Documentation can be found at the [Podman Docs page](https://docs.podman.io). diff --git a/docs/tutorials/rootless_tutorial.md b/docs/tutorials/rootless_tutorial.md index ea5990833..18f60ea00 100644 --- a/docs/tutorials/rootless_tutorial.md +++ b/docs/tutorials/rootless_tutorial.md @@ -45,11 +45,11 @@ If Podman is used before fuse-overlayfs is installed, it may be necessary to adj (...) - [storage.options] +[storage.options] - (...) + (...) - mount_program = "/usr/bin/fuse-overlayfs" + mount_program = "/usr/bin/fuse-overlayfs" ``` ### Enable user namespaces (on RHEL7 machines) |