Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion charts/trueforge/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: TrueForge server (API + UI) served from a single container image.
type: application
# version / appVersion are maintained on main (bot chart-release PR or human).
# Publishing is gated by git tag charts/trueforge@<version> (must match version).
version: 0.1.6-rc.2
version: 0.1.6-rc.3
appVersion: "0.2.0-rc.2"
kubeVersion: ">=1.25.0-0"
home: https://truefoundry.com
Expand Down
91 changes: 90 additions & 1 deletion charts/trueforge/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,91 @@ helm upgrade --install trueforge oci://tfy.jfrog.io/tfy-helm/trueforge \
--set server.publicBaseUrl=https://trueforge.example.com
```

## API keys

`apiKey` (`TRUEFORGE_API_KEY`) authenticates the controller to the server. The
server always runs peered (`STANDALONE=false`) and the app rejects an empty
value, so the chart ships a **dev placeholder**
(`placeholder-value-please-generate-your-own`). Replace it before any shared
deployment, as a string or, preferably, a `valueFrom`:

```yaml
apiKey:
valueFrom:
secretKeyRef:
name: trueforge-api-key
key: TRUEFORGE_API_KEY
```

## Extra environment

`env` is a map of variable name to value, applied to both the server and the
controller. Values are scalars or `valueFrom` references. A key that matches
something the chart already sets **replaces** it rather than adding a second
entry, so it doubles as the override for computed values like `POSTGRES_HOST`
or `PUBLIC_BASE_URL`.

This is the extension point for running against a hosting platform. The chart
does not model any particular platform; those settings live in the caller's
values.

```yaml
env:
SOME_PLATFORM_API_URL:
valueFrom:
configMapKeyRef: { name: platform-config, key: api-url }
SOME_PLATFORM_API_KEY:
valueFrom:
secretKeyRef: { name: platform-creds, key: api-key }
```

When the platform also needs files (an outbound mTLS client certificate, say),
mount them with `extraVolumes` / `extraVolumeMounts`, which apply to both
deployments. `server.extraEnv` and `controller.extraEnv` remain available for
per-deployment entries.

## Custom CA

Honoured from `global.customCA`, whether set on this chart or inherited from a
parent chart. Give it a PEM `certificate` and the chart renders its own
ConfigMap; give it `existingConfigMap.name` (key `ca-certificates.crt`) to reuse
one. With `overrideCAList: true` the ConfigMap is mounted straight over
`/etc/ssl/certs`; otherwise an initContainer merges it into the system bundle.
Either way `NODE_EXTRA_CA_CERTS` is set, since Node ignores the system store.

```yaml
global:
customCA:
enabled: true
certificate: |
-----BEGIN CERTIFICATE-----
...
-----END CERTIFICATE-----
```

## Values inherited from a parent chart

`global.labels`, `global.annotations`, `global.podLabels`,
`global.podAnnotations`, `global.imagePullSecrets`, `global.nodeSelector`,
`global.affinity`, `global.customCA` and `global.resourceTier` are all applied.
The chart's own value wins on conflict; `tolerations` append to
`global.tolerations` rather than replacing them.

## Resource tiers

`resourceTier` (`small` / `medium` / `large`) selects sizing presets for the
server and the controller. When set, it **replaces** the `resources` tables
(replica counts stay as set: server `replicaCount`, controller always 1); an
unknown tier fails the render. Empty (the default) keeps the explicit
`resources` / `controller.resources`. A parent chart may set
`global.resourceTier` instead; the chart's own `resourceTier` wins.

| Preset | Server requests | Controller requests |
| --- | --- | --- |
| `small` | 50m / 128Mi | 50m / 128Mi |
| `medium` | 100m / 256Mi | 100m / 256Mi |
| `large` | 500m / 512Mi | 500m / 512Mi |

## Postgres

Bundled by default (`postgresql.enabled=true`). The chart ships a **dev**
Expand Down Expand Up @@ -198,7 +283,10 @@ extraObjects:

| Value | Default | Description |
| --------------------- | ----------------------------------- | ------------------------------------- |
| `resourceTier` | `""` | Optional `small` / `medium` / `large` sizing preset; empty uses `resources`. |
| `server.replicaCount` | `1` | Number of server replicas. |
| `server.deploymentAnnotations` | `{}` | Annotations on the server Deployment, such as an Argo CD sync wave. |
| `controller.deploymentAnnotations` | `{}` | Annotations on the controller Deployment, such as an Argo CD sync wave. |
| `image.repository` | `tfy.jfrog.io/tfy-images/trueforge` | Image repository. |
| `image.tag` | chart `appVersion` | Image tag; stamped on release. |
| `server.publicBaseUrl`| `""` | Public application URL for OAuth/OIDC callbacks (required for MCP OAuth / OIDC). A pathname is the UI/API public prefix. |
Expand All @@ -212,7 +300,7 @@ extraObjects:
| `podDisruptionBudget.enabled` | `false` | Enable a PodDisruptionBudget (`minAvailable` defaults to `1`). |
| `podSecurityContext` | non-root UID/GID `10001` | Pod-level restricted security defaults. |
| `securityContext` | read-only root FS + drop all capabilities | Container-level restricted security defaults. |
| `resources` | 100m/256Mi requests, 200m/512Mi limits | Container CPU, memory, and ephemeral-storage requests/limits. |
| `resources` | 100m/256Mi requests, 200m/512Mi limits | Server CPU, memory, and ephemeral-storage. Replaced when a resourceTier is set. |
| `mtls.enabled` | `false` | HTTPS listener + controller→server mTLS (`TRUEFORGE_MTLS_*`). When true, probes use `scheme: HTTPS`. |
| `mtls.secretName` | `""` | Secret with `tls.crt` / `tls.key` / `ca.crt` (required when `mtls.enabled`). |
| `mtls.certsDir` | `/etc/tls` | Mount path / `TRUEFORGE_MTLS_CERTS_DIR`. |
Expand All @@ -232,6 +320,7 @@ also sets the `/tmp` `emptyDir.sizeLimit`.
## Production checklist

- **Enable `configs.oidc`** — leaving it off grants shared admin to anyone who can reach the server.
- **Replace the `apiKey` placeholder** with a generated secret (prefer `valueFrom.secretKeyRef`).
- **Replace the bundled Postgres password** (`trueforge`) or set `postgresql.auth.existingSecret`.
- Treat bundled Redis (`redis.auth.enabled: false`) as cluster-internal only, or switch to external passworded Redis via `externalRedis.url`.
- Set `server.publicBaseUrl` to the real public application URL before using MCP OAuth or OIDC (include a pathname when the UI is served under a stripped prefix).
Expand Down
Loading
Loading