Skip to content
This repository has been archived by the owner on Jun 8, 2022. It is now read-only.

enhance health scope with informative health condition #194

Merged
merged 8 commits into from
Sep 9, 2020
Merged

enhance health scope with informative health condition #194

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
645a967
use merging instead of overriding
captainroy-hy Aug 29, 2020
2707bbc
move AddLabel func into oam/helper
captainroy-hy Aug 31, 2020
528ec10
Make health condition of HealthScope more informative
captainroy-hy Sep 3, 2020
9925757
fix e2e-test
captainroy-hy Sep 3, 2020
8a5852a
modify health scope condition
captainroy-hy Sep 4, 2020
8b62ad5
fix typo
captainroy-hy Sep 4, 2020
6ad4984
add unit test for health scope
captainroy-hy Sep 7, 2020
8986d28
resolve conflicts on healthscope_controller
captainroy-hy Sep 9, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 28 additions & 1 deletion apis/core/v1alpha2/core_scope_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,18 @@ import (
"github.com/crossplane/oam-kubernetes-runtime/pkg/oam"
)

// HealthStatus represents health status strings.
type HealthStatus string

const (
// StatusHealthy represents healthy status.
StatusHealthy HealthStatus = "HEALTHY"
// StatusUnhealthy represents unhealthy status.
StatusUnhealthy = "UNHEALTHY"
// StatusUnknown represents unknown status.
StatusUnknown = "UNKNOWN"
)

var _ oam.Scope = &HealthScope{}

// A HealthScopeSpec defines the desired state of a HealthScope.
Expand All @@ -41,7 +53,22 @@ type HealthScopeSpec struct {
type HealthScopeStatus struct {
runtimev1alpha1.ConditionedStatus `json:",inline"`

Health string `json:"health"`
// ScopeHealthCondition represents health condition summary of the scope
ScopeHealthCondition HealthCondition `json:"scopeHealthCondition"`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

they should be different struct as some of the field like componentName don't work here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, let me add a specific struct for ScopeHealthCondition, we can replace
infoFmtScopeDiagnosis = "total workloads: %d, healthy workloads: %d, unhealthy workloads: %d, unknown workloads: %d" with the new struct.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@wonderflow any suggestion on the scope health condition struct? e.g. additional info that may be consumed by traits.

// ScopeHealthCondition represents health condition summary of a scope.
type ScopeHealthCondition struct {
	HealthStatus       HealthStatus `json:"healthStatus"`
	Total              int64        `json:"total,omitempty"`
	HealthyWorkloads   int64        `json:"healthyWorkloads,omitempty"`
	UnhealthyWorkloads int64        `json:"unhealthyWorkloads,omitempty"`
	UnknownWorkloads   int64        `json:"unknownWorkloads,omitempty"`
}

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The struct is good


// HealthConditions represents health condition of workloads in the scope
HealthConditions []*HealthCondition `json:"healthConditions,omitempty"`
}

// HealthCondition represents informative health condition.
type HealthCondition struct {
// ComponentName represents the component name if target is a workload
ComponentName string `json:"componentName,omitempty"`
TargetWorkload runtimev1alpha1.TypedReference `json:"targetWorkload,omitempty"`
HealthStatus HealthStatus `json:"healthStatus"`
Diagnosis string `json:"diagnosis,omitempty"`
// WorkloadStatus represents status of workloads whose HealthStatus is UNKNOWN.
WorkloadStatus string `json:"workloadStatus,omitempty"`
}

// +kubebuilder:object:root=true
Expand Down
28 changes: 28 additions & 0 deletions apis/core/v1alpha2/zz_generated.deepcopy.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

91 changes: 88 additions & 3 deletions charts/oam-kubernetes-runtime/crds/core.oam.dev_healthscopes.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,10 +119,95 @@ spec:
- type
type: object
type: array
health:
type: string
healthConditions:
description: HealthConditions represents health condition of workloads
in the scope
items:
description: HealthCondition represents informative health condition.
properties:
componentName:
description: ComponentName represents the component name if
target is a workload
type: string
diagnosis:
type: string
healthStatus:
description: HealthStatus represents health status strings.
type: string
targetWorkload:
description: A TypedReference refers to an object by Name, Kind,
and APIVersion. It is commonly used to reference cluster-scoped
objects or objects where the namespace is already known.
properties:
apiVersion:
description: APIVersion of the referenced object.
type: string
kind:
description: Kind of the referenced object.
type: string
name:
description: Name of the referenced object.
type: string
uid:
description: UID of the referenced object.
type: string
required:
- apiVersion
- kind
- name
type: object
workloadStatus:
description: WorkloadStatus represents status of workloads whose
HealthStatus is UNKNOWN.
type: string
required:
- healthStatus
type: object
type: array
scopeHealthCondition:
description: ScopeHealthCondition represents health condition summary
of the scope
properties:
componentName:
description: ComponentName represents the component name if target
is a workload
type: string
diagnosis:
type: string
healthStatus:
description: HealthStatus represents health status strings.
type: string
targetWorkload:
description: A TypedReference refers to an object by Name, Kind,
and APIVersion. It is commonly used to reference cluster-scoped
objects or objects where the namespace is already known.
properties:
apiVersion:
description: APIVersion of the referenced object.
type: string
kind:
description: Kind of the referenced object.
type: string
name:
description: Name of the referenced object.
type: string
uid:
description: UID of the referenced object.
type: string
required:
- apiVersion
- kind
- name
type: object
workloadStatus:
description: WorkloadStatus represents status of workloads whose
HealthStatus is UNKNOWN.
type: string
required:
- healthStatus
type: object
required:
- health
- scopeHealthCondition
type: object
type: object
served: true
Expand Down
Loading