fluxcd
/
source-controller
mirror of https://github.com/fluxcd/source-controller.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: document Bucket support HelmChart

This commit is contained in:
Hidde Beydals 2020-09-21 12:38:53 +02:00
parent 1798b200c9
commit 8cdb821946
4 changed files with 23 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
api/v1alpha1/helmchart_types.go
View File

@ -30,7 +30,7 @@ type HelmChartSpec struct {
Chart string `json:"chart"` Chart string `json:"chart"`
// The chart version semver expression, ignored for charts from GitRepository // The chart version semver expression, ignored for charts from GitRepository
// sources. Defaults to latest when omitted. // and Bucket sources. Defaults to latest when omitted.
// +optional // +optional
Version string `json:"version,omitempty"` Version string `json:"version,omitempty"`

2
config/crd/bases/source.toolkit.fluxcd.io_helmcharts.yaml
View File

@ -92,7 +92,7 @@ spec:
type: string type: string
version: version:
description: The chart version semver expression, ignored for charts description: The chart version semver expression, ignored for charts
from GitRepository sources. Defaults to latest when omitted. from GitRepository and Bucket sources. Defaults to latest when omitted.
type: string type: string
required: required:
- chart - chart

4
docs/api/source.md
View File

@ -459,7 +459,7 @@ string
<td> <td>
<em>(Optional)</em> <em>(Optional)</em>
<p>The chart version semver expression, ignored for charts from GitRepository <p>The chart version semver expression, ignored for charts from GitRepository
sources. Defaults to latest when omitted.</p> and Bucket sources. Defaults to latest when omitted.</p>
</td> </td>
</tr> </tr>
<tr> <tr>
@ -1292,7 +1292,7 @@ string
<td> <td>
<em>(Optional)</em> <em>(Optional)</em>
<p>The chart version semver expression, ignored for charts from GitRepository <p>The chart version semver expression, ignored for charts from GitRepository
sources. Defaults to latest when omitted.</p> and Bucket sources. Defaults to latest when omitted.</p>
</td> </td>
</tr> </tr>
<tr> <tr>

22
docs/spec/v1alpha1/helmcharts.md
View File

@ -16,7 +16,7 @@ type HelmChartSpec struct {
Chart string `json:"chart"` Chart string `json:"chart"`
// The chart version semver expression, ignored for charts from GitRepository // The chart version semver expression, ignored for charts from GitRepository
// sources. Defaults to latest when omitted. // and Bucket sources. Defaults to latest when omitted.
// +optional // +optional
Version string `json:"version,omitempty"` Version string `json:"version,omitempty"`
@ -40,8 +40,8 @@ type LocalHelmChartSourceReference struct {
// +optional // +optional
APIVersion string `json:"apiVersion,omitempty"` APIVersion string `json:"apiVersion,omitempty"`
// Kind of the referent, valid values are ('HelmRepository', 'GitRepository'). // Kind of the referent, valid values are ('HelmRepository', 'GitRepository', 'Bucket').
// +kubebuilder:validation:Enum=HelmRepository;GitRepository // +kubebuilder:validation:Enum=HelmRepository;GitRepository;Bucket
// +required // +required
Kind string `json:"kind"` Kind string `json:"kind"`
@ -141,6 +141,22 @@ spec:
interval: 10m interval: 10m
``` ```
Check a S3 compatible bucket every ten minutes for a new `version` in the
`Chart.yaml`, and package a new chart if the revision differs:
```yaml
apiVersion: source.toolkit.fluxcd.io/v1alpha1
kind: HelmChart
metadata:
name: podinfo
spec:
chart: ./podinfo
sourceRef:
name: charts
kind: Bucket
interval: 10m
```
## Status examples ## Status examples
Successful chart pull: Successful chart pull: