values.schema.json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "affinity": {
      "description": "Affinity rules for pod scheduling. When unset and replicaCount \u003e 1, a soft pod anti-affinity on kubernetes.io/hostname is automatically applied. Set to a non-empty affinity object to override.",
      "required": [],
      "title": "affinity",
      "type": "object"
    },
    "extraArgs": {
      "description": "Extra command-line arguments for Typesense server (e.g., [\"--filter-by-max-ops=200\"])",
      "items": {
        "required": []
      },
      "required": [],
      "title": "extraArgs"
    },
    "extraEnv": {
      "description": "Extra environment variables for the Typesense container",
      "items": {
        "required": []
      },
      "required": [],
      "title": "extraEnv"
    },
    "fullnameOverride": {
      "default": "",
      "description": "Override the full name of the release (optional)",
      "required": [],
      "title": "fullnameOverride"
    },
    "gateway": {
      "properties": {
        "enabled": {
          "default": "false",
          "description": "Enable or disable Gateway API for the application",
          "required": [],
          "title": "enabled"
        },
        "hosts": {
          "description": "List of hostnames the Gateway will route traffic for",
          "items": {
            "required": []
          },
          "required": [],
          "title": "hosts"
        },
        "parentRefs": {
          "description": "Configuration controlling which Gateway(s) this HTTPRoute attaches to.",
          "properties": {
            "default": {
              "description": "The default Gateway reference this HTTPRoute attaches to.",
              "properties": {
                "name": {
                  "description": "Name of the Gateway.",
                  "type": "string"
                },
                "namespace": {
                  "default": "istio-system",
                  "description": "Namespace of the Gateway.",
                  "type": "string"
                }
              },
              "required": [
                "name"
              ],
              "type": "object"
            },
            "extras": {
              "description": "Additional Gateway references.",
              "items": {
                "properties": {
                  "name": {
                    "description": "Name of the Gateway.",
                    "type": "string"
                  },
                  "namespace": {
                    "default": "istio-system",
                    "description": "Namespace of the Gateway.",
                    "type": "string"
                  }
                },
                "required": [
                  "name"
                ],
                "type": "object"
              },
              "type": "array"
            }
          },
          "required": [],
          "title": "parentRefs",
          "type": "object"
        },
        "prefix": {
          "default": "/",
          "description": "The URL path prefix for the application",
          "required": [],
          "title": "prefix"
        }
      },
      "required": [],
      "title": "gateway",
      "type": "object"
    },
    "global": {
      "description": "Global values are values that can be accessed from any chart or subchart by exactly the same name.",
      "required": [],
      "title": "global",
      "type": "object"
    },
    "image": {
      "properties": {
        "pullPolicy": {
          "default": "IfNotPresent",
          "description": "Image pull policy (Always, IfNotPresent, etc.)",
          "enum": [
            "Always",
            "IfNotPresent",
            "Never"
          ],
          "required": [],
          "title": "pullPolicy"
        },
        "repository": {
          "default": "typesense/typesense",
          "description": "Docker image repository for Typesense",
          "required": [],
          "title": "repository"
        },
        "tag": {
          "default": "",
          "description": "Overrides the image tag. If left empty, it uses the appVersion from Chart.yaml",
          "required": [],
          "title": "tag"
        }
      },
      "required": [],
      "title": "image",
      "type": "object"
    },
    "ingress": {
      "properties": {
        "annotations": {
          "description": "Extra annotations to add to the Ingress resource",
          "required": [],
          "title": "annotations"
        },
        "className": {
          "default": "nginx",
          "description": "The name of the Ingress class to use (e.g., nginx)",
          "required": [],
          "title": "className"
        },
        "enabled": {
          "default": "false",
          "description": "Enable or disable Ingress for the application",
          "required": [],
          "title": "enabled"
        },
        "hosts": {
          "description": "List of hostnames the Ingress will route traffic for",
          "items": {
            "required": []
          },
          "required": [],
          "title": "hosts"
        },
        "prefix": {
          "default": "/",
          "description": "The URL path prefix for the application",
          "required": [],
          "title": "prefix"
        }
      },
      "required": [],
      "title": "ingress",
      "type": "object"
    },
    "livenessProbe": {
      "properties": {
        "failureThreshold": {
          "default": "2",
          "description": "Number of failed liveness checks before restarting the container",
          "required": [],
          "title": "failureThreshold"
        },
        "httpGet": {
          "description": "HTTP GET path and port to check Typesense health for liveness",
          "properties": {
            "path": {
              "default": "/health",
              "title": "path",
              "type": "string"
            },
            "port": {
              "default": "http",
              "title": "port",
              "type": "string"
            }
          },
          "required": [
            "path",
            "port"
          ],
          "title": "httpGet"
        },
        "periodSeconds": {
          "default": "10",
          "description": "Period (in seconds) to perform the liveness check",
          "required": [],
          "title": "periodSeconds"
        }
      },
      "required": [],
      "title": "livenessProbe",
      "type": "object"
    },
    "metrics": {
      "properties": {
        "enabled": {
          "default": false,
          "description": "Enable Prometheus metrics sidecar",
          "title": "enabled",
          "type": "boolean"
        },
        "image": {
          "properties": {
            "pullPolicy": {
              "default": "IfNotPresent",
              "description": "Image pull policy for metrics exporter",
              "required": [],
              "title": "pullPolicy"
            },
            "repository": {
              "default": "imatefx/typesense-prometheus-exporter",
              "description": "Metrics exporter image repository",
              "required": [],
              "title": "repository"
            },
            "tag": {
              "default": "v0.1.5",
              "description": "Metrics exporter image tag",
              "required": [],
              "title": "tag"
            }
          },
          "required": [],
          "title": "image",
          "type": "object"
        },
        "port": {
          "default": 8888,
          "description": "Port for Prometheus metrics endpoint",
          "maximum": 65535,
          "minimum": 1,
          "title": "port",
          "type": "integer"
        },
        "resources": {
          "description": "Resource requests and limits for the metrics sidecar",
          "required": [],
          "title": "resources"
        },
        "serviceMonitor": {
          "properties": {
            "enabled": {
              "default": "false",
              "description": "Enable ServiceMonitor for Prometheus scraping",
              "required": [],
              "title": "enabled"
            },
            "interval": {
              "default": "30s",
              "description": "Scrape interval",
              "required": [],
              "title": "interval"
            },
            "labels": {
              "description": "Additional labels for ServiceMonitor",
              "required": [],
              "title": "labels"
            }
          },
          "required": [],
          "title": "serviceMonitor",
          "type": "object"
        }
      },
      "required": [
        "image",
        "serviceMonitor"
      ],
      "title": "metrics",
      "type": "object"
    },
    "nameOverride": {
      "default": "",
      "description": "Override the name of the release (optional)",
      "required": [],
      "title": "nameOverride"
    },
    "nodeSelector": {
      "description": "Node selector to schedule pods on specific nodes (optional)",
      "required": [],
      "title": "nodeSelector"
    },
    "pdb": {
      "properties": {
        "enabled": {
          "default": true,
          "description": "Enable PodDisruptionBudget for Typesense StatefulSet. Automatically skipped when replicaCount is 1.",
          "title": "enabled",
          "type": "boolean"
        },
        "maxUnavailable": {
          "anyOf": [
            {
              "minimum": 0,
              "type": "integer"
            },
            {
              "enum": [
                "auto"
              ],
              "required": []
            }
          ],
          "default": "auto",
          "description": "Maximum number of pods that can be unavailable during disruption. Set to \"auto\" (default) to auto-calculate as floor(replicaCount/2), preserving Raft quorum. Set to 0 to block all voluntary disruptions. Any positive value is used directly and must not exceed floor(replicaCount/2).",
          "required": [],
          "title": "maxUnavailable"
        }
      },
      "required": [],
      "title": "pdb",
      "type": "object"
    },
    "podAnnotations": {
      "description": "Additional annotations to add to the Typesense pod(s)",
      "required": [],
      "title": "podAnnotations"
    },
    "podLabels": {
      "description": "Additional labels to add to the Typesense pod(s)",
      "required": [],
      "title": "podLabels"
    },
    "podSecurityContext": {
      "properties": {
        "fsGroup": {
          "default": "2000",
          "description": "Group ID for the filesystem of the Typesense container",
          "required": [],
          "title": "fsGroup"
        },
        "runAsGroup": {
          "default": "3000",
          "description": "Group ID for running the Typesense process",
          "required": [],
          "title": "runAsGroup"
        },
        "runAsNonRoot": {
          "default": "true",
          "description": "Ensure the container does not run as root",
          "required": [],
          "title": "runAsNonRoot"
        },
        "runAsUser": {
          "default": "10000",
          "description": "User ID for running the Typesense process",
          "required": [],
          "title": "runAsUser"
        }
      },
      "required": [],
      "title": "podSecurityContext",
      "type": "object"
    },
    "readinessProbe": {
      "properties": {
        "failureThreshold": {
          "default": "3",
          "description": "Number of failed readiness checks before marking the pod as unready",
          "required": [],
          "title": "failureThreshold"
        },
        "httpGet": {
          "description": "HTTP GET path and port to check Typesense readiness",
          "properties": {
            "path": {
              "default": "/health",
              "title": "path",
              "type": "string"
            },
            "port": {
              "default": "http",
              "title": "port",
              "type": "string"
            }
          },
          "required": [
            "path",
            "port"
          ],
          "title": "httpGet"
        },
        "periodSeconds": {
          "default": "5",
          "description": "Period (in seconds) to perform the readiness check",
          "required": [],
          "title": "periodSeconds"
        }
      },
      "required": [],
      "title": "readinessProbe",
      "type": "object"
    },
    "replicaCount": {
      "default": 3,
      "description": "Number of replicas for the Typesense deployment",
      "minimum": 1,
      "title": "replicaCount",
      "type": "integer"
    },
    "resources": {
      "description": "Resource requests and limits for the Typesense container",
      "required": [],
      "title": "resources"
    },
    "secrets": {
      "properties": {
        "externalSecret": {
          "properties": {
            "enabled": {
              "default": "false",
              "description": "Enable or disable ExternalSecret creation (requires external-secrets operator)",
              "required": [],
              "title": "enabled"
            },
            "extractKey": {
              "default": "",
              "description": "The key path to extract secrets from",
              "required": [],
              "title": "extractKey"
            },
            "storeName": {
              "default": "",
              "description": "The name of the ClusterSecretStore or SecretStore to use",
              "required": [],
              "title": "storeName"
            }
          },
          "required": [],
          "title": "externalSecret",
          "type": "object"
        },
        "optional": {
          "default": true,
          "description": "Whether the secretRef in envFrom is optional (pods start even if secret is missing)",
          "title": "optional",
          "type": "boolean"
        },
        "secretName": {
          "default": "",
          "description": "Name of the Kubernetes Secret to mount via envFrom. Defaults to \u003cfullname\u003e-secret",
          "required": [],
          "title": "secretName"
        }
      },
      "required": [
        "externalSecret"
      ],
      "title": "secrets",
      "type": "object"
    },
    "securityContext": {
      "properties": {
        "allowPrivilegeEscalation": {
          "default": "false",
          "description": "Prevent privilege escalation",
          "required": [],
          "title": "allowPrivilegeEscalation"
        },
        "capabilities": {
          "description": "Drop all Linux capabilities",
          "properties": {
            "drop": {
              "items": {
                "anyOf": [
                  {
                    "type": "string"
                  }
                ],
                "required": []
              },
              "title": "drop",
              "type": "array"
            }
          },
          "required": [
            "drop"
          ],
          "title": "capabilities"
        },
        "readOnlyRootFilesystem": {
          "default": "true",
          "description": "Read-only root filesystem (Typesense only writes to data PVC)",
          "required": [],
          "title": "readOnlyRootFilesystem"
        }
      },
      "required": [],
      "title": "securityContext",
      "type": "object"
    },
    "service": {
      "properties": {
        "port": {
          "default": 8108,
          "description": "Port that the Typesense service will listen on",
          "maximum": 65535,
          "minimum": 1,
          "title": "port",
          "type": "integer"
        },
        "type": {
          "default": "ClusterIP",
          "description": "Kubernetes service type (ClusterIP, NodePort, LoadBalancer)",
          "required": [],
          "title": "type"
        }
      },
      "required": [],
      "title": "service",
      "type": "object"
    },
    "serviceAccount": {
      "properties": {
        "annotations": {
          "description": "Annotations to add to the ServiceAccount (e.g., for IRSA)",
          "required": [],
          "title": "annotations"
        },
        "automountServiceAccountToken": {
          "default": "false",
          "description": "Whether to automount the ServiceAccount token",
          "required": [],
          "title": "automountServiceAccountToken"
        },
        "create": {
          "default": true,
          "description": "Whether to create a ServiceAccount",
          "title": "create",
          "type": "boolean"
        },
        "name": {
          "default": "",
          "description": "Name of the ServiceAccount. Defaults to fullname",
          "required": [],
          "title": "name"
        }
      },
      "required": [],
      "title": "serviceAccount",
      "type": "object"
    },
    "startupProbe": {
      "properties": {
        "failureThreshold": {
          "default": "10",
          "description": "Number of failed startup checks before marking the container as unhealthy",
          "required": [],
          "title": "failureThreshold"
        },
        "httpGet": {
          "description": "HTTP GET path and port to check Typesense health for startup",
          "properties": {
            "path": {
              "default": "/health",
              "title": "path",
              "type": "string"
            },
            "port": {
              "default": "http",
              "title": "port",
              "type": "string"
            }
          },
          "required": [
            "path",
            "port"
          ],
          "title": "httpGet"
        },
        "periodSeconds": {
          "default": "10",
          "description": "Period (in seconds) to perform the startup check",
          "required": [],
          "title": "periodSeconds"
        }
      },
      "required": [],
      "title": "startupProbe",
      "type": "object"
    },
    "storage": {
      "properties": {
        "className": {
          "default": "",
          "description": "Storage class to use for Persistent Volume Claims (PVC)",
          "required": [],
          "title": "className"
        },
        "size": {
          "default": "10Gi",
          "description": "Size of the persistent storage volume (e.g., 10Gi)",
          "title": "size",
          "type": "string"
        }
      },
      "required": [],
      "title": "storage",
      "type": "object"
    },
    "terminationGracePeriodSeconds": {
      "default": "300",
      "description": "Termination grace period in seconds. Typesense recommends 300s to allow graceful shutdown.",
      "required": [],
      "title": "terminationGracePeriodSeconds"
    },
    "tolerations": {
      "description": "Tolerations for pod scheduling",
      "items": {
        "required": []
      },
      "required": [],
      "title": "tolerations"
    },
    "topologySpreadConstraints": {
      "description": "Topology spread constraints for pod distribution across nodes/zones",
      "items": {
        "required": []
      },
      "required": [],
      "title": "topologySpreadConstraints"
    },
    "typesense": {
      "properties": {
        "analytics": {
          "properties": {
            "enabled": {
              "default": "false",
              "description": "Enable aggregated search query analytics",
              "required": [],
              "title": "enabled"
            },
            "flushInterval": {
              "default": "",
              "description": "How often analytics are persisted to disk in seconds. Unset uses Typesense default (3600)",
              "minimum": 1,
              "required": [],
              "title": "flushInterval",
              "type": [
                "integer",
                "null"
              ]
            }
          },
          "required": [],
          "title": "analytics",
          "type": "object"
        },
        "cache": {
          "properties": {
            "numEntries": {
              "default": "",
              "description": "LRU cache size for search responses. Unset uses Typesense default (1000)",
              "minimum": 0,
              "required": [],
              "title": "numEntries",
              "type": [
                "integer",
                "null"
              ]
            }
          },
          "required": [],
          "title": "cache",
          "type": "object"
        },
        "cors": {
          "properties": {
            "domains": {
              "description": "List of allowed origins (no trailing slashes)",
              "items": {
                "required": []
              },
              "required": [],
              "title": "domains"
            },
            "enabled": {
              "default": "false",
              "description": "Enable CORS for browser/JS access",
              "required": [],
              "title": "enabled"
            }
          },
          "required": [],
          "title": "cors",
          "type": "object"
        },
        "health": {
          "properties": {
            "readLag": {
              "default": "",
              "description": "Update lag threshold before rejecting reads. Unset uses Typesense default (1000)",
              "minimum": 0,
              "required": [],
              "title": "readLag",
              "type": [
                "integer",
                "null"
              ]
            },
            "writeLag": {
              "default": "",
              "description": "Update lag threshold before rejecting writes. Unset uses Typesense default (500)",
              "minimum": 0,
              "required": [],
              "title": "writeLag",
              "type": [
                "integer",
                "null"
              ]
            }
          },
          "required": [],
          "title": "health",
          "type": "object"
        },
        "limits": {
          "properties": {
            "diskUsedMaxPercentage": {
              "default": "",
              "description": "Reject writes above this disk usage percentage. Unset uses Typesense default (100)",
              "maximum": 100,
              "minimum": 0,
              "required": [],
              "title": "diskUsedMaxPercentage",
              "type": [
                "integer",
                "null"
              ]
            },
            "memoryUsedMaxPercentage": {
              "default": "",
              "description": "Reject writes above this memory usage percentage. Unset uses Typesense default (100)",
              "maximum": 100,
              "minimum": 0,
              "required": [],
              "title": "memoryUsedMaxPercentage",
              "type": [
                "integer",
                "null"
              ]
            }
          },
          "required": [],
          "title": "limits",
          "type": "object"
        },
        "logging": {
          "properties": {
            "enableSearchLogging": {
              "default": "false",
              "description": "Log search request payloads",
              "required": [],
              "title": "enableSearchLogging"
            },
            "slowRequestsTimeMs": {
              "default": "",
              "description": "Threshold in ms for slow request logging (-1 disables). Unset uses Typesense default (-1)",
              "required": [],
              "title": "slowRequestsTimeMs",
              "type": [
                "integer",
                "null"
              ]
            }
          },
          "required": [],
          "title": "logging",
          "type": "object"
        },
        "snapshots": {
          "properties": {
            "intervalSeconds": {
              "default": "",
              "description": "Replication log snapshot frequency in seconds. Unset uses Typesense default (3600)",
              "minimum": 1,
              "required": [],
              "title": "intervalSeconds",
              "type": [
                "integer",
                "null"
              ]
            }
          },
          "required": [],
          "title": "snapshots",
          "type": "object"
        },
        "threadPoolSize": {
          "default": "",
          "description": "Concurrent request handler threads. Unset uses Typesense default (NUM_CORES * 8)",
          "minimum": 1,
          "required": [],
          "title": "threadPoolSize",
          "type": [
            "integer",
            "null"
          ]
        }
      },
      "required": [
        "cors",
        "cache",
        "analytics",
        "snapshots",
        "limits",
        "health",
        "logging"
      ],
      "title": "typesense",
      "type": "object"
    },
    "updateStrategy": {
      "description": "StatefulSet update strategy configuration. When type is RollingUpdate, rollingUpdate.maxUnavailable is required. When type is OnDelete, rollingUpdate is optional and ignored.",
      "if": {
        "properties": {
          "type": {
            "const": "RollingUpdate",
            "required": []
          }
        },
        "required": []
      },
      "properties": {
        "rollingUpdate": {
          "description": "Rolling update configuration. Only used when type is RollingUpdate.",
          "properties": {
            "maxUnavailable": {
              "anyOf": [
                {
                  "minimum": 0,
                  "type": "integer"
                },
                {
                  "enum": [
                    "auto"
                  ],
                  "required": []
                }
              ],
              "description": "Maximum number of pods unavailable during a rolling update. Set to \"auto\" to auto-calculate as floor(replicaCount/2). Set to 0 to block all voluntary pod replacements. Must not exceed floor(replicaCount/2).",
              "required": []
            }
          },
          "required": [],
          "type": "object"
        },
        "type": {
          "description": "StatefulSet update strategy type. Use RollingUpdate for zero-downtime upgrades or OnDelete for manual pod-by-pod control.",
          "enum": [
            "RollingUpdate",
            "OnDelete"
          ],
          "required": []
        }
      },
      "required": [
        "type"
      ],
      "then": {
        "properties": {
          "rollingUpdate": {
            "required": [
              "maxUnavailable"
            ]
          }
        },
        "required": [
          "rollingUpdate"
        ]
      },
      "title": "updateStrategy",
      "type": "object"
    }
  },
  "required": [
    "image",
    "podSecurityContext",
    "securityContext",
    "service",
    "ingress",
    "gateway",
    "livenessProbe",
    "startupProbe",
    "readinessProbe",
    "pdb",
    "storage",
    "secrets",
    "typesense",
    "serviceAccount",
    "metrics"
  ],
  "type": "object"
}