🥇シングルページアプリケーション配布用の Docker イメージ

シングルページアプリケーション (SPA) は、静的な JavaScript ファイルと HTML ファイル、および画像やその他のリソースのセットです。これらは動的に変更されないため、オンラインで公開するのは非常に簡単です。これには、単純な GitHub Pages (narod.ru を含む一部のサービス) から始まり、Amazon S3 のような CDN に至るまで、安価で無料のサービスが多数あります。ただし、別のものが必要でした。

Kubernetes クラスターの一部として実稼働環境で、また SPA が何なのかを知らないバックエンド開発者のマシン上で簡単に起動できるように、SPA を備えた Docker イメージが必要でした。

私は自分自身に次の画像要件を決定しました。

使いやすさ（ただし組み立ては簡単ではありません）。
ディスクとRAMの両方の最小サイズ。
環境変数を使用した構成により、イメージをさまざまな環境で使用できるようになります。
最も効率的なファイルの配布。

今日はその方法を説明します。

腸nginx;
ソースから Brotli をビルドします。
静的ファイルに環境変数を理解できるように教える。
もちろん、これらすべてから Docker イメージを組み立てる方法も説明します。

この記事の目的は、私の経験を共有し、経験豊富なコミュニティメンバーに建設的な批判を促すことです。

アセンブリ用のイメージを構築する

最終的な Docker イメージのサイズを小さくするには、最小限のレイヤーと最小限の基本イメージという XNUMX つのルールに従う必要があります。最小の基本イメージの XNUMX つは Alpine Linux イメージなので、それを選択します。アルピーヌは生産には適さないと主張する人もいるかもしれないが、それは正しいかもしれない。しかし、個人的には、私は彼との間に何の問題もなかったし、彼に対して議論の余地もありません。

レイヤーを少なくするために、画像を 2 段階で組み立てます。 XNUMX つ目はドラフトであり、補助ユーティリティと一時ファイルはすべてドラフトに残ります。そして最終段階では、アプリケーションの最終バージョンのみを書き留めます。

補助画像から始めましょう。

SPA アプリケーションをコンパイルするには、通常、node.js が必要です。公式イメージを使用します。これは、npm および Yarn パッケージマネージャーにも付属しています。私自身の代わりに、いくつかの npm パッケージを構築するために必要な node-gyp と、後で役立つ Google の Brotli コンプレッサーを追加します。

コメント付きの Dockerfile。

# Базовый образ
FROM node:12-alpine
LABEL maintainer="Aleksey Maydokin <[email protected]>"
ENV BROTLI_VERSION 1.0.7
# Пакеты, которые нужны, чтобы собрать из исходников Brotli
RUN apk add --no-cache --virtual .build-deps 
        bash 
        gcc 
        libc-dev 
        make 
        linux-headers 
        cmake 
        curl 
    && mkdir -p /usr/src 
    # Исходники Brotli скачиваем из официального репозитория
    && curl -LSs https://github.com/google/brotli/archive/v$BROTLI_VERSION.tar.gz | tar xzf - -C /usr/src 
    && cd /usr/src/brotli-$BROTLI_VERSION 
    # Компилируем Brotli
    && ./configure-cmake --disable-debug && make -j$(getconf _NPROCESSORS_ONLN) && make install 
    # Добавляем node-gyp
    && yarn global add node-gyp 
    # Убираем за собой мусор
    && apk del .build-deps && yarn cache clean && rm -rf /usr/src

すでにここで私はミニマリズムのために戦っているので、画像はXNUMXつの大きなチームによってまとめられています。

完成したイメージは次の場所にあります。 https://hub.docker.com/r/alexxxnf/spa-builder。ただし、他の人の画像に頼らずに自分の画像を収集することをお勧めします。

nginx

任意の Web サーバーを使用して静的コンテンツを配布できます。 nginx の使用には慣れているので、これからは nginx を使用します。

Nginx には公式の Docker イメージがありますが、単純な静的配布にはモジュールが多すぎます。どのものが配信に含まれているかは、特別チームまたは公式 Dockerfile で確認できます。

$ docker run --rm nginx:1-alpine nginx -V

