Skip to content
This repository was archived by the owner on Apr 13, 2026. It is now read-only.

chore: add kubernetes deployer concept doc#778

Merged
jakobmoellerdev merged 5 commits into
open-component-model:mainfrom
Skarlso:add-deployment-concept
Mar 26, 2026
Merged

chore: add kubernetes deployer concept doc#778
jakobmoellerdev merged 5 commits into
open-component-model:mainfrom
Skarlso:add-deployment-concept

Conversation

@Skarlso

@Skarlso Skarlso commented Mar 20, 2026

Copy link
Copy Markdown
Contributor

What this PR does / why we need it

Part of open-component-model/ocm-project#890.

Which issue(s) this PR is related to

Type of content

  • Tutorial (getting-started/ or tutorials/)
  • How-to Guide (how-to/)
  • Explanation / Concept (concepts/)
  • Reference (reference/)
  • Other (infrastructure, config, fixes)

Checklist

  • I have read and followed the Contributing Guide
  • All commands/code snippets are tested and can be copy-pasted

@Skarlso Skarlso requested a review from a team as a code owner March 20, 2026 21:48
@netlify

netlify Bot commented Mar 20, 2026

Copy link
Copy Markdown

Deploy Preview for open-component-model ready!

Name Link
🔨 Latest commit 9eb71a3
🔍 Latest deploy log https://app.netlify.com/projects/open-component-model/deploys/69c57c1c0bb0b20008e00d7e
😎 Deploy Preview https://deploy-preview-778--open-component-model.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

coderabbitai Bot commented Mar 20, 2026

Copy link
Copy Markdown

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

Added a new Kubernetes Deployer doc and reworked OCM controllers docs; adjusted front-matter ordering for several concept pages and expanded the repository wordlist with a few tokens. Documentation details Deployer reconciliation, ApplySet behavior, drift detection, deletion finalizers, and blob caching.

Changes

Cohort / File(s) Summary
Kubernetes Deployer doc
content/docs/concepts/kubernetes-deployer.md
New long-form doc describing the Deployer controller reconciliation chain, manifest download/decoding, atomic server-side apply (ApplySet / KEP-3659), automatic pruning and ownership labeling, runtime informers for drift detection, two-phase deletion with finalizers, LRU blob caching keyed by digest, metadata labels/annotations, usage scenarios, front matter, and a Mermaid flowchart.
OCM controllers & related concepts
content/docs/concepts/ocm-controllers.md, content/docs/concepts/component-identity.md, content/docs/concepts/credential-system.md, content/docs/concepts/plugin-system.md, content/docs/concepts/resolvers.md, content/docs/concepts/signing-and-verification-concept.md, content/docs/concepts/transfer-concept.md
Reworked ocm-controllers.md (reconciliation chain, async resolution, config propagation, additionalStatusFields, updated links/install guidance). Other concept files only had front-matter weight metadata changes to adjust ordering.
Repo config / Wordlist
.github/config/wordlist.txt
Added new tokens (KEP, LRU, deduplicated, unregisters) to the wordlist. No behavioral changes.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  participant Repo as Repository
  participant Comp as Component
  participant Res as Resource
  participant Deployer as Deployer
  participant Cluster as Kubernetes Cluster

  Repo->>Comp: publish component/version reference
  Comp->>Res: resolve resource reference
  Res->>Deployer: reference with blob digest (Resource Ready)
  Deployer->>Deployer: wait for Ready, LRU cache lookup, download blob
  Deployer->>Deployer: decode manifests (YAML/JSON)
  Deployer->>Cluster: apply manifests (server-side apply / ApplySet)
  Deployer->>Deployer: create runtime informers for deployed types
  Deployer->>Deployer: monitor drift, trigger reconciles, prune disappeared resources
  Deployer->>Res: add finalizers (`applyset-prune`, `watch`) during deletion flow
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested labels

area/documentation, kind/chore

Suggested reviewers

  • frewilhelm
  • matthiasbruns
  • morri-son

Poem

