ssh-docker

Инструмент Sumor Cloud.
Дополнительная документация

ssh-docker - инструмент Docker для @sumor/ssh-tools

Установка

npm i @sumor/ssh-docker --save

Предварительные требования

Версия Node.JS

Требуется версия Node.JS 18.x или выше

Требование к ES-модулям Node.JS

Так как этот пакет написан на 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()

// построение образа docker
const sourceFolder = '/путь/к/исходной/папке'
const imageName = 'название-образа'
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)

// запуск контейнера docker
await ssh.docker.run({
  name: 'название-контейнера',
  image: imageName,
  version: version,
  ports: [
    {
      from: 443, // порт контейнера
      to: 30123 // порт хоста
    }
  ],
  bindings: [
    {
      from: '/usr/source/config', // папка контейнера
      to: '/путь/к/папке/конфигурации', // папка хоста
      readOnly: true // опционально, по умолчанию false
    }
  ]
})

// список контейнеров docker
const containers = await ssh.docker.containers()

// существует ли контейнер
const exists = await ssh.docker.exists('название-контейнера')

// выполнить команду в контейнере
const result = await ssh.docker.exec('название-контейнера', 'ls -al')

// удалить контейнер docker
await ssh.docker.remove('название-контейнера')

// удалить образ docker
await ssh.docker.removeImage(imageName, version)

// построение проекта node.js
const logs = await ssh.docker.buildNode('/путь/к/исходной')

// выполнить проект node.js
const logs = await ssh.docker.runNode('название-контейнера', '/путь/к/исходной', {
  порт
})

// запустить Nginx
const logs = await ssh.docker.runNginx({
  name: 'название-контейнера',
  ports: [
    {
      from: 443, // порт контейнера
      to: 30123 // порт хоста
    }
  ],
  bindings: [
    {
      from: '/usr/source/config', // папка контейнера
      to: '/путь/к/папке/конфигурации', // папка хоста
      readOnly: true // опционально, по умолчанию false
    }
  ]
})

// обновить конфигурацию Nginx
await ssh.docker.updateNginx(dockerId)

// запустить сайт
await ssh.docker.runSite({
  workerProcesses: 2,
  workerConnections: 2048,
  порт: 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()