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

chore: sync update installation instructions for helm install#745

Merged
frewilhelm merged 2 commits into
open-component-model:mainfrom
frewilhelm:update-docs-k8s
Mar 10, 2026
Merged

chore: sync update installation instructions for helm install#745
frewilhelm merged 2 commits into
open-component-model:mainfrom
frewilhelm:update-docs-k8s

Conversation

@frewilhelm

@frewilhelm frewilhelm commented Mar 9, 2026

Copy link
Copy Markdown
Contributor

What this PR does / why we need it

The location of the helm chart changed. This PR updates the location.

Related to open-component-model/open-component-model#1931 which should be reviewed and merged first.

Summary by CodeRabbit

  • Documentation
    • Updated OCM controller installation instructions to use the new Helm chart path and explicit pre-release variant.
    • Added guidance and link for selecting latest pre-release chart versions.
    • Updated deployment output examples and metadata to reflect the current chart and timestamps.
    • Added local development workflow steps for setting up the controller from the mono-repo.

@netlify

netlify Bot commented Mar 9, 2026

Copy link
Copy Markdown

Deploy Preview for open-component-model ready!

Name Link
🔨 Latest commit 27f2bf0
🔍 Latest deploy log https://app.netlify.com/projects/open-component-model/deploys/69afe2767022d1000865f4b0
😎 Deploy Preview https://deploy-preview-745--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 9, 2026

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: e4fd35c8-28c4-4658-8e05-0daeae7f55b9

📥 Commits

Reviewing files that changed from the base of the PR and between b0df504 and 27f2bf0.

📒 Files selected for processing (2)
  • content/docs/getting-started/setup-controller-environment.md
  • content_versioned/version-legacy/docs/getting-started/setup-controller.md

📝 Walkthrough

Walkthrough

Replaced Helm chart references for installing OCM controllers from ghcr.io/open-component-model/charts/ocm-k8s-toolkit to ghcr.io/open-component-model/kubernetes/controller/chart:<pre-release> in documentation, added guidance linking to pre-release chart versions, and updated sample Helm output (pulled image tag, digest, and timestamps).

Changes

Cohort / File(s) Summary
Primary docs
content/docs/getting-started/setup-controller-environment.md
Replaced Helm chart source with ghcr.io/open-component-model/kubernetes/controller/chart:<pre-release> in two installation blocks; added link to view pre-release chart versions; updated Helm output sample (Pulled tag, Digest, LAST DEPLOYED).
Versioned legacy docs
content_versioned/version-legacy/docs/getting-started/setup-controller.md
Updated install command to use the new chart path (quoted, with <pre-release>), added link to pre-release versions, and added local development install guidance (cd kubernetes/controller + task helm/install).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐇 I hopped through docs to change the chart,
Swapped paths and tags to play my part,
Pre-release bright, a guiding light,
Controllers ready, set to flight! ✨

🚥 Pre-merge checks | ✅ 3
✅ 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 accurately describes the main change: updating installation instructions for Helm install to reflect the new Helm chart location.
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
  • Post copyable unit tests in a comment

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

@frewilhelm frewilhelm marked this pull request as ready for review March 10, 2026 08:46
@frewilhelm frewilhelm requested a review from a team as a code owner March 10, 2026 08:46
@frewilhelm frewilhelm enabled auto-merge (squash) March 10, 2026 08:48

@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_versioned/version-legacy/docs/getting-started/setup-controller.md`:
- Around line 85-91: The helm install example uses the literal token
"<pre-release>" which shells treat as input redirection; update the helm install
example (the line beginning with "helm install ocm-k8s-toolkit
oci://.../controller/chart:<pre-release>") to use a copy-paste safe placeholder
or concrete tag (for example HELM_CHART_VERSION or a sample tag like v0.0.0-pre)
and document that users should replace that variable with the desired chart
version; ensure the placeholder does not include angle brackets so pasting into
a shell won't trigger redirection.

In `@content/docs/getting-started/setup-controller-environment.md`:
- Around line 214-221: The Helm install command uses an unquoted placeholder
"<pre-release>" which Bash treats as a redirection operator; update the command
in the docs so the OCI URL is quoted or the placeholder is replaced by a
shell-safe variable (e.g., use
"oci://ghcr.io/open-component-model/kubernetes/controller/chart:<pre-release>"
or a variable like ${VERSION} with a concrete example such as v0.1.0-rc.1) to
prevent shell parsing errors when users copy-paste the helm install command.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: abb82570-b354-4f32-8402-416ae712e20d

📥 Commits

Reviewing files that changed from the base of the PR and between e2abc51 and b0df504.

📒 Files selected for processing (2)
  • content/docs/getting-started/setup-controller-environment.md
  • content_versioned/version-legacy/docs/getting-started/setup-controller.md

Comment thread content_versioned/version-legacy/docs/getting-started/setup-controller.md Outdated
Comment thread content/docs/getting-started/setup-controller-environment.md
Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com>
Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com>
@frewilhelm frewilhelm merged commit d350bc4 into open-component-model:main Mar 10, 2026
10 checks passed
ocmbot Bot pushed a commit that referenced this pull request Mar 10, 2026
<!-- markdownlint-disable MD041 -->
#### What this PR does / why we need it

The location of the helm chart changed. This PR updates the location.

Related to
open-component-model/open-component-model#1931
which should be reviewed and merged first.

Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com> d350bc4
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.

2 participants