openmcp-project / openmcp-project/docs
Adopt ocpctl in the service provider debugging guide
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 1
- Forks
- 7
- Avg merge
- 8d 9h
- Merged PRs (30d)
- 10
Description
What would you like to be added?
The service provider debugging guide at https://open-control-plane.io/developers/serviceprovider/debugging should reference ocpctl instead of the local-dev.sh script from cluster-provider-kind.
The mapping is:
| Today (script) | Target (ocpctl) |
|---|---|
./hack/local-dev.sh deploy |
ocpctl env apply <name> |
./hack/local-dev.sh reset --force |
ocpctl env delete <name> followed by ocpctl env apply <name> |
| environment variable overrides for images and versions | ocpctl env apply --config <file> with the Environment config (operator.image, clusterProviders[].image, serviceProviders[].image) |
The migration also depends on openmcp-project/ocpctl#40 to cover the access-platform-cluster workflow.
Why is this needed?
ocpctl is positioned as the supported CLI for local OpenControlPlane environments, while the debugging guide still drives developers through a script in a different repository. Consolidating on ocpctl gives service provider developers a single, supported entry point and lets us retire the duplicate workflow in cluster-provider-kind/hack/local-dev.sh.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the service provider debugging guide at the linked URL and replace its local-dev.sh instructions with the listed ocpctl mappings. Check the Environment configuration fields for image and version overrides, and account for the access-platform-cluster dependency on openmcp-project/ocpctl#40. Done means the guide uses the supported ocpctl workflow throughout.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- shell
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 74/100