Skip to content

Add README for k8s multi cluster plugin #5854

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

Merged
merged 6 commits into from
May 20, 2025

Conversation

ffjlabo
Copy link
Member

@ffjlabo ffjlabo commented May 19, 2025

What this PR does:

as title

Why we need it:

I want to describe how to run k8s multicluster plugin locally.

Which issue(s) this PR fixes:

Part of #5006

Does this PR introduce a user-facing change?:

  • How are users affected by this change:
  • Is this breaking change:
  • How to migrate (if breaking change):

Signed-off-by: Yoshiki Fujikane <[email protected]>
Copy link

codecov bot commented May 19, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 27.79%. Comparing base (c3d15b3) to head (c012e03).
Report is 3 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #5854      +/-   ##
==========================================
- Coverage   27.80%   27.79%   -0.02%     
==========================================
  Files         510      510              
  Lines       54301    54329      +28     
==========================================
  Hits        15101    15101              
- Misses      38054    38082      +28     
  Partials     1146     1146              

☔ 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.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Signed-off-by: Yoshiki Fujikane <[email protected]>
@ffjlabo ffjlabo force-pushed the add-readme-for-k8s-multi-cluster branch from 50c6131 to 6d06f3f Compare May 19, 2025 13:11
@ffjlabo ffjlabo changed the title Add readme for k8s multi cluster Add README for k8s multi cluster plugin May 20, 2025
Signed-off-by: Yoshiki Fujikane <[email protected]>
@ffjlabo ffjlabo force-pushed the add-readme-for-k8s-multi-cluster branch from 1ec1f4c to ea6d194 Compare May 20, 2025 02:35
@ffjlabo ffjlabo marked this pull request as ready for review May 20, 2025 02:39
@ffjlabo ffjlabo enabled auto-merge (squash) May 20, 2025 02:39
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TODO: Let's add links to each plugin README in somewhere (like root README? pipedv1 README? or another) because this file is hard to find.


**Prepare the PipeCD Control Plane**

Please refer to [pipe-cd/pipecd/cmd/pipecd/README.md](../../../../../cmd/pipecd/README.md) to set up the Control Plane in your local environment.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we need to specify the oldest version which is compatible with pipedv1 or just specify latest

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add comment on b29e4bf.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ffjlabo
Precisely, v0.51.3 does not contain some commits of plugins since they're not cherry picked.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to specify the commit when we released v0.51.3 instead of release-v0.51.x branch

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@t-kikuc

Precisely, v0.51.3 does not contain some commits of plugins since they're not cherry picked.

We need to specify the commit when we released v0.51.3 instead of release-v0.51.x branch

Thank you.
So, how about describing it using the upstream of the master branch?
The whole fixes for plugins are stored in that branch, and this is the docs for running locally with make command.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ffjlabo
I agree!

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed on c012e03

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mention 'Currently only QuickSync is supported' somewhere

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed on dab25fd

At this time, please select multiple DeployTargets.

## Examples
There are examples under `./example`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the examples should be moved to https://github.com/pipe-cd/examples in the future.

What about for now? Put in examples/ or the examples repo?
WDYT? @Warashi @khanhtc1202

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the examples should be moved to https://github.com/pipe-cd/examples in the future.

I agree with it. I think the examples for built-in plugins should be located in it.

What about for now? Put in examples/ or the examples repo?

I think we should put them in examples for now.
Currently, some errors will occur when there are app.pipecd.yaml files for both pipedv0 and pipedv1.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should put them in examples for now.

I agree! It's still like a draft.

I approve, and if others have a different opinion, I'll reconsider it.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with putting them under the plugin implementation directory for now because the configuration format may change in the future, as written in the head of this README. Putting them here is better because we can reduce the change scope in future pull requests; they are both under the plugin implementation directory.

ffjlabo added 3 commits May 20, 2025 13:32
Signed-off-by: Yoshiki Fujikane <[email protected]>
Signed-off-by: Yoshiki Fujikane <[email protected]>
@ffjlabo ffjlabo requested a review from t-kikuc May 20, 2025 05:17
Copy link
Member

@t-kikuc t-kikuc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!!!
Let's try!!!!!!!

Copy link
Member

@Warashi Warashi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍🏻

@ffjlabo ffjlabo merged commit 7d4722f into master May 20, 2025
19 of 20 checks passed
@ffjlabo ffjlabo deleted the add-readme-for-k8s-multi-cluster branch May 20, 2025 05:42
Tushar240503 pushed a commit to Tushar240503/pipecd that referenced this pull request May 20, 2025
* Add README for pipedv1

Signed-off-by: Yoshiki Fujikane <[email protected]>

* Add README for k8s multi cluster

Signed-off-by: Yoshiki Fujikane <[email protected]>

* Add Config Reference

Signed-off-by: Yoshiki Fujikane <[email protected]>

---------

Signed-off-by: Yoshiki Fujikane <[email protected]>
Signed-off-by: Tushar240503 <[email protected]>
Tushar240503 pushed a commit to Tushar240503/pipecd that referenced this pull request May 20, 2025
* Add README for pipedv1

Signed-off-by: Yoshiki Fujikane <[email protected]>

* Add README for k8s multi cluster

Signed-off-by: Yoshiki Fujikane <[email protected]>

* Add Config Reference

Signed-off-by: Yoshiki Fujikane <[email protected]>

---------

Signed-off-by: Yoshiki Fujikane <[email protected]>
Signed-off-by: Tushar240503 <[email protected]>
Tushar240503 pushed a commit to Tushar240503/pipecd that referenced this pull request May 20, 2025
* Add README for pipedv1

Signed-off-by: Yoshiki Fujikane <[email protected]>

* Add README for k8s multi cluster

Signed-off-by: Yoshiki Fujikane <[email protected]>

* Add Config Reference

Signed-off-by: Yoshiki Fujikane <[email protected]>

---------

Signed-off-by: Yoshiki Fujikane <[email protected]>
Signed-off-by: Tushar240503 <[email protected]>
Tushar240503 pushed a commit to Tushar240503/pipecd that referenced this pull request May 20, 2025
* Add README for pipedv1

Signed-off-by: Yoshiki Fujikane <[email protected]>

* Add README for k8s multi cluster

Signed-off-by: Yoshiki Fujikane <[email protected]>

* Add Config Reference

Signed-off-by: Yoshiki Fujikane <[email protected]>

---------

Signed-off-by: Yoshiki Fujikane <[email protected]>
aryasoni98 pushed a commit to aryasoni98/pipecd that referenced this pull request May 24, 2025
* Add README for pipedv1

Signed-off-by: Yoshiki Fujikane <[email protected]>

* Add README for k8s multi cluster

Signed-off-by: Yoshiki Fujikane <[email protected]>

* Add Config Reference

Signed-off-by: Yoshiki Fujikane <[email protected]>

---------

Signed-off-by: Yoshiki Fujikane <[email protected]>
Signed-off-by: Arya Soni <[email protected]>
@github-actions github-actions bot mentioned this pull request May 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants