Skip to content

Commit

Permalink
propagate DNS Record status to DNS Policy (#585)
Browse files Browse the repository at this point in the history
  • Loading branch information
philbrookes authored Apr 29, 2024
1 parent 854cd7f commit c080b1c
Show file tree
Hide file tree
Showing 8 changed files with 374 additions and 9 deletions.
3 changes: 3 additions & 0 deletions api/v1alpha1/dnspolicy_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,9 @@ type DNSPolicyStatus struct {

// +optional
HealthCheck *HealthCheckStatus `json:"healthCheck,omitempty"`

// +optional
ProbeConditions map[string][]metav1.Condition `json:"probeConditions,omitempty"`
}

func (s *DNSPolicyStatus) GetConditions() []metav1.Condition {
Expand Down
18 changes: 18 additions & 0 deletions api/v1alpha1/zz_generated.deepcopy.go

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

73 changes: 73 additions & 0 deletions bundle/manifests/kuadrant.io_dnspolicies.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -401,6 +401,79 @@ spec:
recorded in the status condition
format: int64
type: integer
probeConditions:
additionalProperties:
items:
description: "Condition contains details for one aspect of the
current state of this API Resource.\n---\nThis struct is intended
for direct use as an array at the field path .status.conditions.
\ For example,\n\n\n\ttype FooStatus struct{\n\t // Represents
the observations of a foo's current state.\n\t // Known .status.conditions.type
are: \"Available\", \"Progressing\", and \"Degraded\"\n\t //
+patchMergeKey=type\n\t // +patchStrategy=merge\n\t //
+listType=map\n\t // +listMapKey=type\n\t Conditions []metav1.Condition
`json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\"
protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t // other
fields\n\t}"
properties:
lastTransitionTime:
description: |-
lastTransitionTime is the last time the condition transitioned from one status to another.
This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
format: date-time
type: string
message:
description: |-
message is a human readable message indicating details about the transition.
This may be an empty string.
maxLength: 32768
type: string
observedGeneration:
description: |-
observedGeneration represents the .metadata.generation that the condition was set based upon.
For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
with respect to the current state of the instance.
format: int64
minimum: 0
type: integer
reason:
description: |-
reason contains a programmatic identifier indicating the reason for the condition's last transition.
Producers of specific condition types may define expected values and meanings for this field,
and whether the values are considered a guaranteed API.
The value should be a CamelCase string.
This field may not be empty.
maxLength: 1024
minLength: 1
pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
type: string
status:
description: status of the condition, one of True, False,
Unknown.
enum:
- "True"
- "False"
- Unknown
type: string
type:
description: |-
type of condition in CamelCase or in foo.example.com/CamelCase.
---
Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be
useful (see .node.status.conditions), the ability to deconflict is important.
The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)
maxLength: 316
pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$
type: string
required:
- lastTransitionTime
- message
- reason
- status
- type
type: object
type: array
type: object
type: object
type: object
served: true
Expand Down
73 changes: 73 additions & 0 deletions config/crd/bases/kuadrant.io_dnspolicies.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -400,6 +400,79 @@ spec:
recorded in the status condition
format: int64
type: integer
probeConditions:
additionalProperties:
items:
description: "Condition contains details for one aspect of the
current state of this API Resource.\n---\nThis struct is intended
for direct use as an array at the field path .status.conditions.
\ For example,\n\n\n\ttype FooStatus struct{\n\t // Represents
the observations of a foo's current state.\n\t // Known .status.conditions.type
are: \"Available\", \"Progressing\", and \"Degraded\"\n\t //
+patchMergeKey=type\n\t // +patchStrategy=merge\n\t //
+listType=map\n\t // +listMapKey=type\n\t Conditions []metav1.Condition
`json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\"
protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t // other
fields\n\t}"
properties:
lastTransitionTime:
description: |-
lastTransitionTime is the last time the condition transitioned from one status to another.
This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
format: date-time
type: string
message:
description: |-
message is a human readable message indicating details about the transition.
This may be an empty string.
maxLength: 32768
type: string
observedGeneration:
description: |-
observedGeneration represents the .metadata.generation that the condition was set based upon.
For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
with respect to the current state of the instance.
format: int64
minimum: 0
type: integer
reason:
description: |-
reason contains a programmatic identifier indicating the reason for the condition's last transition.
Producers of specific condition types may define expected values and meanings for this field,
and whether the values are considered a guaranteed API.
The value should be a CamelCase string.
This field may not be empty.
maxLength: 1024
minLength: 1
pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
type: string
status:
description: status of the condition, one of True, False,
Unknown.
enum:
- "True"
- "False"
- Unknown
type: string
type:
description: |-
type of condition in CamelCase or in foo.example.com/CamelCase.
---
Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be
useful (see .node.status.conditions), the ability to deconflict is important.
The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)
maxLength: 316
pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$
type: string
required:
- lastTransitionTime
- message
- reason
- status
- type
type: object
type: array
type: object
type: object
type: object
served: true
Expand Down
59 changes: 51 additions & 8 deletions controllers/dnspolicy_status.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ import (
"context"
"errors"
"slices"
"strings"

"k8s.io/apimachinery/pkg/api/equality"
apierrors "k8s.io/apimachinery/pkg/api/errors"
Expand All @@ -30,10 +31,13 @@ import (
"sigs.k8s.io/gateway-api/apis/v1alpha2"

kuadrantdnsv1alpha1 "github.com/kuadrant/dns-operator/api/v1alpha1"

"github.com/kuadrant/kuadrant-operator/api/v1alpha1"
"github.com/kuadrant/kuadrant-operator/pkg/library/kuadrant"
)

var NegativePolarityConditions []string

func (r *DNSPolicyReconciler) reconcileStatus(ctx context.Context, dnsPolicy *v1alpha1.DNSPolicy, specErr error) (ctrl.Result, error) {
newStatus := r.calculateStatus(ctx, dnsPolicy, specErr)

Expand Down Expand Up @@ -76,19 +80,22 @@ func (r *DNSPolicyReconciler) calculateStatus(ctx context.Context, dnsPolicy *v1
return newStatus
}

enforcedCondition := r.enforcedCondition(ctx, dnsPolicy)
recordsList := &kuadrantdnsv1alpha1.DNSRecordList{}
var enforcedCondition *metav1.Condition
if err := r.Client().List(ctx, recordsList); err != nil {
enforcedCondition = kuadrant.EnforcedCondition(dnsPolicy, kuadrant.NewErrUnknown(dnsPolicy.Kind(), err), false)
} else {
enforcedCondition = r.enforcedCondition(recordsList, dnsPolicy)
}

meta.SetStatusCondition(&newStatus.Conditions, *enforcedCondition)

propagateRecordConditions(recordsList, newStatus)

return newStatus
}

func (r *DNSPolicyReconciler) enforcedCondition(ctx context.Context, dnsPolicy *v1alpha1.DNSPolicy) *metav1.Condition {
recordsList := &kuadrantdnsv1alpha1.DNSRecordList{}
if err := r.Client().List(ctx, recordsList); err != nil {
r.Logger().V(1).Error(err, "error listing dns records")
return kuadrant.EnforcedCondition(dnsPolicy, kuadrant.NewErrUnknown(dnsPolicy.Kind(), err), false)
}

func (r *DNSPolicyReconciler) enforcedCondition(recordsList *kuadrantdnsv1alpha1.DNSRecordList, dnsPolicy *v1alpha1.DNSPolicy) *metav1.Condition {
var controlled bool
for _, record := range recordsList.Items {
// check that DNS record is controller by this policy
Expand All @@ -114,3 +121,39 @@ func (r *DNSPolicyReconciler) enforcedCondition(ctx context.Context, dnsPolicy *
// there are no controlled DNS records present
return kuadrant.EnforcedCondition(dnsPolicy, kuadrant.NewErrUnknown(dnsPolicy.Kind(), errors.New("policy is not enforced on any dns record: no routes attached for listeners")), false)
}

func propagateRecordConditions(records *kuadrantdnsv1alpha1.DNSRecordList, policyStatus *v1alpha1.DNSPolicyStatus) {
//reset conditions
policyStatus.ProbeConditions = map[string][]metav1.Condition{}

for _, record := range records.Items {
var allConditions []metav1.Condition
allConditions = append(allConditions, record.Status.Conditions...)
if record.Status.HealthCheck != nil {
allConditions = append(allConditions, record.Status.HealthCheck.Conditions...)

if record.Status.HealthCheck.Probes != nil {
for _, probeStatus := range record.Status.HealthCheck.Probes {
allConditions = append(allConditions, probeStatus.Conditions...)
}
}
}

for _, condition := range allConditions {
//skip healthy negative polarity conditions
if slices.Contains(NegativePolarityConditions, condition.Type) &&
strings.ToLower(string(condition.Status)) == "false" {
continue
}
//skip healthy positive polarity conditions
if !slices.Contains(NegativePolarityConditions, condition.Type) &&
strings.ToLower(string(condition.Status)) == "true" {
continue
}

policyStatus.ProbeConditions[*record.Spec.RootHost] = append(
policyStatus.ProbeConditions[*record.Spec.RootHost],
condition)
}
}
}
Loading

0 comments on commit c080b1c

Please sign in to comment.