mosadm bootstrap-node

Install Kubernetes and configure single-node Kubernetes cluster for MATLAB Online Server

collapse all in page

    Syntax

    mosadm bootstrap-node
    mosadm bootstrap-node option1 ... optionN

    Description

    mosadm bootstrap-node installs Kubernetes®, initializes a single-node Kubernetes cluster on the machine where it is being installed, and customizes the cluster for MATLAB® Online Server™.

    The exact commands executed by this command depend on the operating system:

    example

    mosadm bootstrap-node option1 ... optionN initializes the node using the specified configuration options.

    Note

    mosadm bootstrap-node requires sudo administration privileges.

    Examples

    collapse all

    sudo ./mosadm bootstrap-node

    Input Arguments

    collapse all

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

    Specific to mosadm bootstrap-node

    OptionDescription

    --preserve-docker-config

    Preserve the existing Docker® configuration on the machine where you are installing MATLAB Online Server. If you do not specify this option, then mosadm bootstrap-node creates or updates the configuration file for the Docker daemon (/etc/docker/daemon.json) and sets these properties, overwriting any existing ones.

    {
      "exec-opts": ["native.cgroupdriver=systemd"],
      "log-driver": "json-file",
      "log-opts": {
        "max-size": "100m"
      },
      "storage-driver": "overlay2"
}

    For more details on Docker daemon configuration files, see the Docker Daemon documentation (Docker).

    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 bootstrap-node 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 bootstrap-node 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 bootstrap-node command.

    --skip-log-file

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

    --skip-prompt, -y

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

    --verbose

    Output extra details about the mosadm bootstrap-node operation to the command line.

    More About

    collapse all

    Version History

    Introduced in R2020a

    See Also

    |

    Topics