Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

introduce tortoise condition and FailedToReconcile condition in it #139

Merged
merged 1 commit into from
Oct 4, 2023
Merged

introduce tortoise condition and FailedToReconcile condition in it #139

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
36 changes: 36 additions & 0 deletions api/v1beta1/tortoise_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,10 +247,46 @@ type HPATargetUtilizationRecommendationPerContainer struct {
}

type Conditions struct {
// TortoiseConditions is the condition of this tortoise.
// +patchMergeKey=type
// +patchStrategy=merge
// +listType=map
// +listMapKey=type
// +optional
TortoiseConditions []TortoiseCondition `json:"tortoiseConditions" protobuf:"bytes,1,name=tortoiseConditions"`
// ContainerRecommendationFromVPA is the condition of container recommendation from VPA, which is observed last time.
// +optional
ContainerRecommendationFromVPA []ContainerRecommendationFromVPA `json:"containerRecommendationFromVPA,omitempty" protobuf:"bytes,1,opt,name=containerRecommendationFromVPA"`
}

// TortoiseConditionType are the valid conditions of a Tortoise.
type TortoiseConditionType string

const (
// TortoiseConditionTypeFailedToReconcile means tortoise failed to reconcile due to some reasons.
TortoiseConditionTypeFailedToReconcile TortoiseConditionType = "FailedToReconcile"
)

type TortoiseCondition struct {
// Type is the type of the condition.
Type TortoiseConditionType `json:"type" protobuf:"bytes,1,name=type"`
// Status is the status of the condition. (True, False, Unknown)
Status v1.ConditionStatus `json:"status" protobuf:"bytes,2,name=status"`
// The last time this condition was updated.
LastUpdateTime metav1.Time `json:"lastUpdateTime,omitempty" protobuf:"bytes,6,opt,name=lastUpdateTime"`
// lastTransitionTime is the last time the condition transitioned from
// one status to another
// +optional
LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty" protobuf:"bytes,3,opt,name=lastTransitionTime"`
// reason is the reason for the condition's last transition.
// +optional
Reason string `json:"reason,omitempty" protobuf:"bytes,4,opt,name=reason"`
// message is a human-readable explanation containing details about
// the transition
// +optional
Message string `json:"message,omitempty" protobuf:"bytes,5,opt,name=message"`
}

