Skip to content

Commit c6b5a48

Browse files
committed
Drop the "fedora" prefix and rename the project as just "toolbox"
The "fedora" prefix was used because this project was specifically incubated to make it easier to hack on Fedora Silverblue. That and the mix of upstream technologies (ie., Buildah and Podman) made it uniquely "Fedora". However, over time it has gotten clear that other groups, currently Fedora downstreams like RHEL, are interested in it too. It won't be surprising if in future it transcends the Fedora universe altogether. Moreover, this project was inspired by coreos/toolbox [1]. There are good reasons and enough interest to have a unified toolbox project that addresses the needs of both Fedora CoreOS and Silverblue. Therefore, it is best to drop the "fedora" prefix and call the whole thing just "toolbox". No extra effort was made to retain compatibility with the older name due to the project's young age. Its userbase is limited to the earliest of early adopters, and the benefits of a clean break outweigh the loss of compatibility. The OCI images and the toolbox container still retain the "fedora" prefix to disambiguate them from their counterparts from other operating systems. [1] https://github.com/coreos/toolbox https://github.com/debarshiray/toolbox/issues/8
1 parent 05f3530 commit c6b5a48

File tree

7 files changed

+36
-35
lines changed

7 files changed

+36
-35
lines changed

README.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# Fedora Toolbox — Unprivileged development environment
1+
# Toolbox — Unprivileged development environment
22

