Skip to content

fix(base-cluster/certificates): certificate for baseDomain is not used#1644

Merged
cwrau merged 1 commit intomainfrom
fix/base-cluster/superfluous-certificate
Aug 4, 2025
Merged

fix(base-cluster/certificates): certificate for baseDomain is not used#1644
cwrau merged 1 commit intomainfrom
fix/base-cluster/superfluous-certificate

Conversation

@cwrau
Copy link
Copy Markdown
Member

@cwrau cwrau commented Jul 31, 2025

Summary by CodeRabbit

  • Chores
    • Updated certificate configuration to include only the wildcard DNS name.
    • Certificate activation now requires both a base domain and a DNS provider to be set.

Copilot AI review requested due to automatic review settings July 31, 2025 09:40
@cwrau cwrau enabled auto-merge July 31, 2025 09:40
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR fixes an issue where the certificate for the base domain was not being used by updating the condition logic and DNS configuration in the certificates section. The fix ensures that the certificate is only created when both a base domain is provided and a DNS provider is configured.

  • Simplified the DNS names configuration to only include the wildcard domain
  • Updated the condition to require both a base domain and DNS provider to be present

Comment thread charts/base-cluster/values.yaml
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jul 31, 2025

Walkthrough

The update changes the logic for configuring cluster wildcard certificates in the Helm chart values. It removes the base domain from the DNS names list, always includes the wildcard DNS entry, and modifies the condition to require both a non-empty base domain and a specified DNS provider for the certificate configuration to be applied.

Changes

Cohort / File(s) Change Summary
Certificate Configuration Logic
charts/base-cluster/values.yaml
Refactored certificate DNS names to always include only the wildcard entry; updated the activation condition to require both a non-empty base domain and a DNS provider.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Poem

A rabbit hops through YAML fields,
Adjusts the certs, ensures they're sealed.
No more base domain, just wildcards remain,
DNS provider must now explain.
With tidy logic and fluffy cheer,
The cluster's safer, never fear!
🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a6ef45a and 7db8d79.

📒 Files selected for processing (1)
  • charts/base-cluster/values.yaml (1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: cwrau
PR: teutonet/teutonet-helm-charts#1601
File: charts/base-cluster/templates/dns/external-dns.yaml:33-39
Timestamp: 2025-07-24T09:56:41.380Z
Learning: In the teutonet-helm-charts base-cluster chart, secret names like "external-dns" for Cloudflare provider are intentionally hard-coded. Users who need custom secret names should use Helm's `valuesFrom` feature to override values rather than expecting dedicated fields in values.yaml. This design keeps the values.yaml clean while still allowing full customization flexibility.
Learnt from: cwrau
PR: teutonet/teutonet-helm-charts#1601
File: charts/base-cluster/templates/dns/external-dns.yaml:30-32
Timestamp: 2025-07-24T09:55:53.655Z
Learning: In charts/base-cluster/templates/dns/external-dns.yaml, the dns.provider field in values.yaml has always been expected to be a map format (e.g., `{ cloudflare: {} }`), never a string format. The template correctly uses `{{ .Values.dns.provider | keys | first }}` to extract the provider name from the map keys.
charts/base-cluster/values.yaml (2)

Learnt from: cwrau
PR: #1601
File: charts/base-cluster/templates/dns/external-dns.yaml:30-32
Timestamp: 2025-07-24T09:55:53.655Z
Learning: In charts/base-cluster/templates/dns/external-dns.yaml, the dns.provider field in values.yaml has always been expected to be a map format (e.g., { cloudflare: {} }), never a string format. The template correctly uses {{ .Values.dns.provider | keys | first }} to extract the provider name from the map keys.

Learnt from: cwrau
PR: #1601
File: charts/base-cluster/templates/dns/external-dns.yaml:33-39
Timestamp: 2025-07-24T09:56:41.380Z
Learning: In the teutonet-helm-charts base-cluster chart, secret names like "external-dns" for Cloudflare provider are intentionally hard-coded. Users who need custom secret names should use Helm's valuesFrom feature to override values rather than expecting dedicated fields in values.yaml. This design keeps the values.yaml clean while still allowing full customization flexibility.

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: check licenses
  • GitHub Check: lint helm chart (base-cluster)
🔇 Additional comments (1)
charts/base-cluster/values.yaml (1)

59-61: Apex domain is no longer covered by the certificate – double-check caller expectations

By removing the plain {{ .Values.global.baseDomain | quote }} entry, the certificate will not be valid for the root domain (example.com); it will only cover sub-domains (*.example.com).
If any ingress, redirect, or HTTP-01/ALPN challenge ever targets the apex, this change breaks TLS termination.

Request verification that:

  1. No component exposes the bare domain.
  2. A separate certificate exists if apex coverage is still required.
✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix/base-cluster/superfluous-certificate

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@cwrau cwrau added this pull request to the merge queue Aug 4, 2025
Merged via the queue into main with commit 6a3ccae Aug 4, 2025
35 checks passed
@cwrau cwrau deleted the fix/base-cluster/superfluous-certificate branch August 4, 2025 07:08
github-merge-queue Bot pushed a commit that referenced this pull request Aug 15, 2025
🤖 I have created a release *beep* *boop*
---


##
[9.2.0](base-cluster-v9.1.1...base-cluster-v9.2.0)
(2025-08-14)


### Features

* **base-cluster/cert-manager:** enableCertificateOwnerRef
([#1653](#1653))
([283d86f](283d86f))
* **base-cluster/cert-manager:** use oci repository
([#1650](#1650))
([ef6382d](ef6382d))
* **base-cluster/kyverno:** enable policyExceptions for kyverno
([#1655](#1655))
([2029bcb](2029bcb))


### Bug Fixes

* **base-cluster/certificates:** certificate for `baseDomain` is not
used
([#1644](#1644))
([6a3ccae](6a3ccae))
* **base-cluster/dns:** only deploy external-dns HelmRepository if
needed
([#1645](#1645))
([7d313f2](7d313f2))
* **base-cluster/ingress-nginx:** set a couple of timeouts in the
loadbalancer to the maximum value
([#1571](#1571))
([bc6fe78](bc6fe78))
* **base-cluster/monitoring:** remove versions from datasources so they
always take precedence
([#1651](#1651))
([6821ed8](6821ed8))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- New Features
  - Cert-manager: option to set certificate owner references.
  - Cert-manager: support for pulling from an OCI repository.
  - Kyverno: ability to enable policy exceptions.

- Bug Fixes
  - Corrected use of the base domain certificate.
  - External DNS repository now created only when required.
- Ingress load balancer timeouts set to maximum to prevent premature
terminations.
  - Monitoring datasources prioritized by removing version pinning.

- Chores
  - Bumped base-cluster chart to 9.2.0 and updated release notes.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants