Main Content

mosadm undeploy

Remove MATLAB Online Server services from Kubernetes cluster

Since R2020a

collapse all in page

    Syntax

    mosadm undeploy
    mosadm undeploy serviceName
    mosadm undeploy [serviceName] option1 ... optionN

    Description

    mosadm undeploy removes all services that have override charts.

    example

    mosadm undeploy serviceName removes only the specified service.

    example

    mosadm undeploy [serviceName] option1 ... optionN removes services using the specified configuration options and either of the previous syntaxes.

    Examples

    collapse all

    ./mosadm undeploy

    Undeploy the MATLAB® pool service.

    ./mosadm undeploy matlab-pool

    Input Arguments

    collapse all

    Name of service, specified as one of the options in this table.

    NameDescription
    authnzAuthenticates and authorizes actions of MATLAB Online Server™ users and some MATLAB Online Server components
    core-ui

    Configures the login screen and other UI elements

    gatewayMaps MATLAB Online Server clients to their assigned MATLAB instances
    licenseCommunicates with MathWorks® License Manager to check for MATLAB Online Server licenses
    matlab-poolConfigures settings for MATLAB instances running in MATLAB Online Server
    namespaceConfigures the namespace used for a MATLAB Online Server deployment
    nginx-ingressConfigure the NGINX Ingress controller, which acts as a load balancer for MATLAB Online Server
    resource

    Maintains information on all MATLAB instances

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

    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 undeploy 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 undeploy 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 undeploy command.

    --skip-log-file

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

    --skip-prompt, -y

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

    --verbose

    Output extra details about the mosadm undeploy operation to the command line.

    Version History

    Introduced in R2020a

    See Also

    |

    Topics