ssh-docker

Una Herramienta 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 de Node.JS

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 cambia el siguiente código en tu 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 docker
const carpetaFuente = '/ruta/a/carpeta/de/origen'
const nombreImagen = 'nombre-imagen'
const version = '1.0.0'
await ssh.docker.buildImage(carpetaFuente, nombreImagen, version)

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

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

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

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

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

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

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

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

// construir proyecto de node.js
const registros = await ssh.docker.buildNode('/ruta/a/carpeta/de/origen')

// ejecutar proyecto de node.js
const registros = await ssh.docker.runNode('nombre-contenedor', '/ruta/a/carpeta/de/origen', {
  puerto
})

// ejecutar Nginx
const registros = await ssh.docker.runNginx({
  nombre: 'nombre-contenedor',
  puertos: [
    {
      desde: 443, // puerto del contenedor
      a: 30123 // puerto del host
    }
  ],
  asociaciones: [
    {
      desde: '/usr/source/config', // carpeta del contenedor
      a: '/ruta/a/carpeta/config', // carpeta del host
      soloLectura: true // opcional, por defecto es false
    }
  ]
})

// actualizar configuración de Nginx
await ssh.docker.updateNginx(idDocker)

// ejecutar sitio
await ssh.docker.runSite({
  procesosTrabajador: 2,
  conexionesTrabajador: 2048,
  puerto: 30100,
  dominios: [
    {
      dominio: 'dev.example.com',
      servidores: [
        {
          host: 'dev.example.com',
          puerto: 30001,
          maxFallos: 3,
          maxConexiones: 5
        },
        {
          host: 'dev.example.com',
          puerto: 30002,
          peso: 1
        }
      ]
    }
  ]
})

await ssh.disconnect()