ssh-docker

Sumor Cloud ツール。
詳細なドキュメント

ssh-dockerは@sumor/ssh-tools向けのDockerツールです。

インストール

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: 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')

// コンテナを削除する
await ssh.docker.remove('container-name')

// イメージを削除する
await ssh.docker.removeImage(imageName, version)

await ssh.disconnect()