From f55a14bd6cb6d00c422ef07a09a86b7c91af9e38 Mon Sep 17 00:00:00 2001 From: Thomas E Lackey Date: Tue, 22 Aug 2023 13:32:45 -0500 Subject: [PATCH] Create new base container for pre-compiled webapps. (#507) * Create new base container for pre-compiled webapps. * Set the webapp dir appropriately. --- ...ker-compose-fixturenet-laconic-console.yml | 1 + .../cerc-laconic-console-host/Dockerfile | 58 +------------------ .../start-serving-app.sh | 8 --- .../cerc-webapp-base/Dockerfile | 57 ++++++++++++++++++ .../apply-webapp-config.sh | 2 +- .../container-build/cerc-webapp-base/build.sh | 9 +++ .../cerc-webapp-base/config.yml | 1 + .../cerc-webapp-base/start-serving-app.sh | 9 +++ app/data/container-image-list.txt | 1 + .../fixturenet-laconic-loaded/stack.yml | 1 + app/data/stacks/mainnet-laconic/stack.yml | 1 + 11 files changed, 83 insertions(+), 65 deletions(-) delete mode 100755 app/data/container-build/cerc-laconic-console-host/start-serving-app.sh create mode 100644 app/data/container-build/cerc-webapp-base/Dockerfile rename app/data/container-build/{cerc-laconic-console-host => cerc-webapp-base}/apply-webapp-config.sh (89%) create mode 100755 app/data/container-build/cerc-webapp-base/build.sh create mode 100644 app/data/container-build/cerc-webapp-base/config.yml create mode 100755 app/data/container-build/cerc-webapp-base/start-serving-app.sh diff --git a/app/data/compose/docker-compose-fixturenet-laconic-console.yml b/app/data/compose/docker-compose-fixturenet-laconic-console.yml index 23185957..da2fd95f 100644 --- a/app/data/compose/docker-compose-fixturenet-laconic-console.yml +++ b/app/data/compose/docker-compose-fixturenet-laconic-console.yml @@ -3,6 +3,7 @@ services: restart: unless-stopped image: cerc/laconic-console-host:local environment: + - CERC_WEBAPP_FILES_DIR=${CERC_WEBAPP_FILES_DIR:-/usr/local/share/.config/yarn/global/node_modules/@cerc-io/console-app/dist/production} - LACONIC_HOSTED_ENDPOINT=${LACONIC_HOSTED_ENDPOINT:-http://localhost} ports: - "80" diff --git a/app/data/container-build/cerc-laconic-console-host/Dockerfile b/app/data/container-build/cerc-laconic-console-host/Dockerfile index 7e3fc46b..95ddff94 100644 --- a/app/data/container-build/cerc-laconic-console-host/Dockerfile +++ b/app/data/container-build/cerc-laconic-console-host/Dockerfile @@ -1,69 +1,15 @@ -# Originally from: https://github.com/devcontainers/images/blob/main/src/javascript-node/.devcontainer/Dockerfile -# [Choice] Node.js version (use -bullseye variants on local arm64/Apple Silicon): 18, 16, 14, 18-bullseye, 16-bullseye, 14-bullseye, 18-buster, 16-buster, 14-buster -ARG VARIANT=18-bullseye -FROM node:${VARIANT} - -ARG USERNAME=node -ARG NPM_GLOBAL=/usr/local/share/npm-global +FROM cerc/webapp-base:local # This container pulls npm packages from a local registry configured via these env vars ARG CERC_NPM_REGISTRY_URL ARG CERC_NPM_AUTH_TOKEN -# Add NPM global to PATH. -ENV PATH=${NPM_GLOBAL}/bin:${PATH} -# Prevents npm from printing version warnings -ENV NPM_CONFIG_UPDATE_NOTIFIER=false - -RUN \ - # Configure global npm install location, use group to adapt to UID/GID changes - if ! cat /etc/group | grep -e "^npm:" > /dev/null 2>&1; then groupadd -r npm; fi \ - && usermod -a -G npm ${USERNAME} \ - && umask 0002 \ - && mkdir -p ${NPM_GLOBAL} \ - && touch /usr/local/etc/npmrc \ - && chown ${USERNAME}:npm ${NPM_GLOBAL} /usr/local/etc/npmrc \ - && chmod g+s ${NPM_GLOBAL} \ - && npm config -g set prefix ${NPM_GLOBAL} \ - && su ${USERNAME} -c "npm config -g set prefix ${NPM_GLOBAL}" \ - # Install eslint - && su ${USERNAME} -c "umask 0002 && npm install -g eslint" \ - && npm cache clean --force > /dev/null 2>&1 - -# [Optional] Uncomment this section to install additional OS packages. -RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \ - && apt-get -y install --no-install-recommends jq - -# [Optional] Uncomment if you want to install an additional version of node using nvm -# ARG EXTRA_NODE_VERSION=10 -# RUN su node -c "source /usr/local/share/nvm/nvm.sh && nvm install ${EXTRA_NODE_VERSION}" - -# We do this to get a yq binary from the published container, for the correct architecture we're building here -COPY --from=docker.io/mikefarah/yq:latest /usr/bin/yq /usr/local/bin/yq - -RUN mkdir -p /scripts -COPY ./apply-webapp-config.sh /scripts -COPY ./start-serving-app.sh /scripts - -# [Optional] Uncomment if you want to install more global node modules -# RUN su node -c "npm install -g " - # Configure the local npm registry RUN npm config set @cerc-io:registry ${CERC_NPM_REGISTRY_URL} \ && npm config set @lirewine:registry ${CERC_NPM_REGISTRY_URL} \ && npm config set -- ${CERC_NPM_REGISTRY_URL}:_authToken ${CERC_NPM_AUTH_TOKEN} -RUN mkdir -p /config -COPY ./config.yml /config - -# Install simple web server for now (use nginx perhaps later) -RUN yarn global add http-server - # Globally install the payload web app package RUN yarn global add @cerc-io/console-app -# Expose port for http -EXPOSE 80 - -# Default command sleeps forever so docker doesn't kill it -CMD ["/scripts/start-serving-app.sh"] +COPY ./config.yml /config diff --git a/app/data/container-build/cerc-laconic-console-host/start-serving-app.sh b/app/data/container-build/cerc-laconic-console-host/start-serving-app.sh deleted file mode 100755 index a322e5fb..00000000 --- a/app/data/container-build/cerc-laconic-console-host/start-serving-app.sh +++ /dev/null @@ -1,8 +0,0 @@ -#!/usr/bin/env bash -if [ -n "$CERC_SCRIPT_DEBUG" ]; then - set -x -fi -# TODO: Don't hard wire this: -webapp_files_dir=/usr/local/share/.config/yarn/global/node_modules/@cerc-io/console-app/dist/production -/scripts/apply-webapp-config.sh /config/config.yml ${webapp_files_dir} -http-server -p 80 ${webapp_files_dir} diff --git a/app/data/container-build/cerc-webapp-base/Dockerfile b/app/data/container-build/cerc-webapp-base/Dockerfile new file mode 100644 index 00000000..275a5c3c --- /dev/null +++ b/app/data/container-build/cerc-webapp-base/Dockerfile @@ -0,0 +1,57 @@ +# Originally from: https://github.com/devcontainers/images/blob/main/src/javascript-node/.devcontainer/Dockerfile +# [Choice] Node.js version (use -bullseye variants on local arm64/Apple Silicon): 18, 16, 14, 18-bullseye, 16-bullseye, 14-bullseye, 18-buster, 16-buster, 14-buster +ARG VARIANT=18-bullseye +FROM node:${VARIANT} + +ARG USERNAME=node +ARG NPM_GLOBAL=/usr/local/share/npm-global + +# Add NPM global to PATH. +ENV PATH=${NPM_GLOBAL}/bin:${PATH} +# Prevents npm from printing version warnings +ENV NPM_CONFIG_UPDATE_NOTIFIER=false + +RUN \ + # Configure global npm install location, use group to adapt to UID/GID changes + if ! cat /etc/group | grep -e "^npm:" > /dev/null 2>&1; then groupadd -r npm; fi \ + && usermod -a -G npm ${USERNAME} \ + && umask 0002 \ + && mkdir -p ${NPM_GLOBAL} \ + && touch /usr/local/etc/npmrc \ + && chown ${USERNAME}:npm ${NPM_GLOBAL} /usr/local/etc/npmrc \ + && chmod g+s ${NPM_GLOBAL} \ + && npm config -g set prefix ${NPM_GLOBAL} \ + && su ${USERNAME} -c "npm config -g set prefix ${NPM_GLOBAL}" \ + # Install eslint + && su ${USERNAME} -c "umask 0002 && npm install -g eslint" \ + && npm cache clean --force > /dev/null 2>&1 + +# [Optional] Uncomment this section to install additional OS packages. +RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \ + && apt-get -y install --no-install-recommends jq + +# [Optional] Uncomment if you want to install an additional version of node using nvm +# ARG EXTRA_NODE_VERSION=10 +# RUN su node -c "source /usr/local/share/nvm/nvm.sh && nvm install ${EXTRA_NODE_VERSION}" + +# We do this to get a yq binary from the published container, for the correct architecture we're building here +COPY --from=docker.io/mikefarah/yq:latest /usr/bin/yq /usr/local/bin/yq + +RUN mkdir -p /scripts +COPY ./apply-webapp-config.sh /scripts +COPY ./start-serving-app.sh /scripts + +# [Optional] Uncomment if you want to install more global node modules +# RUN su node -c "npm install -g " + +RUN mkdir -p /config +COPY ./config.yml /config + +# Install simple web server for now (use nginx perhaps later) +RUN yarn global add http-server + +# Expose port for http +EXPOSE 80 + +# Default command sleeps forever so docker doesn't kill it +CMD ["/scripts/start-serving-app.sh"] diff --git a/app/data/container-build/cerc-laconic-console-host/apply-webapp-config.sh b/app/data/container-build/cerc-webapp-base/apply-webapp-config.sh similarity index 89% rename from app/data/container-build/cerc-laconic-console-host/apply-webapp-config.sh rename to app/data/container-build/cerc-webapp-base/apply-webapp-config.sh index bf041708..6d366805 100755 --- a/app/data/container-build/cerc-laconic-console-host/apply-webapp-config.sh +++ b/app/data/container-build/cerc-webapp-base/apply-webapp-config.sh @@ -18,7 +18,7 @@ if ! [[ -d ${webapp_files_dir} ]]; then fi # First some magic using yq to translate our yaml config file into an array of key value pairs like: # LACONIC_HOSTED_CONFIG_= -readarray -t config_kv_pair_array < <( yq '.. | select(length > 2) | ([path | join("_"), .] | join("=") )' ${config_file_name} | sed 's/^/LACONIC_HOSTED_CONFIG_/' ) +readarray -t config_kv_pair_array < <( yq '.. | ([path | join("_"), .] | join("=") )' ${config_file_name} | sort -r | sed -e '$ d' | sed 's/^/LACONIC_HOSTED_CONFIG_/' ) declare -p config_kv_pair_array # Then iterate over that kv array making the template substitution in our web app files for kv_pair_string in "${config_kv_pair_array[@]}" diff --git a/app/data/container-build/cerc-webapp-base/build.sh b/app/data/container-build/cerc-webapp-base/build.sh new file mode 100755 index 00000000..51712dc4 --- /dev/null +++ b/app/data/container-build/cerc-webapp-base/build.sh @@ -0,0 +1,9 @@ +#!/usr/bin/env bash +# Build cerc/laconic-registry-cli + +source ${CERC_CONTAINER_BASE_DIR}/build-base.sh + +# See: https://stackoverflow.com/a/246128/1701505 +SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd ) + +docker build -t cerc/webapp-base:local ${build_command_args} -f ${SCRIPT_DIR}/Dockerfile ${SCRIPT_DIR} diff --git a/app/data/container-build/cerc-webapp-base/config.yml b/app/data/container-build/cerc-webapp-base/config.yml new file mode 100644 index 00000000..c69b6752 --- /dev/null +++ b/app/data/container-build/cerc-webapp-base/config.yml @@ -0,0 +1 @@ +# Put config here. diff --git a/app/data/container-build/cerc-webapp-base/start-serving-app.sh b/app/data/container-build/cerc-webapp-base/start-serving-app.sh new file mode 100755 index 00000000..69fa6c22 --- /dev/null +++ b/app/data/container-build/cerc-webapp-base/start-serving-app.sh @@ -0,0 +1,9 @@ +#!/usr/bin/env bash +if [ -n "$CERC_SCRIPT_DEBUG" ]; then + set -x +fi + +CERC_WEBAPP_FILES_DIR="${CERC_WEBAPP_FILES_DIR:-/data}" + +/scripts/apply-webapp-config.sh /config/config.yml ${CERC_WEBAPP_FILES_DIR} +http-server -p 80 ${CERC_WEBAPP_FILES_DIR} diff --git a/app/data/container-image-list.txt b/app/data/container-image-list.txt index b674baf8..9ed473ba 100644 --- a/app/data/container-image-list.txt +++ b/app/data/container-image-list.txt @@ -49,3 +49,4 @@ cerc/sushiswap-v3-periphery cerc/watcher-sushiswap cerc/graph-node cerc/sushiswap-subgraphs +cerc/webapp-base diff --git a/app/data/stacks/fixturenet-laconic-loaded/stack.yml b/app/data/stacks/fixturenet-laconic-loaded/stack.yml index 3102978a..523a7091 100644 --- a/app/data/stacks/fixturenet-laconic-loaded/stack.yml +++ b/app/data/stacks/fixturenet-laconic-loaded/stack.yml @@ -21,6 +21,7 @@ npms: containers: - cerc/laconicd - cerc/laconic-registry-cli + - cerc/webapp-base - cerc/laconic-console-host pods: - fixturenet-laconicd diff --git a/app/data/stacks/mainnet-laconic/stack.yml b/app/data/stacks/mainnet-laconic/stack.yml index 51b0b8a2..e4e6781e 100644 --- a/app/data/stacks/mainnet-laconic/stack.yml +++ b/app/data/stacks/mainnet-laconic/stack.yml @@ -21,6 +21,7 @@ npms: containers: - cerc/laconicd - cerc/laconic-registry-cli + - cerc/webapp-base - cerc/laconic-console-host pods: - mainnet-laconicd