nginx version: nginx/1.17.9
built by gcc 8.3.0 (Alpine 8.3.0) 
built with OpenSSL 1.1.1d  10 Sep 2019
TLS SNI support enabled
configure arguments: --prefix=/etc/nginx --sbin-path=/usr/sbin/nginx --modules-path=/usr/lib/nginx/modules --conf-path=/etc/nginx/nginx.conf --error-log-path=/var/log/nginx/error.log --http-log-path=/var/log/nginx/access.log --pid-path=/var/run/nginx.pid --lock-path=/var/run/nginx.lock --http-client-body-temp-path=/var/cache/nginx/client_temp --http-proxy-temp-path=/var/cache/nginx/proxy_temp --http-fastcgi-temp-path=/var/cache/nginx/fastcgi_temp --http-uwsgi-temp-path=/var/cache/nginx/uwsgi_temp --http-scgi-temp-path=/var/cache/nginx/scgi_temp --with-perl_modules_path=/usr/lib/perl5/vendor_perl --user=nginx --group=nginx --with-compat --with-file-aio --with-threads --with-http_addition_module --with-http_auth_request_module --with-http_dav_module --with-http_flv_module --with-http_gunzip_module --with-http_gzip_static_module --with-http_mp4_module --with-http_random_index_module --with-http_realip_module --with-http_secure_link_module --with-http_slice_module --with-http_ssl_module --with-http_stub_status_module --with-http_sub_module --with-http_v2_module --with-mail --with-mail_ssl_module --with-stream --with-stream_realip_module --with-stream_ssl_module --with-stream_ssl_preread_module --with-cc-opt='-Os -fomit-frame-pointer' --with-ld-opt=-Wl,--as-needed

Dockerfile をベースとして使用しますが、静的コンテンツを配布するために必要なものだけを残しておきます。私のバージョンは HTTPS 経由で動作できず、認証などもサポートしません。ただし、私のバージョンでは、gzip よりもわずかに効率的な Brotli アルゴリズムで圧縮されたファイルを配布できます。ファイルを一度圧縮しますが、その場で圧縮する必要はありません。

これが私が最終的に作成した Dockerfile です。ロシア語のコメントは私によるもので、英語はオリジナルのものです。

ドッカーファイル

# Базовый образ снова Alpine
FROM alpine:3.9
LABEL maintainer="Aleksey Maydokin <[email protected]>"
ENV NGINX_VERSION 1.16.0
ENV NGX_BROTLI_VERSION 0.1.2
ENV BROTLI_VERSION 1.0.7
RUN set -x 
    && addgroup -S nginx 
    && adduser -D -S -h /var/cache/nginx -s /sbin/nologin -G nginx nginx 
# Устанавливаем пакеты, которые нужны чтобы собрать nginx и модуль ngx_brotli к нему
    && apk add --no-cache --virtual .build-deps 
            gcc 
            libc-dev 
            make 
            linux-headers 
            curl 
    && mkdir -p /usr/src 
# Скачиваем исходники
    && curl -LSs https://nginx.org/download/nginx-$NGINX_VERSION.tar.gz | tar xzf - -C /usr/src 
    && curl -LSs https://github.com/eustas/ngx_brotli/archive/v$NGX_BROTLI_VERSION.tar.gz | tar xzf - -C /usr/src 
    && curl -LSs https://github.com/google/brotli/archive/v$BROTLI_VERSION.tar.gz | tar xzf - -C /usr/src 
    && rm -rf /usr/src/ngx_brotli-$NGX_BROTLI_VERSION/deps/brotli/ 
    && ln -s /usr/src/brotli-$BROTLI_VERSION /usr/src/ngx_brotli-$NGX_BROTLI_VERSION/deps/brotli 
    && cd /usr/src/nginx-$NGINX_VERSION 
    && CNF="
            --prefix=/etc/nginx 
            --sbin-path=/usr/sbin/nginx 
            --modules-path=/usr/lib/nginx/modules 
            --conf-path=/etc/nginx/nginx.conf 
            --error-log-path=/var/log/nginx/error.log 
            --http-log-path=/var/log/nginx/access.log 
            --pid-path=/var/run/nginx.pid 
            --lock-path=/var/run/nginx.lock 
            --http-client-body-temp-path=/var/cache/nginx/client_temp 
            --http-proxy-temp-path=/var/cache/nginx/proxy_temp 
            --http-fastcgi-temp-path=/var/cache/nginx/fastcgi_temp 
            --http-uwsgi-temp-path=/var/cache/nginx/uwsgi_temp 
            --http-scgi-temp-path=/var/cache/nginx/scgi_temp 
            --user=nginx 
            --group=nginx 
            --without-http_ssi_module 
            --without-http_userid_module 
            --without-http_access_module 
            --without-http_auth_basic_module 
            --without-http_mirror_module 
            --without-http_autoindex_module 
            --without-http_geo_module 
            --without-http_split_clients_module 
            --without-http_referer_module 
            --without-http_rewrite_module 
            --without-http_proxy_module 
            --without-http_fastcgi_module 
            --without-http_uwsgi_module 
            --without-http_scgi_module 
            --without-http_grpc_module 
            --without-http_memcached_module 
            --without-http_limit_conn_module 
            --without-http_limit_req_module 
            --without-http_empty_gif_module 
            --without-http_browser_module 
            --without-http_upstream_hash_module 
            --without-http_upstream_ip_hash_module 
            --without-http_upstream_least_conn_module 
            --without-http_upstream_keepalive_module 
            --without-http_upstream_zone_module 
            --without-http_gzip_module 
            --with-http_gzip_static_module 
            --with-threads 
            --with-compat 
            --with-file-aio 
            --add-dynamic-module=/usr/src/ngx_brotli-$NGX_BROTLI_VERSION 
    " 
