In the matlab-pool.yaml file, in the flexlm field, update the servers subfield with the license server port and address information. Use the format port@address. For example:

flexlm:
  servers: "27000@lm.acme.com"

To list multiple servers, separate the server information with a colon. For example:

flexlm:
  servers: "27000@lm1.acme.com:27000@lm2.acme.com"

In the matlab-pool.yaml file, update the replicaCount field.

replicaCount: 2

The default count of 2 means that two MATLAB pods are ready for assignment. For example, suppose two users log in at the same time. Each pod assigned to them contains a MATLAB instance that is ready to use within seconds of logging in. If two more users log in at the same time, their logins are delayed until two new pods can start up.

The maximum number of active users that can log in at one time is limited to the number of MATLAB licenses. The total number of MATLAB instances that can be assigned is limited to the number of licenses available and the hardware configured for the MATLAB Pool.

If the server is unable to assign a MATLAB pod to a user, then the user receives a message that no MATLAB instances are available at that time and to try logging in later.

In the matlab-pool.yaml file, update the displayName field. For example:

poolConfig:
  displayName: "R2024a"

This field accepts numbers, letters, dashes (-), underscores (_), and periods (.). For example: "R2024a_4-CPU_16-GB".

After the server establishes a MATLAB session, the display name appears as the title of the browser tab in this format:

MATLAB Online – R2024a

In the networkPolicy field of the matlab-pool.yaml file, uncomment the additionalAllowedPorts and additionalEgress sections and specify the additional ports and egress rules. For example:

networkPolicy:
  enabled: true
  additionalAllowedPorts:
    - port: 1433
      protocol: "TCP"
    - port: 1433
      protocol: "UDP"
  additionalEgress:
    - to:
      - podSelector:
          matchLabels:
            name: "myapp-api"
            app: "myapp"

In the matlab-pool.yaml file, update the mountType field to one of the mounting options described in Set MATLAB Installation Source.

In the matlab-pool.yaml file, define storage profiles for each resource available to users in separate storage fields, as described in Configure File Storage for Users in MATLAB Online Server.

In the matlab-pool.yaml file, update the resourceQuota field, as described in Configure MATLAB Hardware Resources.

In the matlab-pool.yaml file, in the resourceDefinition section, update these fields. Units are in minutes.

resourceDefinition: 
  maxLifetimeMinutes: 240
  defaultLifetimeMinutes: 120
  maxInactivityTimeoutMinutes: 30
  defaultInactivityTimeoutMinutes: 15

For more details, see Configure MATLAB Session Settings.

In the matlab-pool.yaml file, in the resourceDefinition section:

Use this sample matlab-pool.yaml code and update the field values for your MATLAB pod.

resourceDefinition:
  ownerMetadata:
    podLabels:
      - name: "username"
        value: "${subject.subjectId}"
      - name: "environment"
        value: "prod"
    podAnnotations:
      - name: "username"
        value: "${subject.subjectId}"
    env:
      - name: "MOS_USERNAME"
        value: "${subject.subjectId}"
      - name: "environment"
        value: "prod"

The ${subject.subjectId} format enables the authnz service to dynamically populate the user metadata when that user signs in. For more details about how placeholders work, see Placeholders.