Skip to content

Commit 0691ffc

Browse files
authored
docs: update fleetconfig-controller docs to reflect recent changes (#528)
Signed-off-by: Artur Shad Nik <[email protected]>
1 parent 2b4cd8b commit 0691ffc

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

content/en/docs/getting-started/integration/fleetconfig-controller.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,14 @@ weight: 6
55

66
## What is the `FleetConfig Controller`
77

8-
The [`fleetconfig-controller`](https://github.com/open-cluster-management-io/lab/tree/main/fleetconfig-controller) introduces the `FleetConfig` custom resource to the OCM ecosystem. It reconciles `FleetConfig` resources to declaratively manage the lifecycle of Open Cluster Management (OCM) multi-clusters.
8+
The (https://github.com/open-cluster-management-io/lab/tree/main/fleetconfig-controller) introduces 2 new custom resources to the OCM ecosystem: `Hub` and `Spoke` . It reconciles `Hub` and `Spoke` resources to declaratively manage the lifecycle of Open Cluster Management (OCM) multi-clusters.
99

10-
The `fleetconfig-controller` will initialize an OCM hub and one or more managed clusters; add, remove, and upgrade `clustermanagers` and `klusterlets` when their bundle versions change, manage their feature gates, and uninstall all OCM components properly whenever a `FleetConfig` is deleted.
10+
The `fleetconfig-controller` will initialize an OCM hub and one or more spoke clusters; add, remove, and upgrade clustermanagers and klusterlets when their bundle versions change, manage their feature gates, and uninstall all OCM components properly whenever a `Hub` or `Spoke` is deleted.
1111

1212
The controller is a lightweight wrapper around [`clusteradm`](https://github.com/open-cluster-management-io/clusteradm). Anything you can accomplish imperatively via a series of `clusteradm` commands can now be accomplished declaratively using the `fleetconfig-controller`.
1313

14+
`fleetconfig-controller` is built as an OCM AddOn, and will install an agent in each spoke cluster to manage Day 2 operations. AddOn mode can be optionally disabled if required.
15+
1416
## Quick Start
1517

1618
### Prerequisites
@@ -27,7 +29,7 @@ helm repo update ocm
2729
helm install fleetconfig-controller ocm/fleetconfig-controller -n fleetconfig-system --create-namespace
2830
```
2931

30-
By default the Helm chart will also produce a `FleetConfig` to orchestrate, however that behaviour can be disabled. Refer to the chart [README](https://github.com/open-cluster-management-io/lab/blob/main/fleetconfig-controller/charts/fleetconfig-controller/README.md) for full documentation.
32+
By default the Helm chart will also produce a `Hub` and 1 `Spoke` (`hub-as-spoke`) to orchestrate, however that behaviour can be disabled. Refer to the chart [README](https://github.com/open-cluster-management-io/lab/blob/main/fleetconfig-controller/charts/fleetconfig-controller/README.md) for full documentation.
3133

3234
## Support Matrix
3335

0 commit comments

Comments
 (0)