# Собираем
    && ./configure $CNF 
    && make -j$(getconf _NPROCESSORS_ONLN) 
    && make install 
    && rm -rf /usr/src/ 
# Удаляем динамический brotli модуль, оставляя только статический
    && rm /usr/lib/nginx/modules/ngx_http_brotli_filter_module.so 
    && sed -i '$ d' /etc/apk/repositories 
# Bring in gettext so we can get `envsubst`, then throw
# the rest away. To do this, we need to install `gettext`
# then move `envsubst` out of the way so `gettext` can
# be deleted completely, then move `envsubst` back.
    && apk add --no-cache --virtual .gettext gettext 
    && mv /usr/bin/envsubst /tmp/ 
    && runDeps="$( 
        scanelf --needed --nobanner /usr/sbin/nginx /usr/lib/nginx/modules/*.so /tmp/envsubst 
            | awk '{ gsub(/,/, "nso:", $2); print "so:" $2 }' 
            | sort -u 
            | xargs -r apk info --installed 
            | sort -u 
    )" 
    && apk add --no-cache $runDeps 
    && apk del .build-deps 
    && apk del .gettext 
    && mv /tmp/envsubst /usr/local/bin/ 
# Bring in tzdata so users could set the timezones through the environment
# variables
    && apk add --no-cache tzdata 
# forward request and error logs to docker log collector
    && ln -sf /dev/stdout /var/log/nginx/access.log 
    && ln -sf /dev/stderr /var/log/nginx/error.log
COPY nginx.conf /etc/nginx/nginx.conf
EXPOSE 80
STOPSIGNAL SIGTERM
CMD ["nginx", "-g", "daemon off;"]

すぐに nginx.conf を修正して、gzip と brotli がデフォルトで有効になるようにします。静的を変更することがないため、キャッシュヘッダーも含めます。そして最後の仕上げは、すべての 404 リクエストをindex.html にリダイレクトすることです。これは SPA でのナビゲーションに必要です。

nginx.conf

user nginx;
worker_processes  1;
error_log /var/log/nginx/error.log warn;
pid       /var/run/nginx.pid;
load_module /usr/lib/nginx/modules/ngx_http_brotli_static_module.so;
events {
    worker_connections 1024;
}
http {
    include      mime.types;
    default_type application/octet-stream;
    log_format main '$remote_addr - $remote_user [$time_local] "$request" '
                    '$status $body_bytes_sent "$http_referer" '
                    '"$http_user_agent" "$http_x_forwarded_for"';
    access_log /var/log/nginx/access.log main;
    sendfile on;
    keepalive_timeout 65;
    gzip_static   on;
    brotli_static on;
    server {
        listen      80;
        server_name localhost;
        charset utf-8;
        location / {
            root html;
            try_files $uri /index.html;
            etag on;
            expires max;
            add_header Cache-Control public;
            location = /index.html {
                expires 0;
                add_header Cache-Control "no-cache, public, must-revalidate, proxy-revalidate";
            }
        }
    }
}

完成したイメージはここからダウンロードできます。 https://hub.docker.com/r/alexxxnf/nginx-spa。 10,5 MB を消費します。元の nginx は 19,7 MB を使用していました。私のスポーツへの興味は満たされました。

環境変数を理解するために静力学を教える

SPA で設定が必要になるのはなぜですか? たとえば、使用する RESTful API を指定するためです。通常、必要な環境の設定はビルド段階で SPA に転送されます。何かを変更する必要がある場合は、アプリケーションを再構築する必要があります。いりません。アプリケーションを CI 段階で一度ビルドし、CD 段階で環境変数を使用して必要なだけ構成したいと考えています。

もちろん、静的ファイル自体は環境変数を認識しません。したがって、トリックを使用する必要があります。最後のイメージでは、nginx を起動するのではなく、環境変数を読み取って静的ファイルに書き込み、圧縮してから制御を nginx に移す特別なシェルスクリプトを起動します。

この目的のために、Dockerfile は ENTRYPOINT パラメーターを提供します。彼に次のスクリプトを与えてみましょう (例として Angular を使用):

docker-entrypoint.sh

#!/bin/sh set -e FLAG_FILE="/configured" TARGET_DIR="/etc/nginx/html" replace_vars () { ENV_VARS='$(awk 'BEGIN{for(v in ENVIRON) print " quot;v}')' # В Angular ищем плейсхолдеры в main-файлах for f in "$TARGET_DIR"/main*.js; do # envsubst заменяет в файлах плейсхолдеры на значения из переменных окружения echo "$(envsubst "$ENV_VARS" < "$f")" > "$f" done } compress () { for i in $(find "$TARGET_DIR" | grep -E ".css$|.html$|.js$|.svg$|.txt$|.ttf

quot;); do # Используем максимальную степень сжатия gzip -9kf "$i" && brotli -fZ "$i" done } if [ "$1" = 'nginx' ]; then # Флаг нужен, чтобы выполнить скрипт только при самом первом запуске if [ ! -e "$FLAG_FILE" ]; then echo "Running init script" echo "Replacing env vars" replace_vars echo "Compressing files" compress touch $FLAG_FILE echo "Done" fi fi exec "$@"
スクリプトがそのジョブを実行するには、次の形式で設定を js ファイルに記述する必要があります。 ${API_URL}.

最新の SPA のほとんどは、ビルド時にファイルにハッシュを追加することに注意してください。これは、ブラウザがファイルを長期間安全にキャッシュできるようにするために必要です。ファイルが変更されると、そのハッシュも変更され、ブラウザはファイルを再度ダウンロードすることになります。

残念ながら、私の方法では、環境変数を使用して設定を変更してもファイルハッシュは変更されません。つまり、ブラウザのキャッシュを他の方法で無効にする必要があります。異なる構成が異なる環境にデプロイされているため、この問題は発生しません。

最終的なイメージをまとめる

最後に

ドッカーファイル

# Первый базовый образ для сборки
FROM alexxxnf/spa-builder as builder
# Чтобы эффктивнее использовать кэш Docker-а, сначала устанавливаем только зависимости
COPY ./package.json ./package-lock.json /app/
RUN cd /app && npm ci --no-audit
# Потом собираем само приложение
COPY . /app
RUN cd /app && npm run build -- --prod --configuration=docker

# Второй базовый образ для раздачи
FROM alexxxnf/nginx-spa
# Забираем из первого образа сначала компрессор
COPY --from=builder /usr/local/bin/brotli /usr/local/bin
# Потом добавляем чудо-скрипт
COPY ./docker/docker-entrypoint.sh /docker-entrypoint.sh
# И в конце забираем само приложение
COPY --from=builder /app/dist/app /etc/nginx/html/
ENTRYPOINT ["/docker-entrypoint.sh"]
CMD ["nginx", "-g", "daemon off;"]

これで、結果のイメージを組み立ててどこでも使用できるようになります。

出所： habr.com

シングルページアプリケーション配布用のDockerイメージ

アセンブリ用のイメージを構築する

nginx

環境変数を理解するために静力学を教える

最終的なイメージをまとめる