🐰 I hopped through docs with nimble feet,
Wrote of applysets and manifests neat,
Caches kept crumbs, finalizers guide,
Watchers listen while clusters bide,
A rabbit cheers—deployments complete 🥕

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly describes the main change: adding a Kubernetes deployer concept documentation page, which aligns with the primary file addition in the changeset.
Description check ✅ Passed The description is related to the changeset, identifying this as an Explanation/Concept content addition and linking to the related GitHub issue #890.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 3

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@content/docs/concepts/kubernetes-deployer.md`:
- Around line 40-60: Add the technical terms causing spellcheck failures ("KEP"
/ "KEP-3659", "unregisters", and "LRU") to the repository spelling allowlist (or
replace with accepted alternatives) so the CI spellcheck stops flagging them;
update the repository spell dictionary (e.g., your project's spelling/allowlist
file such as .spelling, .cspell.json, or the configured spellcheck wordlist) to
include "KEP", "KEP-3659", "unregisters", and "LRU" and commit that small patch
so the content in the Deployer doc (the references to KEP-3659, unregisters, and
LRU cache) passes the pipeline.
- Line 107: The file ends without the required single trailing newline causing
MD047; open the markdown containing the line with the link "[Setup Controller
Environment]({{< relref \"setup-controller-environment.md\" >}}), prerequisites
for running the controllers" and add exactly one newline character at the end of
the file (ensure no extra blank lines or EOF whitespace).
- Around line 96-103: Replace the placeholder link texts in the
kubernetes-deployer.md doc: swap `<insert rel for deployment with controller>`
with the real relative path/slug for the "Deploy with Controllers" Podinfo
deployment tutorial and replace `<placeholder for deploy with kro and flux doc>`
with the correct URL or relative path for the "Deploy with Controllers" (Kro +
Flux) walkthrough; also remove the inline backticks surrounding the link target
so the markdown link for "Deploy with Controllers" renders correctly (ensure the
link uses standard Markdown [text](url) form).

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 81997a3c-ba36-4b48-88d1-15e2cab7ef6b

📥 Commits

Reviewing files that changed from the base of the PR and between 56ad181 and 85c444f.

📒 Files selected for processing (1)
  • content/docs/concepts/kubernetes-deployer.md

Comment thread content/docs/concepts/kubernetes-deployer.md
Comment thread content/docs/concepts/kubernetes-deployer.md Outdated
Comment thread content/docs/concepts/kubernetes-deployer.md Outdated
@Skarlso Skarlso force-pushed the add-deployment-concept branch from 85c444f to 6c86f6a Compare March 20, 2026 21:52
@jakobmoellerdev jakobmoellerdev force-pushed the add-deployment-concept branch 2 times, most recently from 63b8e29 to 84a2040 Compare March 26, 2026 14:13

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@content/docs/concepts/ocm-controllers.md`:
- Line 76: The link text "[Kubernetes Deployer](`<kubernetes-deploy.md doc
placeholder>`)" is malformed; replace that placeholder/backticked link with the
Hugo reference shortcode used elsewhere in this file (as on the earlier example
line) so the link points to the real page (use the ref/relref shortcode pointing
at "kubernetes-deploy.md" and keep the visible text "Kubernetes
Deployer")—update the string in the paragraph containing the current malformed
link to use the Hugo shortcode instead of the backticked placeholder.
- Line 78: Replace the incorrect credential link target in the ocm-controllers
docs: in content/docs/concepts/ocm-controllers.md update the markdown link text
currently pointing to "configure-credentials-for-controllers.md" so it
references the correct file "configure-credentials-ocm-controllers.md" (i.e.,
change the relref target string used in the link). Ensure the link syntax around
the existing "[Configuring Credentials]" anchor remains unchanged except for the
filename.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 07e183ea-cc37-4de1-adf9-f27485410ba1

📥 Commits

Reviewing files that changed from the base of the PR and between 63b8e29 and 84a2040.

📒 Files selected for processing (3)
  • .github/config/wordlist.txt
  • content/docs/concepts/kubernetes-deployer.md
  • content/docs/concepts/ocm-controllers.md
✅ Files skipped from review due to trivial changes (2)
  • .github/config/wordlist.txt
  • content/docs/concepts/kubernetes-deployer.md

Comment thread content/docs/concepts/ocm-controllers.md Outdated
Comment thread content/docs/concepts/ocm-controllers.md Outdated
@jakobmoellerdev jakobmoellerdev force-pushed the add-deployment-concept branch 2 times, most recently from 67cc579 to 1602584 Compare March 26, 2026 14:47
Comment thread content/docs/concepts/ocm-controllers.md Outdated
Comment thread content/docs/concepts/ocm-controllers.md Outdated
Comment thread content/docs/concepts/ocm-controllers.md Outdated
Comment thread content/docs/concepts/ocm-controllers.md Outdated
Comment thread content/docs/concepts/ocm-controllers.md
Comment thread content/docs/concepts/ocm-controllers.md Outdated
Comment thread content/docs/concepts/ocm-controllers.md Outdated
Comment thread content/docs/concepts/ocm-controllers.md Outdated
Comment thread content/docs/concepts/ocm-controllers.md Outdated
Skarlso and others added 2 commits March 26, 2026 18:51
On-behalf-of: Gergely Brautigam <gergely.brautigam@sap.com>

Co-authored-by: Jakob Möller <jakob.moeller@sap.com>
Signed-off-by: Gergely Brautigam <182850+Skarlso@users.noreply.github.com>
Signed-off-by: Jakob Möller <contact@jakob-moeller.com>
Signed-off-by: Jakob Möller <contact@jakob-moeller.com>
@jakobmoellerdev jakobmoellerdev force-pushed the add-deployment-concept branch 2 times, most recently from cbbeb12 to c4e340a Compare March 26, 2026 17:54
Signed-off-by: Jakob Möller <contact@jakob-moeller.com>
@jakobmoellerdev jakobmoellerdev force-pushed the add-deployment-concept branch from c4e340a to 5614593 Compare March 26, 2026 18:20
Comment thread content/docs/concepts/kubernetes-deployer.md Outdated
Signed-off-by: Gerald Morrison <67469729+morri-son@users.noreply.github.com>
Comment thread content/docs/concepts/kubernetes-deployer.md Outdated
Signed-off-by: Gerald Morrison <67469729+morri-son@users.noreply.github.com>
@jakobmoellerdev jakobmoellerdev enabled auto-merge (squash) March 26, 2026 18:35
@jakobmoellerdev jakobmoellerdev merged commit f9a3983 into open-component-model:main Mar 26, 2026
10 checks passed
ocmbot Bot pushed a commit that referenced this pull request Mar 26, 2026
<!-- markdownlint-disable MD041 -->
#### What this PR does / why we need it

Part of open-component-model/ocm-project#890.

#### Which issue(s) this PR is related to
<!--
Usage: `Related to #<issue number>`, or `Related to (paste link of
issue)`.
-->

#### Type of content
<!--
Which section does this PR target? See CONTRIBUTING.md for guidance.
-->
- [ ] Tutorial (`getting-started/` or `tutorials/`)
- [ ] How-to Guide (`how-to/`)
- [x] Explanation / Concept (`concepts/`)
- [ ] Reference (`reference/`)
- [ ] Other (infrastructure, config, fixes)

#### Checklist

- [x] I have read and followed the [Contributing
Guide](https://github.com/open-component-model/ocm-website/blob/main/CONTRIBUTING.md)
- [x] All commands/code snippets are tested and can be copy-pasted

---------

Signed-off-by: Gergely Brautigam <182850+Skarlso@users.noreply.github.com>
Signed-off-by: Jakob Möller <contact@jakob-moeller.com>
Signed-off-by: Gerald Morrison <67469729+morri-son@users.noreply.github.com>
Co-authored-by: Jakob Möller <jakob.moeller@sap.com>
Co-authored-by: Jakob Möller <contact@jakob-moeller.com>
Co-authored-by: Gerald Morrison <67469729+morri-son@users.noreply.github.com> f9a3983
@coderabbitai coderabbitai Bot mentioned this pull request Mar 30, 2026
7 tasks
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants