Main Content

mosadm merge-kube-config

Merge Kubernetes configuration files into MATLAB Online Server installation

Since R2020a

collapse all in page

    Syntax

    mosadm merge-kube-config
    mosadm merge-kube-config option1 ... optionN

    Description

    example

    mosadm merge-kube-config merges the cluster Kubernetes® configuration located at /etc/kubernetes/admin.conf into the MATLAB® Online Server™ Kubernetes configuration located at ~/.kube/config. The merged configuration makes it easier to run the kubectl command-line tool for managing the Kubernetes cluster that MATLAB Online Server runs in.

    mosadm merge-kube-config option1 ... optionN merges Kubernetes configuration files using the specified configuration options.

    Note

    mosadm merge-kube-config requires sudo administration privileges.

    Examples

    collapse all

    sudo ./mosadm merge-kube-config
    Using kubeconfig from /etc/kubernetes/admin.conf 
Will merge the current config from ~/.kube/config with the one in 
/etc/kubernetes/admin.conf 
mkdir -p /home/ubuntu/.kube 
cp /etc/kubernetes/admin.conf /home/ubuntu/.kube/config 
chown -R ubuntu:ubuntu /home/ubuntu/.kube

    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 merge-kube-config 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 merge-kube-config 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 merge-kube-config command.

    --skip-log-file

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

    --skip-prompt, -y

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

    --verbose

    Output extra details about the mosadm merge-kube-config operation to the command line.

    Version History

    Introduced in R2020a

    See Also

    |

    Topics

    External Websites