Skip to content

Commit 3c8a543

Browse files
authored
Packer script release
1 parent abd58c5 commit 3c8a543

70 files changed

Lines changed: 5184 additions & 7 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

README.md

Lines changed: 39 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# MATLAB Parallel Server on Microsoft Azure
22

3-
This repository helps you automate the process of deploying MATLAB® Parallel Server™ and MATLAB Job Scheduler using your Azure® account.
3+
This repository helps you automate the process of deploying MATLAB® Parallel Server™ and MATLAB Job Scheduler using your Azure® account.
44

55
Use this repository to deploy a compute cluster using compute, storage, and network resources hosted by Azure. The cloud resources are created using Azure Resource Manager (ARM) templates. For information about the architecture of this solution, see [Learn About Cluster Architecture](#learn-about-cluster-architecture).
66

@@ -15,12 +15,21 @@ Before starting, you need the following:
1515
* An Azure account. To configure your account to enable autoscaling (since R2022b), see [Configure Azure Account](#configure-azure-account).
1616

1717
# Costs
18+
1819
You are responsible for the cost of the Azure services you use when you create cloud resources using this repository. Resource settings, such as virtual machine (VM) type, affect the cost of deployment. For cost estimates, see the pricing pages for each Azure service you use. Prices are subject to change.
1920

2021
# Deployment Steps
2122

22-
To view instructions for deploying the MATLAB Parallel Server reference architecture, select a MATLAB release.
23+
By default, the MATLAB Parallel Server reference architectures below launch prebuilt machine images, described in [Learn about Cluster Architecture](#learn-about-cluster-architecture).
24+
Using a prebuilt machine image is the easiest way to deploy a MATLAB Parallel Server reference architecture.
25+
Prebuilt images are provided for the five most recent MATLAB releases.
26+
Alternatively, to build your own machine image,
27+
see [Build and Deploy Your Own Machine Image](#build-and-deploy-your-own-machine-image).
28+
You can also use this workflow to install an earlier MATLAB release.
29+
30+
## Deploy Prebuilt Machine Image
2331

32+
To view instructions for deploying the MATLAB Parallel Server reference architecture, select a MATLAB release.
2433
| Linux | Windows |
2534
| ----- | ------- |
2635
| [R2025b](releases/R2025b/README.md) | [R2025b](https://github.com/mathworks-ref-arch/matlab-parallel-server-on-azure/tree/master/releases/R2025b/README.md) |
@@ -38,6 +47,21 @@ To view instructions for deploying the MATLAB Parallel Server reference architec
3847
| | [R2019b](https://github.com/mathworks-ref-arch/matlab-parallel-server-on-azure/tree/master/releases/R2019b/README.md) |
3948
| | [R2019a\_and\_older](https://github.com/mathworks-ref-arch/matlab-parallel-server-on-azure/tree/master/releases/R2019a_and_older/README.md) |
4049

50+
The above instructions allow you to launch instances based on the latest prebuilt MathWorks® Azure Virtual Machine (VM) Images.
51+
52+
## Build and Deploy Your Own Machine Image
53+
54+
For details of the scripts which form the basis of the MathWorks Linux Azure VM Image build process,
55+
see [Build Your Own Machine Image](./packer/v1).
56+
You can use these scripts to build a custom Linux VM image for running MATLAB Parallel Server on Azure.
57+
You can then deploy this custom image with the MathWorks infrastructure as code (IaC) templates.
58+
You can customize the MATLAB release which is installed as part of this custom build.
59+
This includes MATLAB releases supported by the prebuilt images, as well as earlier MATLAB releases.
60+
For more details,
61+
see [Customize MATLAB Parallel Server Release to Install](./packer/v1#customize-matlab-parallel-server-release-to-install).
62+
Platform engineering teams can use these scripts to take advantage of optimizations MathWorks has developed
63+
for running MathWorks products in the cloud.
64+
For more details, see [What are the advantages of building images with MathWorks scripts?](#what-are-the-advantages-of-building-images-with-mathworks-scripts)
4165

4266
# Learn About Cluster Architecture
4367

@@ -98,13 +122,13 @@ Microsoft Azure is a set of cloud services that allow you to build, deploy, and
98122

99123
### What skills or specializations do I need to use this reference architecture?
100124

101-
No programming or cloud experience required.
125+
No programming or cloud experience required.
102126

103127
### How long does it take to deploy the reference architecture?
104128

105129
If you already have an Azure account set up and ready to use, you can start a MATLAB Parallel Server reference architecture cluster in less than 15 minutes. Startup time varies depending on the size of your cluster.
106130

107-
### How do I manage limits for Azure services?
131+
### How do I manage limits for Azure services?
108132

109133
For information about setting quotas, see [Azure subscription and service limits](https://learn.microsoft.com/azure/azure-resource-manager/management/azure-subscription-service-limits).
110134

@@ -116,19 +140,27 @@ Before enabling Spot Virtual Machines, consider these aspects:
116140

117141
* Pricing: Spot Virtual Machines offer discounts compared to on-demand virtual machines. The actual discount depends on the available unused capacity of the virtual machines within the availability zone (AZ). For more details, see the [Azure documentation](https://azure.microsoft.com/pricing/details/virtual-machines/linux/).
118142

119-
* Behavior of your cluster when Azure reclaims a Spot Virtual Machine: Spot Virtual Machines are used only for the worker nodes, whereas the head node always uses an on-demand virtual machine. This behavior protects your user job and task information from being lost when a virtual machine is reclaimed by Azure. Jobs in the queue are run when a new worker instance is available. For details on how jobs are run, refer to [How Parallel Computing Toolbox Runs a Job](https://www.mathworks.com/help/parallel-computing/how-parallel-computing-products-run-a-job.html). If a Spot VM for a worker is interrupted when it is running a task, the task is marked as failed. You can set the maximum number of times to rerun a failed task using the `MaximumRetries` property. For more details, see [Access task properties and behaviors](https://www.mathworks.com/help/parallel-computing/parallel.task.html).
143+
* Behavior of your cluster when Azure reclaims a Spot Virtual Machine: Spot Virtual Machines are used only for the worker nodes, whereas the head node always uses an on-demand virtual machine. This behavior protects your user job and task information from being lost when a virtual machine is reclaimed by Azure. Jobs in the queue are run when a new worker instance is available. For details on how jobs are run, refer to [How Parallel Computing Toolbox Runs a Job](https://www.mathworks.com/help/parallel-computing/how-parallel-computing-products-run-a-job.html). If a Spot VM for a worker is interrupted when it is running a task, the task is marked as failed. You can set the maximum number of times to rerun a failed task using the `MaximumRetries` property. For more details, see [Access task properties and behaviors](https://www.mathworks.com/help/parallel-computing/parallel.task.html).
120144

121145
* The following VM sizes are not supported for Azure Spot Virtual Machines:
122146
* B-series
123147
* Promo versions of any size (such as the Dv2, NV, NC, and H promo sizes)
124148

125149
For more information about the limitations of using Spot Virtual Machines, see [Azure Spot Virtual Machines for Virtual Machine Scale Sets](https://learn.microsoft.com/azure/virtual-machine-scale-sets/use-spot).
126150

151+
### What are the advantages of building images with MathWorks scripts?
152+
153+
Images built with MathWorks scripts are optimized and tested for MathWorks workflows.
154+
The images are deployed by MathWorks Azure Resource Manager (ARM) templates following Azure best practices.
155+
The warmup scripts found in [startup](./packer/v1/startup) allow you to start MATLAB faster. The ARM template uses these scripts to automatically initialize MathWorks files on the instance. These scripts are automatically included in both the prebuilt images and the images that you build using the instructions in [Deployment Steps](#deployment-steps).
156+
Without the optimization scripts, starting a large software application, such as MATLAB, for the first time can potentially take tens of minutes. Subsequent starts of the large software application will be faster.
157+
127158
# Technical Support
159+
128160
If you need help or have a request for additional features or capabilities, contact [MathWorks Technical Support](https://www.mathworks.com/support/contact_us.html).
129161

130162
----
131163

132-
Copyright 2018-2025 The MathWorks, Inc.
164+
Copyright 2018-2026 The MathWorks, Inc.
133165

134-
----
166+
----

0 commit comments

Comments
 (0)