Added an optional kernel parameter test to Packer Build

.gitignore

@@ -5,3 +5,4 @@
 .DS_Store
 site/
 .git-commit
+sysctl_logs/

templates/al2/provisioners/validate.sh

@@ -31,6 +31,63 @@ validate_file_nonexists '/var/log/cloud-init.log'
 validate_file_nonexists '/var/log/secure'
 validate_file_nonexists '/var/log/wtmp'
 
+THROW_ERR=$SYSCTL_TEST_THROW_ERR
+K_VERSION_ARR=(${KUBERNETES_VERSION//./ })
+KUBERNETES_MINOR_VERSION="${K_VERSION_ARR[0]}${K_VERSION_ARR[1]}"
+
+if [[ $AMI_NAME == *"gpu"* ]]; then
+  AMI_FLAVOR="gpu"
+else
+  AMI_FLAVOR="standard"
+fi
+
+SYSCTL_TEST_FILE=$AMI_ALIAS
+
+if [ -f $(pwd)/resources/$SYSCTL_TEST_FILE ]; then
+  sysctl_cmd=$(eval sudo sysctl -a -e > ./sysctl_log.txt)
+  while [ ! -f $(pwd)/sysctl_log.txt ]; do sleep 10; done
+
+  sysctl_blacklist=()
+  while IFS= read -r line; do
+    sysctl_blacklist+=("$line")
+  done < "$(pwd)/resources/sysctl_blacklist"
+
+  diff_command="diff -b"
+  for pattern in "${sysctl_blacklist[@]}"; do
+    diff_command+=" -I \"$pattern\""
+  done
+
+  diff_command+=" $(pwd)/resources/$SYSCTL_TEST_FILE"
+  diff_command+=" $(pwd)/sysctl_log.txt"
+
+  if [ -f $(pwd)/sysctl_log.txt ]; then
+    echo "Executing diff command: $diff_command ..."
+    if ! eval $diff_command; then
+      echo "Compared $AMI_NAME : $SYSCTL_TEST_FILE with $(pwd)/sysctl_log.txt"
+      if $THROW_ERR ; then
+        echo "Failure: Sysctl has unexpected changes. Either include the new logs in templates/shared/resources/ or undo the kernel parameter changes..."
+        exit 1
+      else
+        echo "Warning: Sysctl has unexpected changes. Either include the new logs in templates/shared/resources/ or undo the kernel parameter changes..."
+      fi
+    else
+      echo "Success: Sysctl has no unexpected changes!"
+    fi
+  else
+    echo "Unhandled error: sysctl_log.txt not generated!"
+    if $THROW_ERR ; then
+      exit 1
+    fi
+  fi
+else
+  echo "Failure: $(pwd)/resources/$SYSCTL_TEST_FILE does not exist in the list of known AMIs."
+  if $THROW_ERR ; then
+    exit 1
+  fi
+fi
+
+echo "Done checking sysctl"
+
 actual_kernel=$(uname -r)
 echo "Verifying that kernel version $actual_kernel matches $KERNEL_VERSION..."
 

templates/al2/template.json

@@ -44,7 +44,11 @@
     "temporary_security_group_source_cidrs": null,
     "user_data_file": null,
     "volume_type": null,
-    "working_dir": null
+    "working_dir": null,
+    "sysctl_test_throw_err": null,
+    "k8s_major_minor": "{{ split (user `kubernetes_version`) `.`  0}}{{split (user `kubernetes_version`) `.` 1}}",
+    "ami_type": null,
+    "ami_alias": "{{ user `k8s_major_minor` }}-al2-{{ user `arch` }}-{{ user `ami_type` }}"
   },
   "builders": [
     {
@@ -221,12 +225,22 @@
         "ADDITIONAL_YUM_REPOS={{user `additional_yum_repos`}}"
       ]
     },
+    {
+      "destination": "/home/ec2-user/resources",
+      "source": "{{template_dir}}/../shared/resources",
+      "type": "file"
+    },
     {
       "type": "shell",
       "remote_folder": "{{ user `remote_folder`}}",
       "script": "{{template_dir}}/provisioners/validate.sh",
       "environment_vars": [
-        "KERNEL_VERSION={{user `kernel_version`}}"
+        "KUBERNETES_VERSION={{user `kubernetes_version`}}",
+        "AMI_NAME={{user `ami_name`}}",
+        "ARCH={{user `arch`}}",
+        "KERNEL_VERSION={{user `kernel_version`}}",
+        "AMI_ALIAS={{user `ami_alias`}}",
+        "SYSCTL_TEST_THROW_ERR={{user `sysctl_test_throw_err`}}"
       ]
     },
     {
@@ -244,6 +258,12 @@
       "source": "{{user `working_dir`}}/version-info.json",
       "destination": "{{ user `ami_name` }}-version-info.json"
     },
+    {
+      "type": "file",
+      "direction": "download",
+      "source": "/home/ec2-user/sysctl_log.txt",
+      "destination": "sysctl_logs/{{user `ami_alias`}}"
+    },
     {
       "type": "shell",
       "remote_folder": "{{ user `remote_folder`}}",

templates/al2/variables-default.json

@@ -37,5 +37,7 @@
     "temporary_security_group_source_cidrs": "",
     "user_data_file": null,
     "volume_type": "gp2",
-    "working_dir": "{{user `remote_folder`}}/worker"
+    "working_dir": "{{user `remote_folder`}}/worker",
+    "sysctl_test_throw_err": "false",
+    "ami_type": "standard"
 }

templates/al2023/provisioners/validate.sh

@@ -31,6 +31,63 @@ validate_file_nonexists '/var/log/cloud-init.log'
 validate_file_nonexists '/var/log/secure'
 validate_file_nonexists '/var/log/wtmp'
 
+THROW_ERR=$SYSCTL_TEST_THROW_ERR
+K_VERSION_ARR=(${KUBERNETES_VERSION//./ })
+KUBERNETES_MINOR_VERSION="${K_VERSION_ARR[0]}${K_VERSION_ARR[1]}"
+
+if [[ $AMI_NAME == *"gpu"* ]]; then
+  AMI_FLAVOR="gpu"
+else
+  AMI_FLAVOR="standard"
+fi
+
+SYSCTL_TEST_FILE=$AMI_ALIAS
+
+if [ -f $(pwd)/resources/$SYSCTL_TEST_FILE ]; then
+  sysctl_cmd=$(eval sudo sysctl -a -e > ./sysctl_log.txt)
+  while [ ! -f $(pwd)/sysctl_log.txt ]; do sleep 10; done
+
+  sysctl_blacklist=()
+  while IFS= read -r line; do
+    sysctl_blacklist+=("$line")
+  done < "$(pwd)/resources/sysctl_blacklist"
+
+  diff_command="diff -b"
+  for pattern in "${sysctl_blacklist[@]}"; do
+    diff_command+=" -I \"$pattern\""
+  done
+
+  diff_command+=" $(pwd)/resources/$SYSCTL_TEST_FILE"
+  diff_command+=" $(pwd)/sysctl_log.txt"
+
+  if [ -f $(pwd)/sysctl_log.txt ]; then
+    echo "Executing diff command: $diff_command ..."
+    if ! eval $diff_command; then
+      echo "Compared $AMI_NAME : $SYSCTL_TEST_FILE with $(pwd)/sysctl_log.txt"
+      if $THROW_ERR ; then
+        echo "Failure: Sysctl has unexpected changes. Either include the new logs in templates/shared/resources/ or undo the kernel parameter changes..."
+        exit 1
+      else
+        echo "Warning: Sysctl has unexpected changes. Either include the new logs in templates/shared/resources/ or undo the kernel parameter changes..."
+      fi
+    else
+      echo "Success: Sysctl has no unexpected changes!"
+    fi
+  else
+    echo "Unhandled error: sysctl_log.txt not generated!"
+    if $THROW_ERR ; then
+      exit 1
+    fi
+  fi
+else
+  echo "Failure: $(pwd)/resources/$SYSCTL_TEST_FILE does not exist in the list of known AMIs."
+  if $THROW_ERR ; then
+    exit 1
+  fi
+fi
+
+echo "Done checking sysctl log."
+
 REQUIRED_COMMANDS=(unpigz)
 
 for ENTRY in "${REQUIRED_COMMANDS[@]}"; do

templates/al2023/template.json

@@ -38,7 +38,11 @@
     "temporary_security_group_source_cidrs": null,
     "user_data_file": null,
     "volume_type": null,
-    "working_dir": null
+    "working_dir": null,
+    "sysctl_test_throw_err": null,
+    "k8s_major_minor": "{{ split (user `kubernetes_version`) `.`  0}}{{split (user `kubernetes_version`) `.` 1}}",
+    "ami_type": null,
+    "ami_alias": "{{ user `k8s_major_minor` }}-al2023-{{ user `arch` }}-{{ user `ami_type` }}"
   },
   "builders": [
     {
@@ -201,10 +205,23 @@
       "remote_folder": "{{ user `remote_folder`}}",
       "script": "{{template_dir}}/../shared/provisioners/cleanup.sh"
     },
+    {
+      "destination": "/home/ec2-user/resources",
+      "source": "{{template_dir}}/../shared/resources",
+      "type": "file"
+    },
     {
       "type": "shell",
       "remote_folder": "{{ user `remote_folder`}}",
-      "script": "{{template_dir}}/provisioners/validate.sh"
+      "script": "{{template_dir}}/provisioners/validate.sh",
+      "environment_vars": [
+        "KUBERNETES_VERSION={{user `kubernetes_version`}}",
+        "AMI_NAME={{user `ami_name`}}",
+        "ARCH={{user `arch`}}",
+        "KERNEL_VERSION={{user `kernel_version`}}",
+        "AMI_ALIAS={{user `ami_alias`}}",
+        "SYSCTL_TEST_THROW_ERR={{user `sysctl_test_throw_err`}}"
+      ]
     },
     {
       "type": "shell",
@@ -218,6 +235,12 @@
       "source": "{{user `working_dir`}}/version-info.json",
       "destination": "{{ user `ami_name` }}-version-info.json"
     },
+    {
+      "type": "file",
+      "direction": "download",
+      "source": "/home/ec2-user/sysctl_log.txt",
+      "destination": "sysctl_logs/{{user `ami_alias`}}"
+    },
     {
       "type": "shell",
       "inline": [

templates/al2023/variables-default.json

@@ -30,5 +30,7 @@
     "temporary_security_group_source_cidrs": "",
     "user_data_file": null,
     "volume_type": "gp3",
-    "working_dir": "{{user `remote_folder`}}/worker"
+    "working_dir": "{{user `remote_folder`}}/worker",
+    "sysctl_test_throw_err": "false",
+    "ami_type": "standard"
 }