सिंगल पेज एप्लिकेशन के वितरण के लिए डॉकर छवि

सिंगल-पेज एप्लिकेशन (एसपीए) स्थिर जावास्क्रिप्ट और HTML फ़ाइलों के साथ-साथ छवियों और अन्य संसाधनों का एक सेट है। क्योंकि वे गतिशील रूप से नहीं बदलते हैं, उन्हें ऑनलाइन प्रकाशित करना बहुत आसान है। इसके लिए बड़ी संख्या में सस्ती और यहां तक ​​कि मुफ्त सेवाएं भी हैं, जो एक साधारण GitHub पेज से शुरू होती हैं (और कुछ के लिए naroad.ru के साथ भी) और Amazon S3 जैसे CDN तक समाप्त होती हैं। हालाँकि, मुझे कुछ और चाहिए था।

मुझे एसपीए के साथ एक डॉकर छवि की आवश्यकता थी ताकि इसे कुबेरनेट्स क्लस्टर के हिस्से के रूप में उत्पादन में और बैक-एंड डेवलपर की मशीन पर आसानी से लॉन्च किया जा सके, जिसे पता नहीं है कि एसपीए क्या है।

मैंने अपने लिए निम्नलिखित छवि आवश्यकताएँ निर्धारित की हैं:

• उपयोग में आसानी (लेकिन असेंबली नहीं);
• डिस्क और रैम दोनों के संदर्भ में न्यूनतम आकार;
• पर्यावरण चर के माध्यम से कॉन्फ़िगरेशन ताकि छवि का उपयोग विभिन्न वातावरणों में किया जा सके;
• फ़ाइलों का सबसे कुशल वितरण।

आज मैं आपको बताऊंगा कैसे:

• आंत nginx;
• स्रोतों से ब्रोटली बनाएं;
• पर्यावरण चर को समझने के लिए स्थिर फ़ाइलें सिखाएं;
• और निश्चित रूप से इस सब से एक डॉकर छवि कैसे बनाई जाए।

इस लेख का उद्देश्य मेरे अनुभव को साझा करना और अनुभवी समुदाय के सदस्यों को रचनात्मक आलोचना के लिए प्रेरित करना है।

असेंबली के लिए एक छवि बनाना

अंतिम डॉकर छवि को आकार में छोटा बनाने के लिए, आपको दो नियमों का पालन करना होगा: न्यूनतम परतें और एक न्यूनतम आधार छवि। सबसे छोटी आधार छवियों में से एक अल्पाइन लिनक्स छवि है, इसलिए मैं इसे चुनूंगा। कुछ लोग यह तर्क दे सकते हैं कि अल्पाइन उत्पादन के लिए उपयुक्त नहीं है, और वे सही भी हो सकते हैं। लेकिन व्यक्तिगत तौर पर मुझे उनसे कभी कोई दिक्कत नहीं रही और उनके खिलाफ कोई तर्क नहीं है.

कम परतें रखने के लिए, मैं छवि को 2 चरणों में एकत्रित करूँगा। पहला एक ड्राफ्ट है; सभी सहायक उपयोगिताएँ और अस्थायी फ़ाइलें इसमें रहेंगी। और अंतिम चरण में मैं केवल एप्लिकेशन का अंतिम संस्करण ही लिखूंगा।

आइए सहायक छवि से शुरू करें।

एसपीए एप्लिकेशन को संकलित करने के लिए, आपको आमतौर पर नोड.जेएस की आवश्यकता होती है। मैं आधिकारिक छवि लूंगा, जो एनपीएम और यार्न पैकेज मैनेजरों के साथ भी आती है। अपनी ओर से, मैं नोड-जिप जोड़ूंगा, जो कुछ एनपीएम पैकेज बनाने के लिए आवश्यक है, और Google से ब्रॉटली कंप्रेसर, जो बाद में हमारे लिए उपयोगी होगा।

टिप्पणियों के साथ डॉकरफ़ाइल।

