Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions src/en/v2.1.0/guides/cluster-management/hub-ui/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
layout: 'guide'
menu:
v2_1_0_docs_menu:
identifier: hub-ui
name: Hub UI
description: Know how to use Hub UI
icon: https://img.icons8.com/external-anggara-basic-outline-anggara-putra/96/external-stats-ui-anggara-basic-outline-anggara-putra.png
popular: true
weight: 50
menu_name: v2_1_0_docs_menu
section_menu: guides
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
---
layout: 'guide'
menu:
v2_1_0_docs_menu:
identifier: hub-ui-cluster
name: Cluster & Clusterset
parent: hub-ui
weight: 70
home_menu:
identifier: hub-ui-cluster
name: Cluster & Clusterset
parent: hub-ui
weight: 70
menu_name: v2_1_0_docs_menu
section_menu: guides
---

# Important Note

⚠️ Spoke users **should NOT manage feature sets directly**

* Feature updates must be handled from the **Hub**
* Hub must stay in sync

---

# ClusterSets

ClusterSets group multiple clusters together.

## Create ClusterSet

1. Go to **ClusterSets**
2. Click **Add ClusterSet**

![ClusterSet](../images/cluster_and_clusterset/clusterset.png)

3. Provide a name



---

## Feature Sets

* Select any feature you want to change in all of your connected spokes

![ClusterSet](../images/cluster_and_clusterset/clusterset_feature_1.png)

![ClusterSet](../images/cluster_and_clusterset/clusterset_feature_2.png)


* Apply configurations across all clusters
* Centralized feature management

## Unaligned and Out of sync cluster

### Unaligned cluster: If any spoke cluster has extra features enabled than hub that's unaligned

![Unaligned](../images/cluster_and_clusterset/unaligned.png)

Like in the image secret management have 1 unaligned cluster

![Unaligned](../images/cluster_and_clusterset/unaligned_2.png)

You can see config-syncer is enabled in spoke but not in hub

### Similarly if any hub update does not get applied in spoke that becomes out of sync

---

## Add Clusters

You can add cluster from another clusterset if you want


![ClusterSet](../images/cluster_and_clusterset/add_cluster_1.png)

1. Select cluster(s)

![ClusterSet](../images/cluster_and_clusterset/add_cluster_2.png)

2. Add to ClusterSet

54 changes: 54 additions & 0 deletions src/en/v2.1.0/guides/cluster-management/hub-ui/create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
layout: 'guide'
menu:
v2_1_0_docs_menu:
identifier: hub-ui-create
name: Create Hub Cluster
parent: hub-ui
weight: 40
home_menu:
identifier: hub-ui-create
name: Create Hub Cluster
parent: hub-ui
weight: 40
menu_name: v2_1_0_docs_menu
section_menu: guides
---


# Creating a Hub Cluster

> ⚠️ Recommended: Use an organizational account for full functionality

### Steps

1. Go to import cluster and choose your preferred method
![Hub & Spoke Model](../images/import/select-cluster.png)
2. After filling up necessary steps for your preferred method Choose Generic as cluster profile
![Cluster Profile](../images/import/cluster-profile.png)
3. Open **Cluster Details**
You won't see the hub UI button initially

![Cluster Details](../images/import/cluster-details.png)

4. Go to **Feature Set Settings**
5. Select **OCM Hub Feature Set**

All the features will be white leveled if you are enabling it for the first time.

![Cluster Feature-set](../images/import/feature-set.png)

In the top right corner there will be enable button.
1. Click in the enable button
2. Select all features ( will be auto-selected)
3. Click Preview then Deploy

![Deploy](../images/import/deploy.png)



✅ Wait a bit Your Hub Cluster is ready




81 changes: 81 additions & 0 deletions src/en/v2.1.0/guides/cluster-management/hub-ui/introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
---
layout: 'guide'
menu:
v2_1_0_docs_menu:
identifier: hub-ui-introduction
name: Introduction
parent: hub-ui
weight: 30
home_menu:
identifier: hub-ui-introduction
name: Introduction
parent: hub-ui
weight: 30
menu_name: v2_1_0_docs_menu
section_menu: guides
---
# Hub UI

Hub UI is to manage multiple cluster from a single point. In this guide we will see how you can do that

![Hub & Spoke Model](../images/introduction/hub-spoke-model.png)

### What is OCM?

**Open Cluster Management (OCM)** is a platform for managing multiple Kubernetes clusters from a single control point.

Think of it like this:

* You run multiple stores across different cities (**clusters**)
* You manage them from a central office (**hub cluster**)

OCM acts as that central office, allowing you to:

* Monitor clusters
* Apply configurations
* Manage workloads
* Enforce policies across environments

---

## Core Terminology

### Hub Cluster

The **central control plane** that:

* Manages other clusters
* Stores cluster states
* Distributes applications and policies

---

### Spoke Cluster

A **cluster connected to a hub**

**Analogy:**

* Hub = center of a wheel
* Spokes = connected clusters

Spoke clusters:

* Run workloads
* Receive policies/configurations from the hub

---

### Subscription

Defines what applications/configurations should be deployed to clusters.

---

### Policy

Rules enforced across clusters, such as:

* Security settings
* Network configurations
* Compliance rules
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
layout: 'guide'
menu:
v2_1_0_docs_menu:
identifier: hub-ui-license
name: License Management
parent: hub-ui
weight: 60
home_menu:
identifier: hub-ui-license
name: License Management
parent: hub-ui
weight: 60
menu_name: v2_1_0_docs_menu
section_menu: guides
---


# License Management

From **Cluster Settings → License**

You can:

* Add licenses

![License](../images/license/add_license.png)

![License](../images/license/license_modal.png)

* Upon clicking on the link you will redirected to billing UI

![License](../images/license/contract.png)

* After selecting a contract add your cluster there

![License](../images/license/contract_1.png)

![License](../images/license/contract_1.png)

* Copy and paste your license
* Assign to namespaces
* Track usage
* Access billing (if permitted)

74 changes: 74 additions & 0 deletions src/en/v2.1.0/guides/cluster-management/hub-ui/permission.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
---
layout: 'guide'
menu:
v2_1_0_docs_menu:
identifier: hub-ui-permission
name: User Permission
parent: hub-ui
weight: 60
home_menu:
identifier: hub-ui-permission
name: User Permission
parent: hub-ui
weight: 60
menu_name: v2_1_0_docs_menu
section_menu: guides
---

# User Access Management

![permission](../images/permission/permission.png)

Here you can assign a user one cluster or many cluster (clusterset) and grant access of different level

## Scenario Example

| User | Cluster | Access Level |
| -------- | ------- | ------------ |
| user-1 | spoke-1 | View Only |
| user-2 | spoke-2 | Edit Access |

---

## Method 1: Assign via Organization Team

### Steps

1. Go to **Platform UI**

![go to platform](../images/permission/go_to_platform.png)

2. Create a **Team**

![create team](../images/permission/create_team.png)

3. Add members

![Add Member](../images/permission/add_member.png)

4. Go to Hub → **Access**
5. Click **Assign Permission**

![Grant Permission](../images/permission/grant_permission.png)


### Fields Explained

* **User** → Organization member
* **Level**

* Cluster
* ClusterSet
* **Cluster/ClusterSet** → Target
* **Role Type**

* ClusterRole
* Role (namespace-specific)
* **Roles Available**

* `cluster-admin`
* `admin`
* `create`
* `view`
* **Namespace** → Scope (if applicable)

Loading