@sumor/ssh-docker

ssh-docker

一个Sumor Cloud工具。
更多文档

ssh-docker是一个用于@sumor/ssh-tools的docker工具

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 = '/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'
  }
})

// 容器列表
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()