✨ docs: remove OCM from user-facing docs; point to vcluster for OCM-style workflows #552
Conversation
Signed-off-by: adity1raut <[email protected]>
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
kubestellar-prow
bot
added
dco-signoff: yes
|
Hi @adity1raut. Thanks for your PR. I'm waiting for a kubestellar member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
kubestellar-prow
bot
added
the
size/M
|
@RayyanSeliya Can You Please Give me Review on this PR |
| - *ocm*: a control plane that uses the | ||
| [multicluster-controlplane project](https://github.com/open-cluster-management-io/multicluster-controlplane) | ||
| for managing multiple clusters. | ||
| - (Deprecated in docs) Traditional OCM-specific control plane references have been removed from the primary supported list. OCM-style multi-cluster/federation workflows are supported via integrations running on `vcluster` instances when needed. See the `vcluster` type below for details. |
There was a problem hiding this comment.
The vcluster type is described above, not below.
| - *ocm*: a control plane that uses the | ||
| [multicluster-controlplane project](https://github.com/open-cluster-management-io/multicluster-controlplane) | ||
| for managing multiple clusters. | ||
| - (Deprecated in docs) Traditional OCM-specific control plane references have been removed from the primary supported list. OCM-style multi-cluster/federation workflows are supported via integrations running on `vcluster` instances when needed. See the `vcluster` type below for details. |
There was a problem hiding this comment.
The deprecation is not just in the documentation. This type is deprecated, period.
| for managing multiple clusters. | ||
| - (Deprecated in docs) Traditional OCM-specific control plane references have been removed from the primary supported list. OCM-style multi-cluster/federation workflows are supported via integrations running on `vcluster` instances when needed. See the `vcluster` type below for details. | ||
|
|
||
| When using KubeFlex, users interact with the API server |
There was a problem hiding this comment.
Why delete this line?
| - k8s: this is the stock Kube API server with a subset of controllers running in the controller manager. | ||
| - vcluster: this is based on the [vcluster project](https://www.vcluster.com) and provides the ability to create pods in the hosting namespace of the hosting cluster. Note: OCM-style multi-cluster federation and ManifestWork-like workflows are supported via integrations deployed to `vcluster` instances when needed. | ||
| - host: this control plane type exposes the underlying hosting cluster with the same control plane abstraction | ||
| used by the other control plane types. | ||
| - external: this control plane type represents an existing cluster that was not created by KubeFlex and is not the KubeFlex hosting cluster. |
There was a problem hiding this comment.
This looks like a copy of the material just above it.
| - host: this control plane type exposes the underlying hosting cluster with the same control plane abstraction | ||
| used by the other control plane types. | ||
| - external: this control plane type represents an existing cluster that was not created by KubeFlex and is not the KubeFlex hosting cluster. | ||
| At this time KubeFlex focuses documentation on the following supported control plane types: |
There was a problem hiding this comment.
I think the existing wording ("At this time KubFlex supports the following control plane types") is just fine. We are removing support for the ocm type.
| - k8s: shared PostgreSQL | ||
| - vcluster: dedicated sqlite | ||
|
|
||
| Note: OCM-specific backends are no longer emphasized in the primary docs; OCM-style federation scenarios should be implemented via integrations running on `vcluster` instances. |
There was a problem hiding this comment.
"OCM-specific backends are no longer emphasized in the primary docs" is not strong enough. They are not just "no longer emphasized in the primary docs". This PR should be removing them from all the user-facing documentation, in anticipation of removing them from the implementation.
|
Ping @adity1raut |
|
@adity1raut any updates ?? |
clubanderson
added
the
ok-to-test
|
/ok-to-test |
kubestellar-prow
bot
removed
the
needs-ok-to-test
clubanderson
added
the
kind/documentation
kubestellar-prow
bot
added
the
needs-rebase
|
PR needs rebase. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
4 participants
Fixed #540
Remove OCM from the primary supported control plane lists in documentation (README, docs/architecture.md, docs/multi-tenancy.md, docs/users.md).
Clarify that OCM-style multi-cluster/federation workflows are supported by deploying integrations to vcluster instances.
Focus user-facing docs on the four main control plane types: k8s, vcluster, host, and external.
Files changed
README.md — removed ocm from Supported Control Plane Types and added a short note about vcluster.
architecture.md — removed the OCM bullet and added a deprecation/clarification pointing to vcluster integrations.
multi-tenancy.md — removed Open Cluster Management as a primary integration and updated the edge/multi-cluster section to reference vcluster + integrations.
users.md — removed OCM items from Control Plane Types and Backends, removed the kflex create --type ocm example, and added notes directing readers to vcluster for federation-like functionality.
Rationale
OCM remains a code/CRD/test-level artifact in the repo (CRD enums, controller code and e2e tests). These changes intentionally update user-facing documentation only, without removing runtime or API support for OCM. This avoids breaking CRDs or controller behavior while aligning docs with the current recommended usage.
Pointing users to vcluster for OCM-style workflows encourages a consistent approach for multi-cluster/federation use cases while preserving existing code paths for compatibility.
Follow-ups (suggested)