Skip to content

Commit e6f6c75

Browse files
augustrhclaude
andcommitted
cncf: incorporate reviewer feedback into GTR Day 0
- Resource requirements: add concrete CPU/memory minimums from maintainer input (qiujian16) — multi-node hub ~100m CPU/500Mi, spoke ~20m CPU/150Mi; single-node hub ~30m CPU/150Mi, spoke ~6m CPU/50Mi - Addons: clarify none are active by default; document first-party installable addons (argocd, argocd-agent, governance-policy-framework via clusteradm install hub-addon) and their sub-project governance model per joshgav request - Helm code blocks: add bash language identifier to satisfy markdownlint Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Signed-off-by: August Simonelli <asimonel@redhat.com>
1 parent 72baeca commit e6f6c75

1 file changed

Lines changed: 13 additions & 6 deletions

File tree

cncf/GTR.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -137,9 +137,14 @@
137137

138138
* **Describe the project’s resource requirements, including CPU, Network and Memory.**
139139

140-
OCM has controllers on the hub cluster, and agents on spoke clusters. Each has its own CPU/memory requirements.
141-
The CPU/memory of the hub and agent can be set in ClusterManager/Klusterlet API or using clusteradm.
142-
OCM requires the spoke cluster to be able to reach the API server of the hub cluster directly or via HTTP proxy.
140+
OCM has controllers on the hub cluster, and agents on spoke clusters. Resource requirements are configurable via the ClusterManager/Klusterlet APIs or using clusteradm; the minimums below reflect a default install with no addons enabled:
141+
142+
| Deployment | Multi-node cluster | Single-node cluster |
143+
|---|---|---|
144+
| Hub (all controllers + operator) | ~100m CPU, ~500Mi memory | ~30m CPU, ~150Mi memory |
145+
| Spoke (Klusterlet agent) | ~20m CPU, ~150Mi memory | ~6m CPU, ~50Mi memory |
146+
147+
These are minimums; actual usage scales with fleet size, ManifestWork volume, and addon activity. OCM requires the spoke cluster to be able to reach the hub cluster's API server directly or via HTTP proxy.
143148

144149
* **Describe the project’s storage requirements, including its use of ephemeral and/or persistent storage.**
145150

@@ -230,21 +235,23 @@
230235

231236
* **Install cluster manager**
232237

233-
```
238+
```bash
234239
helm install cluster-manager --version <version> ocm/cluster-manager --namespace=open-cluster-management --create-namespace
235240
```
236241

237242
* **Install klusterlet**
238243

239-
```
244+
```bash
240245
helm install klusterlet --version <version> ocm/klusterlet \
241246
--set klusterlet.clusterName=<cluster name> \
242247
--set-file bootstrapHubKubeConfig=<the bootstrap kubeconfig file of hub cluster> \
243248
--namespace=open-cluster-management \
244249
--create-namespace
245250
```
246251

247-
OCM includes an [addon framework](https://github.com/open-cluster-management-io/addon-framework) that provides a consistent way to activate built-in addons and develop new ones. Addons are easy to opt-in to, so you only activate what you need, keeping the install lightweight and reducing the attack surface. Community addons are available at https://github.com/open-cluster-management-io/addon-contrib and are installed via Helm charts.
252+
OCM includes an [addon framework](https://github.com/open-cluster-management-io/addon-framework) that provides a consistent way to activate built-in addons and develop new ones. Addons are opt-in — none are active by default — keeping the install lightweight and reducing the attack surface.
253+
254+
A set of first-party addons is installable via `clusteradm install hub-addon --names <addon>`, including `argocd`, `argocd-agent`, and `governance-policy-framework`. These are maintained as sub-projects under the `open-cluster-management-io` GitHub organization, each with their own release cadence and maintainer list, and follow the same contributor ladder and governance model as the core project. Community addons are available at https://github.com/open-cluster-management-io/addon-contrib.
248255

249256
* **How does an adopter test and validate the installation?**
250257

0 commit comments

Comments
 (0)