compiler.runtime.createDockerImage

Create a Docker image that contains MATLAB Runtime

Since R2023b

Syntax

compiler.runtime.createDockerImage(results)

compiler.runtime.createDockerImage(filepath)

compiler.runtime.createDockerImage(___,Name,Value)

name = compiler.runtime.createDockerImage(___)

Description

compiler.runtime.createDockerImage(results) creates a MATLAB^® Runtime Docker^® image using a vector of compiler.build.Results objects results. The results objects can be created by any compiler.build function.

compiler.runtime.createDockerImage(filepath) creates a MATLAB Runtime Docker image using a list of buildresult.json files generated by MATLAB Compiler™.

compiler.runtime.createDockerImage(___,Name,Value) creates a MATLAB Runtime Docker image with additional options specified as one or more name-value arguments. Options include the build folder, verbosity level, and image name.

name = compiler.runtime.createDockerImage(___) creates a MATLAB Runtime Docker image and returns the name of the image as a character vector.

Examples

Create MATLAB Runtime Docker Image for Standalone Applications

Create a MATLAB Runtime Docker image that can run two standalone application Docker containers.

Install and configure Docker on your system.

Create two standalone applications using compiler.build.standaloneApplication. Save the output from each function as a compiler.build.Results object.

results1 = compiler.build.standaloneApplication('magicsquare.m');

results2 = compiler.build.standaloneApplication('houdini.mlapp');

Create a MATLAB Runtime Docker image that can be used for both deployed standalone applications.

name = compiler.runtime.createDockerImage([results1,results2]);

Create a Docker image for each standalone application. Specify the name of the MATLAB Runtime image you created as an input to the compiler.package.docker function.

compiler.package.docker(results1,'RuntimeImage',name)

compiler.package.docker(results2,'RuntimeImage',name)

Deploy the Docker images. For details, see Package MATLAB Standalone Applications into Docker Images.

Create MATLAB Runtime Docker Image for Microservices

Requires MATLAB Compiler SDK™

Create a MATLAB Runtime Docker image that can run two microservice Docker containers.

Create two production server archives using compiler.build.productionServerArchive.

results1 = compiler.build.productionServerArchive('addmatrix.m',...
'OutputDir','add');

results2 = compiler.build.productionServerArchive('eigmatrix.m',...
'OutputDir','eig');

Create a MATLAB Runtime Docker image that can be used for both microservices. Use name-value arguments to specify the image name and build folder.

compiler.runtime.createDockerImage(["add/buildresult.json",...
"eig/buildresult.json"],'ImageName','micro-combo-image',...
'DockerContext','runtime')

Create a microservice Docker image for each production server archive. Specify the name of the MATLAB Runtime image you created as an input to the compiler.package.microserviceDockerImage function.

compiler.package.microserviceDockerImage(results1,...
'ImageName','add-micro','RuntimeImage','micro-combo-image');

compiler.package.microserviceDockerImage(results2,...
'ImageName','eig-micro','RuntimeImage','micro-combo-image');

Deploy the microservices. For details, see Create Microservice Docker Image (MATLAB Compiler SDK).

Create MATLAB Runtime Docker Image with Custom Base Layer

Create a MATLAB Runtime Docker image with a custom base layer image. For more details on this example, see Create Docker Image Using Custom Base Layer.

Install and configure Docker on your system.

Create a standalone application using compiler.build.standaloneApplication. Save the output as a compiler.build.Results object.

results1 = compiler.build.standaloneApplication('magicsquare.m');

Create a custom base layer using a Dockerfile. For this example, create a new file named Dockerfile.customdeps that specifies the Linux distribution and installs all of the dependencies required for MATLAB Runtime. You can add custom commands or dependencies to fulfill your deployment requirements.

At the MATLAB command window, build the custom base layer image using Docker and the Dockerfile you created.

depsImageName = "mycompanybase:r2024b";
system("docker build -f Dockerfile.customdeps -t " + depsImageName + " .");

Create a MATLAB Runtime Docker image layer that uses the custom base layer you created.

runtimeImageName = "custom-matlabruntime:r2024b";
compiler.runtime.createDockerImage(buildResults, ...
    "BaseImage",depsImageName, ...
    "ImageName",runtimeImageName)

