Add link to relevant documentation (vmware-tanzu#1126)

* Add link in CRD definition to relevant documentation
jonasrosland · Jan 25, 2023 · 366c8f8 · 366c8f8
1 parent 6be1aa3
commit 366c8f8
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 21 deletions.
diff --git a/config/crd/bases/carto.run_clusterconfigtemplates.yaml b/config/crd/bases/carto.run_clusterconfigtemplates.yaml
@@ -57,8 +57,8 @@ spec:
                   is specified in jsonpath format, eg: .data'
                 type: string
               healthRule:
-                description: HealthRule specifies rubric for determining the health
-                  of a resource stamped by this template
+                description: 'HealthRule specifies rubric for determining the health
+                  of a resource stamped by this template. See: https://cartographer.sh/docs/latest/health-rules/'
                 properties:
                   alwaysHealthy:
                     description: AlwaysHealthy being set indicates the resource should
@@ -207,10 +207,10 @@ spec:
                 type: object
               lifecycle:
                 default: mutable
-                description: Lifecycle specifies whether template modifications should
+                description: 'Lifecycle specifies whether template modifications should
                   result in originally created objects being updated (`mutable`) or
                   in new objects created alongside original objects (`immutable` or
-                  `tekton`).
+                  `tekton`). See: https://cartographer.sh/docs/latest/lifecycle/'
                 enum:
                 - mutable
                 - immutable

diff --git a/config/crd/bases/carto.run_clusterdeploymenttemplates.yaml b/config/crd/bases/carto.run_clusterdeploymenttemplates.yaml
@@ -51,8 +51,8 @@ spec:
             description: 'Spec describes the deployment template. More info: https://cartographer.sh/docs/latest/reference/template/#clusterdeploymenttemplate'
             properties:
               healthRule:
-                description: HealthRule specifies rubric for determining the health
-                  of a resource stamped by this template
+                description: 'HealthRule specifies rubric for determining the health
+                  of a resource stamped by this template. See: https://cartographer.sh/docs/latest/health-rules/'
                 properties:
                   alwaysHealthy:
                     description: AlwaysHealthy being set indicates the resource should
@@ -201,10 +201,10 @@ spec:
                 type: object
               lifecycle:
                 default: mutable
-                description: Lifecycle specifies whether template modifications should
+                description: 'Lifecycle specifies whether template modifications should
                   result in originally created objects being updated (`mutable`) or
                   in new objects created alongside original objects (`immutable` or
-                  `tekton`).
+                  `tekton`). See: https://cartographer.sh/docs/latest/lifecycle/'
                 enum:
                 - mutable
                 - immutable

diff --git a/config/crd/bases/carto.run_clusterimagetemplates.yaml b/config/crd/bases/carto.run_clusterimagetemplates.yaml
@@ -51,8 +51,8 @@ spec:
             description: 'Spec describes the image template. More info: https://cartographer.sh/docs/latest/reference/template/#clusterimagetemplate'
             properties:
               healthRule:
-                description: HealthRule specifies rubric for determining the health
-                  of a resource stamped by this template
+                description: 'HealthRule specifies rubric for determining the health
+                  of a resource stamped by this template. See: https://cartographer.sh/docs/latest/health-rules/'
                 properties:
                   alwaysHealthy:
                     description: AlwaysHealthy being set indicates the resource should
@@ -208,10 +208,10 @@ spec:
                 type: string
               lifecycle:
                 default: mutable
-                description: Lifecycle specifies whether template modifications should
+                description: 'Lifecycle specifies whether template modifications should
                   result in originally created objects being updated (`mutable`) or
                   in new objects created alongside original objects (`immutable` or
-                  `tekton`).
+                  `tekton`). See: https://cartographer.sh/docs/latest/lifecycle/'
                 enum:
                 - mutable
                 - immutable

diff --git a/config/crd/bases/carto.run_clustersourcetemplates.yaml b/config/crd/bases/carto.run_clustersourcetemplates.yaml
@@ -51,8 +51,8 @@ spec:
             description: 'Spec describes the source template. More info: https://cartographer.sh/docs/latest/reference/template/#clustersourcetemplate'
             properties:
               healthRule:
-                description: HealthRule specifies rubric for determining the health
-                  of a resource stamped by this template
+                description: 'HealthRule specifies rubric for determining the health
+                  of a resource stamped by this template. See: https://cartographer.sh/docs/latest/health-rules/'
                 properties:
                   alwaysHealthy:
                     description: AlwaysHealthy being set indicates the resource should
@@ -201,10 +201,10 @@ spec:
                 type: object
               lifecycle:
                 default: mutable
-                description: Lifecycle specifies whether template modifications should
+                description: 'Lifecycle specifies whether template modifications should
                   result in originally created objects being updated (`mutable`) or
                   in new objects created alongside original objects (`immutable` or
-                  `tekton`).
+                  `tekton`). See: https://cartographer.sh/docs/latest/lifecycle/'
                 enum:
                 - mutable
                 - immutable

diff --git a/config/crd/bases/carto.run_clustertemplates.yaml b/config/crd/bases/carto.run_clustertemplates.yaml
@@ -51,8 +51,8 @@ spec:
             description: 'Spec describes the template. More info: https://cartographer.sh/docs/latest/reference/template/#clustertemplate'
             properties:
               healthRule:
-                description: HealthRule specifies rubric for determining the health
-                  of a resource stamped by this template
+                description: 'HealthRule specifies rubric for determining the health
+                  of a resource stamped by this template. See: https://cartographer.sh/docs/latest/health-rules/'
                 properties:
                   alwaysHealthy:
                     description: AlwaysHealthy being set indicates the resource should
@@ -201,10 +201,10 @@ spec:
                 type: object
               lifecycle:
                 default: mutable
-                description: Lifecycle specifies whether template modifications should
+                description: 'Lifecycle specifies whether template modifications should
                   result in originally created objects being updated (`mutable`) or
                   in new objects created alongside original objects (`immutable` or
-                  `tekton`).
+                  `tekton`). See: https://cartographer.sh/docs/latest/lifecycle/'
                 enum:
                 - mutable
                 - immutable

diff --git a/pkg/apis/v1alpha1/cluster_template.go b/pkg/apis/v1alpha1/cluster_template.go
@@ -65,13 +65,15 @@ type TemplateSpec struct {
 	Params TemplateParams `json:"params,omitempty"`
 
 	// HealthRule specifies rubric for determining the health of a resource
-	// stamped by this template
+	// stamped by this template.
+	// See: https://cartographer.sh/docs/latest/health-rules/
 	// +optional
 	HealthRule *HealthRule `json:"healthRule,omitempty"`
 
 	// Lifecycle specifies whether template modifications should result in originally
 	// created objects being updated (`mutable`) or in new objects created alongside
 	// original objects (`immutable` or `tekton`).
+	// See: https://cartographer.sh/docs/latest/lifecycle/
 	// +kubebuilder:validation:Enum=mutable;immutable;tekton
 	// +kubebuilder:default="mutable"
 	Lifecycle string `json:"lifecycle,omitempty"`