Releases: fluxcd/flux2
v0.29.3
Flux v0.29.3 is patch release which fixes a regression bug where the source-controller would panic in further to be identified edge-case scenarios in which a HelmRepository
Artifact would not have a Size.
In addition, the flags for configuring the exponential back-off retry have been made available in the kustomize-controller.
Note that v0.29.0 includes breaking changes.
Components Changelog
CLI Changelog
- PR #2668 - @fluxcdbot - Update toolkit components
v0.29.2
Flux v0.29.2 is patch release that comes with dependency updates to please static security analyzers.
Note that v0.29.0 includes breaking changes.
Components Changelog
CLI Changelog
- PR #2662 - @fluxcdbot - Update toolkit components
v0.29.1
v0.29.0
Flux v0.29.0 comes with new features and improvements. Users are encouraged to upgrade for the best experience.
Breaking changes
source-controller
- From this release on, the
RUNTIME_NAMESPACE
environment variable is no longer taken into account to configure the advertised HTTP/S
address of the storage. Instead, variable substitution must be used, as described in the changelog entry forv0.5.2
. - Use of file-based KubeConfig options are now permanently disabled (e.g.
TLSClientConfig.CAFile
,TLSClientConfig.KeyFile
,TLSClientConfig.CertFile
andBearerTokenFile
). The drive behind the change was to discourage insecure practices of mounting Kubernetes tokens inside the controller's container file system. - Use of
TLSClientConfig.Insecure
in KubeConfig file is disabled by default, but can be enabled at controller level with the flag--insecure-kubeconfig-tls
. - Use of
ExecProvider
in KubeConfig file is now disabled by default, but can be enabled at controller level with the flag--insecure-kubeconfig-exec
.
Features and improvements
Notification Improvements
A new notification is now emitted to identify recovery from failures. It is triggered when a failed reconciliation is followed by a successful one, and the notification message is the same that's sent in usual successful source reconciliation message about the stored artifact.
In-memory cache for HelmRepository
The opt-in in-memory cache for HelmRepository
addresses issues where the index file is loaded and unmarshalled in concurrent reconciliation resulting in a heavy memory footprint. It can be configured using the flags: --helm-cache-max-size
, --helm-cache-ttl
, --helm-cache-purge-interval
.
Configurable retention of Source Artifacts
Garbage Collection is enabled by default, and now its retention options are configurable with the flags: --artifact-retention-ttl
(default: 60s
) and --artifact-retention-records
(default: 2
). They define the minimum time to live and the maximum amount of artifacts to survive a collection.
Configurable Key Exchange Algorithms for SSH connections
The Key Exchange Algorithms used when establishing SSH connections are based on the defaults configured upstream in go-git
and golang.org/x/crypto
. Now this can be overriden with the flag --ssh-kex-algos
. Note this applies to the go-git
gitImplementation or the libgit2
gitImplementation but only when Managed Transport is being used.
Configurable Exponential Back-off retry settings
The exponential back-off retry can be configured with the new flags: --min-retry-delay
(default: 750ms
) and --max-retry-delay
(default: 15min
). Previously the defaults were set to 5ms
and 1000s
, which in some cases impaired the controller's ability to self-heal (e.g. retrying failing SSH connections).
Experimental managed transport for libgit2 Git implementation
Managed Transport for libgit2
now introduces self-healing capabilities, to recover from failure when long-running connections become stale.
SOPS refactored and optimized
SOPS implementation was refactored to include various improvements and extended code coverage. Age identities are now imported once and reused multiple times, optimizing CPU and memory usage between decryption operations.
Helm chart directory loader improvements
Introduction of a secure directory loader which improves the handling of Helm charts paths.
Components Changelog
- helm-controller to v0.20.1
- kustomize-controller to v0.24.0
- source-controller to v0.24.0
- notification-controller to v0.23.3
- image-reflector-controller to v0.17.2
- image-automation-controller to v0.22.0
Other changes since last minor release:
CLI Changelog
- PR #2652 - @fluxcdbot - Update toolkit components
- PR #2649 - @hiddeco - Update dependencies
- PR #2646 - @aryan9600 - Handle secret types properly while masking sops data
- PR #2631 - @canidam - bootstrap git: Allow the password to be specified with GIT_PASSWORD env var
- PR #2624 - @kingdonb - Add detail to delete docs
- PR #2617 - @fluxcdbot - Update toolkit components
- PR #2616 - @somtochiama - Add cli flags for chart interval and reconcile strategy
- PR #2611 - @souleb - Add an option to diff with a local Flux Kustomization file
- PR #2609 - @darkowlzz - monitoring-config: set grafana dashboards labelValues
- PR #2607 - @souleb - [Diff] Update pkg/kustomize to v0.1.0
- PR #2597 - @stefanprodan - [RFC-0002] Flux OCI support for Helm
v0.28.5
Flux v0.28.5 is a patch release that comes with various improvements and dependency updates to the controller components. Please consult the changelogs from the list below for a precise overview of changes. Users are (as always) encouraged to upgrade for the best experience.
Note that if you are upgrading from v0.27 you need to follow the Upgrade Flux to the Source v1beta2 API guide.
Components Changelog
- kustomize-controller to v0.22.3
- source-controller to v0.22.5
- image-automation-controller to v0.21.3
- notification-controller to v0.23.2
CLI Changelog
- PR #2594 - @fluxcdbot - Update toolkit components
- PR #2584 - @souleb - Diff: Update homeport/Dyff to v1.5.2
v0.28.4
Flux v0.28.4 is a patch release that comes with improvements to the experimental managed transport's overall stability. Users are encouraged to upgrade for the best experience.
Note that if you are upgrading from v0.27 you need to follow the Upgrade Flux to the Source v1beta2 API guide.
Components Changelog
CLI Changelog
- PR #2583 - @fluxcdbot - Update toolkit components
v0.28.3
Flux v0.28.3 is patch release that comes with a regression bug fix for SOPS Azure Key Vault decryption. In addition, Kustomize has been updated to v4.5.3
to address an issue with YAML anchors. Users are encouraged to upgrade for the best experience.
Note that if you are upgrading from v0.27 you need to follow the Upgrade Flux to the Source v1beta2 API guide.
Components Changelog
CLI Changelog
- PR #2577 - @fluxcdbot - Update toolkit components
- PR #2572 - @stefanprodan - Add the kube client qps and burst to the global args
v0.28.2
Flux v0.28.2 is patch release that comes with a regression bug fix for notification spam. Users are encouraged to upgrade for the best experience.
Note that if you are upgrading from v0.27 you need to follow the Upgrade Flux to the Source v1beta2 API guide.
Components Changelog
- kustomize-controller to v0.22.1
CLI Changelog
- PR #2570 - @fluxcdbot - Update toolkit components
v0.28.1
Flux v0.28.1 is patch release that comes with a regression bug fix for image update automation. Users are encouraged to upgrade for the best experience.
Note that if you are upgrading from v0.27 you need to follow the Upgrade Flux to the Source v1beta2 API guide.
Components Changelog
- helm-controller to v0.18.1
- source-controller to v0.22.2
- notification-controller to v0.23.1
- image-reflector-controller to v0.17.1
- image-automation-controller to v0.21.1
CLI Changelog
- PR #2569 - @fluxcdbot - Update toolkit components
v0.28.0
Flux v0.28.0 comes with new reconcilers for Source kinds and graduates the Flux Source API to v1beta2
.
Breaking changes
- From this version on, controllers depending on Source kinds (kustomize-controller, helm-controller and image-automation-controller) do now require the Source
v1beta2
Custom Resource Definition to be present on the cluster.
Features and improvements
API specifications in a user-friendly format
The new specifications for the v1beta2
API have been written in a new format with the aim to be more valuable to a user. Featuring separate sections with examples, and information on how to write and work with them.
Artifact now advertises size
The size (in bytes) of a tarball Artifact is now advertised in the Size (.size
) field of the Artifact. This can be utilized by users to e.g. quickly see if .sourceignore
rules have an effect, or be displayed in a UI.
Azure Blob Storage support for Bucket
resources
The .spec.provider
of a Bucket
resource can now be set to azure
to instruct the source-controller to use the Azure Blob Storage SDK while fetching objects. This allows for authenticating using Service Principals, Managed Identities and Shared Keys.
For more information, see the Bucket spec about the Azure provider.
Azure Key Vault multi-tenancy
Kustomization resources making use of SOPS with Azure Key Vault as the backing KMS are now allowed to refer to Azure credentials in the tenant's namespace.
For more information, see the Kustomization spec about Azure Key Vault Secret entries.
Enhanced Kubernetes Conditions
Source API resources will now advertise more explicit Condition types (more about the types in API changes), provide Reconciling
and Stalled
Conditions where applicable for better integration with kstatus
, and record the Observed Generation on the Condition.
For a detailed overview per Source type, refer to the spec:
Enhanced Kubernetes Events (and notifications)
The Kubernetes Events the source-controller emits have been reworked to provide a proper reason, and more informative messages. Users making use of the notification-controller will notice this as well, as this same information is used to compose notifications.
Experimental managed transport for libgit2
Git implementation
The libgit2
Git implementation supports a new experimental transport to improve reliability, adding timeout enforcement for Git network operations. Opt-in by setting the environment variable EXPERIMENTAL_GIT_TRANSPORT
to true
in the source-controller and/or image-automation-controller their Deployment.
This will result in the low-level transport being handled by the controller, instead of libgit2
. It may result in an increased number of timeout messages in the logs, however it will remove the ability of Git operations to make the controllers hang indefinitely.
Manage cluster addons
A new annotation (kustomize.toolkit.fluxcd.io/ssa: merge
) is available for allowing Flux to patch cluster addons such as CoreDNS without the kustomize-controller removing the kubectl
managed fields.
For more information, see the Kustomization spec about reconciliation.
Reuse of HTTP/S transport for Helm repository index and chart downloads
The Helm dependency has been updated to v3.8.1
, with a patch applied from helm/helm#10568. Using this patch, the HTTP transports are now managed by the source-controller, to prevent the clogging of thousands of open TCP connections on some instances.
Update of libgit2
Git implementation to v1.3.x
The libgit2
Git implementation has been updated to v1.3.x
, allowing us to provide better error signals for authentication, certificate and transport failures. Effectively, this means that instead of a unable to clone: User
error string, a descriptive one is now given.
In addition, NO_PROXY
settings are now properly taken into account.
Preparation of support for rsa-ssh2-256/512
The dependency on golang.org/x/crypto
has been updated to v0.0.0-20220315160706-3147a52a75dd
, as preparation of support for rsa-ssh2-256/512
. This should theoretically work out of the box for known_hosts
entries and go-git
Git provider credentials, but has not been widely tested.
API changes
The source.toolkit.fluxcd.io/v1beta2
API is backwards compatible with v1beta1
.
- Introduction of
Reconciling
andStalled
Condition types for better integration withkstatus
. - Introduction of new Condition types to provide better signals and failure indications:
ArtifactOutdated
: indicates the current Artifact of the Source is outdated.SourceVerified
: indicates the integrity of the Source has been verified.FetchFailed
: indicates a transient or persistent fetch failure of the upstream Source.BuildFailed
: indicates a transient or persistent build failure of a Source's Artifact.StorageOperationFailed
: indicates a transient or persistent failure related to storage.IncludeUnavailable
: indicates an include is not available. For example, because it does not exist, or does not have an Artifact.
- Introduction of a Size (in bytes) field (
.status.artifact.size
) in the Artifact object. - Introduction of
ObservedChartName
(.status.observedChartName
) andObservedSourceArtifactRevision
(.status.observedSourceArtifactRevision
) fields in theHelmChart
Status. - Introduction of
azure
provider implementation forBucket
.
Upgrade procedure
To upgrade your cluster, download the Flux CLI binary from the release page and rerun the flux bootstrap
command. This will upgrade the Flux components on your cluster to the latest version. Other upgrade options can be found on the docs website.
ℹ️ Note that updating the manifests in Git from source.toolkit.fluxcd.io/v1beta1
to source.toolkit.fluxcd.io/v1beta2
can be done at any time after the Flux components upgrade. All users are encouraged to update the manifests as any deprecated fields will be removed when the next API version will be released. For more information, see post upgrade.
Terrafrom upgrade
When using the Terraform provider for Flux, you have to manually remove the v1beta2
GitRepository from the TF state:
terraform state rm 'kubectl_manifest.sync["source.toolkit.fluxcd.io/v1beta1/gitrepository/flux-system/flux-system"]'
Other upgrade methods
When upgrading without the CLI or Terraform (using e.g. GitHub Actions or RenovateBot), we recommend to bump the GitRepository
API version in gotk-sync.yaml
to v1beta2
.
Post upgrade
After rolling out the upgrade, and when you have confirmed things to be working as expected. Resources in Git which refer to source.toolkit.fluxcd.io/v1beta1
can be updated to refer to source.toolkit.fluxcd.io/v1beta2
:
@@ -1,4 +1,4 @@
-apiVersion: source.toolkit.fluxcd.io/v1beta1
+apiVersion: source.toolkit.fluxcd.io/v1beta2
kind: GitRepository
metadata:
name: gitrepository-sample
Components Changelog
- helm-controller to v0.18.0
- kustomize-controller to v0.22.0
- source-controller to v0.22.1
- notification-controller to v0.23.0
- image-reflector-controller to v0.17.0
- image-automation-controller to v0.21.0
CLI Changelog
- PR #2566 - @stefanprodan - Fix resume source bucket panic
- PR #2565 - @hiddeco - fix: wait for Source objects observed generation
- PR #2564 - @stefanprodan - Use absolute domain name for the events address
- PR #2561 - @hiddeco - Update toolkit components
- PR #2559 - @stefanprodan - Retry bootstrap operations on Git conflict errors
- PR #2542 - @fluxcdbot - Update toolkit components
- PR #2530 - @stefanprodan - Add components-extra example usage to CLI help
- PR #2512 - @souleb - Introduce a printer interface for flux resources
- PR #2484 - @cuishuang - all: fix some typos
- PR #2483 - @fluxcdbot - Update toolkit components
- PR #2467 - @darkowlzz - Update
get
subcommand column order