Version: Next

TechDocsContainerRunner.runContainer()

Home > @backstage/plugin-techdocs-node > TechDocsContainerRunner > runContainer

Runs a container image to completion.

Signature:

runContainer(opts: {
        imageName: string;
        command?: string | string[];
        args: string[];
        logStream?: Writable;
        mountDirs?: Record<string, string>;
        workingDir?: string;
        envVars?: Record<string, string>;
        pullImage?: boolean;
        defaultUser?: boolean;
        pullOptions?: {
            authconfig?: {
                username?: string;
                password?: string;
                auth?: string;
                email?: string;
                serveraddress?: string;
                [key: string]: unknown;
            };
            [key: string]: unknown;
        };
    }): Promise<void>;

Parameters

Parameter	Type	Description
opts	{ imageName: string; command?: string \| string[]; args: string[]; logStream?: Writable; mountDirs?: Record<string, string>; workingDir?: string; envVars?: Record<string, string>; pullImage?: boolean; defaultUser?: boolean; pullOptions?: { authconfig?: { username?: string; password?: string; auth?: string; email?: string; serveraddress?: string; [key: string]: unknown; }; [key: string]: unknown; }; }

Returns:

Promise<void>

Parameters​

Parameters