Skip to content

compass-web

Version: 1.0.0 Type: application AppVersion: 0.3.1

A production-ready Helm chart for MongoDB Compass Web - MongoDB database management and administration tool

Installing the Chart

helm repo add pandia https://charts.pandia.io
helm repo update
helm install my-compass-web pandia/compass-web

Values

Search Values

Press Ctrl+K or Cmd+K to search, or use the interactive values search.

Key Type Default Description
Compass Web Configuration
mongoUri string "" MongoDB connection string(s) (required)
existingSecret string "" Name of an existing secret containing MongoDB connection string
existingSecretKey string "mongoUri" Key in existingSecret that contains the MongoDB URI
appName string "Compass Web" Application name displayed in the UI
orgId string "default-org-id" Organization ID associated with the connection
projectId string "default-project-id" Project ID associated with the connection
clusterId string "default-cluster-id" Cluster ID associated with the connection
basicAuth string `nil` Basic HTTP authentication configuration
enabled bool false Enable basic authentication
username string "" Username for basic auth
password string "" Password for basic auth
existingSecret string "" Name of existing secret containing basic auth credentials
existingSecretUsernameKey string "username" Key in existingSecret for username
existingSecretPasswordKey string "password" Key in existingSecret for password
genAI string `nil` GenAI features configuration (requires OpenAI API key)
enabled bool false Enable GenAI features
apiKey string "" OpenAI API key
existingSecret string "" Name of existing secret containing OpenAI API key
existingSecretKey string "apiKey" Key in existingSecret for API key
model string "gpt-4o-mini" OpenAI model to use
enableSampleDocuments bool false Enable uploading sample documents to GenAI service
querySystemPrompt string "" Custom system prompt for query generation
aggregationSystemPrompt string "" Custom system prompt for aggregation generation
config object {} Additional Compass Web configuration as environment variables
Controller Configuration
type string deployment Controller type (deployment or statefulset)
replicas int 1 Number of replicas
strategy string `nil` Deployment update strategy
updateStrategy string `nil` StatefulSet update strategy (only used if controller.type is statefulset)
podManagementPolicy string OrderedReady Pod management policy (only used if controller.type is statefulset)
command list [] Command override for the main container
args list [] Args override for the main container
workingDir string "" Working directory for the main container
terminationGracePeriodSeconds int 30 Termination grace period in seconds
lifecycle object {} Lifecycle hooks for the main container
Diagnostic Mode
enabled bool false Enable diagnostic mode (disables probes, overrides command)
command string `nil` Command override for diagnostic mode
args string `nil` Args override for diagnostic mode
Global Parameters
namespaceOverride string `.Release.Namespace` Override the namespace for all resources
nameOverride string "" Override the name of the chart
fullnameOverride string "" Override the full name of the chart
additionalLabels object {} Additional labels to add to all resources
additionalAnnotations object {} Additional annotations to add to all resources
Health Probes
livenessProbe string `nil` Liveness probe configuration
readinessProbe string `nil` Readiness probe configuration
startupProbe string `nil` Startup probe configuration
High Availability
enabled bool false Enable PodDisruptionBudget
minAvailable int 1 Minimum number of pods that must be available
maxUnavailable string "" Maximum number of pods that can be unavailable
hpa string `nil` Horizontal Pod Autoscaler configuration
enabled bool false Enable HorizontalPodAutoscaler
minReplicas int 1 Minimum number of replicas
maxReplicas int 3 Maximum number of replicas
targetCPUUtilizationPercentage int 80 Target CPU utilization percentage
targetMemoryUtilizationPercentage int 80 Target memory utilization percentage
customMetrics list [] Custom metrics for autoscaling
Image Configuration
repository string haohanyang/compass-web MongoDB Compass Web Docker image repository
tag string Chart appVersion MongoDB Compass Web Docker image tag
pullPolicy string IfNotPresent Image pull policy
digest string "" Image digest (overrides tag if set)
imagePullSecrets list [] Image pull secrets for private registries
Ingress Configuration
enabled bool false Enable ingress
className string "" Ingress class name
annotations object {} Ingress annotations
hosts list [] Ingress hosts configuration
tls list [] Ingress TLS configuration
Monitoring
enabled bool false Enable ServiceMonitor for Prometheus Operator
namespace string "" Namespace for the ServiceMonitor (defaults to the release namespace)
interval string 30s Interval at which metrics should be scraped
scrapeTimeout string 10s Timeout for scraping metrics
labels object {} Additional labels for the ServiceMonitor
annotations object {} Additional annotations for the ServiceMonitor
metricRelabelings list [] Metric relabelings
relabelings list [] Relabelings
enabled bool false Enable PrometheusRule for alerting
namespace string "" Namespace for the PrometheusRule (defaults to the release namespace)
labels object {} Additional labels for the PrometheusRule
rules list [] Alert rules
Network Policy
enabled bool false Enable network policy
policyTypes string `nil` Policy types
ingress list [] Ingress rules
egress string `nil` Egress rules
Persistence Configuration
enabled bool false Enable persistent storage for Compass Web data
storageClassName string Default storage class Storage class name
accessMode string ReadWriteOnce Access mode for the persistent volume
size string 1Gi Size of the persistent volume
existingClaim string "" Name of an existing PVC to use
annotations object {} Annotations for the PVC
Pod Configuration
podAnnotations object {} Pod annotations
podLabels object {} Pod labels
nodeSelector object {} Node selector for pod assignment
tolerations list [] Tolerations for pod assignment
affinity object {} Affinity for pod assignment
priorityClassName string "" Priority class name for the pod
topologySpreadConstraints list [] Topology spread constraints for pod distribution
dnsPolicy string ClusterFirst DNS policy
dnsConfig object {} DNS config
hostAliases list [] Host aliases
runtimeClassName string "" Runtime class name
initContainers list [] Init containers to run before the main container
extraContainers list [] Extra sidecar containers
extraEnv list [] Extra environment variables
extraEnvFrom list [] Extra environment variables from ConfigMaps or Secrets
extraVolumes list [] Extra volumes
extraVolumeMounts list [] Extra volume mounts
RBAC Configuration
create bool true Create a service account
name string "" Service account name (generated if not set and create is true)
annotations object {} Service account annotations
create bool true Create RBAC resources
rules list [] Additional RBAC rules
Resources
resources string `nil` Resource limits and requests
Security Context
podSecurityContext string `nil` Pod security context
securityContext string `nil` Container security context
Service Configuration
type string ClusterIP Service type
port int 8080 Service port
targetPort int 8080 Service target port (container port)
nodePort string "" Node port (only used if type is NodePort)
loadBalancerIP string "" Load balancer IP (only used if type is LoadBalancer)
loadBalancerSourceRanges list [] Load balancer source ranges (only used if type is LoadBalancer)
externalTrafficPolicy string "" External traffic policy (only used if type is LoadBalancer or NodePort)
clusterIP string "" Cluster IP (set to None for headless service)
sessionAffinity string None Session affinity
sessionAffinityConfig object {} Session affinity config
annotations object {} Service annotations
labels object {} Service labels

Autogenerated from chart metadata using helm-docs