Perform Minimal MATLAB Online Server Installation on Single Machine
This topic explains the steps you must perform to set up MATLAB® Online Server™ on a single machine for testing and evaluation. To add nodes to the cluster, see Production environment in the Kubernetes® documentation.
After MATLAB Online Server is installed, individual MATLAB instances are hosted by a container management tool, and the MATLAB Online Server stack is managed by Kubernetes.
These instructions include
sudo for commands that by default require administration privileges. Depending on how your environment is configured,
sudo might not be required in some cases.
Verify Installation Prerequisites
Before beginning the installation, verify the following:
Your system is running one of the supported operating systems and meets the minimum hardware and software requirements described in MATLAB Online Server System Requirements.
Your operating system is hosted at a static IP address. Kubernetes requires a static IP address to function properly. With dynamic IP addresses, when the IP address changes, the Kubernetes server fails and must be reinstalled.
Install Network License Manager
Follow the Linux® instructions for installing on an offline machine described in Install License Manager on License Server in the Help Center. Configure the server to be accessed over the network.
MathWorks® requires two license servers: one for MATLAB Online Server and one for MATLAB.
You can use existing network license servers or create a new installation.
MATLAB workers must have access to their MathWorks licenses. Those licenses can be either co-located on the same license server or on independent servers.
Specify the MATLAB and MATLAB Online Server license hostnames and ports using the
<port>@<host>[,<port>@<other-host>]format. The hostname and port must be accessible from inside the Kubernetes cluster.
On each license server, add these lines to your license file to fix communication with the network license manager and the MLM daemon to ports 27000 and 27001, respectively.
SERVER <HOSTID> ID=0 27000 DAEMON MLM "<FLEXLM_INSTALL_LOCATION>/etc/MLM" port=27001
By default, the MATLAB Online Server network policy enables access to these ports. Running the network license manager and MLM daemon on different ports is supported, but this configuration requires additional updates to your MATLAB Online Server network policy.
If you are restricting access to toolboxes or licenses by username, you must allow
mwuser, the username of the license service that runs in the Kubernetes cluster, to check out licenses for MATLAB Online Server. In the
etcfolder of the network license manager for MATLAB Online Server, add this line to your
INCLUDE MATLAB_Online_Server USER mwuser
Depending on how your organization configures accounts, you might need to create an
mwuseraccount to enable the license options file.
If the license server is configured correctly, then the license service running in the Kubernetes cluster runs without any errors and checks out the license when it starts. If the license is invalid or the license server cannot be reached, then the license service exits and Kubernetes automatically attempts to restart the license service periodically until it succeeds.
The other services require that the license server is running, but if the license is temporarily unavailable, they continue to run. After an approximately two-hour grace period, the services go into a hibernation state and then reject requests with a failed status. The logs of the services indicate when they enter or exit this hibernation or grace period state.
If you encounter any issues with the license service, see Resolve License Service Issues.
Download MATLAB Online Server Installer
Follow these steps to download and then extract the MATLAB Online Server installer and files.
Go to the Downloads page on mathworks.com.
Under Select Release, select the current release, for example R2023b.
Expand the Get MATLAB Online Server section. This section appears only if your account has a license for MATLAB Online Server software.
Click Download to download the ZIP file.
In the download folder or folder of your choice, extract the installation files. For example, this command downloads the ZIP file to your home directory (
unzip R2023b_matlab_online_server.zip -d ~/
matlab_online_serverfolder is the root folder of your MATLAB Online Server installation. Navigate into this folder. For example, if you unzipped the folder into your home directory, run this command.Confirm that this folder contains the following files and subfolders.
attributions.txt— Third-party software license attributions file, which is also included in each release container image.
data— Folder that stores MATLAB Online Server data.
install.config— File containing properties used to configure your MATLAB Online Server installation.
mosadm— Command-line executable used to install and configure MATLAB Online Server.
thirdpartylicenses.txt— Third-party software license file, which is also included in each release container image.
mosadmcommand is the main utility to perform the remaining installation steps. You must run this command from your MATLAB Online Server installation folder. For details on the various operations it can perform, run this command.
Configure MATLAB Online Server
install.config file, located in the folder where you unzipped the installer, using a text editor such as
install.configso that you have a record of the default settings.
At a minimum, set these parameter values.
Fully qualified domain name used to access MATLAB Online Server from a web browser. Specifying an IP address as the domain base is not supported.
|Administrator password you want to use to log in to MATLAB
Online™. The default is |
Port and hostname of your MATLAB
Online Server license server. Use the
Port and hostname of your MATLAB
Online Server license server. Use the
Specify additional properties for your deployment as needed. For example, you can update the namespace to use for the deployment or enable TLS security. For a complete list of parameters, see Installation Configuration Properties.
Download and Install MATLAB
Download and install the version of MATLAB that your MATLAB Online users connect to.
Download and install MATLAB by using the
The example shown here uses
sudo, but if you have ownership of the installation folder and read and write privileges on it,
sudois not required. By default,
mosadm install-matlabinstalls the latest version of MATLAB into the
/MATLABfolder on your local machine. If the
/MATLABfolder does not exist, the command creates it.
sudo ./mosadm install-matlab
(Required only for MATLAB R2023a or later) Download and install the documentation for the MATLAB release you installed.
Create a folder,
/MATLAB/SupportPackages, that will be used to store the documentation that you download and install.
Open MATLAB from the
In MATLAB, set the support package root to the folder you created.
Install the documentation to the support package root folder by following the instructions in Install Documentation on Offline Machines.
Install Kubernetes and MATLAB Online Server
Download and install the required Kubernetes components, and install MATLAB Online Server on the installed Kubernetes cluster.
Create a single-node Kubernetes architecture.
sudo ./mosadm bootstrap-node
This command downloads and installs dependencies and the Kubernetes components. It then initializes a single-node Kubernetes cluster on the machine and customizes the cluster for MATLAB Online Server. It can take several minutes for the installation to finish.
If you are using Docker® as your container management tool, the Docker daemon is configured using the properties in the file
/etc/docker/daemon.json, and the
bootstrap-nodecommand overwrites any customizations. See
mosadm bootstrap-nodefor more details on the bootstrap process.
To preserve existing customizations, use the following command instead.
sudo ./mosadm bootstrap-node --preserve-docker-config
At this step, you are asked to accept the terms and conditions for installing MATLAB Online Server. If you agree, answer "Y." If you do not, answer "N," which closes the installer. If you do not agree, you cannot install MATLAB Online Server.
To verify successful installation, confirm the existence of the
/etc/kubernetes/admin.conffile. This file exists only after the cluster is created successfully.
Check that the pods are in the ready state. Each pods should have a
1/1containers with a
Running. If you do not see the correct list of pods, check the version number for the install files. It can take several minutes for all pods to come online.
sudo kubectl --kubeconfig /etc/kubernetes/admin.conf get pods --all-namespaces
The command returns a display similar to the following.
NAMESPACE NAME READY STATUS RESTARTS AGE kube-system coredns-78fde67838-m2spd 1/1 Running 0 51s kube-system etcd-ip-174-32-36-164 1/1 Running 1 65s kube-system kube-apiserver-ip-174-32-36-164 1/1 Running 1 65s kube-system kube-controller-manager-ip-174-32-36-164 1/1 Running 1 68s kube-system kube-router-w2mk4 1/1 Running 0 52s kube-system kube-scheduler-ip-174-32-36-164 1/1 Running 1 65s
kube-configfile into your home folder so that you can execute the
kubectlcommand without having to specify the
--kubeconfig /etc/kubernetes/admin.confflag going forward.
sudo ./mosadm merge-kube-config
Install NGINX Ingress Controller
The NGINX ingress controller processes incoming requests to the Kubernetes cluster and acts as a load balancer for MATLAB Online Server.
If you are using your own ingress controller, skip this step and see Configure NGINX Ingress Controller instead.
Install the controller and display the configuration options used for the controller.
# Config file for a ingress-nginx helm deploy rbac: create: true controller: hostNetwork: true ...
Verify that the controller is installed correctly.
mathworks is the
default namespace used for the installation. You can customize this name in a later
kubectl get pods --namespace mathworks
NAME READY STATUS RESTARTS AGE mathworks-ingress-nginx-controller-7fdcd49d74-zngv4 1/1 Running 0 54s
Load Docker Images
Load all Docker images and files shipped through the MathWorks container registry onto the computer.
Copy the necessary Helm® charts from the MathWorks container registry. Helm is an open source project that helps deploy services into Kubernetes. This command creates a folder named
chartsin the current folder and copies the charts there.
sudo ./mosadm copy-helm-charts
Load Docker images. This command loads the images from the MathWorks container registry into the local container cache.
sudo ./mosadm load-docker-images
From the local installation of MATLAB that you installed in the Download and Install MATLAB step, build an image containing MATLAB. This step can take several minutes.
To build this image, your machine must have a
TMPDIRenvironment variable that specifies a writable temporary directory mounted in
execmode. For details on applying this configuration, see Tips in the
sudo ./mosadm build-matlab-image /MATLAB
/MATLABis the path to the folder containing your installation of MATLAB.
With the cluster and Docker images ready to use, before the deploying the services, load the configuration overrides.
Create the chart configuration files for the deployments. This command creates the YAML override files that you can use to configure the server in the
overrides/folder of your MATLAB Online Server installation, where:
is the name of your cluster (
matlab-online-serverfor single-node installations).
namespaceis the value of the
NAMESPACEparameter in your
install.configfile (default =
sudo ./mosadm generate-overrides
overrides/contains the following files and subfolders.
The YAML files enable you to override the default configuration and customize the server. For example, you can configure storage and authentication. To customize the server before deployment, see Setup and Configuration. Otherwise, proceed to the next step.
Deploy MATLAB Online Server
To install all the MATLAB Online Server components, run the
This command uses Helm to install all the charts, customized with any overrides that you generate in the previous step.
Check that the services are all running with
namespacewith the namespace you used for MATLAB Online Server (default =
mathworks). Depending on how you configured the server and the platform on which you installed the server, the exact pods you see might differ from the ones shown here.
kubectl get pods --namespace
NAME READY STATUS RESTARTS AGE namespace-authnz-7994c9866d-675fb 1/1 Running 0 10m namespace-core-ui-cfdcccc4c-5bhrc 1/1 Running 0 10m namespace-gateway-88ffd446d-mbf2l 1/1 Running 0 10m namespace-gateway-proxy-6f85db9cbb-8ftbr 1/1 Running 0 10m namespace-gateway-proxy-6f85db9cbb-mdhr7 1/1 Running 0 10m namespace-license-5cc85b97cd-zg4vd 1/1 Running 0 10m namespace-matlab-pool-9cc6b6465-9rdz8 2/2 Running 0 6m54s namespace-matlab-pool-9cc6b6465-t7wp2 2/2 Running 0 3m40s namespace-matlab-pool-helpsearch-8479fbdc88-4r6sd 1/1 Running 0 6m54s namespace-matlab-pool-ui-8484bbbd4d-t6777 1/1 Running 0 6m54s namespace-resource-78f9b97745-fzwlq 1/1 Running 0 10m
The pods running MATLAB can take several minutes to fully start (2/2 containers). It is important to
wait until the pods are in the ready state. If any of the containers do not start running,
check the license server and the
install.config settings. See Resolve MATLAB Pod Issues.
Verify MATLAB Online Server Installation
Make sure the address in the
DOMAIN_BASEparameter defined in
install.configis registered and can be routed to the IP address of the host machine. Run this command, replacing
with the value of the
ping -c 1
This command returns the IP address of the host machine. In some types of installation, the ping does not receive packets. If you have such an installation, this command returns the IP address of the server you ping.
Open a browser on another machine and then go to the address where you are hosting MATLAB Online:
Your browser window displays the MATLAB Online login screen. For a single-machine installation, use the username
adminand the password you specified in the
install.config(the default is
If you can now access your internal version of MATLAB Online, installation is complete. If you cannot access MATLAB Online, or you run into any other technical error, contact MathWorks Support.
Set Up Server
With the installation process and initial configuration complete, you must now complete additional tasks to set up the server for use in your organization. For example, you need to:
Configure user authentication by specifying your identity provider details.
Configure the installed MATLAB versions and specify which user groups can access them.
Configure persistent storage and which directories, drives, and files users can access.
Customize the MATLAB Online sign-in screen.
To get started setting up the server, see Set Up MATLAB Online Server After Installation.