You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
flux2/docs/roadmap/index.md

4.2 KiB

Roadmap

In our planning discussions we identified broad 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%"]

This would be the first stepping stone: we want Flux v2 to be on-par with today's Flux in read-only mode and FluxCloud notifications.

Goals

Non-Goals

  • Migrate users that are using Flux to run custom scripts with flux.yaml
  • Automate the migration of flux.yaml kustomize users

Tasks

  • Design the events API
  • Implement events in source and kustomize controllers
  • Make the kustomize-controller apply/gc events on-par with Flux v1 apply events
  • Design the notifications and events filtering API
  • Implement a notification controller for Slack, MS Teams, Discord, Rocket
  • Implement Prometheus metrics in source and kustomize controllers
  • Review the git source and kustomize APIs
  • Create a migration guide for flux.yaml kustomize users
  • Include support for SOPS

Flux image update feature parity

[= 30% "30%"]

Goals

  • Offer components that can replace Flux v1 image update feature

Non-Goals

  • Maintain backwards compatibility with Flux v1 annotations

Tasks

  • Design the image scanning and automation API
  • Implement an image scanning controller
  • Design the automation component
  • Implement the image scan/patch/push workflow
  • Integrate the new components in the Flux CLI
  • Create a migration guide from Flux annotations

The road to Helm Operator v2

Helm v3 feature parity

[= 100% "100%"]

Goals

  • Offer a migration guide for those that are using Helm Operator with Helm v3 and charts from Helm and Git repositories

Non-Goals

  • Migrate users that are using Helm v2

Tasks

  • Implement a Helm controller for Helm v3 covering all the current release options
  • Discuss and design Helm releases based on source API:
    • Providing values from sources
    • Conditional remediation on failed Helm actions
    • Support for Helm charts from Git
  • Review the Helm release, chart and repository APIs
  • Implement events in Helm controller
  • Implement Prometheus metrics in Helm controller
  • Implement support for values from Secret and ConfigMap resources
  • Implement conditional remediation on (failed) Helm actions
  • Implement support for Helm charts from Git
  • Implement support for referring to an alternative chart values file
  • Stabilize API
  • Create a migration guide for Helm Operator users