Docker slika za distribuciju Single Page Application

Jednostavna aplikacija (SPA) je skup statičnih JavaScript i HTML datoteka, kao i slika i drugih resursa. Pošto se ne menjaju dinamički, veoma je jednostavno objaviti ih na internetu. Za to postoji mnogo jeftinih, pa čak i besplatnih servisa, počinjući od jednostavnog GitHub Pages (a za nekoga čak i od narod.ru) i završavajući CDN-om poput Amazon S3. Međutim, meni je bio potreban nešto drugo.

Trebala mi je Docker slika sa SPA, kako bi lako mogla da se pokrene i u produkciji kao deo Kubernetes klastera, a i na mašini back-end programera koji nema pojma šta je SPA.

Za sebe sam postavio sledeće zahteve za sliku:

  • jednostavnost upotrebe (ali ne i sastavljanja);
  • minimalna veličina sa aspekta diska i RAM-a;
  • konfiguracija preko varijabli okruženja, kako bi se slika mogla koristiti u različitim okruženjima;
  • maksimalno efikasna distribucija datoteka.

Danas ću govoriti kako:

  • razmontirati nginx;
  • sastaviti brotli iz izvora;
  • naučiti statične datoteke da razumeju varijable okruženja;
  • i naravno kako sastaviti iz svega ovoga Docker sliku.

Cilj ovog članka je da podelim svoje iskustvo i podstaknem iskusne članove zajednice na konstruktivnu kritiku.

Izgradnja slike za sastavljanje

Kako bi konačna Docker slika bila mala, treba se pridržavati dva pravila: minimum slojeva i minimalistička osnovna slika. Jedna od najmanjih osnovnih slika je slika Alpine Linux, tako da ću je i izabrati. Neko može da prigovori da Alpine nije prikladan za produkciju i možda će biti u pravu. Ali lično, nikada nisam imao problema sa njom i nemam nikakvih argumenata protiv nje.

Da bi se smanjio broj slojeva, sliku ću sastaviti u 2 faze. Prva – privremena, u kojoj će ostati sve pomoćne alatke i privremene datoteke. A u čistoj ću zapisati samo konačnu verziju aplikacije.

Počnimo sa pomoćnom slikom.

Da bih kompajlirao SPA aplikaciju, obično je potreban node.js. Uzeću zvaničnu sliku koja takođe uključuje paketne menadžere npm i yarn. Od sebe ću dodati node-gyp, koji je potreban za izgradnju nekih npm paketa, i Brotli kompresor od Google-a, koji će nam zatrebati kasnije.

Dockerfile sa komentarima.

# Базовый образ
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

Već ovde se borim za minimalizam, tako da se slika sastavlja jednom velikom komandom.

Spremna slika može se pronaći ovdje: https://hub.docker.com/r/alexxxnf/spa-builder. Iako preporučujem da se ne oslanjate na tuđe slike i da sastavite svoju vlastitu.

nginx

Za distribuciju statičkog sadržaja možete koristiti bilo koji web server. Navikao sam raditi s nginx, pa ću ga koristiti i sada.

Nginx ima službenu Docker sliku, međutim, za jednostavnu distribuciju statike u njoj ima previše modula. Koji su tačno uključeni u distribuciju možete videti pomoću posebne naredbe ili u službenom Dockerfile-u.

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

nginx verzija: nginx/1.17.9
izgrađen pomoću gcc 8.3.0 (Alpine 8.3.0) 
izgrađen sa OpenSSL 1.1.1d  10 Sep 2019
TLS SNI podrška omogućena
argumenti konfiguracije: --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

Uzeću za osnovu Dockerfile, ali ću ostaviti u njemu samo ono što je potrebno za distribuciju statike. Moja verzija neće moći raditi preko HTTPS, neće podržavati autorizaciju i još mnogo toga. Međutim, moja verzija će moći distribuirati datoteke komprimirane Brotli algoritmom, koji je malo efikasniji od gzip-a. Kompresovaćemo datoteke jednom, nije potrebno raditi to u hodu.

