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

GOALS.md: Cosmetics 

https://github.com/containers/toolbox/pull/684
This commit is contained in:
Debarshi Ray 2021-01-25 21:03:27 +01:00
parent 20a8a0551a
commit 538e2dd9c5
1 changed files with 42 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
GOALS.md
View File

@ -1,22 +1,23 @@
<img src="data/logo/toolbox-logo-landscape.svg" alt="Toolbox logo landscape" width="800"/> <img src="data/logo/toolbox-logo-landscape.svg" alt="Toolbox logo landscape" width="800"/>
## Goals and Use Cases ## Goals
### High Level Goals ### High Level Goals
- Provide a CLI convenience interface to run containers (via `podman`) easily - Provide a convenient command line interface to run containers using
- Support for Developer and Debugging/Management use cases [Podman](https://podman.io/)
- Support for development, debugging and system management use cases
- Support for multiple distros - Support for multiple distros
- toolbox package in multiple distros - `toolbox` package in multiple distros
- toolbox containers for multiple distros - `toolbox` containers for multiple distros
### Non-Goals - Anti Use Cases ### Non-goals
- Supporting multiple container runtimes. `toolbox` will use `podman` exclusively - Supporting multiple container runtimes. Toolbox will use Podman exclusively
- Adding significant features on top of `podman` - Adding significant features on top of Podman
- Significant feature requests should be driven into `podman` upstream - Significant feature requests should be driven into Podman upstream
- To run containers that aren't tightly integrated with the host - To run containers that aren't tightly integrated with the host
- i.e. extremely sandboxed containers become specific to the user quickly - Extremely sandboxed containers quickly become specific to the user
### Developer Use Cases ### Developer Use Cases
@ -24,19 +25,21 @@
- Most cases: user doesn't need root, rootless containers work fine - Most cases: user doesn't need root, rootless containers work fine
- Some cases: user needs root for testing - Some cases: user needs root for testing
- Desktop Development: - Desktop Development:
- developers need things like dbus, display, etc, to be forwarded into the toolbox - Developers need things like D-Bus, display, etc. to be forwarded into the
toolbox container
- Headless Development: - Headless Development:
- toolbox works properly in headless environments (no display, etc) - Toolbox works properly in headless environments (no display, etc)
- Need development tools like gdb, strace, etc to work - Need development tools like GDB, strace, etc. to work
### Debugging/System management Use Cases ### Debugging and System Management Use Cases
- Inspecting Host Processes/Kernel - Inspecting host processes and the kernel
- Typically need root access - Typically need root access
- Need bpftrace, strace on host processes to work - Need bpftrace, strace on host processes to work
- Ideally even do things like helping get kernel-debuginfo data for the host kernel - Ideally even do things like helping get kernel-debuginfo data for the
host kernel
- Managing system services - Managing system services
- systemctl restart foo.service - `systemctl restart foo.service`
- journalctl - journalctl
- Managing updates to the host - Managing updates to the host
- rpm-ostree - rpm-ostree
@ -45,16 +48,19 @@
### Specific environments ### Specific environments
- Fedora Silverblue - Fedora Silverblue
- Silverblue comes with a subset of packages and discourages host software changes - Silverblue comes with a subset of packages and discourages host software
changes
- Users need a toolbox container as a working environment - Users need a toolbox container as a working environment
- Future: use toolbox container by default when a user opens a shell - Future: use toolbox container by default when a user opens a shell
- Fedora CoreOS - Fedora CoreOS
- Similar to silverblue, but non-graphical and smaller package set - Similar to Silverblue, but non-graphical and smaller package set
- RHEL CoreOS - RHEL CoreOS
- Similar to Fedora CoreOS. Based on RHEL content and the underlying OS for OpenShift - Similar to Fedora CoreOS. Based on RHEL content and the underlying
operating system for OpenShift
- Need to [use default authfile on pull](https://github.com/coreos/toolbox/pull/58/commits/413f83f7240d3c31121b557bfd55e489fad24489) - Need to [use default authfile on pull](https://github.com/coreos/toolbox/pull/58/commits/413f83f7240d3c31121b557bfd55e489fad24489)
- Need to ensure compatibility with the rhel7/support-tools container - Need to ensure compatibility with the rhel7/support-tools container
- currently not a toolbox image, opportunity for collaboration - Currently not a toolbox image, opportunity for collaboration
- Alignment with `oc debug node/` (OpenShift) - Alignment with `oc debug node/` (OpenShift)
- `oc debug node` opens a shell on a kubernetes node - `oc debug node` opens a shell on a kubernetes node
- Value in having a consistent environment for both `toolbox` in debugging mode and `oc debug node` - Value in having a consistent environment for both Toolbox's debugging
mode and `oc debug node`