Backstage
    Preparing search index...

    Interface TechDocsContainerRunner

    Handles the running of containers to generate TechDocs.

    Custom implementations, e.g. for Kubernetes or other execution environments, can be inspired by the internal default implementation DockerContainerRunner.

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

    • Runs a container image to completion.

      Parameters

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

      Returns Promise<void>

    Settings
    Member Visibility

    On This Page
    Methods