CHANGELOG.md

Changelog

All notable changes to this project are documented in this file.

0.19.1

Release date: 2021-12-03

This prerelease changes the length of the SHA hex added to the SemVer metadata of a HelmChart, when ReconcileStrategy is set to Revision, to a short SHA hex of the first 12 characters. This is to prevent situations in which the SemVer would exceed the length limit of 63 characters when utilized in a Helm chart as a label value.

Concrete example: 1.2.3+a4303ff0f6fb560ea032f9981c6bd7c7f146d083.1 becomes 1.2.3+a4303ff0f6fb.1

⚠️ There have been additional user reports about charts complaining about a + character in the label:

metadata.labels: Invalid value: "1.2.3+a4303ff0f6fb560ea032f9981c6bd7c7f146d083.1": a valid label must be an empty string or consist of alphanumeric characters, '-', '_' or '.', and must start and end with an alphanumeric character (e.g. 'MyValue', or 'my_value', or '12345', regex used for validation is '(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?')

Given the Helm chart best practices mention to replace this character with a _, we encourage you to patch this in your (upstream) chart. Pseudo example using template functions:

{{- replace "+" "_" .Chart.Version | trunc 63 }}

Fixes:

• controllers: use short SHA in chart SemVer meta #507

0.19.0

Release date: 2021-11-23

For this prerelease we focused on improving the logic around Helm resources, with as goal to be more efficient, and increase code and testing quality.

It contains breaking behavioral changes to HelmRepository and HelmChart resources:

• Helm repository index files and/or charts must not exceed the new declared runtime default limits to avoid out-of-memory crashes, overwriting the default configuration is possible.

  Type	Default max size (in MiB)	Option flag to overwrite
  Helm repository index	50MiB	--helm-index-max-size=<bytes>
  Helm chart	10MiB	--helm-chart-max-size=<bytes>
  Singe file from Helm chart	5MiB	--helm-chart-file-max-size=<bytes>

• Using ValuesFiles in a HelmChart will now append a .<Generation> to the SemVer metadata of the packaged chart and the revision of the Artifact. For example, v1.2.3+.5 for a HelmChart resource with generation 5. This ensures consumers of the chart are able to notice changes to the merged values without the underlying chart source (revision) changing.

While an optional ACL field has been added to the API resources, there is no implementation at time of release.

Improvements:

• helm: factor out logic from controller into package #485
• Add ACL option field to Source API #495
• Update various dependencies to mitigate CVE warning #493
• Update controller-runtime to v0.10.2 #497
• Update github.com/minio/minio-go to v7.0.15 #498
• internal/helm: LoadChartMetadataFromArchive improvements #502
• internal/helm: validate loaded chart metadata obj #503

Fixes:

• tests: ensure proper garbage collection #489
• controllers: Fix helmchart values file merge test #494
• Update test shield link #496
• controllers: absolute local path for cached chart #500
• Various small fixes across the code base #501

0.18.0

Release date: 2021-11-12

This prerelease changes the format of the artifact checksum from SHA1 to SHA256 to mitigate chosen-prefix and length extension attacks.

Improvements:

• storage: change Artifact checksum to SHA256 #487

0.17.2

Release date: 2021-11-04

This prerelease comes with a bug fix to ensure the libgit2 Git implementation respects the operation timeout specified in GitRepositorySpec.

Fixes:

• libgit2: ensure context timeout cancels transfer #477

0.17.1

Release date: 2021-10-30

This prerelease fixes a pointer error that was returned in v0.17.0 during the import of public keys to verify a commit.

Fixes:

• Fix pointer error during public key import #479

0.17.0

Release date: 2021-10-28

For this prerelease we focused on further improving the Git implementations, partly to increase stability and test coverage, partly to ensure they are prepared to be moved out into a separate module. With this work, it is now possible to define just a Git commit as a reference, which will result in an Artifact with a Revision format of HEAD/<commit SHA>.

For the go-git implementation, defining the branch and a commit reference will result in a more efficient shallow clone, and using this information when it is available to you is therefore encouraged.

Improvements:

• git: refactor authentication, checkout and verification #462

Fixes:

