Main Content

mosadm generate-overrides

Generate override files for configuring MATLAB Online Server

Since R2020a

collapse all in page

    Syntax

    mosadm generate-overrides
    mosadm generate-overrides option1 ... optionN

    Description

    example

    mosadm generate-overrides generates Helm® override files based on install.config.

    mosadm generate-overrides option1 ... optionN generates Helm override files using the specified configuration options.

    Note

    mosadm generate-overrides interacts with Docker®. If you do not have sudo administration privileges for Docker, then this command also requires sudo.

    Examples

    collapse all

    sudo ./mosadm generate-overrides
    Generating file /.../matlab_online_server/overrides/matlab-online-server/mathworks/all.yaml
Generating file /.../matlab_online_server/overrides/matlab-online-server/mathworks/authnz.yaml
Generating file /.../matlab_online_server/overrides/matlab-online-server/mathworks/core-ui.yaml
Generating file /.../matlab_online_server/overrides/matlab-online-server/mathworks/gateway.yaml
Generating file /.../matlab_online_server/overrides/matlab-online-server/mathworks/license.yaml
Generating file /.../matlab_online_server/overrides/matlab-online-server/mathworks/matlab-pool.yaml
Generating file /.../matlab_online_server/overrides/matlab-online-server/mathworks/resource.yaml
Generating file /.../matlab_online_server/overrides/matlab-online-server/mathworks/namespace.yaml
Generated overrides

    If you receive an error that the MATLAB® install or MATLAB Docker image is not found, set up the MATLAB install or MATLAB Docker image, and then try the command again.

    Input Arguments

    collapse all

    One or more configuration options, specified as strings corresponding to valid configuration options from these tables.

    Specific to mosadm generate-overrides

    OptionDescription
    --deployment-image-registry registryName

    Image registry to use for the deployment.

    Example: registry.yourcompany.com

    --deployment-image-repository repositoryName

    Image repository to use for the deployment images.

    Example: mathworks

    --image-flavor imageFlavorName

    Container image flavor, specified as debian or rhel.

    Default: debian

    --skip-backup

    Skip creating a backup of the existing overrides while generating the new overrides.

    --skip-matlab-image

    Skip checking whether the MATLAB image is already built.

    Common to All mosadm Commands

    OptionDescription

    --charts-dir chartsDir

    Name of the MATLAB Online Server™ charts folder to use. This folder contains the Helm charts of the server.

    Specify chartsDir as an absolute path or a path relative to the MATLAB Online Server root folder mosRoot.

    Example: matlab_online_server/charts.

    Default: mosRoot/charts

    --data-dir dataDir

    Name of the MATLAB Online Server data folder to use.

    Specify dataDir as an absolute path or a path relative to the MATLAB Online Server root folder mosRoot.

    Example: matlab_online_server/data.

    Default: mosRoot/data

    --dry-run

    Print out the commands that would have run without this option specified but do not run the operation. Specify this option to test that the operation produces the expected results before actually executing it.

    --help, -h, help

    		Output help for mosadm generate-overrides to the command line.

    --kube-config configFilePath

    Path to the Kubernetes® cluster configuration file. Specify configFilePath as an absolute path or a path relative to the MATLAB Online Server root folder mosRoot.

    Example: /etc/kubernetes/admin.conf

    By default, configFilePath is empty and Kubernetes obtains the cluster configuration from the KUBECONFIG environment variable (if specified) or the ~/.kube/config file. If you run mosadm generate-overrides with sudo, then ~/.kube/config is equivalent to /root/.kube/config.

    --mos-root rootDir

    MATLAB Online Server root folder, specified as an absolute path or a path relative to the current folder, that is, the folder in which you can run mosadm commands.

    Default: . (current folder)

    --overrides-dir overridesDir

    Name of the MATLAB Online Server overrides folder to use.

    Specify overridesDir as an absolute path or a path relative to the MATLAB Online Server root folder, mosRoot.

    Example: matlab_online_server/overrides

    Default: mosRoot/overrides

    --quiet, -q

    Print only the most useful or relevant output from the mosadm generate-overrides command.

    --skip-log-file

    Skip creating the install.log file and logging data about the mosadm generate-overrides operation to this file.

    --skip-prompt, -y

    Force acceptance of the terms of use for the mosadm generate-overrides and skip any command-line prompts normally provided when calling this command.

    --tmp-dir tempDirName

    Name of MATLAB Online Server temporary folder to use.

    Specify tempDirName as an absolute path or a path relative to the temporary folder.

    By default, mosadm generate-overrides generates a new temporary folder every time you run the command.

    --verbose

    Output extra details about the mosadm generate-overrides operation to the command line.

    Version History

    Introduced in R2020a

    See Also

    |

    Topics