Main Content

mosadm renew-node

Renew single-node Kubernetes certificates for MATLAB Online Server

Since R2023a

collapse all in page

    Syntax

    mosadm renew-node
    mosadm renew-node option1 ... optionN

    Description

    mosadm renew-node renews the Kubernetes® internal cluster certificates for one year from the time of executing the command. After renewing the certificate, the renew-node command performs the following actions:

    1. Restart the Kubernetes static and default pods.

    2. Remove the existing ~/.kube folder.

    3. Run the ./mosadm merge-kube-config command to rebuild the ~/.kube folder and merge the cluster Kubernetes configuration (/etc/kubernetes/admin.conf) into the user Kubernetes configuration (~/.kube/config).

    You can use renew-node on single-node clusters only. sudo privileges are required.

    example

    mosadm renew-node option1 ... optionN renews the node using the specified configuration options.

    Note

    mosadm renew-node requires sudo administration privileges.

    Examples

    collapse all

    sudo ./mosadm renew-node
    Removing static pod manifests from /etc/kubernetes/manifests
Waiting for 30s
Copying static pod manifests to /etc/kubernetes/manifests
Waiting for 30s
Removing existing ~/.kube/config
Proceed? Y/N Y
Copying kube config to  /.../.kube/config

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

    --skip-log-file

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

    --skip-prompt, -y

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

    --verbose

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

    Version History

    Introduced in R2023a

    See Also

    |