이 기사에서는 Plesk 제어판 및 Github 작업을 사용하여 CI/CD를 설정한 경험을 공유합니다. 오늘 우리는 복잡하지 않은 이름 "Helloworld"로 간단한 프로젝트를 배포하는 방법을 배웁니다. Celery 작업자 및 Angular 8 프런트엔드와 함께 Flask Python 프레임워크로 작성되었습니다.

저장소 링크: 백엔드, 프론트엔드.

이 기사의 첫 번째 부분에서는 프로젝트와 해당 부분을 살펴보겠습니다. 두 번째에서는 Plesk를 설정하고 필요한 확장 및 구성 요소(DB, RabbitMQ, Redis, Docker 등)를 설치하는 방법을 알아봅니다.

세 번째 부분에서는 최종적으로 개발 및 프로덕션 환경의 서버에 프로젝트를 배포하기 위한 파이프라인을 설정하는 방법을 알아봅니다. 그런 다음 서버에서 사이트를 시작합니다.

그리고 네, 제 소개를 잊었습니다. 제 이름은 Oleg Borzov입니다. 저는 Domclick의 모기지 관리자를 위한 CRM 팀의 풀스택 개발자입니다.

프로젝트 개요

먼저 백엔드와 프런트의 두 프로젝트 리포지토리를 살펴보고 코드를 살펴보겠습니다.

백엔드: 플라스크+셀러리

뒷부분에서는 Python 개발자들 사이에서 꽤 인기 있는 Flask 프레임워크(API용)와 Celery(작업 대기열용)를 가져왔습니다. SQLAchemy는 ORM으로 사용됩니다. Alembic은 마이그레이션에 사용됩니다. 핸들의 JSON 유효성 검사 - Marshmallow.

В 저장소 구조에 대한 자세한 설명과 프로젝트 실행 지침이 포함된 Readme.md 파일이 있습니다.

웹 파트 API 매우 복잡하지 않으며 6개의 펜으로 구성됩니다.

• /ping - 이용 가능 여부 확인
• 등록, 승인, 승인 취소 및 승인된 사용자 획득을 처리합니다.
• 셀러리 대기열에 작업을 넣는 이메일 핸들.

셀러리 부분 더 쉬워도 문제는 하나뿐 send_mail_task.

폴더에 /conf 두 개의 하위 폴더가 있습니다.

• docker 두 개의 Dockerfile(base.dockerfile 거의 변경되지 않는 기본 이미지를 구축하고 Dockerfile 메인 어셈블리의 경우);
• .env_files - 다른 환경에 대한 환경 변수가 있는 파일.

프로젝트의 루트에는 XNUMX개의 docker-compose 파일이 있습니다.

• docker-compose.local.db.yml 개발을 위한 로컬 데이터베이스 구축
• docker-compose.local.workers.yml 작업자, 데이터베이스, Redis 및 RabbitMQ의 로컬 양육을 위해;
• docker-compose.test.yml 배포 중 테스트 실행
• docker-compose.yml 배치를 위해.

그리고 우리가 관심을 갖는 마지막 폴더 - .ci-cd. 여기에는 배포용 셸 스크립트가 포함되어 있습니다.

• deploy.sh — 마이그레이션 및 배포 시작. Github Actions에서 테스트를 빌드하고 실행한 후 서버에서 실행합니다.
• rollback.sh - 이전 버전의 어셈블리로 컨테이너 롤백
• curl_tg.sh - Telegram에 배포 알림 보내기.

Angular의 프런트엔드

전면이 있는 저장소 Beck보다 훨씬 간단합니다. 앞면은 세 페이지로 구성됩니다.

• 이메일을 보내는 양식과 종료 버튼이 있는 기본 페이지입니다.
• 로그인 페이지.
• 등록 페이지.

메인 페이지는 금욕적으로 보입니다.

루트에 두 개의 파일이 있습니다. Dockerfile и docker-compose.yml, 뿐만 아니라 친숙한 폴더 .ci-cd 백 리포지토리보다 약간 적은 수의 스크립트를 사용합니다(테스트 실행을 위해 제거된 스크립트).

Plesk에서 프로젝트 시작

Plesk를 설정하고 사이트에 대한 구독을 생성하여 시작하겠습니다.

확장 프로그램 설치

Plesk에는 네 가지 확장이 필요합니다.

