container-helper.js
TypeScript icon, indicating that this package has built-in type declarations

1.0.2 • Public • Published

container-help.js

description

nodejs模块,可以帮助你在nodejs环境跟容器应用比如 docker,podman,lima 等容器应用交互。

(跟docker交互)how to use like a docker

const c = require('container-helper.js')
const docker =c.getVm('docker')
// docker images
docker.showImages().then(images=>console.log(images))

(跟podman交互)how to use like a podman

const c = require('container-helper.js')
const podman =c.getVm('podman')
// docker images
podman.showImages().then(images=>console.log(images))

functions

以docker为例,内置的函数方法

启动容器
  • docker.startVm()
展示所有的images
  • docker.showImages();
build一个image
  • docker.buildImage 其中 dockerFilePath 表示的是dockerFile文件存在的路径。docker.buildImage 会在 dockerFilePath 对应的目录下开始构建镜像
  // docker build -t mysql:latest .  
  docker.buildImage({   
      imageName: "mysql",
      dockerFilePath: path.join(__dirname, "../images/mysql"),
      version: 'latest' 
  });
启动一个容器
  • docker.runImage({});
// docker run -p 3307:3306 -e MYSQL_ROOT_PASSWORD=123456789 --name test-mysql
await docker.runImage({
      p:[3307,3306],
      name: 'test-mysql',
      e: {
        "MYSQL_ROOT_PASSWORD":"123456789"
      }
    })
  
删除一个image
  • docker.removeImage(NAME);
删除一个container
  • docker.removeContainer(NAME)
跑一个命令
  • docker.runCommand(command) 比如命令行:
docker build -t mysql:latest . 

则通过docker容器去跑对应的命令

docker.runCommand("build -t mysql:latest .")

Readme

Keywords

Package Sidebar

Install

npm i container-helper.js

Weekly Downloads

2

Version

1.0.2

License

ISC

Unpacked Size

46.6 kB

Total Files

30

Last publish

Collaborators

  • shingu