feat(node): Configuration revamp (GuestOS integration)

ic-os/components/init/bootstrap-ic-node/guestos/bootstrap-ic-node.sh

@@ -3,8 +3,6 @@
 # Provision a node based on an injected "ic-bootstrap.tar" file. This script
 # is meant to be run as a prerequisite before launching orchestrator/replica.
 #
-# The configuration format is described in guestos/docs/ConfigStore.adoc
-#
 # The tar file can be supplied using one of two methods:
 # - as "ic-bootstrap.tar" stored on a (virtual) removable media attached
 #   on first boot

ic-os/components/misc/config.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+
+# Shared config utilities.
+
+# Retrieves a value from the config.json file using a JSON path.
+# Arguments:
+#   $1 - JSON path to the desired value (e.g., '.icos_settings.node_operator_private_key_path')
+function get_config_value() {
+    local CONFIG_FILE="/var/ic/config/config.json"
+    local key=$1
+    jq -r "${key}" "${CONFIG_FILE}"
+}

ic-os/components/setupos-scripts/check-config.sh

@@ -0,0 +1,33 @@
+#!/usr/bin/env bash
+
+set -o nounset
+set -o pipefail
+
+source /opt/ic/bin/config.sh
+source /opt/ic/bin/functions.sh
+
+SHELL="/bin/bash"
+PATH="/sbin:/bin:/usr/sbin:/usr/bin"
+
+check_config_file() {
+    echo "* Checking Config..."
+    local CONFIG_FILE="/var/ic/config/config.json"
+
+    if [ -f "${CONFIG_FILE}" ]; then
+        local config_contents=$(cat "${CONFIG_FILE}")
+        echo -e "Configuration file '${CONFIG_FILE}' exists.\n"
+        echo -e "File contents:\n${config_contents}"
+    else
+        local service_logs=$(journalctl -u config.service --no-pager)
+        local log_message="Error creating SetupOS configuration. Configuration file '${CONFIG_FILE}' does not exist.\n\nConfig.service logs:\n${service_logs}"
+
+        log_and_halt_installation_on_error 1 "${log_message}"
+    fi
+}
+
+# Establish run order
+main() {
+    check_config_file
+}
+
+main

ic-os/components/setupos-scripts/check-hardware.sh

@@ -3,6 +3,9 @@
 set -o nounset
 set -o pipefail
 
+source /opt/ic/bin/config.sh
+source /opt/ic/bin/functions.sh
+
 SHELL="/bin/bash"
 PATH="/sbin:/bin:/usr/sbin:/usr/bin"
 
@@ -30,8 +33,6 @@ GEN2_MINIMUM_AGGREGATE_DISK_SIZE=32000000000000
 GEN1_MINIMUM_DISK_SIZE=3200000000000
 GEN1_MINIMUM_AGGREGATE_DISK_SIZE=32000000000000
 
-CONFIG_DIR="/var/ic/config"
-
 function check_generation() {
     echo "* Checking Generation..."
 
@@ -247,7 +248,10 @@ function verify_disks() {
 
 function verify_deployment_path() {
     echo "* Verifying deployment path..."
-    if [[ ${GENERATION} == 2 ]] && [[ ! -f "${CONFIG_DIR}/node_operator_private_key.pem" ]]; then
+
+    local node_operator_key_path=$(get_config_value '.icos_settings.node_operator_private_key_path')
+
+    if [[ ${GENERATION} == 2 ]] && [[ ! -f "${node_operator_key_path}" ]]; then
         echo -e "\n\n\n\n\n\n"
         echo -e "\033[1;31mWARNING: Gen2 hardware detected but no Node Operator Private Key found.\033[0m"
         echo -e "\033[1;31mGen2 hardware should be deployed using the Gen2 Node Deployment method.\033[0m"
@@ -261,7 +265,6 @@ function verify_deployment_path() {
 
 # Establish run order
 main() {
-    source /opt/ic/bin/functions.sh
     log_start "$(basename $0)"
     check_generation
     verify_cpu

ic-os/components/setupos-scripts/check-network.sh

@@ -3,25 +3,19 @@
 set -o nounset
 set -o pipefail
 
+source /opt/ic/bin/config.sh
+source /opt/ic/bin/functions.sh
+
 SHELL="/bin/bash"
 PATH="/sbin:/bin:/usr/sbin:/usr/bin"
 
-CONFIG="${CONFIG:=/var/ic/config/config.ini}"
-DEPLOYMENT="${DEPLOYMENT:=/data/deployment.json}"
-
-function read_variables() {
-    # Read limited set of keys. Be extra-careful quoting values as it could
-    # otherwise lead to executing arbitrary shell code!
-    while IFS="=" read -r key value; do
-        case "$key" in
-            "ipv6_prefix") ipv6_prefix="${value}" ;;
-            "ipv6_gateway") ipv6_gateway="${value}" ;;
-            "ipv4_address") ipv4_address="${value}" ;;
-            "ipv4_prefix_length") ipv4_prefix_length="${value}" ;;
-            "ipv4_gateway") ipv4_gateway="${value}" ;;
-            "domain") domain="${value}" ;;
-        esac
-    done <"${CONFIG}"
+function read_config_variables() {
+    ipv6_prefix=$(get_config_value '.network_settings.ipv6_prefix')
+    ipv6_gateway=$(get_config_value '.network_settings.ipv6_gateway')
+    ipv4_address=$(get_config_value '.network_settings.ipv4_address')
+    ipv4_prefix_length=$(get_config_value '.network_settings.ipv4_prefix_length')
+    ipv4_gateway=$(get_config_value '.network_settings.ipv4_gateway')
+    domain=$(get_config_value '.network_settings.domain')
 }
 
 # WARNING: Uses 'eval' for command execution.
