API 参考 / @142vip/utils / VipDocker

const VipDocker: object

定义于: packages/utils/src/core/docker.ts:402

docker工具

buildImage: (args) => Promise<void>

构建Docker镜像

• 根据tag标记，推送到远程仓库
• 推送完成后，删除本地镜像

BuildImageDockerOptions

Promise<void>

createContainer: (args) => Promise<void>

创建容器

CreateContainerOptions

Promise<void>

createNetwork: (options) => Promise<boolean>

创建网络

CreateNetworkOptions

Promise<boolean>

deleteContainer: (containerName) => Promise<boolean>

删除容器

string

Promise<boolean>

deleteForceContainer: (containerName) => Promise<boolean>

强制删除容器，同时删除镜像

string

Promise<boolean>

deleteImage: (imageName) => Promise<CommandResponse>

删除Docker镜像

string

Promise<CommandResponse>

deletePruneImages: () => Promise<CommandResponse>

删除虚悬镜像

Promise<CommandResponse>

getImageAddress: (containerName) => Promise<null | string>

基于容器名获取镜像地址

string

Promise<null | string>

isExistContainer: (containerName) => Promise<boolean>

判断容器是否存在

string

Promise<boolean>

isExistDocker: (args?) => Promise<boolean>

是否安装docker

DockerOptions

Promise<boolean>

isExistDockerCompose: (args?) => Promise<boolean>

是否安装docker-compose

DockerOptions

Promise<boolean>

isExistImage: (imageName) => Promise<boolean>

判断是否存在镜像

string

Promise<boolean>

isExistNetwork: (networkName) => Promise<boolean>

判断网络是否存在

string

Promise<boolean>

listContainer: () => Promise<void>

查询所有容器

Promise<void>

listContainerNames: () => Promise<string[]>

列出所有正在运行的容器名称

Promise<string[]>

listContainerStatus: () => Promise<object[]>

列出所有容器名称、状态

Promise<object[]>

listNetworkNames: () => Promise<string[]>

列举出所有的网络名称

Promise<string[]>

listNoRunningContainerNames: () => Promise<string[]>

列出所有未运行的容器名称

Promise<string[]>

listPruneImages: () => Promise<void>

列出虚线镜像

Promise<void>

listRunningContainer: () => Promise<void>

查看正在运行的容器

Promise<void>

listRunningContainerNames: () => Promise<string[]>

列出所有正在运行的容器名称

Promise<string[]>

pullImage: (imageAddress) => Promise<void>

string

Promise<void>

pushImage: (imageName) => Promise<void>

推送Docker镜像到指定仓库

string

Promise<void>

scriptExecutor: (command) => Promise<void>

docker命令的通用执行器

string

Promise<void>

userLogin: (args) => Promise<void>

用户登录

UserLoginDockerOptions

Promise<void>