Docker-выява для раздачы Single Page Application

Single-page Application (SPA) – гэта набор статычных JavaScript і HTML файлаў, а таксама карцінак і іншых рэсурсаў. Паколькі яны не мяняюцца дынамічна, апублікаваць іх у інтэрнэце вельмі проста. Для гэтага існуе вялікая колькасць танных і нават бясплатных сэрвісаў, пачынальна з простага GitHub Pages (а для кагосьці нават з narod.ru) і заканчваючы CDN накшталт Amazon S3. Аднак мне трэба было іншае.

Мне патрэбен быў Docker-выява з SPA, каб яго лёгка можна было запусціць як у прадакшэне ў складзе Kubernetes-кластара, так і на машыне back-end распрацоўніка, які паняцця не мае, што такое SPA.

Я для сябе вызначыў наступныя патрабаванні да выявы:

• прастата ў выкарыстанні (але не ў зборцы);
• мінімальны памер як з пункта гледжання дыска, так і з пункта гледжання RAM;
• настройка праз зменныя асяроддзі, каб выява можна было выкарыстоўваць у розных асяроддзях;
• максімальна эфектыўная раздача файлаў.

Сёння я раскажу як:

• вытрыбушыць nginx;
• сабраць brotli з зыходнікаў;
• навучыць статычныя файлы разумець зменныя асяроддзі;
• і як сабраць з усяго гэтага Docker-вобраз.

Мэта гэтага артыкула падзяліцца маім досведам і справакаваць дасведчаных удзельнікаў супольнасці на канструктыўную крытыку.

Зборка выявы для зборкі

Каб фінальная Docker-выява атрымаўся маленькім па памеры, трэба прытрымвацца двух правіл: мінімум пластоў і мінімалістычная базавая выява. Адным з самых маленькіх базавых выяў з'яўляецца выява Alpine Linux, таму менавіта яго я і абяру. Хтосьці можа запярэчыць, што Alpine не падыходзіць для прадакшэна і, магчыма, мае рацыю. Але асабіста ў мяне з ім ніколі не ўзнікала праблем і ніякіх аргументаў супраць яго няма.

Каб было паменш пластоў, я буду збіраць выяву ў 2 этапы. Першы - чарнавы, у ім застануцца ўсе дапаможныя ўтыліты і часовыя файлы. А ў чыставой я запішу толькі фінальную версію прыкладання.

Пачнём з дапаможнай выявы.

Для таго, каб скампіляваць SPA-дадатак, звычайна, патрэбен node.js. Я вазьму афіцыйную выяву ў камплекце з якім гэтак жа ёсць пакетныя мэнэджары npm і yarn. Ад сябе я дадам node-gyp, які патрэбен для зборкі некаторых npm-пакетаў, і кампрэсар Brotli ад Google, які спатрэбіцца нам пазней.

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

Ужо тут я змагаюся за мінімалізм, таму вобраз збіраецца адной вялікай камандай.

Гатовую выяву можна знайсці тут: https://hub.docker.com/r/alexxxnf/spa-builder. Хаця я рэкамендую не спадзявацца на чужыя вобразы і сабраць свой.

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, не будзе падтрымліваць аўтарызацыю і шматлікае іншае. Затое мая версія зможа раздавай файлы, сціснутыя алгарытмам Brotli, які трохі эфектыўней, чым gzip. Сціскаць файлы будзем адзін раз, рабіць гэта на ляту няма неабходнасці.

Вось які 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 МБ. Арыгінальны nginx займаў 19,7 МБ. Мая спартовая цікавасць задаволена.

Вучым статыку разумець зменныя асяроддзі

Для чаго ў SPA могуць спатрэбіцца наладкі? Напрыклад, для таго, каб паказаць які RESTful API выкарыстоўваць. Звычайна наладкі для патрэбнага асяроддзя перадаюцца ў SPA на этапе зборкі. Калі трэба нешта памяняць, то давядзецца перасабраць прыкладанне. Я гэтага не хачу. Я жадаю каб прыкладанне збіралася адзін раз на стадыі CI, а канфігуравалася гэтулькі, колькі трэба, на стадыі CD з дапамогай зменных асяроддзі.

Зразумела, статычныя файлы самі па сабе не разумеюць ніякіх зменных асяроддзі. Таму, давядзецца пайсці на хітрасць. У фінальнай выяве я буду запускаць не nginx, а адмысловы shell-скрыпт, які прачытае праменныя асяроддзі, запішы іх у статычныя файлы, сцісне іх і толькі пасля гэтага перадасць кіраванне 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