Helm Chart Reference
This document is auto-generated from the Helm chart's README.md. Please do not edit it directly.
A Helm chart for Castlecraft Architect application
Requirements
| Repository | Name | Version |
|---|---|---|
| https://charts.bitnami.com/bitnami | postgresql | 14.2.3 |
| https://charts.bitnami.com/bitnami | redis | 18.19.1 |
Values
| Key | Type | Default | Description |
|---|---|---|---|
| architect | object | {"config":{"authorizationEngine":"allow_all","frontendOidcEnabled":"false","gitBranchForComponents":"main","gitRepoUrlForComponents":"","litellm":{"apiBase":"","defaultModel":"","geminiApiKeySecret":"","geminiApiKeySecretKey":"gemini-api-key"},"loadStaticSiteEnabled":"false","oidc":{"allowedAud":"architect","authority":"","clientId":"architect","clientSecretKey":"client-secret","enableFetchUserinfo":"true","enableIntrospectToken":"true","enableVerifyIdToken":"true","existingSecret":"","introspectRequiresAuth":"true","introspectTokenKey":"token","introspectUrl":"","jwksUrl":"","scope":"openid roles email profile phone","userinfoRolesClaimName":"architect_roles","userinfoUrl":""}},"extraEnv":{},"extraEnvFrom":[],"image":{"pullPolicy":"","repository":"registry.gitlab.com/castlecraft/framework/architect","tag":""},"persistence":{"enabled":true,"size":"1Gi","storageClass":""},"podAnnotations":{},"podLabels":{},"replicaCount":1,"resources":{},"service":{"port":3000,"type":"ClusterIP"}} | Configuration for the Architect backend service. |
| architect.config | object | {"authorizationEngine":"allow_all","frontendOidcEnabled":"false","gitBranchForComponents":"main","gitRepoUrlForComponents":"","litellm":{"apiBase":"","defaultModel":"","geminiApiKeySecret":"","geminiApiKeySecretKey":"gemini-api-key"},"loadStaticSiteEnabled":"false","oidc":{"allowedAud":"architect","authority":"","clientId":"architect","clientSecretKey":"client-secret","enableFetchUserinfo":"true","enableIntrospectToken":"true","enableVerifyIdToken":"true","existingSecret":"","introspectRequiresAuth":"true","introspectTokenKey":"token","introspectUrl":"","jwksUrl":"","scope":"openid roles email profile phone","userinfoRolesClaimName":"architect_roles","userinfoUrl":""}} | Configuration values for the architect application logic |
| architect.config.authorizationEngine | string | "allow_all" | The authorization engine to use. Can be "allow_all", "casbin", etc. |
| architect.config.frontendOidcEnabled | string | "false" | Set to "true" to enable OIDC authentication. If true, the oidc section below must be configured. |
| architect.config.gitBranchForComponents | string | "main" | The branch of the Git repository to clone. |
| architect.config.gitRepoUrlForComponents | string | "" | The URL of the Git repository containing the application's components. This is required for the application to load its domain, application, etc. layers. e.g., https://gitlab.com/your-group/your-scaffolded-app-repo.git |
| architect.config.litellm | object | {"apiBase":"","defaultModel":"","geminiApiKeySecret":"","geminiApiKeySecretKey":"gemini-api-key"} | LiteLLM (AI/LLM features) configuration |
| architect.config.litellm.apiBase | string | "" | API base for local models like Ollama, e.g., "http://ollama.default.svc.cluster.local:11434" |
| architect.config.litellm.defaultModel | string | "" | Default model to use, e.g., "ollama/llama3:8b-instruct", "gemini/gemini-1.5-pro-latest" |
| architect.config.litellm.geminiApiKeySecret | string | "" | Name of an existing Kubernetes Secret that holds API keys (e.g., for Gemini). |
| architect.config.litellm.geminiApiKeySecretKey | string | "gemini-api-key" | The key within the existingSecret for the Gemini API key. |
| architect.config.loadStaticSiteEnabled | string | "false" | Corresponds to the LOAD_STATIC_SITE_ENABLED environment variable. |
| architect.config.oidc | object | {"allowedAud":"architect","authority":"","clientId":"architect","clientSecretKey":"client-secret","enableFetchUserinfo":"true","enableIntrospectToken":"true","enableVerifyIdToken":"true","existingSecret":"","introspectRequiresAuth":"true","introspectTokenKey":"token","introspectUrl":"","jwksUrl":"","scope":"openid roles email profile phone","userinfoRolesClaimName":"architect_roles","userinfoUrl":""} | OIDC configuration, used when frontendOidcEnabled is "true" |
| architect.config.oidc.clientSecretKey | string | "client-secret" | The key within the existingSecret for the client secret. |
| architect.config.oidc.existingSecret | string | "" | Name of an existing Kubernetes Secret that holds the OIDC client secret. The secret must contain a key with the client secret. |
| architect.extraEnv | object | Extra environment variables to add to the architect container. | |
| architect.extraEnvFrom | list | [] | Extra environment variables to source from existing ConfigMaps or Secrets. See https://kubernetes.io/docs/tasks/inject-data-application/define-environment-variable-container/#define-an-environment-variable-with-a-value-from-a-secret-or-configmap |
| architect.image | object | {"pullPolicy":"","repository":"registry.gitlab.com/castlecraft/framework/architect","tag":""} | Backend image configuration. |
| architect.image.pullPolicy | string | "" | Backend image pull policy. Defaults to the global imagePullPolicy. |
| architect.image.repository | string | "registry.gitlab.com/castlecraft/framework/architect" | Backend image repository. |
| architect.image.tag | string | "" | Backend image tag. Defaults to the chart's appVersion. |
| architect.persistence | object | {"enabled":true,"size":"1Gi","storageClass":""} | Persistence for /data volume (COMPONENTS_BASE_PATH). |
| architect.persistence.enabled | bool | true | Enable persistence for the backend. |
| architect.persistence.size | string | "1Gi" | Size of the persistent volume. |
| architect.persistence.storageClass | string | "" | Storage class for the persistent volume. Use default storage class if empty. |
| architect.podAnnotations | object | {} | Annotations to add to the backend pods. |
| architect.podLabels | object | {} | Labels to add to the backend pods. |
| architect.replicaCount | int | 1 | Number of backend replicas. |
| architect.service | object | {"port":3000,"type":"ClusterIP"} | Backend service configuration. |
| architect.service.port | int | 3000 | Backend service port. |
| architect.service.type | string | "ClusterIP" | Backend service type. |
| autoscaling | object | {"enabled":false,"maxReplicas":10,"minReplicas":1,"targetCPUUtilizationPercentage":80} | Autoscaling configuration. |
| autoscaling.enabled | bool | false | Enable Horizontal Pod Autoscaler. |
| autoscaling.maxReplicas | int | 10 | Maximum number of replicas. |
| autoscaling.minReplicas | int | 1 | Minimum number of replicas. |
| autoscaling.targetCPUUtilizationPercentage | int | 80 | Target CPU utilization percentage to scale up. |
| frontend | object | {"config":{"enableApiProxy":"true"},"enabled":true,"image":{"pullPolicy":"","repository":"registry.gitlab.com/castlecraft/framework/architect/frontend","tag":""},"podAnnotations":{},"podLabels":{},"replicaCount":1,"resources":{},"service":{"port":8080,"type":"ClusterIP"}} | Configuration for the Architect frontend service. |
| frontend.config | object | {"enableApiProxy":"true"} | Configuration values for the frontend application logic. |
| frontend.config.enableApiProxy | string | "true" | Enable the API proxy in the frontend to route /api requests to the backend. |
| frontend.enabled | bool | true | Enable the frontend deployment. |
| frontend.image | object | {"pullPolicy":"","repository":"registry.gitlab.com/castlecraft/framework/architect/frontend","tag":""} | Frontend image configuration. |
| frontend.image.pullPolicy | string | "" | Frontend image pull policy. Defaults to the global imagePullPolicy. |
| frontend.image.repository | string | "registry.gitlab.com/castlecraft/framework/architect/frontend" | Frontend image repository. |
| frontend.image.tag | string | "" | Frontend image tag. Defaults to the chart's appVersion. |
| frontend.podAnnotations | object | Annotations to add to the frontend pods. | |
| frontend.podLabels | object | Labels to add to the frontend pods. | |
| frontend.replicaCount | int | 1 | Number of frontend replicas. |
| frontend.resources | object | {} | Resource requests and limits for the frontend pods. |
| frontend.service | object | {"port":8080,"type":"ClusterIP"} | Frontend service configuration. |
| frontend.service.port | int | 8080 | Frontend service port. |
| frontend.service.type | string | "ClusterIP" | Frontend service type. |
| imagePullPolicy | string | "IfNotPresent" | Global image pull policy. |
| ingress.annotations | object | {} | Annotations for the Ingress resource. |
| ingress.className | string | "" | IngressClassName for the Ingress resource. |
| ingress.enabled | bool | false | Enable Ingress for the frontend service. |
| ingress.hosts | list | [{"host":"architect.local","paths":[{"path":"/","pathType":"ImplementationSpecific"}]}] | Host configuration for the Ingress resource. |
| ingress.tls | list | [] | TLS configuration for the Ingress resource. |
| postgresql.auth | object | {"database":"architect_db","password":"architect_secret_password","username":"architect_user"} | Values to pass to the Bitnami PostgreSQL subchart. See https://github.com/bitnami/charts/tree/main/bitnami/postgresql for all available options. The values below are examples and can be customized. @-aliases @-ignore # |
| postgresql.enabled | bool | true | Controls whether the PostgreSQL subchart is deployed. |
| postgresql.external | object | {"database":"","existingSecret":"","host":"","passwordKey":"password","port":5432,"username":""} | Configuration for an external PostgreSQL database. Used when postgresql.enabled is false. |
| postgresql.external.existingSecret | string | "" | The name of an existing Kubernetes Secret that holds the database password. |
| postgresql.external.host | string | "" | Hostname of the external PostgreSQL server. |
| postgresql.external.passwordKey | string | "password" | The key within the existingSecret for the password. |
| postgresql.primary.persistence.enabled | bool | true | |
| postgresql.primary.persistence.size | string | "8Gi" | |
| redis.architecture | string | "standalone" | Values to pass to the Bitnami Redis subchart. See https://github.com/bitnami/charts/tree/main/bitnami/redis for all available options. @-aliases @-ignore # |
| redis.auth.enabled | bool | false | |
| redis.disabled | bool | false | If true, Redis is not used by the application at all. No Redis-related environment variables will be set for the architect container. |
| redis.enabled | bool | true | Controls whether the Redis subchart is deployed. |
| redis.external | object | {"url":""} | Configuration for an external Redis instance. Used when redis.enabled is false and redis.disabled is false. |
| redis.external.url | string | "" | The full URL for the external Redis. e.g., "redis://my-external-redis:6379" |
| serviceAccount | object | {"annotations":{},"automount":true,"create":true,"name":""} | ServiceAccount configuration. |
| serviceAccount.annotations | object | {} | Annotations to add to the service account. |
| serviceAccount.automount | bool | true | Automount API credentials for the service account. |
| serviceAccount.create | bool | true | Specifies whether a service account should be created. |
| serviceAccount.name | string | "" | The name of the service account to use. If not set and create is true, a name is generated using the fullname template. |