• Docker Plesk 관리자 패널에서 컨테이너 상태를 관리하고 시각적으로 표시하기 위해
• Git 서버에서 배포 단계를 구성합니다.
• Let's Encrypt 무료 TLS 인증서 생성(및 자동 갱신)
• Firewall 들어오는 트래픽의 필터링을 구성합니다.

확장 프로그램 섹션의 Plesk 관리자 패널을 통해 설치할 수 있습니다.

확장에 대한 세부 설정은 고려하지 않으며 기본 설정은 데모용으로 사용됩니다.

구독 및 사이트 만들기

다음으로 helloworld.ru 웹사이트에 대한 구독을 생성하고 거기에 dev.helloworld.ru 하위 도메인을 추가해야 합니다.

1. helloworld.ru 도메인에 대한 구독을 만들고 시스템 사용자의 로그인 암호를 지정합니다.

   
   페이지 하단의 체크박스를 선택하세요. Let's Encrypt로 도메인 보호사이트에 HTTPS를 설정하려는 경우:

   

2. 다음으로 이 구독에서 하위 도메인 dev.helloworld.ru를 만듭니다(무료 TLS 인증서도 발급할 수 있음).

   

서버 구성 요소 설치

우리는 서버가 있습니다 OS 데비안 스트레치 9.12 그리고 설치된 제어판 플레스크 흑요석 18.0.27.

프로젝트에 대해 다음을 설치하고 구성해야 합니다.

• PostgreSQL(우리의 경우 개발 및 프로덕션 환경을 위한 두 개의 데이터베이스가 있는 하나의 서버가 있습니다).
• RabbitMQ(환경에 대해 서로 다른 가상 호스트를 사용하는 동일하고 동일한 인스턴스).
• XNUMX개의 Redis 인스턴스(개발 및 프로덕션 환경용).
• Docker 레지스트리(빌드된 Docker 이미지의 로컬 스토리지용).
• Docker 레지스트리용 UI.

PostgreSQL

Plesk는 이미 PostgreSQL DBMS와 함께 제공되지만 최신 버전은 아닙니다(Plesk Obsidian 작성 당시) 지원 Postgres 버전 8.4–10.8). 우리는 애플리케이션의 최신 버전(이 글을 작성할 당시 12.3)을 원하므로 수동으로 설치합니다.

인터넷의 Debian에 Postgres를 설치하는 방법에 대한 자세한 지침이 많이 있습니다(예) 자세한 설명은 생략하고 다음과 같은 명령만 내리겠습니다.

wget -q https://www.postgresql.org/media/keys/ACCC4CF8.asc -O - | sudo apt-key add -
sudo sh -c 'echo "deb http://apt.postgresql.org/pub/repos/apt/ stretch-pgdg main" >> /etc/apt/sources.list.d/pgdg.list'

sudo apt-get update
sudo apt-get install postgresql postgresql-contrib

PostgreSQL의 기본 설정이 다소 평범한 것을 고려하여 구성을 수정해야 합니다. 이것은 우리를 도울 것입니다 계산자: 서버의 매개변수를 입력하고 파일의 설정을 교체해야 합니다. /etc/postgresql/12/main/postgresql.conf제공되는 사람들에게. 여기서 이러한 계산기는 만병통치약이 아니며 하드웨어, 응용 프로그램 및 쿼리 복잡성에 따라 베이스를 보다 정확하게 조정해야 한다는 점에 유의해야 합니다. 그러나 이것은 시작하기에 충분합니다.

계산기에서 제안한 설정 외에도 postgresql.conf기본 포트 5432를 다른 포트(이 예에서는 - 53983).

구성 파일을 변경한 후 다음 명령을 사용하여 postgresql-server를 다시 시작합니다.

service postgresql restart

PostgreSQL을 설치하고 구성했습니다. 이제 데이터베이스, 개발 및 프로덕션 환경을 위한 사용자를 만들고 사용자에게 데이터베이스를 관리할 수 있는 권한을 부여해 보겠습니다.

$ su - postgres
postgres:~$ create database hw_dev_db_name;
CREATE DATABASE
postgres:~$ create user hw_dev_db_user with password 'hw_dev_db_password';
CREATE ROLE
postgres:~$ grant ALL privileges ON database hw_dev_db_name to hw_dev_db_user;
GRANT
postgres:~$ create database hw_prod_db_name;
CREATE DATABASE
postgres:~$ create user hw_prod_db_user with password 'hw_prod_db_password';
CREATE ROLE
postgres:~$ grant ALL privileges ON database hw_prod_db_name to hw_prod_db_user;
GRANT

