diff --git a/README.md b/README.md index edea702..947b745 100644 --- a/README.md +++ b/README.md @@ -26,18 +26,17 @@ The default MATLAB Web App Server deployment template uses the Network License M # Deploy Reference Architecture for Your Release To deploy the reference architecture, select your MATLAB Web App Server release from the table and follow the instructions to deploy the server using the provided template. A deployment of MATLAB Web App Server supports MATLAB Runtime versions up to six releases back. -| Release | Supported MATLAB Runtime Versions | -| ------- | --------------------------------- | -| [R2025a](releases/R2025a/README.md) | R2025a, R2024b, R2024a, R2023b, R2023a*, R2022b* | -| [R2024b](releases/R2024b/README.md) | R2024b, R2024a, R2023b, R2023a*, R2022b*, R2022a* | -| [R2024a](releases/R2024a/README.md) | R2024a, R2023b, R2023a, R2022b, R2022a, R2021b | -| [R2023b](releases/R2023b/README.md) | R2023b, R2023a, R2022b, R2022a, R2021b | -| [R2023a](releases/R2023a/README.md) | R2023a, R2022b, R2022a, R2021b, R2021a, R2020b | -| [R2022b](releases/R2022b/README.md) | R2022b, R2022a, R2021b, R2021a, R2020b, R2020a | +| Release | Supported MATLAB Runtime Versions | Status | +| ------- | --------------------------------- |--------| +| [R2025b](releases/R2025b/README.md) | R2025b, R2025a, R2024b, R2024a, R2023b, R2023a* | ✅ Template available. | +| [R2025a](releases/R2025a/README.md) | R2025a, R2024b, R2024a, R2023b, R2023a*, R2022b* | ✅ Template available. | +| [R2024b](releases/R2024b/README.md) | R2024b, R2024a, R2023b, R2023a*, R2022b*, R2022a* | ✅ Template available. | +| [R2024a](releases/R2024a/README.md) | R2024a, R2023b, R2023a, R2022b, R2022a, R2021b | ⚠️ Template will be removed in September 2026. | +| [R2023b](releases/R2023b/README.md) | R2023b, R2023a, R2022b, R2022a, R2021b | ⚠️ Template will be removed in March 2026. | > \*When the server is configured to use MATLAB Runtime versions prior to R2023b, the `unsafe-inline` attribute is set in the `script-src` directive of the Content Security Policy on the server and cannot be disabled. This allows web apps with embedded JavaScript to execute on the server. These runtimes are disabled by default starting in R2024b. You can enable them using the [webapps-runtime](https://www.mathworks.com/help/webappserver/ref/webappsruntime.html) command. -**Note**: MathWorks provides templates for only the six most recent releases of MATLAB Web App Server. Earlier templates are removed and are no longer supported. +**Note**: MathWorks provides templates for only the five most recent releases of MATLAB Web App Server. Earlier templates are removed and are no longer supported. # Architecture and Resources Deploying this reference architecture creates several resources in your diff --git a/releases/R2022b/README.md b/releases/R2022b/README.md deleted file mode 100644 index 3060d25..0000000 --- a/releases/R2022b/README.md +++ /dev/null @@ -1,220 +0,0 @@ -# MATLAB Web App Server on Amazon Web Services - R2022b - -# Deployment Steps -Follow these steps to deploy the R2022b MATLAB Web App Server reference architecture on AWS. To deploy reference architectures for other releases, see [Deploy Reference Architecture for Your Release](/README.md#deploy-reference-architecture-for-your-release). -## Step 1. Launch Template -Before launching the template, make sure that you have selected one of these supported AWS regions from the top navigation: - -Then, click the appropriate **Launch Stack** button to launch the stack configuration template for deploying resources onto your AWS account. You can deploy resources onto either a new or existing VPC. - -| Release | New VPC | Existing VPC | Operating Systems | -|---------|---------| ------------ | ----------------- | -| R2022b | | | Windows Server 2019 or Ubuntu 18.04 VM | - -The AWS Management Console opens in your web browser. - ->**NOTE:** Multiple versions of MATLAB Runtime are supported. For details, see [Deploy Reference Architecture for Your Release](/README.md#deploy-reference-architecture-for-your-release). - ->**NOTE:** Creating a stack on AWS can take at least 20 minutes. -> - - -## Step 2. Configure the Stack -1. Provide values for parameters in the **Create Stack** page: - - | Parameter Name | Value | - |----------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| - | **Stack name** | Choose a name for the stack. This will be shown in the AWS console.

*Example*: `Boston`

