@142vip.utils.Variable.VipDocker

API 参考 / @142vip/utils / VipDocker

Variable: VipDocker

const VipDocker: object

Defined in: packages/utils/src/core/docker.ts:402

docker工具

Type Declaration

buildImage()

buildImage: (args) => Promise<void>

构建Docker镜像

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

Parameters

args

BuildImageDockerOptions

Returns

Promise<void>

createContainer()

createContainer: (args) => Promise<void>

创建容器

Parameters

args

CreateContainerOptions

Returns

Promise<void>

createNetwork()

createNetwork: (options) => Promise<boolean>

创建网络

Parameters

options

CreateNetworkOptions

Returns

Promise<boolean>

deleteContainer()

deleteContainer: (containerName) => Promise<boolean>

删除容器

Parameters

containerName

string

Returns

Promise<boolean>

deleteForceContainer()

deleteForceContainer: (containerName) => Promise<boolean>

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

Parameters

containerName

string

Returns

Promise<boolean>

deleteImage()

deleteImage: (imageName) => Promise<CommandResponse>

删除Docker镜像

Parameters

imageName

string

Returns

Promise<CommandResponse>

deletePruneImages()

deletePruneImages: () => Promise<CommandResponse>

删除虚悬镜像

Returns

Promise<CommandResponse>

getImageAddress()

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

基于容器名获取镜像地址

Parameters

containerName

string

Returns

Promise<null | string>

isExistContainer()

isExistContainer: (containerName) => Promise<boolean>

判断容器是否存在

Parameters

containerName

string

Returns

Promise<boolean>

isExistDocker()

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

是否安装docker

Parameters

args?

DockerOptions

Returns

Promise<boolean>

isExistDockerCompose()

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

是否安装docker-compose

Parameters

args?

DockerOptions

Returns

Promise<boolean>

isExistImage()

isExistImage: (imageName) => Promise<boolean>

判断是否存在镜像

Parameters

imageName

string

Returns

Promise<boolean>

isExistNetwork()

isExistNetwork: (networkName) => Promise<boolean>

判断网络是否存在

Parameters

networkName

string

Returns

Promise<boolean>

listContainer()

listContainer: () => Promise<void>

查询所有容器

Returns

Promise<void>

listContainerNames()

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

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

Returns

Promise<string[]>

listContainerStatus()

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

列出所有容器名称、状态

Returns

Promise<object[]>

listNetworkNames()

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

列举出所有的网络名称

Returns

Promise<string[]>

listNoRunningContainerNames()

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

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

Returns

Promise<string[]>

listPruneImages()

listPruneImages: () => Promise<void>

列出虚线镜像

Returns

Promise<void>

listRunningContainer()

listRunningContainer: () => Promise<void>

查看正在运行的容器

Returns

Promise<void>

listRunningContainerNames()

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

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

Returns

Promise<string[]>

pullImage()

pullImage: (imageAddress) => Promise<void>

Parameters

imageAddress

string

Returns

Promise<void>

pushImage()

pushImage: (imageName) => Promise<void>

推送Docker镜像到指定仓库

Parameters

imageName

string

Returns

Promise<void>

scriptExecutor()

scriptExecutor: (command) => Promise<void>

docker命令的通用执行器

Parameters

command

string

Returns

Promise<void>

userLogin()

userLogin: (args) => Promise<void>

用户登录

Parameters

args

UserLoginDockerOptions

Returns

Promise<void>