Coverage Matrix

Chkk Curated Release Notesv10.1.0 to latest
Private RegistrySupported
Custom Built ImagesSupported
Safety, Health, and Readiness Checksv10.11.1 to latest
Supported PackagesHelm, Kustomize, Kube
EOL InformationAvailable
Version Incompatibility InformationAvailable
Upgrade TemplatesIn-Place, Blue-Green
PreverificationAvailable

Directus Overview

Directus is an open-source headless CMS that layers REST, GraphQL, and WebSocket APIs over popular SQL engines (PostgreSQL, MySQL/MariaDB, SQLite, etc.). A no-code admin interface streamlines data modeling, content management, and granular permission control, while the built-in Flows automation engine orchestrates event-driven workflows. Its container-friendly architecture integrates smoothly into Kubernetes, enabling platform teams to manage content and metadata without backend overhead or vendor lock-in. Directus also supports custom extensions, single sign-on, and various storage adapters, offering flexible, production-ready deployments.

Chkk Coverage

Curated Release Notes

Chkk curates Directus release notes, highlighting critical operational changes like API deprecations or significant permission model updates. Platform teams receive targeted insights instead of manually parsing lengthy changelogs, enabling proactive preparation for essential configuration adjustments. Important breaking changes, such as major authentication model shifts or integration removals, are flagged explicitly. This focused approach ensures timely and smooth upgrades.

Preflight & Postflight Checks

Chkk performs preflight checks validating database and Node.js runtime compatibility, schema integrity, and deprecated configurations before Directus upgrades. Postflight checks confirm successful database migrations, healthy container status, and consistent API behavior immediately after upgrades. These comprehensive checks proactively identify migration failures or configuration issues, reducing production impact. This structured validation streamlines Directus version transitions, enhancing reliability.

Version Recommendations

Chkk continuously monitors Directus version lifecycles, identifying risks associated with running outdated or unsupported versions. Alerts are generated when versions near end-of-life, highlighting potential security and compatibility issues. Chkk suggests stable and community-vetted upgrade paths, factoring known issues and community feedback. This guidance helps platform engineers strategically time upgrades for optimal stability and support.

Upgrade Templates

Chkk provides detailed templates covering both in-place and blue-green upgrades for Directus deployments via Docker, Helm, or Kubernetes manifests. In-place templates address straightforward container updates and automated database migrations, minimizing downtime. Blue-green upgrade templates outline parallel deployments, schema validation, and incremental traffic migration strategies. These best-practice guides integrate seamlessly with GitOps and CI/CD pipelines, reducing operational risk during upgrades.

Preverification

Chkk’s preverification simulates Directus upgrades in isolated environments, replicating database migrations and configuration application processes. It identifies issues such as schema conflicts, extension incompatibilities, or resource constraints prior to actual production deployments. By validating upgrade scenarios beforehand, platform engineers can address potential problems early. This proactive testing significantly improves upgrade reliability and operational confidence.

Supported Packages

Chkk supports multiple Directus deployment methods, including Helm charts, Kubernetes YAML manifests, and Docker-based setups. It respects custom configurations, private registries, and extension integrations to preserve environment consistency. Chkk seamlessly interfaces with existing GitOps-managed repositories, providing targeted manifest updates and version-aligned recommendations. This ensures flexibility without disrupting established deployment workflows.

Common Operational Considerations

  • Cache and Session Consistency: Deploy a shared Redis instance for multi-instance setups to ensure synchronized caches and consistent user sessions. Without Redis, instances risk inconsistent data or event states.
  • Database Migration Backups: Always back up your database before upgrading Directus, as automated migrations may partially fail or produce unexpected outcomes. Test migrations against a staging database copy first.
  • Extensions and API Changes: Review and update custom Directus extensions before upgrading, as internal APIs and required Node.js versions frequently change. Neglecting this may cause extensions or features to malfunction.
  • Configuration Changes: Regularly review Directus environment variables during upgrades, as missing or changed variables can disrupt essential functionality. Maintain version-controlled configurations to prevent deployment inconsistencies.
  • File Storage Migration: Use persistent or externalized file storage (S3 or Persistent Volume) to retain media files across Directus upgrades or migrations. Failing to preserve file storage can result in broken media links.
  • Resource Allocation: Ensure adequate CPU and memory allocations, especially for high-load operations or after feature-heavy updates. Under-provisioning resources can cause performance degradation or application crashes.

Additional Resources