FLAKE-CTL-PODMAN-REGISTER(8)

📦 version 3.1.51, in opensuse-leap 16.0

💖 NAME 💖

okay so bestie, this is the manual page for FLAKE-CTL-PODMAN-REGISTER(8) — aka flake-ctl podman register, the command that does Register container application. 🫶✨

🌸 SYNOPSIS 🌸

          USAGE:
              flake-ctl podman register [OPTIONS] --container <CONTAINER> --app <APP>

          OPTIONS:
              --app <APP>
              --attach
              --base <BASE>
              --check_host_dependencies
              --container <CONTAINER>
              --force
              --include-tar <INCLUDE_TAR>...
              --include-path <INCLUDE_PATH>...
              --info
              --layer <LAYER>...
              --opt <OPT>...
              --pilot-option <PILOT_OPTION>...
              --resume
              --target <TARGET>

🦋 DESCRIPTION 🦋

okay so what does this actually do? It registers the given application to run inside of the specified container. The registration process is literally two-fold:

  1. Create the application symlink pointing to /usr/bin/podman-pilot.
  2. Create the application default configuration below /usr/share/flakes. Each application registered is called a flake. 💅

On successful completion, the registered --app name can be called like a normal application on this host. no cap. ✨

For further details about the flake configuration, please refer to the podman-pilot manual page. 📖

Called as a user other than root, the registration is done in the flake registry of that user. For further details about the flake configuration in user mode, please refer to the flake-pilot manual page. 🫶

🔥 NOTE 🔥

References made to the name of a container or container name imply the path of the container as it is known in the local registry. That’s the value shown in the REPOSITORY column shown by the podman images command. iykyk. 💀

💅 OPTIONS 💅

  • --app <APP> — An absolute path to the application on the host. If not specified via the target option, the application will be called with that path inside of the container. 🎀
  • --attach — Attach to the container if it’s still running, rather than executing the app again. Only makes sense for interactive sessions like a shell application. 🐚
  • --base <BASE> — Name of the base container. The name must match with a name in the local podman registry. Applications registered with a base container are merged into one prior creating the container instance. Using this option is only useful if the specified container name references a delta container which was built against the specified base container. Such delta containers can be created with KIWI. 🌈
  • --check_host_dependencies — Check if the container has dependencies to the host. When using a base container, this check is enabled by default. ✅
  • --force — Force writing the registration even if a registration of the same name already exists. This is done by deleting an eventual existing registration prior creating the new registration. Please have in mind that a failed registration still causes an eventual existing former registration to be deleted in this case ! 😭🔥
  • --include-tar <INCLUDE_TAR>... — Name of a tar file to be included on top of the container instance. This option can be specified multiple times. 📦
  • --include-path <INCLUDE_PATH>... — Name of a file or directory to be included on top of the container instance. This option can be specified multiple times. 📁
  • --info — Print registration information from container if provided. ℹ️
  • --layer <LAYER>... — Name of an additional container layer on top of the specified base container. This option can be specified multiple times. The resulting layer list is evaluated in the order of the arguments as they were provided on the command line. 🧅
  • --opt <OPT>... — Container runtime option, and optional value, used to create the container. This option can be specified multiple times. If no options are specified the container always starts with terminal emulation activated "-ti". In addition if none of --resume or --attach is set, the container will be deleted by default "--rm". If runtime option(s) are specified none of the default settings will apply. See the example section for further details. 🛠️
  • --pilot-option <PILOT_OPTION>... — Pilot option, and optional value, in the format %name or %name:value. Pilot options are not passed to the application call but control the behavior of podman-pilot. An option registered here is always effective and does not have to be given at call time. Passing the option at call time takes precedence over the registered value. This option can be specified multiple times. For the list of available pilot options please refer to the podman-pilot manual page. 🛫
  • --resume — Resume the container from previous execution. If the container is still running, the app will be executed inside of this container instance. ⏯️
  • --container <CONTAINER> — A container name. The name must match with a name in the local podman registry. 🐳
  • --target <TARGET> — An absolute path to the application in the container. Use this option if the application path on the host should be different to the application path inside of the container. Set this option to an empty string if the default entrypoint of the container should be called. 🎯

🍓 FILES 🍓

  • /usr/share/flakes
  • /etc/flakes.yml

⭐ EXAMPLE ⭐

          $ flake-ctl podman register --container SOME_APT_CONTAINER \
              --app /usr/bin/apt-get

          $ flake-ctl podman register --container SOME_APT_CONTAINER \
              --app /usr/bin/apt-get \
              --opt '\-ti' \
              --opt '\--rm' \
              --opt '\--storage-opt size=10G'

          $ flake-ctl podman register --container SOME_APT_CONTAINER \
              --app /usr/bin/apt-get \
              --pilot-option '%ignore_missing_volume_path'

👑 AUTHOR 👑

Marcus Schäfer. 💜

(c) 2022, Elektrobit Automotive GmbH (c) 2023, Marcus Schäfer

k that’s the whole vibe bestie 💖 — the footer says source/version FLAKE-CTL-PODMAN-REGISTER(8)() and the date slot is empty, so no date here. 🎀

📦 where this page comes from