Github 작업으로 PM2 CI 배포 설정

pm2 을 사용하여 CI용으로 일부 Github 작업을 설정하는 데 오후를 보냈습니다. SSH 문제와 관련하여 몇 가지 문제와 혼란이 있었고 온라인에서 아무 것도 찾을 수 없었으므로 나중에 참조하기 위한 것이더라도 여기에 게시하고 싶었습니다. 특히 Github 액션에서 배포를 시도할 때 Host key verification failed. 처리했습니다.

PM2에 익숙하지 않은 경우 node.js 앱을 실행하여 중지, 재시작 및 로그 보기를 허용하는 프로세스 관리자입니다.

DigitalOcean 액적에 배포하고 있지만 다음은 다른 VPS에 대해서도 동일해야 합니다. 다음은 동일한 설정을 다시 만들기 위해 따를 수 있는 몇 가지 자습서입니다.

Set up a new Ubuntu droplet & sudo user

Set up Node.js & serve with Nginx

Set up PM2

서버를 설정하고 Github에서 리포지토리를 호스팅했으면 다음 단계를 따르세요.

1. PM2 구성 설정

생성 또는 업데이트ecosystem.config.js . 내 모습은 다음과 같습니다.

module.exports = {
  apps: [
    {
      name: 'myapp-api',
      script: 'yarn start:api',
      time: true,
      instances: 1,
      autorestart: true,
      max_restarts: 50,
      watch: false,
      max_memory_restart: '1G',
      env: {
        PORT: 3000,
        DATABASE_ADDRESS: process.env.DATABASE_ADDRESS
      },
    },
  ],
  deploy: {
    production: {
      user: 'username',
      host: '165.232.50.103',
      key: 'deploy.key',
      ref: 'origin/main',
      repo: 'https://github.com/username/myapp',
      path: '/home/username/myapp',
      'post-deploy':
        'yarn install && yarn build && pm2 reload ecosystem.config.js --env production && pm2 save && git checkout yarn.lock',
      env: {
        NODE_ENV: 'production',
        DATABASE_ADDRESS: process.env.DATABASE_ADDRESS
      },
    },
  },
}

deploy.production.key 값이 누락되지 않았는지, ref가 github에서 배포하려는 분기와 일치하는지 확인하십시오. (내 master 분기의 이름을 main 로 변경했습니다. npx no-masters 참조)

2. SSH 키 쌍 생성

작업을 수행하려면 github 작업을 실행하는 시스템에서 원격 서버로 ssh할 수 있어야 합니다. 다음 단계는 몇 가지 새로운 SSH 키를 만드는 것입니다. (이미 가지고 있는 것을 사용할 수 있지만 이 프로젝트를 위해 새 것을 만드는 것이 더 안전합니다.)

로컬 컴퓨터에서 다음을 실행합니다.
ssh-keygen -t rsa -b 4096 -C "username@SERVER_IP" -q -N ""
파일 위치를 묻는 메시지가 표시되면 gh_rsa 또는 원하는 다른 항목을 입력합니다. 필요한 정보를 얻은 후 이러한 파일을 삭제합니다.

3. 원격 서버 설정

공개 파일의 내용을 복사합니다. cat gh_rsa.pub | pbcopy (또는 pbcopy 가 없는 경우 cat 만 복사한 다음 터미널 출력에서 ​​복사합니다).

원격 서버에 SSH로 연결: ssh username@SERVER_IP

사용자의 공개 키를 추가하십시오. authorized_keys :

echo "ssh-rsa AAAA....YOUR_PUBLIC_KEY..." >> ~/.ssh/authorized_keys

4. Github Secrets 설정

다음으로 작업에 사용할 몇 가지 비밀을 Github 리포지토리에 추가합니다. 리포지토리의 설정 > 비밀 창으로 이동한 다음 두 개의 새 키를 추가합니다.

비밀 키:

cat gh_rsa | pbcopy 개인 키를 클립보드에 복사

Github에서 SSH_PRIVATE_KEY라는 새 비밀을 만들고 내용을 붙여넣습니다.

알려진 호스트:

ssh-keyscan SERVER_IP > pbcopy

Github에서 SSH_KNOWN_HOSTS라는 새 비밀을 만들고 내용을 붙여넣습니다.

5. Github 액션 구성

마지막으로 로컬 시스템에서 파일.github/workflows/main.yml(또는 작업에 사용 중인 파일)을 생성하거나 업데이트합니다.

name: CI - Master
  on:
    push:
      branches: [ main ]

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      #
      # ... your other steps, such as running tests, etc...
      #
      - name: Set up SSH
        run: |
          mkdir -p ~/.ssh/
          echo "$SSH_PRIVATE_KEY" > ./deploy.key
          sudo chmod 600 ./deploy.key
          echo "$SSH_KNOWN_HOSTS" > ~/.ssh/known_hosts
        shell: bash
        env:
          SSH_PRIVATE_KEY: ${{secrets.SSH_PRIVATE_KEY}}
          SSH_KNOWN_HOSTS: ${{secrets.SSH_KNOWN_HOSTS}}

      # (optional - only needed if your config uses environment variables)
      - name: Create env file
        run: |
          touch .env
          echo DATABASE_ADDRESS=${{ secrets.DATABASE_ADDRESS }} >> .env

      - name: Install PM2
        run: npm i pm2

      - name: Deploy
        run: env $(cat .env | grep -v \"#\" | xargs) pm2 deploy ecosystem.config.js staging
        # Or alternately, put this deploy script in your package.json's scripts and run it using yarn/npm:
        # run: yarn deploy

주요 단계는 다음과 같습니다.

SSH 설정: 이것은 deploy.key 파일을 생성하므로 pm2가 배포될 때 서버의 authorized_keys 에 추가한 공개 키와 일치합니다.

Env 파일 생성: PM2 구성이 환경 변수를 사용하는 경우 Github 비밀을 사용하여 이러한 변수로 채워야 합니다process.env. "배포"단계에서 env 명령을 사용하여 생성한 파일을 로드합니다.

6. 정리 및 보안

deploy.env를 .gitignore 파일에 추가합니다.

우리가 생성한 gh_rsa 및 gh_rsa.pub 파일을 삭제합니다. 가장 중요한 것은 프로젝트 디렉토리에 SSH 키를 생성한 경우 커밋하지 않는 것입니다.

결론

그것은 그것을해야합니다! 문제가 있는 경우 댓글을 남겨주시면 최대한 빨리 답변해 드리겠습니다. :)