From 771fc20bb2f733b96e97ce221b46d41555d0726d Mon Sep 17 00:00:00 2001 From: Stefan Prodan Date: Thu, 18 Feb 2021 17:18:47 +0200 Subject: [PATCH] Add production ready and GA sections to roadmap Signed-off-by: Stefan Prodan --- docs/roadmap/index.md | 49 ++++++++++++++++++++++++++++++++++++------- 1 file changed, 41 insertions(+), 8 deletions(-) diff --git a/docs/roadmap/index.md b/docs/roadmap/index.md index e61e0a42..d4daccf4 100644 --- a/docs/roadmap/index.md +++ b/docs/roadmap/index.md @@ -1,15 +1,49 @@ # Roadmap -In our planning discussions we identified broad three areas of work: +!!! hint "Production readiness" + 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. + +The following components (included by default in [flux bootstrap](../guides/installation.md#bootstrap)) +are considered production ready: + +- [source-controller](../components/source) +- [kustomize-controller](../components/kustomize) +- [notification-controller](../components/notification) +- [helm-controller](../components/helm) + +The following GitOps Toolkit APIs are considered production ready: + +- `source.toolkit.fluxcd.io/v1beta1` +- `kustomize.toolkit.fluxcd.io/v1beta1` +- `notification.toolkit.fluxcd.io/v1beta1` +- `helm.toolkit.fluxcd.io/v2beta1` + +## The road to Flux v2 GA + +In our planning discussions we have identified these possible areas of work, +this list is subject to change while we gather feedback: + +- Stabilize the image automation APIs + * Review the spec of `ImageRepository`, `ImagePolicy` and `ImageUpdateAutomation` + * Promote the image automation APIs to `v1beta1` + * Include the image automation controllers in the default components list + +- Improve the documentation + * Gather feedback on the [migration guides](https://github.com/fluxcd/flux2/discussions/413) and address more use-cases + * Incident management and troubleshooting guides + * Cloud specific guides (AWS, Azure, Google Cloud, more?) + * Consolidate the docs under [fluxcd.io](https://fluxcd.io) website + +## The road to Flux v1 feature parity + +In our planning discussions we identified three areas of work: - Feature parity with Flux v1 in read-only mode - Feature parity with the image-update functionality in Flux v1 - Feature parity with Helm Operator v1 -All of the above will constitute "Flux v2". - -## The road to Flux v2 - ### Flux read-only feature parity [= 100% "100%"] @@ -43,6 +77,7 @@ Tasks - [x] Implement a notification controller for Slack, MS Teams, Discord, Rocket - [x] Implement Prometheus metrics in source and kustomize controllers - [x] Review the git source and kustomize APIs +- [x] Support [bash-style variable substitution](https://toolkit.fluxcd.io/components/kustomize/kustomization/#variable-substitution) as an alternative to `flux.yaml` envsubst/sed usage - [x] Create a migration guide for `flux.yaml` kustomize users - [x] Include support for SOPS @@ -61,6 +96,7 @@ Goals Non-Goals - Maintain backwards compatibility with Flux v1 annotations +- [Order by timestamps found inside image layers](https://github.com/fluxcd/flux2/discussions/802) Tasks @@ -75,8 +111,6 @@ Tasks - [x] ACR/ECR/GCR integration ([guide here](https://toolkit.fluxcd.io/guides/image-update/#imagerepository-cloud-providers-authentication)) - [x] Write a migration guide from Flux v1 annotations ([guide here](https://toolkit.fluxcd.io/guides/flux-v1-automation-migration/)) -## The road to Helm Operator v2 - ### Helm v3 feature parity [= 100% "100%"] @@ -111,4 +145,3 @@ Tasks - [x] Implement support for referring to an alternative chart values file - [x] Stabilize API - [x] [Create a migration guide for Helm Operator users](../guides/helm-operator-migration.md) -- [ ] [Gather feedback on the migration guide](https://github.com/fluxcd/flux2/discussions/413)