Skip to content

Commit 04ec284

Browse files
authored
add faq page (#448)
Signed-off-by: Qing Hao <[email protected]>
1 parent aeedc22 commit 04ec284

File tree

5 files changed

+53
-10
lines changed

5 files changed

+53
-10
lines changed

content/en/docs/concepts/add-on-extensibility/addon.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ addon should consist of two kinds of components:
2222
cluster like an ordinary kubernetes operator does.
2323

2424
- __Addon Manager__: A kubernetes controller *in the hub cluster* that applies
25-
manifests to the managed clusters via the [ManifestWork](../manifestwork)
25+
manifests to the managed clusters via the [ManifestWork](../work-distribution/manifestwork)
2626
api. In addition to resource dispatching, the manager can optionally manage
2727
the lifecycle of CSRs for the addon agents or even the RBAC permission bond
2828
to the CSRs' requesting identity.

content/en/docs/concepts/cluster-inventory/managedcluster.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ ManagedCluster when it is not reachable. To be specific,
199199

200200
Tolerations are applied to Placements, and allow Placements to select
201201
ManagedClusters with matching taints. Refer to [Placement
202-
Taints/Tolerations](../placement/#taintstolerations) to see how it is used for
202+
Taints/Tolerations](../content-placement/placement/#taintstolerations) to see how it is used for
203203
cluster selection.
204204

205205
### Cluster removal
@@ -261,5 +261,5 @@ identity. The following picture shows the automated certificate rotation works.
261261
## What's next?
262262

263263
Furthermore, we can do advanced cluster matching/selecting within a
264-
[managedclusterset](./managedclusterset.md) using the [placement](./placement.md)
264+
[managedclusterset](./managedclusterset) using the [placement](../content-placement/placement)
265265
module.

content/en/docs/concepts/cluster-inventory/managedclusterset.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ relationship:
4040
cluster set can be operated from all the bound namespaces at the same time.
4141

4242
The cluster set admin can flexibly operate the member clusters in the workspace
43-
namespace using [Placement](../placement) API, etc.
43+
namespace using [Placement](../content-placement/placement) API, etc.
4444

4545
The following picture shows the hierarchies of how the cluster set works:
4646

content/en/docs/concepts/content-placement/placement.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ aliases:
2222

2323
## Overall
2424

25-
`Placement` concept is used to dynamically select a set of [managedClusters](../managedcluster)
26-
in one or multiple [ManagedClusterSet](../managedclusterset) so that higher level
25+
`Placement` concept is used to dynamically select a set of [managedClusters](../cluster-inventory/managedcluster)
26+
in one or multiple [ManagedClusterSet](../cluster-inventory/managedclusterset) so that higher level
2727
users can either replicate Kubernetes resources to the member clusters or run
2828
their advanced workload i.e. __multi-cluster scheduling__.
2929

@@ -48,7 +48,7 @@ multi-cluster scheduling is logically divided into two phases internally:
4848

4949
## Select clusters in ManagedClusterSet
5050

51-
By following [the previous section](../managedclusterset) about
51+
By following [the previous section](../cluster-inventory/managedclusterset) about
5252
`ManagedClusterSet`, now we're supposed to have one or multiple valid cluster
5353
sets in the hub clusters. Then we can move on and create a placement in the
5454
"workspace namespace" by specifying `predicates` and `prioritizers` in the
@@ -62,7 +62,7 @@ sets in the hub clusters. Then we can move on and create a placement in the
6262

6363
#### Label/Claim selection
6464

65-
In the `predicates` section, you can select clusters by labels or [clusterClaims](../clusterclaim).
65+
In the `predicates` section, you can select clusters by labels or [clusterClaims](../cluster-inventory/clusterclaim).
6666
For instance, you can select 3 clusters with label `purpose=test` and
6767
clusterClaim `platform.open-cluster-management.io=aws` as seen in the following
6868
examples:
@@ -106,7 +106,7 @@ cluster.
106106
In OCM, Taints and Tolerations work together to allow users to control the
107107
selection of managed clusters more flexibly.
108108
109-
[Taints](../managedcluster/#cluster-taints-and-tolerations) are properties of
109+
[Taints](../cluster-inventory/managedcluster/#cluster-taints-and-tolerations) are properties of
110110
ManagedClusters, they allow a Placement to repel a set of ManagedClusters in
111111
predicates stage.
112112
@@ -494,7 +494,7 @@ metadata:
494494

495495
### Rollout Strategy
496496

497-
Rollout Strategy [API](https://github.com/open-cluster-management-io/api/blob/main/cluster/v1alpha1/types_rolloutstrategy.go) facilitate the use of placement decision strategy with OCM workload applier APIs such as Policy, [Addon](https://open-cluster-management.io/concepts/addon/#add-on-rollout-strategy) and [ManifestWorkReplicaSet](https://open-cluster-management.io/concepts/manifestworkreplicaset/) to apply workloads.
497+
Rollout Strategy [API](https://github.com/open-cluster-management-io/api/blob/main/cluster/v1alpha1/types_rolloutstrategy.go) facilitate the use of placement decision strategy with OCM workload applier APIs such as Policy, [Addon](../add-on-extensibility/addon/#rollout-strategy) and [ManifestWorkReplicaSet](../work-distribution/manifestworkreplicaset/) to apply workloads.
498498

499499
```yaml
500500
placements:

content/en/docs/faq/_index.md

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
title: FAQ
3+
weight: 8
4+
---
5+
6+
Welcome to our Frequently Asked Questions (FAQ) page! Here, you'll find answers to some of the most common questions we receive. If you have a question that isn't covered here, feel free to reach out to us directly.
7+
8+
## Questions
9+
10+
### What is the difference between Karmada and OCM? ###
11+
12+
We have a post about this at CNCF blog: [Karmada and Open Cluster Management: two new approaches to the multicluster fleet management challenge](https://www.cncf.io/blog/2022/09/26/karmada-and-open-cluster-management-two-new-approaches-to-the-multicluster-fleet-management-challenge/).
13+
14+
### What is the difference between ManifestWork, ManifestWorkReplicaset and AddOn? When to use them? ###
15+
16+
**1. [Manifestwork](../concepts/work-distribution/manifestwork)**
17+
18+
**_Definition:_** Manifestwork is a resource used to define a group of Kubernetes resources that should be applied to a managed cluster from a hub cluster. It allows for the deployment of various resources (like Deployments, Services, etc.) to a specific managed cluster.
19+
20+
**_Use Case:_** Use ManifestWork when you want to apply a specific set of resources to a single managed cluster. It is ideal for scenarios where you need to manage resources directly and track their status on that cluster.
21+
22+
**_Example:_** Deploying a Deployment and a Service to a managed cluster. You can use [clusteradm](https://github.com/open-cluster-management-io/clusteradm) command `clusteradm create work work-example -f xxx.yaml --clusters cluster1` to wrap the kubernetes native resource with a ManifestWork and submit it to a sepecific managed cluster.
23+
24+
**2. [ManifestWorkReplicaSet](../concepts/work-distribution/manifestworkreplicaset)**
25+
26+
**_Definition:_** ManifestWorkReplicaSet is an aggregator API that utilizes [Manifestwork](../concepts/work-distribution/manifestwork) and [Placement](../concepts/content-placement/placement) to create multiple ManifestWork resources for clusters selected by placements. It allows for the deployment of resources across multiple clusters based on defined rollout strategies.
27+
28+
**_Use Case:_** Use ManifestWorkReplicaSet when you need to deploy the same resources to multiple clusters simultaneously, with the ability to control the rollout strategy (e.g., all at once, progressively, etc.). It is useful for managing deployments across a fleet of clusters.
29+
30+
**_Example:_** Deploying a CronJob and Namespace to multiple clusters selected by a placement strategy.
31+
32+
**3. [Add-On](../concepts/add-on-extensibility/addon)**
33+
34+
**_Definition:_** An Add-On in Open Cluster Management is a mechanism that consists of an Addon Agent (running in managed clusters) and an Addon Manager (running in the hub cluster). It allows for the management of extensions that work with multiple clusters, providing a way to apply configurations and manage the lifecycle of resources across clusters by using the rollout strategy.
35+
36+
**_Use Case:_** Use Add-Ons when you need to implement a more complex solution that requires ongoing management and configuration of resources across multiple clusters.
37+
38+
**_Example:_** A tool that collects alert events from managed clusters and sends them to the hub cluster.
39+
40+
**Summary**
41+
- ManifestWork is for single cluster resource management.
42+
- ManifestWorkReplicaSet is for managing resources across multiple clusters with defined rollout strategies.
43+
- Add-On is for implementing extensions that require ongoing management and configuration across multiple clusters, leveraging both an agent and a manager. Also provide the ability to control the addon's lifecycle with rollout strategy.

0 commit comments

Comments
 (0)