values.yaml 31 KB
Newer Older
1
# SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
2
3
4
5
6
7
8
9
10
11
12
13
14
15
# SPDX-License-Identifier: Apache-2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# Used to generate top-level secrets (overridden by custom-values.yaml)
16

17
18
19
20
21
22
23
global:
  etcd:
    # -- Whether this chart should install the bundled etcd subchart.
    # When true, deploys etcd and auto-configures the operator with its address.
    # When false, etcd is not deployed. Use dynamo-operator.etcdAddr to point at an external instance if you are bringing your own etcd.
    install: false

24
25
26
# Subcharts configuration

# Dynamo operator configuration
27
dynamo-operator:
28
  # -- Whether to enable the Dynamo Kubernetes operator deployment
29
  enabled: true
30
31

  # -- NATS server address for operator communication (leave empty to use the bundled NATS chart). Format: "nats://hostname:port"
32
  natsAddr: ""
33

34
  # -- etcd server address for an external etcd instance. Only needed when using external etcd without the bundled subchart. Format: "http://hostname:port" or "https://hostname:port"
35
  etcdAddr: ""
36

Biswa Panda's avatar
Biswa Panda committed
37
38
39
40
  nats:
    # -- Whether the NATS is enabled
    enabled: true

41
42
43
  # -- URL for the Model Express server if not deployed by this helm chart. This is ignored if Model Express server is installed by this helm chart (global.model-express.enabled is true).
  modelExpressURL: ""
  # -- Namespace access controls for the operator
44
  namespaceRestriction:
45
46
    # -- Whether to restrict operator to specific namespaces. By default, the operator will run with cluster-wide permissions. Only 1 instance of the operator should be deployed in the cluster. If you want to deploy multiple operator instances, you can set this to true and specify the target namespace (by default, the target namespace is the helm release namespace).
    enabled: false
47
    # -- Target namespace for operator deployment (leave empty for current namespace)
48
    targetNamespace:
49
50
51
52
53
54
55
    # Namespace scope marker lease configuration (used to prevent conflicts when running both cluster-wide and namespace-restricted operators)
    lease:
      # Duration before the namespace scope marker lease expires if not renewed (namespace-restricted mode only). When a namespace-restricted operator is running, it creates a lease in its namespace. The cluster-wide operator detects this lease and excludes that namespace from processing. If the namespace operator stops renewing the lease (e.g., crashes), the lease expires and the cluster-wide operator automatically resumes processing that namespace.
      duration: 30s
      # Interval for renewing the namespace scope marker lease (namespace-restricted mode only). The namespace-restricted operator renews its lease at this interval to signal it's still running.
      renewInterval: 10s

56
57
58
59
60
61
62
  # -- GPU discovery configuration (only applies when namespaceRestriction.enabled=true)
  gpuDiscovery:
    # -- Whether to provision a ClusterRole for the namespace-scoped operator to read GPU node labels.
    # When true (default), Helm creates a ClusterRole/ClusterRoleBinding granting node read access.
    # Set to false if your installer lacks ClusterRole creation permissions.
    enabled: true

63
64
  # -- The Dynamo discovery backend to use. Default is "kubernetes" for Kubernetes API service discovery. Set to "etcd" to use ETCD for discovery. --
  discoveryBackend: "kubernetes"
65
66

  # Controller manager configuration
67
  controllerManager:
68
    # -- Node tolerations for controller manager pods
69
    tolerations: []
70

71
    # -- Affinity for controller manager pods
72
    affinity: {}
73

74
75
76
77
78
79
80
    # Leader election configuration for cluster-wide coordination
    leaderElection:
      # -- Leader election ID for cluster-wide coordination. WARNING: All cluster-wide operators must use the SAME ID to prevent split-brain. Different IDs would allow multiple leaders simultaneously.
      id: ""  # If empty, defaults to: dynamo.nvidia.com (shared across all cluster-wide operators)
      # -- Namespace for leader election leases (only used in cluster-wide mode). If empty, defaults to kube-system for cluster-wide coordination. All cluster-wide operators should use the SAME namespace for proper leader election.
      namespace: ""

81
    manager:
82
      # Container image configuration for the operator manager
83
      image:
84
        # -- Official NVIDIA Dynamo operator image repository
85
        repository: "nvcr.io/nvidia/ai-dynamo/kubernetes-operator"