# Базовый образ
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 की एक आधिकारिक डॉकर छवि है, लेकिन इसमें सरल स्थैतिक वितरण के लिए बहुत सारे मॉड्यूल हैं। डिलीवरी में कौन-कौन से शामिल हैं, इसे एक विशेष टीम या आधिकारिक डॉकरफ़ाइल में देखा जा सकता है।

$ डॉकर रन --आरएम nginx:1-अल्पाइन 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

मैं डॉकरफाइल को आधार के रूप में उपयोग करूंगा, लेकिन मैं इसमें केवल वही छोड़ूंगा जो स्थैतिक सामग्री वितरित करने के लिए आवश्यक है। मेरा संस्करण HTTPS पर काम नहीं कर पाएगा, प्राधिकरण का समर्थन नहीं करेगा, और भी बहुत कुछ। लेकिन मेरा संस्करण ब्रॉटली एल्गोरिदम के साथ संपीड़ित फ़ाइलों को वितरित करने में सक्षम होगा, जो कि 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 MB लिया। मेरी खेल रुचि संतुष्ट है.

पर्यावरण चर को समझने के लिए सांख्यिकी पढ़ाना

एसपीए में सेटिंग्स की आवश्यकता क्यों हो सकती है? उदाहरण के लिए, यह निर्दिष्ट करने के लिए कि किस RESTful API का उपयोग करना है। आमतौर पर, वांछित वातावरण के लिए सेटिंग्स को निर्माण चरण में एसपीए में स्थानांतरित कर दिया जाता है। यदि आपको कुछ बदलने की आवश्यकता है, तो आपको एप्लिकेशन को फिर से बनाना होगा। मुझे यह नहीं चाहिये। मैं चाहता हूं कि एप्लिकेशन को एक बार सीआई चरण में बनाया जाए, और पर्यावरण चर का उपयोग करके सीडी चरण में जितना आवश्यक हो कॉन्फ़िगर किया जाए।

बेशक, स्थैतिक फ़ाइलें स्वयं किसी पर्यावरण चर को नहीं समझती हैं। इसलिए आपको एक ट्रिक का इस्तेमाल करना होगा. अंतिम छवि में, मैं nginx लॉन्च नहीं करूंगा, बल्कि एक विशेष शेल स्क्रिप्ट लॉन्च करूंगा जो पर्यावरण चर को पढ़ेगी, उन्हें स्थिर फ़ाइलों में लिखेगी, उन्हें संपीड़ित करेगी, और उसके बाद ही nginx पर नियंत्रण स्थानांतरित करेगी।

इस प्रयोजन के लिए, Dockerfile ENTRYPOINT पैरामीटर प्रदान करता है। आइए उसे निम्नलिखित स्क्रिप्ट दें (उदाहरण के रूप में एंगुलर का उपयोग करके):

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}.
यह ध्यान देने योग्य है कि अधिकांश आधुनिक एसपीए निर्माण करते समय अपनी फ़ाइलों में हैश जोड़ते हैं। यह आवश्यक है ताकि ब्राउज़र फ़ाइल को लंबे समय तक सुरक्षित रूप से कैश कर सके। यदि फ़ाइल बदलती है, तो उसका हैश बदल जाएगा, जो बदले में ब्राउज़र को फ़ाइल को फिर से डाउनलोड करने के लिए बाध्य करेगा।
दुर्भाग्य से, मेरी पद्धति में, पर्यावरण चर के माध्यम से कॉन्फ़िगरेशन बदलने से फ़ाइल हैश में कोई बदलाव नहीं होता है, जिसका अर्थ है कि ब्राउज़र कैश को किसी अन्य तरीके से अमान्य किया जाना चाहिए। मुझे यह समस्या नहीं है क्योंकि अलग-अलग वातावरण में अलग-अलग कॉन्फ़िगरेशन तैनात किए जाते हैं।
अंतिम छवि को एक साथ रखना
अंत में।
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;"]
अब परिणामी छवि को इकट्ठा किया जा सकता है और कहीं भी उपयोग किया जा सकता है।
स्रोत: www.habr.com