Skip to content

Commit 65651ff

Browse files
authored
Merge pull request #85648 from dfitzmau/OSDOCS-12806
OSDOCS-12806: Corrected the toolbox image for 4.16+
2 parents fe6f6f0 + b414356 commit 65651ff

File tree

2 files changed

+17
-15
lines changed

2 files changed

+17
-15
lines changed

modules/support-installing-packages-to-a-toolbox-container.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,17 @@
77
= Installing packages to a `toolbox` container
88

99
ifndef::openshift-origin[]
10-
By default, running the `toolbox` command starts a container with the `registry.redhat.io/rhel8/support-tools:latest` image. This image contains the most frequently used support tools. If you need to collect node-specific data that requires a support tool that is not part of the image, you can install additional packages.
10+
By default, running the `toolbox` command starts a container with the `registry.redhat.io/rhel9/support-tools:latest` image. This image contains the most frequently used support tools. If you need to collect node-specific data that requires a support tool that is not part of the image, you can install additional packages.
1111
endif::openshift-origin[]
1212

1313
ifdef::openshift-origin[]
14-
By default, running the `toolbox` command starts a container with the `quay.io/fedora/fedora:36` image. This image contains the most frequently used support tools. If you need to collect node-specific data that requires a support tool that is not part of the image, you can install additional packages.
14+
By default, running the `toolbox` command starts a container with the `quay.io/fedora/fedora` image. This image contains the most frequently used support tools. If you need to collect node-specific data that requires a support tool that is not part of the image, you can install additional packages.
1515
endif::openshift-origin[]
1616

1717
.Prerequisites
1818

1919
* You have accessed a node with the `oc debug node/<node_name>` command.
20+
* You can access your system as a user with root privileges.
2021
2122
.Procedure
2223

modules/support-starting-an-alternative-image-with-toolbox.adoc

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,22 @@
77
= Starting an alternative image with `toolbox`
88

99
ifndef::openshift-origin[]
10-
By default, running the `toolbox` command starts a container with the `registry.redhat.io/rhel8/support-tools:latest` image. You can start an alternative image by creating a `.toolboxrc` file and specifying the image to run.
10+
By default, running the `toolbox` command starts a container with the `registry.redhat.io/rhel9/support-tools:latest` image.
11+
12+
[NOTE]
13+
====
14+
You can start an alternative image by creating a `.toolboxrc` file and specifying the image to run. However, running an older version of the `support-tools` image, such as `registry.redhat.io/rhel8/support-tools:latest`, is not supported on {product-title} {product-version}.
15+
====
1116
endif::openshift-origin[]
1217

1318
ifdef::openshift-origin[]
14-
By default, running the `toolbox` command starts a container with the `quay.io/fedora/fedora:36` image. You can start an alternative image by creating a `.toolboxrc` file and specifying the image to run.
19+
By default, running the `toolbox` command starts a container with the `quay.io/fedora/fedora` image. You can start an alternative image by creating a `.toolboxrc` file and specifying the image to run.
1520
endif::openshift-origin[]
1621

1722
.Prerequisites
1823

1924
* You have accessed a node with the `oc debug node/<node_name>` command.
25+
* You can access your system as a user with root privileges.
2026
2127
.Procedure
2228

@@ -27,24 +33,19 @@ endif::openshift-origin[]
2733
# chroot /host
2834
----
2935

30-
. Create a `.toolboxrc` file in the home directory for the root user ID:
31-
+
32-
[source,terminal]
33-
----
34-
# vi ~/.toolboxrc
35-
----
36+
. Optional: If you need to use an alternative image instead of the default image, create a `.toolboxrc` file in the home directory for the root user ID, and specify the image metadata:
3637
+
3738
[source,text]
3839
----
39-
REGISTRY=quay.io <1>
40-
IMAGE=fedora/fedora:33-x86_64 <2>
41-
TOOLBOX_NAME=toolbox-fedora-33 <3>
40+
REGISTRY=quay.io <1>
41+
IMAGE=fedora/fedora:latest <2>
42+
TOOLBOX_NAME=toolbox-fedora-latest <3>
4243
----
4344
<1> Optional: Specify an alternative container registry.
4445
<2> Specify an alternative image to start.
4546
<3> Optional: Specify an alternative name for the toolbox container.
4647

47-
. Start a toolbox container with the alternative image:
48+
. Start a toolbox container by entering the following command:
4849
+
4950
[source,terminal]
5051
----
@@ -53,5 +54,5 @@ TOOLBOX_NAME=toolbox-fedora-33 <3>
5354
+
5455
[NOTE]
5556
====
56-
If an existing `toolbox` pod is already running, the `toolbox` command outputs `'toolbox-' already exists. Trying to start...`. Remove the running toolbox container with `podman rm toolbox-` and spawn a new toolbox container, to avoid issues with `sosreport` plugins.
57+
If an existing `toolbox` pod is already running, the `toolbox` command outputs `'toolbox-' already exists. Trying to start...`. To avoid issues with `sosreport` plugins, remove the running toolbox container with `podman rm toolbox-` and then spawn a new toolbox container.
5758
====

0 commit comments

Comments
 (0)