docker-virt/dev.ust.zinc.grader.virtualization.docker.imaging/LangDockerfile

LangDockerfile

abstract class LangDockerfile(val imageName: String, val imageTag: String) : BaseDockerfile

Dockerfile for creating programming language-based images.

Parameters

imageName

Name of the image.

imageTag

Tag of the image.

Inheritors

Constructors

LangDockerfile

constructor(imageName: String, imageTag: String)

Types

CFamily

abstract class CFamily(val imageName: String, val imageTag: String) : LangDockerfile

Dockerfile for creating images for GCC/Clang images.

Java

open class Java(val imageTag: String) : LangDockerfile

Dockerfile for creating Java-based images.

Python

open class Python(val imageTag: String) : LangDockerfile.PythonBased

Dockerfile for creating Python-based images.

PythonBased

abstract class PythonBased(val imageName: String, val imageTag: String) : LangDockerfile

Abstraction for all images which provides a Python executable.

PythonWithCUDA

open class PythonWithCUDA(cudaVersion: CUDAVersion, cudnn: Boolean) : LangDockerfile.PythonBased

Dockerfile for creating Python-based images with CUDA support.

Qt5

open class Qt5(val imageTag: String) : LangDockerfile

Dockerfile for creating images for Qt5 images.

Properties

asTagComponent

val asTagComponent: String

This image's image name and tag for use as another image's tag.

baseDistro

open override val baseDistro: BaseDockerfile.BaseDistro

The base distribution of this image.

compileCommand

abstract val compileCommand: String?

The command used to compile source files into an executable form.

dockerfileSpec

abstract val dockerfileSpec: DockerfileBuilder

The Dockerfile DSL that the image should be generated from.

fullImageName

private val fullImageName: String

imageName

val imageName: String

The name for the image.

imageTag

val imageTag: String

The tag for the image.

mountPolicy

val mountPolicy: EnvPath.MountPolicy

The mounting policy for this image.

runCommand

abstract val runCommand: String?

The command used to run executables of the specific language.

Functions

buildImage

private suspend fun buildImage(docker: DockerDaemon): DockerImage

Builds an image based on dockerfileSpec, and returns the resulting image ID.

getImage

suspend fun getImage(docker: DockerDaemon): DockerImage

Returns a proxy handle of the image.

getImageOrNull

private suspend fun getImageOrNull(docker: DockerDaemon): DockerImage?

Retrieves the image as defined by dockerfileSpec, or null if such an image does not exist.

getTag

suspend fun getTag(docker: DockerDaemon): String

The tag of the image.

installPackage

fun DockerfileBuilder.installPackage(vararg develPkgNames: String): DockerfileBuilder

Installs a software package into the distribution.

joinArgs

private fun Pair<String, Array<String>>.joinArgs(): String

Joins a Pair as arguments.

resolveRunCmd

open override fun resolveRunCmd(baseCmd: String?, baseArgs: List<String>?, entrypoint: String, args: List<String>): String

Resolves the command to execute a baseCmd with baseArgs against entrypoint and args.

runCmd

fun runCmd(baseCmd: String? = this.runCommand, baseArgs: List<String>? = null, entrypoint: String, args: List<String> = emptyList()): String

Convenience method to use resolveRunCmd with sensible default arguments.

setEnv

protected fun DockerfileBuilder.setEnv(): DockerfileBuilder

Sets the necessary environment variables for the image.

updateAllPackages

fun DockerfileBuilder.updateAllPackages(): DockerfileBuilder

Updates all packages in the distribution.