DockerfileStage

Handle

📦 Aspire.Hosting v13.6.0

interface DockerfileStage {
  addContainerFiles(
      resource: IResource,
      rootDestinationPath: string,
      logger?: ILogger): DockerfileStage;
  arg(
      name: string,
      defaultValue?: string): DockerfileStage;
  cmd(command: string[]): DockerfileStage;
  comment(comment: string): DockerfileStage;
  copy(
      source: string,
      destination: string,
      chown?: string): DockerfileStage;
  copyFrom(
      from: string,
      source: string,
      destination: string,
      chown?: string): DockerfileStage;
  emptyLine(): DockerfileStage;
  entrypoint(command: string[]): DockerfileStage;
  env(
      name: string,
      value: string): DockerfileStage;
  expose(port: number): DockerfileStage;
  run(command: string): DockerfileStage;
  runWithMounts(
      command: string,
      mounts: string[]): DockerfileStage;
  user(user: string): DockerfileStage;
  workDir(path: string): DockerfileStage;
}

14 members

Methods

methodaddContainerFiles

Adds COPY --from statements for published container files

addContainerFiles(
    resource: IResource,
    rootDestinationPath: string,
    logger?: ILogger): DockerfileStage

Parameters

resourceIResource

rootDestinationPathstring

loggerILoggeroptional

Returns

DockerfileStage

methodarg

Adds an ARG statement to a Dockerfile stage

arg(
    name: string,
    defaultValue?: string): DockerfileStage

Parameters

namestring

defaultValuestringoptional

Returns

DockerfileStage

methodcmd

Adds a CMD statement to a Dockerfile stage

cmd(command: string[]): DockerfileStage

Parameters

commandstring[]

Returns

DockerfileStage

methodcomment

Adds a comment to a Dockerfile stage

comment(comment: string): DockerfileStage

Parameters

commentstring

Returns

DockerfileStage

methodcopy

Adds a COPY statement to a Dockerfile stage

copy(
    source: string,
    destination: string,
    chown?: string): DockerfileStage

Parameters

sourcestring

destinationstring

chownstringoptional

Returns

DockerfileStage

methodcopyFrom

Adds a COPY --from statement to a Dockerfile stage

copyFrom(
    from: string,
    source: string,
    destination: string,
    chown?: string): DockerfileStage

Parameters

fromstring

sourcestring

destinationstring

chownstringoptional

Returns

DockerfileStage

methodemptyLine

Adds an empty line to a Dockerfile stage

emptyLine(): DockerfileStage

Returns

DockerfileStage

methodentrypoint

Adds an ENTRYPOINT statement to a Dockerfile stage

entrypoint(command: string[]): DockerfileStage

Parameters

commandstring[]

Returns

DockerfileStage

methodenv

Adds an ENV statement to a Dockerfile stage

env(
    name: string,
    value: string): DockerfileStage

Parameters

namestring

valuestring

Returns

DockerfileStage

methodexpose

Adds an EXPOSE statement to a Dockerfile stage

expose(port: number): DockerfileStage

Parameters

portnumber

Returns

DockerfileStage

methodrun

Adds a RUN statement to a Dockerfile stage

run(command: string): DockerfileStage

Parameters

commandstring

Returns

DockerfileStage

methodrunWithMounts

Adds a RUN statement with mounts to a Dockerfile stage

runWithMounts(
    command: string,
    mounts: string[]): DockerfileStage

Parameters

commandstring

mountsstring[]

Returns

DockerfileStage

methoduser

Adds a USER statement to a Dockerfile stage

user(user: string): DockerfileStage

Parameters

userstring

Returns

DockerfileStage

methodworkDir

Adds a WORKDIR statement to a Dockerfile stage

workDir(path: string): DockerfileStage

Parameters

pathstring

Returns

DockerfileStage