feat: move common.sh to deploy/, add baremetal config sync and 0-byte guard

fonta-rh · claude · fonta-rh · commit 114df4ac6b8f · 2026-07-09T12:10:23.000+02:00
Move common.sh from deploy/aws-hypervisor/scripts/ to deploy/ so all
deploy paths (AWS and baremetal) can source it without reaching into
aws-hypervisor internals. Add config_baremetal_fencing.sh to the sync
manifest and have baremetal-adopt generate it into config/. Skip syncing
0-byte source files to prevent accidental credential blanking.

Co-Authored-By: Claude Opus 4.6 &lt;noreply@anthropic.com&gt;
diff --git a/CLAUDE.md b/CLAUDE.md
@@ -136,6 +136,7 @@ User configuration files are created in `config/` at the repository root (templa
 - `config/instance.env`: AWS hypervisor settings (copy from `config/instance.env.template`)
 - `config/pull-secret.json`: OpenShift pull secret, fanned out to both dev-scripts and kcli role locations
 - `config/config_arbiter.sh`, `config/config_fencing.sh`, `config/config_sno.sh`: dev-scripts topology configs (copy from the `config/config_*_example.sh` files)
+- `config/config_baremetal_fencing.sh`: baremetal fencing topology config (generated by `make baremetal-adopt`)
 - `config/kcli.yml`: kcli variable overrides (copy from `config/kcli.yml.template`)
 - `config/assisted.yml`: assisted installer variables (copy from `config/assisted.yml.template`)
 - `config/init-host.yml.local`: external-host RHSM overrides (copy from `deploy/openshift-clusters/vars/init-host.yml`)
@@ -145,6 +146,7 @@ User configuration files are created in `config/` at the repository root (templa
 - `roles/dev-scripts/install-dev/files/config_arbiter.sh`: Arbiter topology config
 - `roles/dev-scripts/install-dev/files/config_fencing.sh`: Fencing topology config
 - `roles/dev-scripts/install-dev/files/config_sno.sh`: Single Node OpenShift config
+- `roles/dev-scripts/install-dev/files/config_baremetal_fencing.sh`: Baremetal fencing topology config
 - `roles/dev-scripts/install-dev/files/pull-secret.json`: OpenShift pull secret
 
 #### Kcli Method (canonical locations)
diff --git a/config/README.md b/config/README.md
@@ -18,6 +18,7 @@ prevents your real config files (including the pull secret) from ever being comm
 | `config_arbiter.sh` | dev-scripts arbiter topology | `deploy/openshift-clusters/roles/dev-scripts/install-dev/files/config_arbiter.sh` | `cp config/config_arbiter_example.sh config/config_arbiter.sh` |
 | `config_fencing.sh` | dev-scripts fencing topology | `deploy/openshift-clusters/roles/dev-scripts/install-dev/files/config_fencing.sh` | `cp config/config_fencing_example.sh config/config_fencing.sh` |
 | `config_sno.sh` | dev-scripts SNO topology | `deploy/openshift-clusters/roles/dev-scripts/install-dev/files/config_sno.sh` | `cp config/config_sno_example.sh config/config_sno.sh` |
+| `config_baremetal_fencing.sh` | dev-scripts baremetal fencing topology | `deploy/openshift-clusters/roles/dev-scripts/install-dev/files/config_baremetal_fencing.sh` | Generated by `make baremetal-adopt`, or copy from canonical location |
 | `kcli.yml` | kcli deployment (optional overrides) | `deploy/openshift-clusters/vars/kcli.yml` | `cp config/kcli.yml.template config/kcli.yml` |
 | `assisted.yml` | assisted installer spoke deployment | `deploy/openshift-clusters/vars/assisted.yml` | `cp config/assisted.yml.template config/assisted.yml` |
 | `init-host.yml.local` | external host initialization (optional RHSM overrides) | `deploy/openshift-clusters/vars/init-host.yml.local` | `cp deploy/openshift-clusters/vars/init-host.yml config/init-host.yml.local` |
diff --git a/deploy/Makefile b/deploy/Makefile
@@ -62,7 +62,7 @@ inventory:
 	@./aws-hypervisor/scripts/inventory.sh
 
 sync-config:
-	@bash -c 'source ./aws-hypervisor/scripts/common.sh; if [ "$${CONFIG_SYNCED_COUNT:-0}" -eq 0 ]; then echo "Config files: everything up to date."; fi'
+	@bash -c 'source ./common.sh; if [ "$${CONFIG_SYNCED_COUNT:-0}" -eq 0 ]; then echo "Config files: everything up to date."; fi'
 
 fencing-ipi:
 	@./openshift-clusters/scripts/deploy-cluster.sh --topology fencing --method ipi
diff --git a/deploy/aws-hypervisor/scripts/create.sh b/deploy/aws-hypervisor/scripts/create.sh
@@ -2,7 +2,7 @@
 
 SCRIPT_DIR=$(dirname "$0")
 # shellcheck source=/dev/null
-source "${SCRIPT_DIR}/common.sh"
+source "${SCRIPT_DIR}/../../common.sh"
 
 set -o nounset
 set -o errexit
diff --git a/deploy/aws-hypervisor/scripts/destroy.sh b/deploy/aws-hypervisor/scripts/destroy.sh
@@ -2,7 +2,7 @@
 
 SCRIPT_DIR=$(dirname "$0")
 # shellcheck source=/dev/null
-source "${SCRIPT_DIR}/common.sh"
+source "${SCRIPT_DIR}/../../common.sh"
 
 set -o nounset
 set -o errexit
diff --git a/deploy/aws-hypervisor/scripts/force-stop.sh b/deploy/aws-hypervisor/scripts/force-stop.sh
@@ -2,7 +2,7 @@
 
 SCRIPT_DIR=$(dirname "$0")
 # shellcheck source=/dev/null
-source "${SCRIPT_DIR}/common.sh"
+source "${SCRIPT_DIR}/../../common.sh"
 
 set -o nounset
 set -o errexit
diff --git a/deploy/aws-hypervisor/scripts/init.sh b/deploy/aws-hypervisor/scripts/init.sh
@@ -1,7 +1,7 @@
 #!/bin/bash
 SCRIPT_DIR=$(dirname "$0")
 # shellcheck source=/dev/null
-source "${SCRIPT_DIR}/common.sh"
+source "${SCRIPT_DIR}/../../common.sh"
 
 node_dir="$(get_node_dir)"
 instance_ip="$(cat "${node_dir}/ssh_user")@$(cat "${node_dir}/public_address")"
diff --git a/deploy/aws-hypervisor/scripts/inventory.sh b/deploy/aws-hypervisor/scripts/inventory.sh
@@ -2,7 +2,7 @@
 
 SCRIPT_DIR=$(dirname "$0")
 # shellcheck source=/dev/null
-source "${SCRIPT_DIR}/common.sh"
+source "${SCRIPT_DIR}/../../common.sh"
 
 set -o nounset
 set -o errexit
diff --git a/deploy/aws-hypervisor/scripts/print_instance_data.sh b/deploy/aws-hypervisor/scripts/print_instance_data.sh
@@ -1,7 +1,7 @@
 #!/bin/bash
 SCRIPT_DIR=$(dirname "$0")
 # shellcheck source=/dev/null
-source "${SCRIPT_DIR}/common.sh"
+source "${SCRIPT_DIR}/../../common.sh"
 
 node_dir="$(get_node_dir)"
 echo "Stack: $(cat "${node_dir}/rhel_host_stack_name")"
diff --git a/deploy/aws-hypervisor/scripts/ssh.sh b/deploy/aws-hypervisor/scripts/ssh.sh
@@ -1,7 +1,7 @@
 #!/bin/bash
 SCRIPT_DIR=$(dirname "$0")
 # shellcheck source=/dev/null
-source "${SCRIPT_DIR}/common.sh"
+source "${SCRIPT_DIR}/../../common.sh"
 
 node_dir="$(get_node_dir)"
 instance_ip="$(cat "${node_dir}/ssh_user")@$(cat "${node_dir}/public_address")"
diff --git a/deploy/aws-hypervisor/scripts/start.sh b/deploy/aws-hypervisor/scripts/start.sh
@@ -2,7 +2,7 @@
 
 SCRIPT_DIR=$(dirname "$0")
 # shellcheck source=/dev/null
-source "${SCRIPT_DIR}/common.sh"
+source "${SCRIPT_DIR}/../../common.sh"
 
 set -o nounset
 set -o errexit
diff --git a/deploy/aws-hypervisor/scripts/stop.sh b/deploy/aws-hypervisor/scripts/stop.sh
@@ -2,7 +2,7 @@
 
 SCRIPT_DIR=$(dirname "$0")
 # shellcheck source=/dev/null
-source "${SCRIPT_DIR}/common.sh"
+source "${SCRIPT_DIR}/../../common.sh"
 
 set -o nounset
 set -o errexit
diff --git a/deploy/common.sh b/deploy/common.sh
@@ -1,7 +1,7 @@
 #!/bin/bash
 SCRIPT_DIR=$(dirname "$0")
 COMMON_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
-REPO_ROOT="$(cd "${COMMON_DIR}/../../.." && pwd)"
+REPO_ROOT="$(cd "${COMMON_DIR}/.." && pwd)"
 
 readonly COLOR_RED='\033[0;31m'
 readonly COLOR_YELLOW='\033[0;33m'
@@ -28,6 +28,7 @@ CONFIG_SYNC_MANIFEST=(
   "config_arbiter.sh:deploy/openshift-clusters/roles/dev-scripts/install-dev/files/config_arbiter.sh"
   "config_fencing.sh:deploy/openshift-clusters/roles/dev-scripts/install-dev/files/config_fencing.sh"
   "config_sno.sh:deploy/openshift-clusters/roles/dev-scripts/install-dev/files/config_sno.sh"
+  "config_baremetal_fencing.sh:deploy/openshift-clusters/roles/dev-scripts/install-dev/files/config_baremetal_fencing.sh"
   "pull-secret.json:deploy/openshift-clusters/roles/dev-scripts/install-dev/files/pull-secret.json:deploy/openshift-clusters/roles/kcli/kcli-install/files/pull-secret.json"
   "kcli.yml:deploy/openshift-clusters/vars/kcli.yml"
   "assisted.yml:deploy/openshift-clusters/vars/assisted.yml"
@@ -46,6 +47,10 @@ function sync_config_files() {
     IFS=':' read -r -a fields <<< "${entry}"
     src="${REPO_ROOT}/config/${fields[0]}"
     [[ -f "${src}" ]] || continue
+    if [[ ! -s "${src}" ]]; then
+      msg_warning "config/${fields[0]} is empty (0 bytes), skipping sync"
+      continue
+    fi
     for dest in "${fields[@]:1}"; do
       if [[ ! -f "${REPO_ROOT}/${dest}" || "${src}" -nt "${REPO_ROOT}/${dest}" ]]; then
         msg_info "config/${fields[0]} is newer, updating ${dest}"
@@ -57,9 +62,9 @@ function sync_config_files() {
 }
 sync_config_files
 
-if [[ -f "${COMMON_DIR}/../instance.env" ]]; then
+if [[ -f "${COMMON_DIR}/aws-hypervisor/instance.env" ]]; then
   # shellcheck source=/dev/null
-  source "${COMMON_DIR}/../instance.env"
+  source "${COMMON_DIR}/aws-hypervisor/instance.env"
 else
   msg_warning "instance.env not found (only needed for AWS hypervisor targets). To create it: cp config/instance.env.template config/instance.env and edit it."
 fi
@@ -78,13 +83,13 @@ export CAPACITY_RESERVATION_DURATION_MINUTES="${CAPACITY_RESERVATION_DURATION_MI
 export NODE_ID="${NODE_ID:-node-0}"
 
 get_shared_dir() {
-  echo "${COMMON_DIR}/../${SHARED_DIR}"
+  echo "${COMMON_DIR}/aws-hypervisor/${SHARED_DIR}"
 }
 
 get_node_dir() {
-  local node_dir="${COMMON_DIR}/../${SHARED_DIR}/${NODE_ID}"
-  if [[ ! -d "$node_dir" && -f "${COMMON_DIR}/../${SHARED_DIR}/aws-instance-id" ]]; then
-    echo "${COMMON_DIR}/../${SHARED_DIR}"
+  local node_dir="${COMMON_DIR}/aws-hypervisor/${SHARED_DIR}/${NODE_ID}"
+  if [[ ! -d "$node_dir" && -f "${COMMON_DIR}/aws-hypervisor/${SHARED_DIR}/aws-instance-id" ]]; then
+    echo "${COMMON_DIR}/aws-hypervisor/${SHARED_DIR}"
     return
   fi
   echo "$node_dir"
diff --git a/deploy/openshift-clusters/scripts/baremetal-adopt.sh b/deploy/openshift-clusters/scripts/baremetal-adopt.sh
@@ -499,26 +499,30 @@ main() {
         exit 0
     fi
 
-    # Output alongside existing dev-scripts config files
-    local output_dir="${OC_DIR}/roles/dev-scripts/install-dev/files"
+    local repo_root
+    repo_root="$(cd "${OC_DIR}/../.." && pwd)"
+    local config_dir="${repo_root}/config"
+    local files_dir="${OC_DIR}/roles/dev-scripts/install-dev/files"
 
-    # Generate artifacts
-    local nodes_file="${output_dir}/ironic_nodes.json"
+    # Generate ironic nodes alongside existing dev-scripts files
+    local nodes_file="${files_dir}/ironic_nodes.json"
     generate_ironic_nodes_json "${nodes_file}"
 
-    # NODES_FILE path on the hypervisor — resolves when dev-scripts sources the config
+    # Generate config into config/ — sync-config carries it to the canonical location
     local remote_nodes_path="\${PWD}/ironic_nodes.json"
-    generate_baremetal_config "${output_dir}/config_baremetal_fencing.sh" "${remote_nodes_path}"
+    generate_baremetal_config "${config_dir}/config_baremetal_fencing.sh" "${remote_nodes_path}"
 
     echo ""
     info "Adoption complete. Generated artifacts:"
     echo "    ${nodes_file}"
-    echo "    ${output_dir}/config_baremetal_fencing.sh"
+    echo "    ${config_dir}/config_baremetal_fencing.sh"
     echo ""
-    echo "  Before deploying, verify these values in ${output_dir}/config_baremetal_fencing.sh:"
+    echo "  Before deploying, verify these values in ${config_dir}/config_baremetal_fencing.sh:"
     echo "    - CI_TOKEN        (get from console-openshift-console.apps.ci.l2s4.p1.openshiftapps.com)"
     echo "    - OPENSHIFT_RELEASE_IMAGE  (find tags at quay.io/openshift-release-dev/ocp-release)"
     echo ""
+    echo "  The config will be synced to its canonical location automatically by 'make sync-config'."
+    echo ""
     echo "  Next: deploy to the nodes using one of the baremetal-deploy* options"
 }
 
diff --git a/deploy/openshift-clusters/scripts/clean-spoke.sh b/deploy/openshift-clusters/scripts/clean-spoke.sh
@@ -7,7 +7,7 @@ SCRIPT_DIR=$(dirname "$0")
 DEPLOY_DIR="$(cd "${SCRIPT_DIR}/../.." && pwd)"
 
 # shellcheck source=/dev/null
-source "${DEPLOY_DIR}/aws-hypervisor/scripts/common.sh"
+source "${DEPLOY_DIR}/common.sh"
 
 set -o nounset
 set -o errexit
diff --git a/deploy/openshift-clusters/scripts/clean.sh b/deploy/openshift-clusters/scripts/clean.sh
@@ -6,7 +6,7 @@ SCRIPT_DIR=$(dirname "$0")
 DEPLOY_DIR="$(cd "${SCRIPT_DIR}/../.." && pwd)"
 
 # shellcheck source=/dev/null
-source "${DEPLOY_DIR}/aws-hypervisor/scripts/common.sh"
+source "${DEPLOY_DIR}/common.sh"
 
 set -o nounset
 set -o errexit
diff --git a/deploy/openshift-clusters/scripts/deploy-baremetal.sh b/deploy/openshift-clusters/scripts/deploy-baremetal.sh
@@ -16,6 +16,9 @@ set -o pipefail
 
 SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)"
 OC_DIR="$(cd "${SCRIPT_DIR}/.." && pwd)"
+DEPLOY_DIR="$(cd "${OC_DIR}/.." && pwd)"
+# shellcheck source=/dev/null
+source "${DEPLOY_DIR}/common.sh"
 
 INVENTORY="${OC_DIR}/inventory_baremetal.ini"
 PLAYBOOK="${OC_DIR}/deploy-baremetal.yml"
diff --git a/deploy/openshift-clusters/scripts/deploy-cluster.sh b/deploy/openshift-clusters/scripts/deploy-cluster.sh
@@ -10,7 +10,7 @@ SCRIPT_DIR=$(dirname "$0")
 DEPLOY_DIR="$(cd "${SCRIPT_DIR}/../.." && pwd)"
 
 # shellcheck source=/dev/null
-source "${DEPLOY_DIR}/aws-hypervisor/scripts/common.sh"
+source "${DEPLOY_DIR}/common.sh"
 
 set -o nounset
 set -o errexit
diff --git a/deploy/openshift-clusters/scripts/deploy-fencing-assisted.sh b/deploy/openshift-clusters/scripts/deploy-fencing-assisted.sh
@@ -6,7 +6,7 @@ SCRIPT_DIR=$(dirname "$0")
 DEPLOY_DIR="$(cd "${SCRIPT_DIR}/../.." && pwd)"
 
 # shellcheck source=/dev/null
-source "${DEPLOY_DIR}/aws-hypervisor/scripts/common.sh"
+source "${DEPLOY_DIR}/common.sh"
 
 set -o nounset
 set -o errexit
diff --git a/deploy/openshift-clusters/scripts/full-clean.sh b/deploy/openshift-clusters/scripts/full-clean.sh
@@ -6,7 +6,7 @@ SCRIPT_DIR=$(dirname "$0")
 DEPLOY_DIR="$(cd "${SCRIPT_DIR}/../.." && pwd)"
 
 # shellcheck source=/dev/null
-source "${DEPLOY_DIR}/aws-hypervisor/scripts/common.sh"
+source "${DEPLOY_DIR}/common.sh"
 
 set -o nounset
 set -o errexit
diff --git a/deploy/openshift-clusters/scripts/get-tnf-logs.sh b/deploy/openshift-clusters/scripts/get-tnf-logs.sh
@@ -8,7 +8,7 @@ DEPLOY_DIR="$(cd "${SCRIPT_DIR}/../.." && pwd)"
 REPO_ROOT="$(cd "${DEPLOY_DIR}/.." && pwd)"
 
 # shellcheck source=/dev/null
-source "${DEPLOY_DIR}/aws-hypervisor/scripts/common.sh"
+source "${DEPLOY_DIR}/common.sh"
 
 set -o nounset
 set -o errexit
diff --git a/deploy/openshift-clusters/scripts/patch-nodes.sh b/deploy/openshift-clusters/scripts/patch-nodes.sh
@@ -6,7 +6,7 @@ SCRIPT_DIR=$(dirname "$0")
 DEPLOY_DIR="$(cd "${SCRIPT_DIR}/../.." && pwd)"
 
 # shellcheck source=/dev/null
-source "${DEPLOY_DIR}/aws-hypervisor/scripts/common.sh"
+source "${DEPLOY_DIR}/common.sh"
 
 set -o nounset
 set -o errexit
diff --git a/deploy/openshift-clusters/scripts/redeploy-cluster.sh b/deploy/openshift-clusters/scripts/redeploy-cluster.sh
@@ -5,7 +5,7 @@ SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
 DEPLOY_DIR="$(cd "${SCRIPT_DIR}/../../" && pwd)"
 
 # shellcheck source=/dev/null
-source "${DEPLOY_DIR}/aws-hypervisor/scripts/common.sh"
+source "${DEPLOY_DIR}/common.sh"
 
 set -o nounset
 set -o errexit
diff --git a/deploy/openshift-clusters/scripts/shutdown-cluster.sh b/deploy/openshift-clusters/scripts/shutdown-cluster.sh
@@ -5,7 +5,7 @@ SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
 DEPLOY_DIR="$(cd "${SCRIPT_DIR}/../../" && pwd)"
 
 # shellcheck source=/dev/null
-source "${DEPLOY_DIR}/aws-hypervisor/scripts/common.sh"
+source "${DEPLOY_DIR}/common.sh"
 
 set -o nounset
 set -o errexit
diff --git a/deploy/openshift-clusters/scripts/startup-cluster.sh b/deploy/openshift-clusters/scripts/startup-cluster.sh
@@ -5,7 +5,7 @@ SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
 DEPLOY_DIR="$(cd "${SCRIPT_DIR}/../../" && pwd)"
 
 # shellcheck source=/dev/null
-source "${DEPLOY_DIR}/aws-hypervisor/scripts/common.sh"
+source "${DEPLOY_DIR}/common.sh"
 
 set -o nounset
 set -o errexit
