Skip to content

K8SPSMDB-1608: add externaldns annotation to create dns for created loadbalancer #2280

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

Open
myJamong wants to merge 15 commits into
base: main
Choose a base branch
from
Open

K8SPSMDB-1608: add externaldns annotation to create dns for created loadbalancer #2280

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
c613276
add externaldns annotations
myJamong Mar 6, 2026
f22a115
add validation for ttl and mongos
myJamong Mar 9, 2026
90546a3
add unit test
myJamong Mar 9, 2026
efb7c81
change example cr prod to service-name
myJamong Mar 9, 2026
f991502
add externalDNS field to CRD schema and deepcopy
myJamong Mar 10, 2026
ee194e4
remove required for prefix and use cr name as default
myJamong Mar 10, 2026
19a85b2
Move externalDNS validation and default prefix logic from reconcile f…
myJamong Mar 10, 2026
ff70a0b
run make generate manifest
myJamong Mar 10, 2026
abd5cfa
remove log for every reconcile loop
myJamong Apr 23, 2026
32387a8
Merge branch 'main' into NO-TICKET-YET-add-externaldns-anotation
egegunes Apr 24, 2026
97fe53d
Merge branch 'main' into NO-TICKET-YET-add-externaldns-anotation
hors May 6, 2026
4f3054f
Merge branch 'main' into NO-TICKET-YET-add-externaldns-anotation
hors May 13, 2026
cb82fb8
Merge branch 'main' into NO-TICKET-YET-add-externaldns-anotation
egegunes May 26, 2026
3112f13
Update pkg/apis/psmdb/v1/psmdb_types.go
myJamong May 26, 2026
5c4a043
Merge branch 'main' into NO-TICKET-YET-add-externaldns-anotation
hors May 27, 2026
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 config/crd/bases/psmdb.percona.com_perconaservermongodbs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3954,6 +3954,18 @@ spec:
type: boolean
exposeType:
type: string
externalDNS:
properties:
domain:
type: string
prefix:
type: string
ttl:
minimum: 0
type: integer
required:
- domain
type: object
externalTrafficPolicy:
type: string
internalTrafficPolicy:
Expand Down Expand Up @@ -14783,6 +14795,18 @@ spec:
type: boolean
exposeType:
type: string
externalDNS:
properties:
domain:
type: string
prefix:
type: string
ttl:
minimum: 0
type: integer
required:
- domain
type: object
externalTrafficPolicy:
type: string
internalTrafficPolicy:
Expand Down Expand Up @@ -23229,6 +23253,18 @@ spec:
type: object
exposeType:
type: string
externalDNS:
properties:
domain:
type: string
prefix:
type: string
ttl:
minimum: 0
type: integer
required:
- domain
type: object
externalTrafficPolicy:
type: string
internalTrafficPolicy:
Expand Down
36 changes: 36 additions & 0 deletions deploy/bundle.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4841,6 +4841,18 @@ spec:
type: boolean
exposeType:
type: string
externalDNS:
properties:
domain:
type: string
prefix:
type: string
ttl:
minimum: 0
type: integer
required:
- domain
type: object
externalTrafficPolicy:
type: string
internalTrafficPolicy:
Expand Down Expand Up @@ -15670,6 +15682,18 @@ spec:
type: boolean
exposeType:
type: string
externalDNS:
properties:
domain:
type: string
prefix:
type: string
ttl:
minimum: 0
type: integer
required:
- domain
type: object
externalTrafficPolicy:
type: string
internalTrafficPolicy:
Expand Down Expand Up @@ -24116,6 +24140,18 @@ spec:
type: object
exposeType:
type: string
externalDNS:
properties:
domain:
type: string
prefix:
type: string
ttl:
minimum: 0
type: integer
required:
- domain
type: object
externalTrafficPolicy:
type: string
internalTrafficPolicy:
Expand Down
12 changes: 12 additions & 0 deletions deploy/cr.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -263,6 +263,10 @@ spec:
# rack: rack-22
# internalTrafficPolicy: Local
# externalTrafficPolicy: Local
# externalDNS:
# prefix: "service-name"
# domain: "mongo.example.com"
# ttl: 300
resources:
limits:
cpu: "600m"
Expand Down Expand Up @@ -573,6 +577,10 @@ spec:
# rack: rack-22
# internalTrafficPolicy: Local
# externalTrafficPolicy: Local
# externalDNS:
# prefix: "service-name"
# domain: "mongo.example.com"
# ttl: 300
resources:
limits:
cpu: "600m"
Expand Down Expand Up @@ -698,6 +706,10 @@ spec:
# nodePort: 32017
# internalTrafficPolicy: Local
# externalTrafficPolicy: Local
# externalDNS:
# prefix: "service-name"
# domain: "mongo.example.com"
# ttl: 300
# hostAliases:
# - ip: "10.10.0.2"
# hostnames:
Expand Down
36 changes: 36 additions & 0 deletions deploy/crd.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4841,6 +4841,18 @@ spec:
type: boolean
exposeType:
type: string
externalDNS:
properties:
domain:
type: string
prefix:
type: string
ttl:
minimum: 0
type: integer
required:
- domain
type: object
externalTrafficPolicy:
type: string
internalTrafficPolicy:
Expand Down Expand Up @@ -15670,6 +15682,18 @@ spec:
type: boolean
exposeType:
type: string
externalDNS:
properties:
domain:
type: string
prefix:
type: string
ttl:
minimum: 0
type: integer
required:
- domain
type: object
externalTrafficPolicy:
type: string
internalTrafficPolicy:
Expand Down Expand Up @@ -24116,6 +24140,18 @@ spec:
type: object
exposeType:
type: string
externalDNS:
properties:
domain:
type: string
prefix:
type: string
ttl:
minimum: 0
type: integer
required:
- domain
type: object
externalTrafficPolicy:
type: string
internalTrafficPolicy:
Expand Down
36 changes: 36 additions & 0 deletions deploy/cw-bundle.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4841,6 +4841,18 @@ spec:
type: boolean
exposeType:
type: string
externalDNS:
properties:
domain:
type: string
prefix:
type: string
ttl:
minimum: 0
type: integer
required:
- domain
type: object
externalTrafficPolicy:
type: string
internalTrafficPolicy:
Expand Down Expand Up @@ -15670,6 +15682,18 @@ spec:
type: boolean
exposeType:
type: string
externalDNS:
properties:
domain:
type: string
prefix:
type: string
ttl:
minimum: 0
type: integer
required:
- domain
type: object
externalTrafficPolicy:
type: string
internalTrafficPolicy:
Expand Down Expand Up @@ -24116,6 +24140,18 @@ spec:
type: object
exposeType:
type: string
externalDNS:
properties:
domain:
type: string
prefix:
type: string
ttl:
minimum: 0
type: integer
required:
- domain
type: object
externalTrafficPolicy:
type: string
internalTrafficPolicy:
Expand Down
18 changes: 18 additions & 0 deletions pkg/apis/psmdb/v1/psmdb_defaults.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -350,6 +350,15 @@ func (cr *PerconaServerMongoDB) CheckNSetDefaults(ctx context.Context, platform
if len(cr.Spec.Sharding.Mongos.ServiceAccountName) == 0 && cr.CompareVersion("1.16.0") >= 0 {
cr.Spec.Sharding.Mongos.ServiceAccountName = WorkloadSA
}

if dns := cr.Spec.Sharding.Mongos.Expose.ExternalDNS; dns != nil {
if dns.Domain == "" {
return errors.New("externalDNS requires domain for mongos")
}
if dns.Prefix == "" {
dns.Prefix = cr.Name
}
}
}

