Skip to content

docs(platform-stack): add trust-manager card#550

Open
Aleksei Sviridkin (lexfrei) wants to merge 1 commit into
mainfrom
feat/trust-manager-docs
Open

docs(platform-stack): add trust-manager card#550
Aleksei Sviridkin (lexfrei) wants to merge 1 commit into
mainfrom
feat/trust-manager-docs

Conversation

@lexfrei
Copy link
Copy Markdown
Contributor

@lexfrei Aleksei Sviridkin (lexfrei) commented May 26, 2026

What this PR does

Documents trust-manager as a cozystack platform component. Adds one oss-card to the "GitOps and platform automation" section of content/en/docs/next/guides/platform-stack/_index.md, immediately next to cert-manager.

Companion to the code PR cozystack/cozystack#2744 which ships trust-manager v0.22.1 as a system package installed into cozy-cert-manager alongside cert-manager. The card describes what trust-manager does (distributes CA bundles into namespaces via the cluster-scoped Bundle CRD) and the cozystack-specific architectural choice (co-located with cert-manager so TLS-bearing charts can project release-issued CAs into release-namespace ConfigMaps without consumer-side cross-namespace RBAC).

Why a single card and not a dedicated page

The platform-stack page is the canonical place where every cozystack-shipped open-source component gets a one-card summary with license + source link. cert-manager itself, External Secrets Operator, Velero — none has a dedicated component page; the operator-facing docs about cert-manager / trust-manager usage live in TLS-and-secrets guides that don't exist yet. When a guide eventually exists, that's where deeper trust-manager content (Bundle examples, namespaceSelector patterns, troubleshooting) belongs — out of scope here.

Notes on the card

  • Logo reuse: cert-manager.svg (trust-manager is part of the cert-manager project family; no separate brand asset upstream). A dedicated SVG can be added later if upstream publishes one.
  • License: Apache-2.0, source URL points at cert-manager/trust-manager/blob/main/LICENSE (default branch is main, not master).
  • Lands in content/en/docs/next/ (per CLAUDE.md guidance for unreleased features); will materialize as vX.Y/ when next is promoted.

Verification

  • Two-pass independent branch-review: both passes LGTM, all upstream claims (cluster-scoped Bundle CRD, license, source URL) verified against cert-manager/trust-manager v0.22.1.
  • Hugo shortcode signature matches all neighboring oss-card entries in the same section.

Release note

NONE

Summary by CodeRabbit

  • Documentation
    • Added trust-manager to the Cozystack platform stack documentation in the GitOps and platform automation section, including license information, upstream source link, and description of CA bundle distribution capabilities.

Review Change Stack

@netlify
Copy link
Copy Markdown

netlify Bot commented May 26, 2026

Deploy Preview for cozystack ready!

Name Link
🔨 Latest commit da1f898
🔍 Latest deploy log https://app.netlify.com/projects/cozystack/deploys/6a15bb243ba6600008ff8512
😎 Deploy Preview https://deploy-preview-550--cozystack.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 26, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 8614c9c4-a49a-42cc-ad42-cf6305eb1945

📥 Commits

Reviewing files that changed from the base of the PR and between 3720cbf and da1f898.

📒 Files selected for processing (1)
  • content/en/docs/next/guides/platform-stack/_index.md

📝 Walkthrough

Walkthrough

This PR adds a single documentation entry for the trust-manager platform component to the Cozystack platform stack guide. The new card documents trust-manager's role in distributing CA bundles via the Bundle CRD alongside cert-manager integration.

Changes

Platform Stack Documentation Update

Layer / File(s) Summary
trust-manager Component Entry
content/en/docs/next/guides/platform-stack/_index.md
Added trust-manager OSS component card to the "GitOps and platform automation" section with logo, Apache 2.0 license, upstream source link, and description of Bundle CRD functionality for CA bundle distribution.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A certificate bundle hops into the fold,
Trust-manager's card joins the story untold,
CA bundles distributed, crisp and clear,
The platform stack grows, year after year! 🌱

🚥 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 'docs(platform-stack): add trust-manager card' directly and specifically describes the main change: adding a trust-manager documentation card to the platform-stack guide.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/trust-manager-docs

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.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request adds a new oss-card entry for trust-manager to the platform stack documentation. The reviewer suggested a minor grammatical improvement to the description of trust-manager to enhance readability.

