Skip to content

chore(doc): update install instructions for helm install#1931

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

chore(doc): update install instructions for helm install#1931
jakobmoellerdev merged 2 commits into
open-component-model:mainfrom
frewilhelm:update-docs

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.

Testing

How to test the changes

Create a kind cluster and execute

$> helm install ocm-k8s-toolkit oci://ghcr.io/open-component-model/kubernetes/controller/chart:0.0.0-66b9926 \
  --namespace ocm-k8s-toolkit-system \
  --create-namespace
Pulled: ghcr.io/open-component-model/kubernetes/controller/chart:0.0.0-66b9926
Digest: sha256:cfa13f5c98fc41c3d318471241e431479d2f35c492431c82e76b14dc6dcfcd9a
NAME: ocm-k8s-toolkit
LAST DEPLOYED: Mon Mar  9 11:59:18 2026
NAMESPACE: ocm-k8s-toolkit-system
STATUS: deployed
REVISION: 1
DESCRIPTION: Install complete
TEST SUITE: None

Summary by CodeRabbit

  • Documentation
    • Updated Helm installation instructions for OCM K8s Toolkit to reference pre-release chart path
    • Added guidance on accessing and using available pre-release chart versions

Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com>
@frewilhelm frewilhelm requested a review from a team as a code owner March 9, 2026 11:04
@github-actions github-actions Bot added kind/chore chore, maintenance, etc. size/xs Extra small labels Mar 9, 2026
@coderabbitai

coderabbitai Bot commented Mar 9, 2026

Copy link
Copy Markdown
Contributor
📝 Walkthrough

Walkthrough

Updated the OCM K8s Toolkit Helm installation documentation to reference pre-release chart paths and added guidance directing users to the latest pre-release version until an official release becomes available. The local development setup section remains unchanged.

Changes

Cohort / File(s) Summary
Documentation Update
kubernetes/controller/docs/getting-started/setup.md
Updated Helm chart installation path from charts/ocm-k8s-toolkit to kubernetes/controller/chart:<pre-release> and added guidance paragraph for pre-release version selection.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Suggested reviewers

  • jakobmoellerdev
  • matthiasbruns

Poem

🐰 Hop, hop, the docs now gleam,
Pre-release charts fulfill the dream,
Setup guides with wisdom bright,
Guiding rabbits left and right! 🌟

🚥 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 'chore(doc): update install instructions for helm install' is directly related to the changeset, which updates Helm installation documentation for the OCM K8s Toolkit.
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.

@coderabbitai coderabbitai Bot left a comment

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.

Actionable comments posted: 1

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

Inline comments:
In `@kubernetes/controller/docs/getting-started/setup.md`:
- Around line 89-95: The helm install line uses a placeholder tag
"<pre-release>" making the command non-runnable; replace that placeholder in the
helm command (the line starting with "helm install ocm-k8s-toolkit
oci://ghcr.io/open-component-model/kubernetes/controller/chart:<pre-release>")
with the tested chart tag "0.0.0-66b9926" so the command becomes runnable, and
leave the following note that points users to the versions list (the lines
advising how to pick newer pre-release versions) intact as optional guidance.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: b699c196-d6f9-4730-ae0c-b588396b6918

📥 Commits

Reviewing files that changed from the base of the PR and between acf41be and 0928898.

📒 Files selected for processing (1)
  • kubernetes/controller/docs/getting-started/setup.md

Comment thread kubernetes/controller/docs/getting-started/setup.md
@jakobmoellerdev jakobmoellerdev merged commit bb57ba1 into open-component-model:main Mar 10, 2026
22 checks passed
frewilhelm added a commit to open-component-model/ocm-website 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>
ocmbot Bot pushed a commit to open-component-model/ocm-website 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
frewilhelm added a commit to frewilhelm/open-component-model that referenced this pull request Mar 12, 2026
…ent-model#1931)

<!-- markdownlint-disable MD041 -->
#### What this PR does / why we need it

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

#### Testing

##### How to test the changes

Create a kind cluster and execute

```bash
$> helm install ocm-k8s-toolkit oci://ghcr.io/open-component-model/kubernetes/controller/chart:0.0.0-66b9926 \
  --namespace ocm-k8s-toolkit-system \
  --create-namespace
Pulled: ghcr.io/open-component-model/kubernetes/controller/chart:0.0.0-66b9926
Digest: sha256:cfa13f5c98fc41c3d318471241e431479d2f35c492431c82e76b14dc6dcfcd9a
NAME: ocm-k8s-toolkit
LAST DEPLOYED: Mon Mar  9 11:59:18 2026
NAMESPACE: ocm-k8s-toolkit-system
STATUS: deployed
REVISION: 1
DESCRIPTION: Install complete
TEST SUITE: None
```

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

* **Documentation**
* Updated Helm installation instructions for OCM K8s Toolkit to
reference pre-release chart path
* Added guidance on accessing and using available pre-release chart
versions

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com>
morri-son pushed a commit to morri-son/open-component-model that referenced this pull request Mar 18, 2026
…ent-model#1931)

<!-- markdownlint-disable MD041 -->
#### What this PR does / why we need it

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

#### Testing

##### How to test the changes

Create a kind cluster and execute

```bash
$> helm install ocm-k8s-toolkit oci://ghcr.io/open-component-model/kubernetes/controller/chart:0.0.0-66b9926 \
  --namespace ocm-k8s-toolkit-system \
  --create-namespace
Pulled: ghcr.io/open-component-model/kubernetes/controller/chart:0.0.0-66b9926
Digest: sha256:cfa13f5c98fc41c3d318471241e431479d2f35c492431c82e76b14dc6dcfcd9a
NAME: ocm-k8s-toolkit
LAST DEPLOYED: Mon Mar  9 11:59:18 2026
NAMESPACE: ocm-k8s-toolkit-system
STATUS: deployed
REVISION: 1
DESCRIPTION: Install complete
TEST SUITE: None
```

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

* **Documentation**
* Updated Helm installation instructions for OCM K8s Toolkit to
reference pre-release chart path
* Added guidance on accessing and using available pre-release chart
versions

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com>
Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

kind/chore chore, maintenance, etc. size/xs Extra small

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants