Klusterlet

Manages the installation and upgrade of the Klusterlet.
Channel
stable
Capability Level
Basic InstallBasic Install
Provider
Open Cluster Management Community
Container Image
quay.io/open-cluster-management/registration-operator:v1.0.0
Created At
Thu Jun 19, 2025
Maintainers
Categories
Integration & Delivery
OpenShift Optional

Klusterlet

The Klusterlet provides the registration to the Hub cluster as a managed cluster. This operator supports the installation and upgrade of Klusterlet.

Prerequisites

You need a Hub cluster with ClusterManager installed.

How to Install

  • Install Klusterlet operator by following instructions in top right button Install.
  • Optional: Create an agent namespace used to deploy Klusterlet. The default namespace is open-cluster-management-agent.
  • Create a secret bootstrap-hub-kubeconfig with the kubeconfig file of hub cluster in the agent namespace.
  $ kubectl create secret generic bootstrap-hub-kubeconfig --from-file=kubeconfig=<kubeconfig file of hub cluster> -n <agent namespace>
  • Create an instance of the Klusterlet resource to install the Klusterlet.

The pods of Klusterlet are created in agent namespace.

$ kubectl get pods -n open-cluster-management-agent
  NAME                                READY   STATUS    RESTARTS   AGE
  klusterlet-agent-55c6574876-nfxm9   1/1     Running   0          8m38s

There is a ManagedCluster created in the Hub cluster.

$ kubectl get managedclusters.cluster.open-cluster-management.io
NAME                   HUB ACCEPTED   MANAGED CLUSTER URLS     JOINED   AVAILABLE   AGE
cluster1               false                                                        27s

Custom Resource Definitions

Klusterlet
Klusterlet defines the configurations of agents running on the managed cluster
View YAML Example