|
2 | 2 |
|
3 | 3 | All notable changes to this project are documented in this file.
|
4 | 4 |
|
| 5 | +## 1.0.0-rc.1 |
| 6 | + |
| 7 | +**Release date:** 2023-03-30 |
| 8 | + |
| 9 | +This release candidate promotes the `GitRepository` API from `v1beta2` to `v1`. |
| 10 | +The controller now supports horizontal scaling using |
| 11 | +sharding based on a label selector. |
| 12 | + |
| 13 | +In addition, support for Azure Workload Identity was added to |
| 14 | +`OCIRepositories`, `Buckets` and `HelmRepositories` when using `provider: azure`. |
| 15 | + |
| 16 | +### Highlights |
| 17 | + |
| 18 | +#### API changes |
| 19 | + |
| 20 | +The `GitRepository` kind was promoted from v1beta2 to v1 (GA) and deprecated fields were removed. |
| 21 | + |
| 22 | +The common types `Artifact`, `Conditions` and the `Source` interface were promoted to v1. |
| 23 | + |
| 24 | +The `gitrepositories.source.toolkit.fluxcd.io` CRD contains the following versions: |
| 25 | +- v1 (storage version) |
| 26 | +- v1beta2 (deprecated) |
| 27 | +- v1beta1 (deprecated) |
| 28 | + |
| 29 | +#### Upgrade procedure |
| 30 | + |
| 31 | +The `GitRepository` v1 API is backwards compatible with v1beta2, except for the following: |
| 32 | +- the deprecated field `.spec.gitImplementation` was removed |
| 33 | +- the unused field `.spec.accessFrom` was removed |
| 34 | +- the deprecated field `.status.contentConfigChecksum` was removed |
| 35 | +- the deprecated field `.status.artifact.checksum` was removed |
| 36 | +- the `.status.url` was removed in favor of the absolute `.status.artifact.url` |
| 37 | + |
| 38 | +To upgrade from v1beta2, after deploying the new CRD and controller, |
| 39 | +set `apiVersion: source.toolkit.fluxcd.io/v1` in the YAML files that |
| 40 | +contain `GitRepository` definitions and remove the deprecated fields if any. |
| 41 | +Bumping the API version in manifests can be done gradually. |
| 42 | +It is advised to not delay this procedure as the beta versions will be removed after 6 months. |
| 43 | + |
| 44 | +#### Sharding |
| 45 | + |
| 46 | +Starting with this release, the controller can be configured with |
| 47 | +`--watch-label-selector`, after which only objects with this label will |
| 48 | +be reconciled by the controller. |
| 49 | + |
| 50 | +This allows for horizontal scaling, where source-controller |
| 51 | +can be deployed multiple times with a unique label selector |
| 52 | +which is used as the sharding key. |
| 53 | + |
| 54 | +Note that this also requires configuration of the `--storage-adv-addr` |
| 55 | +to a unique address (in combination with a proper Service definition). |
| 56 | +This to ensure the Artifacts handled by the sharding controller point |
| 57 | +to a unique endpoint. |
| 58 | + |
| 59 | +In addition, Source object kinds which have a dependency on another |
| 60 | +kind (i.e. a HelmChart on a HelmRepository) need to have the same |
| 61 | +labels applied to work as expected. |
| 62 | + |
| 63 | +### Full changelog |
| 64 | + |
| 65 | +Improvements: |
| 66 | +- GA: Promote `GitRepository` API to `source.toolkit.fluxcd.io/v1` |
| 67 | + [#1056](https://github.com/fluxcd/source-controller/pull/1056) |
| 68 | +- Add reconciler sharding capability based on label selector |
| 69 | + [#1059](https://github.com/fluxcd/source-controller/pull/1059) |
| 70 | +- Support Azure Workload Identity |
| 71 | + [#1048](https://github.com/fluxcd/source-controller/pull/1048) |
| 72 | +- Update dependencies |
| 73 | + [#1062](https://github.com/fluxcd/source-controller/pull/1062) |
| 74 | +- Update workflows |
| 75 | + [#1054](https://github.com/fluxcd/source-controller/pull/1054) |
| 76 | + |
5 | 77 | ## 0.36.1
|
6 | 78 |
|
7 | 79 | **Release date:** 2023-03-20
|
|
0 commit comments