Main Content

mosadm install-ingress

Install NGINX ingress controller for MATLAB Online Server

Since R2020a

collapse all in page

    Syntax

    mosadm install-ingress
    mosadm install-ingress option1 ... optionN

    Description

    mosadm install-ingress installs the NGINX® ingress controller for processing incoming requests to the Kubernetes® cluster. This controller acts as a load balancer for MATLAB® Online Server™.

    example

    mosadm install-ingress option1 ... optionN installs the controller using the specified configuration options.

    Examples

    collapse all

    ./mosadm install-ingress

    Input Arguments

    collapse all

    One or more configuration options, specified as strings corresponding to valid configuration options from this table.

    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 install-ingress 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 install-ingress 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 install-ingress command.

    --skip-log-file

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

    --skip-prompt, -y

    Force acceptance of the terms of use for the mosadm install-ingress 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 install-ingress generates a new temporary folder every time you run the command.

    --verbose

    Output extra details about the mosadm install-ingress operation to the command line.

    Version History

    Introduced in R2020a

    See Also

    Topics

    External Websites