86
        # -- Image tag (leave empty to use chart default)
87
        tag: ""
88
        # -- Image pull policy - when to pull the image
89
        pullPolicy: IfNotPresent
90
91

      # Command line arguments for the operator manager
92
      args:
93
        # -- Health probe endpoint for Kubernetes health checks
94
        - --health-probe-bind-address=:8081
95
        # -- Metrics endpoint for Prometheus scraping (localhost only for security)
96
        - --metrics-bind-address=127.0.0.1:8080
97
98

  # -- Secrets for pulling private container images
99
  imagePullSecrets: []
100
101

  # Core Dynamo platform configuration
102
  dynamo:
103
    # -- How long to wait before forcefully terminating Grove instances
104
    groveTerminationDelay: 4h
105
106

    # Docker registry configuration for private repositories
107
    dockerRegistry:
108
      # -- Whether to use Kubernetes secrets for registry authentication
109
      useKubernetesSecret: false
110
      # -- Docker registry server URL
111
      server:
112
      # -- Registry username
113
      username:
114
      # -- Registry password (consider using existingSecretName instead)
115
      password:
116
      # -- Name of existing Kubernetes secret containing registry credentials
117
      existingSecretName:
118
      # -- Whether the registry uses HTTPS
119
      secure: true
120
121

    # Ingress configuration for external access
122
    ingress:
123
      # -- Whether to create ingress resources
124
      enabled: false
125
      # -- Ingress class name (e.g., "nginx", "traefik")
126
      className:
127
      # -- Secret name containing TLS certificates
128
      tlsSecretName: my-tls-secret
129
130

    # Istio service mesh configuration
131
    istio:
132
      # -- Whether to enable Istio integration
133
      enabled: false
134
      # -- Istio gateway name for routing
135
      gateway:
136
137

    # -- Host suffix for generated ingress hostnames
138
    ingressHostSuffix: ""
139
140

    # -- Whether VirtualServices should support HTTPS routing
141
    virtualServiceSupportsHTTPS: false
142

143
144
145
146
147
    # Metrics configuration
    metrics:
      # -- Endpoint that services can use to retrieve metrics. If set, dynamo operator will automatically inject the PROMETHEUS_ENDPOINT environment variable into services it manages. Users can override the value of the PROMETHEUS_ENDPOINT environment variable by modifying the corresponding deployment's environment variables
      prometheusEndpoint: ""

148
149
150
151
152
153
154
155
156
    # MPI Run configuration
    mpiRun:
      # -- Name of the secret containing the SSH key for MPI Run
      secretName: "mpi-run-ssh-secret"
      # SSH key generation configuration
      sshKeygen:
        # -- Whether to enable SSH key generation for MPI Run
        enabled: true

