Supertstream Engine Deployment using custom resource limits

Superstream Engine is deployed with default resource limits designed to ensure high performance. In some cases, these configured limits may not be sufficient. To address potential performance bottlenecks, you can adjust the resource limits using the procedure outlined below.

Specify desired resource limits in the custom_values.yaml .

To adjust the resource limits for the Superstream Engine Data Plane, add the following configuration:

superstreamEngine:  
  resources:
    limits:
      cpu: '8'
      memory: 8Gi

To modify the resource limits for NATS, add the following configuration:

nats: 
  container:
    merge:
      resources:
        limits:
          memory: 8Gi

Example: Final Configuration File

Below is an example of a complete configuration file (custom_values.yaml) after setting custom resource limits:

############################################################
# GLOBAL configuration for Superstream Engine
############################################################
global:
  engineName: ""                    # Define the superstream engine name within 32 characters, excluding '.', and using only lowercase letters, numbers, '-', and '_'.
  superstreamAccountId: ""          # Provide the account ID associated with the deployment, which could be used for identifying resources or configurations tied to a specific account.
  superstreamActivationToken: ""    # Enter the activation token required for services or resources that need an initial token for activation or authentication.
  skipLocalAuthentication: true
############################################################
# NATS config
############################################################
# NATS HA Deployment. Default "true"
nats:
  config:
    cluster:
      enabled: true
# NATS storageClass configuration. Default is blank "".
    jetstream:
      fileStore:
        pvc:
          storageClassName: ""
  container:
    merge:
      resources:
        limits:
          memory: 8Gi
superstreamEngine:  
  resources:
    limits:
      cpu: '8'
      memory: 8Gi

Deploy

Once you have updated the custom_values.yaml file with your desired resource limits, deploy the Superstream Engine using Helm:

helm repo add superstream https://k8s.superstream.ai/ --force-update && helm install superstream superstream/superstream -f custom_values.yaml --create-namespace --namespace superstream --wait