[Multi_K8s-Plugin] Update plugin README to release standard by mohammedfirdouss · Pull Request #6977 · pipe-cd/pipecd

mohammedfirdouss · 2026-07-03T03:16:16Z

What this PR does:

Updates the kubernetes_multicluster plugin README to match the same standard as other plugin README.

Adds How to Build & Run section with Makefile commands, --force-plugin-redownload note, and local kind cluster setup steps
Adds How to Test section explaining how to run unit tests and the role of envtest
Adds Directory Structure overview
Adds full Config Reference tables for all fields: piped config, deploy target config, application config, all 8 stages, Helm/Kustomize options, traffic routing (PodSelector + Istio), and patch operations
Removes the stale "only QuickSync is supported" note
Removes the "url is a dummy" comment (no longer accurate)
Updates all stage names to the K8S_MULTI_* prefix introduced in [Multi_K8s-Plugin] rename stages to avoid conflicts with kubernetes plugin #6880

Why we need it:

The plugin README was a rough developer guide written during the mentorship term. Before a binary release can be triggered (via the plugin_release workflow), the README should be accurate and useful for contributors and users — matching the standard set by the ECS plugin.

Which issue(s) this PR fixes:

Fixes #

Does this PR introduce a user-facing change?:

How are users affected by this change: Documentation only — no code changes.
Is this breaking change: No
How to migrate (if breaking change): N/A

Signed-off-by: Mohammed Firdous <124298708+mohammedfirdouss@users.noreply.github.com>

…plugin Signed-off-by: Mohammed Firdous <124298708+mohammedfirdouss@users.noreply.github.com>

mohammedfirdouss · 2026-07-03T03:29:24Z

@rahulshendre @eeshaanSA @khanhtc1202 please review when free

Ayushmore1214

it feels a little long, but honestly that's mostly repetition rather than too much info. The kind: Piped block shows up like 2 times; maybe we keep one good annotated copy and point the other spots to it? good work though!!!

rahulshendre

checked all the tables against the config structs, fields and defaults match, and the structure looks good as well, main ones are the kubeconfig order and the test command, rest are nits.
really nice work on the tables @mohammedfirdouss : D

rahulshendre · 2026-07-04T07:07:46Z

+├── livestate/      # Live state fetcher (reports current resource state across clusters)
+├── planpreview/    # Plan preview (shows diff before deployment)
+├── toolregistry/   # Tool registry for kubectl, kustomize, and helm binaries
+└── example/        # Example application configurations


nit: docs/ is missing here 👀

Alright, in a bit

rahulshendre · 2026-07-04T07:07:51Z

