chore(doc): update install instructions for helm install#1931
Conversation
Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com>
📝 WalkthroughWalkthroughUpdated 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
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
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
📒 Files selected for processing (1)
kubernetes/controller/docs/getting-started/setup.md
<!-- 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>
<!-- 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
…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>
…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>
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
Summary by CodeRabbit