@@ -168,45 +162,36 @@ function ping_ipv6_gateway() {
     echo " "
 }
 
-function assemble_nns_nodes_list() {
-    NNS_URL_STRING=$(/opt/ic/bin/fetch-property.sh --key=.nns.url --config=${DEPLOYMENT})
-    NNS_URL_LIST=$(echo $NNS_URL_STRING | sed 's@,@ @g')
-}
-
 function query_nns_nodes() {
     echo "* Querying NNS nodes..."
 
-    i=0
-    success=0
-    nodes=$(echo ${NNS_URL_LIST} | wc -w)
-    # At least one of the provided URLs needs to work.
-    verify=1
-    for url in $(echo $NNS_URL_LIST); do
+    local nns_urls=($(get_config_value '.icos_settings.nns_urls' | jq -r '.[]'))
+    local success=false
+
+    for url in "${nns_urls[@]}"; do
         # When running against testnets, we need to ignore self signed certs
         # with `--insecure`. This check is only meant to confirm from SetupOS
         # that NNS urls are reachable, so we do not mind that it is "weak".
-        curl --insecure --head --connect-timeout 3 --silent ${url} >/dev/null 2>&1
-        if [ "${?}" -ne 0 ]; then
-            echo "  fail: ${url}"
-        else
+        if curl --insecure --head --connect-timeout 3 --silent "${url}" >/dev/null 2>&1; then
             echo "  okay: ${url}"
-            success=$((${success} + 1))
-        fi
-        i=$((${i} + 1))
-        if [ ${success} -ge ${verify} ]; then
-            echo "  success"
+            success=true
             break
-        elif [ ${i} -eq ${nodes} ]; then
-            log_and_halt_installation_on_error "1" "Unable to query enough healthy NNS nodes."
+        else
+            echo "  fail: ${url}"
         fi
     done
+
+    if $success; then
+        echo "  success"
+    else
+        log_and_halt_installation_on_error "1" "Unable to query enough healthy NNS nodes."
+    fi
 }
 
 # Establish run order
 main() {
-    source /opt/ic/bin/functions.sh
     log_start "$(basename $0)"
-    read_variables
+    read_config_variables
     get_network_settings
     print_network_settings
 
@@ -217,7 +202,6 @@ main() {
     fi
 
     ping_ipv6_gateway
-    assemble_nns_nodes_list
     query_nns_nodes
     log_end "$(basename $0)"
 }

ic-os/components/setupos-scripts/config.service

@@ -6,9 +6,9 @@ Before=setupos.service
 [Service]
 Type=oneshot
 RemainAfterExit=true
-ExecStart=/opt/ic/bin/output-wrapper.sh /dev/ttyS0 /opt/ic/bin/config.sh
-StandardOutput=tty
-StandardError=tty
+ExecStart=/opt/ic/bin/config create-setupos-config
+StandardOutput=journal+console
+StandardError=journal+console
 
 [Install]
 WantedBy=multi-user.target

ic-os/components/setupos-scripts/functions.sh

@@ -23,7 +23,7 @@ function log_and_halt_installation_on_error() {
             echo "                                     ERROR"
             echo "--------------------------------------------------------------------------------"
             echo -e "\n\n"
-            echo "${log_message}"
+            echo -e "${log_message}"
             echo -e "\n\n"
             echo "--------------------------------------------------------------------------------"
             echo "                                     ERROR"

ic-os/components/setupos-scripts/install-guestos.sh

@@ -3,6 +3,8 @@
 set -o nounset
 set -o pipefail
 
+source /opt/ic/bin/functions.sh
+
 SHELL="/bin/bash"
 PATH="/sbin:/bin:/usr/sbin:/usr/bin"
 
@@ -34,7 +36,6 @@ function install_guestos() {
 
 # Establish run order
 main() {
-    source /opt/ic/bin/functions.sh
     log_start "$(basename $0)"
     install_guestos
     log_end "$(basename $0)"

ic-os/components/setupos-scripts/install-hostos.sh

@@ -3,6 +3,8 @@
 set -o nounset
 set -o pipefail
 
+source /opt/ic/bin/functions.sh
+
 SHELL="/bin/bash"
 PATH="/sbin:/bin:/usr/sbin:/usr/bin"
 
@@ -101,7 +103,6 @@ function resize_partition() {
 
 # Establish run order
 main() {
-    source /opt/ic/bin/functions.sh
     log_start "$(basename $0)"
     install_hostos
     configure_efi

ic-os/components/setupos-scripts/setup-disk.sh

@@ -3,6 +3,8 @@
 set -o nounset
 set -o pipefail
 
+source /opt/ic/bin/functions.sh
+
 SHELL="/bin/bash"
 PATH="/sbin:/bin:/usr/sbin:/usr/bin"
 
@@ -60,7 +62,6 @@ function setup_storage() {
 
 # Establish run order
 main() {
-    source /opt/ic/bin/functions.sh
     log_start "$(basename $0)"
     purge_partitions
     setup_storage