@lime.it/blip-core/docker-machine.d.ts

Blip cli basic abstractions and functionalities

import { ToolingDependecy } from './model';
export declare type DockerMachineListField = 'name' | 'active' | 'driver' | 'state' | 'url' | 'swarm' | 'docker' | 'errors';
export declare type DockerMachineState = 'Running' | 'Paused' | 'Saved' | 'Stopped' | 'Stopping' | 'Starting' | 'Error' | 'Timeout';
export interface DockerMachineListResult {
    name?: string;
    active?: string;
    activeHost?: string;
    activeSwarm?: string;
    driverName?: string;
    state?: DockerMachineState;
    URL?: string;
    swarm?: string;
    error?: string;
    dockerVersion?: string;
    responseTime?: string;
}
export declare function isMachineStarty(state: DockerMachineState): boolean;
export declare function isMachineStoppy(state: DockerMachineState): boolean;
export declare function isMachineStuck(state: DockerMachineState): boolean;
export interface DockerMachineEnv {
    DOCKER_TLS_VERIFY: string;
    DOCKER_HOST: string;
    DOCKER_CERT_PATH: string;
    DOCKER_MACHINE_NAME: string;
    COMPOSE_CONVERT_WINDOWS_PATHS: string;
}
export declare function getMachineAddress(env: DockerMachineEnv): string;
export interface DockerMachineCreateOptions {
    driver: string;
    engineRegistryMirror: string[] | null;
    engineInsecureRegistry: string[] | null;
}
export declare abstract class DockerMachineTool extends ToolingDependecy {
    abstract ls(...fields: (keyof DockerMachineListResult)[]): Promise<DockerMachineListResult[]>;
    abstract create(name: string, options: Partial<DockerMachineCreateOptions>, direverOptions: {
        [key: string]: string;
    }): Promise<void>;
    abstract env(name: string, shell: string): Promise<DockerMachineEnv>;
    abstract envStdout(name: string, shell: string): Promise<string>;
    abstract start(name: string): Promise<void>;
    abstract stop(name: string): Promise<void>;
    abstract remove(name: string): Promise<void>;
}
export declare const DockerMachine: DockerMachineTool;