ssh-docker

Un outil Sumor Cloud.
Plus de documentation

ssh-docker est un outil docker pour @sumor/ssh-tools

Installation

npm i @sumor/ssh-docker --save

Prérequis

Version de Node.JS

Nécessite Node.JS version 18.x ou supérieure

Nécessite Node.JS ES module

Comme ce package est écrit en module ES, veuillez modifier le code suivant dans votre fichier package.json :

{
  "type": "module"
}

Utilisation

Importer l'outil

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

Utiliser l'outil

import SSH from './ssh.js'

const ssh = new SSH(server)

await ssh.connect()

// Construire l'image docker
const sourceFolder = '/chemin/vers/dossier/source'
const nomImage = 'nom-image'
const version = '1.0.0'
await ssh.docker.buildImage(sourceFolder, nomImage, version)

// Liste des images
const images = await ssh.docker.images()

// Vérifier l'existence de l'image
const existe = await ssh.docker.existsImage(nomImage, version)

// Exécuter un conteneur docker
await ssh.docker.run({
  nom: 'nom-conteneur',
  image: nomImage,
  version: version,
  ports: [
    {
      de: 443, // port du conteneur
      vers: 30123 // port de l'hôte
    }
  ],
  bindings: [
    {
      de: '/usr/source/config', // dossier du conteneur
      vers: '/chemin/vers/dossier/config', // dossier de l'hôte
      enLectureSeule: true // optionnel, par défaut : false
    }
  ]
})

// Liste des conteneurs docker
const conteneurs = await ssh.docker.conteneurs()

// Vérifier l'existence du conteneur
const existe = await ssh.docker.exists('nom-conteneur')

// Exécuter une commande dans le conteneur
const resultat = await ssh.docker.exec('nom-conteneur', 'ls -al')

// Supprimer le conteneur docker
await ssh.docker.remove('nom-conteneur')

// Supprimer l'image docker
await ssh.docker.removeImage(nomImage, version)

// Construire un projet node.js
const logs = await ssh.docker.buildNode('/chemin/vers/source')

// Exécuter un projet node.js
const logs = await ssh.docker.runNode('nom-conteneur', '/chemin/vers/source', {
  port
})

// Exécuter Nginx
const logs = await ssh.docker.runNginx({
  nom: 'nom-conteneur',
  ports: [
    {
      de: 443, // port du conteneur
      vers: 30123 // port de l'hôte
    }
  ],
  bindings: [
    {
      de: '/usr/source/config', // dossier du conteneur
      vers: '/chemin/vers/dossier/config', // dossier de l'hôte
      enLectureSeule: true // optionnel, par défaut : false
    }
  ]
})

// Mettre à jour la configuration de Nginx
await ssh.docker.updateNginx(idDocker)

// Exécuter le site
await ssh.docker.runSite({
  processesTravailleur: 2,
  connexionsTravailleur: 2048,
  port: 30100,
  domaines: [
    {
      domaine: 'dev.example.com',
      serveurs: [
        {
          hôte: 'dev.example.com',
          port: 30001,
          maxEchecs: 3,
          maxConnexions: 5
        },
        {
          hôte: 'dev.example.com',
          port: 30002,
          poids: 1
        }
      ]
    }
  ]
})

await ssh.disconnect()