Skip to content

Commit 8e13a92

Browse files
committed
README update
1 parent 82651c0 commit 8e13a92

File tree

1 file changed

+29
-11
lines changed

1 file changed

+29
-11
lines changed

README.md

Lines changed: 29 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,10 @@ To view instructions for deploying the MATLAB reference architecture, select a M
4040
| [R2019b](releases/R2019b/README.md) | |
4141
| [R2019a\_and\_older](releases/R2019a_and_older/README.md) | |
4242

43+
The above instructions allow you to launch instances based on the latest prebuilt MathWorks® Amazon Machine Images (AMIs).
44+
MathWorks periodically replaces older AMIs with new images.
45+
For more details, see
46+
[When are the MathWorks Amazon Machine Images updated?](#when-are-the-mathWorks-amazon-machine-images-updated)
4347

4448
## Build and Deploy Your Own Machine Image
4549
For details of the scripts which form the basis of the MathWorks Linux AMI build process,
@@ -73,7 +77,22 @@ The following resources may be created according to your deployment configuratio
7377

7478
## FAQ
7579

76-
### How do I save my changes in the VM?
80+
### When are the MathWorks Amazon Machine Images updated?
81+
The links in [Deployment Steps](#deployment-steps) launch instances based on the latest MathWorks
82+
AMIs for at least the four most recent MATLAB releases. MATLAB releases occur twice each year.
83+
84+
For each MATLAB release, MathWorks periodically replaces the corresponding AMI with a newer AMI
85+
that includes the latest MATLAB updates and important security updates of the base OS image.
86+
87+
When MathWorks replaces an AMI, the older AMI is deleted.
88+
However, any running instances previously launched from the older AMI are not affected.
89+
To continue using an older AMI, copy the AMI into your AWS account.
90+
For more details on how to copy an AMI, see
91+
[How do I copy the AMI?](#how-do-I-copy-the-ami)
92+
For more details on how to customize the reference architectures to
93+
deploy the copied AMI see [How do I customize the AMI?](#how-do-I-customize-the-ami)
94+
95+
### How do I save my changes in the AMI?
7796
All your files and changes are stored locally on the virtual machine. They will persist until you either terminate the virtual machine instance or delete the stack. Stopping the instance does not destroy the data on the instance. If you want your changes to persist outside the stack or before you terminate an instance, you’ll need to:
7897
* Copy your files to another location (*Example*: S3 or Mount an Amazon EBS volume and create a snapshot), or
7998
* Create an image of the virtual machine.
@@ -84,27 +103,26 @@ You may want to shut down the instance when you aren’t using it to save some m
84103
### How do I keep the same public IP address?
85104
To avoid having to change the IP address between restarts, you can enable the *Keep public IP address the same* during deployment. For more information, see https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html.
86105

87-
### How do I save a VM image?
88-
To save a VM image, locate the EC2 Instance in the AWS web console and select **Actions** > **Image** > **Create Image.**
89-
90-
### How do I copy the VM image to a different region?
91-
You can copy the AMI for a certain MATLAB version to a target region of your choice.
106+
### How do I save an AMI?
107+
To save an AMI, locate the EC2 Instance in the AWS web console and select **Actions** > **Image** > **Create Image.**
92108

93-
* In the Releases folder of this repository, choose the MATLAB release that you want to copy. Download and open the CloudFormation template .json file for that release.
109+
### How do I copy the AMI?
110+
To copy the AMI for a certain MATLAB version to a target region of your choice, follow these steps:
111+
* Choose the MATLAB release that you want to copy from the Releases folder of this repository. Download and open the CloudFormation template .json file for that release.
94112
* Locate the Mappings section in the CloudFormation template. Copy the AMI ID for one of the existing regions, for example, us-east-1.
95-
* To copy the AMI to your target region, [follow the instructions at Copying an AMI on the AWS documentation](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/CopyingAMIs.html).
113+
* To copy the AMI to your target region, see [Copy an AMI](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/CopyingAMIs.html) in the AWS documentation.
96114
* In the Mappings section of the CloudFormation template, add a new RegionMap pair corresponding to your target region. Insert the new AMI ID of the AMI in the target region.
97115
* In your AWS Console, change your region to your target region. In the CloudFormation menu, select Create Stack > With new resources option. Provide the modified CloudFormation template.
98116

99117
You can now deploy the AMI in your target region using the AMI that you copied.
100118

101-
### How do I customize the VM image?
102-
You can customize a prebuilt VM image by launching the reference architecture, applying any changes you want to the EC2 Instance (such as installing additional software, drivers, and files), and then saving an image of that instance using the AWS Console. For more information, see [How Do I save a VM image?](#how-do-i-save-a-vm-image). When you create a stack, replace the AMI ID in the CloudFormation template with the AMI ID of your customized image.
119+
### How do I customize the AMI?
120+
You can customize a prebuilt AMI by launching the reference architecture, applying any changes you want to the EC2 Instance (such as installing additional software, drivers, and files), and then saving an image of that instance using the AWS Console. For more information, see [How do I save an AMI?](#how-do-i-save-an-ami). When you create a stack, replace the AMI ID in the CloudFormation template with the AMI ID of your customized image.
103121

104122
You can also create a custom image by building your own using the Packer scripts we provide. See [Build and Deploy Your Own Machine Image](#build-and-deploy-your-own-machine-image).
105123

106124
### How do I use a different license manager?
107-
The VM image uses MathWorks Hosted License Manager by default. For information on how to use other license managers, see [MATLAB Licensing in the Cloud](https://www.mathworks.com/help/licensingoncloud/matlab-on-the-cloud.html).
125+
The AMI uses MathWorks Hosted License Manager by default. For information on how to use other license managers, see [MATLAB Licensing in the Cloud](https://www.mathworks.com/help/licensingoncloud/matlab-on-the-cloud.html).
108126

109127
# Technical Support
110128
If you require assistance or have a request for additional features or capabilities, please contact [MathWorks Technical Support](https://www.mathworks.com/support/contact_us.html).

0 commit comments

Comments
 (0)