157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
  # Webhook configuration for admission control and validation
  webhook:
    # Certificate configuration for webhook TLS
    certificateSecret:
      # -- Name of the Kubernetes secret containing webhook TLS certificates. The secret must contain three keys: tls.crt (server certificate), tls.key (server private key), and ca.crt (Certificate Authority certificate).
      name: webhook-server-cert

      # -- Whether to manage the certificate secret externally. When false (default), certificates are automatically generated via Helm hooks during installation. When true, you must create the secret manually before installing the chart.
      external: false

    # -- Certificate validity duration in days for auto-generated certificates. Only used when certManager.enabled=false and certificateSecret.external=false. After this duration, certificates will expire and need to be regenerated.
    certificateValidity: 365

    # Container image for certificate generation and CA injection jobs
    # Only used when certManager.enabled=false and certificateSecret.external=false
    certGenerator:
      image:
        # -- Container image repository for certificate generation jobs. This image must contain both openssl and kubectl commands.
        repository: bitnami/kubectl
        # -- Container image tag for certificate generation jobs
        tag: latest
        # -- Image pull policy for certificate generation jobs
        pullPolicy: IfNotPresent

    # -- CA bundle (base64 encoded) for webhook validation. Only used when certificateSecret.external=true. For automatic certificate generation or cert-manager integration, leave this empty as it will be injected automatically.
    caBundle: ""

    # -- Webhook failure policy controls how Kubernetes handles requests when the webhook is unavailable. 'Fail' (recommended for production) rejects requests if the webhook cannot be reached, ensuring strict validation. 'Ignore' allows requests through if the webhook is unavailable, providing availability over validation guarantees.
    failurePolicy: Fail

    # -- Timeout in seconds for webhook validation calls. If the webhook doesn't respond within this time, the request will be handled according to the failurePolicy.
    timeoutSeconds: 10

    # Namespace selector for webhook scope control
    # -- Custom namespace selector for webhook validation. Use this to include or exclude specific namespaces from webhook validation. For CLUSTER-WIDE operators, you can exclude namespaces managed by namespace-restricted operators by using: matchExpressions: [{ key: "dynamo-operator", operator: "NotIn", values: ["namespace-restricted"] }]. For NAMESPACE-RESTRICTED operators, leave empty as it will be auto-configured to match only the operator's namespace.
    namespaceSelector: {}

    # cert-manager integration for automated certificate lifecycle management
    certManager:
      # -- Whether to use cert-manager for automatic certificate management. Requires cert-manager to be installed in the cluster. When enabled, cert-manager will automatically generate, renew, and rotate certificates, and the automatic certificate generation via Helm hooks will be disabled.
      enabled: false

      # Certificate configuration for cert-manager
      certificate:
        # -- Certificate duration for webhook certificates managed by cert-manager (e.g., "8760h" for 1 year). cert-manager will automatically renew the certificate before it expires.
        duration: "8760h"

        # -- Time before certificate expiration to trigger renewal (e.g., "360h" for 15 days). cert-manager will attempt to renew the certificate when this threshold is reached.
        renewBefore: "360h"

        # Root CA configuration for cert-manager
        rootCA:
          # -- Duration for the root CA certificate (e.g., "87600h" for 10 years). The root CA typically has a much longer lifetime than the leaf certificates it signs.
          duration: "87600h"

          # -- Time before root CA expiration to trigger renewal (e.g., "720h" for 30 days). Renewing a CA can be disruptive as all signed certificates must be reissued.
          renewBefore: "720h"

215
216
217
218
219
  # Checkpoint configuration for fast pod restore using CRIU/cuda-checkpoint
  # NOTE: The checkpoint infrastructure (PVC + DaemonSet) must be installed separately
  # using the chrek Helm chart in each namespace where checkpointing is needed.
  checkpoint:
    # -- Whether to enable checkpoint/restore functionality
220
    enabled: false
221

222
223
224
225
226
227
228
229
230
    # -- Image used for init containers in checkpoint jobs (e.g., signal file cleanup)
    initContainerImage: "busybox:latest"

    # -- Path written by worker when model is loaded and ready for checkpointing
    readyForCheckpointFilePath: "/tmp/ready-for-checkpoint"

    # -- Path written by restore-entrypoint after successful CRIU restore
    restoreMarkerFilePath: "/tmp/dynamo-restored"

231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
    # Storage configuration
    # These settings tell the operator where to find checkpoint storage
    # Must match the configuration in the chrek chart
    storage:
      # -- Storage backend type: pvc, s3, or oci
      type: pvc

      # -- Host path for signal files (communication between checkpoint pod and DaemonSet)
      signalHostPath: "/var/lib/chrek/signals"

      # PVC storage configuration (used when type=pvc)
      pvc:
        # -- Name of the PVC created by the chrek chart
        pvcName: "chrek-pvc"
        # -- Base path within the PVC for storing checkpoints
        basePath: "/checkpoints"

      # S3 storage configuration (used when type=s3)
      s3:
        # -- S3 URI in format: s3://[endpoint/]bucket/prefix
        uri: ""
        # -- Reference to a secret containing AWS credentials
        credentialsSecretRef: ""

      # OCI registry storage configuration (used when type=oci)
      oci:
        # -- OCI URI in format: oci://registry/repository
        uri: ""
        # -- Reference to a docker config secret for registry authentication
        credentialsSecretRef: ""

262
263
264
265
# Grove component - distributed inference orchestration
grove:
  # -- Whether to enable Grove for multi-node inference coordination, if enabled, the Grove operator will be deployed cluster-wide
  enabled: false
266
267
268
269
  # -- Node tolerations for Grove pods
  tolerations: []
  # -- Affinity for Grove pods
  affinity: {}
270
271
272
273
274

# Kai Scheduler component - advanced workload scheduling
kai-scheduler:
  # -- Whether to enable Kai Scheduler for intelligent resource allocation, if enabled, the Kai Scheduler operator will be deployed cluster-wide
  enabled: false
275
276
277
278
279
280
  # Global configuration for kai-scheduler (applies to all components including crd-upgrader)
  global:
    # -- Node tolerations for kai-scheduler pods
    tolerations: []
    # -- Affinity for kai-scheduler pods
    affinity: {}
281

282
283
# etcd configuration - distributed key-value store
# Installation is controlled by global.etcd.install above.
284
etcd:
285
  image:
286
    # -- following bitnami announcement for brownout - https://github.com/bitnami/charts/tree/main/bitnami/etcd#%EF%B8%8F-important-notice-upcoming-changes-to-the-bitnami-catalog, we need to use the legacy repository until we migrate to the new "secure" repository
287
    repository: bitnamilegacy/etcd
288
    tag: 3.5.18-debian-12-r5
289

290
  # Persistent storage configuration for etcd data
291
  persistence:
292
    # Whether to enable persistent storage (recommended for production)
293
294
295
    enabled: true
    # Use the cluster default storage-class or override with a named class
    storageClass: null
296
    # Size of persistent volume for etcd data
297
    size: 1Gi
298
299

  # Pre-upgrade job configuration
300
  preUpgradeJob:
301
    # Whether to run pre-upgrade validation jobs
302
    enabled: false
303
304

  # Number of etcd replicas (1 for single-node, 3+ for HA)
305
  replicaCount: 1
306
307
308

  # Authentication and authorization settings
  # Explicitly remove authentication for simplified internal communication
309
310
  auth:
    rbac:
311
      # Whether to create RBAC authentication (disabled for internal use)
312
313
      create: false

314
  # Health check configuration
315
  readinessProbe:
316
    # Whether to enable readiness probes (disabled to reduce startup complexity)
317
318
319
    enabled: false

  livenessProbe:
320
    # Whether to enable liveness probes (disabled to reduce startup complexity)
321
322
    enabled: false

323
324
325
326
327
328
  # Pod Disruption Budget configuration
  # Should be enabled for HA deployments with 3+ replicas
  pdb:
    # Whether to create a PodDisruptionBudget (disabled for single-node deployments)
    create: false

329
  # Node tolerations for etcd pods (allows scheduling on specific nodes)
330
331
  tolerations: []

332
333
334
  # Affinity for etcd pods
  affinity: {}

335
# NATS configuration - messaging system for operator communication
336
nats:
337
  # -- Whether to enable NATS deployment, disable if you want to use an external NATS instance. For complete configuration options, see: https://github.com/nats-io/k8s/tree/main/helm/charts/nats , all nats settings should be prefixed with "nats."
338
  enabled: true
339
340
341
342

  # TLS Certificate Authority configuration for secure communication
  # Reference a common CA Certificate or Bundle in all nats config `tls` blocks and nats-box contexts
  # Note: `tls.verify` still must be set in the appropriate nats config `tls` blocks to require mTLS
343
  tlsCA:
344
    # Whether to enable TLS CA configuration
345
346
    enabled: false

347
  # Core NATS server configuration
348
  config:
349
    # NATS clustering for high availability (multiple NATS servers)
350
    cluster:
351
      # Whether to enable NATS clustering (disabled for single-node setups)
352
353
      enabled: false

354
    # JetStream - persistent messaging and streaming capabilities
355
    jetstream:
356
      # Whether to enable JetStream (recommended for persistent messaging)
357
358
      enabled: true

359
      # File-based storage for JetStream streams and consumers
360
      fileStore:
361
        # Whether to enable file storage (persistent across restarts)
362
        enabled: true
363
        # Directory path for JetStream file storage
364
365
366
        dir: /data

        ############################################################
367
        # Persistent Volume Claim for JetStream file storage
368
369
        ############################################################
        pvc:
370
          # Whether to create a PVC for JetStream storage
371
          enabled: true
372
          # Size of the persistent volume for JetStream data
373
          size: 10Gi
374
          # Storage class name (leave empty for default)
375
376
          storageClassName:

377
          # Advanced PVC configuration (merge additional fields)
378
379
380
          # https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#persistentvolumeclaim-v1-core
          merge: {}
          patch: []
381
          # PVC name (defaults to "{{ include "nats.fullname" $ }}-js")
382
383
          name:

384
        # Maximum size for JetStream file storage (defaults to PVC size)
