docs: fix generation of underlying types (#3150)

Signed-off-by: RealAnna <anna.reale@dynatrace.com>
keptn · Mar 1, 2024 · a387a88 · a387a88
1 parent 3d32a42
commit a387a88
Show file tree

Hide file tree

Showing 19 changed files with 336 additions and 105 deletions.
diff --git a/.github/actions/spelling/expect.txt b/.github/actions/spelling/expect.txt
@@ -19,6 +19,7 @@ Analysislog
 analysismetrics
 analysispool
 analysisspec
+analysisstate
 analysisstatus
 analysistypes
 analysisvaluetemplate
@@ -78,6 +79,7 @@ certwebhook
 chainsaw
 Chans
 Checkmarx
+checktype
 clientgoscheme
 cloudevents
 clt
@@ -320,9 +322,11 @@ keptnmetricsprovider
 keptnmetricsproviderlist
 keptnmetricsproviderspec
 keptnmetricstatus
+keptnphase
 keptnprommetrics
 keptnsandbox
 keptnserver
+keptnstate
 keptntask
 keptntaskdefinition
 keptntaskdefinitionlist
@@ -471,6 +475,7 @@ perc
 persistentvolumeclaims
 persistentvolumes
 phaseitem
+phasetraceid
 pid
 pipefail
 poc

diff --git a/.github/scripts/generate-crd-docs/crd-docs-generator-config-lifecycle-v1alpha4.yaml b/.github/scripts/generate-crd-docs/crd-docs-generator-config-lifecycle-v1alpha4.yaml
@@ -2,6 +2,7 @@ processor:
   useRawDocstring: true
   ignoreFields:
     - "TypeMeta$"
+    - "KeptnPhase$"
 render:
   kubernetesVersion: 1.28
   knownTypes:
@@ -11,6 +12,12 @@ render:
     - name: ItemStatus
       package: github.com/keptn/lifecycle-toolkit/lifecycle-operator/apis/lifecycle/v1alpha3
       link: ../v1alpha3/index.md#itemstatus
+    - name: KeptnState
+      package: github.com/keptn/lifecycle-toolkit/lifecycle-operator/apis/lifecycle/v1alpha3/common
+      link: ../v1alpha3/index.md#keptnstate
+    - name: PhaseTraceID
+      package: github.com/keptn/lifecycle-toolkit/lifecycle-operator/apis/lifecycle/v1alpha3/common
+      link: ../v1alpha3/index.md#phasetraceid
     - name: Quantity
       package: "k8s.io/apimachinery/pkg/api/resource"
       link: https://pkg.go.dev/k8s.io/apimachinery/pkg/api/resource#Quantity
@@ -23,3 +30,6 @@ render:
     - name: MapCarrier
       package: "go.opentelemetry.io/otel/propagation"
       link: https://pkg.go.dev/go.opentelemetry.io/otel/propagation#MapCarrier
+    - name: UID
+      package: "k8s.io/apimachinery/pkg/types"
+      link: https://pkg.go.dev/k8s.io/apimachinery@v0.29.2/pkg/types#UID
diff --git a/.github/scripts/generate-crd-docs/crd-docs-generator-config.yaml b/.github/scripts/generate-crd-docs/crd-docs-generator-config.yaml
@@ -4,9 +4,11 @@ processor:
     - "EmptyStatus$"
     - "KeptnEvaluationProvider$"
     - "KeptnEvaluationProviderList$"
+    - "KeptnPhase$"
   ignoreFields:
     - "TypeMeta$"
     - "EmptyStatus$"
+    - "KeptnPhase$"
 render:
   kubernetesVersion: 1.28
   knownTypes:
@@ -22,3 +24,6 @@ render:
     - name: MapCarrier
       package: "go.opentelemetry.io/otel/propagation"
       link: https://pkg.go.dev/go.opentelemetry.io/otel/propagation#MapCarrier
+    - name: UID
+      package: "k8s.io/apimachinery/pkg/types"
+      link: https://pkg.go.dev/k8s.io/apimachinery@v0.29.2/pkg/types#UID
diff --git a/.github/scripts/generate-crd-docs/templates/type.tpl b/.github/scripts/generate-crd-docs/templates/type.tpl
@@ -24,7 +24,7 @@ _Appears in:_
 {{ end -}}
 
 {{ range $type.Members -}}
-| `{{ .Name }}` {{ if .Type.IsAlias }}_{{  markdownRenderTypeLink .Type.UnderlyingType  }}_{{else}}_{{ markdownRenderType .Type }}_{{ end }} | {{ template "type_members" . }} |
+| `{{ .Name }}` _{{ markdownRenderType .Type }}_ | {{ template "type_members" . }} |
 {{- if index .Markers "kubebuilder:default" -}}
 {{- with index (index .Markers "kubebuilder:default") 0 -}}
  {{ .Value -}}

diff --git a/docs/docs/contribute/docs/contrib-guidelines-docs.md b/docs/docs/contribute/docs/contrib-guidelines-docs.md
@@ -53,11 +53,11 @@ that are relevant only to documentation.
   This ensures that, when the sample file is updated,
   your document is also updated.
 
-    For example, to include the `examples/sample-app/version3/app-pre-deploy-eval.yaml` file,
+    For example, to include the `examples/sample-app/version1/app-pre-deploy-eval.yaml` file,
     the syntax is:
 
     ```md
-    {% /* include "examples/sample-app/version-3/app-pre-deploy-eval.yaml" */ %}
+    {% /* include "examples/sample-app/version-1/app-pre-deploy-eval.yaml" */ %}
     ```
 
 * `markdownlint` enforces limits on line length.

diff --git a/docs/docs/guides/evaluations.md b/docs/docs/guides/evaluations.md
@@ -70,7 +70,7 @@ resource contains a list of `objectives`,
 each of which checks whether a defined `KeptnMetric` resource
 meets a defined target value.
 The example
-[app-pre-deploy-eval.yaml](https://github.com/keptn/lifecycle-toolkit/blob/main/examples/sample-app/version-2/app-pre-deploy-eval.yaml)
+[app-pre-deploy-eval.yaml](https://github.com/keptn/lifecycle-toolkit/blob/main/examples/sample-app/version-1/app-pre-deploy-eval.yaml)
 file specifies the `app-pre-deploy-eval-2` evaluation as follows:
 
 ```yaml

diff --git a/docs/docs/reference/api-reference/lifecycle/v1alpha1/index.md b/docs/docs/reference/api-reference/lifecycle/v1alpha1/index.md
@@ -32,6 +32,18 @@ Package v1alpha1 contains API Schema definitions for the lifecycle v1alpha1 API
 
 
 
+#### CheckType
+
+_Underlying type:_ _string_
+
+
+
+_Appears in:_
+- [KeptnEvaluationSpec](#keptnevaluationspec)
+- [KeptnTaskSpec](#keptntaskspec)
+
+
+
 #### ConfigMapReference
 
 
@@ -61,7 +73,7 @@ _Appears in:_
 | Field | Description | Default | Optional |
 | --- | --- | --- | --- |
 | `evaluationDefinitionName` _string_ |  || ✓ |
-| `status` _string_ |  |Pending| ✓ |
+| `status` _[KeptnState](#keptnstate)_ |  |Pending| ✓ |
 | `evaluationName` _string_ |  || ✓ |
 | `startTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta)_ |  || ✓ |
 | `endTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta)_ |  || ✓ |
@@ -79,7 +91,7 @@ _Appears in:_
 | Field | Description | Default | Optional |
 | --- | --- | --- | --- |
 | `value` _string_ |  || x |
-| `status` _string_ |  || x |
+| `status` _[KeptnState](#keptnstate)_ |  || x |
 | `message` _string_ |  || ✓ |
 
 
@@ -130,6 +142,10 @@ _Appears in:_
 | `configMap` _string_ |  || ✓ |
 
 
+
+
+
+
 #### HttpReference
 
 
@@ -293,19 +309,19 @@ _Appears in:_
 
 | Field | Description | Default | Optional |
 | --- | --- | --- | --- |
-| `preDeploymentStatus` _string_ |  |Pending| ✓ |
-| `postDeploymentStatus` _string_ |  |Pending| ✓ |
-| `preDeploymentEvaluationStatus` _string_ |  |Pending| ✓ |
-| `postDeploymentEvaluationStatus` _string_ |  |Pending| ✓ |
-| `workloadOverallStatus` _string_ |  |Pending| ✓ |
+| `preDeploymentStatus` _[KeptnState](#keptnstate)_ |  |Pending| ✓ |
+| `postDeploymentStatus` _[KeptnState](#keptnstate)_ |  |Pending| ✓ |
+| `preDeploymentEvaluationStatus` _[KeptnState](#keptnstate)_ |  |Pending| ✓ |
+| `postDeploymentEvaluationStatus` _[KeptnState](#keptnstate)_ |  |Pending| ✓ |
+| `workloadOverallStatus` _[KeptnState](#keptnstate)_ |  |Pending| ✓ |
 | `workloadStatus` _[WorkloadStatus](#workloadstatus) array_ |  || ✓ |
 | `currentPhase` _string_ |  || ✓ |
 | `preDeploymentTaskStatus` _[TaskStatus](#taskstatus) array_ |  || ✓ |
 | `postDeploymentTaskStatus` _[TaskStatus](#taskstatus) array_ |  || ✓ |
 | `preDeploymentEvaluationTaskStatus` _[EvaluationStatus](#evaluationstatus) array_ |  || ✓ |
 | `postDeploymentEvaluationTaskStatus` _[EvaluationStatus](#evaluationstatus) array_ |  || ✓ |
-| `phaseTraceIDs` _[MapCarrier](https://pkg.go.dev/go.opentelemetry.io/otel/propagation#MapCarrier)_ |  || ✓ |
-| `status` _string_ |  |Pending| ✓ |
+| `phaseTraceIDs` _[PhaseTraceID](#phasetraceid)_ |  || ✓ |
+| `status` _[KeptnState](#keptnstate)_ |  |Pending| ✓ |
 | `startTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta)_ |  || ✓ |
 | `endTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta)_ |  || ✓ |
 
@@ -414,7 +430,7 @@ _Appears in:_
 | `retries` _integer_ |  |10| ✓ |
 | `retryInterval` _[Duration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#duration-v1-meta)_ |  |5s| ✓ |
 | `failAction` _string_ |  || ✓ |
-| `checkType` _string_ |  || ✓ |
+| `checkType` _[CheckType](#checktype)_ |  || ✓ |
 
 
 #### KeptnEvaluationStatus
@@ -430,11 +446,33 @@ _Appears in:_
 | --- | --- | --- | --- |
 | `retryCount` _integer_ |  |0| x |
 | `evaluationStatus` _object (keys:string, values:[EvaluationStatusItem](#evaluationstatusitem))_ |  || x |
-| `overallStatus` _string_ |  |Pending| x |
+| `overallStatus` _[KeptnState](#keptnstate)_ |  |Pending| x |
 | `startTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta)_ |  || ✓ |
 | `endTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta)_ |  || ✓ |
 
 
+
+
+
+
+#### KeptnState
+
+_Underlying type:_ _string_
+
+KeptnState  is a string containing current Phase state  (Progressing/Succeeded/Failed/Unknown/Pending/Cancelled)
+
+_Appears in:_
+- [EvaluationStatus](#evaluationstatus)
+- [EvaluationStatusItem](#evaluationstatusitem)
+- [KeptnAppVersionStatus](#keptnappversionstatus)
+- [KeptnEvaluationStatus](#keptnevaluationstatus)
+- [KeptnTaskStatus](#keptntaskstatus)
+- [KeptnWorkloadInstanceStatus](#keptnworkloadinstancestatus)
+- [TaskStatus](#taskstatus)
+- [WorkloadStatus](#workloadstatus)
+
+
+
 #### KeptnTask
 
 
@@ -550,7 +588,7 @@ _Appears in:_
 | `context` _[TaskContext](#taskcontext)_ |  || x |
 | `parameters` _[TaskParameters](#taskparameters)_ |  || ✓ |
 | `secureParameters` _[SecureParameters](#secureparameters)_ |  || ✓ |
-| `checkType` _string_ |  || ✓ |
+| `checkType` _[CheckType](#checktype)_ |  || ✓ |
 
 
 #### KeptnTaskStatus
@@ -565,7 +603,7 @@ _Appears in:_
 | Field | Description | Default | Optional |
 | --- | --- | --- | --- |
 | `jobName` _string_ |  || ✓ |
-| `status` _string_ |  |Pending| ✓ |
+| `status` _[KeptnState](#keptnstate)_ |  |Pending| ✓ |
 | `message` _string_ |  || ✓ |
 | `startTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta)_ |  || ✓ |
 | `endTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta)_ |  || ✓ |
@@ -657,20 +695,20 @@ _Appears in:_
 
 | Field | Description | Default | Optional |
 | --- | --- | --- | --- |
-| `preDeploymentStatus` _string_ |  |Pending| ✓ |
-| `deploymentStatus` _string_ |  |Pending| ✓ |
-| `preDeploymentEvaluationStatus` _string_ |  |Pending| ✓ |
-| `postDeploymentEvaluationStatus` _string_ |  |Pending| ✓ |
-| `postDeploymentStatus` _string_ |  |Pending| ✓ |
+| `preDeploymentStatus` _[KeptnState](#keptnstate)_ |  |Pending| ✓ |
+| `deploymentStatus` _[KeptnState](#keptnstate)_ |  |Pending| ✓ |
+| `preDeploymentEvaluationStatus` _[KeptnState](#keptnstate)_ |  |Pending| ✓ |
+| `postDeploymentEvaluationStatus` _[KeptnState](#keptnstate)_ |  |Pending| ✓ |
+| `postDeploymentStatus` _[KeptnState](#keptnstate)_ |  |Pending| ✓ |
 | `preDeploymentTaskStatus` _[TaskStatus](#taskstatus) array_ |  || ✓ |
 | `postDeploymentTaskStatus` _[TaskStatus](#taskstatus) array_ |  || ✓ |
 | `preDeploymentEvaluationTaskStatus` _[EvaluationStatus](#evaluationstatus) array_ |  || ✓ |
 | `postDeploymentEvaluationTaskStatus` _[EvaluationStatus](#evaluationstatus) array_ |  || ✓ |
 | `startTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta)_ |  || ✓ |
 | `endTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta)_ |  || ✓ |
 | `currentPhase` _string_ |  || ✓ |
-| `phaseTraceIDs` _[MapCarrier](https://pkg.go.dev/go.opentelemetry.io/otel/propagation#MapCarrier)_ |  || ✓ |
-| `status` _string_ |  |Pending| ✓ |
+| `phaseTraceIDs` _[PhaseTraceID](#phasetraceid)_ |  || ✓ |
+| `status` _[KeptnState](#keptnstate)_ |  |Pending| ✓ |
 
 
 #### KeptnWorkloadList
@@ -757,19 +795,31 @@ _Appears in:_
 | `evaluationTarget` _string_ |  || x |
 
 
-#### ResourceReference
+#### PhaseTraceID
+
+_Underlying type:_ _[MapCarrier](https://pkg.go.dev/go.opentelemetry.io/otel/propagation#MapCarrier)_
+
+PhaseTraceID is a map storing TraceIDs of OpenTelemetry spans in lifecycle phases
+
+_Appears in:_
+- [KeptnAppVersionStatus](#keptnappversionstatus)
+- [KeptnWorkloadInstanceStatus](#keptnworkloadinstancestatus)
 
 
 
+#### ResourceReference
+
+
 
+ResourceReference represents the parent resource of Workload
 
 _Appears in:_
 - [KeptnWorkloadInstanceSpec](#keptnworkloadinstancespec)
 - [KeptnWorkloadSpec](#keptnworkloadspec)
 
 | Field | Description | Default | Optional |
 | --- | --- | --- | --- |
-| `uid` _string_ |  || x |
+| `uid` _[UID](https://pkg.go.dev/k8s.io/apimachinery@v0.29.2/pkg/types#UID)_ |  || x |
 | `kind` _string_ |  || x |
 | `name` _string_ |  || x |
 
@@ -789,6 +839,8 @@ _Appears in:_
 | `secret` _string_ |  || ✓ |
 
 
+
+
 #### TaskContext
 
 
@@ -836,7 +888,7 @@ _Appears in:_
 | Field | Description | Default | Optional |
 | --- | --- | --- | --- |
 | `taskDefinitionName` _string_ |  || ✓ |
-| `status` _string_ |  |Pending| ✓ |
+| `status` _[KeptnState](#keptnstate)_ |  |Pending| ✓ |
 | `taskName` _string_ |  || ✓ |
 | `startTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta)_ |  || ✓ |
 | `endTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta)_ |  || ✓ |
@@ -854,6 +906,6 @@ _Appears in:_
 | Field | Description | Default | Optional |
 | --- | --- | --- | --- |
 | `workload` _[KeptnWorkloadRef](#keptnworkloadref)_ |  || ✓ |
-| `status` _string_ |  |Pending| ✓ |
+| `status` _[KeptnState](#keptnstate)_ |  |Pending| ✓ |