Store user settings (#1)

* Store user settings in metrics

* Avoid printing user settings values

* Replace variables in config file

* Add metrics config to volumes

* Add import config to chain

* Keep static configs

Author: dappnodedev

docker-compose.yml

@@ -39,8 +39,11 @@ services:
       PUSHGATEWAY_URL: "https://keyperingest.metrics.shutter.network/api/v1/write"
       PUSHGATEWAY_USERNAME: ""
       PUSHGATEWAY_PASSWORD: ""
+    volumes:
+      - metrics-config:/config
 
 volumes:
   db_data: {}
   chain: {}
   keyper-config: {}
+  metrics-config: {}

metrics/Dockerfile

@@ -9,11 +9,14 @@ FROM victoriametrics/vmagent:v1.101.0
 ARG NETWORK
 
 ENV ASSETS_DIR=/assets \
+    TEMPLATE_CONFIG_FILE=/config/${NETWORK}/vmagent_template.yml \
     CONFIG_FILE=/config/${NETWORK}/vmagent.yml \
     USER_SETTINGS_FILE=/config/user/settings.env
 
 COPY --from=assets ${ASSETS_DIR}/ ${ASSETS_DIR}/
 COPY config/ /config/
 COPY entrypoint.sh /usr/local/bin/entrypoint.sh
 
+RUN mkdir -p $(dirname ${USER_SETTINGS_FILE})
+
 ENTRYPOINT [ "entrypoint.sh" ]

metrics/config/gnosis/vmagent.yml …trics/config/gnosis/vmagent_template.ymlmetrics/config/gnosis/vmagent.yml renamed to metrics/config/gnosis/vmagent_template.yml metrics/config/gnosis/vmagent.yml renamed to metrics/config/gnosis/vmagent_template.yml

@@ -1,31 +1,40 @@
 #!/bin/sh
 
 update_user_settings() {
-    key=$1
-    value=$(eval echo \$$key)
+
+    keys="KEYPER_NAME PUSHGATEWAY_URL PUSHGATEWAY_USERNAME PUSHGATEWAY_PASSWORD"
 
     if [ ! -f "$USER_SETTINGS_FILE" ]; then
         touch "$USER_SETTINGS_FILE"
     fi
 
+    for key in $keys; do
+        update_user_setting "$key" "$(eval echo \$"$key")"
+    done
+}
+
+update_user_setting() {
+    key=$1
+    value=$(eval echo \$"$key")
+
     if [ -z "$value" ]; then
         echo "[INFO | metrics] Skipped updating $key in user settings file (empty value)"
         return 1
     fi
 
     if grep -q "^$key=" "$USER_SETTINGS_FILE"; then
         # Update the existing key
-        sed -i "s/^$key=.*/$key=$value/" "$USER_SETTINGS_FILE"
-        echo "[INFO | metrics] Updated $key to $value in $USER_SETTINGS_FILE"
+        sed -i "s|^$key=.*|$key=$value|" "$USER_SETTINGS_FILE"
+        echo "[INFO | metrics] Updated $key in $USER_SETTINGS_FILE"
     else
         # Add the new key
         echo "$key=$value" >>"$USER_SETTINGS_FILE"
-        echo "[INFO | metrics] Added $key=$value to $USER_SETTINGS_FILE"
+        echo "[INFO | metrics] Added $key to $USER_SETTINGS_FILE"
     fi
 }
 
 source_envs() {
-    set -a
+    set -a # Export all variables
 
     # shellcheck disable=SC1091
     if [ -f "${ASSETS_DIR}/variables.env" ]; then
@@ -46,14 +55,12 @@ source_envs() {
     set +a
 }
 
-# Create an empty JSON file in path USER_SETTINGS_FILE if it does not exist
-if [ ! -f "${USER_SETTINGS_FILE}" ]; then
-    echo "{}" >"${USER_SETTINGS_FILE}"
-fi
+replace_envs_in_yaml() {
+    echo "[INFO | metrics] Replacing environment variables in the configuration file"
+    sed "s|%{KEYPER_NAME}|$KEYPER_NAME|g; s|%{_ASSETS_VERSION}|$_ASSETS_VERSION|g" "$TEMPLATE_CONFIG_FILE" >"$CONFIG_FILE"
+}
 
-update_user_settings "PUSHGATEWAY_URL" "${PUSHGATEWAY_URL}"
-update_user_settings "PUSHGATEWAY_USERNAME" "${PUSHGATEWAY_USERNAME}"
-update_user_settings "PUSHGATEWAY_PASSWORD" "${PUSHGATEWAY_PASSWORD}"
+update_user_settings
 
 if [ "${SHUTTER_PUSH_METRICS_ENABLED}" = "false" ]; then
     echo "[INFO | metrics] Metrics push is disabled"
@@ -62,6 +69,8 @@ fi
 
 source_envs
 
+replace_envs_in_yaml
+
 exec /vmagent-prod \
     -promscrape.config="${CONFIG_FILE}" \
     -remoteWrite.url="${PUSHGATEWAY_URL}" \

metrics/entrypoint.sh

@@ -18,7 +18,7 @@ fields:
       type: environment
       name: SHUTTER_GNOSIS_NODE_PRIVATEKEY
       service: shutter
-    required: true
+    required: false
     secret: true
 
   - id: enable_push_metrics

setup-wizard.yml

@@ -29,7 +29,7 @@ ENV SHUTTER_GNOSIS_SM_BLOCKTIME=10 \
     CHAIN_LISTEN_PORT=26657 \
     SHUTTER_BIN=/rolling-shutter \
     SHUTTER_ENV_FILE=/shutter.env \
-    SHUTTER_GENERATED_CONFIG_FILE=${KEYPER_CONFIG_DIR}/generated.toml \
+    KEYPER_GENERATED_CONFIG_FILE=${KEYPER_CONFIG_DIR}/generated.toml \
     KEYPER_CONFIG_FILE=${KEYPER_CONFIG_DIR}/keyper.toml \
     SHUTTER_CHAIN_DIR=${SHUTTER_CHAIN_DIR} \
     SHUTTER_CHAIN_CONFIG_FILE=${SHUTTER_CHAIN_DIR}/config/config.toml \

shutter/Dockerfile

@@ -1,16 +1,24 @@
 #!/bin/bash
 
+check_assets() {
+    # shellcheck disable=SC1091
+    if [[ ! -f ${ASSETS_DIR}/variables.env ]]; then
+        echo "[ERROR | configure] Missing variables file (${ASSETS_DIR}/variables)"
+        exit 1
+    fi
+}
+
 generate_keyper_config() {
 
     # Check if the configuration file already exists
-    if [ -f "$SHUTTER_GENERATED_CONFIG_FILE" ]; then
+    if [ -f "$KEYPER_GENERATED_CONFIG_FILE" ]; then
         echo "[INFO | configure] Configuration file already exists. Skipping generation..."
         return
     fi
 
     echo "[INFO | configure] Generating configuration files..."
 
-    $SHUTTER_BIN gnosiskeyper generate-config --output "$SHUTTER_GENERATED_CONFIG_FILE"
+    $SHUTTER_BIN gnosiskeyper generate-config --output "$KEYPER_GENERATED_CONFIG_FILE"
 }
 
 init_keyper_db() {
@@ -23,7 +31,7 @@ init_keyper_db() {
 
     echo "[INFO | configure] Initializing keyper database..."
 
-    $SHUTTER_BIN gnosiskeyper initdb --config "$SHUTTER_GENERATED_CONFIG_FILE"
+    $SHUTTER_BIN gnosiskeyper initdb --config "$KEYPER_GENERATED_CONFIG_FILE"
 }
 
 init_chain() {
@@ -61,6 +69,8 @@ trigger_keyper_start() {
     supervisorctl start keyper
 }
 
+check_assets
+
 generate_keyper_config
 
 init_keyper_db

shutter/scripts/configure.sh

@@ -1,65 +1,63 @@
 #!/bin/bash
 
-set -eu
-
-# shellcheck disable=SC1091
-if [[ -f ${ASSETS_DIR}/variables.env ]]; then
-    . "${ASSETS_DIR}/variables.env"
-else
-    echo "[ERROR | configure] Missing variables file (${ASSETS_DIR}/variables)"
-    exit 1
-fi
-
-if [ ! -f "$SHUTTER_GENERATED_CONFIG_FILE" ]; then
-    echo "[ERROR | configure] Missing generated configuration file (${SHUTTER_GENERATED_CONFIG_FILE})"
-    exit 1
-fi
-
-echo "[INFO | configure] Generating keyper configuration file..."
-
-# Copy if keyper configuration file does not exist
-if [ ! -f "$KEYPER_CONFIG_FILE" ]; then
-    cp "$SHUTTER_GENERATED_CONFIG_FILE" "$KEYPER_CONFIG_FILE"
-fi
-
-echo "[INFO | configure] Calculating keyper configuration values..."
-
 # To use staker scripts
 # shellcheck disable=SC1091
 . /etc/profile
+# shellcheck disable=SC1091
+. "${ASSETS_DIR}/variables.env"
+
+echo "[INFO | configure] Calculating keyper configuration values..."
 
 SUPPORTED_NETWORKS="gnosis"
 
 SHUTTER_P2P_ADVERTISEADDRESSES="/ip4/${_DAPPNODE_GLOBAL_PUBLIC_IP}/tcp/23003"
 SHUTTER_BEACONAPIURL=$(get_beacon_api_url_from_global_env "$NETWORK" "$SUPPORTED_NETWORKS")
 SHUTTER_GNOSIS_NODE_CONTRACTSURL=http://execution.gnosis.dncore.dappnode:8545
 SHUTTER_GNOSIS_NODE_ETHEREUMURL=$(get_execution_ws_url_from_global_env "$NETWORK" "$SUPPORTED_NETWORKS")
+VALIDATOR_PUBLIC_KEY=$(cat "${SHUTTER_CHAIN_DIR}/config/priv_validator_pubkey.hex")
 
-# TODO: Update script with upstream version
+# Check if the keyper configuration file already exists
+if [ -f "$KEYPER_CONFIG_FILE" ]; then
+    echo "[INFO | configure] Keyper configuration file already exists"
+else
+    echo "[INFO | configure] Generating configuration files..."
+
+    if [ ! -f "$KEYPER_GENERATED_CONFIG_FILE" ]; then
+        echo "[ERROR | configure] Missing generated configuration file (${KEYPER_GENERATED_CONFIG_FILE})"
+        exit 1
+    fi
+
+    cp "$KEYPER_GENERATED_CONFIG_FILE" "$KEYPER_CONFIG_FILE"
+
+    echo "[INFO | configure] Keyper configuration file created"
+    echo "[INFO | configure] Setting private key in the configuration file..."
+    sed -i "/^PrivateKey/c\PrivateKey = \"${SHUTTER_GNOSIS_NODE_PRIVATEKEY}\"" "$KEYPER_CONFIG_FILE"
+fi
 
-# Values set from assets container and compose env varibles
+# Assets values
 sed -i "/^InstanceID/c\InstanceID = ${_ASSETS_INSTANCE_ID}" "$KEYPER_CONFIG_FILE"
-sed -i "/^DatabaseURL/c\DatabaseURL = \"${SHUTTER_DATABASEURL}\"" "$KEYPER_CONFIG_FILE"
-sed -i "/^BeaconAPIURL/c\BeaconAPIURL = \"${SHUTTER_BEACONAPIURL}\"" "$KEYPER_CONFIG_FILE"
 sed -i "/^MaxNumKeysPerMessage/c\MaxNumKeysPerMessage = ${_ASSETS_MAX_NUM_KEYS_PER_MESSAGE}" "$KEYPER_CONFIG_FILE"
 sed -i "/^EncryptedGasLimit/c\EncryptedGasLimit = ${_ASSETS_ENCRYPTED_GAS_LIMIT}" "$KEYPER_CONFIG_FILE"
-sed -i "/^MaxTxPointerAge/c\MaxTxPointerAge = ${SHUTTER_GNOSIS_MAXTXPOINTERAGE}" "$KEYPER_CONFIG_FILE"
 sed -i "/^GenesisSlotTimestamp/c\GenesisSlotTimestamp = ${_ASSETS_GENESIS_SLOT_TIMESTAMP}" "$KEYPER_CONFIG_FILE"
 sed -i "/^SyncStartBlockNumber/c\SyncStartBlockNumber = ${_ASSETS_SYNC_START_BLOCK_NUMBER}" "$KEYPER_CONFIG_FILE"
-sed -i "/^PrivateKey/c\PrivateKey = \"${SHUTTER_GNOSIS_NODE_PRIVATEKEY}\"" "$KEYPER_CONFIG_FILE"
-sed -i "/^ContractsURL/c\ContractsURL = \"${SHUTTER_GNOSIS_NODE_CONTRACTSURL}\"" "$KEYPER_CONFIG_FILE"
-sed -i "/^DeploymentDir/c\DeploymentDir = \"\" # unused" "$KEYPER_CONFIG_FILE"
-sed -i "/^EthereumURL/c\EthereumURL = \"${SHUTTER_GNOSIS_NODE_ETHEREUMURL}\"" "$KEYPER_CONFIG_FILE"
 sed -i "/^KeyperSetManager/c\KeyperSetManager = \"${_ASSETS_KEYPER_SET_MANAGER}\"" "$KEYPER_CONFIG_FILE"
 sed -i "/^KeyBroadcastContract/c\KeyBroadcastContract = \"${_ASSETS_KEY_BROADCAST_CONTRACT}\"" "$KEYPER_CONFIG_FILE"
 sed -i "/^Sequencer/c\Sequencer = \"${_ASSETS_SEQUENCER}\"" "$KEYPER_CONFIG_FILE"
 sed -i "/^ValidatorRegistry/c\ValidatorRegistry = \"${_ASSETS_VALIDATOR_REGISTRY}\"" "$KEYPER_CONFIG_FILE"
 sed -i "/^DiscoveryNamespace/c\DiscoveryNamespace = \"${_ASSETS_DISCOVERY_NAME_PREFIX}-${_ASSETS_INSTANCE_ID}\"" "$KEYPER_CONFIG_FILE"
-sed -i "/^ShuttermintURL/c\ShuttermintURL = \"${SHUTTER_SHUTTERMINT_SHUTTERMINTURL}\"" "$KEYPER_CONFIG_FILE"
-sed -i "/^ValidatorPublicKey/c\ValidatorPublicKey = \"$(cat "${SHUTTER_CHAIN_DIR}/config/priv_validator_pubkey.hex")\"" "$KEYPER_CONFIG_FILE"
-sed -i "/^ListenAddresses/c\ListenAddresses = \"${SHUTTER_P2P_LISTENADDRESSES}\"" "$KEYPER_CONFIG_FILE"
-sed -i "/^AdvertiseAddresses/c\AdvertiseAddresses = \"${SHUTTER_P2P_ADVERTISEADDRESSES}\"" "$KEYPER_CONFIG_FILE"
 sed -i "/^CustomBootstrapAddresses/c\CustomBootstrapAddresses = ${_ASSETS_CUSTOM_BOOTSTRAP_ADDRESSES}" "$KEYPER_CONFIG_FILE"
 sed -i "/^DKGPhaseLength/c\DKGPhaseLength = ${_ASSETS_DKG_PHASE_LENGTH}" "$KEYPER_CONFIG_FILE"
 sed -i "/^DKGStartBlockDelta/c\DKGStartBlockDelta = ${_ASSETS_DKG_START_BLOCK_DELTA}" "$KEYPER_CONFIG_FILE"
-sed -i "/^Enabled/c\Enabled = ${SHUTTER_PUSH_METRICS_ENABLED}" "$KEYPER_CONFIG_FILE"
+
+# Dynamic values (regenerated on each start)
+sed -i "/^DatabaseURL/c\DatabaseURL = \"${SHUTTER_DATABASEURL}\"" "$KEYPER_CONFIG_FILE"
+sed -i "/^BeaconAPIURL/c\BeaconAPIURL = \"${SHUTTER_BEACONAPIURL}\"" "$KEYPER_CONFIG_FILE"
+sed -i "/^ContractsURL/c\ContractsURL = \"${SHUTTER_GNOSIS_NODE_CONTRACTSURL}\"" "$KEYPER_CONFIG_FILE"
+sed -i "/^MaxTxPointerAge/c\MaxTxPointerAge = ${SHUTTER_GNOSIS_MAXTXPOINTERAGE}" "$KEYPER_CONFIG_FILE"
+sed -i "/^DeploymentDir/c\DeploymentDir = \"\" # unused" "$KEYPER_CONFIG_FILE"
+sed -i "/^EthereumURL/c\EthereumURL = \"${SHUTTER_GNOSIS_NODE_ETHEREUMURL}\"" "$KEYPER_CONFIG_FILE"
+sed -i "/^ShuttermintURL/c\ShuttermintURL = \"${SHUTTER_SHUTTERMINT_SHUTTERMINTURL}\"" "$KEYPER_CONFIG_FILE"
+sed -i "/^ListenAddresses/c\ListenAddresses = \"${SHUTTER_P2P_LISTENADDRESSES}\"" "$KEYPER_CONFIG_FILE"
+sed -i "/^AdvertiseAddresses/c\AdvertiseAddresses = \"${SHUTTER_P2P_ADVERTISEADDRESSES}\"" "$KEYPER_CONFIG_FILE"
+sed -i "/^ValidatorPublicKey/c\ValidatorPublicKey = \"${VALIDATOR_PUBLIC_KEY}\"" "$KEYPER_CONFIG_FILE"
+sed -i "/^Enabled/c\Enabled = true" "$KEYPER_CONFIG_FILE"

shutter/scripts/configure_keyper.sh

@@ -1,23 +1,19 @@
 #!/bin/bash
 
-set -eux
-
 # shellcheck disable=SC1091
-if [[ -f ${ASSETS_DIR}/variables.env ]]; then
-    . "${ASSETS_DIR}/variables.env"
-else
-    echo "[ERROR | configure] Missing variables file (${ASSETS_DIR}/variables)"
-    exit 1
-fi
+. "${ASSETS_DIR}/variables.env"
+
+ASSETS_GENESIS_FILE="/assets/genesis.json"
+CHAIN_GENESIS_FILE="${SHUTTER_CHAIN_DIR}/config/genesis.json"
 
-rm "${SHUTTER_CHAIN_DIR}/config/genesis.json"
-ln -s /assets/genesis.json "${SHUTTER_CHAIN_DIR}/config/genesis.json"
+rm "$CHAIN_GENESIS_FILE"
+ln -s "$ASSETS_GENESIS_FILE" "$CHAIN_GENESIS_FILE"
 
 SHUTTERMINT_MONIKER=${KEYPER_NAME:-$(openssl rand -hex 8)}
 
 sed -i "/^seeds =/c\seeds = \"${_ASSETS_SHUTTERMINT_SEED_NODES}\"" "$SHUTTER_CHAIN_CONFIG_FILE"
 sed -i "/^moniker =/c\moniker = \"${SHUTTERMINT_MONIKER}\"" "$SHUTTER_CHAIN_CONFIG_FILE"
-sed -i "/^genesis_file =/c\genesis_file = \"/assets/genesis.json\"" "$SHUTTER_CHAIN_CONFIG_FILE"
+sed -i "/^genesis_file =/c\genesis_file = \"${ASSETS_GENESIS_FILE}\"" "$SHUTTER_CHAIN_CONFIG_FILE"
 sed -i "/^external_address =/c\external_address = \"${_DAPPNODE_GLOBAL_PUBLIC_IP}:${CHAIN_PORT}\"" "$SHUTTER_CHAIN_CONFIG_FILE"
 sed -i "/^addr_book_strict =/c\addr_book_strict = true" "$SHUTTER_CHAIN_CONFIG_FILE"
 sed -i "/^pex =/c\pex = true" "$SHUTTER_CHAIN_CONFIG_FILE"