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

// 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: 30123 // ホストポート
    }
  ],
  folders: [
    {
      from: '/usr/source/config', // コンテナフォルダ
      to: '/path/to/config/folder', // ホストフォルダ
      readOnly: true // オプション、デフォルトはfalse
    }
  ]
})

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