3-
[Fedora Toolbox](https://github.com/debarshiray/fedora-toolbox) is a tool that
4-
offers a familiar RPM based environment for developing and debugging software
5-
that runs fully unprivileged using [Podman](https://podman.io/).
3+
[Toolbox](https://github.com/debarshiray/toolbox) is a tool that offers a
4+
familiar RPM based environment for developing and debugging software that runs
5+
fully unprivileged using [Podman](https://podman.io/).
66

77
The toolbox container is a fully *mutable* container; when you see
88
`yum install ansible` for example, that's something you can do inside your
@@ -18,23 +18,24 @@ However this project doesn't *require* using an OSTree based system — it
1818
works equally well if you're running e.g. existing Fedora Workstation or
1919
Server, and that's a useful way to incrementally adopt containerization.
2020

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

2526
## Usage
2627

27-
### Create your Fedora Toolbox container:
28+
### Create your toolbox container:
2829
```
29-
[user@hostname ~]$ fedora-toolbox create
30+
[user@hostname ~]$ toolbox create
3031
[user@hostname ~]$
3132
```
3233
This will create a container, and an image, called
3334
`fedora-toolbox-<your-username>:<version-id>` that's specifically customised
3435
for your host user.
3536

36-
### Enter the Toolbox:
37+
### Enter the toolbox:
3738
```
38-
[user@hostname ~]$ fedora-toolbox enter
39+
[user@hostname ~]$ toolbox enter
3940
🔹[user@toolbox ~]$
4041
```

images/fedora/f28/Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ ENV NAME=fedora-toolbox VERSION=28
44
LABEL com.redhat.component="$NAME" \
55
name="$FGC/$NAME" \
66
version="$VERSION" \
7-
usage="This image is meant to be used with the fedora-toolbox command" \
7+
usage="This image is meant to be used with the toolbox command" \
88
summary="Base image for creating Fedora toolbox containers" \
99
maintainer="Debarshi Ray <[email protected]>"
1010

images/fedora/f29/Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ ENV NAME=fedora-toolbox VERSION=29
44
LABEL com.redhat.component="$NAME" \
55
name="$FGC/$NAME" \
66
version="$VERSION" \
7-
usage="This image is meant to be used with the fedora-toolbox command" \
7+
usage="This image is meant to be used with the toolbox command" \
88
summary="Base image for creating Fedora toolbox containers" \
99
maintainer="Debarshi Ray <[email protected]>"
1010

images/fedora/f30/Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ ENV NAME=fedora-toolbox VERSION=30
44
LABEL com.redhat.component="$NAME" \
55
name="$FGC/$NAME" \
66
version="$VERSION" \
7-
usage="This image is meant to be used with the fedora-toolbox command" \
7+
usage="This image is meant to be used with the toolbox command" \
88
summary="Base image for creating Fedora toolbox containers" \
99
maintainer="Debarshi Ray <[email protected]>"
1010

meson.build

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
project(
2-
'fedora-toolbox',
2+
'toolbox',
33
version: '0.0.5',
44
license: 'ASL 2.0',
55
meson_version: '>= 0.40.0',
66
)
77

88
install_data(
9-
'fedora-toolbox',
9+
'toolbox',
1010
install_dir: get_option('bindir'),
1111
)

fedora-toolbox renamed to toolbox

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,7 @@ create()
212212
(
213213
dbus_system_bus_address="unix:path=/var/run/dbus/system_bus_socket"
214214
tmpfs_size=$((64 * 1024 * 1024)) # 64 MiB
215-
working_container_name="fedora-toolbox-working-container-$(uuidgen --time)"
215+
working_container_name="toolbox-working-container-$(uuidgen --time)"
216216

217217
if [ "$DBUS_SYSTEM_BUS_ADDRESS" != "" ]; then
218218
dbus_system_bus_address=$DBUS_SYSTEM_BUS_ADDRESS
@@ -231,7 +231,7 @@ create()
231231
localhost/$base_toolbox_image >/dev/null 2>&42; then
232232
echo "$base_toolbox_command: looking for image $registry/$fgc/$base_toolbox_image" >&42
233233

234-
if spinner_directory=$(mktemp --directory --tmpdir fedora-toolbox-spinner-XXXXXXXXXX 2>&42); then
234+
if spinner_directory=$(mktemp --directory --tmpdir toolbox-spinner-XXXXXXXXXX 2>&42); then
235235
spinner_message="$base_toolbox_command: pulling from $registry: "
236236
if ! spinner_start "$spinner_directory" "$spinner_message"; then
237237
spinner_directory=""
@@ -258,7 +258,7 @@ create()
258258

259259
echo "$base_toolbox_command: trying to configure working container $working_container_name" >&42
260260

261-
if spinner_directory=$(mktemp --directory --tmpdir fedora-toolbox-spinner-XXXXXXXXXX 2>&42); then
261+
if spinner_directory=$(mktemp --directory --tmpdir toolbox-spinner-XXXXXXXXXX 2>&42); then
262262
spinner_message="$base_toolbox_command: configuring working container: "
263263
if ! spinner_start "$spinner_directory" "$spinner_message"; then
264264
spinner_directory=""
@@ -282,7 +282,7 @@ create()
282282

283283
echo "$base_toolbox_command: trying to create image $toolbox_image" >&42
284284

285-
if spinner_directory=$(mktemp --directory --tmpdir fedora-toolbox-spinner-XXXXXXXXXX 2>&42); then
285+
if spinner_directory=$(mktemp --directory --tmpdir toolbox-spinner-XXXXXXXXXX 2>&42); then
286286
spinner_message="$base_toolbox_command: creating image $toolbox_image: "
287287
if ! spinner_start "$spinner_directory" "$spinner_message"; then
288288
spinner_directory=""
@@ -326,7 +326,7 @@ create()
326326

327327
echo "$base_toolbox_command: trying to create container $toolbox_container" >&42
328328

329-
if spinner_directory=$(mktemp --directory --tmpdir fedora-toolbox-spinner-XXXXXXXXXX 2>&42); then
329+
if spinner_directory=$(mktemp --directory --tmpdir toolbox-spinner-XXXXXXXXXX 2>&42); then
330330
spinner_message="$base_toolbox_command: creating container $toolbox_container: "
331331
if ! spinner_start "$spinner_directory" "$spinner_message"; then
332332
spinner_directory=""
@@ -436,7 +436,7 @@ list_images()
436436
| column --separator $'\t' --table --table-columns "IMAGE ID,IMAGE NAME,CREATED")
437437

438438
if [ "$output" != "" ]; then
439-
echo -e "${LBC}Images created by fedora-toolbox${NC}"
439+
echo -e "${LBC}Images created by toolbox${NC}"
440440
echo "$output"
441441
fi
442442
)
@@ -455,7 +455,7 @@ list_containers()
455455
--table-columns "CONTAINER ID,CONTAINER NAME,CREATED,STATUS,IMAGE NAME" 2>&42)
456456

457457
if [ "$output" != "" ]; then
458-
echo -e "${LBC}Containers created by fedora-toolbox${NC}"
458+
echo -e "${LBC}Containers created by toolbox${NC}"
459459
echo "$output" | head --lines 1 2>&42
460460
(
461461
echo "$output" | tail --lines +2 2>&42
@@ -495,18 +495,18 @@ exit_if_unrecognized_option()
495495

496496
usage()
497497
{
498-
echo "Usage: fedora-toolbox [--container <name>]"
499-
echo " [--release <release>]"
500-
echo " [-v | --verbose]"
501-
echo " create [--candidate-registry]"
502-
echo " [--image <name>]"
503-
echo " or: fedora-toolbox [--container <name>]"
504-
echo " [--release <release>]"
505-
echo " [-v | --verbose]"
506-
echo " enter"
507-
echo " or: fedora-toolbox list [-c | --containers]"
508-
echo " [-i | --images]"
509-
echo " or: fedora-toolbox --help"
498+
echo "Usage: toolbox [--container <name>]"
499+
echo " [--release <release>]"
500+
echo " [-v | --verbose]"
501+
echo " create [--candidate-registry]"
502+
echo " [--image <name>]"
503+
echo " or: toolbox [--container <name>]"
504+
echo " [--release <release>]"
505+
echo " [-v | --verbose]"
506+
echo " enter"
507+
echo " or: toolbox list [-c | --containers]"
508+
echo " [-i | --images]"
509+
echo " or: toolbox --help"
510510
}
511511

512512

File renamed without changes.

0 commit comments

Comments
 (0)