| - | |**Settings for Hosting MATLAB Web App Server**| - | **Name of Existing Amazon EC2 Key Pair** | Choose an existing Amazon EC2 key pair to connect to the EC2 instance hosting MATLAB Web App Server. If you do not have a key pair, create one. For details, see [Amazon EC2 Key Pairs](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html#having-ec2-create-your-key-pair).

*Example*: `boston-keypair`

| - | **IP Address of MATLAB Web App Server Administrator in CIDR Notation** | Specify the IP address of the administrator using CIDR notation. The administrator can remotely connect to the EC2 instance that hosts MATLAB Web App Server and administer it. The IP address can be a single IP address or a range of IP addresses. The format for this parameter is IP Address/Mask.

Example: `x.x.x.x/32`

**NOTE:** Restricting access to the server using an IP address is not a form of authentication. MATLAB Web App Server supports authentication using LDAP and OIDC. For details, see [Authentication](https://www.mathworks.com/help/webappserver/ug/authentication.html).

| - | **Do You Want to Use the Same IP Address Range to Access the MATLAB Web App Server Apps Home Page?**| Select, **Yes** or **No**. - | **IP Addresses Allowed to Access MATLAB Web App Server Apps Home Page** | Complete this parameter only if you selected **No** for the previous parameter. Specify the range of IP addresses that can access the MATLAB Web App Server apps home page in CIDR notation. The format for this parameter is IP Address/Mask.

*Example*: `x.x.x.x/24`

| - | **ARN of SSL Certificate** | Specify the Amazon Resource Name (ARN) of the SSL certificate you uploaded to the AWS Certificate Manager. The ARN facilitates connecting to the apps home page using an HTTPS connection.

*Example*: arn:aws:acm:us-east-1:012345678910:certificate/666abcd6-ab6c-6ab6-a666-a666666bcd66

To retrieve an ARN:

For more information, see [Create Self-signed Certificate](#create-self-signed-certificate) and [Upload Self-signed Certificate to AWS Certificate Manager](#upload-self-signed-certificate-to-aws-certificate-manager). - | **EC2 Instance Type** | Choose the AWS EC2 instance type to use for the server. All AWS instance types are supported. For more information, see [Amazon EC2 Instance Types](https://aws.amazon.com/ec2/instance-types/).

*Example*: `m5.xlarge`

| - | **Operating System** | Choose between Windows (Windows Server) and Linux (Ubuntu). | - ||**Settings for Network License Manager**| - | **Password for Network License Manager** | Specify a password for the network license manager. Use this password to log in to the network license manager after the stack has been successfully created.

Deploying MATLAB Web App Server automatically deploys a network license manager.

| - | **Confirm Password** | Reenter the password to log in to the network license manager. | - - >**Note**: Make sure you select US East (N.Virginia), EU (Ireland) or Asia Pacific (Tokyo) as your region from the navigation panel on top. Currently, US East, EU (Ireland), and Asia Pacific (Tokyo) are the only supported regions. - -2. Tick the boxes to accept that the template uses IAM roles. For more information about IAM, see [IAM FAQ](https://aws.amazon.com/iam/faqs). - -3. Click the **Create** button. The CloudFormation service starts creating resources for the stack. ->**Note**: Clicking **Create** takes you to the *Stack Detail* page for your stack. Wait for the Status to reach **CREATE\_COMPLETE**. This can take up to 20 minutes. - -## Step 3. Configure Existing VPC - ->**Note**: If you are deploying to a new VPC, skip this step. - -To deploy MATLAB Web App Server onto an existing VPC, specify these additional parameters. - -| Parameter | Value | -|----------------------------------|--------------------------------------------------------------------------------| -| Existing VPC ID | ID of your existing VPC. | -| IP address range of existing VPC | IP address range from the existing VPC. To find the IP address range:
  1. Log in to the AWS Console.
  2. Navigate to the VPC dashboard and select your VPC.
  3. Click the **CIDR blocks** tab.
  4. The **IPv4 CIDR Blocks** gives the IP address range.
| -|Assign Public IP to EC2 Instance Hosting MATLAB Web App Server | Specify whether the deployed EC2 instance must use a public IP address. If you select "No", you must provide a private subnet in the parameter **Subnet for MATLAB Web App Server**. | -| Subnet for MATLAB Web App Server | Specify the ID of a public or private subnet within the existing VPC that will host the server. | -| Public Subnet 1 ID | ID of an existing public subnet to host server resources. This subnet can be the same as the one hosting MATLAB Web App Server, as long as the subnet hosting the server is public. If the subnet hosting the server is private, then this subnet must be a different public subnet. | -| Public Subnet 2 ID | ID of an existing public subnet to host server resources. This subnet must be different from Public Subnet 1.| - -You will also need to open the following ports in your VPC: - -| Port | Description | -|------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `443` | Required for communicating with MATLAB Web App Server apps home page. | -| `8000`, `9988` | Required for communication between MATLAB Web App Server controllers and AWS services. These ports do not need to be open to the internet. | -| `27000` | Required for communication between the network license manager and MATLAB Web App Server. | -| `3389`, `22` | Required for Remote Desktop and Secure Connection functionality. This can be used for troubleshooting and debugging MATLAB Web App Server. | - -### Use an existing network license manager in an existing VPC -If you want to use an existing network license manager: -- Choose `No` for the *Deploy Network License Manager* step of the deployment. -- Specify the IP address of the existing network license manager in the `IP Address of Existing Network License Manager` step of the deployment. - -To use an existing network license manager, you must add the security group of the server VMs to the security group of the license manager. -1. In the AWS management console, select the stack where the network license manager is deployed. -1. In the *Stack details* for your stack, click **Resources**. -1. Look for the **Logical ID** named ```SecurityGroup``` and click the corresponding URL listed under **Physical ID**. This will take you to the security group details. -1. Click the **Inbound Rules** tab, then click **Edit Inbound Rules**. -1. Click **Add Rule**. -1. In the **Type** dropdown, select ```All TCP```. -1. In the **Source**, search and add the ```MatlabWebappServerCloudStackSg``` security group. -1. Click **Save Rules**. - ->**NOTE:** When using an existing license manager on an existing VPC, use the private IP address of the network license manager. You can find the private IP address in the *Outputs* tab of the existing network license manager deployment. - - -## Step 4. Create Stack -Review or edit your stack details. You must select the acknowledgements to create IAM resources. Otherwise, the deployment produces a `Requires capabilities : [CAPABILITY_IAM]` error and fails to create resources. For more information about IAM, see [IAM FAQ](https://aws.amazon.com/iam/faqs). - -Click the **Create** button. The CloudFormation service starts creating resources for the stack. ->**Note**: Clicking **Create** takes you to the *Stack Detail* page for your stack. Wait for the Status to reach **CREATE\_COMPLETE**. This can take up to 20 minutes. - -## Step 5. Upload License File -1. Click **Outputs** in the *Stack details* for your stack. -1. Look for the key named `MATLABWebAppServerLicenseManager` and click the corresponding URL listed under value. This will take you to Network License Manager for MATLAB Dashboard login page. -1. The username is **manager**. For the password, enter the password you entered for the **Password for Network License Manager** parameter while creating the stack in [Step 2](#step-2-configure-the-stack). -1. Follow the instructions on the home page of the network license manager to upload your MATLAB Web App Server license. - ->**Note:** MATLAB Web App Server automatically starts after succesfully uploading a valid license file. - - -## Step 6. Open the MATLAB Web App Server Apps Home Page -1. In the *Stack details* for your stack, click the **Outputs** tab. -1. Look for the key named `MATLABWebAppServerAppsHomePage` and click the corresponding URL listed under value. This opens the apps home page. - -You are now ready to use MATLAB Web App Server on AWS. - -To run applications on MATLAB Web App Server, you need to create web apps using MATLAB Compiler. For details, see [Web Apps](https://www.mathworks.com/help/compiler/webapps/create-and-deploy-a-web-app.html) in the MATLAB Compiler product documentation. - -# Common Tasks - -## Upload Web Apps to AWS S3 Bucket -1. In the AWS management console, select the stack that you deployed. -1. In the *Stack details* for your stack, click the **Outputs** tab. -1. Look for the key named `MATLABWebAppServerAppsS3Bucket`, and click the corresponding URL listed under value. -1. In the S3 console, click **apps**. -1. Click **Upload** > **Add Files** to select and upload web apps (`.ctf` files). ->**NOTE 1:** If you enable OIDC authentication, you can upload web apps from the apps home page. Any apps you upload via the apps home page are not synchornized with S3 bucket. To enable OIDC authentication, see [Configure OIDC Authentication](#configure-oidc-authentication). ->**NOTE 2:** Only folders created within the APPS root level folder are supported. Subfolders within those folders are not supported. - -## Get Password to EC2 Instance Hosting MATLAB Web App Server -1. In the AWS management console, select the stack you deployed. -1. In the Stack Detail for your stack, click the **Outputs** tab. -1. Look for the key named `MATLABWebAppServerEC2Instance` and click the corresponding URL listed under value. This will take you to the server instance (`matlab-webapp-server-vm`) page. -1. Click the **Connect** button at the top. -1. In the *Connect to instance* dialog, click the **RDP client** tab and then click **Get Password**. -1. Click **Choose File** to navigate and select the private key file (`.pem` file) for the key pair that you used while creating the stack in [Step 2](#step-2-configure-the-stack). -1. Click **Decrypt Password**. The console displays the password for the instance in the *Connect to instance* dialog. -1. Copy the password to the clipboard. - -## Connect to EC2 Instance Hosting MATLAB Web App Server Using Remote Desktop -1. In the AWS management console, select the stack you deployed. -1. In the *Stack details* for your stack, click the **Outputs** tab. -1. Look for the key named `MATLABWebAppServerEC2Instance` and click the corresponding URL listed under value. This will take you to the server instance (`matlab-webapp-server-vm`) page. -1. Click the value under Instance ID to view the instance summary. -1. Click the **Connect** button at the top. -1. In the *Connect to instance* dialog, click the **RDP client** tab. -1. Click the **Download remote desktop file** button to download a .rdp file. -1. Use the .rdp file to remotely connect to EC2 instance using the following credentials: -* Username: Administrator -* Password: The decrypted password. For details, see [Get Password to EC2 Instance](#get-password-to-ec2-instance-hosting-matlab-web-app-server). - -## Connect to EC2 Instance Hosting MATLAB Web App Server Using SSH -1. In the AWS management console, select the stack you deployed. -1. In the *Stack details* for your stack, click the **Outputs** tab. -1. Look for the key named `MATLABWebAppServerEC2Instance` and click the corresponding URL listed under value. This will take you to the server instance (`matlab-webapp-server-vm`) page. -1. Click the value under Instance ID to view the instance summary. -1. Click the **Connect** button at the top. -1. In the *Connect to instance* dialog, click the **SSH client** tab. -1. Follow the instructions on the page to SSH to the EC2 instance. - -## Find Setup and Configuration Files -| Task | Relevant Files | Details | -|-----------------------|-----------------------------------------------------------|------------------------------------| -| Server Administration | `webapps-start`, `webapps-stop`, `webapps-restart`, `webapps-status` | [Command-Line Scripts Documentation](https://www.mathworks.com/help/webappserver/server-management.html) | -| Authentication | `webapps_authn.json` | [Authentication Documentation](https://www.mathworks.com/help/webappserver/ug/authentication.html) | -| Role-Based Access | `webapps_app_roles.json` | [Role-Based Access Documentation](https://www.mathworks.com/help/webappserver/ug/role-based-access.html) | -| Policy-Based Access | `webapps_acc_ctl.json` | [Policy-Based Access Documentation](https://www.mathworks.com/help/webappserver/ug/policy-based-access.html) | - -## Configure OIDC Authentication -1. Connect to the EC2 instance hosting MATLAB Web App Server. For details, see: - * [Connect to EC2 Instance Hosting MATLAB Web App Server Using Remote Desktop](#connect-to-ec2-instance-hosting-matlab-web-app-server-using-remote-desktop) - * [Connect to EC2 Instance Hosting MATLAB Web App Server Using SSH](#connect-to-ec2-instance-hosting-matlab-web-app-server-using-ssh). -1. Follow the instructions on the [Authentication](https://www.mathworks.com/help/webappserver/ug/authentication.html) page in the MathWorks documentation. - >**NOTE:** SSL is enabled when you deploy the stack. -1. For the `redirectUrl`, use the URL created as part of your stack. - * In the AWS management console, select the stack you deployed. - * In the *Stack details* for your stack, click the **Outputs** tab. - * Look for the key named `MATLABWebAppServerOIDCRedirectUrl` and copy the corresponding URL listed under value. - * Use this URL in the `webapps_authn.json` file. - -## Create Self-signed Certificate -For information on creating a self-signed certificate, see [Create and Sign an X509 Certificate](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/configuring-https-ssl.html). - -## Upload Self-signed Certificate to AWS Certificate Manager - -1. Open the AWS Certificate Manager. -2. Click the button at the top of the page to **Import a certificate**. -3. Copy the contents of the `.crt` file containing the certificate into the field labeled **Certificate body**. -4. Copy the contents of the `.pem` file containing the private key into the field labeled **Certificate private key**. -5. Leave the field labeled **Certificate chain** blank. -6. Click the button labeled **Review and import**. -7. Review the settings and click the **Import** button. -8. Copy the value of the Amazon Resource Name (ARN) field from the **Details** section of the certificate. - -The ARN value that you copied should be pasted into the **ARN of SSL Certificate** parameter of the template in [Step 2](#step-2-configure-the-stack). - -## View Logs -Logs are available in AWS CloudWatch. -1. In the AWS management console, select the stack you deployed. -1. In the *Stack details* for your stack, click the **Outputs** tab. -1. To view logs related to the cloud console and the MATLAB Web App Server workers, look for the key named `MATLABWebAppServerLogGroup`, and click the corresponding URL listed under value. - -## Get Network License Manager MAC Address -1. In the AWS management console, select the stack that you deployed. -1. In the *Stack details* for your stack, click the **Outputs** tab. -1. Look for the key named `MATLABWebAppServerLicenseManager`, and click the corresponding URL listed under value. -1. Log in to the Network License Manager for MATLAB dashboard using the following credentials:
-Username: **manager**
-Password: Enter the password you provided while creating the stack. -1. Click **Administration** > **Manage License**. -1. Copy the license server MAC address displayed at the top. - -When you deploy the MATLAB Web App Server reference architecture, a network license manager is automatically deployed. You can also use an existing license manager that is located in the same VPC and the security group of the MATLAB Web App Server EC2 instance. For details, see [Network License Manager for MATLAB](https://github.com/mathworks-ref-arch/license-manager-for-matlab-on-aws). - ->**NOTE**: The license manager MAC address is available only after the stack creation is complete. - -## Delete Your Stack -To delete the stack: -1. Log in to the AWS Console. -3. Go to the CloudFormation page and select the stack you created. -3. Click **Delete**. - -# Enhancement Request -Provide suggestions for additional features or capabilities using the following link: https://www.mathworks.com/solutions/cloud.html - -# Technical Support -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). diff --git a/releases/R2023a/templates.json b/releases/R2023a/templates.json deleted file mode 100644 index 4f8fe37..0000000 --- a/releases/R2023a/templates.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "VPCStack.yml": "https://matlab-web-app-server-templates.s3.amazonaws.com/r2023a_refarch/VPCStack.yml", - "LambdaFunctionStack.yml": "https://matlab-web-app-server-templates.s3.amazonaws.com/r2023a_refarch/LambdaFunctionStack.yml", - "CommonResourcesStack.yml": "https://matlab-web-app-server-templates.s3.amazonaws.com/r2023a_refarch/CommonResourcesStack.yml", - "WebAppServer_existing.yml": "https://matlab-web-app-server-templates.s3.amazonaws.com/r2023a_refarch/WebAppServer_existing.yml", - "WebAppServer_new.yml": "https://matlab-web-app-server-templates.s3.amazonaws.com/r2023a_refarch/WebAppServer_new.yml" -} \ No newline at end of file diff --git a/releases/R2023b/README.md b/releases/R2023b/README.md index 8e54fd1..c69ec72 100644 --- a/releases/R2023b/README.md +++ b/releases/R2023b/README.md @@ -1,7 +1,7 @@ # MATLAB Web App Server on Amazon Web Services - R2023b # Deployment Steps -Follow these steps to deploy the R2023b MATLAB Web App Server reference architecture on AWS. To deploy reference architectures for other releases, see [Deploy Reference Architecture for Your Release](/README.md#deploy-reference-architecture-for-your-release). +Follow these steps to deploy the R2023b MATLAB Web App Server reference architecture on AWS. To deploy reference architectures for other releases, see [Deploy Reference Architecture for Your Release](/README.md?tab=readme-ov-file#deploy-reference-architecture-for-your-release). ## Step 1. Launch Template Before launching the template, make sure that you have selected one of these supported AWS regions from the top navigation: @@ -13,7 +13,7 @@ Then, click the appropriate **Launch Stack** button to launch the stack configur The AWS Management Console opens in your web browser. ->**NOTE:** Multiple versions of MATLAB Runtime are supported. For details, see [Deploy Reference Architecture for Your Release](/README.md#deploy-reference-architecture-for-your-release). +>**NOTE:** Multiple versions of MATLAB Runtime are supported. For details, see [Deploy Reference Architecture for Your Release](/README.md?tab=readme-ov-file#deploy-reference-architecture-for-your-release). >**NOTE:** Creating a stack on AWS can take at least 20 minutes. > diff --git a/releases/R2024a/README.md b/releases/R2024a/README.md index e3ec762..403add3 100644 --- a/releases/R2024a/README.md +++ b/releases/R2024a/README.md @@ -1,7 +1,7 @@ # MATLAB Web App Server on Amazon Web Services - R2024a # Deployment Steps -Follow these steps to deploy the R2024a MATLAB Web App Server reference architecture on AWS. To deploy reference architectures for other releases, see [Deploy Reference Architecture for Your Release](/README.md#deploy-reference-architecture-for-your-release). +Follow these steps to deploy the R2024a MATLAB Web App Server reference architecture on AWS. To deploy reference architectures for other releases, see [Deploy Reference Architecture for Your Release](/README.md?tab=readme-ov-file#deploy-reference-architecture-for-your-release). ## Step 1. Launch Template Before launching the template, make sure that you have selected one of these supported AWS regions from the top navigation: @@ -13,7 +13,7 @@ Then, click the appropriate **Launch Stack** button to launch the stack configur The AWS Management Console opens in your web browser. ->**NOTE:** Multiple versions of MATLAB Runtime are supported. For details, see [Deploy Reference Architecture for Your Release](/README.md#deploy-reference-architecture-for-your-release). +>**NOTE:** Multiple versions of MATLAB Runtime are supported. For details, see [Deploy Reference Architecture for Your Release](/README.md?tab=readme-ov-file#deploy-reference-architecture-for-your-release). >**NOTE:** Creating a stack on AWS can take at least 20 minutes. > diff --git a/releases/R2024b/README.md b/releases/R2024b/README.md index 19b30ce..9aaf91d 100644 --- a/releases/R2024b/README.md +++ b/releases/R2024b/README.md @@ -1,7 +1,7 @@ # MATLAB Web App Server on Amazon Web Services - R2024b # Deployment Steps -Follow these steps to deploy the R2024b MATLAB Web App Server reference architecture on AWS. To deploy reference architectures for other releases, see [Deploy Reference Architecture for Your Release](/README.md#deploy-reference-architecture-for-your-release). +Follow these steps to deploy the R2024b MATLAB Web App Server reference architecture on AWS. To deploy reference architectures for other releases, see [Deploy Reference Architecture for Your Release](/README.md?tab=readme-ov-file#deploy-reference-architecture-for-your-release). ## Step 1. Launch Template Before launching the template, make sure that you have selected one of these supported AWS regions from the top navigation: @@ -13,7 +13,7 @@ Then, click the appropriate **Launch Stack** button to launch the stack configur The AWS Management Console opens in your web browser. ->**NOTE:** Multiple versions of MATLAB Runtime are supported. For details, see [Deploy Reference Architecture for Your Release](/README.md#deploy-reference-architecture-for-your-release). +>**NOTE:** Multiple versions of MATLAB Runtime are supported. For details, see [Deploy Reference Architecture for Your Release](/README.md?tab=readme-ov-file#deploy-reference-architecture-for-your-release). >**NOTE:** Creating a stack on AWS can take at least 20 minutes. diff --git a/releases/R2025a/README.md b/releases/R2025a/README.md index df12e38..1bd2513 100644 --- a/releases/R2025a/README.md +++ b/releases/R2025a/README.md @@ -1,7 +1,7 @@ # MATLAB Web App Server on Amazon Web Services - R2025a # Deployment Steps -Follow these steps to deploy the R2025a MATLAB Web App Server reference architecture on AWS. To deploy reference architectures for other releases, see [Deploy Reference Architecture for Your Release](/README.md#deploy-reference-architecture-for-your-release). +Follow these steps to deploy the R2025a MATLAB Web App Server reference architecture on AWS. To deploy reference architectures for other releases, see [Deploy Reference Architecture for Your Release](/README.md?tab=readme-ov-file#deploy-reference-architecture-for-your-release). ## Prerequisites Before deploying MATLAB Web App Server within an existing Virtual Private Cloud (VPC), you must configure the VPC to enable connectivity. For details, see [Ensure connectivity in an existing VPC](#ensure-connectivity-in-an-existing-vpc). @@ -17,7 +17,7 @@ Then, click the appropriate **Launch Stack** button to launch the stack configur The AWS Management Console opens in your web browser. ->**NOTE:** Multiple versions of MATLAB Runtime are supported. For details, see [Deploy Reference Architecture for Your Release](/README.md#deploy-reference-architecture-for-your-release). +>**NOTE:** Multiple versions of MATLAB Runtime are supported. For details, see [Deploy Reference Architecture for Your Release](/README.md?tab=readme-ov-file#deploy-reference-architecture-for-your-release). >**NOTE:** Creating a stack on AWS can take at least 20 minutes. @@ -95,7 +95,7 @@ Click the **Create** button. The CloudFormation service starts creating resource ## Step 6. Connect and Log In to the Admin Portal (Linux Server Only) > **Note:** The Internet Explorer web browser is not supported for accessing the admin portal. -The MALAB Web App Server admin portal provides a web-based interface to configure and manage the server instance on the cloud. The admin portal is only available for servers deployed on Ubuntu Linux. +The MATLAB Web App Server admin portal provides a web-based interface to configure and manage the server instance on the cloud. The admin portal is only available for servers deployed on Ubuntu Linux. For more details on accessing and using the admin portal, see [Manage MATLAB Web App Server on AWS Using Admin Portal](https://www.mathworks.com/help/webappserver/ug/manage-matlab-web-app-server-using-admin-portal-on-aws-reference-architecture.html). 1. In the Stack details for your stack, click the **Outputs** tab. 1. Look for the key named `AdminPortalUrl` and click the corresponding URL listed under **value**. This opens the admin portal Overview page. @@ -131,7 +131,7 @@ To run applications on MATLAB Web App Server, you need to create web apps using ## Step 8. Configure User Authentication ### Linux Server -On Linux servers, user authentication to the admin portal and MATLAB Web App Server home page is administered by default through [Keycloak](https://www.keycloak.org/docs/latest/server_admin/index.html). Keycloak is a cloud native solution that provides authentication, authorization, and user management for applications and services. You can configure authentication using your identity provider with Keycloak or directly using LDAP or OIDC. +On Linux servers, user authentication to the admin portal and MATLAB Web App Server home page is administered by default through [Keycloak](https://www.keycloak.org/docs/latest/server_admin/index.html). Keycloak is a cloud native solution that provides authentication, authorization, and user management for applications and services. You can configure authentication using your identity provider with Keycloak or directly using LDAP or OIDC. For more details, see [Configure Authentication for MATLAB Web App Server on AWS](https://www.mathworks.com/help/webappserver/ug/configure-authentication-for-matlab-web-app-server-on-aws.html). After you deploy MATLAB Web App Server, log in to the Keycloak administration console to configure user authentication and change the default admin credentials. 1. In the Stack details for your stack, click the **Outputs** tab. @@ -145,7 +145,7 @@ After you deploy MATLAB Web App Server, log in to the Keycloak administration co There are three pre-configured user accounts and three groups in Keycloak. Each user account belongs to one or more groups, and each group grants specific permissions on the MATLAB Web App Server. For example, the `matlab-webapps-admin` user inherits the ability to upload and delete apps from the **MATLAB Web App Server Authors** group. Add or modify groups and users as needed through the Keycloak admin console. For more information, see [Managing users](https://www.keycloak.org/docs/latest/server_admin/index.html#assembly-managing-users_server_administration_guide) in the Keycloak documentation. -To allow an existing group to access additional resources on the MATLAB Web App Server, use the **App Management/Access Control** page of the admin portal. For example, you could assign all members of the **MATLAB Web App Server Users** group execute permissions for all apps in the root level folder. +To allow an existing group to access additional resources on the MATLAB Web App Server, use the **App Management/Access Control** page of the admin portal. For example, you could assign all members of the **MATLAB Web App Server Users** group execute permissions for all apps at the root level. ### Windows Server diff --git a/releases/R2023a/README.md b/releases/R2025b/README.md similarity index 53% rename from releases/R2023a/README.md rename to releases/R2025b/README.md index 38b881a..fffc8e8 100644 --- a/releases/R2023a/README.md +++ b/releases/R2025b/README.md @@ -1,7 +1,11 @@ -# MATLAB Web App Server on Amazon Web Services - R2023a +# MATLAB Web App Server on Amazon Web Services - R2025b # Deployment Steps -Follow these steps to deploy the R2023a MATLAB Web App Server reference architecture on AWS. To deploy reference architectures for other releases, see [Deploy Reference Architecture for Your Release](/README.md#deploy-reference-architecture-for-your-release). +Follow these steps to deploy the R2025b MATLAB Web App Server reference architecture on AWS. To deploy reference architectures for other releases, see [Deploy Reference Architecture for Your Release](/README.md?tab=readme-ov-file#deploy-reference-architecture-for-your-release). + +## Prerequisites +Before deploying MATLAB Web App Server within an existing Virtual Private Cloud (VPC), you must configure the VPC to enable connectivity. For details, see [Ensure connectivity in an existing VPC](#ensure-connectivity-in-an-existing-vpc). + ## Step 1. Launch Template Before launching the template, make sure that you have selected one of these supported AWS regions from the top navigation: @@ -9,15 +13,13 @@ Then, click the appropriate **Launch Stack** button to launch the stack configur | Release | New VPC | Existing VPC | Operating Systems | |---------|---------| ------------ | ----------------- | -| R2023a | | | Windows Server 2019 or Ubuntu 18.04 VM | +| R2025b | | | Windows Server 2022 or Ubuntu 22.04 VM | The AWS Management Console opens in your web browser. ->**NOTE:** Multiple versions of MATLAB Runtime are supported. For details, see [Deploy Reference Architecture for Your Release](/README.md#deploy-reference-architecture-for-your-release). +>**NOTE:** Multiple versions of MATLAB Runtime are supported. For details, see [Deploy Reference Architecture for Your Release](/README.md?tab=readme-ov-file#deploy-reference-architecture-for-your-release). >**NOTE:** Creating a stack on AWS can take at least 20 minutes. -> - ## Step 2. Configure the Stack 1. Provide values for parameters in the **Create Stack** page: @@ -27,12 +29,11 @@ The AWS Management Console opens in your web browser. | **Stack name** | Choose a name for the stack. This will be shown in the AWS console.

*Example*: `Boston`

| | |**Settings for Hosting MATLAB Web App Server**| | **Name of Existing Amazon EC2 Key Pair** | Choose an existing Amazon EC2 key pair to connect to the EC2 instance hosting MATLAB Web App Server. If you do not have a key pair, create one. For details, see [Amazon EC2 Key Pairs](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html#having-ec2-create-your-key-pair).

*Example*: `boston-keypair`

| - | **IP Address of MATLAB Web App Server Administrator in CIDR Notation** | Specify the IP address of the administrator using CIDR notation. The administrator can remotely connect to the EC2 instance that hosts MATLAB Web App Server and administer it. The IP address can be a single IP address or a range of IP addresses. The format for this parameter is IP Address/Mask.

Example: `x.x.x.x/32`

**NOTE:** Restricting access to the server using an IP address is not a form of authentication. MATLAB Web App Server supports authentication using LDAP and OIDC. For details, see [Authentication](https://www.mathworks.com/help/webappserver/ug/authentication.html).

| - | **Do You Want to Use the Same IP Address Range to Access the MATLAB Web App Server Apps Home Page?**| Select, **Yes** or **No**. - | **IP Addresses Allowed to Access MATLAB Web App Server Apps Home Page** | Complete this parameter only if you selected **No** for the previous parameter. Specify the range of IP addresses that can access the MATLAB Web App Server apps home page in CIDR notation. The format for this parameter is IP Address/Mask.

*Example*: `x.x.x.x/24`

| - | **ARN of SSL Certificate** | Specify the Amazon Resource Name (ARN) of the SSL certificate you uploaded to the AWS Certificate Manager. The ARN facilitates connecting to the apps home page using an HTTPS connection.

*Example*: arn:aws:acm:us-east-1:012345678910:certificate/666abcd6-ab6c-6ab6-a666-a666666bcd66

To retrieve an ARN:

For more information, see [Create Self-signed Certificate](#create-self-signed-certificate) and [Upload Self-signed Certificate to AWS Certificate Manager](#upload-self-signed-certificate-to-aws-certificate-manager). - | **EC2 Instance Type** | Choose the AWS EC2 instance type to use for the server. All AWS instance types are supported. For more information, see [Amazon EC2 Instance Types](https://aws.amazon.com/ec2/instance-types/).

*Example*: `m5.xlarge`

| - | **Operating System** | Choose between Windows (Windows Server) and Linux (Ubuntu). | + | **IP Address of MATLAB Web App Server Administrator in CIDR Notation** | Specify the IP address of the administrator using CIDR notation. The administrator can remotely connect to the EC2 instance that hosts MATLAB Web App Server and administer it. The IP address can be a single IP address or a range of IP addresses. The format for this parameter is IP Address/Mask.

Example: `x.x.x.x/32`

**NOTE:** Restricting access to the server using an IP address is not a form of authentication. MATLAB Web App Server supports authentication using LDAP or OIDC. For details, see [Step 8](#step-8-configure-user-authentication).

| + | **Do You Want to Use the Same IP Address Range to Access the MATLAB Web App Server Apps Home Page?**| Select, **Yes** or **No**. + | **IP Addresses Allowed to Access MATLAB Web App Server Apps Home Page** | Complete this parameter only if you selected **No** for the previous parameter. Specify the range of IP addresses that can access the MATLAB Web App Server apps home page in CIDR notation. The format for this parameter is IP Address/Mask.

*Example*: `x.x.x.x/24`

| + | **EC2 Instance Type** | Choose the AWS EC2 instance type to use for the server. All AWS instance types are supported. For more information, see [Amazon EC2 Instance Types](https://aws.amazon.com/ec2/instance-types/).

*Example*: `m6a.large`

| + | **Operating System** | Choose between Windows (Windows Server) and Linux (Ubuntu).

**NOTE:** The admin portal interface and Keycloak authentication are only available on Linux.| ||**Settings for Network License Manager**| | **Password for Network License Manager** | Specify a password for the network license manager. Use this password to log in to the network license manager after the stack has been successfully created.

Deploying MATLAB Web App Server automatically deploys a network license manager.

| | **Confirm Password** | Reenter the password to log in to the network license manager. | @@ -48,42 +49,35 @@ The AWS Management Console opens in your web browser. >**Note**: If you are deploying to a new VPC, skip this step. -To deploy MATLAB Web App Server onto an existing VPC, specify these additional parameters. +To deploy MATLAB Web App Server onto an existing VPC, select the **Existing VPC** template in [Step 1](#step-1-launch-template). In addition to the parameters listed in Step 2, you must also specify the following parameters. | Parameter | Value | |----------------------------------|--------------------------------------------------------------------------------| | Existing VPC ID | ID of your existing VPC. | -| IP address range of existing VPC | IP address range from the existing VPC. To find the IP address range:
  1. Log in to the AWS Console.
  2. Navigate to the VPC dashboard and select your VPC.
  3. Click the **CIDR blocks** tab.
  4. The **IPv4 CIDR Blocks** gives the IP address range.
| -|Assign Public IP to EC2 Instance Hosting MATLAB Web App Server | Specify whether the deployed EC2 instance must use a public IP address. If you select "No", you must provide a private subnet in the parameter **Subnet for MATLAB Web App Server**.

**Note:** Even after you select "No", your MATLAB Web App Server apps home page is still accessible over the Internet. However, you cannot remotely connect to the EC2 instance hosting the server from outside the VPC.

| -| Subnet for MATLAB Web App Server | Specify the ID of a public or private subnet within the existing VPC that will host the server. | -| Public Subnet 1 ID | ID of an existing public subnet to host server resources. This subnet can be the same as the one hosting MATLAB Web App Server, as long as the subnet hosting the server is public. If the subnet hosting the server is private, then this subnet must be a different public subnet. | -| Public Subnet 2 ID | ID of an existing public subnet to host server resources. This subnet must be different from Public Subnet 1.| - -You will also need to open the following ports in your VPC: - -| Port | Description | -|------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `443` | Required for communicating with MATLAB Web App Server apps home page. | -| `8000`, `9988` | Required for communication between MATLAB Web App Server controllers and AWS services. These ports do not need to be open to the internet. | -| `27000` | Required for communication between the network license manager and MATLAB Web App Server. | -| `3389`, `22` | Required for Remote Desktop and Secure Connection functionality. This can be used for troubleshooting and debugging MATLAB Web App Server. | +|Assign Public IP to EC2 Instance Hosting MATLAB Web App Server | Specify whether to assign a public IP address to the deployed EC2 instance. If you are deploying a new network license manager, the network license manager will be assigned the same type of IP address as the EC2 instance.

**Note:** You may need to configure an endpoint or public NAT gateway to ensure MATLAB Web App Server can access AWS services. For details, see [Ensure connectivity in an existing VPC](#ensure-connectivity-in-an-existing-vpc).

| +| Subnet for MATLAB Web App Server | Specify the ID of a public or private subnet within the existing VPC that will host the server. If you selected `Yes` for the previous parameter for assigning a public IP, choose a public subnet. Otherwise, choose a private subnet. | +| Public Subnet 1 | ID of an existing public subnet to host server resources. This subnet can be the same as the one hosting MATLAB Web App Server, as long as the subnet hosting the server is public. If the subnet hosting the server is private, then this subnet must be a different public subnet. | + ||**Settings for Network License Manager**| + | Port and IP Address of Existing Network License Manager | Optional parameter: Specify the port number and private DNS name or private IP address of the network license manager that has already been deployed to the existing VPC. Specify it in the format port@privateDNSname, for example, `27000@ip-172-30-1-89.ec2.internal` or `27000@172.30.1.89`. By default, the license manager uses port 27000. Leave this parameter blank if you are deploying a new network license manager. | + | Security Group of Existing Network License Manager | Optional parameter: Specify the security group of the network license manager that has already been deployed to the existing VPC. If you have an existing license manager and leave this parameter blank, you must add the security group manually using the instructions in [Use an existing network license manager in an existing VPC](#use-an-existing-network-license-manager-in-an-existing-vpc). Leave this parameter blank if you are deploying a new network license manager.| ### Use an existing network license manager in an existing VPC -If you want to use an existing network license manager: +For complete instructions on deploying the Network License Manager for MATLAB reference architecture, see [Network License Manager for MATLAB on Amazon Web Services](https://github.com/mathworks-ref-arch/license-manager-for-matlab-on-aws). + +If you want to use an existing network license manager in an existing VPC: - Choose `No` for the *Deploy Network License Manager* step of the deployment. - Specify the IP address of the existing network license manager in the `IP Address of Existing Network License Manager` step of the deployment. You can find the private IP address in the *Outputs* tab of the existing network license manager deployment. - -To use an existing network license manager, you must add the security group of the server VMs to the security group of the license manager. -1. In the AWS management console, select the stack where the network license manager is deployed. -1. In the *Stack details* for your stack, click **Resources**. +#### Add security group of the server VMs to the security group of the license manager +If you did not supply a security group in the parameter **Security Group of Existing Network License Manager** at the time of deployment, you must add the security group of the server VMs to the security group of the license manager. +1. In the AWS management console, select the external security group that is nested in the network license manager stack you created. If it is not present in the stack list, ensure the **View nested** option is enabled.

For example: `mluser-nlm-MWSecurityGroupExternal-8JJX66NUZDD8`

+1. In the *Stack details* for the external security group stack, click **Resources**. 1. Look for the **Logical ID** named ```SecurityGroup``` and click the corresponding URL listed under **Physical ID**. This will take you to the security group details. -1. Click the **Inbound Rules** tab, then click **Edit Inbound Rules**. +1. Select the security group. Click the **Inbound Rules** tab, then click **Edit Inbound Rules**. 1. Click **Add Rule**. 1. In the **Type** dropdown, select ```All TCP```. 1. In the **Source**, search and add the ```matlab-webapp-server-sg``` security group. 1. Click **Save Rules**. - ## Step 4. Create Stack Review or edit your stack details. You must select the acknowledgements to create IAM resources. Otherwise, the deployment produces a `Requires capabilities : [CAPABILITY_IAM]` error and fails to create resources. For more information about IAM, see [IAM FAQ](https://aws.amazon.com/iam/faqs). @@ -92,21 +86,71 @@ Click the **Create** button. The CloudFormation service starts creating resource ## Step 5. Upload License File 1. Click **Outputs** in the *Stack details* for your stack. -1. Look for the key named `MATLABWebAppServerLicenseManager` and click the corresponding URL listed under value. This will take you to Network License Manager for MATLAB Dashboard login page. +1. Look for the key named `MATLABWebAppServerLicenseManager` and click the corresponding URL listed under value. This opens the Network License Manager for MATLAB Dashboard login page. 1. The username is **manager**. For the password, enter the password you entered for the **Password for Network License Manager** parameter while creating the stack in [Step 2](#step-2-configure-the-stack). 1. Follow the instructions on the home page of the network license manager to upload your MATLAB Web App Server license. ->**Note:** MATLAB Web App Server automatically starts after succesfully uploading a valid license file. +>**Note:** MATLAB Web App Server automatically starts after successfully uploading a valid license file. + +## Step 6. Connect and Log In to the Admin Portal (Linux Server Only) +> **Note:** The Internet Explorer web browser is not supported for accessing the admin portal. + +The MATLAB Web App Server admin portal provides a web-based interface to configure and manage the server instance on the cloud. The admin portal is only available for servers deployed on Ubuntu Linux. For more details on accessing and using the admin portal, see [Manage MATLAB Web App Server on AWS Using Admin Portal](https://www.mathworks.com/help/webappserver/ug/manage-matlab-web-app-server-using-admin-portal-on-aws-reference-architecture.html). + +1. In the Stack details for your stack, click the **Outputs** tab. +1. Look for the key named `AdminPortalUrl` and click the corresponding URL listed under **value**. This opens the admin portal Overview page. +1. The first time you access the admin portal, log in using the following username and password: + + + + +
Usernamematlab-webapps-admin
Passwordmatlab-webapps-admin
+1. After logging in for the first time, you are prompted to change the password. + + +## Step 7. Open the MATLAB Web App Server Apps Home Page +The MATLAB Web App Server home page provides a web-based interface to deploy and manage web applications. To access the apps home page: -## Step 6. Open the MATLAB Web App Server Apps Home Page 1. In the *Stack details* for your stack, click the **Outputs** tab. 1. Look for the key named `MATLABWebAppServerAppsHomePage` and click the corresponding URL listed under value. This opens the apps home page. +1. On Linux servers, user authentication to the server home page is enabled by default through [Keycloak](https://www.keycloak.org/docs/latest/server_admin/index.html). + + There are three pre-configured user accounts in Keycloak that you can use to log in to the server home page: `matlab-webapps-admin`, `matlab-webapps-author`, and `matlab-webapps-user`. After you log in, you see the `SampleApps` category, which is created by default and contains a sample web app. -You are now ready to use MATLAB Web App Server on AWS. + |User account |      Permissions |       Group Membership | + |-|-|-| + |`matlab-webapps-admin` | | | + |`matlab-webapps-author` | | | + |`matlab-webapps-user` | | | + + The default password for each user is the same as the username. For instance, the default password for the author account is `matlab-webapps-author`. After you log in to a user account for the first time, you are prompted to change the password. To run applications on MATLAB Web App Server, you need to create web apps using MATLAB Compiler. For details, see [Web Apps](https://www.mathworks.com/help/compiler/webapps/create-and-deploy-a-web-app.html) in the MATLAB Compiler product documentation. +## Step 8. Configure User Authentication + +### Linux Server +On Linux servers, user authentication to the admin portal and MATLAB Web App Server home page is administered by default through [Keycloak](https://www.keycloak.org/docs/latest/server_admin/index.html). Keycloak is a cloud native solution that provides authentication, authorization, and user management for applications and services. You can configure authentication using your identity provider with Keycloak or directly using LDAP or OIDC. + +After you deploy MATLAB Web App Server, log in to the Keycloak administration console to configure user authentication and change the default admin credentials. +1. In the Stack details for your stack, click the **Outputs** tab. +1. Look for the key named `KeycloakConsoleUrl` and click the corresponding URL listed under **value**. This opens the Keycloak admin console. +1. Log into the Keycloak portal using the following username and password: + + + + +
Usernamekeycloak-admin
Passwordkeycloak-admin
+ +There are three pre-configured user accounts and three groups in Keycloak. Each user account belongs to one or more groups, and each group grants specific permissions on the MATLAB Web App Server. For example, the `matlab-webapps-admin` user inherits the ability to upload and delete apps from the **MATLAB Web App Server Authors** group. Add or modify groups and users as needed through the Keycloak admin console. For more information, see [Managing users](https://www.keycloak.org/docs/latest/server_admin/index.html#assembly-managing-users_server_administration_guide) in the Keycloak documentation. + +To allow an existing group to access additional resources on the MATLAB Web App Server, use the **App Management/Access Control** page of the admin portal. For example, you could assign all members of the **MATLAB Web App Server Users** group execute permissions for all apps at the root level. + + +### Windows Server +On Windows servers, user authentication to the MATLAB Web App Server home page is not enabled by default. To enable OIDC authentication, see [Configure OIDC Authentication](#configure-oidc-authentication).

+ # Common Tasks ## Upload Web Apps to AWS S3 Bucket @@ -115,8 +159,8 @@ To run applications on MATLAB Web App Server, you need to create web apps using 1. Look for the key named `MATLABWebAppServerAppsS3Bucket`, and click the corresponding URL listed under value. 1. In the S3 console, click **apps**. 1. Click **Upload** > **Add Files** to select and upload web apps (`.ctf` files). ->**NOTE 1:** If you enable OIDC authentication, you can upload web apps from the apps home page. Any apps you upload via the apps home page are not synchornized with S3 bucket. To enable OIDC authentication, see [Configure OIDC Authentication](#configure-oidc-authentication). ->**NOTE 2:** Only folders created within the APPS root level folder are supported. Subfolders within those folders are not supported. +>**NOTE 1:** If you enable user authentication, you can upload web apps from the apps home page. To configure authentication, see [Step 8](#step-8-configure-user-authentication).

+>**NOTE 2:** Only folders created within the `apps` root-level folder are supported. Subfolders within those folders are not supported. ## Get Password to EC2 Instance Hosting MATLAB Web App Server 1. In the AWS management console, select the stack you deployed. @@ -135,7 +179,7 @@ To run applications on MATLAB Web App Server, you need to create web apps using 1. Click the value under Instance ID to view the instance summary. 1. Click the **Connect** button at the top. 1. In the *Connect to instance* dialog, click the **RDP client** tab. -1. Click the **Download remote desktop file** button to download a .rdp file. +1. Click the **Download remote desktop file** button to download the .rdp file. 1. Use the .rdp file to remotely connect to EC2 instance using the following credentials: * Username: Administrator * Password: The decrypted password. For details, see [Get Password to EC2 Instance](#get-password-to-ec2-instance-hosting-matlab-web-app-server). @@ -158,6 +202,9 @@ To run applications on MATLAB Web App Server, you need to create web apps using | Policy-Based Access | `webapps_acc_ctl.json` | [Policy-Based Access Documentation](https://www.mathworks.com/help/webappserver/ug/policy-based-access.html) | ## Configure OIDC Authentication +On Linux servers, configure authentication using Keycloak in [Step 8](#step-8-configure-user-authentication). You can also use the following steps to configure OIDC authentication manually. + +On Windows servers, use the following instructions. 1. Connect to the EC2 instance hosting MATLAB Web App Server. For details, see: * [Connect to EC2 Instance Hosting MATLAB Web App Server Using Remote Desktop](#connect-to-ec2-instance-hosting-matlab-web-app-server-using-remote-desktop) * [Connect to EC2 Instance Hosting MATLAB Web App Server Using SSH](#connect-to-ec2-instance-hosting-matlab-web-app-server-using-ssh). @@ -169,28 +216,14 @@ To run applications on MATLAB Web App Server, you need to create web apps using * Look for the key named `MATLABWebAppServerOIDCRedirectUrl` and copy the corresponding URL listed under value. * Use this URL in the `webapps_authn.json` file. -## Create Self-signed Certificate -For information on creating a self-signed certificate, see [Create and Sign an X509 Certificate](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/configuring-https-ssl.html). - -## Upload Self-signed Certificate to AWS Certificate Manager - -1. Open the AWS Certificate Manager. -2. Click the button at the top of the page to **Import a certificate**. -3. Copy the contents of the `.crt` file containing the certificate into the field labeled **Certificate body**. -4. Copy the contents of the `.pem` file containing the private key into the field labeled **Certificate private key**. -5. Leave the field labeled **Certificate chain** blank. -6. Click the button labeled **Review and import**. -7. Review the settings and click the **Import** button. -8. Copy the value of the Amazon Resource Name (ARN) field from the **Details** section of the certificate. - -The ARN value that you copied should be pasted into the **ARN of SSL Certificate** parameter of the template in [Step 2](#step-2-configure-the-stack). - ## View Logs Logs are available in AWS CloudWatch. 1. In the AWS management console, select the stack you deployed. 1. In the *Stack details* for your stack, click the **Outputs** tab. 1. To view logs related to the cloud console and the MATLAB Web App Server workers, look for the key named `MATLABWebAppServerLogGroup`, and click the corresponding URL listed under value. +On Linux servers, you can also download logs directly from the admin portal. For details, see [Step 6](#step-6-connect-and-log-in-to-the-admin-portal-linux-server-only). + ## Get Network License Manager MAC Address 1. In the AWS management console, select the stack that you deployed. 1. In the *Stack details* for your stack, click the **Outputs** tab. @@ -211,8 +244,73 @@ To delete the stack: 3. Go to the CloudFormation page and select the stack you created. 3. Click **Delete**. +## Ensure connectivity in an existing VPC +If you are deploying MATLAB Web App Server to an existing VPC, you must open the following ports in your VPC: + +| Port | Description | +|------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `443` | Required for communicating with MATLAB Web App Server apps home page. | +| `8000`, `9988` | Required for communication between MATLAB Web App Server controllers and AWS services. These ports do not need to be open to the internet. | +| `27000` | Required for communication between the network license manager and MATLAB Web App Server. | +| `3389`, `22` | Required for Remote Desktop and Secure Connection functionality. This can be used for troubleshooting and debugging MATLAB Web App Server. | + + In addition, in order for Lambda functions present in the MATLAB Web App Server reference architecture to work in an existing VPC, you must configure connectivity based on whether you choose a public or a private subnet for your deployment. + +### Use public NAT gateway when deploying to a private subnet +If you are using an existing VPC and deploying in a private subnet, consider using a public NAT gateway associated with a public subnet. This setup allows the Lambda functions to communicate with AWS services. For more information, see [NAT gateways](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html) in the AWS documentation. + +### Create interface VPC endpoint when deploying to a public subnet +If you are using an existing VPC and deploying in a public subnet, then you must add an interface VPC endpoint to one of the public subnets in the VPC. You can check if such an endpoint already exists by navigating to the AWS Console, selecting **Endpoints**, and filtering by VPC ID for the VPC you are using for deployment. If no such endpoint is present, follow these steps: + +1. Click **Create endpoint**. +1. Provide a name tag for the endpoint. +1. Select **Type** as `AWS services`. +1. In **Services**, select `com.amazonaws..ec2`. The region should match your VPC region. For instance, if your region is US East (N. Virginia), select `com.amazonaws.us-east-1.ec2`. +1. In **Network settings**, select the VPC you are using for deployment. +1. Ensure that **Enable DNS** is checked to facilitate DNS resolution within the VPC. +1. In **Subnets**, select the public subnet where the endpoint will be configured. +1. In **Security groups**, select the security group to associate with the endpoint network interface. Ensure the following settings are applied to the security group:

+ + + + + + + + + + + + + + + + + +
Inbound rules
TypeAll TCP
ProtocolTCP
Port Range0 - 65535
SourceVPC CIDR block range — allows internal VPC communication on any TCP port
+ + + + + + + + + + + + + + + + + +
Outbound rules
TypeAll traffic
ProtocolAll
Port RangeAll
DestinationAnywhere (0.0.0.0/0) — allows all outbound traffic to any destination
+ +For detailed information on creating endpoints, see [Access an AWS service using an interface VPC endpoint](https://docs.aws.amazon.com/vpc/latest/privatelink/create-interface-endpoint.html). + # Enhancement Request Provide suggestions for additional features or capabilities using the following link: https://www.mathworks.com/solutions/cloud.html # Technical Support -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). +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). \ No newline at end of file diff --git a/releases/R2022b/templates.json b/releases/R2025b/templates.json similarity index 53% rename from releases/R2022b/templates.json rename to releases/R2025b/templates.json index 0824dfd..f445be2 100644 --- a/releases/R2022b/templates.json +++ b/releases/R2025b/templates.json @@ -1,7 +1,7 @@ { - "VPCStack.yml": "https://matlab-web-app-server-templates.s3.amazonaws.com/r2022b_refarch/VPCStack.yml", - "LambdaFunctionStack.yml": "https://matlab-web-app-server-templates.s3.amazonaws.com/r2022b_refarch/LambdaFunctionStack.yml", - "CommonResourcesStack.yml": "https://matlab-web-app-server-templates.s3.amazonaws.com/r2022b_refarch/CommonResourcesStack.yml", - "WebAppServer_existing.yml": "https://matlab-web-app-server-templates.s3.amazonaws.com/r2022b_refarch/WebAppServer_existing.yml", - "WebAppServer_new.yml": "https://matlab-web-app-server-templates.s3.amazonaws.com/r2022b_refarch/WebAppServer_new.yml" + "VPCStack.yml": "https://matlab-web-app-server-templates.s3.amazonaws.com/r2025b_refarch/VPCStack.yml", + "LambdaFunctionStack.yml": "https://matlab-web-app-server-templates.s3.amazonaws.com/r2025b_refarch/LambdaFunctionStack.yml", + "CommonResourcesStack.yml": "https://matlab-web-app-server-templates.s3.amazonaws.com/r2025b_refarch/CommonResourcesStack.yml", + "WebAppServer_existing.yml": "https://matlab-web-app-server-templates.s3.amazonaws.com/r2025b_refarch/WebAppServer_existing.yml", + "WebAppServer_new.yml": "https://matlab-web-app-server-templates.s3.amazonaws.com/r2025b_refarch/WebAppServer_new.yml" } \ No newline at end of file diff --git a/releases/release-notes.md b/releases/release-notes.md index 357a836..a572ae2 100644 --- a/releases/release-notes.md +++ b/releases/release-notes.md @@ -1,5 +1,8 @@ ## Release Notes for MATLAB Web App Server on Amazon Web Services +### R2025b +- You can now deploy MATLAB Web App Server R2025b using the Amazon Web Services reference architecture. + ### R2025a - You can now deploy MATLAB Web App Server R2025a using the Amazon Web Services reference architecture. - You can now manage MATLAB Web App Server Linux instances using the MATLAB Web App Server Admin Portal, which is a web-based interface to edit server settings, configure access control for web applications, and view server logs. For more details, see [Connect and Log In to the Admin Portal](R2025a/README.md#step-6-connect-and-log-in-to-the-admin-portal-linux-server-only).