Skip to content

Commit 8ab19c9

Browse files
committed
docs: Add API spec for Helm v1
Signed-off-by: Stefan Prodan <stefan.prodan@gmail.com>
1 parent f85bc17 commit 8ab19c9

File tree

9 files changed

+1861
-21
lines changed

9 files changed

+1861
-21
lines changed

README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,13 @@ and is a core component of the [GitOps toolkit](https://fluxcd.io/flux/component
1616

1717
## APIs
1818

19-
| Kind | API Version |
20-
|---------------------------------------------------------|------------------------------------|
21-
| [GitRepository](docs/spec/v1/gitrepositories.md) | `source.toolkit.fluxcd.io/v1` |
22-
| [OCIRepository](docs/spec/v1beta2/ocirepositories.md) | `source.toolkit.fluxcd.io/v1beta2` |
23-
| [HelmRepository](docs/spec/v1beta2/helmrepositories.md) | `source.toolkit.fluxcd.io/v1beta2` |
24-
| [HelmChart](docs/spec/v1beta2/helmcharts.md) | `source.toolkit.fluxcd.io/v1beta2` |
25-
| [Bucket](docs/spec/v1beta2/buckets.md) | `source.toolkit.fluxcd.io/v1beta2` |
19+
| Kind | API Version |
20+
|-------------------------------------------------------|------------------------------------|
21+
| [GitRepository](docs/spec/v1/gitrepositories.md) | `source.toolkit.fluxcd.io/v1` |
22+
| [OCIRepository](docs/spec/v1beta2/ocirepositories.md) | `source.toolkit.fluxcd.io/v1beta2` |
23+
| [HelmRepository](docs/spec/v1/helmrepositories.md) | `source.toolkit.fluxcd.io/v1` |
24+
| [HelmChart](docs/spec/v1/helmcharts.md) | `source.toolkit.fluxcd.io/v1` |
25+
| [Bucket](docs/spec/v1beta2/buckets.md) | `source.toolkit.fluxcd.io/v1beta2` |
2626

2727
## Features
2828

api/v1/helmchart_types.go

+11
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,11 @@ type HelmChartSpec struct {
7878
// +deprecated
7979
ValuesFile string `json:"valuesFile,omitempty"`
8080

81+
// IgnoreMissingValuesFiles controls whether to silently ignore missing values
82+
// files rather than failing.
83+
// +optional
84+
IgnoreMissingValuesFiles bool `json:"ignoreMissingValuesFiles,omitempty"`
85+
8186
// Suspend tells the controller to suspend the reconciliation of this
8287
// source.
8388
// +optional
@@ -141,6 +146,12 @@ type HelmChartStatus struct {
141146
// +optional
142147
ObservedChartName string `json:"observedChartName,omitempty"`
143148

149+
// ObservedValuesFiles are the observed value files of the last successful
150+
// reconciliation.
151+
// It matches the chart in the last successfully reconciled artifact.
152+
// +optional
153+
ObservedValuesFiles []string `json:"observedValuesFiles,omitempty"`
154+
144155
// Conditions holds the conditions for the HelmChart.
145156
// +optional
146157
Conditions []metav1.Condition `json:"conditions,omitempty"`

api/v1/zz_generated.deepcopy.go

+5
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

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

+13
Original file line numberDiff line numberDiff line change
@@ -745,6 +745,11 @@ spec:
745745
Chart is the name or path the Helm chart is available at in the
746746
SourceRef.
747747
type: string
748+
ignoreMissingValuesFiles:
749+
description: |-
750+
IgnoreMissingValuesFiles controls whether to silently ignore missing values
751+
files rather than failing.
752+
type: boolean
748753
interval:
749754
description: |-
750755
Interval at which the HelmChart SourceRef is checked for updates.
@@ -1020,6 +1025,14 @@ spec:
10201025
ObservedSourceArtifactRevision is the last observed Artifact.Revision
10211026
of the HelmChartSpec.SourceRef.
10221027
type: string
1028+
observedValuesFiles:
1029+
description: |-
1030+
ObservedValuesFiles are the observed value files of the last successful
1031+
reconciliation.
1032+
It matches the chart in the last successfully reconciled artifact.
1033+
items:
1034+
type: string
1035+
type: array
10231036
url:
10241037
description: |-
10251038
URL is the dynamic fetch link for the latest Artifact.

docs/api/v1/source.md

+40
Original file line numberDiff line numberDiff line change
@@ -408,6 +408,19 @@ is merged before the ValuesFiles items. Ignored when omitted.</p>
408408
</tr>
409409
<tr>
410410
<td>
411+
<code>ignoreMissingValuesFiles</code><br>
412+
<em>
413+
bool
414+
</em>
415+
</td>
416+
<td>
417+
<em>(Optional)</em>
418+
<p>IgnoreMissingValuesFiles controls whether to silently ignore missing values
419+
files rather than failing.</p>
420+
</td>
421+
</tr>
422+
<tr>
423+
<td>
411424
<code>suspend</code><br>
412425
<em>
413426
bool
@@ -1492,6 +1505,19 @@ is merged before the ValuesFiles items. Ignored when omitted.</p>
14921505
</tr>
14931506
<tr>
14941507
<td>
1508+
<code>ignoreMissingValuesFiles</code><br>
1509+
<em>
1510+
bool
1511+
</em>
1512+
</td>
1513+
<td>
1514+
<em>(Optional)</em>
1515+
<p>IgnoreMissingValuesFiles controls whether to silently ignore missing values
1516+
files rather than failing.</p>
1517+
</td>
1518+
</tr>
1519+
<tr>
1520+
<td>
14951521
<code>suspend</code><br>
14961522
<em>
14971523
bool
@@ -1599,6 +1625,20 @@ resolved chart reference.</p>
15991625
</tr>
16001626
<tr>
16011627
<td>
1628+
<code>observedValuesFiles</code><br>
1629+
<em>
1630+
[]string
1631+
</em>
1632+
</td>
1633+
<td>
1634+
<em>(Optional)</em>
1635+
<p>ObservedValuesFiles are the observed value files of the last successful
1636+
reconciliation.
1637+
It matches the chart in the last successfully reconciled artifact.</p>
1638+
</td>
1639+
</tr>
1640+
<tr>
1641+
<td>
16021642
<code>conditions</code><br>
16031643
<em>
16041644
<a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Condition">

docs/spec/v1/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ This is the v1 API specification for defining the desired state sources of Kuber
66

77
* Source kinds:
88
+ [GitRepository](gitrepositories.md)
9+
+ [HelmRepository](helmrepositories.md)
10+
+ [HelmChart](helmcharts.md)
911

1012
## Implementation
1113

0 commit comments

Comments
 (0)