Skip to content
This repository was archived by the owner on Apr 25, 2023. It is now read-only.

Commit 8ab28f3

Browse files
authored
Merge pull request #1455 from xunpan/doc
fixes #1454: add document for intersectWithClusterSelector
2 parents 4a723d2 + 6c21506 commit 8ab28f3

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

docs/userguide.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -980,6 +980,20 @@ desired by user preferences), which apparently is the only mechanism to check if
980980
this cluster has capacity now. The `spec.rebalance` should not be used if this
981981
behaviour is unacceptable.
982982

983+
By default, RSP placement scheduling result overwrites the clusters list in the
984+
`spec.placement.clusters` of the target resource. However, the federated resources
985+
can use `spec.placement.clusterSelector` to select target clusters dynamically for
986+
resource propagation. When the RSP placement scheduling result is determined, the
987+
federated resource may need to apply its cluster selector at the same time to get
988+
the result clusters instead of override.
989+
990+
If `intersectWithClusterSelector` is set to true, the placement of target kind will
991+
be determined using the instersection of RSP placement scheduling result and the
992+
`spec.placement.clusterSelector` specified on the target kind. For example, a
993+
`FederatedDeployment` specifies a `clusterSelector` and chooses clusters `A`, `B`
994+
and `C`. The corresponding RSP defines clusters `C` and `D`. The final placement
995+
decision is `C` if `intersectionWithClusterSelector` is defined in the RSP.
996+
983997
The RSP can be considered as more user friendly mechanism to distribute the
984998
replicas, where the inputs needed from the user at federated control plane are
985999
reduced. The user only needs to create the RSP resource and associated federated

0 commit comments

Comments
 (0)