Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@alex-berger
alex-berger committed Feb 2, 2021
1 parent 1db3c55 commit 1ce5ee3
Showing 1 changed file with 215 additions and 8 deletions.
223 changes: 215 additions & 8 deletions docs/api/helmrelease.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -422,6 +422,58 @@ string
<h3 id="helm.toolkit.fluxcd.io/v2beta1.DeploymentAction">DeploymentAction
</h3>
<p>DeploymentAction defines a consistent interface for Install and Upgrade.</p>
<h3 id="helm.toolkit.fluxcd.io/v2beta1.Gvk">Gvk
</h3>
<p>
(<em>Appears on:</em>
<a href="#helm.toolkit.fluxcd.io/v2beta1.Selector">Selector</a>)
</p>
<p>Gvk identifies a Kubernetes API type.
<a href="https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md">https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md</a></p>
<div class="md-typeset__scrollwrap">
<div class="md-typeset__table">
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>group</code><br>
<em>
string
</em>
</td>
<td>
</td>
</tr>
<tr>
<td>
<code>version</code><br>
<em>
string
</em>
</td>
<td>
</td>
</tr>
<tr>
<td>
<code>kind</code><br>
<em>
string
</em>
</td>
<td>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<h3 id="helm.toolkit.fluxcd.io/v2beta1.HelmChartTemplate">HelmChartTemplate
</h3>
<p>
Expand Down Expand Up @@ -1062,6 +1114,73 @@ state. It is reset after a successful reconciliation.</p>
</table>
</div>
</div>
<h3 id="helm.toolkit.fluxcd.io/v2beta1.Image">Image
</h3>
<p>
(<em>Appears on:</em>
<a href="#helm.toolkit.fluxcd.io/v2beta1.Kustomize">Kustomize</a>)
</p>
<p>Image contains an image name, a new name, a new tag or digest,
which will replace the original name and tag.</p>
<div class="md-typeset__scrollwrap">
<div class="md-typeset__table">
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>name</code><br>
<em>
string
</em>
</td>
<td>
<p>Name is a tag-less image name.</p>
</td>
</tr>
<tr>
<td>
<code>newName</code><br>
<em>
string
</em>
</td>
<td>
<p>NewName is the value used to replace the original name.</p>
</td>
</tr>
<tr>
<td>
<code>newTag</code><br>
<em>
string
</em>
</td>
<td>
<p>NewTag is the value used to replace the original tag.</p>
</td>
</tr>
<tr>
<td>
<code>digest</code><br>
<em>
string
</em>
</td>
<td>
<p>Digest is the value used to replace the original image tag.
If digest is present NewTag value is ignored.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<h3 id="helm.toolkit.fluxcd.io/v2beta1.Install">Install
</h3>
<p>
Expand Down Expand Up @@ -1331,21 +1450,23 @@ the HelmRelease.</p>
<td>
<code>patchesJson6902</code><br>
<em>
<a href="#helm.toolkit.fluxcd.io/v2beta1.PatcheJSON6902">
[]PatcheJSON6902
<a href="#helm.toolkit.fluxcd.io/v2beta1.PatchJSON6902">
[]PatchJSON6902
</a>
</em>
</td>
<td>
<em>(Optional)</em>
<p>Json 6902 patches, defined as inline YAML objects.</p>
<p>JSON 6902 patches, defined as inline YAML objects.</p>
</td>
</tr>
<tr>
<td>
<code>images</code><br>
<em>
[]sigs.k8s.io/kustomize/api/types.Image
<a href="#helm.toolkit.fluxcd.io/v2beta1.Image">
[]Image
</a>
</em>
</td>
<td>
Expand All @@ -1359,13 +1480,13 @@ patch, but this operator is simpler to specify.</p>
</table>
</div>
</div>
<h3 id="helm.toolkit.fluxcd.io/v2beta1.PatcheJSON6902">PatcheJSON6902
<h3 id="helm.toolkit.fluxcd.io/v2beta1.PatchJSON6902">PatchJSON6902
</h3>
<p>
(<em>Appears on:</em>
<a href="#helm.toolkit.fluxcd.io/v2beta1.Kustomize">Kustomize</a>)
</p>
<p>PatcheJSON6902 JSON 6902 patches</p>
<p>PatchJSON6902 contains a JSON patch and the target it applies to.</p>
<div class="md-typeset__scrollwrap">
<div class="md-typeset__table">
<table>
Expand Down Expand Up @@ -1393,11 +1514,13 @@ patch, but this operator is simpler to specify.</p>
<td>
<code>target</code><br>
<em>
sigs.k8s.io/kustomize/api/types.Selector
<a href="#helm.toolkit.fluxcd.io/v2beta1.Selector">
Selector
</a>
</em>
</td>
<td>
<p>Target points to the resources that the patch is applied to</p>
<p>Target points to the resources that the patch is applied to.</p>
</td>
</tr>
</tbody>
Expand Down Expand Up @@ -1551,6 +1674,90 @@ rollback action when it fails.</p>
</table>
</div>
</div>
<h3 id="helm.toolkit.fluxcd.io/v2beta1.Selector">Selector
</h3>
<p>
(<em>Appears on:</em>
<a href="#helm.toolkit.fluxcd.io/v2beta1.PatchJSON6902">PatchJSON6902</a>)
</p>
<p>Selector specifies a set of resources.
Any resource that matches intersection of all conditions
is included in this set.</p>
<div class="md-typeset__scrollwrap">
<div class="md-typeset__table">
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>Gvk</code><br>
<em>
<a href="#helm.toolkit.fluxcd.io/v2beta1.Gvk">
Gvk
</a>
</em>
</td>
<td>
<p>
(Members of <code>Gvk</code> are embedded into this type.)
</p>
</td>
</tr>
<tr>
<td>
<code>namespace</code><br>
<em>
string
</em>
</td>
<td>
</td>
</tr>
<tr>
<td>
<code>name</code><br>
<em>
string
</em>
</td>
<td>
</td>
</tr>
<tr>
<td>
<code>annotationSelector</code><br>
<em>
string
</em>
</td>
<td>
<p>AnnotationSelector is a string that follows the label selection expression
<a href="https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api">https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api</a>
It matches with the resource annotations.</p>
</td>
</tr>
<tr>
<td>
<code>labelSelector</code><br>
<em>
string
</em>
</td>
<td>
<p>LabelSelector is a string that follows the label selection expression
<a href="https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api">https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api</a>
It matches with the resource labels.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<h3 id="helm.toolkit.fluxcd.io/v2beta1.Test">Test
</h3>
<p>
Expand Down

0 comments on commit 1ce5ee3

Please sign in to comment.