@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 или выше

Обязательно использование модулей 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 = '/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)

// запуск контейнера Docker
await ssh.docker.run({
  name: 'container-name',
  image: imageName,
  version: version,
  ports: [{ from: 443, to: 30000 }],
  folders: {
    config: '/path/to/config/folder'
  }
})

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

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

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

// удаление контейнера Docker
await ssh.docker.remove('container-name')

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

await ssh.disconnect()