Skip to content

Commit 5f4daba

Browse files
authored
docs: add fleetconfig-controller page (#498)
Signed-off-by: Tyler Gillson <[email protected]>
1 parent b983f24 commit 5f4daba

File tree

2 files changed

+45
-2
lines changed

2 files changed

+45
-2
lines changed
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
title: FleetConfig Controller
3+
weight: 6
4+
---
5+
6+
## What is the `FleetConfig Controller`
7+
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.
9+
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.
11+
12+
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`.
13+
14+
## Quick Start
15+
16+
### Prerequisites
17+
18+
- [Helm](https://helm.sh/docs/intro/install/) v3.17+
19+
20+
### Installation
21+
22+
The controller is installed via Helm.
23+
24+
```bash
25+
helm repo add ocm https://open-cluster-management.io/helm-charts
26+
helm repo update ocm
27+
helm install fleetconfig-controller ocm/fleetconfig-controller -n fleetconfig-system --create-namespace
28+
```
29+
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.
31+
32+
## Support Matrix
33+
34+
Support for orchestration of OCM multi-clusters varies based on the Kubernetes distribution and/or cloud provider.
35+
36+
| Kubernetes Distribution | Support Level |
37+
|-------------------------|--------------------|
38+
| Vanilla Kubernetes | ✅ Fully Supported |
39+
| Amazon EKS | ✅ Fully Supported |
40+
| Google GKE | ✅ Fully Supported |
41+
| Azure AKS | 🚧 On Roadmap |

content/en/docs/getting-started/quick-start/_index.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@ weight: 1
55

66
<!-- spellchecker-disable -->
77

8-
8+
Follow these steps to setup an OCM hub with two managed clusters using `clusteradm` and `kind`.
99

1010
## Prerequisites
1111

1212
- Ensure [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl) and [kustomize](https://kubectl.docs.kubernetes.io/installation/kustomize/) are installed.
13-
- Ensure [kind](https://kind.sigs.k8s.io/)(greater than `v0.9.0+`, or the latest version is preferred) is installed.
13+
- Ensure [kind](https://kind.sigs.k8s.io/) (greater than `v0.9.0+`, or the latest version is preferred) is installed.
1414

1515
## Install clusteradm CLI tool
1616

@@ -30,6 +30,8 @@ curl -L https://raw.githubusercontent.com/open-cluster-management-io/OCM/main/so
3030

3131
If you want to setup OCM in a production environment or on a different kubernetes distribution, please refer to the [Start the control plane]({{< ref "docs/getting-started/installation/start-the-control-plane" >}}) and [Register a cluster]({{< ref "docs/getting-started/installation/register-a-cluster" >}}) guides.
3232

33+
Alternatively, you can [deploy OCM declaratively using the FleetConfig Controller]({{< ref "docs/getting-started/integration/fleetconfig-controller" >}}).
34+
3335
## What is next
3436

3537
Now you have the OCM control plane with 2 managed clusters connected! Let's start your OCM journey.

0 commit comments

Comments
 (0)