Skip to content

Commit 3f94372

Browse files
fix(mariadb-operator): derive the cluster name from the platform domain (#5123)
<!-- Thank you for making a contribution! Here are some tips for you: - Use Conventional Commits for the PR title: `type(scope): description` - Types: feat, fix, docs, style, refactor, perf, test, build, ci, chore - Scopes are not an exhaustive list — pick the most specific scope for the change and extend the list when a genuinely new area appears. Examples: - System components: dashboard, platform, operator, cilium, kube-ovn, linstor, fluxcd, cluster-api - Managed apps: postgres, mariadb, redis, kafka, clickhouse, virtual-machine, kubernetes - Development and maintenance: api, hack, tests, ci, docs, maintenance - Breaking changes: append `!` after type/scope (`feat(api)!: ...`) or add a `BREAKING CHANGE:` footer - If it's a work in progress, consider creating this PR as a draft. - Don't hesistate to ask for opinion and review in the community chats, even if it's still a draft. - Add the label `kind/backport` if it's a bugfix that needs to be backported to a previous version. --> ## What this PR does Fixes #2348. `packages/system/mariadb-operator/values.yaml` pins `mariadb-operator.clusterName: cozy.local`, and the vendored chart turns it into the operator's `CLUSTER_NAME` and into a SAN of the webhook certificate. On a platform installed with any other `networking.clusterDomain`, the operator resolves its own pods as `<name>.<ns>.svc.cozy.local` and gets NXDOMAIN. Observed on a cluster with `clusterDomain: lab.local`: a 2-replica MariaDB never gets replication configured (`status.replication` stays `{}`, the secondary runs as a standalone semi-sync master), and User, Database and Grant fail with `lookup mariadb-<name>-primary.<ns>.svc.cozy.local ... no such host`, while the operator only retries at verbosity 1. `clusterName` is a value of the vendored subchart, which the `_cluster` lookup used by package templates cannot reach. The platform now carries `networking.clusterDomain` under the `mariadb-operator` subchart key in the shared `cozystack-values` Secret, the same route `keda.clusterDomain` and `opensearch-operator.manager.dnsBase` already take. The literal in the package stays as the fallback for a render without that Secret, so a cluster on `cozy.local` renders exactly as before. Tests cover both ends of the path: `packages/core/platform/tests/apps_mariadb_operator_cluster_name_test.yaml` pins that the Secret carries the domain under the anchored subchart key and tracks a non-default value (it fails with the `apps.yaml` change reverted), and `packages/system/mariadb-operator/tests/cluster_name_test.yaml` pins that a domain set on that key reaches the operator's `CLUSTER_NAME` and the webhook certificate, with `cozy.local` kept as the standalone default. `make helm-unit-tests` passes locally. ### Screenshots <!-- REQUIRED for UI changes: attach screenshots or screen recordings demonstrating the visual impact of your changes. PRs with UI changes without screenshots will not be merged. --> ### Downstream repositories <!-- Cozystack is upstream for repositories that are NOT kept in sync with it automatically, and nothing in CI compares the two sides, so a change here can break them silently. Which change forces what, and which file to touch, is the trigger map in docs/agents/contributing.md under "Downstream Repositories". Walk it before you tick anything. IF YOU ARE AN AI AGENT OR AN LLM, THIS IS PART OF THE TASK, NOT A FORM TO FILL IN: 1. Walk the trigger map against the actual diff of this PR, file by file. Do not decide from the PR title or from your memory of what you changed. 2. For every repository you tick, open the follow-up PR there and link it on the same line. A ticked box with no link claims work that does not exist, which is worse than an empty box. Search that repository for an open PR or issue covering it first, and link that instead of filing a duplicate. 3. When the follow-up is out of scope, or needs a decision that is not yours to make, open an issue in that repository instead, link that, and say so in the PR body. Do not push a speculative PR into another repository just to fill a line here. 4. Do not tick "No downstream repository is affected" to make the checklist go away. If you are unsure, leave every box empty and say so in the PR body, so a human decides. --> - [x] No downstream repository is affected by this change - [ ] [cozystack/website](https://github.com/cozystack/website) - follow-up: - [ ] [cozystack/terraform-provider-cozystack](https://github.com/cozystack/terraform-provider-cozystack) - follow-up: - [ ] [cozystack/ansible-cozystack](https://github.com/cozystack/ansible-cozystack) - follow-up: - [ ] [cozystack/ccp](https://github.com/cozystack/ccp) - follow-up: - [ ] [cozystack/talm](https://github.com/cozystack/talm) - follow-up: - [ ] [cozystack/cozyhr](https://github.com/cozystack/cozyhr) - follow-up: - [ ] [cozystack/cozy-proxy](https://github.com/cozystack/cozy-proxy) - follow-up: - [ ] [cozystack/cozystack-telemetry-server](https://github.com/cozystack/cozystack-telemetry-server) - follow-up: - [ ] [cozystack/external-apps-example](https://github.com/cozystack/external-apps-example) - follow-up: - [ ] [cozystack/examples](https://github.com/cozystack/examples) - follow-up: - [ ] [cozystack/community](https://github.com/cozystack/community) - follow-up: ### Release note <!-- Write a release note: - Explain what has changed internally and for users. - Start with the same `type(scope):` prefix as in the PR title - Follow the guidelines at https://github.com/kubernetes/community/blob/master/contributors/guide/release-notes.md. --> ```release-note fix(mariadb-operator): the MariaDB operator now uses the platform's networking.clusterDomain instead of a hard-coded cozy.local, so replication and User/Database/Grant reconciliation work on clusters with a non-default cluster domain. ``` <!-- This is an auto-generated comment: release notes by coderabbit.ai --> <!-- coderabbit-ai-generated:v1 --> ## Summary by CodeRabbit * **New Features** * MariaDB now uses the configured networking domain as its cluster name and webhook certificate address. If no custom domain is configured, it continues to use the default cluster name and address. * **Tests** * Added coverage for default and custom domain settings, including their effect on the MariaDB cluster name and webhook certificate address. <!-- end of auto-generated comment: release notes by coderabbit.ai --> Backported-from: d61db78
2 parents 199054b + 17702dd commit 3f94372

5 files changed

Lines changed: 89 additions & 0 deletions

File tree

‎packages/core/platform/templates/apps.yaml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,14 @@ stringData:
3333
opensearch-operator:
3434
manager:
3535
dnsBase: {{ .Values.networking.clusterDomain | quote }}
36+
{{- /*
37+
The operator resolves its own MariaDB pods, and the webhook certificate
38+
gets its SAN, from CLUSTER_NAME, which the vendored subchart reads from
39+
clusterName. Same subchart-key route as above; a package rendered
40+
without this Secret falls back to the literal in its values.yaml.
41+
*/}}
42+
mariadb-operator:
43+
clusterName: {{ .Values.networking.clusterDomain | quote }}
3644
_cluster:
3745
root-host: {{ $rootHost | quote }}
3846
bundle-name: {{ .Values.bundles.system.variant | quote }}
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
suite: apps.yaml networking.clusterDomain reaches the mariadb-operator cluster name
2+
3+
templates:
4+
- templates/apps.yaml
5+
6+
release:
7+
name: cozy-platform
8+
namespace: cozy-system
9+
10+
# The operator dials <primary>.<ns>.svc.<CLUSTER_NAME> to set up replication and
11+
# to reconcile User, Database and Grant, and the vendored subchart fills
12+
# CLUSTER_NAME from clusterName. A cluster whose domain is not cozy.local got
13+
# NXDOMAIN on every such lookup while the literal was pinned in the package.
14+
# Every pattern anchors clusterName to its mariadb-operator parent, so a sibling
15+
# block carrying the same domain cannot satisfy the assertion on its own.
16+
17+
tests:
18+
- it: carries the cozy.local default under the subchart key
19+
asserts:
20+
- matchRegex:
21+
path: stringData["values.yaml"]
22+
pattern: '(?m)^mariadb-operator:\n clusterName: "cozy\.local"$'
23+
24+
- it: tracks a non-default networking.clusterDomain
25+
set:
26+
networking.clusterDomain: example.test
27+
asserts:
28+
- matchRegex:
29+
path: stringData["values.yaml"]
30+
pattern: '(?m)^mariadb-operator:\n clusterName: "example\.test"$'
31+
- notMatchRegex:
32+
path: stringData["values.yaml"]
33+
pattern: '(?m)^mariadb-operator:\n clusterName: "cozy\.local"$'

‎packages/system/mariadb-operator/Makefile‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ export NAMESPACE=cozy-$(NAME)
33

44
include ../../../hack/package.mk
55

6+
test:
7+
helm unittest .
8+
69
update:
710
rm -rf charts
811
helm repo add mariadb-operator https://mariadb-operator.github.io/mariadb-operator
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
suite: mariadb-operator package resolves its pods in the platform cluster domain
2+
release:
3+
name: mariadb-operator
4+
namespace: cozy-mariadb-operator
5+
# core/platform hands the cluster domain to this package as
6+
# mariadb-operator.clusterName in the shared values Secret. Guard that the
7+
# vendored chart still threads that key into what the operator and the webhook
8+
# certificate use, so a re-vendor that renames it goes red here.
9+
tests:
10+
- it: sets the operator CLUSTER_NAME from the injected domain
11+
templates:
12+
- charts/mariadb-operator/templates/operator/deployment.yaml
13+
set:
14+
mariadb-operator.clusterName: example.test
15+
asserts:
16+
- contains:
17+
path: spec.template.spec.containers[0].env
18+
content:
19+
name: CLUSTER_NAME
20+
value: example.test
21+
22+
- it: issues the webhook certificate for the injected domain
23+
templates:
24+
- charts/mariadb-operator/templates/webhook/certificate.yaml
25+
documentSelector:
26+
path: kind
27+
value: Certificate
28+
set:
29+
mariadb-operator.clusterName: example.test
30+
asserts:
31+
- contains:
32+
path: spec.dnsNames
33+
content: mariadb-operator-webhook.cozy-mariadb-operator.svc.example.test
34+
35+
- it: keeps cozy.local as the standalone default
36+
templates:
37+
- charts/mariadb-operator/templates/operator/deployment.yaml
38+
asserts:
39+
- contains:
40+
path: spec.template.spec.containers[0].env
41+
content:
42+
name: CLUSTER_NAME
43+
value: cozy.local

‎packages/system/mariadb-operator/values.yaml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
mariadb-operator:
2+
# Fallback only: core/platform injects networking.clusterDomain into this key
3+
# through the shared cozystack-values Secret (see its apps.yaml).
24
clusterName: cozy.local
35
metrics:
46
enabled: true

0 commit comments

Comments
 (0)