Skip to content

Commit de06bf9

Browse files
swansong314swansong314
authored
R2024a release!
0 parents  commit de06bf9

12 files changed

+1425
-0
lines changed

‎LICENSE.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
MATHWORKS CLOUD REFERENCE ARCHITECTURE LICENSE
2+
3+
The files in this GitHub repository refer to commercial software products and services, virtual machine images, and related materials of The MathWorks, Inc. (“MathWorks Programs”). MathWorks Programs are separately licensed under the MathWorks Software License Agreement, available in the desktop installation of the MathWorks Programs or in the virtual machine image. The files in this GitHub repository may also refer to third-party software licensed under separate terms provided by such third parties.
4+
5+
The following license terms apply only to the files in this GitHub repository, including files in this folder and its subfolders, and do not apply to MathWorks Programs. References to “software” and “code” in the following license terms refer to the files in this GitHub repository.
6+
7+
Copyright (c) 2024, The MathWorks, Inc.
8+
9+
All rights reserved.
10+
11+
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
12+
13+
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
14+
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
15+
3. In all cases, the software is, and all modifications and derivatives of the software shall be, licensed to you solely for use in conjunction with MathWorks products and service offerings.
16+
17+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

‎README.md

+70
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# Network License Manager for MATLAB on Microsoft Azure (Linux VM)
2+
3+
This repository shows how to automate the process of starting a Network License Manager for MATLAB®, running on a Linux® virtual machine, using your Azure® account. The cloud resources are created using Azure Resource Manager (ARM) templates. For information about the architecture of this solution, see [Learn About Architecture](#learn-about-architecture).
4+
5+
# Requirements
6+
7+
You need:
8+
9+
- An Azure® account.
10+
11+
- A valid MathWorks® license. For more information on configuring your license for cloud use, see [License Requirements for MATLAB on Cloud Platforms](https://www.mathworks.com/help/licensingoncloud/matlab-on-the-cloud.html).
12+
13+
- To be an administrator of the network license you want to use.
14+
15+
# Costs
16+
You are responsible for the cost of the Azure services used when you create cloud resources using this guide. Resource settings such as instance type affect the cost of deployment. For cost estimates, see the pricing pages for each Azure service you will be using. Prices are subject to change.
17+
18+
19+
# Deployment Steps
20+
21+
To view instructions for deploying the Network License Manager for MATLAB reference architecture, select a MATLAB release:
22+
23+
| Linux | Windows |
24+
| ----- | ------- |
25+
| [R2024a](releases/R2024a/README.md) | [R2024a](https://github.com/mathworks-ref-arch/license-manager-for-matlab-on-azure/blob/master/releases/R2024a/README.md) |
26+
| | [R2023b](https://github.com/mathworks-ref-arch/license-manager-for-matlab-on-azure/blob/master/releases/R2023b/README.md) |
27+
| | [R2023a](https://github.com/mathworks-ref-arch/license-manager-for-matlab-on-azure/blob/master/releases/R2023a/README.md) |
28+
| | [R2022b](https://github.com/mathworks-ref-arch/license-manager-for-matlab-on-azure/blob/master/releases/R2022b/README.md) |
29+
| | [R2022a](https://github.com/mathworks-ref-arch/license-manager-for-matlab-on-azure/blob/master/releases/R2022a/README.md) |
30+
| | [R2021b](https://github.com/mathworks-ref-arch/license-manager-for-matlab-on-azure/blob/master/releases/R2021b/README.md) |
31+
| | [R2021a](https://github.com/mathworks-ref-arch/license-manager-for-matlab-on-azure/blob/master/releases/R2021a/README.md) |
32+
| | [R2020b](https://github.com/mathworks-ref-arch/license-manager-for-matlab-on-azure/blob/master/releases/R2020b/README.md) |
33+
| | [R2020a](https://github.com/mathworks-ref-arch/license-manager-for-matlab-on-azure/blob/master/releases/R2020a/README.md) |
34+
| | [R2019b](https://github.com/mathworks-ref-arch/license-manager-for-matlab-on-azure/blob/master/releases/R2019b/README.md) |
35+
| | [R2019a\_and\_older](https://github.com/mathworks-ref-arch/license-manager-for-matlab-on-azure/blob/master/releases/R2019a_and_older/README.md) |
36+
37+
## Learn About Architecture
38+
39+
The network license manager and its resources are created using [ARM templates](https://docs.microsoft.com/en-gb/azure/azure-resource-manager/resource-group-overview). The architecture is illustrated in Figure 2. For more information about each resource, see the [Azure template reference](https://docs.microsoft.com/en-us/azure/templates/).
40+
41+
![Server Architecture](img/FlexServer_in_Azure_architecture.png?raw=true)
42+
43+
*Figure 2: Network License Manager Architecture*
44+
45+
The following resources are created.
46+
47+
### Networking resources
48+
* Virtual Network (Microsoft.Network/virtualNetworks) The Virtual Network includes the following components:
49+
* Subnet (Microsoft.Network/virtualNetworks/subnets)
50+
* Network Security Group (Microsoft.Network/networkSecurityGroups) : Ingress rules from client IP address:
51+
* Allow 3389: Required for Remote Desktop Protocol to connect to the network license manager server.
52+
* Allow 22: Required for SSH into the network license manager server.
53+
* Allow 443: Required for communication between client and network license manager for MATLAB Dashboard server.
54+
* Allow 27000-27010: Required for communication from MATLAB and MATLAB workers to the network license manager for MATLAB.
55+
* Allow all internal traffic: Open access to network traffic between all cluster nodes internally.
56+
* Network interface (Microsoft.Network/networkInterfaces)
57+
* Public IP Address (Microsoft.Network/publicIPAddresses)
58+
59+
### Instances
60+
* Network license manager instance (Microsoft.Compute/virtualMachines): A Compute instance for the license server.
61+
* Custom Script Extension (Microsoft.Compute/virtualMachines/extensions): An extension which configures this instance at deployment time to start the network license manager for MATLAB Dashboard web server.
62+
63+
# Technical Support
64+
To request assistance or additional features, contact [MathWorks Technical Support](https://www.mathworks.com/support/contact_us.html).
65+
66+
----
67+
68+
Copyright 2024 The MathWorks, Inc.
69+
70+
----

‎SECURITY.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Reporting Security Vulnerabilities
2+
==================================
3+
If you believe you have discovered a security vulnerability, please report it to
4+
[email protected] instead of GitHub. Please see
5+
[MathWorks Vulnerability Disclosure Policy for Security Researchers](https://www.mathworks.com/company/aboutus/policies_statements/vulnerability-disclosure-policy.html)
6+
for additional information.

‎img/Console_Login.png

164 KB
Loading

‎img/Console_Upload.png

62.8 KB
Loading

‎img/FlexServer_in_Azure_architecture.png

56.2 KB
Loading

‎img/Resource_Group_Delete.png

845 KB
Loading

‎releases/R2024a/README.md

+90
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
# Network License Manager for MATLAB on Microsoft Azure
2+
3+
## Step 1. Launch the Template
4+
5+
Click the **Deploy to Azure** button below to deploy the cloud resources on Azure®. This will open the Azure Portal in your web browser.
6+
7+
| Create Virtual network | Use Existing Virtual Network |
8+
| --- | --- |
9+
| Use this option if you would like to deploy the resources in a new virtual network:<br><br><a href="https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2Fmathworks-ref-arch%2Flicense-manager-for-matlab-on-azure-linux%2Fmaster%2Freleases%2FR2024a%2Fazuredeploy-R2024a.json" target="_blank"><img src="https://aka.ms/deploytoazurebutton"/></a></br></br> | Use this option if you would like to deploy the resources in an existing virtual network: <br><br><a href="https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2Fmathworks-ref-arch%2Flicense-manager-for-matlab-on-azure-linux%2Fmaster%2Freleases%2FR2024a%2Fazuredeploy-existing-vnet-R2024a.json" target="_blank"><img src="https://aka.ms/deploytoazurebutton"/></a></br></br> |
10+
11+
> Cluster Platform: Ubuntu 22.04 LTS
12+
13+
> MATLAB&reg; Release: R2024a
14+
15+
## Step 2. Configure the Cloud Resources
16+
Clicking the Deploy to Azure button opens the "Custom deployment" page in your browser. You can configure the parameters on this page. It is easier to complete the steps if you position these instructions and the Azure Portal window side by side.
17+
18+
1. Specify and check the defaults for these resource parameters:
19+
20+
| Parameter label | Description |
21+
| --------------- | ----------- |
22+
| **Instance Type** | Azure instance type, see https://learn.microsoft.com/en-us/azure/virtual-machines/sizes. |
23+
| **Client IP Address** | The IP address range that can be used access the license manager. This must be a valid IP CIDR range of the form x.x.x.x/x. Use the value &lt;your_public_ip_address&gt;/32 to restrict access to only your computer. |
24+
| **Admin Username** | Admin username, this is used to login to the Network License Manager for MATLAB dashboard. |
25+
| **Admin Password** | Admin password for the chosen username. This is used to login to the Network License Manager for MATLAB dashboard. |
26+
| **Virtual Network Resource ID** | The Resource ID of an existing virtual network to deploy your server into. Specify this parameter only when deploying with the Existing Virtual Network option. Specify this parameter only when deploying with the Existing Virtual Network option. |
27+
| **Subnet Name** | The name of an existing subnet within your virtual network to deploy your server into. Specify this parameter only when deploying with the Existing Virtual Network option. Specify this parameter only when deploying with the Existing Virtual Network option. |
28+
29+
30+
**NOTE**: The port and hostname of the network license manager must be reachable from all virtual machines running MATLAB. It is therefore recommended that you deploy into a subnet within the same virtual network as the network license manager.
31+
32+
2. Tick the box to accept the Azure Marketplace terms and conditions.
33+
34+
3. Click the **Create** button.
35+
36+
# Step 3: Connect to the Dashboard
37+
38+
> **Note**: The Internet Explorer web browser is not supported for interacting with the dashboard.
39+
40+
1. In the Deployments for your resource group, select the Microsoft.Template deployment created in step 2 and select the **Outputs** section.
41+
2. Copy the URL listed in the `NETWORKLICENSEMANAGERADDRESS` field. This is the HTTPS endpoint to the network license manager for MATLAB Dashboard.
42+
43+
# Step 4: Sign in to the Dashboard
44+
1. Paste the network license manager Address URL into a web browser.
45+
2. Enter the username set at the time of the deployment along with the password for this user you created in Step 2.
46+
47+
![Console Login](../../img/Console_Login.png)
48+
49+
> **Note**: The dashboard uses a self-signed certificate which can be changed. For information on changing the self-signed certificates, see [Change Self-signed Certificate](#change-self-signed-certificate).
50+
51+
# Step 5: Upload the License File
52+
> **Note**: You will need the fixed network license manager Host ID to get a license file from the MathWorks&reg; License Center for your product. For more information, see the documentation for your product.
53+
54+
1. In the dashboard, go to **Administration > Manage License**.
55+
2. Click **Browse License File** to select the license file you want to upload and click **Open**.
56+
3. Click **Upload**.
57+
58+
![Console Upload](../../img/Console_Upload.png)
59+
60+
You are now ready to use the network license manager on Azure.
61+
62+
To configure your MATLAB products deployed in Azure to use the network license manager, see the product documentation. An example for MATLAB Parallel Server can be found at [MATLAB Parallel Server on Azure](https://github.com/mathworks-ref-arch/matlab-parallel-server-on-azure).
63+
64+
# Additional Information
65+
## Delete Your Cloud Resources
66+
You can remove the Resource Group and all associated resources when you are done with them. Note that you cannot recover resources once they are deleted.
67+
1. Sign in to the Azure Portal.
68+
2. Select the Resource Group containing your resources.
69+
3. Select the "Delete resource group" icon to destroy all resources deplyoyed in this group.
70+
4. You will be prompted to enter the name of the resource group to confirm the deletion.
71+
72+
![Resource Group Delete](../../img/Resource_Group_Delete.png)
73+
74+
## Change Self-signed Certificate
75+
You can change the self-signed certificate used to connect to the dashboard. To upload an HTTPS certificate:
76+
1. On the dashboard navigation menu, select **Administration** > **Manage HTTPS Certificate**.
77+
1. Click **Browse Certificate...** and select a certificate file. Only `.pfx` files are supported.
78+
1. Enter the certificate password in the **Certificate Password** field.
79+
1. Click **Upload**.
80+
81+
The server will automatically restart after uploading a certificate. You will need to sign out and sign back in.
82+
83+
## Troubleshooting
84+
If your resource group fails to deploy, check the Deployments section of the Resource Group. It will indicate which resource deployments failed and allow you to navigate to the relevant error message.
85+
86+
----
87+
88+
Copyright 2024 The MathWorks, Inc.
89+
90+
----

0 commit comments

Comments
 (0)