385
386
        maxSize:

387
      # Memory-based storage for JetStream (non-persistent)
388
      memoryStore:
389
        # Whether to enable memory storage (faster but not persistent)
390
391
        enabled: false

392
393
      # Advanced JetStream configuration
      # For options see: https://docs.nats.io/running-a-nats-service/configuration#jetstream
394
395
396
      merge: {}
      patch: []

397
    # Core NATS server settings
398
    nats:
399
      # Port for NATS client connections
400
      port: 4222
401
402

      # TLS configuration for encrypted connections
403
      tls:
404
        # Whether to enable TLS encryption
405
        enabled: false
406
407
        # Advanced TLS configuration
        # For options see: https://docs.nats.io/running-a-nats-service/configuration/securing_nats/tls
408
409
410
        merge: {}
        patch: []

411
    # Leaf nodes for creating NATS topologies and remote connections
412
    leafnodes:
413
      # Whether to enable leaf node connections
414
415
      enabled: false

416
    # WebSocket support for browser-based NATS clients
417
    websocket:
418
      # Whether to enable WebSocket protocol support
419
420
      enabled: false

421
    # MQTT protocol bridge for IoT device connectivity
422
    mqtt:
423
      # Whether to enable MQTT protocol support
424
425
      enabled: false

426
    # Gateway connections for multi-cluster NATS deployments
427
    gateway:
428
      # Whether to enable gateway connections
429
430
      enabled: false

431
    # HTTP monitoring endpoint for NATS server metrics
432
    monitor:
433
      # Whether to enable HTTP monitoring interface
434
      enabled: true
435
      # Port for monitoring HTTP endpoint
436
      port: 8222
437
438

      # TLS configuration for monitoring endpoint
439
      tls:
440
441
        # Whether to enable HTTPS for monitoring (requires config.nats.tls enabled)
        # When enabled, monitoring port will use HTTPS with the options from config.nats.tls
442
443
        enabled: false

444
    # Go pprof profiling endpoint for performance debugging
445
    profiling:
446
      # Whether to enable profiling endpoint (for debugging only)
447
      enabled: false
448
      # Port for profiling endpoint
449
450
      port: 65432

451
    # Account resolver for multi-tenant NATS deployments
452
    resolver:
453
      # Whether to enable account resolution (for advanced multi-tenancy)
454
455
      enabled: false

456
457
458
    # Server naming configuration
    # Adds a prefix to the server name, which defaults to the pod name
    # Helpful for ensuring server name is unique in a super cluster
459
460
    serverNamePrefix: ""

461
462
463
    # Advanced NATS configuration merging and patching
    # For complete options see: https://docs.nats.io/running-a-nats-service/configuration
    # Special rules apply:
464
465
466
467
468
    #  1. strings that start with << and end with >> will be unquoted
    #     use this for variables and numbers with units
    #  2. keys ending in $include will be switched to include directives
    #     keys are sorted alphabetically, use prefix before $includes to control includes ordering
    #     paths should be relative to /etc/nats-config/nats.conf
469
    # Example:
470
471
472
473
474
475
476
477
    #   merge:
    #     $include: ./my-config.conf
    #     zzz$include: ./my-config-last.conf
    #     server_name: nats
    #     authorization:
    #       token: << $TOKEN >>
    #     jetstream:
    #       max_memory_store: << 1GB >>
478
    merge:
479
480
481
      # 15MB to accommodate prompt embeddings: 10MB decoded → ~13.3MB base64-encoded + metadata
      # Also allows larger context: 256K tokens (int32 - 4 bytes each) = 1MB
      max_payload: 15728640
482
483
484
    patch: []

  ############################################################
485
  # NATS container configuration in StatefulSet
486
487
  ############################################################
  container:
488
    # NATS server container image configuration
489
    image:
490
      # Official NATS server repository
491
      repository: nats
492
      # NATS server version (Alpine-based for smaller size)
493
      tag: 2.10.21-alpine
494
      # Image pull policy (leave empty for chart default)
495
      pullPolicy:
496
      # Custom registry URL (leave empty for Docker Hub)
497
498
      registry:

499
500
    # Container port configuration
    # Note: Ports must also be enabled in the config section above
501
502
    # https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#containerport-v1-core
    ports:
503
      # Main NATS client connection port
504
      nats: {}
505
      # Leaf node connection port
