OliveTin Helm Chart
Deploy OliveTin on Kubernetes using the official jamesread/olivetin container image. OliveTin gives safe and simple access to predefined shell commands from a web interface.
Features
- Web UI for shell commands — define actions in YAML, run them from the browser
- Zero dependencies — stateless, no database required
- Configuration via ConfigMap — YAML config mounted at /config/config.yaml
- Prometheus metrics — optional /metrics endpoint with ServiceMonitor support
- Ingress support — TLS with cert-manager
- Gateway API support — optional HTTPRoute rendering for modern ingress controllers
- External Secrets support — optional ExternalSecret resources for command credentials
- Dual-stack Service support — optional
ipFamilyPolicyandipFamilies - Authoritative application port —
olivetin.portconfigures both Kubernetes and OliveTin throughPORT - Optional persistence — dynamically provision a data PVC or attach an existing claim
- Lightweight — minimal resource usage
Installation
HTTPS repository:
helm repo add helmforge https://repo.helmforge.dev
helm repo update
helm install olivetin helmforge/olivetin -f values.yaml
OCI registry:
helm install olivetin oci://ghcr.io/helmforgedev/helm/olivetin -f values.yaml
Basic Example
# values.yaml
config: |
actions:
- title: "Ping Google"
shell: "ping -c 1 google.com"
- title: "Check Disk Usage"
shell: "df -h"
After deploying:
kubectl port-forward svc/<release>-olivetin 1337:80
# Open http://localhost:1337
Values & Configuration Reference
All schema parameters, types, defaults, and allowed values are extracted directly from the chart repository. Filter and search them in the interactive reference below or customize in Values Studio.
|-----|---------|-------------|
| configInit.enabled | true | Prepare writable OliveTin runtime files before startup |
| configInit.resources | requests/limits set | Resource guardrails for the config bootstrap init container |
| configInit.securityContext | non-root | Security context for the config bootstrap init container |
| image.tag | 3000.20.0 | OliveTin image tag |
| securityContext | non-root | Security context for the OliveTin application container |
| olivetin.port | 1337 | Application port, propagated through OliveTin's PORT environment variable |
| config | "" | OliveTin YAML configuration. Empty uses the chart-managed default config. |
| configTpl.enabled | false | Opt in to Helm tpl rendering for config |
| persistence.enabled | false | Enable optional PVC for data |
| persistence.size | 1Gi | PVC size |
| ingress.enabled | false | Enable ingress |
| service.port | 80 | Service port |
| service.ipFamilyPolicy | omitted | Optional Service IP family policy for dual-stack clusters |
| gatewayAPI.enabled | false | Enable Gateway API HTTPRoute rendering |
| gatewayAPI.httpRoutes[].rules[].omitDefaultBackend | false | Omit the default Service backend for redirect-only rules |
| externalSecrets.enabled | false | Render ExternalSecret resources for command credentials |
| externalSecrets.apiVersion | external-secrets.io/v1 | ExternalSecret API version |
| externalSecrets.refreshInterval | 1h | Default provider sync interval |
| externalSecrets.items | [] | ExternalSecret item list with full ESO spec blocks |
| metrics.enabled | false | Enable Prometheus metrics |
| metrics.port | 1341 | Dedicated Prometheus listener and Service port |
| metrics.defaultGoMetrics | false | Expose default Go runtime metrics |
| metrics.serviceMonitor.enabled | false | Create ServiceMonitor |
| resources | requests/limits set | Default CPU and memory requests and limits |
| serviceAccount.automountServiceAccountToken | false | Prevent automatic API token mounting |
Prometheus Metrics
OliveTin exposes metrics at /metrics. To enable scraping with Prometheus Operator:
metrics:
enabled: true
port: 1341
defaultGoMetrics: false
serviceMonitor:
enabled: true
interval: 30s
OliveTin serves Prometheus metrics on a separate internal listener. The chart
binds that listener to 0.0.0.0:<metrics.port>, exposes the named metrics
Service port, and configures ServiceMonitor to scrape /metrics. Enabling a
ServiceMonitor without metrics is rejected.
Configuration
The config value is mounted as /config/config.yaml inside the container. It is not rendered through Helm tpl by default,
so OliveTin runtime expressions such as {{ message }} remain literal for OliveTin to evaluate. Set configTpl.enabled=true
only when you intentionally want Helm to render templates inside config.
The chart parses the result as YAML and owns the prometheus and
listenAddressPrometheus settings so metrics work consistently with starter
and custom configurations. When metrics are disabled, it forces
prometheus.enabled=false and removes any custom Prometheus listener address.
See the
chart configuration guide and the
OliveTin documentation for all available options.
Upgrade Notes
OliveTin 3000.18.0 added dnsname action arguments and configuration issues
in diagnostics. OliveTin 3000.20.0 adds dashboard categories, persistent log
filters, and support for the PORT environment variable. It also fixes
shellAfterCompleted output injection, HTTP timeout and path traversal
weaknesses, and unsafe theme permissions. Upstream reports no breaking changes.
The chart now propagates olivetin.port through PORT; remove any duplicate
PORT entry from olivetin.extraEnv and configure the port only through
olivetin.port. Enabling persistence now creates the data PVC when
persistence.existingClaim is empty.
Security
OliveTin executes operator-defined shell commands. Do not expose it publicly without configuring OliveTin authentication and ACLs or an authenticated reverse proxy. Trusted-header authentication also requires preventing clients from bypassing that proxy.
The chart defaults to a non-root container, drops all capabilities, disables
privilege escalation, uses runtime-default seccomp, and does not mount a
ServiceAccount token. If actions call the Kubernetes API, explicitly enable the
token and bind only the minimum RBAC. Keep credentials in Kubernetes Secrets or
External Secrets; values.config is stored in a ConfigMap.
The optional /data PVC stores only files that actions deliberately write
there. Session files, themes, and logs under /config remain ephemeral. The
chart does not create NetworkPolicy because action destinations are specific to
each deployment.
Security Scan: olivetin
| Framework | Score |
|---|---|
| MITRE + NSA + SOC2 | 95% |
Security posture: acceptable.
Ingress Example
ingress:
enabled: true
ingressClassName: traefik # or nginx
annotations:
cert-manager.io/cluster-issuer: letsencrypt
hosts:
- host: olivetin.example.com
paths:
- path: /
pathType: Prefix
tls:
- hosts:
- olivetin.example.com
secretName: olivetin-tls
Gateway API Example
gatewayAPI:
enabled: true
httpRoutes:
- name: web
parentRefs:
- name: public
namespace: gateway-system
hostnames:
- olivetin.example.com
External Secrets Example
externalSecrets:
enabled: true
items:
- name: command-credentials
spec:
secretStoreRef:
name: platform-secrets
kind: ClusterSecretStore
target:
name: olivetin-command-credentials
creationPolicy: Owner
data:
- secretKey: API_TOKEN
remoteRef:
key: olivetin/api-token
olivetin:
extraEnv:
- name: API_TOKEN
valueFrom:
secretKeyRef:
name: olivetin-command-credentials
key: API_TOKEN
More Information
System Architecture
DESIGN.md SyncedVerified architecture contract rendered dynamically from GitHub DESIGN.md
flowchart LR user[Authenticated user or trusted network] --> edge[Ingress or HTTPRoute] edge --> service[OliveTin Service HTTP port] service --> frontend[OliveTin frontend listener] frontend --> pod[OliveTin pod] config[ConfigMap config.yaml] --> pod runtime[Writable emptyDir for sessions and themes] --> pod data[(Optional /data PVC)] --> pod eso[External Secrets Operator] -. optional .-> secret[Command credential Secret] secret -. extraEnv or extra volume .-> pod prometheus[Prometheus] -. ServiceMonitor .-> metrics[Service metrics port] metrics --> metricsListener[OliveTin Prometheus listener] metricsListener --> pod
Olivetin Values Schema Reference
Official schema parameters, default values, and types extracted directly from the chart repository.
Global(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| global | object | - | Global settings reserved for chart ecosystem compatibility. |
Name Override(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| nameOverride | string | - | Chart configuration parameter |
Fullname Override(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| fullnameOverride | string | - | Chart configuration parameter |
Common Labels(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| commonLabels | any | - | Chart configuration parameter |
Image(3)
| Parameter | Type | Default | Description |
|---|---|---|---|
| image.repository | string | - | Chart configuration parameter |
| image.tag | string | - | Chart configuration parameter |
| image.pullPolicy | any | - | Chart configuration parameter |
Image Pull Secrets(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| imagePullSecrets | array | - | Chart configuration parameter |
Config Init(9)
| Parameter | Type | Default | Description |
|---|---|---|---|
| configInit.enabled | boolean | - | Chart configuration parameter |
| configInit.image.repository | string | - | Chart configuration parameter |
| configInit.image.tag | string | - | Chart configuration parameter |
| configInit.image.pullPolicy | any | - | Chart configuration parameter |
| configInit.securityContext | object | - | Kubernetes SecurityContext for the config bootstrap container. |
| configInit.resources.requests.cpu | stringnumber | - | Chart configuration parameter |
| configInit.resources.requests.memory | stringnumber | - | Chart configuration parameter |
| configInit.resources.limits.cpu | stringnumber | - | Chart configuration parameter |
| configInit.resources.limits.memory | stringnumber | - | Chart configuration parameter |
Olivetin(2)
| Parameter | Type | Default | Description |
|---|---|---|---|
| olivetin.port | integer | - | Application listener port propagated through OliveTin's PORT environment variable. |
| olivetin.extraEnv | array | - | Additional environment variables. PORT is reserved by the chart. |
Configuration(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| config | string | - | OliveTin YAML configuration mounted at /config/config.yaml. |
Config Tpl(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| configTpl.enabled | boolean | - | Chart configuration parameter |
Metrics & Observability(8)
| Parameter | Type | Default | Description |
|---|---|---|---|
| metrics.enabled | boolean | - | Chart configuration parameter |
| metrics.port | integer | - | Prometheus listener and Service port. |
| metrics.defaultGoMetrics | boolean | - | Chart configuration parameter |
| metrics.serviceMonitor.enabled | boolean | - | Chart configuration parameter |
| metrics.serviceMonitor.namespace | string | - | Chart configuration parameter |
| metrics.serviceMonitor.labels | any | - | Chart configuration parameter |
| metrics.serviceMonitor.interval | string | - | Chart configuration parameter |
| metrics.serviceMonitor.scrapeTimeout | string | - | Chart configuration parameter |
Persistence(5)
| Parameter | Type | Default | Description |
|---|---|---|---|
| persistence.enabled | boolean | - | Chart configuration parameter |
| persistence.size | string | - | Chart configuration parameter |
| persistence.storageClass | string | - | Chart configuration parameter |
| persistence.accessModes | array | - | Chart configuration parameter |
| persistence.existingClaim | string | - | Chart configuration parameter |
Service Account(4)
| Parameter | Type | Default | Description |
|---|---|---|---|
| serviceAccount.create | boolean | - | Chart configuration parameter |
| serviceAccount.name | string | - | Chart configuration parameter |
| serviceAccount.annotations | any | - | Chart configuration parameter |
| serviceAccount.automountServiceAccountToken | boolean | - | Chart configuration parameter |
Service & Networking(5)
| Parameter | Type | Default | Description |
|---|---|---|---|
| service.type | string | - | Chart configuration parameter Allowed: ClusterIPNodePortLoadBalancer |
| service.port | integer | - | Chart configuration parameter |
| service.annotations | any | - | Chart configuration parameter |
| service.ipFamilyPolicy | string | - | Chart configuration parameter Allowed: SingleStackPreferDualStackRequireDualStack |
| service.ipFamilies | array | - | Chart configuration parameter |
Ingress(5)
| Parameter | Type | Default | Description |
|---|---|---|---|
| ingress.enabled | boolean | - | Chart configuration parameter |
| ingress.ingressClassName | string | - | Chart configuration parameter |
| ingress.annotations | any | - | Chart configuration parameter |
| ingress.hosts | array | - | Chart configuration parameter |
| ingress.tls | array | - | Chart configuration parameter |
Health Probes(15)
| Parameter | Type | Default | Description |
|---|---|---|---|
| probes.startup.enabled | boolean | - | Chart configuration parameter |
| probes.startup.initialDelaySeconds | integer | - | Chart configuration parameter |
| probes.startup.periodSeconds | integer | - | Chart configuration parameter |
| probes.startup.timeoutSeconds | integer | - | Chart configuration parameter |
| probes.startup.failureThreshold | integer | - | Chart configuration parameter |
| probes.liveness.enabled | boolean | - | Chart configuration parameter |
| probes.liveness.initialDelaySeconds | integer | - | Chart configuration parameter |
| probes.liveness.periodSeconds | integer | - | Chart configuration parameter |
| probes.liveness.timeoutSeconds | integer | - | Chart configuration parameter |
| probes.liveness.failureThreshold | integer | - | Chart configuration parameter |
| probes.readiness.enabled | boolean | - | Chart configuration parameter |
| probes.readiness.initialDelaySeconds | integer | - | Chart configuration parameter |
| probes.readiness.periodSeconds | integer | - | Chart configuration parameter |
| probes.readiness.timeoutSeconds | integer | - | Chart configuration parameter |
| probes.readiness.failureThreshold | integer | - | Chart configuration parameter |
Resources(4)
| Parameter | Type | Default | Description |
|---|---|---|---|
| resources.requests.cpu | stringnumber | - | Chart configuration parameter |
| resources.requests.memory | stringnumber | - | Chart configuration parameter |
| resources.limits.cpu | stringnumber | - | Chart configuration parameter |
| resources.limits.memory | stringnumber | - | Chart configuration parameter |
Pod Security(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| podSecurityContext | object | - | Kubernetes PodSecurityContext. |
Container Security(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| securityContext | object | - | Kubernetes SecurityContext for OliveTin. |
Node Selector(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| nodeSelector | object | - | Chart configuration parameter |
Tolerations(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| tolerations | array | - | Chart configuration parameter |
Affinity(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| affinity | object | - | Chart configuration parameter |
Topology Spread Constraints(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| topologySpreadConstraints | array | - | Chart configuration parameter |
Priority Class Name(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| priorityClassName | string | - | Chart configuration parameter |
Termination Grace Period Seconds(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| terminationGracePeriodSeconds | integer | - | Chart configuration parameter |
Pod Labels(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| podLabels | any | - | Chart configuration parameter |
Pod Annotations(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| podAnnotations | any | - | Chart configuration parameter |
Extra Volumes(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| extraVolumes | array | - | Chart configuration parameter |
Extra Volume Mounts(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| extraVolumeMounts | array | - | Chart configuration parameter |
Extra Manifests(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| extraManifests | array | - | Chart configuration parameter |
External Secrets(4)
| Parameter | Type | Default | Description |
|---|---|---|---|
| externalSecrets.enabled | boolean | - | Chart configuration parameter |
| externalSecrets.apiVersion | string | - | Chart configuration parameter Allowed: external-secrets.io/v1external-secrets.io/v1beta1 |
| externalSecrets.refreshInterval | string | - | Chart configuration parameter |
| externalSecrets.items | array | - | Chart configuration parameter |
Gateway API(2)
| Parameter | Type | Default | Description |
|---|---|---|---|
| gatewayAPI.enabled | boolean | - | Chart configuration parameter |
| gatewayAPI.httpRoutes | array | - | Chart configuration parameter |
No schema parameters match your search
Try searching for a different keyword or reset the filter.