• libgit2: handle EOF in parseKnownHosts() #475

0.16.1

Release date: 2021-10-22

This prerelease adds support for GCP storage authentication using the GOOGLE_APPLICATION_CREDENTIALS environment variable available in the container, or by defining a secretRef with a serviceaccount JSON data blob. See #434 for more information.

In addition, several bug fixes and improvements have been made to the libgit2 Git implementation, ensuring the checkout logic is more rigorously tested.

During this work, it was discovered that both Git implementation had a minor bug resulting in v prefixed tags with metadata added to it (e.g. v0.1.0+build-1 and v0.1.0+build-2) were not properly sorted by their commit timestamp, which has been addressed as well.

Improvements:

• Add GCP storage authentication #434

Fixes:

• libgit2: correctly resolve (annotated) tags #457
• libgit2: add remaining checkout strategy tests #458
• git: ensure original tag is used for TS lookup #459

0.16.0

Release date: 2021-10-08

This prerelease improves the configuration of the libgit2 C library, solving most issues around private key formats (e.g. PKCS#8 and ED25519) by ensuring it is linked against OpenSSL and LibSSH2.

In addition, the HelmChart resource does now allow setting a ReconcileStrategy to define when a new artifact for a chart should be created for charts from Bucket and GitRepository sources. By setting this to Revision, you no longer have to bump the version in the Chart.yaml file, but a new chart will automatically be made available when the revision of the Source changes.

Fixes:

• Update containerd and runc to fix CVEs #446

Improvements:

• Add reconcile strategy for HelmCharts #308
• Update github.com/libgit2/git2go to v31.6.1 #437

0.15.4

Release date: 2021-08-05

This prerelease comes with a series of bug fixes, and updates the Kubernetes dependencies to v1.21.3 and Helm to v3.6.3.

Fixes:

• Fix tag checkout with libgit2 #394
• Take relative paths in account for Bucket revision #403
• Ensure rel path never traverses outside Storage #417
• Use same SemVer logic in both Git implementations #417
• storage: strip env specific data during archive #417

Improvements:

• e2e: Update Kubernetes to v1.21 #396
• Update Helm to v3.6.3 #400
• Add setup-envtest in Makefile #404
• Use ObjectKeyFromObject instead of ObjectKey #405
• Drop deprecated io/ioutil #409
• Update dependencies #416

0.15.3

Release date: 2021-06-29

This prerelease comes with a bug fix to the Git tag checkout when using libgit2.

Fixes:

• Fix tag checkout with libgit2 #394

0.15.2

Release date: 2021-06-22

This prerelease updates the build constraints for libgit2, ensuring the underlying libssh2-1-dev dependency is linked against libssl-dev instead of libgcrypt so that PKCS* private keys can be used without any issues.

Fixes:

• Use libgit2 from "unstable" / "sid" #391

0.15.1

Release date: 2021-06-18

This prerelease updates the Helm dependency to v3.6.1, this update is a security update and ensures credentials are only passed to the defined URL in a HelmRelease.

Note: there have been reports from the Helm user community that this new behavior may cause issues with Helm repository providers like Artifactory. If this happens to be a problem for you, the behavior can be disabled by setting PassCredentials in the HelmRepositorySpec.

For more details, see: https://github.com/helm/helm/security/advisories/GHSA-56hp-xqp3-w2jf

Improvements:

• Update Helm to v3.6.1 #388

0.15.0

Release date: 2021-06-17

This prerelease comes with changes to the base image used to build the controller, replacing Alpine with Debian slim. This change allows the controller to run on ARM64, previously broken in v0.14.0.

Improvements:

• Use Debian instead of Alpine for multi-arch builds #386
• Panic on non-nil AddToScheme errors in main init #387

0.14.0

Release date: 2021-06-09

This prerelease comes with an update to the Kubernetes and controller-runtime dependencies to align them with the Kubernetes 1.21 release, including an update of Helm to v3.6.0.

After a failed ARMv7 build during the initial release attempt of this version, binutils-gold has been introduced to the builder image to allow gccgo to build using the Gold linker.

Improvements:

• Update K8s, controller-runtime and fluxcd/pkg deps #374
• Add nightly builds workflow #376

Fixes:

• Reinstate Git cloning timeout #372
• Use binutils-gold in builder image #377
• Use github.repository property for image name #378

0.13.2

Release date: 2021-06-02

This prerelease comes with an update to the go-git implementation dependency, bumping the version to v5.4.2. This should resolve any issues with object not found and empty git-upload-pack given errors that were thrown for some Git repositories since 0.13.0.

Fixes:

• Update go-git to v5.4.2 #370

0.13.1

Release date: 2021-05-28

This prerelease comes with a bug fix to the GitRepository include feature.

Fixes:

• Fix GitRepository include for nested paths #367

0.13.0

Release date: 2021-05-26

This prerelease comes with support for including the contents of a Git repository into another.

The include feature has multiple benefits over regular Git submodules:

• Including a GitRepository allows you to use different authentication methods for different repositories.
• A change in the included repository will trigger an update of the including repository.
• Multiple GitRepositories could include the same repository, which decreases the amount of cloning done compared to using submodules.

Features:

• Add include property to GitRepositories #348

Improvements:

• Update Git packages #365

0.12.2

Release date: 2021-05-10

This prerelease comes with a bug fix to Bucket source ignore handling.

Fixes:

• Split bucket item key by / to satisfy matcher #356

0.12.1

Release date: 2021-04-23

This prerelease comes with a bug fix to source ignore handling.

Fixes:

• Configure ignore domain for GitRepository rules #351

0.12.0

Release date: 2021-04-21

This prerelease comes with support for SSH keys with a passphrase.

The .sourceignore files are now loaded by traversing through the directory tree, instead of just looking at the root.

The HelmChart ValueFile string field has been deprecated in favour of ValuesFiles string array.

Features:

• Support SSH private key with password #338 #339
• Add ValuesFiles to HelmChart spec #305

Improvements:

• Check ignore matches before Bucket item downloads #337
• Add short name for Git and Helm repositories #334
• Update Helm to v3.5.4 #340

Fixes:

• Write chart data on identical values overwrite #345
• Fix HelmChart values tests #332

0.11.0

Release date: 2021-03-31

This prerelease comes with support for Git submodules and self-signed TLS certs when using gitProvider: go-git.

Features:

• Add support for Git submodules with go-git #327
• Enable self-signed certs for go-git #324

Improvements:

• Add well-known CI configs to exclusion list #329

0.10.0

Release date: 2021-03-26

This is the tenth MINOR prerelease.

This prerelease comes with a breaking change to the leader election ID from 305740c0.fluxcd.io to source-controller-leader-election to be more descriptive. This change should not have an impact on most installations, as the default replica count is 1. If you are running a setup with multiple replicas, it is however advised to scale down before upgrading.

The suspended status of resources is now recorded to a gotk_suspend_status Prometheus gauge metric.

Improvements:

• Record suspend metrics in controllers #311
• Set leader election deadline to 30s #318
• Change leader election ID to be more descriptive #319

0.9.1

Release date: 2021-03-15

This prerelease comes with improvements to Git clone errors and patch updates to dependencies.

Improvements:

• Tidy git clone errors #304
• Update dependencies #307

0.9.0

Release date: 2021-02-23

This is the ninth MINOR prerelease.

Due to changes in Helm v3.5.2, charts not versioned using strict semver are no longer compatible with source-controller. When using charts from Git, make sure that the version field is set in Chart.yaml.

Improvements:

• Update dependencies #299
• Refactor release workflow #300

0.8.1

Release date: 2021-02-18

This prerelease fixes a bug where only one dependency of a Helm chart would be included.

Fixes:

• Copy loop iterator var for use by goroutine #294

0.8.0

Release date: 2021-02-12

This is the eight MINOR prerelease.

The libgit2 Git implementation now has support for Certificate Authority validation for Git over HTTPS, as well as various bug fixes around working with SSH host key fingerprints.

Alpine has been updated to 3.13, making it possible to move away from edge for libgit2 and musl dependencies.

pprof endpoints have been enabled on the metrics server, making it easier to collect runtime information to for example debug performance issues.

Features:

• Add custom CA validation for Git over HTTPS #283

Improvements:

• Rename Git packages to implementations #270
• Enable pprof endpoints on metrics server #282
• Add fsGroup to pod security context #285
• Use musl and libit2 packages from v3.13 branch #289

Fixes:

• Fix chart with custom valuesFile (0bytes tgz) #286
• libgit2: use provided host to validate public key #288
• libgit2: check hostkey type when validating hostkey #290

0.7.4

Release date: 2021-02-03

This prerelease fixes a bug where the controller tried to update dependencies for Helm charts even when dependencies were already present.

0.7.3

Release date: 2021-02-02

This prerelease changes the strategy of the controller's deployment to Recreate to prevent a deadlock during upgrades and to ensure safe usage of backing persistent (RW) volumes.

0.7.2

Release date: 2021-02-01

This prerelease ensures the file server of the controller only starts for the elected leader, and improves the visibility of chart name validation errors.

0.7.1

Release date: 2021-01-25

This prerelease changes the recorded revision for a HelmRepository resource to a SHA1 checksum, this to improve the detection of changes for repositories that do not correctly update their advertised generation timestamp.

0.7.0

Release date: 2021-01-21

This is the seventh MINOR prerelease.

Two new argument flags are introduced to support configuring the QPS (--kube-api-qps) and burst (--kube-api-burst) while communicating with the Kubernetes API server.

The LocalObjectReference from the Kubernetes core has been replaced with our own, making Name a required field. The impact of this should be limited to direct API consumers only, as the field was already required by controller logic.

Overwrite of chart values has been patched to correctly read the data from the defined YAML file.

0.6.3

Release date: 2021-01-19

This prereleases comes with bug fixes to the HelmChart indexes, watches, and the overwrite of chart values.

0.6.2

Release date: 2021-01-16

This prerelease comes with updates to Kubernetes and Helm dependencies. The Kubernetes packages were updated to v1.20.2 and Helm to v3.5.0.

0.6.1

Release date: 2021-01-14

This prerelease fixes a regression bug introduced in v0.6.0 that caused reconciliation request annotations to be ignored in certain scenarios.

0.6.0

Release date: 2021-01-12

This is the sixth MINOR prerelease, upgrading the controller-runtime dependencies to v0.7.0.

The container image for ARMv7 and ARM64 that used to be published separately as source-controller:*-arm64 has been merged with the AMD64 image.

0.5.6

Release date: 2020-12-18

This prerelease fixes a regression bug that made it impossible to reference to a HelmChart.ValuesFile in a path relative to the root of the Bucket or GitRepository source.

0.5.5

Release date: 2020-12-16

This prerelease adds safe guards for user defined relative paths, ensuring they never traverse outside working directories.

Other notable changes:

• ListObjects V1 fallback for GCS S3 endpoints, ensuring generic Bucket resources connecting to GCS are able to list object
• HelmChart controller panic regression bug fix, introduced in v0.5.0

0.5.4

Release date: 2020-12-12

This prerelease fixes a bug in the build process that caused the ARMv7 image to fail due to libgit2 requiring musl>=1.2.0.

0.5.3

Release date: 2020-12-11

This prerelease fixes a regression bug causing the commit hash for the go-git implementation to not be forwarded, introduced by the support for multiple Git implementations.

0.5.2

Release date: 2020-12-11

This prerelease adds the option to configure the advertised storage address using the --storage-adv-addr flag.

The default deployment manifest uses this to configure the FQDN of the service (source-controller.$(RUNTIME_NAMESPACE).svc.cluster.local.), but omitting the flag will result in a fallback to the previous behavior for backwards compatibility.

0.5.1

Release date: 2020-12-09

This prerelease fixes a bug in the build process that caused the ARMv7 build to fail due to libgit2 requiring musl>=1.2.0.

0.5.0

Release date: 2020-12-09

This is the fifth MINOR prerelease, adding a new Git implementation (libgit2) to allow for communication with Git servers that just support the Git v2 protocol, like Azure Devops.

The new Git implementation can be enabled by configuring the GitImplementation in a GitRepository to libgit2 (default: go-git). Note that this implementation does not support shallow cloning, and it is therefore advised to only resort to this option if a connection fails with the default configuration.

Other notable changes in this release:

• Bug fix to respect the configured SSH user in GitRepository URLs
• Chart name validation for charts from a HelmRepository resource
• Kubernetes dependency upgrades to v1.19.4
• Helm upgrade to v3.4.2

0.4.1

Release date: 2020-11-26

This prerelease fixes a bug in the listing of HelmChart resources for GitRepository changes.

0.4.0

Release date: 2020-11-26

This is the fourth MINOR prerelease, adding support for suspension of resources using .spec.suspend, and watchers for the upstream sources of HelmChart resources to detect revision changes faster.

0.3.0

Release date: 2020-11-19

This prerelease comes with a fix to garbage collection. The status sub-resource has a new field called LastHandledReconcileAt that can be used to track the reconciliation progress.

This version comes with a breaking change to the API package: the status condition type is imported from Kubernetes API machinery 1.19.

0.2.2

Release date: 2020-11-12

This prerelease comes with improvements to status reporting. The Kubernetes packages have been updated to v1.19.

0.2.1

Release date: 2020-10-30

This prerelease comes with a fix for a regression bug (introduced in v0.2.0) where dependency entries in the Chart.yaml file during the (re)packaging of the Helm chart artifact would have their names overwritten with the alias if defined.

0.2.0

Release date: 2020-10-29

This is the second MINOR prerelease, it comes with breaking changes:

• Due to a change of semver library to exclude pre-releases from 1.0.x ranges, support for more complex ranges like >=1.0.0 <2.0.0 || >=3.0.0 !3.0.1-beta.1 has been dropped.
• The histogram metric gotk_reconcile_duration was renamed to gotk_reconcile_duration_seconds

Other notable changes:

• Ambiguous semver matches are now sorted by the timestamp of the source system to use the most recent match.
• Added support for downloading dependencies for Helm charts from GitRepository and Bucket sources.
• Added support for creating artifacts for packaged Helm charts (.tgz) from GitRepository and Bucket sources.
• The annotation fluxcd.io/reconcileAt was renamed to reconcile.fluxcd.io/requestedAt, the former will be removed in a next release but is backwards compatible for now.

0.1.1

Release date: 2020-10-13

This prerelease comes with Prometheus instrumentation for the controller's resources.

For each kind, the controller exposes a gauge metric to track the Ready condition status, and a histogram with the reconciliation duration in seconds:

• gotk_reconcile_condition{kind, name, namespace, status, type="Ready"}
• gotk_reconcile_duration{kind, name, namespace}

0.1.0

Release date: 2020-09-30

This is the first MINOR prerelease, it promotes the source.toolkit.fluxcd.io API to v1beta1 and removes support for v1alpha1.

Going forward, changes to the API will be accompanied by a conversion mechanism. With this release the API becomes more stable, but while in beta phase there are no guarantees about backwards compatibility between beta releases.

0.0.18

Release date: 2020-09-23

This prerelease fixes a reconciliation bug that prevented resources recovering from transient errors. Container images for ARMv7 and ARMv8 are published to ghcr.io/fluxcd/source-controller-arm64. The Helm package was updated to v3.3.4.

0.0.17

Release date: 2020-09-18

This prerelease comes with support for S3 compatible storage sources defined as buckets. The Helm package was updated to v3.3.2.

0.0.16

Release date: 2020-09-12

This prerelease comes with the option to watch for resources in the runtime namespace of the controller or at cluster level.

0.0.15

Release date: 2020-09-11

This prerelease adds support for overwriting the default values of a HelmChart by defining a ValuesFile, adds a Checksum field to the Artifact object, and comes with several improvements to the storage and handling of artifacts.

0.0.14

Release date: 2020-09-04

This prerelease comes with Helm v3.3.1. Container images for linux/amd64 and linux/arm64 are published to GHCR.

0.0.13

Release date: 2020-09-01

This prerelease fixes a bug in the packaging of HelmChart artifacts build from GitRepository sources, and improves the logic of the Storage.ArtifactExist method to not follow symlinks and only return true for regular files.

0.0.12

Release date: 2020-08-31

This prerelease adds support for HelmChart artifacts build from GitRepository sources, and includes several (breaking) changes to the API:

• The Name field in the HelmChartSpec has been renamed to Chart, and may now contain the path a chart is available at in a referred Source.
• The HelmRepositoryRef field in the HelmChartSpec has been renamed to SourceRef, and may now contain a reference to HelmRepository and GitRepository resources.
• The Kind field in the SourceRef object is now mandatory.

Other notable changes: the HelmChart Version field now supports the same ranges as the GitRepository SemVer checkout strategy, support for relative URLs in HelmRepository indexes, and several other bug fixes.

0.0.11

Release date: 2020-08-21

This prerelease only included a version change of github.com/fluxcd/source-controller/api to publish go.mod changes.

0.0.10

Release date: 2020-08-18

This prerelease comes with a bug fix to the Git semver checkout.

0.0.9

Release date: 2020-08-17

This prerelease upgrades the github.com/fluxcd/pkg/* dependencies to dedicated versioned modules.

0.0.8

Release date: 2020-08-12

This prerelease comes with improvements to Helm repository index fetching. The Helm getter was upgraded to v3.3.0, and it's possible to configure the timeout of index downloads.

0.0.7

Release date: 2020-07-31

This prerelease comes with a breaking change, the CRDs group has been renamed to source.toolkit.fluxcd.io.

0.0.6

Release date: 2020-07-20

This prerelease drops support for Kubernetes <1.16. The CRDs have been updated to apiextensions.k8s.io/v1.

0.0.5

Release date: 2020-07-13

This prerelease comes with improvements to logging. The default logging format is JSON and the timestamp format is ISO8601. Introduce fluxcd.io/reconcileA annotation for on-demand reconciliation of source objects.

0.0.4

Release date: 2020-07-10

This prerelease comes with fixes to the testing framework.

0.0.3

Release date: 2020-07-09

This prerelease adds support for ignore patterns to be specified on GitRepository objects.

0.0.2

Release date: 2020-07-03

This prerelease comes with Kubernetes events dispatching. The reconciliation events can be forwarded to notification controller and alerting can be configured for Slack, MS Teams, Discord and Rocket chat using the notification.fluxcd.io API.

0.0.1

Release date: 2020-06-24

This is the first prerelease ready for public testing. To get started testing, see the GitOps Toolkit guide.

0.0.1-beta.2

Release date: 2020-06-10

This beta release comes with improvements to the artifacts archiving.

0.0.1-beta.1

Release date: 2020-05-29

This is the first beta release of source controller. This release adds support for excluding files when packaging artifacts from Git repositories.

0.0.1-alpha.6

Release date: 2020-05-06

This alpha release comes with improvements to the GitRepository reconciler. Starting with this version, the controller watches for sources only in the namespace where it's deployed.

0.0.1-alpha.5

Release date: 2020-04-30

This alpha release contains several bug fixes #47 #49 #50. After a successful synchronization, the controller reports the revision in the status ready condition.

0.0.1-alpha.4

Release date: 2020-04-28

This alpha release comes with integrity checks for artifacts produced from Git repositories.

0.0.1-alpha.3

Release date: 2020-04-27

This alpha release contains a bug fix for GitRepositories status reporting and allows waiting for sources on-demand sync.

0.0.1-alpha.2

Release date: 2020-04-24

This is the second alpha release of source controller.

It introduces a timeout field to the GitRepositoriesSpec and SyncAt annotation to the common spec. Furthermore, it allows configuring the amount of concurrent reconciliation operations per reconciler using the newly introduced --concurrent flag (defaults to 2), and introduces a --log-json flag to enable JSON logging.

Liveness and readiness probes have been added to the deployment manifest, and the security has been strengthened by running the controller as a non-root user by default and adding a container security context.

Tests have been added to ensure correct behaviour of the HelmChartReconciler and HelmRepositoryReconciler.

0.0.1-alpha.1

Release date: 2020-04-16

This is the first alpha release of source controller. The controller is an implementation of the source.fluxcd.io/v1alpha1 API based on the specifications described in the Source Controller Proposal.