Upgrade workflow doc #12
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mwshriya
requested changes
Oct 20, 2023
Update for 23a/b
mwshriya
approved these changes
Nov 29, 2023
UPGRADES.md
Outdated
|
|
||
| - An existing deployment of MATLAB Production Server, as deployed by the reference architecture. | ||
| - A backup of all applications uploaded to your current MATLAB Production Server deployment. You can create this by copying the contents of the S3 bucket containing your application code archives (``.ctf`` files) to a secure location. | ||
| - (Optional) An existing VPC with the required subnets and ports to deploy MATLAB Production Server to it. For more information on these requirements, navigate to the [reference architecture documentation](https://github.com/mathworks-ref-arch/matlab-production-server-on-aws) for the MATLAB release of your existing deployment. Required subnets and ports are described in "Step 3. Configure Existing VPC" for R2023a and later, or "How do I use an existing VPC to deploy MATLAB Production Server" in the FAQ section for earlier releases. If you already have an existing deployment in this VPC, these requirements should already be met. |
There was a problem hiding this comment.
Would be great if we can get editorial inputs for alternatives to using double quotes. It's a little hard to follow in what situations we are using bold font vs monospace font vs quotes.
| ### URL Compatibility | ||
| Your client applications might access MATLAB Production Server applications using the default MATLAB Execution Endpoint URL ```MATLABProductionServerFunctionExecutionURL``` provided in the **Outputs** tab of the root stack. If they do, note that this URL is different for your new deployment. | ||
|
|
||
| You can avoid this issue in future upgrades by setting a custom DNS name for the MATLAB Execution Endpoint load balancer ```MATLABProductionServerLoadBalancer```. See [Configure a custom domain name for your Classic Load Balancer](https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/using-domain-names-with-elb.html) for instructions. |
There was a problem hiding this comment.
Since we are linking out to AWS doc, MathWorks doc center, and GitHub, it may be helpful to orient the reader. Editorial review should cover this.
UPGRADES.md
Outdated
|
|
||
|
|
||
| *If using a new VPC*: | ||
| 1. In the GitHub repository for [MATLAB Production Server on AWS](https://github.com/mathworks-ref-arch/matlab-production-server-on-aws), navigate to the [MATLAB release](https://github.com/mathworks-ref-arch/matlab-production-server-on-aws#deploy-reference-architecture-for-your-release) you are deploying. Under “Step 1. Launch Template,” click **Launch Stack**. (For R2023a and later, click the button under New VPC.) |
There was a problem hiding this comment.
For consistency between the first bullets in new VPC and existing VPC, we can use either "In the GitHub repository..." or "From the GitHub repository..." in both sentences.
UPGRADES.md
Outdated
| ### Step 2. Upload License File | ||
| 1. Log in to the Network License Manager Dashboard. | ||
| - *If using a new network license manager*:<ol style="list-style-type:lower-roman"><li>In the **Outputs** tab for your new stack, locate the ```MatlabProductionServerLicenseServer``` key and click the corresponding URL. This takes you to the Network License Manager for MATLAB Dashboard login page.</li><li>Log in with the username ```manager``` and the password you specified while creating the stack. </li></ol> | ||
| - *If using an existing network license manager*:<ol style="list-style-type:lower-roman"><li>In the AWS Console, navigate to the EC2 instance for your network license manager. Locate the public IPv4 DNS for this instance and click the corresponding URL. This takes you to the Network License Manager for MATLAB Dashboard login page.</li><li>Log in with the username and password congifured when initially deploying this License Manager.</li><li>Navigate to the [reference architecture documentation](https://github.com/mathworks-ref-arch/matlab-production-server-on-aws#deploy-reference-architecture-for-your-release) for the MATLAB release of your new deployment. Follow the additional configuration steps in the “How to use an existing license server in an existing VPC?” subsection, under “How do I use an existing VPC to deploy MATLAB Production Server?” in the FAQ section. (For R2023a and later, follow the steps under "Use Existing License Server in Existing VPC," under "Additional Information.")</li></ol> |
UPGRADES.md
Outdated
|
|
||
| 1. Navigate to the S3 bucket containing the applications for your existing deployment. This can be found in the **Outputs** tab for your existing deployment's stack, with the key ```MATLABProductionServerApplicationsBucket```. | ||
| 2. Select all code archives (``.ctf`` files) in the **auto_deploy** folder, then select **Actions > Move**. | ||
| 3. Set the destination as the **auto_deploy** folder in the S3 bucket for your new deployment. This can be found in Outputs tab for your new stack, with the key ```MATLABProductionServerApplicationsBucket```. |
There was a problem hiding this comment.
For consistency, we can format Outputs in bold here since it is in bold earlier.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Documentation for upgrading an existing deployment to a newer version.