Skip to content

[Multi_K8s-Plugin] Update plugin README to release standard#6977

Open
mohammedfirdouss wants to merge 4 commits into
pipe-cd:masterfrom
mohammedfirdouss:feat/multicluster-plugin-readme-update
Open

[Multi_K8s-Plugin] Update plugin README to release standard#6977
mohammedfirdouss wants to merge 4 commits into
pipe-cd:masterfrom
mohammedfirdouss:feat/multicluster-plugin-readme-update

Conversation

@mohammedfirdouss

@mohammedfirdouss mohammedfirdouss commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

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

@mohammedfirdouss mohammedfirdouss requested review from a team as code owners July 3, 2026 03:16
@mohammedfirdouss mohammedfirdouss force-pushed the feat/multicluster-plugin-readme-update branch 2 times, most recently from 4d482fd to d31dd09 Compare July 3, 2026 03:18
Signed-off-by: Mohammed Firdous <124298708+mohammedfirdouss@users.noreply.github.com>
@mohammedfirdouss mohammedfirdouss force-pushed the feat/multicluster-plugin-readme-update branch from d31dd09 to ed0f228 Compare July 3, 2026 03:19
…plugin

Signed-off-by: Mohammed Firdous <124298708+mohammedfirdouss@users.noreply.github.com>
@mohammedfirdouss mohammedfirdouss force-pushed the feat/multicluster-plugin-readme-update branch from d7f8ee0 to 0fb100e Compare July 3, 2026 03:23
@mohammedfirdouss

Copy link
Copy Markdown
Contributor Author

@rahulshendre @eeshaanSA @khanhtc1202 please review when free

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.

1 participant