From 1ce5ee380b6d7ae286bcd882500a2d95432cb4f8 Mon Sep 17 00:00:00 2001 From: Alexander Berger Date: Tue, 2 Feb 2021 13:35:24 +0100 Subject: [PATCH] Update docs --- docs/api/helmrelease.md | 223 ++++++++++++++++++++++++++++++++++++++-- 1 file changed, 215 insertions(+), 8 deletions(-) diff --git a/docs/api/helmrelease.md b/docs/api/helmrelease.md index a92655d9e..431355bbe 100644 --- a/docs/api/helmrelease.md +++ b/docs/api/helmrelease.md @@ -422,6 +422,58 @@ string

DeploymentAction

DeploymentAction defines a consistent interface for Install and Upgrade.

+

Gvk +

+

+(Appears on: +Selector) +

+

Gvk identifies a Kubernetes API type. +https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md

+
+
+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+group
+ +string + +		 +
+version
+ +string + +		 +
+kind
+ +string + +		 +
+
+

HelmChartTemplate

@@ -1062,6 +1114,73 @@ state. It is reset after a successful reconciliation.

+

Image +

+

+(Appears on: +Kustomize) +

+

Image contains an image name, a new name, a new tag or digest, +which will replace the original name and tag.

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+name
+ +string + +		 +

Name is a tag-less image name.

+
+newName
+ +string + +		 +

NewName is the value used to replace the original name.

+
+newTag
+ +string + +		 +

NewTag is the value used to replace the original tag.

+
+digest
+ +string + +		 +

Digest is the value used to replace the original image tag. +If digest is present NewTag value is ignored.

+
+
+

Install

@@ -1331,21 +1450,23 @@ the HelmRelease.

patchesJson6902
- -[]PatcheJSON6902 + +[]PatchJSON6902 (Optional) -

Json 6902 patches, defined as inline YAML objects.

+

JSON 6902 patches, defined as inline YAML objects.

images
-[]sigs.k8s.io/kustomize/api/types.Image + +[]Image + @@ -1359,13 +1480,13 @@ patch, but this operator is simpler to specify.

-

PatcheJSON6902 +

PatchJSON6902

(Appears on: Kustomize)

-

PatcheJSON6902 JSON 6902 patches

+

PatchJSON6902 contains a JSON patch and the target it applies to.

@@ -1393,11 +1514,13 @@ patch, but this operator is simpler to specify.

@@ -1551,6 +1674,90 @@ rollback action when it fails.

target
-sigs.k8s.io/kustomize/api/types.Selector + +Selector + 		-

Target points to the resources that the patch is applied to

+

Target points to the resources that the patch is applied to.
+

Selector +

+

+(Appears on: +PatchJSON6902) +

+

Selector specifies a set of resources. +Any resource that matches intersection of all conditions +is included in this set.

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+Gvk
+ + +Gvk + + +		 +

+(Members of Gvk are embedded into this type.) +

+
+namespace
+ +string + +		 +
+name
+ +string + +		 +
+annotationSelector
+ +string + +		 +

AnnotationSelector is a string that follows the label selection expression +https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api +It matches with the resource annotations.

+
+labelSelector
+ +string + +		 +

LabelSelector is a string that follows the label selection expression +https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api +It matches with the resource labels.

+
+
+

Test