RabbitMQ

셀러리용 메시지 브로커인 RabbitMQ 설치로 넘어가겠습니다. Debian에 설치하는 것은 매우 간단합니다.

wget https://packages.erlang-solutions.com/erlang-solutions_1.0_all.deb
sudo dpkg -i erlang-solutions_1.0_all.deb

sudo apt-get update
sudo apt-get install erlang erlang-nox

sudo add-apt-repository 'deb http://www.rabbitmq.com/debian/ testing main'
wget -O- https://www.rabbitmq.com/rabbitmq-release-signing-key.asc | sudo apt-key add -

sudo apt-get update
sudo apt-get install rabbitmq-server

설치 후, 우리는 생성해야합니다 가상 호스트, 사용자 및 필요한 권한 부여:

sudo rabbitmqctl add_user hw_dev_amqp_user hw_dev_amqp_password 
sudo rabbitmqctl set_user_tags hw_dev_amqp_user administrator
sudo rabbitmqctl add_vhost hw_dev_vhost
sudo rabbitmqctl set_permissions -p hw_dev_vhost hw_dev_amqp_user ".*" ".*" ".*"

sudo rabbitmqctl add_user hw_prod_amqp_user hw_prod_amqp_password 
sudo rabbitmqctl set_user_tags hw_prod_amqp_user administrator
sudo rabbitmqctl add_vhost hw_prod_vhost
sudo rabbitmqctl set_permissions -p hw_prod_vhost hw_prod_amqp_user ".*" ".*" ".*"

Redis

이제 애플리케이션의 마지막 구성 요소인 Redis를 설치하고 구성하겠습니다. Celery 작업의 결과를 저장하기 위한 백엔드로 사용됩니다.

확장을 사용하여 개발 및 프로덕션 환경을 위해 Redis로 두 개의 Docker 컨테이너를 올릴 것입니다. Docker 플레스크를 위해.

1. Plesk로 이동하여 확장 섹션으로 이동하여 Docker 확장을 찾아 설치합니다(무료 버전 필요).

   

2. 설치된 확장 프로그램으로 이동하여 검색을 통해 이미지 찾기 redis bitnami 최신 버전을 설치하십시오.

   

3. 다운로드한 컨테이너로 이동하여 구성을 조정합니다. 포트, 최대 할당 RAM 크기, 환경 변수의 암호를 지정하고 볼륨을 마운트합니다.

   

4. prod 컨테이너에 대해 2-3단계를 수행합니다. 설정에서 포트, 암호, RAM 크기 및 서버의 볼륨 폴더 경로와 같은 매개 변수만 변경합니다.

   

도커 레지스트리

기본 서비스 외에 자체 Docker 이미지 리포지토리를 서버에 두는 것이 좋습니다. 다행스럽게도 서버 공간은 이제 매우 저렴하고(확실히 DockerHub 구독보다 저렴함) 개인 리포지토리를 설정하는 프로세스는 매우 간단합니다.

우리는 다음을 원합니다.

• 하위 도메인에서 액세스할 수 있는 암호로 보호된 Docker 리포지토리 https://docker.helloworld.ru;
• 리포지토리에서 이미지를 보기 위한 UI는 다음에서 사용할 수 있습니다. https://docker-ui.helloworld.ru.

이 작업을 수행하려면 :

1. 구독에서 Plesk에 docker.helloworld.ru 및 docker-ui.helloworld.ru라는 두 개의 하위 도메인을 생성하고 이에 대한 Let's Encrypt 인증서를 구성해 보겠습니다.
2. docker.helloworld.ru 하위 도메인 폴더에 파일 추가 docker-compose.yml 다음과 같은 내용으로:

   version: "3"
   
   services:
     docker-registry:
       image: "registry:2"
       restart: always
       ports:
         - "53985:5000"
       environment:
         REGISTRY_AUTH: htpasswd
         REGISTRY_AUTH_HTPASSWD_REALM: basic-realm
         REGISTRY_AUTH_HTPASSWD_PATH: /auth/.htpasswd
         REGISTRY_STORAGE_FILESYSTEM_ROOTDIRECTORY: /data
       volumes:
         - ./.docker-registry.htpasswd:/auth/.htpasswd
         - ./data:/data
   
     docker-registry-ui:
       image: konradkleine/docker-registry-frontend:v2
       restart: always
       ports:
         - "53986:80"
       environment:
         VIRTUAL_HOST: '*, https://*'
         ENV_DOCKER_REGISTRY_HOST: 'docker-registry'
         ENV_DOCKER_REGISTRY_PORT: 5000
       links:
         - 'docker-registry'
   

