Scroll to navigation

podman-play-kube(1)() podman-play-kube(1)()

NAME

podman-play-kube - Create containers, pods or volumes based on Kubernetes YAML

SYNOPSIS

podman play kube [options] file.yml|-

DESCRIPTION

podman play kube will read in a structured file of Kubernetes YAML. It will then recreate the containers, pods or volumes described in the YAML. Containers within a pod are then started and the ID of the new Pod or the name of the new Volume is output. If the yaml file is specified as "-" then podman play kube will read the YAML file from stdin. Using the --down command line option, it is also capable of tearing down the pods created by a previous run of podman play kube. Using the --replace command line option, it will tear down the pods(if any) created by a previous run of podman play kube and recreate the pods with the Kubernetes YAML file. Ideally the input file would be one created by Podman (see podman-generate-kube(1)). This would guarantee a smooth import and expected results.

Currently, the supported Kubernetes kinds are: - Pod - Deployment - PersistentVolumeClaim - ConfigMap

Kubernetes Pods or Deployments

Only two volume types are supported by play kube, the hostPath and persistentVolumeClaim volume types. For the hostPath volume type, only the default (empty), DirectoryOrCreate, Directory, FileOrCreate, File, Socket, CharDevice and BlockDevice subtypes are supported. Podman interprets the value of hostPath path as a file path when it contains at least one forward slash, otherwise Podman treats the value as the name of a named volume. When using a persistentVolumeClaim, the value for claimName is the name for the Podman named volume.

Note: When playing a kube YAML with init containers, the init container will be created with init type value once. To change the default type, use the io.podman.annotations.init.container.type annotation to set the type to always.

Note: hostPath volume types created by play kube will be given an SELinux shared label (z), bind mounts are not relabeled (use chcon -t container_file_t -R <directory>).

Note: If the :latest tag is used, Podman will attempt to pull the image from a registry. If the image was built locally with Podman or Buildah, it will have localhost as the domain, in that case, Podman will use the image from the local store even if it has the :latest tag.

Kubernetes PersistentVolumeClaims

A Kubernetes PersistentVolumeClaim represents a Podman named volume. Only the PersistentVolumeClaim name is required by Podman to create a volume. Kubernetes annotations can be used to make use of the available options for Podman volumes.

  • volume.podman.io/driver
  • volume.podman.io/device
  • volume.podman.io/type
  • volume.podman.io/uid
  • volume.podman.io/gid
  • volume.podman.io/mount-options

Play kube is capable of building images on the fly given the correct directory layout and Containerfiles. This option is not available for remote clients, including Mac and Windows (excluding WSL2) machines, yet. Consider the following excerpt from a YAML file:

apiVersion: v1
kind: Pod
metadata:
spec:


  containers:


  - command:


    - top


    - name: container


      value: podman


    image: foobar

If there is a directory named foobar in the current working directory with a file named Containerfile or Dockerfile, Podman play kube will build that image and name it foobar. An example directory structure for this example would look like:

|- mykubefiles


    |- myplayfile.yaml


    |- foobar


         |- Containerfile

The build will consider foobar to be the context directory for the build. If there is an image in local storage called foobar, the image will not be built unless the --build flag is used. Use --build=false to completely disable builds.

Kubernetes ConfigMap

Kubernetes ConfigMap can be referred as a source of environment variables or volumes in Pods or Deployments. ConfigMaps aren't a standalone object in Podman; instead, when a container uses a ConfigMap, Podman will create environment variables or volumes as needed.

For example, the following YAML document defines a ConfigMap and then uses it in a Pod:

apiVersion: v1
kind: ConfigMap
metadata:


  name: foo
data:


    FOO: bar
---
apiVersion: v1
kind: Pod
metadata:


  name: foobar
spec:


  containers:


  - command:


    - top


    name: container-1


    image: foobar


    envFrom:


    - configMapRef:


        name: foo


        optional: false

and as a result environment variable FOO will be set to bar for container container-1.

Systemd Integration

A Kubernetes YAML can be executed in systemd via the podman-kube@.service systemd template. The template's argument is the path to the YAML file. Given a workload.yaml file in the home directory, it can be executed as follows:

$ escaped=$(systemd-escape ~/sysadmin.yaml)
$ systemctl --user start podman-kube@$escaped.service
$ systemctl --user is-active podman-kube@$escaped.service
active

Note that the path to the YAML file must be escaped via systemd-escape.

OPTIONS

--annotation=key=value

