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

Requisitos previos

Version de Node.JS

Requiere Node.JS versión 18.x o superior

Requiere Node.JS Módulo ES

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 la 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 la herramienta

import SSH from './ssh.js'

const ssh = new SSH(server)

await ssh.connect()

// construir imagen de docker
const sourceFolder = '/ruta/a/carpeta/de/origen'
const imageName = 'nombre-de-imagen'
const version = '1.0.0'
await ssh.docker.buildImage(sourceFolder, imageName, version)

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

// verificar si existe una imagen
const exists = await ssh.docker.existsImage(imageName, version)

// ejecutar contenedor de docker
await ssh.docker.run({
  name: 'nombre-de-contenedor',
  image: imageName,
  version: version,
  ports: [
    {
      from: 443, // puerto del contenedor
      to: 30123 // puerto del host
    }
  ],
  bindings: [
    {
      from: '/usr/source/config', // carpeta del contenedor
      to: '/ruta/a/carpeta/config', // carpeta del host
      readOnly: true // opcional, por defecto es false
    }
  ]
})

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

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

// ejecutar comando en el contenedor
const result = 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(imageName, version)

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

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

// ejecutar Nginx
const logs = await ssh.docker.runNginx({
  name: 'nombre-de-contenedor',
  ports: [
    {
      from: 443, // puerto del contenedor
      to: 30123 // puerto del host
    }
  ],
  bindings: [
    {
      from: '/usr/source/config', // carpeta del contenedor
      to: '/ruta/a/carpeta/config', // carpeta del host
      readOnly: true // opcional, por defecto es false
    }
  ]
})

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

// ejecutar sitio
await ssh.docker.runSite({
  workerProcesses: 2,
  workerConnections: 2048,
  port: 30100,
  domains: [
    {
      domain: 'dev.example.com',
      servers: [
        {
          host: 'dev.example.com',
          port: 30001,
          maxFails: 3,
          maxConns: 5
        },
        {
          host: 'dev.example.com',
          port: 30002,
          weight: 1
        }
      ]
    }
  ]
})

await ssh.disconnect()