3. SSH에서 Docker 리포지토리의 기본 인증을 위한 .htpasswd 파일을 생성합니다.

   htpasswd -bBc .htpasswd hw_docker_admin hw_docker_password

4. 용기 수집 및 들어 올리기:

   docker-compose up -d

5. 그리고 Nginx를 컨테이너로 리디렉션해야 합니다. Plesk를 통해 가능합니다.

docker.helloworld.ru 및 docker-ui.helloworld.ru 하위 도메인에 대해 다음 단계를 수행해야 합니다.

섹션에서 개발 도구 우리 사이트로 이동 도커 프록시 규칙:

그리고 들어오는 트래픽을 컨테이너로 프록시하는 규칙을 추가합니다.

1. 로컬 머신에서 컨테이너에 로그인할 수 있는지 확인합니다.

   $ docker login docker.helloworld.ru -u hw_docker_admin -p hw_docker_password
   WARNING! Using --password via the CLI is insecure. Use --password-stdin.
   Login Succeeded

2. docker-ui.helloworld.ru 하위 도메인의 작동도 확인하겠습니다.

   
   리포지토리 찾아보기를 클릭하면 브라우저에 리포지토리의 사용자 이름과 비밀번호를 입력해야 하는 인증 창이 표시됩니다. 그런 다음 리포지토리 목록이 있는 페이지로 리디렉션됩니다(현재로서는 비어 있음).

   

Plesk 방화벽에서 포트 열기

구성 요소를 설치 및 구성한 후 Docker 컨테이너 및 외부 네트워크에서 구성 요소에 액세스할 수 있도록 포트를 열어야 합니다.

이전에 설치한 Plesk용 방화벽 확장을 사용하여 이 작업을 수행하는 방법을 살펴보겠습니다.

1. 우리는에 전달한다. 도구 및 설정 > 설정 > 방화벽:
   
2. 우리는에 전달한다. Plesk 방화벽 규칙 수정 > 사용자 지정 규칙 추가 Docker 서브넷에 대해 다음 TCP 포트를 엽니다(172.0.0.0 / 8):
   토끼MQ: 1883, 4369, 5671-5672, 25672, 61613-61614
   레디스: 32785, 32786

   

3. 또한 PostgreSQL 포트와 RabbitMQ 관리 패널을 외부 세계로 여는 규칙을 추가할 것입니다.

   

4. 변경 사항 적용 버튼을 사용하여 규칙을 적용합니다.

   

Github 작업에서 CI/CD 설정

가장 흥미로운 부분인 지속적인 통합 파이프라인을 설정하고 프로젝트를 서버에 전달하는 부분에 대해 알아보겠습니다.

이 파이프라인은 두 부분으로 구성됩니다.

• Github 측에서 이미지 빌드 및 테스트 실행(백엔드용)
• 마이그레이션 실행(백엔드용) 및 컨테이너 배포 - 서버에서.

Plesk에 배포

두 번째 항목을 먼저 다루겠습니다(첫 번째 항목이 이에 의존하기 때문입니다).

Plesk용 Git 확장을 사용하여 배포 프로세스를 구성합니다.

백엔드 리포지토리에 대한 Prod 환경의 예를 고려하십시오.

1. Helloworld 웹 사이트 구독으로 이동하여 Git 하위 섹션으로 이동합니다.

   

2. Github 리포지토리에 대한 링크를 "원격 Git 리포지토리" 필드에 삽입하고 기본 폴더를 변경합니다. httpdocs 다른 사람에게 (예. /httpdocs/hw_back):

   

3. 이전 단계에서 SSH 공개 키를 복사하고 추가하다 Github 설정에 있습니다.
4. 2단계 화면에서 확인을 클릭하면 Plesk의 리포지토리 페이지로 리디렉션됩니다. 이제 마스터 브랜치에 대한 커밋에서 업데이트되도록 리포지토리를 구성해야 합니다. 이렇게 하려면 다음으로 이동하십시오. 리포지토리 설정 그리고 값을 저장 Webhook URL (나중에 Github Actions를 설정할 때 필요합니다):

   

