ssh-docker

Ein Sumor Cloud Tool.
Weitere Dokumentation

ssh-docker ist ein Docker-Tool für @sumor/ssh-tools

Installation

npm i @sumor/ssh-docker --save

Voraussetzungen

Node.JS Version

Node.JS Version 18.x oder höher erforderlich

Erforderliches Node.JS ES-Modul

Da dieses Paket in ES-Modul geschrieben ist, bitte ändern Sie den folgenden Code in Ihrer package.json Datei:

{
  "type": "module"
}

Verwendung

Werkzeug importieren

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

Werkzeug verwenden

import SSH from './ssh.js'

const ssh = new SSH(server)

await ssh.connect()

// Docker-Image erstellen
const sourceFolder = '/Pfad/zum/Quellordner'
const imageName = 'image-name'
const version = '1.0.0'
await ssh.docker.buildImage(sourceFolder, imageName, version)

// Liste der Images
const images = await ssh.docker.images()

// Existierendes Image
const exists = await ssh.docker.existsImage(imageName, version)

// Docker-Container ausführen
await ssh.docker.run({
  name: 'container-name',
  image: imageName,
  version: version,
  ports: [
    {
      from: 443, // Container-Port
      to: 30123 // Host-Port
    }
  ],
  bindings: [
    {
      from: '/usr/source/config', // Container-Ordner
      to: '/Pfad/zum/Config-Ordner', // Host-Ordner
      readOnly: true // optional, Standard ist false
    }
  ]
})

// Liste der Docker-Container
const containers = await ssh.docker.containers()

// Existierender Container
const exists = await ssh.docker.exists('container-name')

// Befehl im Container ausführen
const result = await ssh.docker.exec('container-name', 'ls -al')

// Docker-Container löschen
await ssh.docker.remove('container-name')

// Docker-Image löschen
await ssh.docker.removeImage(imageName, version)

// Node.js-Projekt erstellen
const logs = await ssh.docker.buildNode('/Pfad/zum/Quellordner')

// Node.js-Projekt ausführen
const logs = await ssh.docker.runNode('container-name', '/Pfad/zum/Quellordner', {
  port
})

// Nginx ausführen
const logs = await ssh.docker.runNginx({
  name: 'container-name',
  ports: [
    {
      from: 443, // Container-Port
      to: 30123 // Host-Port
    }
  ],
  bindings: [
    {
      from: '/usr/source/config', // Container-Ordner
      to: '/Pfad/zum/Config-Ordner', // Host-Ordner
      readOnly: true // optional, Standard ist false
    }
  ]
})

// Nginx-Konfiguration aktualisieren
await ssh.docker.updateNginx(dockerId)

// Site ausführen
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()