Skip to content

Add detailed documentation about member cluster leave process #1134

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented May 21, 2025

This PR enhances the documentation to provide a comprehensive explanation of what happens when a member cluster leaves the fleet. The updated documentation in the "Leaving the Fleet" section now includes:

  1. A step-by-step breakdown of the leave process:

    • How the process is initiated by deleting the MemberCluster CR
    • The coordination between hub and member cluster controllers
    • The state transitions during the leave process
  2. Details about resource cleanup:

    • How resources propagated via Fleet are removed from the member cluster
    • The role of ApplyWorkReconciler in removing finalizers and enabling garbage collection
    • How AppliedWork objects are deleted to clean up resources
  3. Status reporting and completion:

    • How the member agent reports successful or failed leave operations
    • The final cleanup steps performed on the hub cluster
    • What happens to resource placements targeting the cluster
  4. Connection to other documentation:

    • A link to the how-to guide for uninstalling the member agent after the leave process

These changes should help users better understand the expected behavior when a cluster leaves a fleet and what happens under the hood during this process.

Fixes #1133.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

@Copilot Copilot AI changed the title [WIP] Add a documentation about member leave Add detailed documentation about member cluster leave process May 21, 2025
@Copilot Copilot AI requested a review from zhiying-lin May 21, 2025 09:43
Copilot finished work on behalf of zhiying-lin May 21, 2025 09:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add a documentation about member leave
2 participants