Skip to content

Commit 8cdb821

Browse files
committed
docs: document Bucket support HelmChart
1 parent 1798b20 commit 8cdb821

File tree

4 files changed

+23
-7
lines changed

4 files changed

+23
-7
lines changed

api/v1alpha1/helmchart_types.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ type HelmChartSpec struct {
3030
Chart string `json:"chart"`
3131

3232
// The chart version semver expression, ignored for charts from GitRepository
33-
// sources. Defaults to latest when omitted.
33+
// and Bucket sources. Defaults to latest when omitted.
3434
// +optional
3535
Version string `json:"version,omitempty"`
3636

config/crd/bases/source.toolkit.fluxcd.io_helmcharts.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ spec:
9292
type: string
9393
version:
9494
description: The chart version semver expression, ignored for charts
95-
from GitRepository sources. Defaults to latest when omitted.
95+
from GitRepository and Bucket sources. Defaults to latest when omitted.
9696
type: string
9797
required:
9898
- chart

docs/api/source.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -459,7 +459,7 @@ string
459459
<td>
460460
<em>(Optional)</em>
461461
<p>The chart version semver expression, ignored for charts from GitRepository
462-
sources. Defaults to latest when omitted.</p>
462+
and Bucket sources. Defaults to latest when omitted.</p>
463463
</td>
464464
</tr>
465465
<tr>
@@ -1292,7 +1292,7 @@ string
12921292
<td>
12931293
<em>(Optional)</em>
12941294
<p>The chart version semver expression, ignored for charts from GitRepository
1295-
sources. Defaults to latest when omitted.</p>
1295+
and Bucket sources. Defaults to latest when omitted.</p>
12961296
</td>
12971297
</tr>
12981298
<tr>

docs/spec/v1alpha1/helmcharts.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ type HelmChartSpec struct {
1616
Chart string `json:"chart"`
1717

1818
// The chart version semver expression, ignored for charts from GitRepository
19-
// sources. Defaults to latest when omitted.
19+
// and Bucket sources. Defaults to latest when omitted.
2020
// +optional
2121
Version string `json:"version,omitempty"`
2222

@@ -40,8 +40,8 @@ type LocalHelmChartSourceReference struct {
4040
// +optional
4141
APIVersion string `json:"apiVersion,omitempty"`
4242

43-
// Kind of the referent, valid values are ('HelmRepository', 'GitRepository').
44-
// +kubebuilder:validation:Enum=HelmRepository;GitRepository
43+
// Kind of the referent, valid values are ('HelmRepository', 'GitRepository', 'Bucket').
44+
// +kubebuilder:validation:Enum=HelmRepository;GitRepository;Bucket
4545
// +required
4646
Kind string `json:"kind"`
4747

@@ -141,6 +141,22 @@ spec:
141141
interval: 10m
142142
```
143143

144+
Check a S3 compatible bucket every ten minutes for a new `version` in the
145+
`Chart.yaml`, and package a new chart if the revision differs:
146+
147+
```yaml
148+
apiVersion: source.toolkit.fluxcd.io/v1alpha1
149+
kind: HelmChart
150+
metadata:
151+
name: podinfo
152+
spec:
153+
chart: ./podinfo
154+
sourceRef:
155+
name: charts
156+
kind: Bucket
157+
interval: 10m
158+
```
159+
144160
## Status examples
145161

146162
Successful chart pull:

0 commit comments

Comments
 (0)