if mongos := cr.Spec.Sharding.Mongos; mongos != nil && cr.CompareVersion("1.18.0") >= 0 && cr.Status.State == AppStateInit {
Expand Down Expand Up @@ -720,6 +729,15 @@ func (rs *ReplsetSpec) SetDefaults(platform version.Platform, cr *PerconaServerM
}
}

if dns := rs.Expose.ExternalDNS; dns != nil {
if dns.Domain == "" {
return fmt.Errorf("externalDNS requires domain for replset %s", rs.Name)
}
if dns.Prefix == "" {
dns.Prefix = cr.Name
}
}

if cr.CompareVersion("1.18.0") >= 0 && cr.Status.State == AppStateInit {
if rs.Expose.DeprecatedExposeType != "" {
log.Info("Field `.expose.exposeType` was deprecated in 1.18.0. Consider using `.expose.type` instead", "cluster", cr.Name, "namespace", cr.Namespace, "replset", rs.Name)
Expand Down
10 changes: 10 additions & 0 deletions pkg/apis/psmdb/v1/psmdb_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1458,6 +1458,16 @@ type Expose struct {

InternalTrafficPolicy *corev1.ServiceInternalTrafficPolicy `json:"internalTrafficPolicy,omitempty"`
ExternalTrafficPolicy corev1.ServiceExternalTrafficPolicy `json:"externalTrafficPolicy,omitempty"`

ExternalDNS *ExternalDNSConfig `json:"externalDNS,omitempty"`
}

type ExternalDNSConfig struct {
Prefix string `json:"prefix,omitempty"`
// +kubebuilder:validation:Required
Domain string `json:"domain"`
Comment thread
myJamong marked this conversation as resolved.
// +kubebuilder:validation:Minimum=0
TTL int `json:"ttl,omitempty"`
}

func (e *Expose) SaveOldMeta() bool {
Expand Down
5 changes: 5 additions & 0 deletions pkg/apis/psmdb/v1/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.

7 changes: 7 additions & 0 deletions pkg/controller/perconaservermongodb/service.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import (
k8serrors "k8s.io/apimachinery/pkg/api/errors"
"k8s.io/apimachinery/pkg/labels"
"sigs.k8s.io/controller-runtime/pkg/client"
logf "sigs.k8s.io/controller-runtime/pkg/log"

api "github.com/percona/percona-server-mongodb-operator/pkg/apis/psmdb/v1"
"github.com/percona/percona-server-mongodb-operator/pkg/mcs"
Expand All @@ -28,7 +29,13 @@ func (r *ReconcilePerconaServerMongoDB) reconcileServices(ctx context.Context, c
}

func (r *ReconcilePerconaServerMongoDB) reconcileReplsetServices(ctx context.Context, cr *api.PerconaServerMongoDB, repls []*api.ReplsetSpec) error {
log := logf.FromContext(ctx)

for _, rs := range repls {
if rs.Expose.ExternalDNS != nil && !rs.Expose.Enabled {
log.Info("externalDNS is configured but expose is not enabled, skipping DNS annotations", "replset", rs.Name)
}
Copy link
Copy Markdown
Member

@mayankshah1607 mayankshah1607 Apr 14, 2026

Choose a reason for hiding this comment

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

Will this get logged on every reconciliation?

Copy link
Copy Markdown
Contributor Author

@myJamong myJamong Apr 23, 2026

Choose a reason for hiding this comment

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

@mayankshah1607
You're right, this fires every reconcile. The log prints about every ~11s (default reconcile interval) and it is quite noisy.

Let me change it back to just silently skip when expose is disabled.
Thanks for catching this.

Copy link
Copy Markdown
Contributor Author

@myJamong myJamong Apr 23, 2026

Choose a reason for hiding this comment

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

Removed the logging parts.
abd5cfa


// Create headless service
service := psmdb.Service(cr, rs)
if err := setControllerReference(cr, service, r.scheme); err != nil {
Expand Down
20 changes: 19 additions & 1 deletion pkg/psmdb/mongos.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -434,7 +434,25 @@ func MongosService(cr *api.PerconaServerMongoDB, name string) corev1.Service {
}

if cr.Spec.Sharding.Mongos != nil {
svc.Annotations = cr.Spec.Sharding.Mongos.Expose.ServiceAnnotations
annotations := make(map[string]string)
for k, v := range cr.Spec.Sharding.Mongos.Expose.ServiceAnnotations {
annotations[k] = v
}

if dns := cr.Spec.Sharding.Mongos.Expose.ExternalDNS; dns != nil {
var hostname string
if cr.Spec.Sharding.Mongos.Expose.ServicePerPod {
hostname = BuildDNSHostname(dns, "mongos", name)
} else {
hostname = BuildDNSHostnameWithoutIndex(dns, "mongos")
}
annotations["external-dns.alpha.kubernetes.io/hostname"] = hostname
if dns.TTL > 0 {
annotations["external-dns.alpha.kubernetes.io/ttl"] = strconv.Itoa(dns.TTL)
}
}

svc.Annotations = annotations
for k, v := range cr.Spec.Sharding.Mongos.Expose.ServiceLabels {
if _, ok := svc.Labels[k]; !ok {
svc.Labels[k] = v
Expand Down
Loading
Loading