Function generateFeaturesComposeOverrideContent

src/spec-node/dockerCompose.ts:504–573

(
	updatedImageName: string,
	originalImageName: string,
	mergedConfig: MergedDevContainerConfig,
	config: DevContainerFromDockerComposeConfig,
	versionPrefix: string,
	imageDetails: () => Promise<ImageDetails>,
	service: any,
	additionalLabels: string[],
	additionalMounts: Mount[],
	params: DockerResolverParameters,
)

}

async function generateFeaturesComposeOverrideContent(
	updatedImageName: string,
	originalImageName: string,
	mergedConfig: MergedDevContainerConfig,
	config: DevContainerFromDockerComposeConfig,
	versionPrefix: string,
	imageDetails: () => Promise<ImageDetails>,
	service: any,
	additionalLabels: string[],
	additionalMounts: Mount[],
	params: DockerResolverParameters,
) {
	const overrideImage = updatedImageName !== originalImageName;

	const user = mergedConfig.containerUser;
	const env = mergedConfig.containerEnv || {};
	const capAdd = mergedConfig.capAdd || [];
	const securityOpts = mergedConfig.securityOpt || [];
	const mounts = [
		...mergedConfig.mounts || [],
		...additionalMounts,
	].map(m => typeof m === 'string' ? parseMount(m) : m);
	const namedVolumeMounts = mounts.filter(m => m.type === 'volume' && m.source);
	const customEntrypoints = mergedConfig.entrypoints || [];
	const composeEntrypoint: string[] | undefined = typeof service.entrypoint === 'string' ? shellQuote.parse(service.entrypoint) : service.entrypoint;
	const composeCommand: string[] | undefined = typeof service.command === 'string' ? shellQuote.parse(service.command) : service.command;
	const { overrideCommand } = mergedConfig;
	const userEntrypoint = overrideCommand ? [] : composeEntrypoint /* $ already escaped. */
		|| ((await imageDetails()).Config.Entrypoint || []).map(c => c.replace(/\$/g, '$$$$')); // $ > $$ to escape docker-compose.yml's interpolation.
	const userCommand = overrideCommand ? [] : composeCommand /* $ already escaped. */
		|| (composeEntrypoint ? [/* Ignore image CMD per docker-compose.yml spec. */] : ((await imageDetails()).Config.Cmd || []).map(c => c.replace(/\$/g, '$$$$'))); // $ > $$ to escape docker-compose.yml's interpolation.

	const hasGpuRequirement = config.hostRequirements?.gpu;
	const addGpuCapability = hasGpuRequirement && await checkDockerSupportForGPU(params);
	if (hasGpuRequirement && hasGpuRequirement !== 'optional' && !addGpuCapability) {
		params.common.output.write('No GPU support found yet a GPU was required - consider marking it as "optional"', LogLevel.Warning);
	}
	const gpuResources = addGpuCapability ? `
    deploy:
      resources:
        reservations:
          devices:
            - capabilities: [gpu]` : '';

	return `${versionPrefix}services:
  '${config.service}':${overrideImage ? `
    image: ${updatedImageName}` : ''}
    entrypoint: ["/bin/sh", "-c", "echo Container started\\n
trap \\"exit 0\\" 15\\n
${customEntrypoints.join('\\n\n')}\\n
exec \\"$$@\\"\\n
while sleep 1 & wait $$!; do :; done", "-"${userEntrypoint.map(a => `, ${JSON.stringify(a)}`).join('')}]${userCommand !== composeCommand ? `
    command: ${JSON.stringify(userCommand)}` : ''}${mergedConfig.init ? `
    init: true` : ''}${user ? `
    user: ${user}` : ''}${Object.keys(env).length ? `
    environment:${Object.keys(env).map(key => `
      - '${key}=${String(env[key]).replace(/\n/g, '\\n').replace(/\$/g, '$$$$').replace(/'/g, '\'\'')}'`).join('')}` : ''}${mergedConfig.privileged ? `
    privileged: true` : ''}${capAdd.length ? `