diff --git a/src/en/v2.1.0/guides/cluster-management/hub-ui/_index.md b/src/en/v2.1.0/guides/cluster-management/hub-ui/_index.md new file mode 100644 index 0000000..1c1e170 --- /dev/null +++ b/src/en/v2.1.0/guides/cluster-management/hub-ui/_index.md @@ -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 +--- \ No newline at end of file diff --git a/src/en/v2.1.0/guides/cluster-management/hub-ui/cluster-and-clusterset.md b/src/en/v2.1.0/guides/cluster-management/hub-ui/cluster-and-clusterset.md new file mode 100644 index 0000000..28c89f9 --- /dev/null +++ b/src/en/v2.1.0/guides/cluster-management/hub-ui/cluster-and-clusterset.md @@ -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 + diff --git a/src/en/v2.1.0/guides/cluster-management/hub-ui/create.md b/src/en/v2.1.0/guides/cluster-management/hub-ui/create.md new file mode 100644 index 0000000..8b2434f --- /dev/null +++ b/src/en/v2.1.0/guides/cluster-management/hub-ui/create.md @@ -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 + + + + diff --git a/src/en/v2.1.0/guides/cluster-management/hub-ui/introduction.md b/src/en/v2.1.0/guides/cluster-management/hub-ui/introduction.md new file mode 100644 index 0000000..beb1bd4 --- /dev/null +++ b/src/en/v2.1.0/guides/cluster-management/hub-ui/introduction.md @@ -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 diff --git a/src/en/v2.1.0/guides/cluster-management/hub-ui/license-management.md b/src/en/v2.1.0/guides/cluster-management/hub-ui/license-management.md new file mode 100644 index 0000000..6ac52a7 --- /dev/null +++ b/src/en/v2.1.0/guides/cluster-management/hub-ui/license-management.md @@ -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) + diff --git a/src/en/v2.1.0/guides/cluster-management/hub-ui/permission.md b/src/en/v2.1.0/guides/cluster-management/hub-ui/permission.md new file mode 100644 index 0000000..7a7f496 --- /dev/null +++ b/src/en/v2.1.0/guides/cluster-management/hub-ui/permission.md @@ -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) + diff --git a/src/en/v2.1.0/guides/cluster-management/hub-ui/spoke.md b/src/en/v2.1.0/guides/cluster-management/hub-ui/spoke.md new file mode 100644 index 0000000..1cba042 --- /dev/null +++ b/src/en/v2.1.0/guides/cluster-management/hub-ui/spoke.md @@ -0,0 +1,82 @@ +--- +layout: 'guide' +menu: + v2_1_0_docs_menu: + identifier: hub-ui-spoke + name: Connect Spoke Cluster + parent: hub-ui + weight: 50 + home_menu: + identifier: hub-ui-spoke + name: Connect Spoke Cluster + parent: hub-ui + weight: 50 +menu_name: v2_1_0_docs_menu +section_menu: guides +--- + +# Creating a Spoke Cluster + +## Method 1 (Recommended): Import with Hub Connection + +### Steps + +1. Go to **Import Cluster** like before and do the necessary steps +2. Select an existing hub cluster before importing + +![Spoke](../images/spoke/spoke.png) + +3. Complete import + +✅ Spoke cluster is created and linked + +![Homepage](../images/spoke/homepage.png) + + +This method can be started from Hub cluster as well + + + + +1. Go to Hub → **Cluster List** +2. Click **Import Managed Cluster** + + +![Homepage](../images/spoke/import_spoke.png) + +3. Follow import steps + +✅ Hub auto-selected during import + + +--- + +## Method 2: Enable OCM Spoke Feature + +1. Go to cluster → Feature Set +2. Enable **OCM Spoke** (initially your features will be white leveled) + +![featureset](../images/spoke/featureset.png) + +3. Select Hub Cluster + +![select](../images/spoke/select.png) + +4. Provide a name +5. Enable + +Then: + +* Enter into your hub cluster then Click Go to Hub + +![request](../images/spoke/request.png) + +* Click **Accept Spoke** The select the spoke from which the connection request was sent before + +![accept](../images/spoke/accept.png) + +* Approve the request + +✅ Cluster becomes a managed spoke + + diff --git a/src/en/v2.1.0/guides/cluster-management/hub-ui/upgrade.md b/src/en/v2.1.0/guides/cluster-management/hub-ui/upgrade.md new file mode 100644 index 0000000..d47de40 --- /dev/null +++ b/src/en/v2.1.0/guides/cluster-management/hub-ui/upgrade.md @@ -0,0 +1,37 @@ +--- +layout: 'guide' +menu: + v2_1_0_docs_menu: + identifier: hub-ui-upgrade + name: Upgrade Spoke + parent: hub-ui + weight: 80 + home_menu: + identifier: hub-ui-upgrade + name: Upgrade Spoke + parent: hub-ui + weight: 80 +menu_name: v2_1_0_docs_menu +section_menu: guides +--- + + + + +# Upgrade spoke cluster + +1. Go to clusterset of the cluster that you want to upgrade to latest version + +![Upgrade](../images/upgrade/upgrade_1.png) + +2. You will see a new interface a spoke featureset inside a hub + +![Upgrade](../images/upgrade/upgrade_2.png) + +Here if you want a spoke to intentionally have different features than hub then you can configure them from here + +3. Go to the upgrade version from sidebar if there is any latest version available you will upgrade button click and Done + +![Upgrade](../images/upgrade/upgrade_3.png) + + diff --git a/src/en/v2.1.0/guides/cluster-management/images/cluster_and_clusterset/add_cluster_1.png b/src/en/v2.1.0/guides/cluster-management/images/cluster_and_clusterset/add_cluster_1.png new file mode 100644 index 0000000..09c45a3 Binary files /dev/null and b/src/en/v2.1.0/guides/cluster-management/images/cluster_and_clusterset/add_cluster_1.png differ diff --git a/src/en/v2.1.0/guides/cluster-management/images/cluster_and_clusterset/add_cluster_2.png b/src/en/v2.1.0/guides/cluster-management/images/cluster_and_clusterset/add_cluster_2.png new file mode 100644 index 0000000..54480d7 Binary files /dev/null and b/src/en/v2.1.0/guides/cluster-management/images/cluster_and_clusterset/add_cluster_2.png differ diff --git a/src/en/v2.1.0/guides/cluster-management/images/cluster_and_clusterset/clusterset.png b/src/en/v2.1.0/guides/cluster-management/images/cluster_and_clusterset/clusterset.png new file mode 100644 index 0000000..35cdc75 Binary files /dev/null and b/src/en/v2.1.0/guides/cluster-management/images/cluster_and_clusterset/clusterset.png differ diff --git a/src/en/v2.1.0/guides/cluster-management/images/cluster_and_clusterset/clusterset_feature_1.png b/src/en/v2.1.0/guides/cluster-management/images/cluster_and_clusterset/clusterset_feature_1.png new file mode 100644 index 0000000..0846d87 Binary files /dev/null and b/src/en/v2.1.0/guides/cluster-management/images/cluster_and_clusterset/clusterset_feature_1.png differ diff --git a/src/en/v2.1.0/guides/cluster-management/images/cluster_and_clusterset/clusterset_feature_2.png b/src/en/v2.1.0/guides/cluster-management/images/cluster_and_clusterset/clusterset_feature_2.png new file mode 100644 index 0000000..70a750c Binary files /dev/null and b/src/en/v2.1.0/guides/cluster-management/images/cluster_and_clusterset/clusterset_feature_2.png differ diff --git a/src/en/v2.1.0/guides/cluster-management/images/cluster_and_clusterset/unaligned.png b/src/en/v2.1.0/guides/cluster-management/images/cluster_and_clusterset/unaligned.png new file mode 100644 index 0000000..a6ff007 Binary files /dev/null and b/src/en/v2.1.0/guides/cluster-management/images/cluster_and_clusterset/unaligned.png differ diff --git a/src/en/v2.1.0/guides/cluster-management/images/cluster_and_clusterset/unaligned_2.png b/src/en/v2.1.0/guides/cluster-management/images/cluster_and_clusterset/unaligned_2.png new file mode 100644 index 0000000..1bb329e Binary files /dev/null and b/src/en/v2.1.0/guides/cluster-management/images/cluster_and_clusterset/unaligned_2.png differ diff --git a/src/en/v2.1.0/guides/cluster-management/images/import/cluster-details.png b/src/en/v2.1.0/guides/cluster-management/images/import/cluster-details.png new file mode 100644 index 0000000..44dfa26 Binary files /dev/null and b/src/en/v2.1.0/guides/cluster-management/images/import/cluster-details.png differ diff --git a/src/en/v2.1.0/guides/cluster-management/images/import/cluster-profile.png b/src/en/v2.1.0/guides/cluster-management/images/import/cluster-profile.png new file mode 100644 index 0000000..425efe9 Binary files /dev/null and b/src/en/v2.1.0/guides/cluster-management/images/import/cluster-profile.png differ diff --git a/src/en/v2.1.0/guides/cluster-management/images/import/deploy.png b/src/en/v2.1.0/guides/cluster-management/images/import/deploy.png new file mode 100644 index 0000000..44e2cc0 Binary files /dev/null and b/src/en/v2.1.0/guides/cluster-management/images/import/deploy.png differ diff --git a/src/en/v2.1.0/guides/cluster-management/images/import/feature-set.png b/src/en/v2.1.0/guides/cluster-management/images/import/feature-set.png new file mode 100644 index 0000000..ad06ac4 Binary files /dev/null and b/src/en/v2.1.0/guides/cluster-management/images/import/feature-set.png differ diff --git a/src/en/v2.1.0/guides/cluster-management/images/import/select-cluster.png b/src/en/v2.1.0/guides/cluster-management/images/import/select-cluster.png new file mode 100644 index 0000000..47dba03 Binary files /dev/null and b/src/en/v2.1.0/guides/cluster-management/images/import/select-cluster.png differ diff --git a/src/en/v2.1.0/guides/cluster-management/images/introduction/hub-spoke-model.png b/src/en/v2.1.0/guides/cluster-management/images/introduction/hub-spoke-model.png new file mode 100644 index 0000000..ce01403 Binary files /dev/null and b/src/en/v2.1.0/guides/cluster-management/images/introduction/hub-spoke-model.png differ diff --git a/src/en/v2.1.0/guides/cluster-management/images/license/add_license.png b/src/en/v2.1.0/guides/cluster-management/images/license/add_license.png new file mode 100644 index 0000000..96da550 Binary files /dev/null and b/src/en/v2.1.0/guides/cluster-management/images/license/add_license.png differ diff --git a/src/en/v2.1.0/guides/cluster-management/images/license/contract.png b/src/en/v2.1.0/guides/cluster-management/images/license/contract.png new file mode 100644 index 0000000..a93ef3b Binary files /dev/null and b/src/en/v2.1.0/guides/cluster-management/images/license/contract.png differ diff --git a/src/en/v2.1.0/guides/cluster-management/images/license/contract_1.png b/src/en/v2.1.0/guides/cluster-management/images/license/contract_1.png new file mode 100644 index 0000000..9e1e47e Binary files /dev/null and b/src/en/v2.1.0/guides/cluster-management/images/license/contract_1.png differ diff --git a/src/en/v2.1.0/guides/cluster-management/images/license/contract_2.png b/src/en/v2.1.0/guides/cluster-management/images/license/contract_2.png new file mode 100644 index 0000000..858f678 Binary files /dev/null and b/src/en/v2.1.0/guides/cluster-management/images/license/contract_2.png differ diff --git a/src/en/v2.1.0/guides/cluster-management/images/license/license_modal.png b/src/en/v2.1.0/guides/cluster-management/images/license/license_modal.png new file mode 100644 index 0000000..24b18a1 Binary files /dev/null and b/src/en/v2.1.0/guides/cluster-management/images/license/license_modal.png differ diff --git a/src/en/v2.1.0/guides/cluster-management/images/permission/add_member.png b/src/en/v2.1.0/guides/cluster-management/images/permission/add_member.png new file mode 100644 index 0000000..5b9281a Binary files /dev/null and b/src/en/v2.1.0/guides/cluster-management/images/permission/add_member.png differ diff --git a/src/en/v2.1.0/guides/cluster-management/images/permission/create_team.png b/src/en/v2.1.0/guides/cluster-management/images/permission/create_team.png new file mode 100644 index 0000000..2c2c7d5 Binary files /dev/null and b/src/en/v2.1.0/guides/cluster-management/images/permission/create_team.png differ diff --git a/src/en/v2.1.0/guides/cluster-management/images/permission/go_to_platform.png b/src/en/v2.1.0/guides/cluster-management/images/permission/go_to_platform.png new file mode 100644 index 0000000..1e5cbbd Binary files /dev/null and b/src/en/v2.1.0/guides/cluster-management/images/permission/go_to_platform.png differ diff --git a/src/en/v2.1.0/guides/cluster-management/images/permission/grant_permission.png b/src/en/v2.1.0/guides/cluster-management/images/permission/grant_permission.png new file mode 100644 index 0000000..3d22fc0 Binary files /dev/null and b/src/en/v2.1.0/guides/cluster-management/images/permission/grant_permission.png differ diff --git a/src/en/v2.1.0/guides/cluster-management/images/permission/permission.png b/src/en/v2.1.0/guides/cluster-management/images/permission/permission.png new file mode 100644 index 0000000..47f8620 Binary files /dev/null and b/src/en/v2.1.0/guides/cluster-management/images/permission/permission.png differ diff --git a/src/en/v2.1.0/guides/cluster-management/images/spoke/accept.png b/src/en/v2.1.0/guides/cluster-management/images/spoke/accept.png new file mode 100644 index 0000000..61d9a38 Binary files /dev/null and b/src/en/v2.1.0/guides/cluster-management/images/spoke/accept.png differ diff --git a/src/en/v2.1.0/guides/cluster-management/images/spoke/featureset.png b/src/en/v2.1.0/guides/cluster-management/images/spoke/featureset.png new file mode 100644 index 0000000..b9300f8 Binary files /dev/null and b/src/en/v2.1.0/guides/cluster-management/images/spoke/featureset.png differ diff --git a/src/en/v2.1.0/guides/cluster-management/images/spoke/homepage.png b/src/en/v2.1.0/guides/cluster-management/images/spoke/homepage.png new file mode 100644 index 0000000..efdd158 Binary files /dev/null and b/src/en/v2.1.0/guides/cluster-management/images/spoke/homepage.png differ diff --git a/src/en/v2.1.0/guides/cluster-management/images/spoke/import_spoke.png b/src/en/v2.1.0/guides/cluster-management/images/spoke/import_spoke.png new file mode 100644 index 0000000..a2bca81 Binary files /dev/null and b/src/en/v2.1.0/guides/cluster-management/images/spoke/import_spoke.png differ diff --git a/src/en/v2.1.0/guides/cluster-management/images/spoke/request.png b/src/en/v2.1.0/guides/cluster-management/images/spoke/request.png new file mode 100644 index 0000000..8d766ff Binary files /dev/null and b/src/en/v2.1.0/guides/cluster-management/images/spoke/request.png differ diff --git a/src/en/v2.1.0/guides/cluster-management/images/spoke/select.png b/src/en/v2.1.0/guides/cluster-management/images/spoke/select.png new file mode 100644 index 0000000..d803482 Binary files /dev/null and b/src/en/v2.1.0/guides/cluster-management/images/spoke/select.png differ diff --git a/src/en/v2.1.0/guides/cluster-management/images/spoke/spoke.png b/src/en/v2.1.0/guides/cluster-management/images/spoke/spoke.png new file mode 100644 index 0000000..3934c82 Binary files /dev/null and b/src/en/v2.1.0/guides/cluster-management/images/spoke/spoke.png differ diff --git a/src/en/v2.1.0/guides/cluster-management/images/upgrade/upgrade_1.png b/src/en/v2.1.0/guides/cluster-management/images/upgrade/upgrade_1.png new file mode 100644 index 0000000..517524a Binary files /dev/null and b/src/en/v2.1.0/guides/cluster-management/images/upgrade/upgrade_1.png differ diff --git a/src/en/v2.1.0/guides/cluster-management/images/upgrade/upgrade_2.png b/src/en/v2.1.0/guides/cluster-management/images/upgrade/upgrade_2.png new file mode 100644 index 0000000..7198b89 Binary files /dev/null and b/src/en/v2.1.0/guides/cluster-management/images/upgrade/upgrade_2.png differ diff --git a/src/en/v2.1.0/guides/cluster-management/images/upgrade/upgrade_3.png b/src/en/v2.1.0/guides/cluster-management/images/upgrade/upgrade_3.png new file mode 100644 index 0000000..0944e7e Binary files /dev/null and b/src/en/v2.1.0/guides/cluster-management/images/upgrade/upgrade_3.png differ