Cronicle Helm Chart
Deploy Cronicle on Kubernetes using the soulteary/cronicle community container image. Multi-server task scheduler and runner with a built-in web UI for scheduled jobs, shell commands, HTTP requests, and plugins with zero external dependencies.
Features
- Web UI — built-in dashboard for managing schedules, viewing logs, and monitoring jobs
- Zero dependencies — filesystem-based storage, no external database needed
- Configurable — JSON config via ConfigMap, secret key via Secret
- Auto-discovery — optional UDP port for multi-server setups
- Persistent storage — job data, history, and state on PVC
- Ingress support — TLS with cert-manager, supports traefik or nginx
Installation
HTTPS repository:
helm repo add helmforge https://repo.helmforge.dev
helm repo update
helm install cronicle helmforge/cronicle -f values.yaml
OCI registry:
helm install cronicle oci://ghcr.io/helmforgedev/helm/cronicle -f values.yaml
Basic Example
# values.yaml — default values are sufficient for a single-server setup
# Filesystem storage, auto-generated secret key
After deploying:
kubectl port-forward svc/<release>-cronicle 3012:80
# Open http://localhost:3012
# Default credentials: admin / admin
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.
|-----|---------|-------------|
| cronicle.port | 3012 | HTTP web UI port |
| cronicle.discoveryPort | 3014 | UDP auto-discovery port |
| cronicle.discoveryEnabled | false | Enable UDP discovery service port |
| cronicle.baseUrl | "http://localhost:3012" | Public base URL |
| cronicle.emailFrom | "cronicle@localhost" | Email sender for notifications |
| cronicle.smtpHostname | "localhost" | SMTP server hostname |
| cronicle.jobMemoryMax | 1073741824 | Max memory per job (bytes, 1 GB) |
| cronicle.maxJobs | 0 | Max concurrent jobs (0 = unlimited) |
| secret.create | true | Auto-generate session encryption key |
| secret.existingSecret | "" | Use an existing secret |
| persistence.enabled | true | Enable persistence for /opt/cronicle/data |
| persistence.size | 5Gi | PVC size |
| ingress.enabled | false | Enable ingress |
| ingress.ingressClassName | traefik | Ingress class (traefik, nginx) |
| service.port | 80 | Service port |
| securityProfile.enabled | false | Enable the opt-in compatible hardening profile |
| networkPolicy.enabled | false | Create the optional NetworkPolicy |
Examples
- Simple private scheduler - port-forward access with bounded job concurrency and persistent storage.
- Ingress deployment - HTTPS ingress with production resource requests and limits.
- SMTP notifications - public URL, SMTP host, and notification-related environment values.
Architecture Guides
- Architecture - Kubernetes resources, request flow, scheduler flow, and single-replica rationale.
- Operations - access, storage, scheduler capacity, notifications, upgrades, and troubleshooting.
Limitations
- Single instance recommended — filesystem storage is single-writer; horizontal scaling requires shared storage or external database
- ReadWriteOnce — default PVC uses ReadWriteOnce due to filesystem storage
- Community image — uses
soulteary/cronicleas Cronicle does not publish an official container image - Root image — the pinned image initializes as root; non-root and read-only-root-filesystem settings require a separately validated image
Upgrade Compatibility
The P2 quality baseline adds documentation, schema coverage, an optional
NetworkPolicy, and an optional security profile. Both new features default to
disabled. The default Deployment keeps the same ServiceAccount token and empty
security-context behavior as chart version 1.1.11, so a normal upgrade does
not change the runtime identity or connectivity of existing jobs.
Validate an upgrade with the same values used by the release:
helm upgrade cronicle helmforge/cronicle --namespace cronicle --reuse-values
kubectl rollout status deployment/cronicle-cronicle --namespace cronicle --timeout=300s
Enable securityProfile.enabled=true only after testing existing scheduled
commands. The profile drops capabilities, blocks privilege escalation, uses
RuntimeDefault seccomp, and disables ServiceAccount token automount. Explicit
podSecurityContext and securityContext keys override profile defaults.
Troubleshooting
- If the pod does not become ready, inspect
kubectl logsand verify the PVC is mounted at/opt/cronicle/data. - If jobs cannot reach dependencies after enabling a custom NetworkPolicy, restore the required DNS, SMTP, and destination egress rules.
- If an existing job needs a Linux capability or Kubernetes API token, disable the security profile or add the smallest explicit override after review.
- If UI links point to localhost, set
cronicle.baseUrlto the public URL.
Quality Gates
helm lint charts/cronicle
helm unittest charts/cronicle
helm template cronicle charts/cronicle | kubeconform -strict -kubernetes-version 1.30.0 -schema-location default
Security Scan: cronicle
| Framework | Score |
|---|---|
| MITRE + NSA + SOC2 | 74.24% |
Security posture: acceptable.
More Information
System Architecture
DESIGN.md SyncedVerified architecture contract rendered dynamically from GitHub DESIGN.md
flowchart LR
Operator[Operator workstation] -->|port-forward| Service[ClusterIP Service]
User[Trusted user] -->|optional HTTPS| Ingress[Ingress controller]
Ingress --> Service
Service --> Pod[Cronicle Deployment: one pod]
Config[ConfigMap: config.json] --> Pod
Secret[Secret: secret_key] --> Pod
Pod --> PVC[PVC: /opt/cronicle/data]
Pod --> SMTP[External SMTP server]Cronicle 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 shared by the chart. |
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 | object | {} | Chart configuration parameter |
Image(3)
| Parameter | Type | Default | Description |
|---|---|---|---|
| image.repository | string | docker.io/soulteary/cronicle | Chart configuration parameter |
| image.tag | string | "" | Chart configuration parameter |
| image.pullPolicy | string | IfNotPresent | Chart configuration parameter Allowed: AlwaysIfNotPresentNever |
Image Pull Secrets(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| imagePullSecrets | array | [] | Chart configuration parameter |
Cronicle(9)
| Parameter | Type | Default | Description |
|---|---|---|---|
| cronicle.port | integer | 3012 | HTTP web UI port |
| cronicle.discoveryPort | integer | 3014 | UDP auto-discovery port |
| cronicle.discoveryEnabled | boolean | false | Enable UDP auto-discovery service port |
| cronicle.baseUrl | string | http://localhost:3012 | Public base URL of the instance |
| cronicle.emailFrom | string | cronicle@localhost | Email sender address for notifications |
| cronicle.smtpHostname | string | localhost | SMTP server hostname for notifications |
| cronicle.jobMemoryMax | integer | 1073741824 | Maximum memory per job in bytes |
| cronicle.maxJobs | integer | 0 | Maximum concurrent jobs (0 = unlimited) |
| cronicle.extraEnv | array | [] | Chart configuration parameter |
Secret(2)
| Parameter | Type | Default | Description |
|---|---|---|---|
| secret.create | boolean | true | Auto-generate a secret_key |
| secret.existingSecret | string | "" | Use an existing secret (must contain key secret_key) |
Persistence(5)
| Parameter | Type | Default | Description |
|---|---|---|---|
| persistence.enabled | boolean | true | Chart configuration parameter |
| persistence.size | string | 5Gi | Chart configuration parameter |
| persistence.storageClass | string | "" | Chart configuration parameter |
| persistence.accessModes | array | - | Chart configuration parameter |
| persistence.existingClaim | string | "" | Chart configuration parameter |
Service Account(3)
| Parameter | Type | Default | Description |
|---|---|---|---|
| serviceAccount.create | boolean | false | Chart configuration parameter |
| serviceAccount.name | string | "" | Chart configuration parameter |
| serviceAccount.annotations | object | {} | Chart configuration parameter |
Service & Networking(3)
| Parameter | Type | Default | Description |
|---|---|---|---|
| service.type | string | ClusterIP | Chart configuration parameter Allowed: ClusterIPNodePortLoadBalancer |
| service.port | integer | 80 | Chart configuration parameter |
| service.annotations | object | {} | Chart configuration parameter |
Ingress(5)
| Parameter | Type | Default | Description |
|---|---|---|---|
| ingress.enabled | boolean | false | Chart configuration parameter |
| ingress.ingressClassName | string | traefik | Chart configuration parameter |
| ingress.annotations | object | {} | 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(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| resources | object | - | Chart configuration parameter |
Pod Security(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| podSecurityContext | any | - | Chart configuration parameter |
Container Security(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| securityContext | any | - | Chart configuration parameter |
Security Profile(6)
| Parameter | Type | Default | Description |
|---|---|---|---|
| securityProfile.enabled | boolean | false | Chart configuration parameter |
| securityProfile.automountServiceAccountToken | boolean | false | Chart configuration parameter |
| securityProfile.podSecurityContext.seccompProfile.type | string | - | Chart configuration parameter |
| securityProfile.containerSecurityContext.allowPrivilegeEscalation | boolean | - | Chart configuration parameter |
| securityProfile.containerSecurityContext.capabilities.add | array | - | Chart configuration parameter |
| securityProfile.containerSecurityContext.capabilities.drop | array | - | Chart configuration parameter |
Network Policy(3)
| Parameter | Type | Default | Description |
|---|---|---|---|
| networkPolicy.enabled | boolean | false | Chart configuration parameter |
| networkPolicy.ingress | array | [] | Chart configuration parameter |
| networkPolicy.egress | array | [] | Chart configuration parameter |
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 | 30 | Chart configuration parameter |
Pod Labels(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| podLabels | object | {} | Chart configuration parameter |
Pod Annotations(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| podAnnotations | object | {} | 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 |
No schema parameters match your search
Try searching for a different keyword or reset the filter.