Add an annotation to the container or pod. The format is key=value. The --annotation option can be set multiple times.

--authfile=path

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.

Note: You can also override the default path of the authentication file by setting the REGISTRY_AUTH_FILE environment variable. export REGISTRY_AUTH_FILE=path

--build

Build images even if they are found in the local storage. Use --build=false to completely disable builds. (This option is not available with the remote Podman client)

--cert-dir=path

Use certificates at path (*.crt, *.cert, *.key) to connect to the registry. (Default: /etc/containers/certs.d) Please refer to containers-certs.d(5) for details. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines)

--configmap=path

Use Kubernetes configmap YAML at path to provide a source for environment variable values within the containers of the pod. (This option is not available with the remote Podman client)

Note: The --configmap option can be used multiple times or a comma-separated list of paths can be used to pass multiple Kubernetes configmap YAMLs.

--context-dir=path

Use path as the build context directory for each image. Requires --build option be true. (This option is not available with the remote Podman client)

--creds

The [username[:password]] to use to authenticate with the registry if required. If one or both values are not supplied, a command line prompt will appear and the value can be entered. The password is entered without echo.

--down

Tears down the pods that were created by a previous run of play kube. The pods are stopped and then removed. Any volumes created are left intact.

--help, -h

Print usage statement

--ip=IP address

Assign a static ip address to the pod. This option can be specified several times when play kube creates more than one pod. Note: When joining multiple networks you should use the --network name:ip=<ip> syntax.

--log-driver=driver

Set logging driver for all created containers.

--log-opt=name=value

