ssh-docker

Sumor Cloud의 도구입니다.
더 많은 문서

ssh-docker는 @sumor/ssh-tools를 위한 도커 도구입니다.

설치

npm i @sumor/ssh-docker --save

전제조건

Node.JS 버전

Node.JS 버전 18.x 이상이 필요합니다.

Node.JS ES 모듈 필요

이 패키지는 ES 모듈로 작성되었으므로, package.json 파일에서 다음 코드를 변경해주세요:

{
  "type": "module"
}

사용법

도구 가져오기

import SSHBasic from '@sumor/ssh-tools'
import docker from '@sumor/ssh-docker'

class SSH extends SSHBasic {
  constructor(config) {
    super(config)
    this.addTool('docker', docker)
  }
}

export default SSH

도구 사용하기

import SSH from './ssh.js'

const ssh = new SSH(server)

await ssh.connect()

// 도커 이미지 빌드하기
const sourceFolder = '/path/to/source/folder'
const imageName = 'image-name'
const version = '1.0.0'
await ssh.docker.buildImage(sourceFolder, imageName, version)

// 이미지 목록
const images = await ssh.docker.images()

// 이미지 존재 여부
const exists = await ssh.docker.existsImage(imageName, version)

// 도커 컨테이너 실행
await ssh.docker.run({
  name: 'container-name',
  image: imageName,
  version: version,
  ports: [
    {
      from: 443, // 컨테이너 포트
      to: 30123 // 호스트 포트
    }
  ],
  bindings: [
    {
      from: '/usr/source/config', // 컨테이너 폴더
      to: '/path/to/config/folder', // 호스트 폴더
      readOnly: true // 선택 사항, 기본값은 false
    }
  ]
})

// 도커 컨테이너 목록
const containers = await ssh.docker.containers()

// 컨테이너 존재 여부
const exists = await ssh.docker.exists('container-name')

// 컨테이너 내 명령 실행
const result = await ssh.docker.exec('container-name', 'ls -al')

// 도커 컨테이너 삭제
await ssh.docker.remove('container-name')

// 도커 이미지 삭제
await ssh.docker.removeImage(imageName, version)

// Node.js 프로젝트 빌드
const logs = await ssh.docker.buildNode('/path/to/source')

// Node.js 프로젝트 실행
const logs = await ssh.docker.runNode('container-name', '/path/to/source', {
  port
})

// Nginx 실행
const logs = await ssh.docker.runNginx({
  name: 'container-name',
  ports: [
    {
      from: 443, // 컨테이너 포트
      to: 30123 // 호스트 포트
    }
  ],
  bindings: [
    {
      from: '/usr/source/config', // 컨테이너 폴더
      to: '/path/to/config/folder', // 호스트 폴더
      readOnly: true // 선택 사항, 기본값은 false
    }
  ]
})

// Nginx 구성 업데이트
await ssh.docker.updateNginx(dockerId)

// 사이트 실행
await ssh.docker.runSite({
  workerProcesses: 2,
  workerConnections: 2048,
  port: 30100,
  domains: [
    {
      domain: 'dev.example.com',
      servers: [
        {
          host: 'dev.example.com',
          port: 30001,
          maxFails: 3,
          maxConns: 5
        },
        {
          host: 'dev.example.com',
          port: 30002,
          weight: 1
        }
      ]
    }
  ]
})

await ssh.disconnect()