@sumor/ssh-docker

ssh-docker

Ein Sumor Cloud Tool.
Weitere Dokumentation

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

CI Test Coverage Audit

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

// Bilderliste
const images = await ssh.docker.images()

// Existiert Bild
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, to: 30000 }],
  folders: {
    config: '/Pfad/zum/Konfigurationsordner'
  }
})

// Docker-Containerliste
const containers = await ssh.docker.containers()

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