+Run unit tests from the repository root:
+
+```bash
+go test ./pkg/app/pipedv1/plugin/kubernetes_multicluster/...


I think this won't run from the repo root since the plugin has its own go.mod, and the envtest tests need KUBEBUILDER_ASSETS
make test/go MODULES=pkg/app/pipedv1/plugin/kubernetes_multicluster is the one that works, ref - Makefile#L102

Hm, so to fix the test command to make test/go MODULES=pkg/app/pipedv1/plugin/kubernetes_multicluster with a note about the separate go.mod

rahulshendre · 2026-07-04T07:07:54Z

+
+### Integration tests
+
+To test against real clusters, build and run piped with the plugin pointing to real clusters. The plugin resolves kubeconfig in this order:


masterURL isn't actually used anywhere in the plugin, only kubeConfigPath gets passed to kubectl, ref - applier.go#L58
So this resolution order doesn't really exist, I think we should just say kubeConfigPath is passed to kubectl, and empty falls back to kubectl's own defaults

rahulshendre · 2026-07-04T07:07:57Z

-### app.pipecd.yaml
+| Field | Type | Description | Required |
+|-|-|-|-|
+| deployTargets | [][DeployTargetConfig](#deploytargetconfig) | List of Kubernetes clusters to deploy to | Yes |


there's also a config block next to deployTargets chartRepositories + chartRegistries, Initialize() uses it for helm repo add and oci login.
I think we should add tables for that too

rahulshendre · 2026-07-04T07:08:00Z

+| Field | Type | Description | Required |
+|-|-|-|-|
+| input | [KubernetesDeploymentInput](#kubernetesdeploymentinput) | Input for deployment such as manifests, kubectl version, helm/kustomize options. | No |
+| quickSync | [K8sSyncStageOptions](#k8ssyncstageoptions) | Options for the quick sync stage. | No |


this anchor doesn't go anywhere, I don't think there is K8sSyncStageOptions heading on this page - try it.
It should be #k8s_multi_sync, what do you think?

Didn't even see that, doesnt redirect, it solved now. thanks

rahulshendre · 2026-07-04T07:28:26Z

it feels a little long, but honestly that's mostly repetition rather than too much info. The kind: Piped block shows up like 2 times; maybe we keep one good annotated copy and point the other spots to it? good work though!!!

good catch @Ayushmore1214
yeah the repetition is there, but I don't think we should keep just one copy. the Run block is a walkthrough, someone following it just needs enough to get the plugin loaded, and Piped Config is the reference people jump to directly, so that one should stay complete.
I think we should trim the Run block down to name, port, url and a bare deployTargets, with a small "see Plugin Configuration below for all fields" link 👀

Signed-off-by: Mohammed Firdous <124298708+mohammedfirdouss@users.noreply.github.com>

mohammedfirdouss · 2026-07-04T13:18:49Z

@Ayushmore1214 thanks for the catch! The full annotated block stays in one place now.

rahulshendre

LGTM 👍
everything checks out, nice work @mohammedfirdouss 🙌

mohammedfirdouss requested review from a team as code owners July 3, 2026 03:16

mohammedfirdouss requested review from Warashi, ffjlabo and khanhtc1202 July 3, 2026 03:16

github-actions Bot added area/go area/pipedv1 labels Jul 3, 2026

mohammedfirdouss force-pushed the feat/multicluster-plugin-readme-update branch 2 times, most recently from 4d482fd to d31dd09 Compare July 3, 2026 03:18

docs(kubernetes_multicluster): update plugin README to release standard

ed0f228

Signed-off-by: Mohammed Firdous <124298708+mohammedfirdouss@users.noreply.github.com>

mohammedfirdouss force-pushed the feat/multicluster-plugin-readme-update branch from d31dd09 to ed0f228 Compare July 3, 2026 03:19

docs(kubernetes_multicluster): use alpha status caution to match ECS …

0fb100e

…plugin Signed-off-by: Mohammed Firdous <124298708+mohammedfirdouss@users.noreply.github.com>

mohammedfirdouss force-pushed the feat/multicluster-plugin-readme-update branch from d7f8ee0 to 0fb100e Compare July 3, 2026 03:23

Ayushmore1214 requested changes Jul 4, 2026

View reviewed changes

rahulshendre reviewed Jul 4, 2026

View reviewed changes

mohammedfirdouss force-pushed the feat/multicluster-plugin-readme-update branch from eb922fd to 5e6b48f Compare July 4, 2026 13:14

docs(kubernetes_multicluster): address review comments on README

6d9113b

Signed-off-by: Mohammed Firdous <124298708+mohammedfirdouss@users.noreply.github.com>

mohammedfirdouss force-pushed the feat/multicluster-plugin-readme-update branch from 5e6b48f to 6d9113b Compare July 4, 2026 13:14

Merge branch 'master' into feat/multicluster-plugin-readme-update

18de96a

rahulshendre approved these changes Jul 4, 2026

View reviewed changes

Merge branch 'master' into feat/multicluster-plugin-readme-update

1e8376b


		### Integration tests

		To test against real clusters, build and run piped with the plugin pointing to real clusters. The plugin resolves kubeconfig in this order:

Uh oh!

Conversation

mohammedfirdouss commented Jul 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mohammedfirdouss commented Jul 3, 2026

Uh oh!

Ayushmore1214 left a comment

Choose a reason for hiding this comment

Uh oh!

rahulshendre left a comment

Choose a reason for hiding this comment

Uh oh!

rahulshendre Jul 4, 2026

Choose a reason for hiding this comment

Uh oh!

mohammedfirdouss Jul 4, 2026

Choose a reason for hiding this comment

Uh oh!

rahulshendre Jul 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mohammedfirdouss Jul 4, 2026

Choose a reason for hiding this comment

Uh oh!

rahulshendre Jul 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rahulshendre Jul 4, 2026

Choose a reason for hiding this comment

Uh oh!

rahulshendre Jul 4, 2026

Choose a reason for hiding this comment

Uh oh!

mohammedfirdouss Jul 4, 2026

Choose a reason for hiding this comment

Uh oh!

rahulshendre commented Jul 4, 2026

Uh oh!

mohammedfirdouss commented Jul 4, 2026

Uh oh!

rahulshendre left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

mohammedfirdouss commented Jul 3, 2026 •

edited

Loading

rahulshendre Jul 4, 2026 •

edited

Loading

rahulshendre Jul 4, 2026 •

edited

Loading