docs: fix phases

Signed-off-by: RealAnna <[email protected]>
keptn · Feb 29, 2024 · 5f8ae9d · 5f8ae9d
1 parent 4e9daa7
commit 5f8ae9d
Show file tree

Hide file tree

Showing 16 changed files with 86 additions and 24 deletions.
diff --git a/docs/docs/reference/api-reference/lifecycle/v1alpha1/index.md b/docs/docs/reference/api-reference/lifecycle/v1alpha1/index.md
@@ -10,6 +10,7 @@ Reference information for lifecycle.keptn.sh/v1alpha1
 
 ## lifecycle.keptn.sh/v1alpha1
 
+Package v1alpha1 contains API Schema definitions for the lifecycle v1alpha1 API group
 
 
 ### Resource Types
@@ -315,7 +316,7 @@ _Appears in:_
 | `postDeploymentEvaluationStatus` _[KeptnState](#keptnstate)_ |  |Pending| ✓ |
 | `workloadOverallStatus` _[KeptnState](#keptnstate)_ |  |Pending| ✓ |
 | `workloadStatus` _[WorkloadStatus](#workloadstatus) array_ |  || ✓ |
-| `currentPhase` _string_ |  || ✓ |
+| `currentPhase` _[KeptnPhase](#keptnphase)_ |  || ✓ |
 | `preDeploymentTaskStatus` _[TaskStatus](#taskstatus) array_ |  || ✓ |
 | `postDeploymentTaskStatus` _[TaskStatus](#taskstatus) array_ |  || ✓ |
 | `preDeploymentEvaluationTaskStatus` _[EvaluationStatus](#evaluationstatus) array_ |  || ✓ |
@@ -453,6 +454,19 @@ _Appears in:_
 
 
 
+#### KeptnPhase
+
+_Underlying type:_ _[KeptnPhaseType](#keptnphasetype)_
+
+KeptnPhase holds long and short names of each phase supported by Keptn
+
+_Appears in:_
+- [KeptnAppVersionStatus](#keptnappversionstatus)
+
+| Field | Description | Default | Optional |
+| --- | --- | --- | --- |
+| `LongName` _string_ |  || x |
+| `ShortName` _string_ |  || x |
 
 
 #### KeptnPhaseType

diff --git a/docs/docs/reference/api-reference/lifecycle/v1alpha2/index.md b/docs/docs/reference/api-reference/lifecycle/v1alpha2/index.md
@@ -10,6 +10,7 @@ Reference information for lifecycle.keptn.sh/v1alpha2
 
 ## lifecycle.keptn.sh/v1alpha2
 
+Package v1alpha2 contains API Schema definitions for the lifecycle v1alpha2 API group
 
 
 ### Resource Types
@@ -313,7 +314,7 @@ _Appears in:_
 | `postDeploymentEvaluationStatus` _[KeptnState](#keptnstate)_ |  |Pending| ✓ |
 | `workloadOverallStatus` _[KeptnState](#keptnstate)_ |  |Pending| ✓ |
 | `workloadStatus` _[WorkloadStatus](#workloadstatus) array_ |  || ✓ |
-| `currentPhase` _string_ |  || ✓ |
+| `currentPhase` _[KeptnPhase](#keptnphase)_ |  || ✓ |
 | `preDeploymentTaskStatus` _[ItemStatus](#itemstatus) array_ |  || ✓ |
 | `postDeploymentTaskStatus` _[ItemStatus](#itemstatus) array_ |  || ✓ |
 | `preDeploymentEvaluationTaskStatus` _[ItemStatus](#itemstatus) array_ |  || ✓ |
@@ -451,6 +452,20 @@ _Appears in:_
 
 
 
+#### KeptnPhase
+
+_Underlying type:_ _[KeptnPhaseType](#keptnphasetype)_
+
+KeptnPhase holds long and short names of each phase supported by Keptn
+
+_Appears in:_
+- [KeptnAppVersionStatus](#keptnappversionstatus)
+- [KeptnWorkloadInstanceStatus](#keptnworkloadinstancestatus)
+
+| Field | Description | Default | Optional |
+| --- | --- | --- | --- |
+| `LongName` _string_ |  || x |
+| `ShortName` _string_ |  || x |
 
 
 #### KeptnPhaseType
@@ -718,7 +733,7 @@ _Appears in:_
 | `postDeploymentEvaluationTaskStatus` _[ItemStatus](#itemstatus) 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_ |  || ✓ |
+| `currentPhase` _[KeptnPhase](#keptnphase)_ |  || ✓ |
 | `phaseTraceIDs` _[PhaseTraceID](#phasetraceid)_ |  || ✓ |
 | `status` _[KeptnState](#keptnstate)_ |  |Pending| ✓ |
 

diff --git a/docs/docs/reference/api-reference/lifecycle/v1alpha3/index.md b/docs/docs/reference/api-reference/lifecycle/v1alpha3/index.md
@@ -10,6 +10,7 @@ Reference information for lifecycle.keptn.sh/v1alpha3
 
 ## lifecycle.keptn.sh/v1alpha3
 
+Package v1alpha3 contains API Schema definitions for the lifecycle v1alpha3 API group
 
 
 ### Resource Types
@@ -369,7 +370,7 @@ _Appears in:_
 | `postDeploymentEvaluationStatus` _[KeptnState](#keptnstate)_ | PostDeploymentEvaluationStatus indicates the current status of the KeptnAppVersion's PostDeploymentEvaluation phase. |Pending| ✓ |
 | `workloadOverallStatus` _[KeptnState](#keptnstate)_ | WorkloadOverallStatus indicates the current status of the KeptnAppVersion's Workload deployment phase. |Pending| ✓ |
 | `workloadStatus` _[WorkloadStatus](#workloadstatus) array_ | WorkloadStatus contains the current status of each KeptnWorkload that is part of the KeptnAppVersion. || ✓ |
-| `currentPhase` _string_ | CurrentPhase indicates the current phase of the KeptnAppVersion. || ✓ |
+| `currentPhase` _[KeptnPhase](#keptnphase)_ | CurrentPhase indicates the current phase of the KeptnAppVersion. || ✓ |
 | `preDeploymentTaskStatus` _[ItemStatus](#itemstatus) array_ | PreDeploymentTaskStatus indicates the current state of each preDeploymentTask of the KeptnAppVersion. || ✓ |
 | `postDeploymentTaskStatus` _[ItemStatus](#itemstatus) array_ | PostDeploymentTaskStatus indicates the current state of each postDeploymentTask of the KeptnAppVersion. || ✓ |
 | `preDeploymentEvaluationTaskStatus` _[ItemStatus](#itemstatus) array_ | PreDeploymentEvaluationTaskStatus indicates the current state of each preDeploymentEvaluation of the KeptnAppVersion. || ✓ |
@@ -521,6 +522,20 @@ _Appears in:_
 | `namespace` _string_ | Namespace is the namespace where the referenced KeptnMetric is located. || ✓ |
 
 
+#### KeptnPhase
+
+_Underlying type:_ _[KeptnPhaseType](#keptnphasetype)_
+
+KeptnPhase holds long and short names of each phase supported by Keptn
+
+_Appears in:_
+- [KeptnAppVersionStatus](#keptnappversionstatus)
+- [KeptnWorkloadInstanceStatus](#keptnworkloadinstancestatus)
+
+| Field | Description | Default | Optional |
+| --- | --- | --- | --- |
+| `LongName` _string_ |  || x |
+| `ShortName` _string_ |  || x |
 
 
 #### KeptnPhaseType
@@ -796,7 +811,7 @@ _Appears in:_
 | `postDeploymentEvaluationTaskStatus` _[ItemStatus](#itemstatus) array_ | PostDeploymentEvaluationTaskStatus indicates the current state of each postDeploymentEvaluation of the KeptnWorkloadInstance. || ✓ |
 | `startTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta)_ | StartTime represents the time at which the deployment of the KeptnWorkloadInstance started. || ✓ |
 | `endTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta)_ | EndTime represents the time at which the deployment of the KeptnWorkloadInstance finished. || ✓ |
-| `currentPhase` _string_ | CurrentPhase indicates the current phase of the KeptnWorkloadInstance. This can be: - PreDeploymentTasks - PreDeploymentEvaluations - Deployment - PostDeploymentTasks - PostDeploymentEvaluations || ✓ |
+| `currentPhase` _[KeptnPhase](#keptnphase)_ | CurrentPhase indicates the current phase of the KeptnWorkloadInstance. This can be: - PreDeploymentTasks - PreDeploymentEvaluations - Deployment - PostDeploymentTasks - PostDeploymentEvaluations || ✓ |
 | `phaseTraceIDs` _[PhaseTraceID](#phasetraceid)_ | PhaseTraceIDs contains the trace IDs of the OpenTelemetry spans of each phase of the KeptnWorkloadInstance || ✓ |
 | `status` _[KeptnState](#keptnstate)_ | Status represents the overall status of the KeptnWorkloadInstance. |Pending| ✓ |
 

diff --git a/docs/docs/reference/api-reference/lifecycle/v1alpha4/index.md b/docs/docs/reference/api-reference/lifecycle/v1alpha4/index.md
@@ -97,7 +97,7 @@ _Appears in:_
 | `postDeploymentEvaluationTaskStatus` _[ItemStatus](../v1alpha3/index.md#itemstatus) array_ | PostDeploymentEvaluationTaskStatus indicates the current state of each postDeploymentEvaluation of the KeptnWorkloadVersion. || ✓ |
 | `startTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta)_ | StartTime represents the time at which the deployment of the KeptnWorkloadVersion started. || ✓ |
 | `endTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta)_ | EndTime represents the time at which the deployment of the KeptnWorkloadVersion finished. || ✓ |
-| `currentPhase` _string_ | CurrentPhase indicates the current phase of the KeptnWorkloadVersion. This can be: - PreDeploymentTasks - PreDeploymentEvaluations - Deployment - PostDeploymentTasks - PostDeploymentEvaluations || ✓ |
+| `currentPhase` _[KeptnPhase](#keptnphase)_ | CurrentPhase indicates the current phase of the KeptnWorkloadVersion. This can be: - PreDeploymentTasks - PreDeploymentEvaluations - Deployment - PostDeploymentTasks - PostDeploymentEvaluations || ✓ |
 | `phaseTraceIDs` _[PhaseTraceID](#phasetraceid)_ | PhaseTraceIDs contains the trace IDs of the OpenTelemetry spans of each phase of the KeptnWorkloadVersion || ✓ |
 | `status` _[KeptnState](#keptnstate)_ | Status represents the overall status of the KeptnWorkloadVersion. |Pending| ✓ |
 

diff --git a/docs/docs/reference/api-reference/lifecycle/v1beta1/index.md b/docs/docs/reference/api-reference/lifecycle/v1beta1/index.md
@@ -10,6 +10,7 @@ Reference information for lifecycle.keptn.sh/v1beta1
 
 ## lifecycle.keptn.sh/v1beta1
 
+Package v1beta1 contains API Schema definitions for the lifecycle v1beta1 API group
 
 
 ### Resource Types
@@ -609,6 +610,19 @@ _Appears in:_
 | `namespace` _string_ | Namespace is the namespace where the referenced KeptnMetric is located. || ✓ |
 
 
+#### KeptnPhase
+
+_Underlying type:_ _[KeptnPhaseType](#keptnphasetype)_
+
+KeptnPhase holds long and short names of each phase supported by Keptn
+
+_Appears in:_
+- [KeptnWorkloadVersionStatus](#keptnworkloadversionstatus)
+
+| Field | Description | Default | Optional |
+| --- | --- | --- | --- |
+| `LongName` _string_ |  || x |
+| `ShortName` _string_ |  || x |
 
 
 #### KeptnPhaseType
@@ -954,7 +968,7 @@ _Appears in:_
 | `postDeploymentEvaluationTaskStatus` _[ItemStatus](#itemstatus) array_ | PostDeploymentEvaluationTaskStatus indicates the current state of each postDeploymentEvaluation of the KeptnWorkloadVersion. || ✓ |
 | `startTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta)_ | StartTime represents the time at which the deployment of the KeptnWorkloadVersion started. || ✓ |
 | `endTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta)_ | EndTime represents the time at which the deployment of the KeptnWorkloadVersion finished. || ✓ |
-| `currentPhase` _string_ | CurrentPhase indicates the current phase of the KeptnWorkloadVersion. This can be: - PreDeploymentTasks - PreDeploymentEvaluations - Deployment - PostDeploymentTasks - PostDeploymentEvaluations || ✓ |
+| `currentPhase` _[KeptnPhase](#keptnphase)_ | CurrentPhase indicates the current phase of the KeptnWorkloadVersion. This can be: - PreDeploymentTasks - PreDeploymentEvaluations - Deployment - PostDeploymentTasks - PostDeploymentEvaluations || ✓ |
 | `phaseTraceIDs` _[PhaseTraceID](#phasetraceid)_ | PhaseTraceIDs contains the trace IDs of the OpenTelemetry spans of each phase of the KeptnWorkloadVersion || ✓ |
 | `status` _[KeptnState](#keptnstate)_ | Status represents the overall status of the KeptnWorkloadVersion. |Pending| ✓ |
 | `appContextMetadata` _object (keys:string, values:string)_ | AppContextMetadata contains metadata from the related KeptnAppVersion. || ✓ |

diff --git a/lifecycle-operator/apis/lifecycle/v1alpha1/common/common.go b/lifecycle-operator/apis/lifecycle/v1alpha1/common/common.go
@@ -1,3 +1,4 @@
+// Package v1alpha1 contains API Schema definitions for the lifecycle v1alpha1 API group
 // +groupName=lifecycle.keptn.sh
 // +versionName=v1alpha1
 package common

diff --git a/lifecycle-operator/apis/lifecycle/v1alpha1/keptnappversion_types.go b/lifecycle-operator/apis/lifecycle/v1alpha1/keptnappversion_types.go
@@ -62,7 +62,7 @@ type KeptnAppVersionStatus struct {
 	// +optional
 	WorkloadStatus []WorkloadStatus `json:"workloadStatus,omitempty"`
 	// +optional
-	CurrentPhase string `json:"currentPhase,omitempty"`
+	CurrentPhase common.KeptnPhase `json:"currentPhase,omitempty"`
 	// +optional
 	PreDeploymentTaskStatus []TaskStatus `json:"preDeploymentTaskStatus,omitempty"`
 	// +optional
@@ -310,11 +310,11 @@ func (a *KeptnAppVersion) SetState(state common.KeptnState) {
 	a.Status.Status = state
 }
 
-func (a KeptnAppVersion) GetCurrentPhase() string {
+func (a KeptnAppVersion) GetCurrentPhase() common.KeptnPhase {
 	return a.Status.CurrentPhase
 }
 
-func (a *KeptnAppVersion) SetCurrentPhase(phase string) {
+func (a *KeptnAppVersion) SetCurrentPhase(phase common.KeptnPhase) {
 	a.Status.CurrentPhase = phase
 }
 

diff --git a/lifecycle-operator/apis/lifecycle/v1alpha2/common/common.go b/lifecycle-operator/apis/lifecycle/v1alpha2/common/common.go
@@ -1,3 +1,4 @@
+// Package v1alpha2 contains API Schema definitions for the lifecycle v1alpha2 API group
 // +groupName=lifecycle.keptn.sh
 // +versionName=v1alpha2
 package common

diff --git a/lifecycle-operator/apis/lifecycle/v1alpha2/keptnappversion_types.go b/lifecycle-operator/apis/lifecycle/v1alpha2/keptnappversion_types.go
@@ -62,7 +62,7 @@ type KeptnAppVersionStatus struct {
 	// +optional
 	WorkloadStatus []WorkloadStatus `json:"workloadStatus,omitempty"`
 	// +optional
-	CurrentPhase string `json:"currentPhase,omitempty"`
+	CurrentPhase common.KeptnPhase `json:"currentPhase,omitempty"`
 	// +optional
 	PreDeploymentTaskStatus []ItemStatus `json:"preDeploymentTaskStatus,omitempty"`
 	// +optional
@@ -320,11 +320,11 @@ func (a *KeptnAppVersion) SetState(state common.KeptnState) {
 	a.Status.Status = state
 }
 
-func (a KeptnAppVersion) GetCurrentPhase() string {
+func (a KeptnAppVersion) GetCurrentPhase() common.KeptnPhase {
 	return a.Status.CurrentPhase
 }
 
-func (a *KeptnAppVersion) SetCurrentPhase(phase string) {
+func (a *KeptnAppVersion) SetCurrentPhase(phase common.KeptnPhase) {
 	a.Status.CurrentPhase = phase
 }
 

diff --git a/lifecycle-operator/apis/lifecycle/v1alpha2/keptnworkloadinstance_types.go b/lifecycle-operator/apis/lifecycle/v1alpha2/keptnworkloadinstance_types.go
@@ -64,7 +64,7 @@ type KeptnWorkloadInstanceStatus struct {
 	// +optional
 	EndTime metav1.Time `json:"endTime,omitempty"`
 	// +optional
-	CurrentPhase string `json:"currentPhase,omitempty"`
+	CurrentPhase common.KeptnPhase `json:"currentPhase,omitempty"`
 	// +optional
 	PhaseTraceIDs common.PhaseTraceID `json:"phaseTraceIDs,omitempty"`
 	// +kubebuilder:default:=Pending

diff --git a/lifecycle-operator/apis/lifecycle/v1alpha3/common/common.go b/lifecycle-operator/apis/lifecycle/v1alpha3/common/common.go
@@ -1,3 +1,4 @@
+// Package v1alpha3 contains API Schema definitions for the lifecycle v1alpha3 API group
 // +groupName=lifecycle.keptn.sh
 // +versionName=v1alpha3
 package common

diff --git a/lifecycle-operator/apis/lifecycle/v1alpha3/keptnappversion_types.go b/lifecycle-operator/apis/lifecycle/v1alpha3/keptnappversion_types.go
@@ -71,7 +71,7 @@ type KeptnAppVersionStatus struct {
 	WorkloadStatus []WorkloadStatus `json:"workloadStatus,omitempty"`
 	// CurrentPhase indicates the current phase of the KeptnAppVersion.
 	// +optional
-	CurrentPhase string `json:"currentPhase,omitempty"`
+	CurrentPhase common.KeptnPhase `json:"currentPhase,omitempty"`
 	// PreDeploymentTaskStatus indicates the current state of each preDeploymentTask of the KeptnAppVersion.
 	// +optional
 	PreDeploymentTaskStatus []ItemStatus `json:"preDeploymentTaskStatus,omitempty"`
@@ -341,11 +341,11 @@ func (a *KeptnAppVersion) SetState(state common.KeptnState) {
 	a.Status.Status = state
 }
 
-func (a KeptnAppVersion) GetCurrentPhase() string {
+func (a KeptnAppVersion) GetCurrentPhase() common.KeptnPhase {
 	return a.Status.CurrentPhase
 }
 
-func (a *KeptnAppVersion) SetCurrentPhase(phase string) {
+func (a *KeptnAppVersion) SetCurrentPhase(phase common.KeptnPhase) {
 	a.Status.CurrentPhase = phase
 }
 

diff --git a/lifecycle-operator/apis/lifecycle/v1alpha3/keptnworkloadinstance_types.go b/lifecycle-operator/apis/lifecycle/v1alpha3/keptnworkloadinstance_types.go
@@ -84,7 +84,7 @@ type KeptnWorkloadInstanceStatus struct {
 	// - PostDeploymentTasks
 	// - PostDeploymentEvaluations
 	// +optional
-	CurrentPhase string `json:"currentPhase,omitempty"`
+	CurrentPhase common.KeptnPhase `json:"currentPhase,omitempty"`
 	// PhaseTraceIDs contains the trace IDs of the OpenTelemetry spans of each phase of the KeptnWorkloadInstance
 	// +optional
 	PhaseTraceIDs common.PhaseTraceID `json:"phaseTraceIDs,omitempty"`

diff --git a/lifecycle-operator/apis/lifecycle/v1alpha4/keptnworkloadversion_types.go b/lifecycle-operator/apis/lifecycle/v1alpha4/keptnworkloadversion_types.go
@@ -89,7 +89,7 @@ type KeptnWorkloadVersionStatus struct {
 	// - PostDeploymentTasks
 	// - PostDeploymentEvaluations
 	// +optional
-	CurrentPhase string `json:"currentPhase,omitempty"`
+	CurrentPhase common.KeptnPhase `json:"currentPhase,omitempty"`
 	// PhaseTraceIDs contains the trace IDs of the OpenTelemetry spans of each phase of the KeptnWorkloadVersion
 	// +optional
 	PhaseTraceIDs common.PhaseTraceID `json:"phaseTraceIDs,omitempty"`
@@ -324,11 +324,11 @@ func (w *KeptnWorkloadVersion) SetState(state common.KeptnState) {
 	w.Status.Status = state
 }
 
-func (w KeptnWorkloadVersion) GetCurrentPhase() string {
+func (w KeptnWorkloadVersion) GetCurrentPhase() common.KeptnPhase {
 	return w.Status.CurrentPhase
 }
 
-func (w *KeptnWorkloadVersion) SetCurrentPhase(phase string) {
+func (w *KeptnWorkloadVersion) SetCurrentPhase(phase common.KeptnPhase) {
 	w.Status.CurrentPhase = phase
 }
 

diff --git a/lifecycle-operator/apis/lifecycle/v1beta1/common/common.go b/lifecycle-operator/apis/lifecycle/v1beta1/common/common.go
@@ -1,3 +1,4 @@
+// Package v1beta1 contains API Schema definitions for the lifecycle v1beta1 API group
 // +groupName=lifecycle.keptn.sh
 // +versionName=v1beta1
 package common

diff --git a/lifecycle-operator/apis/lifecycle/v1beta1/keptnworkloadversion_types.go b/lifecycle-operator/apis/lifecycle/v1beta1/keptnworkloadversion_types.go
@@ -106,7 +106,7 @@ type KeptnWorkloadVersionStatus struct {
 	// - PostDeploymentTasks
 	// - PostDeploymentEvaluations
 	// +optional
-	CurrentPhase string `json:"currentPhase,omitempty"`
+	CurrentPhase common.KeptnPhase `json:"currentPhase,omitempty"`
 	// PhaseTraceIDs contains the trace IDs of the OpenTelemetry spans of each phase of the KeptnWorkloadVersion
 	// +optional
 	PhaseTraceIDs common.PhaseTraceID `json:"phaseTraceIDs,omitempty"`
@@ -379,11 +379,11 @@ func (w *KeptnWorkloadVersion) SetState(state common.KeptnState) {
 	w.Status.Status = state
 }
 
-func (w KeptnWorkloadVersion) GetCurrentPhase() string {
+func (w KeptnWorkloadVersion) GetCurrentPhase() common.KeptnPhase {
 	return w.Status.CurrentPhase
 }
 
-func (w *KeptnWorkloadVersion) SetCurrentPhase(phase string) {
+func (w *KeptnWorkloadVersion) SetCurrentPhase(phase common.KeptnPhase) {
 	w.Status.CurrentPhase = phase
 }