lora application server
version tuned with small adjustements and updated documentation
There are two options how to run application. Develop and deploy mode.
Both modes are using same docker volume (same database is loaded).
.env.example إلى .envclient/.env.development.example إلى client/.env.development إذا كنت ترغب في تشغيل التطبيق في وضع التطويرclient/.env.production.example إلى client/.env.production إذا كنت ترغب في تشغيل التطبيق في وضع الإنتاج${REACT_APP_GOOGLE_API} اتبع هذه الخطوات This will just run db and pgadmin containers. React and server instances are running separately, outside of containers.
${DB_HOST} من .env إلى: localhostdocker-compose -f docker-compose.dev.yml up -dnpm i && npm run server${REACT_APP_BASE_URL} المتغير في ملف client/.env.development وفقًا لذلك إلى ${SERVER_PORT} في ملف .envcd client && npm i && cd .. && npm run clientlocalhost:3000 This will run db, pgadmin, server and build react with disabled redux devtools.
${DB_HOST} من .env إلى postgres .docker-compose up -d .localhost:${SERVER_PORT} .من أجل عمل التطبيق الصحيح ، يجب ملء قاعدة البيانات أولاً. سنستخدم سطر الأوامر لإنجاز ذلك.
من دليل الجذر ، انتقل إلى الدليل حيث توجد البيانات المصدرة.
cd dummy بعد ذلك ، انسخ البيانات إلى تشغيل حاوية postgres (لوضع التطوير ، استخدم dev_postgres_container ).
docker cp dbexport.sql postgres_container:/
ثم ، أدخل الحاوية (لوضع التطوير ، استخدم dev_postgres_container ).
docker exec -it postgres_container /bin/bash
إذا كنت ترغب في استيراد البيانات إلى قاعدة بيانات مأهولة بالفعل ، فيجب عليك أولاً إزالة الجدول الحالي ثم إنشاء جهاز جديد. في وحدة التحكم في الحاوية ، أسقط قاعدة البيانات الحالية. (تخطي هذه الخطوة إذا لم تكن قد قمت بإنشاء قاعدة بيانات حتى الآن)
dropdb -U ${DB_USER} ${DB_NAME}قم بتسجيل الدخول إلى خادم Postgres كمستخدم.
su - ${DB_USER}ثم إنشاء قاعدة بيانات جديدة.
createdb ${DB_NAME}الخروج من وحدة التحكم في خادم Postgres.
exitملء قاعدة البيانات مع بيانات جديدة.
psql -d ${DB_NAME} -U ${DB_USER} -f dbexport.sql الآن يمكنك تسجيل الدخول إلى التطبيق. كلاهما ، name الافتراضي وكلمة password هو: admin .
localhost:${DB_PORT}${DB_USER}${DB_PASSWORD}http://localhost:${PGADMIN_PORT}${PGADMIN_EMAIL}${PGADMIN_PASSWORD}postgres${DB_PORT}${DB_NAME}${DB_PASSWORD} يوجد ملف Docker على مستوى جذر المشروع ويتم استخدامه فقط لوضع النشر.
# Dockerfile
FROM node:latest
WORKDIR /server
COPY . ./
RUN npm install
RUN npm install --prefix client
CMD npm run build في البداية ، يتم تنزيل أحدث العقدة ويتم إنشاء دليل عمل /server في الحاوية التي تم إنشاؤها حديثًا. في دليل العمل هذا ، يتم نسخ رمز المصدر بالكامل ، وتوقع للملفات المحددة في client/.dockerignore . تم حذف هذه الملفات. بعد ذلك ، يتم تثبيت تبعيات العقدة في دليل العمل لكل من الخادم والعميل. أخيرًا ، يسمى أمر npm run build الذي يقع في package.json . هذا الأمر أولاً قم بإنشاء تطبيق React ثم تشغيل الخادم. عند بدء تشغيل الخادم بهذه الطريقة ، يتم تعيين متغير البيئة NODE_ENV على production ويتم استخدام الإصدار المبني من تطبيق React.
نحن نستخدم ملفين Docker-Corms. docker-compose.dev.yml لوضع التطوير و docker-compose.yml لوضع الإنتاج ، وكلاهما يقع في دليل الجذر. يقوم كل ملفات بتكوين تحميل متغيرات البيئة المحددة في ملف .env .
# docker-compose.dev.yml
version : " 3.5 "
# inspired by https://github.com/khezen/compose-postgres
services :
postgres :
container_name : postgres_container
image : postgres:11
environment :
POSTGRES_USER : ${DB_USER}
POSTGRES_PASSWORD : ${DB_PASSWORD}
PGDATA : /data/postgres
volumes :
- postgres:/data/postgres
ports :
- " ${DB_PORT}:5432 "
networks :
- postgres
restart : always
pgadmin :
container_name : pgadmin_container
image : dpage/pgadmin4
environment :
PGADMIN_DEFAULT_EMAIL : ${PGADMIN_EMAIL}
PGADMIN_DEFAULT_PASSWORD : ${PGADMIN_PASSWORD}
PGADMIN_CONFIG_SERVER_MODE : " False "
volumes :
- pgadmin:/root/.pgadmin
ports :
- " ${PGADMIN_PORT}:80 "
networks :
- postgres
restart : always
server :
container_name : server_container
build :
context : .
dockerfile : Dockerfile
depends_on :
- postgres
ports :
- " ${SERVER_PORT}:${SERVER_PORT} "
networks :
- postgres
restart : always
networks :
postgres :
driver : bridge
volumes :
postgres :
pgadmin : يقوم هذا التكوين بإنشاء 3 حاويات وشبكة واحدة وحجم واحد لتخزين البيانات المستمرة. تستخدم كل حاوية نفس الشبكة للتواصل مع الحاويات الأخرى. كل حاوية ، بعد الفشل ، تعيد تشغيله تلقائيًا. Container postgres_container ينشئ خادم postgresql ، حيث يتم تخزين البيانات المستمرة في الحجم. يوجد أيضًا حاوية pgadmin_container ، وهو عميل SQL. الحاوية الأخيرة ، المسماة server_container ، هي المكان الذي يعمل فيه تطبيقنا الرئيسي. بدلاً من الصورة ، تستخدم الإنشاء ، محددة في Dockerfile ، التي تمت مناقشتها في القسم السابق.
يشبه التكوين لتكوين وضع التطوير الوضع الوضعي. الفرق الوحيد هو أنه لا يوجد server_container ، لأن الخادم والعميل مثيلات منفصلة تنفد من Docker.
.env.example إلى .env وضبط القيمة ${DB_HOST} إلى postgres .client/.env.production.example إلى client/.env.production .${REACT_APP_GOOGLE_API} في client/.env.production ، اتبع هذه الخطوات. يجب ضبط الوكيل العكسي على الوصول إلى جينكينز وخادم التطبيق. يجب أن تتطابق المنافذ المحددة في ./env
أولاً ، انتقل إلى دليل تكوين المواقع المتاحة.
cd /etc/nginx/sites-available/ إنشاء ملف التكوين. يمكنك تسميته كما أنت. الممارسة الجيدة هي تسميتها بنفس طريقة عنوان DNS الخاص بك. في حالتنا ، هو lora.fiit.stuba.sk .
touch lora.fiit.stuba.sk نسخ والصق الرمز التالي إلى الملف الذي تم إنشاؤه حديثًا. قم بتغيير تكوين proxy_pass لكل موقع لمطابقة المنافذ المحددة في .env . لا تنس أيضًا ضبط server_name لمطابقة DNS.
upstream jenkins {
keepalive 32; # keepalive connections
server 127.0.0.1:8080; # jenkins ip and port
}
# Required for Jenkins websocket agents
map $http_upgrade $connection_upgrade {
default upgrade;
'' close;
}
server {
server_name lora.fiit.stuba.sk www.lora.fiit.stuba.sk;
# this is the jenkins web root directory
# (mentioned in the /etc/default/jenkins file)
root /var/run/jenkins/war/;
access_log /var/log/nginx/jenkins/access.log;
error_log /var/log/nginx/jenkins/error.log;
# pass through headers from Jenkins that Nginx considers invalid
ignore_invalid_headers off;
location /jenkins/ {
autoindex on ;
sendfile off ;
proxy_pass http://jenkins/jenkins/;
proxy_redirect default ;
proxy_http_version 1.1 ;
# Required for Jenkins websocket agents
proxy_set_header Connection $connection_upgrade ;
proxy_set_header Upgrade $http_upgrade ;
proxy_set_header Host $host ;
proxy_set_header X-Real-IP $remote_addr ;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for ;
proxy_set_header X-Forwarded-Proto $scheme ;
proxy_max_temp_file_size 0 ;
#this is the maximum upload size
client_max_body_size 10m ;
client_body_buffer_size 128k ;
proxy_connect_timeout 90 ;
proxy_send_timeout 90 ;
proxy_read_timeout 90 ;
proxy_buffering off ;
proxy_request_buffering off; # Required for HTTP CLI commands
proxy_set_header Connection "" ; # Clear for keepalive
}
location / {
#Add serving gzipped files
gzip_static on ;
gzip on ;
gzip_proxied no-cache no-store private expired auth;
gzip_min_length 256 ;
gzip_types
text/plain
text/css
application/json
application/javascript
text/xml
application/xml
application/xml+rss text/javascript
application/atom+xml
application/geo+json
application/x-javascript
application/ld+json
application/manifest+json
application/rdf+xml
application/rss+xml
application/xhtml+xml
font/eot
font/otf
font/ttf
image/svg+xml;
proxy_pass http://127.0.0.1:5000/;
proxy_set_header Host $host ;
proxy_set_header X-Real-IP $remote_addr ;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for ;
proxy_set_header X-Forwarded-Proto $scheme ;
# enable WebSockets
proxy_http_version 1.1 ;
proxy_set_header Upgrade $http_upgrade ;
proxy_set_header Connection "upgrade" ;
}
listen 443 ssl; # managed by Certbot
# SSL Configuration
ssl_certificate /etc/letsencrypt/live/lora.fiit.stuba.sk/fullchain.pem; # managed by Certbot
ssl_certificate_key /etc/letsencrypt/live/lora.fiit.stuba.sk/privkey.pem; # managed by Certbot
include /etc/letsencrypt/options-ssl-nginx.conf; # managed by Certbot
ssl_dhparam /etc/letsencrypt/ssl-dhparams.pem; # managed by Certbot
}
# SSL redirect from HTTP to HTTPS
server {
if ( $host = lora.fiit.stuba.sk) {
return 301 https:// $host$request_uri ;
} # managed by Certbot
listen 80 ;
server_name lora.fiit.stuba.sk www.lora.fiit.stuba.sk;
return 404 ; # managed by Certbot
}حفظ الملف وإعادة تشغيل خدمة nginx
sudo systemctl restart nginx يجب أن يكون تطبيق Jenkins متاحًا على lora.fiit.stuba.sk/jenkins . في حالتك ، سيكون اسم DNS الخاص بك بدلاً من lora.fiit.stuba.sk .
عندما تريد تغيير المنزل الافتراضي لـ Jenkins ، يمكنك تغيير متغير JENKINS_HOME . الدليل مستوحى بشدة من هذا البرنامج التعليمي.
قم بإنشاء دليل جديد في أي وقت ترغب في نقله إلى المنزل Jenkins. في حالتنا هو /data/jenkins .
mkdir /data/jenkinsتغيير ملكية الدليل الذي تم إنشاؤه حديثًا.
sudo chown jenkins:jenkins /data/jenkins انسخ المحتوى من دليل Jenkins Home Old ، /var/lib/jenkins/ ، إلى دليل New Jenkins Home ، /data/jenkins/ ، باستخدام الأمر التالي.
sudo cp -prv /var/lib/jenkins /data/jenkins/بعد ذلك ، قم بتغيير منزل مستخدم Jenkins.
sudo usermod -d /data/jenkins/ jenkins قم بتحديث مسار دليل Jenkins المنزلي الجديد في /etc/default/jenkins . يمكنك استخدام أي محرر من اختيارك. في حالتنا ، نحن نستخدم السادس.
sudo vi /etc/default/jenkinsقم بالتمرير لأسفل إلى موقع Jenkins Home وقم بتحديث مسار الدليل المنزلي الجديد.
# defaults for Jenkins automation server
# pulled in from the init script; makes things easier.
NAME=jenkins
# arguments to pass to java
# Allow graphs etc. to work even when an X server is present
JAVA_ARGS= " -Djava.awt.headless=true "
# JAVA_ARGS="-Xmx256m"
# make jenkins listen on IPv4 address
# JAVA_ARGS="-Djava.net.preferIPv4Stack=true"
PIDFILE=/var/run/$NAME/$NAME.pid
# user and group to be invoked as (default to jenkins)
JENKINS_USER=$NAME
JENKINS_GROUP=$NAME
# location of the jenkins war file
JENKINS_WAR=/usr/share/$NAME/$NAME.war
# jenkins home location
JENKINS_HOME=/data/$NAME
# set this to false if you don't want Jenkins to run by itself
# in this set up, you are expected to provide a servlet container
# to host jenkins.
RUN_STANDALONE=trueابدأ خدمة Jenkins باستخدام الأمر التالي.
sudo service jenkins start
قم بزيارة Jenkins من متصفحك في lora.fiit.stuba.sk/jenkins .
تسجيل الدخول إلى التطبيق.
انتقل Manage Jenkins الموجود في الجانب الأيسر من الشاشة.
انقر فوق " Manage Credentials " الموجودة في Security group .
ثم ، انقر على الرابط (global) الموجود في الجدول.
انقر على زر addCredentials على الجانب الأيسر من الشاشة.
اختر خيار Secret file من القائمة Kind .
تحميل ملف .env وتعيين حقل المعرف إلى env .
كرر الخطوة 6 ثم قم بتحميل ملف client/.env.production envClient .
قم بإنشاء بيانات اعتماد أخرى ولكن هذه المرة اختر SSH Username with private key من القائمة المنسدلة. اضبط حقل المعرف على lora-application-server-ssh . للحصول على مفاتيح SSH لمستودعك (حيث يكون رمز المصدر لخادم التطبيق) اتبع هذه التعليمات.
من لوحة القيادة ، انقر على زر New Item ، الموجود في الجانب الأيسر من الشاشة.
أدخل الاسم المطلوب ، انقر فوق زر Pipeline وقم بتأكيده على النقر فوق الزر "موافق"
إلى معجون نص خط الأنابيب بعد الكود
node {
/*** 1 Pull new changes from git branch deploy ***/
stage ( 'Pull master branch' ) {
git credentialsId : 'lora-application-server-ssh' , url : '[email protected]:danielhros/lora-application-server.git'
}
/*** 2 Add secret enviroment variables stored securely in Jenkins ***/
stage ( 'Add enviroment variables' ) {
/* 2.1 Remove .env file if exists */
sh 'rm -f -- .env'
/* 2.2 Add .env file to server */
withCredentials ( [ file ( credentialsId : 'env' , variable : 'env' ) ] ) {
sh "cp $env ./"
}
/* 2.2 Add .env file to client */
withCredentials ( [ file ( credentialsId : 'envClient' , variable : 'envClient' ) ] ) {
sh 'cp $envClient client/.env.production'
}
}
/*** 3 Build docker image ***/
stage ( 'Build docker image' ) {
sh '(docker-compose build)'
}
/*** 4 Run docker image in production ***/
stage ( 'Run docker images' ) {
sh '(docker-compose up -d)'
}
/*** 5 Clean after build ***/
stage ( 'Clean workspace' ) {
sh 'docker system prune -f'
cleanWs ( )
}
}احفظ التغييرات وقم بتشغيل خط الأنابيب الأول
مبروك! بعد إنشاء خط الأنابيب بنجاح ونشر التطبيق ، يمكن الوصول إلى تطبيقك على lora.fiit.stuba.sk .
