From 5c8fc6fd31f55bd597f662c9cf952f614e647581 Mon Sep 17 00:00:00 2001
From: Jay Faulkner <jay.faulkner@verizonmedia.com>
Date: Mon, 9 Aug 2021 14:51:52 -0700
Subject: [PATCH] Allow opt-out of full ramdisk pruning

While aggressively pruning ramdisk contents reduces the size, it can
break packages that depend on any of the pruned directories existing.
Allow anyone impacted by that case to opt out.

Change-Id: I1b5a65a56d151a26ee44446c20c6df31bb695223
---
 dib/ironic-ramdisk-base/README.rst            |  9 +++
 .../cleanup.d/99-ramdisk-create               | 69 ++++++++++++-------
 2 files changed, 53 insertions(+), 25 deletions(-)

diff --git a/dib/ironic-ramdisk-base/README.rst b/dib/ironic-ramdisk-base/README.rst
index c32839f..f18f06a 100644
--- a/dib/ironic-ramdisk-base/README.rst
+++ b/dib/ironic-ramdisk-base/README.rst
@@ -3,3 +3,12 @@ ironic-ramdisk-base
 
 This is a base element for ironic ramdisks. It does not install anything, just
 takes the prepared images and extract kernel/ramdisk from it.
+
+Configurable Environment Variables
+----------------------------------
+- `DIB_IPA_COMPRESS_COMMAND` defaults to `gzip`, may be set to any valid
+  compression program usable for an initramfs
+- `DIB_IPA_MINIMAL_PRUNE` defaults to `0` (false). If set to `1`, will skip
+  most ramdisk size optimizations. This may be helpful for use of packages
+  with IPA that require otherwise-pruned directories or files.
+
diff --git a/dib/ironic-ramdisk-base/cleanup.d/99-ramdisk-create b/dib/ironic-ramdisk-base/cleanup.d/99-ramdisk-create
index 393040d..1efa1c8 100755
--- a/dib/ironic-ramdisk-base/cleanup.d/99-ramdisk-create
+++ b/dib/ironic-ramdisk-base/cleanup.d/99-ramdisk-create
@@ -24,31 +24,50 @@ echo "#disabled" > ./tmp/fstab.new
 sudo mv ./tmp/fstab.new ./etc/fstab
 sudo ln -s ./sbin/init ./
 
-# Note: The pci.ids, which is used by lshw, locate on Ubuntu
-# in /usr/share/misc. Therefore we are removing only the
-# ./usr/share/misc/m* (will remove the magic and magic.mgc files).
-# on RHEL pci.ids is locate on /usr/share/hwdata/pci.ids.
-sudo find . -xdev \
-    -path './sys/*' -prune -o \
-    -path './tmp/*' -prune -o \
-    -path './boot/*' -prune -o \
-    -path './root/.cache' -prune -o \
-    -path "*site-packages/babel/locale-data/*" -prune -o \
-    -path './usr/include/*' -prune -o \
-    -path './usr/lib/locale/*' -prune -o \
-    -path './usr/share/doc/*' -prune -o \
-    -path './usr/share/man/*' -prune -o \
-    -path './usr/share/GeoIP/*' -prune -o \
-    -path './usr/share/info/*' -prune -o \
-    -path './usr/share/licenses/*' -prune -o \
-    -path './usr/share/locale/*' -prune -o \
-    -path './usr/share/misc/m*' -prune -o \
-    -path './usr/src/kernels/*' -prune -o \
-    -path './var/cache/*' -prune -o \
-    -path './var/log/*' -prune -o \
-    -name '*.pyc' -prune -o \
-    -name '*.pyo' -prune -o \
-    -print | sudo cpio -o -H newc | ${DIB_IPA_COMPRESS_CMD} > ${IMAGE_PATH}.initramfs
+# Note(JayF): to anyone trying to make this more configurable in the future,
+# there are significant hurdles around shell quoting if you try to put these
+# find commands into variables for making them more configurable.
+if [ "${DIB_IPA_MINIMAL_PRUNE:-0}" -gt 0 ]; then
+    # Operator opted out of full ramdisk pruning; do not proactively remove
+    # directories that may be in use by other elements/packages
+    sudo find . -xdev \
+        -path './sys/*' -prune -o \
+        -path './tmp/*' -prune -o \
+        -path './boot/*' -prune -o \
+        -path './root/.cache' -prune -o \
+        -name '*.pyc' -prune -o \
+        -name '*.pyo' -prune -o \
+        -print | sudo cpio -o -H newc | ${DIB_IPA_COMPRESS_CMD} > ${IMAGE_PATH}.initramfs
+else
+    # This performs a full prune, leading to the smallest possible ramdisk
+    # size. This may break operator-configured packages or elements that
+    # depend on pruned paths.
+    # Note: The pci.ids, which is used by lshw, are located on Ubuntu
+    # in /usr/share/misc. Therefore we are removing only the
+    # ./usr/share/misc/m* (will remove the magic and magic.mgc files).
+    # on RHEL pci.ids is locate on /usr/share/hwdata/pci.ids.
+    sudo find . -xdev \
+        -path './sys/*' -prune -o \
+        -path './tmp/*' -prune -o \
+        -path './boot/*' -prune -o \
+        -path './root/.cache' -prune -o \
+        -path "*site-packages/babel/locale-data/*" -prune -o \
+        -path './usr/include/*' -prune -o \
+        -path './usr/lib/locale/*' -prune -o \
+        -path './usr/share/doc/*' -prune -o \
+        -path './usr/share/man/*' -prune -o \
+        -path './usr/share/GeoIP/*' -prune -o \
+        -path './usr/share/info/*' -prune -o \
+        -path './usr/share/licenses/*' -prune -o \
+        -path './usr/share/locale/*' -prune -o \
+        -path './usr/share/misc/m*' -prune -o \
+        -path './usr/src/kernels/*' -prune -o \
+        -path './var/cache/*' -prune -o \
+        -path './var/log/*' -prune -o \
+        -name '*.pyc' -prune -o \
+        -name '*.pyo' -prune -o \
+        -print | sudo cpio -o -H newc | ${DIB_IPA_COMPRESS_CMD} > ${IMAGE_PATH}.initramfs
+fi
 
 select_boot_kernel_initrd $TARGET_ROOT
 sudo cp $BOOTDIR/$KERNEL ${IMAGE_PATH}.kernel