techdocs-node: containerRunner api report

Signed-off-by: Vincenzo Scamporlino <vincenzos@spotify.com>
This commit is contained in:
Vincenzo Scamporlino
2024-05-02 14:23:07 +02:00
parent f62d673ae8
commit 21c750bd6f
+18 -2
View File
@@ -7,7 +7,6 @@
import { CompoundEntityRef } from '@backstage/catalog-model';
import { Config } from '@backstage/config';
import { ContainerRunner } from '@backstage/backend-common';
import { Entity } from '@backstage/catalog-model';
import express from 'express';
import { ExtensionPoint } from '@backstage/backend-plugin-api';
@@ -19,6 +18,11 @@ import { UrlReader } from '@backstage/backend-common';
import * as winston from 'winston';
import { Writable } from 'stream';
// @public
export interface ContainerRunner {
runContainer(opts: RunContainerOptions): Promise<void>;
}
// @public
export class DirectoryPreparer implements PreparerBase {
static fromConfig(config: Config, options: PreparerConfig): DirectoryPreparer;
@@ -72,7 +76,6 @@ export class Generators implements GeneratorBuilder {
config: Config,
options: {
logger: Logger;
containerRunner: ContainerRunner;
customGenerator?: TechdocsGenerator;
},
): Promise<GeneratorBuilder>;
@@ -236,6 +239,19 @@ export type ReadinessResponse = {
// @public
export type RemoteProtocol = 'url' | 'dir';
// @public
export type RunContainerOptions = {
imageName: string;
command?: string | string[];
args: string[];
logStream?: Writable;
mountDirs?: Record<string, string>;
workingDir?: string;
envVars?: Record<string, string>;
pullImage?: boolean;
defaultUser?: boolean;
};
// @public
export type SupportedGeneratorKey = 'techdocs' | string;