506
      leafnodes: {}
507
      # WebSocket connection port
508
      websocket: {}
509
      # MQTT protocol port
510
      mqtt: {}
511
      # Cluster communication port
512
      cluster: {}
513
      # Gateway connection port
514
      gateway: {}
515
      # HTTP monitoring port
516
      monitor: {}
517
      # Go profiling port
518
519
      profiling: {}

520
521
522
    # Environment variables for the NATS container
    # Map with key as env var name, value can be string or map
    # Example:
523
524
525
526
527
528
529
530
531
    #   env:
    #     GOMEMLIMIT: 7GiB
    #     TOKEN:
    #       valueFrom:
    #         secretKeyRef:
    #           name: nats-auth
    #           key: token
    env: {}

532
    # Advanced container configuration merging and patching
533
534
535
536
537
    # https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#container-v1-core
    merge: {}
    patch: []

  ############################################################
538
  # Configuration reloader container for hot config updates
539
540
  ############################################################
  reloader:
541
    # Whether to enable the config reloader sidecar container
542
    enabled: true
543
544

    # Config reloader container image
545
    image:
546
      # Official NATS config reloader repository
547
      repository: natsio/nats-server-config-reloader
548
      # Config reloader version
549
      tag: 0.16.0
550
      # Image pull policy (leave empty for chart default)
551
      pullPolicy:
552
      # Custom registry URL (leave empty for Docker Hub)
553
554
      registry:

555
    # Environment variables for the reloader container
556
557
    env: {}

558
559
    # Volume mount prefixes from NATS container to share with reloader
    # All NATS container volume mounts with these prefixes will be mounted into the reloader
560
561
562
    natsVolumeMountPrefixes:
    - /etc/

563
    # Advanced reloader container configuration
564
565
566
567
568
    # https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#container-v1-core
    merge: {}
    patch: []

  ############################################################
569
  # Prometheus metrics exporter container (optional)
570
  ############################################################
571
  # Note: config.monitor must be enabled for this to work
572
  promExporter:
573
    # Whether to enable Prometheus metrics exporter sidecar
574
575
576
    enabled: false

  ############################################################
577
  # Kubernetes Service for NATS access
578
579
  ############################################################
  service:
580
    # Whether to create a Kubernetes Service for NATS
581
582
    enabled: true

583
584
585
    # Service port configuration
    # Additional boolean field 'enabled' controls whether port is exposed in the service
    # Note: Ports must also be enabled in the config section above
586
587
    # https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#serviceport-v1-core
    ports:
588
      # Main NATS client connection port
589
590
      nats:
        enabled: true
591
      # Leaf node connection port
592
593
      leafnodes:
        enabled: true
594
      # WebSocket connection port
595
596
      websocket:
        enabled: true
597
      # MQTT protocol port
598
599
      mqtt:
        enabled: true
600
      # Cluster communication port (typically internal only)
601
602
      cluster:
        enabled: false
603
      # Gateway connection port (typically internal only)
604
605
      gateway:
        enabled: false
606
      # HTTP monitoring port (typically internal only)
607
608
      monitor:
        enabled: false
609
      # Go profiling port (typically internal only)
610
611
612
      profiling:
        enabled: false

613
    # Advanced service configuration
614
615
616
    # https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#service-v1-core
    merge: {}
    patch: []
617
    # Service name (defaults to "{{ include "nats.fullname" $ }}")
618
619
620
    name:

  ############################################################
621
  # Advanced NATS Kubernetes resource configuration
622
623
  ############################################################

624
  # StatefulSet configuration for NATS server persistence
625
  statefulSet:
626
    # Advanced StatefulSet configuration merging and patching
627
628
629
    # https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#statefulset-v1-apps
    merge: {}
    patch: []
630
    # StatefulSet name (defaults to "{{ include "nats.fullname" $ }}")
631
632
    name:

633
  # Pod template configuration for NATS StatefulSet
634
  podTemplate:
635
636
    # Whether to add a hash of the ConfigMap as a pod annotation
    # This will cause the StatefulSet to roll when the ConfigMap is updated
637
638
    configChecksumAnnotation: true

639
640
641
642
643
644
645
    # Pod topology spread constraints for better distribution across nodes
    # Map of topologyKey: topologySpreadConstraint
    # labelSelector will be added automatically to match StatefulSet pods
    # Example:
    #   topologySpreadConstraints:
    #     kubernetes.io/hostname:
    #       maxSkew: 1
