@deploystack/docker-to-iac/dist/src/types/container-config.d.ts

Translate docker run and docker compose file to Infrastructure as Code

import { DockerImageInfo, TemplateFormat } from '../parsers/base-parser';
import { EnvironmentVariableGenerationConfig } from './environment-config';
import { ServiceConnectionsConfig, ResolvedServiceConnection } from './service-connections';
export interface PortMapping {
    host: number;
    container: number;
    protocol?: string;
    published?: number;
    target?: number;
}
export interface VolumeMapping {
    host: string;
    container: string;
    mode?: string;
}
export interface ContainerConfig {
    image: DockerImageInfo;
    ports: PortMapping[];
    volumes: VolumeMapping[];
    environment: {
        [key: string]: string;
    };
    command?: string;
    restart?: string;
    envVars?: Array<{
        key: string;
        value?: string;
        fromService?: {
            name: string;
            type: string;
            property: string;
        };
        fromDatabase?: {
            name: string;
            property: string;
        };
    }>;
}
export interface ApplicationConfig {
    services: {
        [key: string]: ContainerConfig;
    };
    serviceConnections?: ResolvedServiceConnection[];
}
export interface FileOutput {
    content: string;
    format: TemplateFormat;
    isMain?: boolean;
}
export interface TranslationResult {
    files: {
        [path: string]: FileOutput;
    };
    serviceConnections?: ResolvedServiceConnection[];
}
export type TranslateOptions = {
    source: 'compose' | 'run';
    target: string;
    templateFormat?: TemplateFormat;
    environmentVariableGeneration?: EnvironmentVariableGenerationConfig;
    environmentVariables?: Record<string, string>;
    persistenceKey?: string;
    serviceConnections?: ServiceConnectionsConfig;
};
export type ListServicesOptions = {
    source: 'compose' | 'run';
    environmentVariableGeneration?: EnvironmentVariableGenerationConfig;
    environmentVariables?: Record<string, string>;
    persistenceKey?: string;
};