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

decouple healthy from ready conditions #292

Merged
merged 1 commit into from
Nov 7, 2024
Merged

decouple healthy from ready conditions #292

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
9 changes: 7 additions & 2 deletions internal/controller/dnsrecord_controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -442,17 +442,23 @@ func setStatusConditions(record *v1alpha1.DNSRecord, hadChanges bool, notHealthy
setDNSRecordCondition(record, string(v1alpha1.ConditionTypeReady), metav1.ConditionFalse, string(v1alpha1.ConditionReasonAwaitingValidation), "Awaiting validation")
return
}

setDNSRecordCondition(record, string(v1alpha1.ConditionTypeReady), metav1.ConditionTrue, string(v1alpha1.ConditionReasonProviderSuccess), "Provider ensured the dns record")

// probes are disabled or not defined, or this is a wildcard record
if record.Spec.HealthCheck == nil || strings.HasPrefix(record.Spec.RootHost, v1alpha1.WildcardPrefix) {
meta.RemoveStatusCondition(&record.Status.Conditions, string(v1alpha1.ConditionTypeHealthy))
return
}

// if we haven't published because of the health failure, we won't have changes but the spec endpoints will be empty
if record.Status.Endpoints == nil || len(record.Status.Endpoints) == 0 {
setDNSRecordCondition(record, string(v1alpha1.ConditionTypeReady), metav1.ConditionFalse, string(v1alpha1.ConditionReasonUnhealthy), "Not publishing unhealthy records")
}

// we don't have probes yet
if cap(notHealthyProbes) == 0 {
setDNSRecordCondition(record, string(v1alpha1.ConditionTypeHealthy), metav1.ConditionFalse, string(v1alpha1.ConditionReasonUnhealthy), "Probes are creating")
setDNSRecordCondition(record, string(v1alpha1.ConditionTypeReady), metav1.ConditionFalse, string(v1alpha1.ConditionReasonUnhealthy), "Probes are creating")
return
}

Expand All @@ -470,7 +476,6 @@ func setStatusConditions(record *v1alpha1.DNSRecord, hadChanges bool, notHealthy
}
// none of the probes is healthy (change ready condition to false)
setDNSRecordCondition(record, string(v1alpha1.ConditionTypeHealthy), metav1.ConditionFalse, string(v1alpha1.ConditionReasonUnhealthy), fmt.Sprintf("Not healthy addresses: %s", notHealthyProbes))
setDNSRecordCondition(record, string(v1alpha1.ConditionTypeReady), metav1.ConditionFalse, string(v1alpha1.ConditionReasonUnhealthy), "None of the healthchecks succeeded")

}

Expand Down
125 changes: 121 additions & 4 deletions internal/controller/dnsrecord_healthchecks_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ var _ = Describe("DNSRecordReconciler_HealthChecks", func() {
"Type": Equal(string(v1alpha1.ConditionTypeReady)),
"Status": Equal(metav1.ConditionFalse),
"Reason": Equal(string(v1alpha1.ConditionReasonUnhealthy)),
"Message": Equal("None of the healthchecks succeeded"),
"Message": Equal("Not publishing unhealthy records"),
"ObservedGeneration": Equal(dnsRecord.Generation),
})),
)
Expand Down Expand Up @@ -345,12 +345,129 @@ var _ = Describe("DNSRecordReconciler_HealthChecks", func() {
}),
MatchFields(IgnoreExtras, Fields{
"Type": Equal(string(v1alpha1.ConditionTypeReady)),
"Status": Equal(metav1.ConditionFalse),
"Reason": Equal(string(v1alpha1.ConditionReasonUnhealthy)),
"Message": Equal("None of the healthchecks succeeded"),
"Status": Equal(metav1.ConditionTrue),
"Reason": Equal(string(v1alpha1.ConditionReasonProviderSuccess)),
"Message": Equal("Provider ensured the dns record"),
}),
))
}, TestTimeoutMedium, time.Second).Should(Succeed())
})

