Skip to content

Add best practices for using OpenKruise workloads in Karmada and OCM #2031

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

fromsaurav
Copy link

@fromsaurav fromsaurav commented May 14, 2025

I. What does this PR do?

This PR introduces a new tutorial that provides best practices for running OpenKruise workloads in multi-cluster orchestration platforms, specifically Karmada and Open Cluster Management (OCM).

The new doc (docs/tutorial/multi-cluster-orchestration.md) is designed to help users understand how to effectively deploy and manage OpenKruise resources—such as CloneSet and Advanced StatefulSet—across multiple clusters. It includes:

  • Integration patterns for Karmada and OCM
  • Detailed examples of ResourceInterpreter configs for Karmada to handle Kruise CRDs properly
  • Sample ManifestWork resources to integrate Kruise with OCM
  • A section on common challenges and practical solutions
  • Deployment and scaling best practices across clusters

This aims to fill the current gap in official guidance for using OpenKruise in a multi-cluster environment.


II. Does this PR fix an issue?

Yes — it closes #2005, which requested official documentation for multi-cluster orchestration with OpenKruise.


III. How can it be verified?

You can verify the PR by:

  1. Checking that the new file is added at docs/tutorial/multi-cluster-orchestration.md
  2. Reviewing the content to ensure it reflects the key takeaways from the referenced KubeCon talk and upstream docs
  3. Ensuring the YAML examples for ResourceInterpreter and ManifestWork are syntactically correct and platform-specific
  4. Confirming that both Karmada and OCM use cases are well covered

IV. Anything reviewers should know?

  • This is the first official documentation from the OpenKruise project that addresses multi-cluster use cases
  • The focus is on practical implementation with ready-to-use examples—not just concepts
  • The structure and formatting are consistent with existing Kruise tutorials
  • I'd really appreciate an extra set of eyes on the technical examples to ensure accuracy

@kruise-bot kruise-bot requested review from Fei-Guo and veophi May 14, 2025 08:00
@kruise-bot
Copy link

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign veophi for approval by writing /assign @veophi in a comment. For more information see:The Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@kruise-bot
Copy link

Welcome @fromsaurav! It looks like this is your first PR to openkruise/kruise 🎉

@kruise-bot kruise-bot added the size/L size/L: 100-499 label May 14, 2025
@fromsaurav fromsaurav force-pushed the add-multi-cluster-docs branch from e9a0703 to 39e4114 Compare May 14, 2025 08:16
Copy link

codecov bot commented May 14, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 43.78%. Comparing base (ff8dcec) to head (39e4114).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #2031   +/-   ##
=======================================
  Coverage   43.78%   43.78%           
=======================================
  Files         316      316           
  Lines       31617    31617           
=======================================
+ Hits        13842    13845    +3     
+ Misses      16378    16375    -3     
  Partials     1397     1397           
Flag Coverage Δ
unittests 43.78% <ø> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@fromsaurav fromsaurav force-pushed the add-multi-cluster-docs branch from 39e4114 to 366703f Compare May 14, 2025 11:42
@fromsaurav fromsaurav force-pushed the add-multi-cluster-docs branch from 366703f to 1588e3e Compare May 14, 2025 11:57
@furykerry
Copy link
Member

@fromsaurav thanks for your contribution to OpenKruise. However this issue is marked as the project for LFX mentorship term2, so we will accept the patch only if your application to the mentorship project is accepted. You can get familiar with OpenKruise with other issues that is not part of LFX mentorship program

@fromsaurav
Copy link
Author

yeah got that , thank you !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size/L size/L: 100-499
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[feature request] add best practice to use openkruise workload in karmada etc.
3 participants