@sumor/ssh-docker

ssh-docker

Sumor Cloud Tool.
Документация

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

CI Test Coverage Audit

Установка

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()

// сборка образа 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 // порт хоста
    }
  ],
  folders: [
    {
      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)

await ssh.disconnect()