compiler.package.docker

Create a Docker image for files generated by MATLAB Compiler on Linux operating systems

Syntax

compiler.package.docker(results)

compiler.package.docker(results,Name,Value)

compiler.package.docker(results,'Options',opts)

compiler.package.docker(files,filepath,'ImageName',imageName)

compiler.package.docker(files,filepath,'ImageName',imageName,Name,Value)

compiler.package.docker(files,filepath,'Options',opts)

Description

Caution

This function is only supported on Linux^® operating systems.

compiler.package.docker(results) creates a Docker^® image for files generated by the MATLAB^® Compiler™ using the compiler.build.Results object results. The results object is created by a compiler.build function.

compiler.package.docker(results,Name,Value) creates a Docker image using the compiler.build.Results object results and additional options specified as one or more name-value pairs. Options include the build folder, entry point command, and image name.

compiler.package.docker(results,'Options',opts) creates a Docker image using the compiler.build.Results object results and additional options specified by a DockerOptions object opts. If you use a DockerOptions object, you cannot specify any other options using name-value pairs.

compiler.package.docker(files,filepath,'ImageName',imageName) creates a Docker image using files that are generated by the MATLAB Compiler. The Docker image name is specified by imageName.

compiler.package.docker(files,filepath,'ImageName',imageName,Name,Value) creates a Docker image using files that are generated by the MATLAB Compiler. The Docker image name is specified by imageName. Additional options are specified as one or more name-value pairs.

compiler.package.docker(files,filepath,'Options',opts) creates a Docker image using files that are generated by the MATLAB Compiler and additional options specified by a DockerOptions object opts. If you use a DockerOptions object, you cannot specify any other options using name-value pairs.

Examples

Create Docker Image Using Results

Create a Docker image from a standalone application on a Linux system.

Install and configure Docker on your system.

Create a standalone application using magicsquare.m and save the build results to a compiler.build.Results object.

appFile = fullfile(matlabroot,'extern','examples','compiler','magicsquare.m');
buildResults = compiler.build.standaloneApplication(appFile);

The Results object is passed as an input to the compiler.package.docker function to build the Docker image.

compiler.package.docker(buildResults);

Customize Docker Image Using Results and Name Value Pairs

Customize a standalone application using name-value pairs on a Linux system to specify the image name and build directory.

Create a standalone application using magicsquare.m and save the build results to a compiler.build.Results object.

appFile = fullfile(matlabroot,'extern','examples','compiler','magicsquare.m');
buildResults = compiler.build.standaloneApplication(appFile);

Build the Docker image using the Results object and specify additional options as name-value pair arguments.

compiler.package.docker(buildResults,...
    'ImageName','mymagicapp',...
    'DockerContext','/home/mluser/Documents/MATLAB/docker');

Customize Docker Image Using Results and Options Object

Customize a Docker image using a DockerOptions object on a Linux system.

Create a standalone application using hello-world.m and save the build results to a compiler.build.Results object.

buildResults = compiler.build.standaloneApplication('hello-world.m');

Create a DockerOptions object to specify additional build options, such as the image name.

opts = compiler.package.DockerOptions(buildResults,
    'ImageName','hellodocker',...
    'ExecuteDockerBuild','Off');

The DockerOptions and Results objects are passed as inputs to the compiler.package.docker function to build the Docker image.

compiler.package.docker(buildResults,'Options',opts);

Create Docker Image Using Files and Name Value Pairs

Create a Docker image using files generated by the MATLAB Compiler and specify the image name on a Linux system.

Build a standalone application using the mcc command.

mcc -o runmyapp -m myapp.m

Build the Docker image by passing the generated files to the compiler.package.docker function.

compiler.package.docker('runmyapp','requiredMCRProducts.txt',...
    'ImageName','launchapp','EntryPoint','runmyapp');

Customize Docker Image Using Files and Options Object

Customize a Docker image using files generated by the MATLAB Compiler and a DockerOptions object on a Linux system.

Create a standalone application using helloworld.m and save the build results to a compiler.build.Results object..

buildResults = compiler.build.standaloneApplication('helloworld.m');

Create a DockerOptions object to specify additional build options, such as the build folder.

opts = compiler.package.DockerOptions(buildResults,...    
    'DockerContext','DockerImages')

opts = 

  DockerOptions with properties:

            EntryPoint: 'helloworld'
    ExecuteDockerBuild: on
             ImageName: 'helloworld'
         DockerContext: './DockerImages'

You can modify property values of an existing DockerOptions object using dot notation. For example, populate the DockerContext folder without calling 'docker build'.

opts.ExecuteDockerBuild = 'Off';

Build the Docker image by passing the generated files to the compiler.package.docker function.

cd helloworldstandaloneApplication

compiler.package.docker('helloworld','requiredMCRProducts.txt',...
    'Options',opts);

Input Arguments

results — Build results

compiler.build.Results object

Build results created by a compiler.build function, specified as a compiler.build.Results object.

files — Files and folders for installation

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

Files and folders for installation, specified as a character vector, string scalar, string array, or cell array of strings. These files are typically generated by the MATLAB Compiler product and can also include any additional files and folders required by the installed application to run. Files generated by the MATLAB Compiler product in a particular release can be packaged using the compiler.package.docker function of the same release.

Example: 'myDockerFiles/'

Data Types: char | string | cell

filepath — Path to requiredMCRProducts.txt file

character vector | string scalar

Path to the requiredMCRProducts.txt file, specified as a character vector or string scalar. This file is generated by the MATLAB Compiler product. The path can be relative to the current working directory or absolute.

Example: '/home/mluser/Documents/MATLAB/magicsquare/requiredMCRProducts.txt'

Data Types: char | string

imageName — Name of Docker image

character vector | string scalar

Name of the Docker image. It must comply with Docker naming rules.

Example: 'hello-world'

Data Types: char | string

opts — Docker options

DockerOptions object

Docker options, specified as a DockerOptions object.

Name-Value Pair Arguments

Specify optional comma-separated pairs of Name,Value arguments. Name is the argument name and Value is the corresponding value. Name must appear inside quotes. You can specify several name and value pair arguments in any order as Name1,Value1,...,NameN,ValueN.

Example: 'ExecuteDockerBuild','on'

'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 ImageNamedocker in the current working directory.

Example: 'DockerContext','/home/mluser/Documents/MATLAB/docker/magicsquaredocker'

Data Types: char | string

'EntryPoint ' — Command executed at image start-up

'' (default) | character vector | string scalar

The command to be executed at image start-up, specified as a character vector or a string scalar.

Example: 'EntryPoint',"exec top -b"

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

'' (default) | character vector | string scalar

Name of the 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 the main executable or archive file is named using uppercase letters, then the uppercase letters are replaced with lowercase letters in the Docker image name.

Example: 'ImageName','magicsquare'

Data Types: char | string

Limitations

• Only standalone applications can be packaged into Docker images as of R2020b.