diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 29d4b1101..810b8b7b9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,6 +10,32 @@ # Contributing guidelines +The ocm repo contains 4 core components: +* registration +* placement +* work +* registration-operator + +Before 0.11.0, the 4 components has independent repos, now we are going through [the task of consolidating code](https://github.com/open-cluster-management-io/OCM/issues/128) to merge all code into this repo to gain all kinds of benifits. + +We're contiously working on migrate code from `/staging` folder to outside. Finally, the `/staging` folder will be empty and removed. + +Here is a table of the migration status: + +| Component | Status | +| --- | --- | +| registration | staging | +| placement | staging | +| work | staging | +| registration-operator | staging | + +Status: +* staging: the component is having all code in `staging` folder. +* mix: the component is having code in both `staging` and outside. +* done: the component is having all code outside `staging` folder and done of the migration. + +If a component is in the `staging` status, you need to open project in the `/staging` folder and contribute there. + ## Terms All contributions to the repository must be submitted under the terms of the [Apache Public License 2.0](https://www.apache.org/licenses/LICENSE-2.0). diff --git a/README.md b/README.md index 3252ed6d0..b22db4b59 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ There are a number of key use cases that are enabled by this project, and are ca OCM has a group of [APIs](https://github.com/open-cluster-management-io/api) to provide the foundational functions in multiple cluster management. -The journey of cluster management starts with [Cluster Registration](https://github.com/open-cluster-management-io/registration) which follows a `double opt-in` protocol to establish a MTLS connection from the agent on the managed cluster (Klusterlet) to the hub (Cluster Manager). After this, users or operands on the hub can declare [ManifestWorks](https://github.com/open-cluster-management-io/work) which contains a slice of Kubernetes resource manifests to be distributed and applied to a certain managed cluster. To schedule workloads to a certain set of clusters, users can also declare a [Placement](https://github.com/open-cluster-management-io/placement) on the hub to dynamically select a set of clusters with certain criteria. +The journey of cluster management starts with [Cluster Registration](https://open-cluster-management.io/concepts/architecture/#cluster-registering-double-opt-in-handshaking) which follows a `double opt-in` protocol to establish a MTLS connection from the agent on the managed cluster (Klusterlet) to the hub (Cluster Manager). After this, users or operands on the hub can declare [ManifestWorks](https://open-cluster-management.io/concepts/manifestwork/) which contains a slice of Kubernetes resource manifests to be distributed and applied to a certain managed cluster. To schedule workloads to a certain set of clusters, users can also declare a [Placement](https://open-cluster-management.io/concepts/placement/) on the hub to dynamically select a set of clusters with certain criteria. In addition, developers can leverage [Addon framework](https://github.com/open-cluster-management-io/addon-framework) to build their own management tools or integrate with other open source projects to extend the multicluster management capability. OCM maintaines two built-in addons for application lifecycle and security governance.