Skip to content

Commit e52884f

Browse files
committed
Minor fixes
1 parent 653887f commit e52884f

File tree

1 file changed

+19
-22
lines changed

1 file changed

+19
-22
lines changed

docs/howtos/takeover.md

Lines changed: 19 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ differences are found. Consider using this option for a safer adoption journey.
3434

3535
## How Fleet can be used to safely take over pre-existing resources
3636

37-
The steps below explains how the takeover experience functions. The code assumes that you have
37+
The steps below explain how the takeover experience functions. The code assumes that you have
3838
a fleet of two clusters, `member-1` and `member-2`:
3939

4040
* Switch to the first member cluster, and create a namespace, `work-2`, with labels:
@@ -63,28 +63,28 @@ a fleet of two clusters, `member-1` and `member-2`:
6363
apiVersion: placement.kubernetes-fleet.io/v1beta1
6464
kind: ClusterResourcePlacement
6565
metadata:
66-
name: work-2
66+
name: work-2
6767
spec:
68-
resourceSelectors:
68+
resourceSelectors:
6969
- group: ""
70-
kind: Namespace
71-
version: v1
72-
# Select all namespaces with the label app=work.
73-
labelSelector:
70+
kind: Namespace
71+
version: v1
72+
# Select all namespaces with the label app=work.
73+
labelSelector:
7474
matchLabels:
75-
app: work-2
76-
policy:
75+
app: work-2
76+
policy:
7777
placementType: PickAll
78-
strategy:
78+
strategy:
7979
# For simplicity reasons, the CRP is configured to roll out changes to
8080
# all member clusters at once. This is not a setup recommended for production
8181
# use.
8282
type: RollingUpdate
8383
rollingUpdate:
84-
maxUnavailable: 100%
85-
unavailablePeriodSeconds: 1
84+
maxUnavailable: 100%
85+
unavailablePeriodSeconds: 1
8686
applyStrategy:
87-
whenToTakeOver: IfNoDiff
87+
whenToTakeOver: IfNoDiff
8888
EOF
8989
```
9090

@@ -95,8 +95,8 @@ a fleet of two clusters, `member-1` and `member-2`:
9595
# The command above uses JSON paths to query the drift details directly and
9696
# uses the jq utility to pretty print the output JSON.
9797
#
98-
# If your system does not have jq installed, consider installing it, or drop
99-
# it from the command.
98+
# jq might not be available in your environment. You may have to install it
99+
# separately, or omit it from the command.
100100
#
101101
# If the output is empty, the status might have not been populated properly
102102
# yet. You can switch the output type from jsonpath to yaml to see the full
@@ -124,8 +124,8 @@ configuration differences as well:
124124
# The command above uses JSON paths to query the drift details directly and
125125
# uses the jq utility to pretty print the output JSON.
126126
#
127-
# If your system does not have jq installed, consider installing it, or drop
128-
# it from the command.
127+
# jq might not be available in your environment. You may have to install it
128+
# separately, or omit it from the command.
129129
#
130130
# If the output is empty, the status might have not been populated properly
131131
# yet. You can switch the output type from jsonpath to yaml to see the full
@@ -168,7 +168,7 @@ configuration differences as well:
168168

169169
* To fix the configuration difference, consider one of the following options:
170170

171-
* Switch the whenToTakeOver setting back to Always, which will instruct Fleet to take over the resource right away and overwrite all configuration differences; or
171+
* Switch the `whenToTakeOver` setting back to `Always`, which will instruct Fleet to take over the resource right away and overwrite all configuration differences; or
172172
* Edit the diff'd field directly on the member cluster side, so that the value is consistent with that on the hub cluster; Fleet will periodically re-evaluate diffs and should take over the resource soon after.
173173
* Delete the resource from the member cluster. Fleet will then re-apply the resource template and re-create the resource.
174174

@@ -178,7 +178,7 @@ configuration differences as well:
178178

179179
## Takeover and comparison options
180180

181-
> See the how-to guide on drift detection for an explaination on comparison options.
181+
> See the how-to guide on drift detection for an explanation on comparison options.
182182

183183
The `comparisonOptions` setting applies to the takeover process as well.
184184
If `partialComparison` is used, Fleet will only report configuration differences in the managed
@@ -194,6 +194,3 @@ Below is the synergy table that summarizes the combos and their respective effec
194194
| `IfNoDiff` | `partialComparison` | The pre-existing resource has a field that is absent on the hub cluster resource template. | Fleet will take over the resource; the configuration difference in the unmanaged field will be left untouched. |
195195
| `IfNoDiff` | `fullComparison` | **Difference has been found on a field, managed or not.** | Fleet will report an apply error in the status, plus the diff details. |
196196
| `Always` | any option | Difference has been found on a field, managed or not. | Fleet will take over the resource; configuration differences in unmanaged fields will be left untouched. |
197-
198-
199-

0 commit comments

Comments
 (0)