From c19883bd339c27e18f2eea183b7be1a0a8f5a3bf Mon Sep 17 00:00:00 2001 From: mewzherder Date: Wed, 3 Mar 2021 09:54:22 -0800 Subject: [PATCH] Move Flux 1 -> Flux 2 info to the top of the FAQ Signed-off-by: mewzherder --- docs/faq/index.md | 148 +++++++++++++++++++++++----------------------- 1 file changed, 75 insertions(+), 73 deletions(-) diff --git a/docs/faq/index.md b/docs/faq/index.md index 5832d847..fc4f36ea 100644 --- a/docs/faq/index.md +++ b/docs/faq/index.md @@ -1,5 +1,80 @@ # Frequently asked questions +## Flux v1 vs v2 questions + +### What does Flux v2 mean for Flux? + +Flux v1 is a monolithic do-it-all operator; Flux v2 separates the functionalities into specialized controllers, collectively called the GitOps Toolkit. + +You can install and operate Flux v2 simply using the `flux` command. You can easily pick and choose the functionality you need and extend it to serve your own purposes. + +The timeline we are looking at right now is: + +1. Put Flux v1 into maintenance mode (no new features being added; bugfixes and CVEs patched only). +1. Continue work on the [Flux v2 roadmap](https://toolkit.fluxcd.io/roadmap/). +1. We will provide transition guides for specific user groups, e.g. users of Flux v1 in read-only mode, or of Helm Operator v1, etc. once the functionality is integrated into Flux v2 and it's deemed "ready". +1. Once the use-cases of Flux v1 are covered, we will continue supporting Flux v1 for 6 months. This will be the transition period before it's considered unsupported. + +### Why did you rewrite Flux? + +Flux v2 implements its functionality in individual controllers, which allowed us to address long-standing feature requests much more easily. + +By basing these controllers on modern Kubernetes tooling (`controller-runtime` libraries), they can be dynamically configured with Kubernetes custom resources either by cluster admins or by other automated tools -- and you get greatly increased observability. + +This gave us the opportunity to build Flux v2 with the top Flux v1 feature requests in mind: + +- Supporting multiple source Git repositories +- Operational insight through health checks, events and alerts +- Multi-tenancy capabilities, like applying each source repository with its own set of permissions + +On top of that, testing the individual components and understanding the codebase becomes a lot easier. + +### What are significant new differences between Flux v1 and Flux v2? + +#### Reconciliation + +Flux v1 | Flux v2 +---------------------------------- | ---------------------------------- +Limited to a single Git repository | Multiple Git repositories +Declarative config via arguments in the Flux deployment | `GitRepository` custom resource, which produces an artifact which can be reconciled by other controllers +Follow `HEAD` of Git branches | Supports Git branches, pinning on commits and tags, follow SemVer tag ranges +Suspending of reconciliation by downscaling Flux deployment | Reconciliation can be paused per resource by suspending the `GitRepository` +Credentials config via Arguments and/or Secret volume mounts in the Flux pod | Credentials config per `GitRepository` resource: SSH private key, HTTP/S username/password/token, OpenPGP public keys + +#### `kustomize` support + +Flux v1 | Flux v2 +---------------------------------- | ---------------------------------- +Declarative config through `.flux.yaml` files in the Git repository | Declarative config through a `Kustomization` custom resource, consuming the artifact from the GitRepository +Manifests are generated via shell exec and then reconciled by `fluxd` | Generation, server-side validation, and reconciliation is handled by a specialised `kustomize-controller` +Reconciliation using the service account of the Flux deployment | Support for service account impersonation +Garbage collection needs cluster role binding for Flux to query the Kubernetes discovery API | Garbage collection needs no cluster role binding or access to Kubernetes discovery API +Support for custom commands and generators executed by fluxd in a POSIX shell | No support for custom commands + +#### Helm integration + +Flux v1 | Flux v2 +---------------------------------- | ---------------------------------- +Declarative config in a single Helm custom resource | Declarative config through `HelmRepository`, `GitRepository`, `Bucket`, `HelmChart` and `HelmRelease` custom resources +Chart synchronisation embedded in the operator | Extensive release configuration options, and a reconciliation interval per source +Support for fixed SemVer versions from Helm repositories | Support for SemVer ranges for `HelmChart` resources +Git repository synchronisation on a global interval | Planned support for charts from GitRepository sources +Limited observability via the status object of the HelmRelease resource | Better observability via the HelmRelease status object, Kubernetes events, and notifications +Resource heavy, relatively slow | Better performance +Chart changes from Git sources are determined from Git metadata | Chart changes must be accompanied by a version bump in `Chart.yaml` to produce a new artifact + +#### Notifications, webhooks, observability + +Flux v1 | Flux v2 +---------------------------------- | ---------------------------------- +Emits "custom Flux events" to a webhook endpoint | Emits Kubernetes events for included custom resources +RPC endpoint can be configured to a 3rd party solution like FluxCloud to be forwarded as notifications to e.g. Slack | Flux v2 components can be configured to POST the events to a `notification-controller` endpoint. Selective forwarding of POSTed events as notifications using `Provider` and `Alert` custom resources. +Webhook receiver is a side-project | Webhook receiver, handling a wide range of platforms, is included +Unstructured logging | Structured logging for all components +Custom Prometheus metrics | Generic / common `controller-runtime` Prometheus metrics + + + ## Kustomize questions ### Are there two Kustomization types? @@ -251,79 +326,6 @@ EOF Based on the above definition, Flux will upgrade the release automatically when Bitnami publishes a new version of the metrics-server chart. -## Flux v1 vs v2 questions - -### What does Flux v2 mean for Flux? - -Flux v1 is a monolithic do-it-all operator; Flux v2 separates the functionalities into specialized controllers, collectively called the GitOps Toolkit. - -You can install and operate Flux v2 simply using the `flux` command. You can easily pick and choose the functionality you need and extend it to serve your own purposes. - -The timeline we are looking at right now is: - -1. Put Flux v1 into maintenance mode (no new features being added; bugfixes and CVEs patched only). -1. Continue work on the [Flux v2 roadmap](https://toolkit.fluxcd.io/roadmap/). -1. We will provide transition guides for specific user groups, e.g. users of Flux v1 in read-only mode, or of Helm Operator v1, etc. once the functionality is integrated into Flux v2 and it's deemed "ready". -1. Once the use-cases of Flux v1 are covered, we will continue supporting Flux v1 for 6 months. This will be the transition period before it's considered unsupported. - -### Why did you rewrite Flux? - -Flux v2 implements its functionality in individual controllers, which allowed us to address long-standing feature requests much more easily. - -By basing these controllers on modern Kubernetes tooling (`controller-runtime` libraries), they can be dynamically configured with Kubernetes custom resources either by cluster admins or by other automated tools -- and you get greatly increased observability. - -This gave us the opportunity to build Flux v2 with the top Flux v1 feature requests in mind: - -- Supporting multiple source Git repositories -- Operational insight through health checks, events and alerts -- Multi-tenancy capabilities, like applying each source repository with its own set of permissions - -On top of that, testing the individual components and understanding the codebase becomes a lot easier. - -### What are significant new differences between Flux v1 and Flux v2? - -#### Reconciliation - -Flux v1 | Flux v2 ----------------------------------- | ---------------------------------- -Limited to a single Git repository | Multiple Git repositories -Declarative config via arguments in the Flux deployment | `GitRepository` custom resource, which produces an artifact which can be reconciled by other controllers -Follow `HEAD` of Git branches | Supports Git branches, pinning on commits and tags, follow SemVer tag ranges -Suspending of reconciliation by downscaling Flux deployment | Reconciliation can be paused per resource by suspending the `GitRepository` -Credentials config via Arguments and/or Secret volume mounts in the Flux pod | Credentials config per `GitRepository` resource: SSH private key, HTTP/S username/password/token, OpenPGP public keys - -#### `kustomize` support - -Flux v1 | Flux v2 ----------------------------------- | ---------------------------------- -Declarative config through `.flux.yaml` files in the Git repository | Declarative config through a `Kustomization` custom resource, consuming the artifact from the GitRepository -Manifests are generated via shell exec and then reconciled by `fluxd` | Generation, server-side validation, and reconciliation is handled by a specialised `kustomize-controller` -Reconciliation using the service account of the Flux deployment | Support for service account impersonation -Garbage collection needs cluster role binding for Flux to query the Kubernetes discovery API | Garbage collection needs no cluster role binding or access to Kubernetes discovery API -Support for custom commands and generators executed by fluxd in a POSIX shell | No support for custom commands - -#### Helm integration - -Flux v1 | Flux v2 ----------------------------------- | ---------------------------------- -Declarative config in a single Helm custom resource | Declarative config through `HelmRepository`, `GitRepository`, `Bucket`, `HelmChart` and `HelmRelease` custom resources -Chart synchronisation embedded in the operator | Extensive release configuration options, and a reconciliation interval per source -Support for fixed SemVer versions from Helm repositories | Support for SemVer ranges for `HelmChart` resources -Git repository synchronisation on a global interval | Planned support for charts from GitRepository sources -Limited observability via the status object of the HelmRelease resource | Better observability via the HelmRelease status object, Kubernetes events, and notifications -Resource heavy, relatively slow | Better performance -Chart changes from Git sources are determined from Git metadata | Chart changes must be accompanied by a version bump in `Chart.yaml` to produce a new artifact - -#### Notifications, webhooks, observability - -Flux v1 | Flux v2 ----------------------------------- | ---------------------------------- -Emits "custom Flux events" to a webhook endpoint | Emits Kubernetes events for included custom resources -RPC endpoint can be configured to a 3rd party solution like FluxCloud to be forwarded as notifications to e.g. Slack | Flux v2 components can be configured to POST the events to a `notification-controller` endpoint. Selective forwarding of POSTed events as notifications using `Provider` and `Alert` custom resources. -Webhook receiver is a side-project | Webhook receiver, handling a wide range of platforms, is included -Unstructured logging | Structured logging for all components -Custom Prometheus metrics | Generic / common `controller-runtime` Prometheus metrics - ### How can I get involved? There are a variety of ways and we look forward to having you on board building the future of GitOps together: