toolbox/doc/toolbox.1.md at c7d2eb7a9994dce9c2803f5b483dc78189a60f9d

Debarshi Ray 2a099e8049 Add a reset command

The 'reset' command is meant to factory reset the local Podman and
Toolbox installations. Every now and then early adopters and testers of
Toolbox have to do this when their local Podman state has gotten
irrecoverably broken due to some Podman bug.

It's useful to have a command that encapsulates all the steps to do a
factory reset, as opposed to having to spell them out separately. It's
easier to document, helps with user support, and can enable less opaque
error messages that suggest a way forward when nothing is working.

Since this command is meant to be used when the Podman installation is
completely broken, it must avoid using any Podman commands at all
costs. This is why it cannot use 'podman stop' to stop any running
containers, nor can it use 'podman unshare' to delete
~/.local/share/containers when running rootless. Instead, it relies on
the user rebooting the machine for the former, and uses newgidmap(1),
newuidmap(1) and unshare(1) to reimplement 'podman unshare' for the
latter.

Note that when running as root, some care has been taken to avoid
removing directories that might be owned by the operating system. eg.,
on Fedora /var/lib/containers/sigstore is owned by the
containers-common RPM.

https://github.com/containers/toolbox/pull/295

2019-10-21 16:27:41 +02:00

2.1 KiB

Raw Blame History

% toolbox(1)

NAME

toolbox - Unprivileged development environment

SYNOPSIS

toolbox [--verbose | -v] COMMAND [ARGS]

DESCRIPTION

Toolbox is a tool that offers a familiar RPM based environment for developing and debugging software that runs fully unprivileged using Podman.

The toolbox container is a fully mutable container; when you see yum install ansible for example, that's something you can do inside your toolbox container, without affecting the base operating system.

This is particularly useful on OSTree based Fedora systems like Silverblue. The intention of these systems is to discourage installation of software on the host, and instead install software as (or in) containers.

However this tool doesn't require using an OSTree based system — it works equally well if you're running e.g. existing Fedora Workstation or Server, and that's a useful way to incrementally adopt containerization.

The toolbox environment is based on an OCI image. On Fedora this is the fedora-toolbox image. This image is then customized for the current user to create a toolbox container that seamlessly integrates with the rest of the operating system.

OPTIONS

The following options are understood:

--assumeyes, -y

Automatically answer yes for all questions.

--help, -h

Print a synopsis of this manual and exit.

--verbose, -v

Print debug information including standard error stream of internal commands.

COMMANDS

Commands for working with toolbox containers and images:

toolbox-create(1)

Create a new toolbox container.

toolbox-enter(1)

Enter a toolbox container for interactive use.

toolbox-help(1)

Display help information about Toolbox.

toolbox-init-container(1)

Initialize a running container.

toolbox-list(1)

List existing toolbox containers and images.

toolbox-reset(1)

Remove all local podman (and toolbox) state.

toolbox-rm(1)

Remove one or more toolbox containers.

toolbox-rmi(1)

Remove one or more toolbox images.

toolbox-run(1)

Run a command in an existing toolbox container.

2.1 KiB Raw Blame History