Skip to content

Clarify semantics of AttachedConnector spec.tlsCredentials#2527

Open
c-kruse wants to merge 1 commit into
skupperproject:mainfrom
c-kruse:update-attachedconnector-apidocs
Open

Clarify semantics of AttachedConnector spec.tlsCredentials#2527
c-kruse wants to merge 1 commit into
skupperproject:mainfrom
c-kruse:update-attachedconnector-apidocs

Conversation

@c-kruse

@c-kruse c-kruse commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

Closes #2526

Summary by CodeRabbit

  • Documentation
    • Clarified where TLS certificate bundles are stored for connector setup, making the reference location in the Site namespace easier to understand.

Signed-off-by: Christian Kruse <christian@c-kruse.com>
@coderabbitai

coderabbitai Bot commented Jul 8, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: cdea5b2a-5154-4071-a882-39be2fc188d4

📥 Commits

Reviewing files that changed from the base of the PR and between 172317c and fa13e18.

📒 Files selected for processing (1)
  • config/crd/bases/skupper_attached_connector_crd.yaml

📝 Walkthrough

Walkthrough

The CRD documentation for the AttachedConnector's spec.tlsCredentials field is updated to clarify that the referenced Secret containing TLS certificates resides in the Site namespace (spec.siteNamespace), replacing the previous, misleading description referencing the current namespace.

Changes

AttachedConnector CRD Description Update

Layer / File(s) Summary
Update tlsCredentials description
config/crd/bases/skupper_attached_connector_crd.yaml
Corrects the schema description to state the TLS certificate Secret is located in the Site namespace, removing the confusing reference to the current namespace and non-Kubernetes runtime behavior.

Estimated code review effort: 1 (Trivial) | ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main change to AttachedConnector tlsCredentials documentation.
Linked Issues check ✅ Passed The doc change addresses the reported confusion by clarifying the Secret is in the Site namespace and removing the misleading current-namespace wording.
Out of Scope Changes check ✅ Passed The PR only updates one CRD documentation line for the same field, with no unrelated code or schema changes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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.

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.

AttachedConnector spec.tlsCredentials description confusing

2 participants