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 la version Node.JS 18.x ou supérieure

Nécessite Node.JS module ES

Comme ce package est écrit en module ES, merci de changer 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 dossierSource = '/chemin/vers/dossier/source'
const nomImage = 'nom-image'
const version = '1.0.0'
await ssh.docker.buildImage(dossierSource, 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)

// Lancer 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
    }
  ],
  dossiers: [
    {
      de: '/usr/source/config', // dossier du conteneur
      vers: '/chemin/vers/dossier/config', // dossier de l'hôte
      enLectureSeule: true // facultatif, par défaut false
    }
  ]
})

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

// 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 un conteneur docker
await ssh.docker.remove('nom-conteneur')

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

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

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

await ssh.disconnect()