Skip to content
Cronicle icon
v1.2.0App: v0.9.80Pinned DigestS3 Backup Ready

Production Helm chart • Apache-2.0 • Zero-Root • Verified on Kubernetes v1.33-v1.36+

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
Official Schema

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.

View Values Schema

|-----|---------|-------------| | 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

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/cronicle as 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 logs and 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.baseUrl to 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 Synced

Verified 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]
Official Contractvalues.schema.json

Cronicle Values Schema Reference

Official schema parameters, default values, and types extracted directly from the chart repository.

73 parametersValues Studio

Global(1)

ParameterTypeDefaultDescription
globalobject-Global settings shared by the chart.

Name Override(1)

ParameterTypeDefaultDescription
nameOverridestring""Chart configuration parameter

Fullname Override(1)

ParameterTypeDefaultDescription
fullnameOverridestring""Chart configuration parameter

Common Labels(1)

ParameterTypeDefaultDescription
commonLabelsobject{}Chart configuration parameter

Image(3)

ParameterTypeDefaultDescription
image.repositorystringdocker.io/soulteary/cronicleChart configuration parameter
image.tagstring""Chart configuration parameter
image.pullPolicystringIfNotPresentChart configuration parameter
Allowed:AlwaysIfNotPresentNever

Image Pull Secrets(1)

ParameterTypeDefaultDescription
imagePullSecretsarray[]Chart configuration parameter

Cronicle(9)

ParameterTypeDefaultDescription
cronicle.portinteger3012HTTP web UI port
cronicle.discoveryPortinteger3014UDP auto-discovery port
cronicle.discoveryEnabledbooleanfalseEnable UDP auto-discovery service port
cronicle.baseUrlstringhttp://localhost:3012Public base URL of the instance
cronicle.emailFromstringcronicle@localhostEmail sender address for notifications
cronicle.smtpHostnamestringlocalhostSMTP server hostname for notifications
cronicle.jobMemoryMaxinteger1073741824Maximum memory per job in bytes
cronicle.maxJobsinteger0Maximum concurrent jobs (0 = unlimited)
cronicle.extraEnvarray[]Chart configuration parameter

Secret(2)

ParameterTypeDefaultDescription
secret.createbooleantrueAuto-generate a secret_key
secret.existingSecretstring""Use an existing secret (must contain key secret_key)

Persistence(5)

ParameterTypeDefaultDescription
persistence.enabledbooleantrueChart configuration parameter
persistence.sizestring5GiChart configuration parameter
persistence.storageClassstring""Chart configuration parameter
persistence.accessModesarray-Chart configuration parameter
persistence.existingClaimstring""Chart configuration parameter

Service Account(3)

ParameterTypeDefaultDescription
serviceAccount.createbooleanfalseChart configuration parameter
serviceAccount.namestring""Chart configuration parameter
serviceAccount.annotationsobject{}Chart configuration parameter

Service & Networking(3)

ParameterTypeDefaultDescription
service.typestringClusterIPChart configuration parameter
Allowed:ClusterIPNodePortLoadBalancer
service.portinteger80Chart configuration parameter
service.annotationsobject{}Chart configuration parameter

Ingress(5)

ParameterTypeDefaultDescription
ingress.enabledbooleanfalseChart configuration parameter
ingress.ingressClassNamestringtraefikChart configuration parameter
ingress.annotationsobject{}Chart configuration parameter
ingress.hostsarray[]Chart configuration parameter
ingress.tlsarray[]Chart configuration parameter

Health Probes(15)

ParameterTypeDefaultDescription
probes.startup.enabledboolean-Chart configuration parameter
probes.startup.initialDelaySecondsinteger-Chart configuration parameter
probes.startup.periodSecondsinteger-Chart configuration parameter
probes.startup.timeoutSecondsinteger-Chart configuration parameter
probes.startup.failureThresholdinteger-Chart configuration parameter
probes.liveness.enabledboolean-Chart configuration parameter
probes.liveness.initialDelaySecondsinteger-Chart configuration parameter
probes.liveness.periodSecondsinteger-Chart configuration parameter
probes.liveness.timeoutSecondsinteger-Chart configuration parameter
probes.liveness.failureThresholdinteger-Chart configuration parameter
probes.readiness.enabledboolean-Chart configuration parameter
probes.readiness.initialDelaySecondsinteger-Chart configuration parameter
probes.readiness.periodSecondsinteger-Chart configuration parameter
probes.readiness.timeoutSecondsinteger-Chart configuration parameter
probes.readiness.failureThresholdinteger-Chart configuration parameter

Resources(1)

ParameterTypeDefaultDescription
resourcesobject-Chart configuration parameter

Pod Security(1)

ParameterTypeDefaultDescription
podSecurityContextany-Chart configuration parameter

Container Security(1)

ParameterTypeDefaultDescription
securityContextany-Chart configuration parameter

Security Profile(6)

ParameterTypeDefaultDescription
securityProfile.enabledbooleanfalseChart configuration parameter
securityProfile.automountServiceAccountTokenbooleanfalseChart configuration parameter
securityProfile.podSecurityContext.seccompProfile.typestring-Chart configuration parameter
securityProfile.containerSecurityContext.allowPrivilegeEscalationboolean-Chart configuration parameter
securityProfile.containerSecurityContext.capabilities.addarray-Chart configuration parameter
securityProfile.containerSecurityContext.capabilities.droparray-Chart configuration parameter

Network Policy(3)

ParameterTypeDefaultDescription
networkPolicy.enabledbooleanfalseChart configuration parameter
networkPolicy.ingressarray[]Chart configuration parameter
networkPolicy.egressarray[]Chart configuration parameter

Node Selector(1)

ParameterTypeDefaultDescription
nodeSelectorobject{}Chart configuration parameter

Tolerations(1)

ParameterTypeDefaultDescription
tolerationsarray-Chart configuration parameter

Affinity(1)

ParameterTypeDefaultDescription
affinityobject-Chart configuration parameter

Topology Spread Constraints(1)

ParameterTypeDefaultDescription
topologySpreadConstraintsarray-Chart configuration parameter

Priority Class Name(1)

ParameterTypeDefaultDescription
priorityClassNamestring""Chart configuration parameter

Termination Grace Period Seconds(1)

ParameterTypeDefaultDescription
terminationGracePeriodSecondsinteger30Chart configuration parameter

Pod Labels(1)

ParameterTypeDefaultDescription
podLabelsobject{}Chart configuration parameter

Pod Annotations(1)

ParameterTypeDefaultDescription
podAnnotationsobject{}Chart configuration parameter

Extra Volumes(1)

ParameterTypeDefaultDescription
extraVolumesarray-Chart configuration parameter

Extra Volume Mounts(1)

ParameterTypeDefaultDescription
extraVolumeMountsarray-Chart configuration parameter

Extra Manifests(1)

ParameterTypeDefaultDescription
extraManifestsarray-Chart configuration parameter