type ContainerRecommendationFromVPA struct {
// ContainerName is the name of target container.
ContainerName string `json:"containerName" protobuf:"bytes,1,name=containerName"`
Expand Down
38 changes: 38 additions & 0 deletions config/crd/bases/autoscaling.mercari.com_tortoises.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -501,6 +501,8 @@ spec:
conditions:
properties:
containerRecommendationFromVPA:
description: ContainerRecommendationFromVPA is the condition of
container recommendation from VPA, which is observed last time.
items:
properties:
containerName:
Expand Down Expand Up @@ -545,6 +547,42 @@ spec:
- recommendation
type: object
type: array
tortoiseConditions:
description: TortoiseConditions is the condition of this tortoise.
items:
properties:
lastTransitionTime:
description: lastTransitionTime is the last time the condition
transitioned from one status to another
format: date-time
type: string
lastUpdateTime:
description: The last time this condition was updated.
format: date-time
type: string
message:
description: message is a human-readable explanation containing
details about the transition
type: string
reason:
description: reason is the reason for the condition's last
transition.
type: string
status:
description: Status is the status of the condition. (True,
False, Unknown)
type: string
type:
description: Type is the type of the condition.
type: string
required:
- status
- type
type: object
type: array
x-kubernetes-list-map-keys:
- type
x-kubernetes-list-type: map
type: object
recommendations:
properties:
Expand Down
6 changes: 4 additions & 2 deletions controllers/tortoise_controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,8 +84,10 @@ func (r *TortoiseReconciler) Reconcile(ctx context.Context, req ctrl.Request) (_
return ctrl.Result{}, err
}
defer func() {
if reterr != nil {
r.EventRecorder.Event(tortoise, "Warning", "ReconcileError", reterr.Error())
tortoise = r.TortoiseService.RecordReconciliationFailure(tortoise, reterr, now)
_, err = r.TortoiseService.UpdateTortoiseStatus(ctx, tortoise, now)
if err != nil {
logger.Error(err, "update Tortoise status", "tortoise", req.NamespacedName)
}
}()

Expand Down
33 changes: 33 additions & 0 deletions ...d/apiextensions.k8s.io_v1_customresourcedefinition_tortoises.autoscaling.mercari.com.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -399,6 +399,7 @@ spec:
conditions:
properties:
containerRecommendationFromVPA:
description: ContainerRecommendationFromVPA is the condition of container recommendation from VPA, which is observed last time.
items:
properties:
containerName:
Expand Down Expand Up @@ -440,6 +441,38 @@ spec:
- recommendation
type: object
type: array
tortoiseConditions:
description: TortoiseConditions is the condition of this tortoise.
items:
properties:
lastTransitionTime:
description: lastTransitionTime is the last time the condition transitioned from one status to another
format: date-time
type: string
lastUpdateTime:
description: The last time this condition was updated.
format: date-time
type: string
message:
description: message is a human-readable explanation containing details about the transition
type: string
reason:
description: reason is the reason for the condition's last transition.
type: string
status:
description: Status is the status of the condition. (True, False, Unknown)
type: string
type:
description: Type is the type of the condition.
type: string
required:
- status
- type
type: object
type: array
x-kubernetes-list-map-keys:
- type
x-kubernetes-list-type: map
type: object
recommendations:
properties:
Expand Down
33 changes: 33 additions & 0 deletions ...t/apiextensions.k8s.io_v1_customresourcedefinition_tortoises.autoscaling.mercari.com.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -399,6 +399,7 @@ spec:
conditions:
properties:
containerRecommendationFromVPA:
description: ContainerRecommendationFromVPA is the condition of container recommendation from VPA, which is observed last time.
items:
properties:
containerName:
Expand Down Expand Up @@ -440,6 +441,38 @@ spec:
- recommendation
type: object
type: array
tortoiseConditions:
description: TortoiseConditions is the condition of this tortoise.
items:
properties:
lastTransitionTime:
description: lastTransitionTime is the last time the condition transitioned from one status to another
format: date-time
type: string
lastUpdateTime:
description: The last time this condition was updated.
format: date-time
type: string
message:
description: message is a human-readable explanation containing details about the transition
type: string
reason:
description: reason is the reason for the condition's last transition.
type: string
status:
description: Status is the status of the condition. (True, False, Unknown)
type: string
type:
description: Type is the type of the condition.
type: string
required:
- status
- type
type: object
type: array
x-kubernetes-list-map-keys:
- type
x-kubernetes-list-type: map
type: object
recommendations:
properties:
Expand Down
40 changes: 40 additions & 0 deletions pkg/tortoise/tortoise.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -320,3 +320,43 @@ func (s *Service) updateLastTimeUpdateTortoise(tortoise *v1beta1.Tortoise, now t

s.lastTimeUpdateTortoise[client.ObjectKeyFromObject(tortoise)] = now
}

func (s *Service) RecordReconciliationFailure(t *v1beta1.Tortoise, err error, now time.Time) *v1beta1.Tortoise {
if err != nil {
s.recorder.Event(t, "Warning", "ReconcileError", err.Error())
for i := range t.Status.Conditions.TortoiseConditions {
if t.Status.Conditions.TortoiseConditions[i].Type == v1beta1.TortoiseConditionTypeFailedToReconcile {
// TODO: have a clear reason and utilize it to have a better reconciliation next.
// For example, in some cases, the reconciliation may keep failing until people fix some problems manually.
t.Status.Conditions.TortoiseConditions[i].Reason = "ReconcileError"
t.Status.Conditions.TortoiseConditions[i].Message = err.Error()
t.Status.Conditions.TortoiseConditions[i].Status = corev1.ConditionTrue
t.Status.Conditions.TortoiseConditions[i].LastTransitionTime = metav1.NewTime(now)
t.Status.Conditions.TortoiseConditions[i].LastUpdateTime = metav1.NewTime(now)
return t
}
}
// add as a new condition if not found.
t.Status.Conditions.TortoiseConditions = append(t.Status.Conditions.TortoiseConditions, v1beta1.TortoiseCondition{
Type: v1beta1.TortoiseConditionTypeFailedToReconcile,
Status: corev1.ConditionTrue,
Reason: "ReconcileError",
Message: err.Error(),
LastTransitionTime: metav1.NewTime(now),
LastUpdateTime: metav1.NewTime(now),
})
return t
}

for i := range t.Status.Conditions.TortoiseConditions {
if t.Status.Conditions.TortoiseConditions[i].Type == v1beta1.TortoiseConditionTypeFailedToReconcile {
t.Status.Conditions.TortoiseConditions[i].Reason = ""
t.Status.Conditions.TortoiseConditions[i].Message = ""
t.Status.Conditions.TortoiseConditions[i].Status = corev1.ConditionFalse
t.Status.Conditions.TortoiseConditions[i].LastTransitionTime = metav1.NewTime(now)
t.Status.Conditions.TortoiseConditions[i].LastUpdateTime = metav1.NewTime(now)
return t
}
}
return t
}
Loading
Loading