5. 이전 단락의 화면에 있는 작업 필드에 스크립트를 입력하여 배포를 시작합니다.

   cd {REPOSITORY_ABSOLUTE_PATH}
   .ci-cd/deploy.sh {ENV} {DOCKER_REGISTRY_HOST} {DOCKER_USER} {DOCKER_PASSWORD} {TG_BOT_TOKEN} {TG_CHAT_ID} 

   지역 :

   {REPOSITORY_ABSOLUTE_PATH} - 서버에 있는 백엔드 저장소의 prod 폴더 경로
   {ENV} - 우리의 경우 환경(dev / prod) prod;
   {DOCKER_REGISTRY_HOST} - 도커 저장소의 호스트
   {TG_BOT_TOKEN} — 텔레그램 봇 토큰;
   {TG_CHAT_ID} — 알림 전송을 위한 채팅/채널의 ID입니다.

   스크립트 예:

   cd /var/www/vhosts/helloworld.ru/httpdocs/hw_back/
   .ci-cd/deploy.sh dev docker.helloworld.ru docker_user docker_password 12345678:AAbcdEfghCH1vGbCasdfSAs0K5PALDsaw -1001234567890

6. 컨테이너를 관리할 수 있도록 구독의 사용자를 Docker 그룹에 추가합니다.

   sudo usermod -aG docker helloworld_admin

백엔드 리포지토리와 프런트엔드의 개발 환경은 동일한 방식으로 설정됩니다.

Github 작업의 배포 파이프라인

Github Actions에서 CI/CD 파이프라인의 첫 번째 부분 설정으로 이동하겠습니다.

백엔드

파이프라인은 에 설명되어 있습니다. 배포.yml 파일.

하지만 파싱하기 전에 Github에서 필요한 Secret 변수를 채우자. 이렇게 하려면 다음으로 이동하십시오. 설정 -> 비밀:

• DOCKER_REGISTRY - Docker 저장소의 호스트(docker.helloworld.ru)
• DOCKER_LOGIN - Docker 저장소에 로그인합니다.
• DOCKER_PASSWORD - 비밀번호;
• DEPLOY_HOST — Plesk 관리자 패널을 사용할 수 있는 호스트(예: helloworld.com:8443 또는 123.4.56.78:8443);
• DEPLOY_BACK_PROD_TOKEN - 서버의 prod-repository에 배포하기 위한 토큰(Plesk의 배포 p. 4에서 얻었음)
• DEPLOY_BACK_DEV_TOKEN - 서버의 개발 리포지토리에 배포하기 위한 토큰입니다.

배포 프로세스는 간단하며 세 가지 주요 단계로 구성됩니다.

• 저장소에 이미지를 구축하고 게시합니다.
• 새로 빌드된 이미지를 기반으로 컨테이너에서 테스트 실행
• 브랜치(dev/master)에 따라 원하는 환경에 배포합니다.

프런트 엔드

전면 리포지토리용 deploy.yml 파일 벡과 조금 다릅니다. 테스트를 실행하는 단계가 없으며 배포용 토큰 이름이 변경됩니다. 그나저나 전면 저장소의 비밀은 별도로 작성해야 합니다.

사이트 설정

Nginx를 통한 프록시 트래픽

글쎄, 우리는 끝났습니다. Nginx를 통해 컨테이너로 들어오고 나가는 트래픽의 프록시를 구성하는 것만 남아 있습니다. Docker Registry 설정의 5단계에서 이 프로세스를 이미 다뤘습니다. dev 및 prod 환경에서 후면 및 전면 부분에 대해 동일한 작업을 반복해야 합니다.

설정 스크린 샷을 제공하겠습니다.

백엔드

프런트 엔드

중요한 설명. 다음으로 시작하는 URL을 제외한 모든 URL은 프런트엔드 컨테이너에 프록시됩니다. /api/ - 백 컨테이너에 프록시됩니다(그래서 백 컨테이너에서 모든 핸들러는 다음으로 시작해야 합니다. /api/).

결과

이제 우리 사이트는 helloworld.ru 및 dev.helloworld.ru(각각 prod 및 dev 환경)에서 사용할 수 있어야 합니다.

전체적으로 Flask 및 Angular에서 간단한 애플리케이션을 준비하고 Github Actions에서 파이프라인을 설정하여 Plesk를 실행하는 서버에 롤아웃하는 방법을 배웠습니다.

코드를 사용하여 리포지토리에 대한 링크를 복제합니다. 백엔드, 프론트엔드.

출처 : habr.com