docs: add the takeover how-to doc (preview) #967
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
docs/howtos/takeover.md
Outdated
|
|
||
| ## Takeover and comparison options | ||
|
|
||
| > See the how-to guide on drift detection for an explaination on comparison options. |
There was a problem hiding this comment.
Suggested change
| > See the how-to guide on drift detection for an explaination on comparison options. | |
| > See the how-to guide on drift detection for an explanation on comparison options. |
ryanzhang-oss
approved these changes
Nov 23, 2024
docs/howtos/takeover.md
Outdated
Comment on lines
79
to
88
| # For simplicity reasons, the CRP is configured to roll out changes to | ||
| # all member clusters at once. This is not a setup recommended for production | ||
| # use. | ||
| type: RollingUpdate | ||
| rollingUpdate: | ||
| maxUnavailable: 100% | ||
| unavailablePeriodSeconds: 1 | ||
| applyStrategy: | ||
| whenToTakeOver: IfNoDiff | ||
| EOF |
There was a problem hiding this comment.
Suggested change
| # For simplicity reasons, the CRP is configured to roll out changes to | |
| # all member clusters at once. This is not a setup recommended for production | |
| # use. | |
| type: RollingUpdate | |
| rollingUpdate: | |
| maxUnavailable: 100% | |
| unavailablePeriodSeconds: 1 | |
| applyStrategy: | |
| whenToTakeOver: IfNoDiff | |
| EOF | |
| # For simplicity reasons, the CRP is configured to roll out changes to | |
| # all member clusters at once. This is not a setup recommended for production | |
| # use. | |
| type: RollingUpdate | |
| rollingUpdate: | |
| maxUnavailable: 100% | |
| unavailablePeriodSeconds: 1 | |
| applyStrategy: | |
| whenToTakeOver: IfNoDiff | |
| EOF |
jwtty
reviewed
Dec 12, 2024
| The steps below explain how the takeover experience functions. The code assumes that you have | ||
| a fleet of two clusters, `member-1` and `member-2`: | ||
|
|
||
| * Switch to the first member cluster, and create a namespace, `work-2`, with labels: |
There was a problem hiding this comment.
Suggested change
| * Switch to the first member cluster, and create a namespace, `work-2`, with labels: | |
| * Switch to the second member cluster, and create a namespace, `work-2`, with labels: |
| The `comparisonOptions` setting applies to the takeover process as well. | ||
| If `partialComparison` is used, Fleet will only report configuration differences in the managed | ||
| fields; the presence of extra fields on the member cluster side will not stop Fleet from taking | ||
| over the pre-existing resource; on the contrary, with `fullComparsion`, Fleet will only take over |
There was a problem hiding this comment.
Suggested change
| over the pre-existing resource; on the contrary, with `fullComparsion`, Fleet will only take over | |
| over the pre-existing resource; on the contrary, with `fullComparison`, Fleet will only take over |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of your changes
This PR adds a how-to doc for the new takeover experience.
I have:
make reviewableto ensure this PR is ready for review.How has this code been tested
N/A
Special notes for your reviewer