5
5
There are 2 [ Helm repository types] ( #type ) defined by the ` HelmRepository ` API:
6
6
- Helm HTTP/S repository, which defines a Source to produce an Artifact for a Helm
7
7
repository index YAML (` index.yaml ` ).
8
- - OCI Helm repository, which defines a source that does not produce an Artifact.
9
- Instead a validation of the Helm repository is performed and the outcome is reported in the
10
- ` .status.conditions ` field .
8
+ - OCI Helm repository, which defines a source that does not produce an Artifact.
9
+ It's a data container to store the information about the OCI repository that
10
+ can be used by [ HelmChart ] ( helmcharts.md ) to access OCI Helm charts .
11
11
12
12
## Examples
13
13
@@ -113,9 +113,11 @@ In the above example:
113
113
114
114
- A HelmRepository named `podinfo` is created, indicated by the
115
115
` .metadata.name` field.
116
- - The source-controller performs the Helm repository url validation i.e. the url
117
- is a valid OCI registry url, every five minutes with the information indicated by the
118
- ` .spec.interval` and `.spec.url` fields.
116
+ - A HelmChart that refers to this HelmRepository uses the URL in the `.spec.url`
117
+ field to access the OCI Helm chart.
118
+
119
+ **NOTE:** The `.spec.interval` field is only used by the `default` Helm
120
+ repository and is ignored for any value in `oci` Helm repository.
119
121
120
122
You can run this example by saving the manifest into `helmrepository.yaml`.
121
123
@@ -129,25 +131,12 @@ You can run this example by saving the manifest into `helmrepository.yaml`.
129
131
130
132
` ` ` console
131
133
NAME URL AGE READY STATUS
132
- podinfo oci://ghcr.io/stefanprodan/charts 3m22s True Helm repository "podinfo" is ready
134
+ podinfo oci://ghcr.io/stefanprodan/charts 3m22s
133
135
` ` `
134
136
135
- 3. Run `kubectl describe helmrepository podinfo` to see the [Conditions](#conditions)
136
- in the HelmRepository's Status :
137
-
138
- ` ` ` console
139
- ...
140
- Status:
141
- Conditions:
142
- Last Transition Time: 2022-05-12T14:02:12Z
143
- Message: Helm repository "podinfo" is ready
144
- Observed Generation: 1
145
- Reason: Succeeded
146
- Status: True
147
- Type: Ready
148
- Observed Generation: 1
149
- Events: <none>
150
- ` ` `
137
+ Because the OCI Helm repository is a data container, there's nothing to report
138
+ for `READY` and `STATUS` columns above. The existence of the object can be
139
+ considered to be ready for use.
151
140
152
141
# # Writing a HelmRepository spec
153
142
@@ -360,6 +349,9 @@ for more information about setting up GKE Workload Identity.
360
349
361
350
# ## Interval
362
351
352
+ **Note:** This field is ineffectual for [OCI Helm
353
+ Repositories](#helm-oci-repository).
354
+
363
355
` .spec.interval` is a required field that specifies the interval which the
364
356
Helm repository index must be consulted at.
365
357
@@ -387,6 +379,9 @@ For Helm repositories which require authentication, see [Secret reference](#secr
387
379
388
380
# ## Timeout
389
381
382
+ **Note:** This field is not applicable to [OCI Helm
383
+ Repositories](#helm-oci-repository).
384
+
390
385
` .spec.timeout` is an optional field to specify a timeout for the fetch
391
386
operation. The value must be in a
392
387
[Go recognized duration string format](https://pkg.go.dev/time#ParseDuration),
@@ -537,6 +532,9 @@ to HTTP/S Helm repositories.
537
532
538
533
# ## Suspend
539
534
535
+ **Note:** This field is not applicable to [OCI Helm
536
+ Repositories](#helm-oci-repository).
537
+
540
538
` .spec.suspend` is an optional field to suspend the reconciliation of a
541
539
HelmRepository. When set to `true`, the controller will stop reconciling the
542
540
HelmRepository, and changes to the resource or the Helm repository index will
@@ -547,6 +545,10 @@ For practical information, see
547
545
[suspending and resuming](#suspending-and-resuming).
548
546
549
547
# # Working with HelmRepositories
548
+
549
+ **Note:** This section does not apply to [OCI Helm
550
+ Repositories](#helm-oci-repository), being a data container, once created, they
551
+ are ready to used by [HelmCharts](helmcharts.md).
550
552
551
553
# ## Triggering a reconcile
552
554
@@ -648,6 +650,10 @@ flux resume source helm <repository-name>
648
650
649
651
# ## Debugging a HelmRepository
650
652
653
+ **Note:** This section does not apply to [OCI Helm
654
+ Repositories](#helm-oci-repository), being a data container, they are static
655
+ objects that don't require debugging if valid.
656
+
651
657
There are several ways to gather information about a HelmRepository for debugging
652
658
purposes.
653
659
@@ -713,9 +719,11 @@ specific HelmRepository, e.g. `flux logs --level=error --kind=HelmRepository --n
713
719
714
720
# # HelmRepository Status
715
721
716
- # ## Artifact
722
+ **Note:** This section does not apply to [OCI Helm
723
+ Repositories](#helm-oci-repository), they do not contain any information in the
724
+ status.
717
725
718
- **Note:** This section does not apply to [OCI Helm Repositories](#helm-oci-repository), they do not emit artifacts.
726
+ # ## Artifact
719
727
720
728
The HelmRepository reports the last fetched repository index as an Artifact
721
729
object in the `.status.artifact` of the resource.
@@ -757,9 +765,6 @@ and reports `Reconciling` and `Stalled` conditions where applicable to
757
765
provide better (timeout) support to solutions polling the HelmRepository to become
758
766
` Ready` .
759
767
760
- OCI Helm repositories use only `Reconciling`, `Ready`, `FetchFailed`, and `Stalled`
761
- condition types.
762
-
763
768
# ### Reconciling HelmRepository
764
769
765
770
The source-controller marks a HelmRepository as _reconciling_ when one of the following
0 commit comments