ssh-docker

Una herramienta de Sumor Cloud.
Más documentación

ssh-docker es una herramienta docker para @sumor/ssh-tools

Instalación

npm i @sumor/ssh-docker --save

Prerrequisitos

Versión de Node.JS

Se requiere la versión de Node.JS 18.x o superior

Se requiere módulo ES de Node.JS

Dado que este paquete está escrito en módulo ES, por favor cambie el siguiente código en su archivo package.json:

{
  "type": "module"
}

Uso

Importar herramienta

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

Usar herramienta

import SSH from './ssh.js'

const ssh = new SSH(server)

await ssh.connect()

// Construir imagen de docker
const carpetaOrigen = '/ruta/a/carpeta/de/origen'
const nombreImagen = 'nombre-de-imagen'
const version = '1.0.0'
await ssh.docker.buildImage(carpetaOrigen, nombreImagen, version)

// Listar imágenes
const imagenes = await ssh.docker.images()

// Verificar existencia de imagen
const existe = await ssh.docker.existsImage(nombreImagen, version)

// Ejecutar contenedor de docker
await ssh.docker.run({
  nombre: 'nombre-de-contenedor',
  imagen: nombreImagen,
  version: version,
  puertos: [{ desde: 443, a: 30000 }],
  carpetas: {
    config: '/ruta/a/carpeta/de/configuracion'
  }
})

// Listar contenedores de docker
const contenedores = await ssh.docker.containers()

// Verificar existencia de contenedor
const existe = await ssh.docker.exists('nombre-de-contenedor')

// Ejecutar comando en el contenedor
const resultado = await ssh.docker.exec('nombre-de-contenedor', 'ls -al')

// Eliminar contenedor de docker
await ssh.docker.remove('nombre-de-contenedor')

// Eliminar imagen de docker
await ssh.docker.removeImage(nombreImagen, version)

await ssh.disconnect()