ssh-docker

Una Herramienta de Sumor Cloud.
Más Documentación

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

Instalación

npm i @sumor/ssh-docker --save

Prerrequisitos

Versión Node.JS

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

Requiere módulo ES de Node.JS

Como 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(servidor)

await ssh.connect()

// construir imagen de docker
const carpetaFuente = '/ruta/a/carpeta/fuente'
const nombreImagen = 'nombre-imagen'
const versión = '1.0.0'
await ssh.docker.buildImage(carpetaFuente, nombreImagen, versión)

// lista de imágenes
const imágenes = await ssh.docker.images()

// verificar si existe imagen
const existe = await ssh.docker.existsImage(nombreImagen, versión)

// ejecutar contenedor de docker
await ssh.docker.run({
  nombre: 'nombre-contenedor',
  imagen: nombreImagen,
  versión: versión,
  puertos: [
    {
      desde: 443, // puerto del contenedor
      a: 30123 // puerto del host
    }
  ],
  carpetas: [
    {
      desde: '/usr/source/config', // carpeta del contenedor
      a: '/ruta/a/carpeta/config', // carpeta del host
      soloLectura: true // opcional, el valor predeterminado es false
    }
  ]
})

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

// verificar si existe contenedor
const existe = await ssh.docker.exists('nombre-contenedor')

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

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

// eliminar imagen de docker
await ssh.docker.removeImage(nombreImagen, versión)

await ssh.disconnect()