{{< oss-card name="Flux" logo="fluxcd" license="Apache-2.0; AGPL-3.0" source="https://github.com/fluxcd/flux2/blob/main/LICENSE" description="GitOps engine reconciling cluster state from Helm releases and Kustomizations. ControlPlane Flux Operator is AGPL-3.0; upstream controllers are Apache-2.0." >}}
{{< oss-card name="Aenix etcd Operator" logo="etcd" license="Apache-2.0" source="https://github.com/aenix-io/etcd-operator/blob/main/LICENSE" description="Manages dedicated etcd clusters for tenant Kubernetes control planes. Handles member lifecycle, scaling, and backup-restore as Kubernetes reconciliation loops." >}}
{{< oss-card name="cert-manager" logo="cert-manager" license="Apache-2.0" source="https://github.com/cert-manager/cert-manager/blob/master/LICENSE" description="Automates TLS certificate issuance, renewal, and rotation. Integrates with ACME, internal PKI (OpenBao), and self-signed issuers." >}}
{{< oss-card name="trust-manager" logo="cert-manager" license="Apache-2.0" source="https://github.com/cert-manager/trust-manager/blob/main/LICENSE" description="Distributes CA bundles into Kubernetes namespaces via the cluster-scoped Bundle CRD. Co-located with cert-manager so TLS-bearing charts can project release-issued CAs into release-namespace ConfigMaps without cross-namespace RBAC." >}}
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

To improve readability and use standard terminology, consider changing "release-namespace" to "release namespace" and adding "requiring" before "cross-namespace RBAC" to make the description grammatically complete and clearer.

Suggested change
{{< oss-card name="trust-manager" logo="cert-manager" license="Apache-2.0" source="https://github.com/cert-manager/trust-manager/blob/main/LICENSE" description="Distributes CA bundles into Kubernetes namespaces via the cluster-scoped Bundle CRD. Co-located with cert-manager so TLS-bearing charts can project release-issued CAs into release-namespace ConfigMaps without cross-namespace RBAC." >}}
{{< oss-card name="trust-manager" logo="cert-manager" license="Apache-2.0" source="https://github.com/cert-manager/trust-manager/blob/main/LICENSE" description="Distributes CA bundles into Kubernetes namespaces via the cluster-scoped Bundle CRD. Co-located with cert-manager so TLS-bearing charts can project release-issued CAs into release namespace ConfigMaps without requiring cross-namespace RBAC." >}}

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Addressed in da1f898 — applied both suggestions: release-namespacerelease namespace, and inserted requiring before cross-namespace RBAC.

Documents the new trust-manager system component shipping in the
upstream platform package. Reuses the cert-manager logo (no
separate brand asset upstream); we can swap in a dedicated SVG
later if upstream publishes one.

Assisted-By: Claude <noreply@anthropic.com>
Signed-off-by: Aleksei Sviridkin <f@lex.la>
Copy link
Copy Markdown
Contributor

@Arsolitt Arsolitt (Arsolitt) left a comment

Choose a reason for hiding this comment

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

LGTM — single oss-card for trust-manager, all upstream facts verified, builds clean.

Business context: documents trust-manager as a cozystack platform component (companion to the code change shipping trust-manager v0.22.1 co-located with cert-manager).

Verified:

  • License Apache-2.0 and source URL branch (main, not master) match the upstream cert-manager/trust-manager repo.
  • "cluster-scoped Bundle CRD" matches the upstream CRD definition (scope: Cluster).
  • Logo reuse (cert-manager.svg) resolves to an existing asset; the shortcode falls back to an initials badge if the file is missing.
  • The architectural description (co-location, CA projection into release-namespace ConfigMaps without cross-namespace RBAC) matches the companion code change.
  • Shortcode signature matches the neighboring oss-card entries; deploy preview builds.

No blockers, no follow-ups.

Copy link
Copy Markdown
Member

@lllamnyp Timofei Larkin (lllamnyp) left a comment

Choose a reason for hiding this comment

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

This cannot go live until the issues with cozystack/cozystack#2744 are resolved.

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.

3 participants