Skip to content

Commit ce6950a

Browse files
authored
Add Quick Start instructions to readme (#30)
* Add Quick Start instructions to readme * Update README.md
1 parent 2ff6515 commit ce6950a

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,34 @@ Before starting, you need the following:
3333

3434
If you do not have a license, please contact your MathWorks representative [here](https://www.mathworks.com/company/aboutus/contact_us/contact_sales.html) or [request a trial license](https://www.mathworks.com/campaigns/products/trials.html?prodcode=PR).
3535

36+
## Quick Start
37+
The Quick Start option is recommended for the following cases:
38+
* You are deploying MATLAB Production Server R2024b or newer
39+
* You don't require significant changes to the Helm chart
40+
* You are not running MATLAB Production server on Kubernetes as part of a CI/CD workflow
41+
For CI/CD workflows, we recommend that you cache docker images in your private container registry. For more complex workflows, use the [Deployment Steps](#Deployment-Steps)
42+
43+
The Quick Start option only requires you to download a single file, rather than cloning the full GitHub repository. For more complex workflows, use the [Deployment Steps](#Deployment-Steps)
44+
45+
1. Download the `values-overrides.yaml` file containing configuration options that apply across all release deployments from the MATLAB Production Server on Kubernetes GitHub repository. You can use the cURL command below or click the "Download Raw File" icon.
46+
```
47+
curl -O https://raw.githubusercontent.com/mathworks-ref-arch/matlab-production-server-on-kubernetes/main/values-overrides.yaml
48+
```
49+
50+
2. Complete the steps in [Provide Mapping for Deployable Archives](#Provide-Mapping-for-Deployable-Archives).
51+
52+
3. Before installing the chart, first set parameters that state your agreement to the MathWorks cloud reference architecture license and specify the address of the network license manager. In the top-level values-overrides.yaml file, set these parameters:
53+
54+
To accept the license terms, set global > agreeToLicense to "yes".
55+
To specify the address of the license server, set global > licenseServer using the format port_number@host.
56+
57+
Next, install the Helm chart for MATLAB Production Server by using the following `helm install` command:
58+
59+
```
60+
helm install -f <path/to/values-overrides.yaml> [-n <k8s-namespace>] --generate-name oci://containers.mathworks.com/matlab-prodserver-k8s --version 1.1.0
61+
```
62+
4. After the deployment is complete, upload the MATLAB Production Server deployable archive to your network file server or Azure file share. All users must have read permission to the deployable archive.
63+
3664
## Deployment Steps
3765
### Clone GitHub® Repository that Contains Helm Chart
3866
The MATLAB Production Server on Kubernetes GitHub repository contains Helm charts that reference Ubuntu-based Docker container images for MATLAB Production Server deployment.

0 commit comments

Comments
 (0)