Skip to content

Conversation

@gnunn1
Copy link
Contributor

@gnunn1 gnunn1 commented Dec 3, 2025

What does this PR do / why we need it:

Fixes a couple of minor issues with the Agent instructions for cert-manager, specifically:

  • Suffixes the secret with -principal in the certificate since later instructions rely on that
  • Fixes the hardcoded managed-cluster for the commonName, this should be the cluster-name

Which issue(s) this PR fixes:

None

How to test changes / Special notes to the reviewer:

Follow instructions for using cert-manager for PKI

Checklist

  • Documentation update is required by this PR (and has been updated) OR no documentation update is required.

Summary by CodeRabbit

  • Documentation
    • Updated PKI certificate configuration examples to use revised naming conventions: secret names, certificate common names, and corresponding CLI sample commands now reflect the new cluster-specific identifiers.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link

coderabbitai bot commented Dec 3, 2025

Walkthrough

Updated documentation example for PKI certificates: spec.secretName now uses <cluster-name>-principal, spec.commonName now uses <cluster-name>, and a CLI output example references kubectl get secret <cluster-name>-agent ....

Changes

Cohort / File(s) Summary
PKI Certificate Configuration Documentation
docs/configuration/agent/pki-certificates.md
Adjusted example Certificate manifest values: spec.secretName changed from <cluster-name> to <cluster-name>-principal; spec.commonName changed from managed-cluster to <cluster-name>; CLI output example updated to reference <cluster-name>-agent secret.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • Single documentation file; only example value updates.
  • No code, API, or behavioral changes.

Suggested reviewers

  • jannfis
  • jgwest
  • chetan-rns
  • mikeshng

Poem

🐰 I hopped through docs with nimble feet,

Names aligned — now tidy and neat,
Secrets and CNs in proper place,
No more mismatched, a cleaner space,
🥕 Hooray for clarity, a happy trace!

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and specifically summarizes the main change: minor corrections to certificate documentation for the Agent using cert-manager, which aligns with the file changes updating secret names and commonName references.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 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 2a34d37 and be12f46.

📒 Files selected for processing (1)
  • docs/configuration/agent/pki-certificates.md (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/configuration/agent/pki-certificates.md
⏰ 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: Build and push image
  • GitHub Check: Analyze (go)

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

Comment @coderabbitai help to get the list of available commands and usage tips.

@gnunn1
Copy link
Contributor Author

gnunn1 commented Dec 3, 2025

Please don't merge this yet, I need to look at this one more time with a clear head.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant