ProHoster > Blog > Adminisztráció > Docker-kép a Single Page Application terjesztéséhez.

Docker-kép a Single Page Application terjesztéséhez.

A Single-page Application (SPA) – statikus JavaScript és HTML fájlok, valamint képek és egyéb források összessége. Mivel ezek nem változnak dinamikusan, nagyon egyszerű őket az interneten közzétenni. Erre számos olcsó, sőt ingyenes szolgáltatás létezik, kezdve a GitHub Pages-től (és van, akinek még a narod.ru is megfelel), egészen az Amazon S3-hoz hasonló CDN-ekig. Azonban nekem másra volt szükségem.

Szükségem volt egy Docker-képre az SPA-hoz, hogy azt könnyen lehessen indítani akár a Kubernetes klaszterben, akár a back-end fejlesztő gépén, aki nem tudja, mi az az SPA.

A következő követelményeket határoztam meg a képre:

  • használhatóság (de nem összeállítás);
  • minimális méret disk és RAM szempontjából;
  • konfigurálás környezeti változókon keresztül, hogy a képet különböző környezetekben lehessen használni;
  • a fájlok maximálisan hatékony terjesztése.

Ma arról fogok beszélni, hogyan:

  • kiüríteni az nginx-t;
  • brottlit összeállítani forrásból;
  • megtanítani a statikus fájlokat a környezeti változók értelmezésére;
  • és persze, hogyan állítsuk össze a teljes Docker-képet.

Ennek a cikknek a célja, hogy megosszam a tapasztalataimat, és ösztönözzem a tapasztalt közösségi tagokat a konstruktív kritikára.

A kép összeállítása

Ahhoz, hogy a végső Docker-kép kicsi legyen, két szabályt kell betartani: lehetőleg kevesebb réteg és minimalista alapkép. Az egyik legkisebb alapképek közé tartozik az Alpine Linux, ezért ezt fogom választani. Valaki megjegyezheti, hogy az Alpine nem alkalmas a produkcióra, és lehet, hogy igaza is van. De személy szerint nekem soha nem volt vele problémám, és semmi érvet nem tudok felhozni ellene.

A rétegek csökkentése érdekében 2 lépésben fogom összeállítani a képet. Az első – a tervezet, amiben minden segédprogram és ideiglenes fájl ott marad. A tisztán pedig csak az alkalmazás végső verziójába írok.

Kezdjük a segéd képpel.

A SPA alkalmazás összeállításához általában szükség van node.js-re. Az hivatalos képet választom, amelyhez a csomagkezelők, az npm és a yarn is tartoznak. Hozzáadom a node-gyp-ot is, amely néhány npm-csomag összeállításához szükséges, valamint a Google Brotli tömörítőt, amely később hasznos lesz.

Dockerfile megjegyzésekkel.

# Базовый образ
FROM node:12-alpine
LABEL maintainer="Aleksey Maydokin <amaydokin@gmail.com>"
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

Már itt a minimalizmusra törekszem, ezért a kép egyetlen nagy parancs segítségével készül.

A kész képet itt találhatja: https://hub.docker.com/r/alexxxnf/spa-builder. Bár azt javaslom, hogy ne mások képeire alapozzon, és készítse el a sajátját.

nginx

Statikus fájlok kiszolgálásához bármilyen webkiszolgálót használhat. Én az nginx használatát szoktam meg, így most is azt fogom alkalmazni.

Az nginx-nek van hivatalos Docker képe, azonban a statikus fájlok egyszerű kiszolgálásához túl sok modul van benne. Az éppen benne lévő modulokat egy külön parancs segítségével, vagy a hivatalos Dockerfile-ban is megtekintheti.

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

nginx verzió: nginx/1.17.9
built by gcc 8.3.0 (Alpine 8.3.0) 
built with OpenSSL 1.1.1d  2019. szeptember 10.
TLS SNI támogatás engedélyezve
konfigurációs paraméterek: --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

A Dockerfile alapszavát fogom venni, de csak azokat a részeket hagyom benne, amelyek a statikus fájlok kiszolgálásához szükségesek. Az én verzióm nem fog HTTPS-en működni, nem támogatja az autorizálást és sok egyebet. Viszont az én verzióm képes lesz Brotli algoritmussal tömörített fájlokat kiszolgálni, ami egy kicsit hatékonyabb, mint a gzip. A fájlokat egyszer fogjuk tömöríteni, a valós idejű tömörítésre nincs szükség.

Íme, ilyen Dockerfile-t hoztam létre. A kommentárok oroszul – az enyémek, angolul – az eredetiből.

Dockerfile

# Базовый образ снова Alpine
FROM alpine:3.9
LABEL maintainer="Aleksey Maydokin <amaydokin@gmail.com>"
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;"]

Azonnal módosítani fogom az nginx.conf fájlt, hogy a gzip és a brotli alapértelmezetten engedélyezve legyen. A gyorsítótárazó fejléceket is be fogom kapcsolni, hiszen olyan statikus fájlokat fogunk kiszolgálni, amelyek soha nem változnak. Az utolsó simításként pedig minden 404-es kérést átirányítok az index.html-re, ez szükséges a SPA navigációhoz.

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";
            }
        }
    }
}

A kész képet itt lehet letölteni: https://hub.docker.com/r/alexxxnf/nginx-spa. Mérete 10,5 MB. Az eredeti nginx 19,7 MB-ot foglalt el. A sportos érdeklődésem kielégült.

Tanuljuk meg, hogy a statikus fájlok hogyan értsék a környezeti változókat.

Miért lehet szükség konfigurációs beállításokra az SPA-ban? Például annak meghatározására, hogy melyik RESTful API-t használjuk. Általában a szükséges környezethez tartozó beállításokat az SPA a build folyamat során kapja meg. Ha valamit meg kell változtatni, újra kell építeni az alkalmazást. Én ezt nem akarom. Azt szeretném, ha az alkalmazás egyszer épülne a CI szakaszban, és annyira konfigurálódna, amennyire szükséges, a CD szakaszban a környezeti változók segítségével.

Természetesen a statikus fájlok önállóan nem értenek a környezeti változókhoz. Ezért egy kis trükkhöz kell folyamodnunk. A végső képen nem nginx-et fogok futtatni, hanem egy speciális shell-scriptet, amely elolvassa a környezeti változókat, beírja azokat a statikus fájlokba, összenyomja azokat, és csak ezt követően adja át a vezérlést az nginx-nek.

Ehhez a Dockerfile-ban szerepel az ENTRYPOINT paraméter. Adjunk át neki egy ilyen scriptet (például Angular esetében):

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"
 kész
 }
 compress () {
 for i in $(find "$TARGET_DIR" | grep -E ".css$|.html$|.js$|.svg$|.txt$|.ttf
quot;); do
 # Используем максимальную степень сжатия
 gzip -9kf "$i" && brotli -fZ "$i"
 kész
 }
 if [ "$1" = 'nginx' ]; then
 # Флаг нужен, чтобы выполнить скрипт только при самом первом запуске
 if [ ! -e "$FLAG_FILE" ]; then
 echo "Running init script"
 echo "Replacing env vars"
 replace_vars
 echo "Compressing files"
 tömörít
 touch $FLAG_FILE
 echo "Done"
 fi
 fi
 exec "$@"

 Ahhoz, hogy a script elvégezze a dolgát, a js-fájlokban a beállításokat így kell írni: ${API_URL}.
Érdemes megjegyezni, hogy a legtöbb modern SPA a build során hash-eket ad a fájljaikhoz. Ez szükséges ahhoz, hogy a böngésző biztonságosan gyorsítótárazza a fájlt hosszú időre. Ha a fájl mégis megváltozik, a hash is megváltozik, ami arra kényszeríti a böngészőt, hogy letöltse a fájlt újra.
Sajnálatos módon az én módszerem szerint a környezeti változókon keresztüli konfigurációváltoztatás nem eredményezi a fájl hash-ének módosulását, ezért a böngésző gyorsítótárának érvénytelenítésére más módon van szükség. Nálam nincs ilyen probléma, mert a különböző konfigurációk különböző környezetekben kerülnek telepítésre.
Összegyűjtjük a végső képet
Végre.
Dockerfile
# Первый базовый образ для сборки
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;"]
Most a létrehozott képet össze lehet állítani és bárhol használni.
Forrás: habr.com
 
             
 Megbízható hosting vásárlása weboldalak számára, DDoS védelemmel, VPS VDS szerverek. 🔥 Megbízható webtárhely vásárlása DDoS védelemmel, VPS VDS szerverek | ProHoster