docs: add clusterResourcePlacement and components doc #598
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
zhiying-lin
changed the title
britaniar
reviewed
Nov 7, 2023
britaniar
reviewed
Nov 7, 2023
britaniar
approved these changes
Nov 8, 2023
Comment on lines
+166
to
+184
| Conditions: | ||
| Last Transition Time: 2023-11-06T10:22:56Z | ||
| Message: found all the clusters needed as specified by the scheduling policy | ||
| Observed Generation: 2 | ||
| Reason: SchedulingPolicyFulfilled | ||
| Status: True | ||
| Type: ClusterResourcePlacementScheduled | ||
| Last Transition Time: 2023-11-06T10:22:56Z | ||
| Message: All 2 cluster(s) are synchronized to the latest resources on the hub cluster | ||
| Observed Generation: 2 | ||
| Reason: SynchronizeSucceeded | ||
| Status: True | ||
| Type: ClusterResourcePlacementSynchronized | ||
| Last Transition Time: 2023-11-06T10:22:56Z | ||
| Message: Successfully applied resources to 2 member clusters | ||
| Observed Generation: 2 | ||
| Reason: ApplySucceeded | ||
| Status: True | ||
| Type: ClusterResourcePlacementApplied |
There was a problem hiding this comment.
can we use an example that the last transition time is different ?
Comment on lines
+133
to
+142
| ## Rollout Strategy | ||
| Update strategy determines how changes to the `ClusterWorkloadPlacement` will be rolled out across member clusters. | ||
| The only supported update strategy is `RollingUpdate` and it replaces the old placed resource using rolling update, i.e. | ||
| gradually create the new one while replace the old ones. | ||
|
|
||
| ## Placement status | ||
|
|
||
| After a `ClusterResourcePlacement` is created, details on current status can be seen by performing a `kubectl describe crp <name>`. | ||
| The status output will indicate both placement conditions and individual placement statuses on each member cluster that was selected. | ||
| The list of resources that are selected for placement will also be included in the describe output. |
There was a problem hiding this comment.
can we add links to the deep dive "how to" section of the doc here after they are done?
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
add doc
Fixes #
I have:
make reviewableto ensure this PR is ready for review.How has this code been tested
Special notes for your reviewer