Create a Docker image for the standalone application layer. Specify the name of the MATLAB Runtime image you created as an input to the compiler.package.docker function.

compiler.package.docker(buildResults, ...
    "ImageName","mymagicimg","RuntimeImage",runtimeImageName);

Deploy the Docker image. For details, see Package MATLAB Standalone Applications into Docker Images.

Input Arguments

results — Build results

Vector of compiler.build.Results objects

One or more build results created by a compiler.build function, such as compiler.build.standaloneApplication or compiler.build.productionServerArchive (MATLAB Compiler SDK), specified as a vector of compiler.build.Results objects.

Example: [results1,results2]

filepath — Paths to buildresult.json

character vector | string scalar | string array | cell array of strings

One or more paths to buildresult.json, specified as a character vector or string scalar. This file is generated by MATLAB Compiler SDK. The path can be relative to the current working directory or absolute. In releases prior to R2025a, use requiredMCRProducts.txt instead of buildresult.json.

Example: ["fun1/buildresult.json","fun2/buildresult.json"]

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Before R2021a, use commas to separate each name and value, and enclose Name in quotes.

Example:

BaseImage — Name of base Docker image

character vector | string scalar

Name of the base Docker image that is used in the FROM line to create the MATLAB Runtime image, specified as a character vector or a string scalar. If this property is not specified, a base image with all required dependencies is created.

Example: 'BaseImage','matlab-deps'

Data Types: char | string

DockerContext — Path to build folder

'ImageNamedocker' (default) | character vector | string scalar

Path to the build folder where the Docker image is built, specified as a character vector or a string scalar. The path can be relative to the current working directory or absolute.

If no path is specified, the function creates a build folder named ImageNameruntime in the current working directory.

Example: 'DockerContext','./docker/magicruntime'

Data Types: char | string

ExecuteDockerBuild — Flag to build Docker image

'on' (default) | on/off logical value

Flag to build the Docker image, specified as 'on' or 'off', or as numeric or logical 1 (true) or 0 (false). A value of 'on' is equivalent to true, and 'off' is equivalent to false. Thus, you can use the value of this property as a logical value. The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState.

• If you set this property to 'on', then the function will build the Docker image.

• If you set this property to 'off', then the function will populate the DockerContext folder without calling 'docker build'.

Example: 'ExecuteDockerBuild','Off'

Data Types: logical

ImageName — Name of Docker image

character vector | string scalar

Name of the MATLAB Runtime Docker image, specified as a character vector or a string scalar. The name must comply with Docker naming rules. Docker repository names must be lowercase. If specified, this property is used as the name output argument.

If not specified, the default image name resembles the following:

matlabruntime/r2026a/update0/1000000000000000

Example: 'ImageName','magicruntime'

Data Types: char | string

OptionalDependencies — Optional dependencies to include

'none' (default) | 'all'

Since R2025a

Optional MATLAB Runtime dependencies to include in the installer, specified as one of the following:

• 'none' — Option to not include any of the optional dependencies in the image. Use this option to minimize the size of the generated image. This option is the default behavior.

• 'all' — Option to include all of the optional dependencies in the image, including graphical support.

Example: 'OptionalDependencies','all'

Data Types: char | string

VerbosityLevel — Output verbosity level

'verbose' (default) | 'concise' | 'none'

Output verbosity level, specified as one of the following options:

• 'verbose' (default) — Display all screen output, including Docker output that occurs from the commands 'docker pull' and 'docker build'.

• 'concise' — Display progress information without Docker output

• 'none' — Do not display output.

Example: 'VerbosityLevel','concise'

Data Types: char | string

Output Arguments

name — Name of image

Name of the generated MATLAB Runtime Docker image, specified as a character vector. You can set the name using the ImageName property.

Data Types: char

Limitations

• This function requires an installation of Docker. On macOS, Docker Desktop is supported. On Windows^®, Docker Desktop and Docker in WSL2 are supported.

Version History

Introduced in R2023b

R2025a: Build using buildresult.json

You can use the JSON file named buildresult.json in place of requiredMCRProducts.txt in deployment workflows. The requiredMCRProducts.txt file will be removed in a future release.

R2025a: Optional dependencies

You can use the OptionalDependencies option to control whether to include all of the optional MATLAB Runtime dependencies in the image.