Grafbase API

This reference documents the Kubernetes configuration options for the Grafbase API, which provides a GraphQL interface to the Grafbase platform.

Global configuration values for the chart.

Defaults:

global: # Enable or disable the Zitadel sidecar zitadel: enabled: false

Kubernetes ReplicationController Docs

Defaults:

replicaCount: 1

Kubernetes Image Pull Policy

Defaults:

image: # Controls container image pulls pullPolicy: IfNotPresent # Container image repository repository: docker.grafbase.com/proxy/enterprise-platform/ghcr.io/grafbase/api # Image tag to use tag: latest

Kubernetes Service Account Docs

Defaults:

serviceAccount: # Controls service account creation create: true # Annotations to add to the service account annotations: {} # Service account name. Uses default if not set name: ''

Kubernetes Service Types

Defaults:

service: type: ClusterIP port: 80 targetPort: 8080 name: http nodePort: 30080

Kubernetes Ingress Docs

Defaults:

ingress: # Enables ingress enabled: false # Ingress class className: 'nginx' hosts: # Hostnames and paths for the ingress - host: api.local paths: - path: /* pathType: ImplementationSpecific backend: serviceName: api servicePort: 8080

Kubernetes Horizontal Pod Autoscaler

Defaults:

autoscaling: # Enables autoscaling enabled: true # Minimum number of replicas minReplicas: 1 # Maximum number of replicas maxReplicas: 2 # Target CPU utilization percentage targetCPUUtilizationPercentage: 50

Configuration values for the cluster configmap.

Defaults:

configmap: # Enables configmap creation and env var mounting enabled: true name: '' values: # The port the service will expose PORT_WEB: 8080 PORT_WORKER: 8080 # Logging level configuration RUST_LOG: info # Name of the AWS S3 bucket AWS_S3_BUCKET_NAME: grafbase # Connection URL for ClickHouse database CLICKHOUSE_URL: clickhouse://grafbase-enterprise-platform-clickhouse:9000 # ClickHouse database name CLICKHOUSE_DB: analytics # ClickHouse username CLICKHOUSE_USER: grafbase # ClickHouse connection timeout in seconds CLICKHOUSE_TIMEOUT_SECS: 5 # Maximum number of PostgreSQL connections PG_MAX_CONNECTIONS: 10 # Minimum number of PostgreSQL connections PG_MIN_CONNECTIONS: 1 # PostgreSQL connection timeout in seconds PG_CONNECT_TIMEOUT_SECS: 1 # PostgreSQL connection acquisition timeout in seconds PG_ACQUIRE_TIMEOUT_SECS: 1 # PostgreSQL idle connection timeout in seconds PG_IDLE_TIMEOUT_SECS: 300 # Maximum lifetime of PostgreSQL connections in seconds PG_CONNECTION_MAX_LIFETIME_SECS: 3600 # URL for runtime assets storage RUNTIME_ASSETS_STORAGE: http://grafbase-enterprise-platform-minio:9000 # Enable or disable tracing ENABLE_TRACING: true

Configuration values for the cluster secret.

Defaults:

secrets: # Enables secret creation and env var mounting enabled: true name: '' values: # The secret key for symmetric encryption SYMMETRIC_ENCRYPTION_SECRET: thisisaverysecurekeythatis32byte # Password for ClickHouse database access CLICKHOUSE_PASSWORD: grafbase # PostgreSQL database connection string PG_CONNECTION_STRING: postgresql://postgres:grafbase@grafbase-enterprise-platform-postgresql:5432/grafbase

Configuration values for the API background worker worker.

Defaults:

worker: replicaCount: 1 port: 8080 resources: {}