Set custom logging configuration. The following *name*s are supported:

  • path: specify a path to the log file (e.g. --log-opt path=/var/log/container/mycontainer.json);
  • max-size: specify a max size of the log file (e.g. --log-opt max-size=10mb);
  • tag: specify a custom log tag for the container (e.g. --log-opt tag="{{.ImageName}}".

It supports the same keys as podman inspect --format.

This option is currently supported only by the journald log driver.

--mac-address=MAC address

Assign a static mac address to the pod. This option can be specified several times when play kube creates more than one pod. Note: When joining multiple networks you should use the --network name:mac=<mac> syntax.

--network=mode, --net

Change the network mode of the pod. The host network mode should be configured in the YAML file. Valid mode values are:

•
bridge[:OPTIONS,...]: Create a network stack on the default bridge. This is the default for rootful containers. It is possible to specify these additional options:
  • alias=name: Add network-scoped alias for the container.
  • ip=IPv4: Specify a static ipv4 address for this container.
  • ip=IPv6: Specify a static ipv6 address for this container.
  • mac=MAC: Specify a static mac address for this container.
  • interface_name: Specify a name for the created network interface inside the container.

For example to set a static ipv4 address and a static mac address, use --network bridge:ip=10.88.0.10,mac=44:33:22:11:00:99. - <network name or ID>[:OPTIONS,...]: Connect to a user-defined network; this is the network name or ID from a network created by podman network create. Using the network name implies the bridge network mode. It is possible to specify the same options described under the bridge mode above. You can use the --network option multiple times to specify additional networks. - none: Create a network namespace for the container but do not configure network interfaces for it, thus the container has no network connectivity. - container:id: Reuse another container's network stack. - ns:path: Path to a network namespace to join. - private: Create a new namespace for the container. This will use the bridge mode for rootful containers and slirp4netns for rootless ones. - slirp4netns[:OPTIONS,...]: use slirp4netns(1) to create a user network stack. This is the default for rootless containers. It is possible to specify these additional options, they can also be set with network_cmd_options in containers.conf:
- allow_host_loopback=true|false: Allow the slirp4netns to reach the host loopback IP (10.0.2.2). Default is false.
- mtu=MTU: Specify the MTU to use for this network. (Default is 65520).
- cidr=CIDR: Specify ip range to use for this network. (Default is 10.0.2.0/24).
- enable_ipv6=true|false: Enable IPv6. Default is true. (Required for outbound_addr6).
- outbound_addr=INTERFACE: Specify the outbound interface slirp should bind to (ipv4 traffic only).
- outbound_addr=IPv4: Specify the outbound ipv4 address slirp should bind to.
- outbound_addr6=INTERFACE: Specify the outbound interface slirp should bind to (ipv6 traffic only).
- outbound_addr6=IPv6: Specify the outbound ipv6 address slirp should bind to.
- port_handler=rootlesskit: Use rootlesskit for port forwarding. Default.
Note: Rootlesskit changes the source IP address of incoming packets to an IP address in the container network namespace, usually 10.0.2.100. If your application requires the real source IP address, e.g. web server logs, use the slirp4netns port handler. The rootlesskit port handler is also used for rootless containers when connected to user-defined networks.
- port_handler=slirp4netns: Use the slirp4netns port forwarding, it is slower than rootlesskit but preserves the correct source IP address. This port handler cannot be used for user-defined networks.

--no-hosts

Do not create /etc/hosts for the pod. By default, Podman will manage /etc/hosts, adding the container's own IP address and any hosts from --add-host. --no-hosts disables this, and the image's /etc/host will be preserved unmodified. This option conflicts with host added in the Kubernetes YAML.

--quiet, -q

Suppress output information when pulling images

--replace

Tears down the pods created by a previous run of play kube and recreates the pods. This option is used to keep the existing pods up to date based upon the Kubernetes YAML.

--seccomp-profile-root=path

Directory path for seccomp profiles (default: "/var/lib/kubelet/seccomp"). (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines)

--start

Start the pod after creating it, set to false to only create it.

--tls-verify

Require HTTPS and verify certificates when contacting registries (default: true). If explicitly set to true, then TLS verification will be used. If set to false, then TLS verification will not be used. If not specified, TLS verification will be used unless the target registry is listed as an insecure registry in registries.conf.

--userns=mode

Set the user namespace mode for the container. It defaults to the PODMAN_USERNS environment variable. An empty value ("") means user namespaces are disabled unless an explicit mapping is set with the --uidmap and --gidmap options.

Rootless user --userns=Key mappings:

Key Host User Container User
"" $UID 0 (Default User account mapped to root user in container.)
keep-id $UID $UID (Map user account to same UID within container.)
auto $UID nil (Host User UID is not mapped into container.)
nomap $UID nil (Host User UID is not mapped into container.)

Valid mode values are:

auto[:OPTIONS,...]: automatically create a unique user namespace.

The --userns=auto flag, requires that the user name containers and a range of subordinate user ids that the Podman container is allowed to use be specified in the /etc/subuid and /etc/subgid files.

Example: containers:2147483647:2147483648.

Podman allocates unique ranges of UIDs and GIDs from the containers subordinate user ids. The size of the ranges is based on the number of UIDs required in the image. The number of UIDs and GIDs can be overridden with the size option. The auto options currently does not work in rootless mode

Valid auto options:

  • gidmapping=_CONTAINER_GID:HOSTGID:SIZE: to force a GID mapping to be present in the user namespace.
  • size=SIZE: to specify an explicit size for the automatic user namespace. e.g. --userns=auto:size=8192. If size is not specified, auto will estimate a size for the user namespace.
  • uidmapping=_CONTAINER_UID:HOSTUID:SIZE: to force a UID mapping to be present in the user namespace.

container:id: join the user namespace of the specified container.

host: create a new namespace for the container.

keep-id: creates a user namespace where the current rootless user's UID:GID are mapped to the same values in the container. This option is not allowed for containers created by the root user.

nomap: creates a user namespace where the current rootless user's UID:GID are not mapped into the container. This option is not allowed for containers created by the root user.

ns:namespace: run the pod in the given existing user namespace.

EXAMPLES

Recreate the pod and containers as described in a file called demo.yml

$ 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

Teardown the pod and containers as described in a file demo.yml

$  podman play kube --down demo.yml
Pods stopped:
52182811df2b1e73f36476003a66ec872101ea59034ac0d4d3a7b40903b955a6
Pods removed:
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
52182811df2b1e73f36476003a66ec872101ea59034ac0d4d3a7b40903b955a6
$ podman play kube demo.yml --configmap configmap-foo.yml --configmap configmap-bar.yml
52182811df2b1e73f36476003a66ec872101ea59034ac0d4d3a7b40903b955a6

Create a pod connected to two networks (called net1 and net2) with a static ip

$ podman play kube demo.yml --network net1:ip=10.89.1.5 --network net2:ip=10.89.10.10
52182811df2b1e73f36476003a66ec872101ea59034ac0d4d3a7b40903b955a6

Please take into account that networks must be created first using podman-network-create(1).

SEE ALSO

podman(1), podman-play(1), podman-network-create(1), podman-generate-kube(1), containers-certs.d(5)

HISTORY

December 2018, Originally compiled by Brent Baude (bbaude at redhat dot com)