ssh-docker

Ein Sumor Cloud Tool.
Mehr Dokumentation

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

Installation

npm i @sumor/ssh-docker --save

Voraussetzungen

Node.JS-Version

Erfordert Node.JS-Version 18.x oder höher

Erforderliches Node.JS ES-Modul

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

{
  "type": "module"
}

Verwendung

Tool 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

Tool 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
    }
  ],
  folders: [
    {
      from: '/usr/source/config', // Container-Verzeichnis
      to: '/Pfad/zum/Konfigurationsordner', // Host-Verzeichnis
      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)

await ssh.disconnect()