Files
flux2/docs/migration/timetable.md
Scott Rigby b775d11a70 Flux Migration and Support Timetable
* Set explicit column widths for timetable

  No need for old Firefox workaround. It appears fine on FF in 2021

  See:
  - https://github.com/squidfunk/mkdocs-material/issues/922
  - https://github.com/squidfunk/mkdocs-material/issues/118

* Hide TOC right column on migration table page

* SDK->GOTK footnote

* Cross-link admonitions between Roadmap and Timetable

  To-do: change structure and file names under migration menu dir when we
  move to fluxcd/website

* Add custom heart admonition

* Link to documentated deprecation of apiextensions.k8s.io/v1beta1
  CustomResourceDefinition

* Fix caret (^^ underlines short status)

* Initial migration and Support Timetable

  Add mkdocs markdown_extensions and sort them alphabetically

Co-authored-by: Stefan Prodan <stefan.prodan@gmail.com>
Signed-off-by: Scott Rigby <scott@r6by.com>
2021-03-13 22:24:21 -05:00

4.1 KiB
Raw Blame History

hide
toc

Migration and Support Timetable

!!! heart "Flux Migration Commitment" This public timetable clarifies our commitment to end users. Its purpose is to help improve your experience in deciding how and when to plan infra decisions related to Flux versions. Please refer to the Roadmap for additional details.

Date Flux 1 Flux 2 CLI GOTK1
Oct 6, 2020 ^^Maintenance Mode^^
  • Flux 1 releases only include critical bug fixes (which dont require changing Flux 1 architecture), and security patches (for OS packages, Go runtime, and kubectl). No new features
  • Existing projects encouraged to test migration to Flux 2 pre-releases in non-production
^^Development Mode^^
  • Working to finish parity with Flux 1
  • New projects encouraged to test Flux 2 pre-releases in non-production
^^All Alpha^^2
Feb 18, 2021 ^^Partial Migration Mode^^
  • Existing projects encouraged to migrate to v1beta1/v2beta1 if you only use those features (Flux 1 read-only mode, and Helm Operator)
  • Existing projects encouraged to test image automation Alpha in non-production
^^Feature Parity^^ ^^Image Automation Alpha. All others reached Feature Parity, Beta^^
TBD ^^Superseded^^
^^Needs further testing, may get breaking changes^^
  • CLI needs further user testing during this migration period
^^All Beta, Production Ready^^3
  • All Flux 1 features stable and supported in Flux 2
  • Promoting Alpha versions to Beta makes this Production Ready
TBD ^^Migration and security support only^^
  • Flux 1 releases only include security patches (no bug fixes)
  • Maintainers support users with migration to Flux 2 only, no longer with Flux 1 issues
  • Flux 1 archive date announced
^^Public release (GA), Production Ready^^
  • CLI commits to backwards compatibility moving forward
  • CLI follows kubectl style backwards compatibility support: +1 -1 MINOR version for server components (e.g., APIs, Controllers, validation webhooks)
^^All Beta, Production Ready^^
TBD ^^Archived^^
  • Flux 1 obsolete, no further releases or maintainer support
  • Flux 1 repo archived
^^Continued active development^^ ^^Continued active development^^

  1. GOTK is shorthand for the GitOps Toolkit APIs and Controllers ↩︎

  2. Versioning: Flux 2 is a multi-service architecture, so requires a more complex explanation than Flux 1:

    • Flux 2 CLI follows Semantic Versioning scheme
    • The GitOps Toolkit APIs follow the Kubernetes API versioning pattern. See Roadmap for component versions.
    • These are coordinated for cross-compatibility: For each Flux 2 CLI tag, CLI and GOTK versions are end-to-end tested together, so you may safely upgrade from one MINOR/PATCH version to another.
    ↩︎
  3. The GOTK Custom Resource Definitions which are at v1beta1 and v2beta1 and their controllers are considered stable and production ready. Going forward, breaking changes to the beta CRDs will be accompanied by a conversion mechanism. ↩︎