646
647
    topologySpreadConstraints: {}

648
    # Advanced pod template configuration
649
    # https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#pod-v1-core
650
651
    merge:
      spec:
652
        # Node tolerations for NATS pods (allows scheduling on specific nodes)
653
        tolerations: []
654
655
        # Affinity for NATS pods
        affinity: {}
656
657
    patch: []

658
  # Headless service for StatefulSet pod discovery
659
  headlessService:
660
    # Advanced headless service configuration
661
662
663
    # https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#service-v1-core
    merge: {}
    patch: []
664
    # Headless service name (defaults to "{{ include "nats.fullname" $ }}-headless")
665
666
    name:

667
  # ConfigMap for NATS server configuration
668
  configMap:
669
    # Advanced ConfigMap configuration
670
671
672
    # https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#configmap-v1-core
    merge: {}
    patch: []
673
    # ConfigMap name (defaults to "{{ include "nats.fullname" $ }}-config")
674
675
    name:

676
  # Pod Disruption Budget for controlled rolling updates
677
  podDisruptionBudget:
678
    # Whether to create a PodDisruptionBudget (recommended for production)
679
680
    enabled: true

681
  # Service Account for NATS server pods
682
  serviceAccount:
683
    # Whether to create and use a dedicated service account
684
685
686
    enabled: false

  ############################################################
687
688
  # NATS Box - CLI tools and debugging container
  # NATS Box provides CLI tools for interacting with NATS server
689
690
  ############################################################
  natsBox:
691
    # Whether to deploy NATS Box for CLI access and debugging
692
    enabled: false
693
694

    ############################################################
695
    # NATS client contexts for authentication and connection
696
697
    ############################################################
    contexts:
698
      # Default context configuration
699
      default:
700
        # Credentials-based authentication
701
        creds:
702
          # Inline credentials file contents (base64 encoded)
703
          contents:
704
          # Name of existing secret containing credentials file
705
          secretName:
706
          # Directory to mount credentials (defaults to /etc/nats-creds/<context-name>)
707
          dir:
708
          # Key name in secret for credentials file
709
          key: nats.creds
710
711

        # NKey-based authentication (public/private key pairs)
712
        nkey:
713
          # Inline NKey file contents (base64 encoded)
714
          contents:
715
          # Name of existing secret containing NKey file
716
          secretName:
717
          # Directory to mount NKey (defaults to /etc/nats-nkeys/<context-name>)
718
          dir:
719
          # Key name in secret for NKey file
720
          key: nats.nk
721
722

        # TLS client certificate authentication
723
        tls:
724
          # Name of existing secret containing TLS client certificates
725
          secretName:
726
          # Directory to mount certificates (defaults to /etc/nats-certs/<context-name>)
727
          dir:
728
          # Certificate file name in secret
729
          cert: tls.crt
730
          # Private key file name in secret
731
732
          key: tls.key

733
734
        # Advanced context configuration
        # For options see: https://docs.nats.io/using-nats/nats-tools/nats_cli#nats-contexts
735
736
737
        merge: {}
        patch: []

738
    # Name of context to select by default for NATS CLI operations
739
740
741
    defaultContextName: default

    ############################################################
742
    # NATS Box container configuration
743
744
    ############################################################
    container:
745
      # NATS Box container image
746
      image:
747
        # Official NATS Box repository with CLI tools
748
        repository: natsio/nats-box
749
        # NATS Box version
750
        tag: 0.14.5
751
        # Image pull policy (leave empty for chart default)
752
        pullPolicy:
753
        # Custom registry URL (leave empty for Docker Hub)
754
755
        registry:

756
      # Environment variables for NATS Box container
757
758
      env: {}

759
      # Advanced container configuration
760
761
762
      # https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#container-v1-core
      merge: {}
      patch: []
763
764

    # Service Account for NATS Box deployment
765
    serviceAccount:
766
      # Whether to create and use a dedicated service account for NATS Box
767
      enabled: false
768

769
    # Pod template configuration for NATS Box deployment
770
771
772
    podTemplate:
      merge:
        spec:
773
          # Node tolerations for NATS Box pods
774
          tolerations: []
775
776
          # Affinity for NATS Box pods
          affinity: {}
777
      patch: []