It("Should remove healthy condition when healthchecks removed", func() {
//Create default test dnsrecord
Expect(k8sClient.Create(ctx, dnsRecord)).To(Succeed())

By("Marking all probes as healthy")
Eventually(func(g Gomega) {
probes := &v1alpha1.DNSHealthCheckProbeList{}

g.Expect(k8sClient.List(ctx, probes, &client.ListOptions{
LabelSelector: labels.SelectorFromSet(map[string]string{
ProbeOwnerLabel: BuildOwnerLabelValue(dnsRecord),
}),
Namespace: dnsRecord.Namespace,
})).To(Succeed())
g.Expect(len(probes.Items)).To(Equal(2))

// make probes healthy
for _, probe := range probes.Items {
probe.Status.Healthy = ptr.To(true)
probe.Status.LastCheckedAt = metav1.Now()
probe.Status.ConsecutiveFailures = 0
g.Expect(k8sClient.Status().Update(ctx, &probe)).To(Succeed())
}
}, TestTimeoutMedium, time.Second).Should(Succeed())

// make sure we published endpoint
Eventually(func(g Gomega) {
g.Expect(k8sClient.Get(ctx, client.ObjectKeyFromObject(dnsRecord), dnsRecord)).To(Succeed())
g.Expect(dnsRecord.Status.Endpoints).To(ConsistOf(
PointTo(MatchFields(IgnoreExtras, Fields{
"DNSName": Equal(testHostname),
"Targets": ConsistOf("172.32.200.1", "172.32.200.2"),
})),
))
}, TestTimeoutMedium, time.Second).Should(Succeed())

By("Making one of the probes unhealthy")
Eventually(func(g Gomega) {
probes := &v1alpha1.DNSHealthCheckProbeList{}

g.Expect(k8sClient.List(ctx, probes, &client.ListOptions{
LabelSelector: labels.SelectorFromSet(map[string]string{
ProbeOwnerLabel: BuildOwnerLabelValue(dnsRecord),
}),
Namespace: dnsRecord.Namespace,
})).To(Succeed())

var updated bool
// make one of the probes unhealthy
for _, probe := range probes.Items {
if probe.Spec.Address == "172.32.200.1" {
probe.Status.Healthy = ptr.To(false)
probe.Status.LastCheckedAt = metav1.Now()
probe.Status.ConsecutiveFailures = dnsRecord.Spec.HealthCheck.FailureThreshold + 1
g.Expect(k8sClient.Status().Update(ctx, &probe)).To(Succeed())
updated = true
}
}
// expect to have updated one of the probes
g.Expect(updated).To(BeTrue())
}, TestTimeoutMedium, time.Second).Should(Succeed())

By("Ensure unhealthy endpoints are gone and status is updated")
Eventually(func(g Gomega) {
Expect(k8sClient.Get(ctx, client.ObjectKeyFromObject(dnsRecord), dnsRecord)).To(Succeed())

g.Expect(dnsRecord.Status.Endpoints).To(ConsistOf(
PointTo(MatchFields(IgnoreExtras, Fields{
"DNSName": Equal(testHostname),
"Targets": ConsistOf("172.32.200.2"),
})),
))
g.Expect(dnsRecord.Status.Conditions).To(
ContainElement(MatchFields(IgnoreExtras, Fields{
"Type": Equal(string(v1alpha1.ConditionTypeHealthy)),
"Status": Equal(metav1.ConditionFalse),
"Reason": Equal(string(v1alpha1.ConditionReasonPartiallyHealthy)),
"Message": Equal("Not healthy addresses: [172.32.200.1]"),
})),
)
}, TestTimeoutMedium, time.Second).Should(Succeed())

By("Remove health spec")
Eventually(func(g Gomega) {
dnsRecord.Spec.HealthCheck = nil
g.Expect(k8sClient.Update(ctx, dnsRecord)).To(Succeed())
}, TestTimeoutMedium, time.Second).Should(Succeed())

// we don't remove EPs if this leads to empty EPs
By("Ensure endpoints are published and a health condition is gone")
Eventually(func(g Gomega) {
Expect(k8sClient.Get(ctx, client.ObjectKeyFromObject(dnsRecord), dnsRecord)).To(Succeed())
g.Expect(dnsRecord.Status.Endpoints).To(ConsistOf(
PointTo(MatchFields(IgnoreExtras, Fields{
"DNSName": Equal(testHostname),
"Targets": ConsistOf("172.32.200.1", "172.32.200.2"),
})),
))
g.Expect(dnsRecord.Status.Conditions).To(
And(
ContainElement(
MatchFields(IgnoreExtras, Fields{
"Type": Equal(string(v1alpha1.ConditionTypeReady)),
"Status": Equal(metav1.ConditionTrue),
"Reason": Equal(string(v1alpha1.ConditionReasonProviderSuccess)),
"Message": Equal("Provider ensured the dns record"),
}),
),
Not(ContainElement(
MatchFields(IgnoreExtras, Fields{
"Type": Equal(string(v1alpha1.ConditionTypeHealthy)),
}),
)),
))
}, time.Hour, time.Second).Should(Succeed())
})

})
Loading