diff --git a/docs/_static/custom.css b/docs/_static/custom.css index fe31d76d..e17c215b 100644 --- a/docs/_static/custom.css +++ b/docs/_static/custom.css @@ -94,4 +94,29 @@ body { .progress-0plus .progress-bar { background-color: #ff1744; - } \ No newline at end of file + } + +/* Custom admonitions */ +/* See https://squidfunk.github.io/mkdocs-material/reference/admonitions */ +:root { + --md-admonition-icon--heart: url('data:image/svg+xml;charset=utf-8,') +} +.md-typeset .admonition.heart, +.md-typeset details.heart { + border-color: rgb(233, 30, 99); +} +.md-typeset .heart > .admonition-title, +.md-typeset .heart > summary { + background-color: rgba(233, 30, 99, 0.1); +} +.md-typeset .heart > .admonition-title::before, +.md-typeset .heart > summary::before { + background-color: rgb(233, 30, 99); + -webkit-mask-image: var(--md-admonition-icon--heart); + mask-image: var(--md-admonition-icon--heart); +} + +.timetable-explicit-col-widths th:nth-child(1) { width: 4%; } +.timetable-explicit-col-widths th:nth-child(2) { width: 32%; } +.timetable-explicit-col-widths th:nth-child(3) { width: 32%; } +.timetable-explicit-col-widths th:nth-child(4) { width: 32%; } diff --git a/docs/migration/timetable.md b/docs/migration/timetable.md new file mode 100644 index 00000000..537028a7 --- /dev/null +++ b/docs/migration/timetable.md @@ -0,0 +1,38 @@ +--- +hide: + # The table data on this page is easier to read when wider + # The TOC right column is already blank anyway + - 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](../roadmap/index.md) for additional details. + + + +
+ + + +| Date | Flux 1 | Flux 2 CLI | GOTK[^1] | +| -- | -- | -- | -- | +| Oct 6, 2020 | ^^[Maintenance Mode](https://github.com/fluxcd/website/pull/25)^^
| ^^Development Mode^^
| ^^All Alpha^^[^2] | +Feb 18, 2021 | ^^Partial Migration Mode^^
| ^^Feature Parity^^ | ^^Image Automation Alpha. All others reached Feature Parity, Beta^^ | +| TBD | ^^Superseded^^
| ^^Needs further testing, may get breaking changes^^
| ^^All Beta, Production Ready^^[^3]
| +| TBD | ^^Migration and security support only^^
| ^^Public release (GA), Production Ready^^
| ^^All Beta, Production Ready^^ | +| TBD | ^^Archived^^
| ^^Continued active development^^ | ^^Continued active development^^ | + + +
+ +[^1]: GOTK is shorthand for the [GitOps Toolkit](https://toolkit.fluxcd.io/components/) 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](https://semver.org/) scheme + - The GitOps Toolkit APIs follow the [Kubernetes API versioning](https://kubernetes.io/docs/reference/using-api/#api-versioning) pattern. See [Roadmap](https://toolkit.fluxcd.io/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. diff --git a/docs/roadmap/index.md b/docs/roadmap/index.md index d4daccf4..b4088451 100644 --- a/docs/roadmap/index.md +++ b/docs/roadmap/index.md @@ -4,6 +4,7 @@ The Flux 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. + Please see the [Migration and Suport Timetable](../migration/timetable.md) for our commitment to end users. The following components (included by default in [flux bootstrap](../guides/installation.md#bootstrap)) are considered production ready: diff --git a/mkdocs.yml b/mkdocs.yml index 5cbefe28..7e638081 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -26,31 +26,34 @@ plugins: markdown_extensions: - admonition - - meta - codehilite: guess_lang: false - - toc: - permalink: true + - footnotes + - meta + - pymdownx.caret + - pymdownx.emoji: + emoji_generator: !!python/name:materialx.emoji.to_svg + emoji_index: !!python/name:materialx.emoji.twemoji + - pymdownx.extra + - pymdownx.progressbar - pymdownx.superfences: highlight_code: true - pymdownx.tabbed - - pymdownx.tilde - - pymdownx.progressbar - pymdownx.tasklist - - pymdownx.superfences - - pymdownx.emoji: - emoji_index: !!python/name:materialx.emoji.twemoji - emoji_generator: !!python/name:materialx.emoji.to_svg + - pymdownx.tilde + - toc: + permalink: true nav: - Introduction: index.md - Core Concepts: core-concepts/index.md - Get Started: get-started/index.md - Migration: - - Migrate from Flux v1: guides/flux-v1-migration.md - - Migrate from Flux v1 image update automation: guides/flux-v1-automation-migration.md - - Migrate from the Helm Operator: guides/helm-operator-migration.md - - FAQ: guides/faq-migration.md + - Migration and Support Timetable: migration/timetable.md + - Migrate from Flux v1: guides/flux-v1-migration.md + - Migrate from Flux v1 image update automation: guides/flux-v1-automation-migration.md + - Migrate from the Helm Operator: guides/helm-operator-migration.md + - FAQ: guides/faq-migration.md - Guides: - Installation: guides/installation.md - Manage Helm Releases: guides/helmreleases.md