|
1 | 1 | # toolbox - bring your tools with you |
2 | 2 |
|
3 | | -rhcos-toolbox is a small script, designed for RHEL CoreOS, that launches a podman container to let you bring in your favorite debugging or admin tools. |
| 3 | +rhcos-toolbox is a small script, designed for RHEL CoreOS, that launches a |
| 4 | +podman container to let you bring in your favorite debugging or admin tools. |
4 | 5 |
|
5 | | -## Usage |
| 6 | +This project is deprecated and in maintenance mode. |
6 | 7 |
|
7 | | -``` |
8 | | -$ /usr/bin/toolbox |
9 | | -Spawning container core-fedora-latest on /var/lib/toolbox/core-fedora-latest. |
10 | | -Press ^] three times within 1s to kill container. |
11 | | -[root@localhost ~]# dnf -y install tcpdump |
12 | | -... |
13 | | -[root@localhost ~]# tcpdump -i ens3 |
14 | | -tcpdump: verbose output suppressed, use -v or -vv for full protocol decode |
15 | | -listening on ens3, link-type EN10MB (Ethernet), capture size 65535 bytes |
16 | | -``` |
17 | | - |
18 | | -## Advanced Usage |
19 | | - |
20 | | -### Use a custom image |
21 | | - |
22 | | -toolbox uses a Fedora-based userspace environment by default, but this can be changed to any Docker image. Simply override environment variables in `$HOME/.toolboxrc`: |
23 | | - |
24 | | -``` |
25 | | -core@core-01 ~ $ cat ~/.toolboxrc |
26 | | -REGISTRY=registry.redhat.io |
27 | | -IMAGE=rhel7/rhel-tools:latest |
28 | | -core@core-01 ~ $ toolbox |
29 | | -Spawning a container 'toolbox-test' with image 'registry.redhat.io/rhel7/rhel-tools:latest' |
30 | | -``` |
31 | | - |
32 | | -### Automatically enter toolbox on login |
33 | | - |
34 | | -Set an `/etc/passwd` entry for one of the users to `/usr/bin/toolbox`: |
35 | | - |
36 | | -```sh |
37 | | -useradd bob -m -p '*' -s /usr/bin/toolbox -U -G sudo,docker,rkt |
38 | | -``` |
39 | | - |
40 | | -Now when SSHing into the system as that user, toolbox will automatically be started: |
41 | | - |
42 | | -``` |
43 | | -$ ssh bob@hostname.example.com |
44 | | -Container Linux by CoreOS alpha (1284.0.0) |
45 | | -... |
46 | | -Spawning container bob-fedora-latest on /var/lib/toolbox/bob-fedora-latest. |
47 | | -Press ^] three times within 1s to kill container. |
48 | | -[root@localhost ~]# dnf -y install emacs-nox |
49 | | -... |
50 | | -[root@localhost ~]# emacs /media/root/etc/systemd/system/docker.service |
51 | | -``` |
| 8 | +We recommend that you use https://github.com/containers/toolbox instead. |
0 commit comments