Skip to content

Commit 1e37cbe

Browse files
committed
Update Helm OCI RFC - static HelmRepository design
Update the design details to reflect the design change to make the HelmRepository of type OCI static. Signed-off-by: Sunny <darkowlzz@protonmail.com>
1 parent 0e7dedc commit 1e37cbe

File tree

1 file changed

+10
-11
lines changed

1 file changed

+10
-11
lines changed

rfcs/0002-helm-oci/README.md

+10-11
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
**Creation date:** 2022-03-30
66

7-
**Last update:** 2022-10-20
7+
**Last update:** 2023-11-28
88

99
## Summary
1010

@@ -252,17 +252,15 @@ Bucket API design, where the same Kind servers different implementations: AWS S3
252252

253253
## Design Details
254254

255-
In source-controller we'll add a new predicate for filtering `HelmRepositories` based on the `spec.type` field.
255+
Unlike the default `HelmRepository`, the OCI `HelmRepository` does not need to
256+
download any repository index file. The associated HelmChart can pull the chart
257+
directly from the OCI registry based on the registry information in the
258+
`HelmRepository` object. This makes the `HelmRepository` of type `oci` static,
259+
not backed by a reconciler to move to a desired state. It becomes a data
260+
container with information about the OCI registry.
256261

257-
The current `HelmRepositoryReconciler` will handle only objects with `type: default`,
258-
it's scope remains unchanged.
259-
260-
We'll introduce a new reconciler named `HelmRepositoryOCIReconciler`, that will handle
261-
objects with `type: oci`. This reconciler will set the `HelmRepository` Ready status to
262-
`False` if:
263-
- the URL is not prefixed with `oci://`
264-
- the URL is malformed and can't be parsed
265-
- the specified credentials result in an authentication error
262+
In source-controller, the `HelmRepositoryReconciler` will be updated to check
263+
the `.spec.type` field of `HelmRepository` and do nothing if it is `oci`.
266264

267265
The current `HelmChartReconciler` will be adapted to handle both types.
268266

@@ -277,6 +275,7 @@ The feature is enabled by default.
277275
* **2022-08-11** Resolve chart dependencies from OCI released with [flux2 v0.32.0](https://github.com/fluxcd/flux2/releases/tag/v0.32.0)
278276
* **2022-08-29** Contextual login for AWS, Azure and GCP released with [flux2 v0.33.0](https://github.com/fluxcd/flux2/releases/tag/v0.33.0)
279277
* **2022-10-21** Verifying Helm charts with Cosign released with [flux2 v0.36.0](https://github.com/fluxcd/flux2/releases/tag/v0.36.0)
278+
* **2023-11-28** Update the design of HelmRepository of type OCI to be static object [flux2 v2.2.0](https://github.com/fluxcd/flux2/releases/tag/v2.2.0)
280279

281280
### TODOs
282281

0 commit comments

Comments
 (0)