Evo kakav je Dockerfile ispao. Komentari na ruskom – moji, na engleskom – iz originala.

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

Odmah ću ispraviti nginx.conf, da gzip i brotli budu uključeni po defaultu. Takođe, uključujem keširajuće zaglavlja, jer ćemo distribuirati statički sadržaj koji se nikada ne menja. I poslednji detalj biće preusmeravanje svih 404 zahteva na index.html, što je neophodno za navigaciju u 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";
            }
        }
    }
}

Preuzmite gotovu sliku ovdje: https://hub.docker.com/r/alexxxnf/nginx-spa. Zauzima 10,5 MB. Originalni nginx je zauzimao 19,7 MB. Moj sportski interes je zadovoljen.

Učimo statiku da razume varijable okruženja

Zašto su podešavanja potrebna u SPA? Na primjer, kako bi se naznačilo koji RESTful API koristiti. Obično se podešavanja za potrebnu okolinu prenose u SPA tokom faze izgradnje. Ako treba nešto da promenite, moraćete ponovo da izgradite aplikaciju. Ja to ne želim. Želim da se aplikacija gradi jednom tokom CI faze, a konfigurira onoliko puta koliko je potrebno, tokom CD faze korišćenjem varijabli okruženja.

Naravno, statički fajlovi sami po sebi ne razumeju nikakve varijable okruženja. Stoga, moraću da budem maštovit. U finalnoj slici neću pokretati nginx, već poseban shell skript koji će pročitati varijable okruženja, napisati ih u statičke fajlove, kompresovati ih, a tek potom prebaciti kontrolu nginx-u.

Za to se u Dockerfile-u predviđa parametar ENTRYPOINT. Prosledićemo mu ovakav skript (na primeru Angular-a):

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-файлах
za f u "$TARGET_DIR"/main*.js; do
# envsubst заменяет в файлах плейсхолдеры на значения из переменных окружения
echo "$(envsubst "$ENV_VARS" "$f"
done
}
komprimir () {
for i in $(find "$TARGET_DIR" | grep -E ".css$|.html$|.js$|.svg$|.txt$|.ttf

quot;); do
# Используем максимальную степень сжатия
gzip -9kf "$i" && brotli -fZ "$i"
done
}
ako [ "$1" = 'nginx' ]; onda
# Флаг нужен, чтобы выполнить скрипт только при самом первом запуске
ako [ ! -e "$FLAG_FILE" ]; onda
echo "Pokrećem init skriptu"
echo "Zamjenjujem env varijable"
zamijeni_varijable
echo "Kompresujem datoteke"
kompresuj
touch $FLAG_FILE
echo "Gotovo"
fi
fi
exec "$@"


Da bi skript obavio svoj posao, u js-fajlovima je potrebno pisati podešavanja ovako: ${API_URL}.

Vredno je napomenuti da većina modernih SPA prilikom izgradnje dodaje heševe svojim fajlovima. To je potrebno kako bi pretraživač mogao da kešira fajl na duži rok. Ako se fajl ipak izmeni, promeniće se i njegov heš, što će primorati pretraživač da ponovo preuzme fajl.

Nažalost, u mojoj metodi, promjene konfiguracije putem varijabli okruženja ne dovode do promjene hash-a datoteke, što znači da se keš preglednika mora invalidirati na neki drugi način. Nemam taj problem jer se različite konfiguracije postavljaju u različitim okruženjima.

Pripremamo finalnu sliku

Napokon.

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

Sada se dobijena slika može složiti i koristiti bilo gdje.

Izvor: habr.com

Kupite pouzdan hosting za sajtove uz zaštitu od DDoS, VPS VDS servere 🔥 Kupite pouzdan hosting za sajtove uz zaštitu od DDoS, VPS VDS servere | ProHoster