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 // ホストのポート
    }
  ],
  bindings: [
    {
      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)

// Node.js プロジェクトのビルド
const logs = await ssh.docker.buildNode('/path/to/source')

// Node.js プロジェクトの実行
const logs = await ssh.docker.runNode('container-name', '/path/to/source', {
  port
})

// Nginx の実行
const logs = await ssh.docker.runNginx({
  name: 'container-name',
  ports: [
    {
      from: 443, // コンテナのポート
      to: 30123 // ホストのポート
    }
  ],
  bindings: [
    {
      from: '/usr/source/config', // コンテナ内のフォルダ
      to: '/path/to/config/folder', // ホストのフォルダ
      readOnly: true // オプション, デフォルトは false
    }
  ]
})

// Nginx の設定更新
await ssh.docker.updateNginx(dockerId)

// サイトの実行
await ssh.docker.runSite({
  workerProcesses: 2,
  workerConnections: 2048,
  port: 30100,
  domains: [
    {
      domain: 'dev.example.com',
      servers: [
        {
          host: 'dev.example.com',
          port: 30001,
          maxFails: 3,
          maxConns: 5
        },
        {
          host: 'dev.example.com',
          port: 30002,
          weight: 1
        }
      ]
    }
  ]
})

await ssh.disconnect()