Skip to content

Commit e20fcfe

Browse files
jan-cernyjan-cerny
committed
Rename oscap-bootc to oscap-im
This commit renames the `oscap-bootc` tool to `oscap-im`. IM stands for Image Mode. The `bootc` is just one of the tools that participate on the Image Mode Operating System experience, therefore, it's more appropriate to use Image Mode than bootc in the tooling naming. It should be safe to rename it now because the `oscap-bootc` hasn't been released in upstream nor in downstream.
1 parent b88b330 commit e20fcfe

File tree

5 files changed

+20
-20
lines changed

5 files changed

+20
-20
lines changed

‎CMakeLists.txt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -337,7 +337,7 @@ cmake_dependent_option(ENABLE_OSCAP_UTIL_AS_RPM "enable the scap-as-rpm utility,
337337
cmake_dependent_option(ENABLE_OSCAP_UTIL_SSH "enables the oscap-ssh utility, this lets you scan remote machines over ssh" ON "NOT WIN32" OFF)
338338
cmake_dependent_option(ENABLE_OSCAP_UTIL_VM "enables the oscap-vm utility, this lets you scan VMs and VM storage images" ON "NOT WIN32" OFF)
339339
cmake_dependent_option(ENABLE_OSCAP_UTIL_PODMAN "enables the oscap-podman utility, this lets you scan Podman containers and container images" ON "NOT WIN32" OFF)
340-
cmake_dependent_option(ENABLE_OSCAP_UTIL_BOOTC "enables the oscap-bootc utility, this lets you build hardened bootable container images" ON "NOT WIN32" OFF)
340+
cmake_dependent_option(ENABLE_OSCAP_UTIL_IM "enables the oscap-im utility, this lets you build hardened bootable container images" ON "NOT WIN32" OFF)
341341
cmake_dependent_option(ENABLE_OSCAP_UTIL_CHROOT "enables the oscap-chroot utility, this lets you scan entire chroots using offline scanning" ON "NOT WIN32" OFF)
342342
option(ENABLE_OSCAP_UTIL_AUTOTAILOR "enables the autotailor utility that is able to perform command-line tailoring" TRUE)
343343
option(ENABLE_OSCAP_REMEDIATE_SERVICE "enables the oscap-remediate service" FALSE)
@@ -477,7 +477,7 @@ message(STATUS "scap-as-rpm: ${ENABLE_OSCAP_UTIL_AS_RPM}")
477477
message(STATUS "oscap-ssh: ${ENABLE_OSCAP_UTIL_SSH}")
478478
message(STATUS "oscap-vm: ${ENABLE_OSCAP_UTIL_VM}")
479479
message(STATUS "oscap-podman: ${ENABLE_OSCAP_UTIL_PODMAN}")
480-
message(STATUS "oscap-bootc: ${ENABLE_OSCAP_UTIL_BOOTC}")
480+
message(STATUS "oscap-im: ${ENABLE_OSCAP_UTIL_IM}")
481481
message(STATUS "oscap-chroot: ${ENABLE_OSCAP_UTIL_CHROOT}")
482482
message(STATUS "autotailor: ${ENABLE_OSCAP_UTIL_AUTOTAILOR}")
483483
message(STATUS " ")

‎docs/manual/manual.adoc‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2134,15 +2134,15 @@ registry.access.redhat.com/ubi8 latest 3269c37eae33 2 months ago 208 MB
21342134

21352135
Note that the `oscap-podman` command requires root privileges.
21362136

2137-
=== Building hardened bootable container images using oscap-bootc
2137+
=== Building hardened bootable container images using oscap-im
21382138

2139-
The `oscap-bootc` tool is a convenience script that makes building hardened bootable container images easier.
2139+
The `oscap-im` tool is a convenience script that makes building hardened bootable container images easier.
21402140
This tool is designed to be used during the build of the bootable container image.
21412141

2142-
Include `oscap-bootc` in your `Containerfile` that will be used to build your bootable container image.
2143-
The `Containerfile` first needs to install the `openscap-utils` package which ships the `oscap-bootc` tool.
2142+
Include `oscap-im` in your `Containerfile` that will be used to build your bootable container image.
2143+
The `Containerfile` first needs to install the `openscap-utils` package which ships the `oscap-im` tool.
21442144

2145-
Also, SCAP content needs to be installed to the image before `oscap-bootc` will be run.
2145+
Also, SCAP content needs to be installed to the image before `oscap-im` will be run.
21462146
Although any SCAP content can be consumed by the tool, the SCAP source data streams shipped in `scap-security-guide` are specially cared to be compatible with bootable containers.
21472147

21482148
Example `Containerfile`:
@@ -2152,7 +2152,7 @@ FROM quay.io/centos-bootc/centos-bootc:stream9
21522152
21532153
RUN dnf install -y openscap-utils scap-security-guide
21542154
2155-
RUN oscap-bootc --profile stig /usr/share/xml/scap/ssg/content/ssg-cs9-ds.xml
2155+
RUN oscap-im --profile stig /usr/share/xml/scap/ssg/content/ssg-cs9-ds.xml
21562156
----
21572157

21582158
Once you have your `Containerfile`, execute the image build:
@@ -2161,15 +2161,15 @@ Once you have your `Containerfile`, execute the image build:
21612161
podman build -t hardened_image .
21622162
----
21632163

2164-
The `oscap-bootc` tool installs and removes all packages required by the selected profile to or from the image.
2164+
The `oscap-im` tool installs and removes all packages required by the selected profile to or from the image.
21652165
Then, it runs a scan and remediation with the selected profile.
21662166
It doesn't use offline scanning.
21672167
The configuration files and other content in the image are modified by this process, depending on the used SCAP content.
21682168

21692169
The built bootable container image can be then deployed and booted.
21702170
After booting the image, the state of the resulting system will be in line with the selected security profile.
21712171

2172-
The `oscap-bootc` tool can't be used anywhere else than in a `Containerfile`.
2172+
The `oscap-im` tool can't be used anywhere else than in a `Containerfile`.
21732173

21742174
=== Scanning of Docker containers and images using oscap-docker
21752175

‎utils/CMakeLists.txt‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -139,11 +139,11 @@ if(ENABLE_OSCAP_UTIL_PODMAN)
139139
DESTINATION "${CMAKE_INSTALL_MANDIR}/man8"
140140
)
141141
endif()
142-
if(ENABLE_OSCAP_UTIL_BOOTC)
143-
install(PROGRAMS "oscap-bootc"
142+
if(ENABLE_OSCAP_UTIL_IM)
143+
install(PROGRAMS "oscap-im"
144144
DESTINATION ${CMAKE_INSTALL_BINDIR}
145145
)
146-
install(FILES "oscap-bootc.8"
146+
install(FILES "oscap-im.8"
147147
DESTINATION "${CMAKE_INSTALL_MANDIR}/man8"
148148
)
149149
endif()

utils/oscap-bootc renamed to utils/oscap-im

File renamed without changes.

utils/oscap-bootc.8 renamed to utils/oscap-im.8

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
1-
.TH oscap-bootc "8" "November 2024" "Red Hat, Inc." "System Administration Utilities"
1+
.TH oscap-im "8" "January 2025" "Red Hat, Inc." "System Administration Utilities"
22

33
.SH NAME
4-
oscap-bootc \- Tool for building hardened bootable container images
4+
oscap-im \- Tool for building hardened bootable container images
55

66
.SH DESCRIPTION
7-
The oscap-bootc tool is a convenience script that makes building hardened bootable container images easier.
7+
The oscap-im tool is a convenience script that makes building hardened bootable container images easier.
88
This tool is designed to be used during the build of the bootable container image.
9-
Include oscap-bootc in your Containerfile that will be used to build your bootable container image.
10-
The oscap-bootc runs oscap tool on a given container image.
9+
Include oscap-im in your Containerfile that will be used to build your bootable container image.
10+
The oscap-im runs oscap tool on a given container image.
1111

12-
The oscap-bootc tool can't be used anywhere else than in a Containerfile.
12+
The oscap-im tool can't be used anywhere else than in a Containerfile.
1313

1414
.SH USAGE
1515

16-
oscap-bootc [OPTION...] DATASTREAM_FILE
16+
oscap-im [OPTION...] DATASTREAM_FILE
1717

1818
Usage of the tool mimics usage and options of oscap(8) tool.
1919

0 commit comments

Comments
 (0)