[Multi_K8s-Plugin] Add plugin documentation page by mohammedfirdouss · Pull Request #6878 · pipe-cd/pipecd

mohammedfirdouss · 2026-05-28T10:48:01Z

What this PR does: Adds a documentation page for the kubernetes_multicluster plugin and updates the plugins index to include it.

Why we need it: The plugin has no user-facing documentation yet. This page covers prerequisites, all 8 pipeline stages with options tables, multi-cluster features (per-cluster manifests, per-stage filtering), livestate/drift detection, plan preview, Helm authentication, and a complete configuration reference.

Which issue(s) this PR fixes:

Fixes #

Does this PR introduce a user-facing change?:

How are users affected by this change: Users can now find documentation for the kubernetes_multicluster plugin at docs-v1.0.x/plugins/kubernetes-multicluster/
Is this breaking change: No
How to migrate (if breaking change): N/A

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

Warashi

I'm not good at English or documentation styling, so I want others to review the English wording and/or styling.
cc: @pipe-cd/pipecd-approvers-docs

Warashi · 2026-05-29T22:50:52Z

+| prune | bool | Remove resources that are no longer defined in Git. | false |
+| multiTargets | []string | Restrict the stage to these deploy targets. | all |
+
+### K8S_PRIMARY_ROLLOUT


I'm so sorry for not noticing that the stage name conflicts with the Kubernetes plugin
It's not allowed that a Piped instance has some plugins with the same stage names, which is a limitation of the Piped implementation.
Please change the stage name of the Kubernetes multicluster plugin to something else, for example, "K8S_MULTI_PRIMARY_ROLLOUT."

The conflicting stage names (K8S_PRIMARY_ROLLOUT, K8S_CANARY_ROLLOUT, etc.) need to be renamed in both the Go source and the docs to avoid collision with the regular Kubernetes plugin. I should open a PR for this.

Warashi · 2026-05-29T22:53:49Z

+               kubeConfigPath: /etc/piped/kube/cluster-us
+   ```
+
+2. **`kubectl` must be reachable from the piped host.** The plugin invokes `kubectl` (and `kustomize`/`helm` when used) via the tool registry; pin a version with `kubectlVersion` if you need a specific one.


Does reachable mean that the piped host can download the kubectl binary from the internet? If so, it's correct and ok.
If that means that the kubectl binary must exist on the piped host, then it's not correct. The piped downloads the kubectl binary through the tool registry, so the kubectl binary doesn't need to exist on the piped host.

Hmm, I think reachable is ambigous, kubectl binary is pre-installed on the host, OR the host has internet access to download it. Yeah correct, update it shortly.

mohammedfirdouss · 2026-05-29T23:04:21Z

I'm not good at English or documentation styling, so I want others to review the English wording and/or styling. cc: @pipe-cd/pipecd-approvers-docs

okay no problem

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

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

mohammedfirdouss · 2026-06-13T12:50:52Z

@eeshaanSA @khanhtc1202 please have a look when free.

khanhtc1202 · 2026-06-24T07:53:50Z

I'm okay with the docs itself. Only need @eeshaanSA or @rahulshendre to confirm the structure, then it's good to go. Thanks 👍

khanhtc1202

LGTM

codecov · 2026-06-24T08:36:02Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 27.28%. Comparing base (1bff994) to head (28fc693).

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #6878      +/-   ##
==========================================
- Coverage   29.38%   27.28%   -2.10%     
==========================================
  Files         601      533      -68     
  Lines       64276    57596    -6680     
==========================================
- Hits        18887    15717    -3170     
+ Misses      43922    40644    -3278     
+ Partials     1467     1235     -232

Flag	Coverage Δ
.	`23.14% <ø> (ø)`
.-pkg-app-pipedv1-plugin-analysis	`?`
.-pkg-app-pipedv1-plugin-ecs	`31.74% <ø> (ø)`
.-pkg-app-pipedv1-plugin-kubernetes	`?`
.-pkg-app-pipedv1-plugin-kubernetes_multicluster	`59.66% <ø> (ø)`
.-pkg-app-pipedv1-plugin-scriptrun	`54.83% <ø> (ø)`
.-pkg-app-pipedv1-plugin-terraform	`38.18% <ø> (ø)`
.-pkg-app-pipedv1-plugin-wait	`33.04% <ø> (ø)`
.-pkg-app-pipedv1-plugin-waitapproval	`52.71% <ø> (ø)`
.-pkg-plugin-sdk	`50.34% <ø> (-0.15%)`	⬇️
.-tool-actions-gh-release	`19.23% <ø> (ø)`
.-tool-actions-plan-preview	`?`
.-tool-codegen-protoc-gen-auth	`?`

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

☔ View full report in Codecov by Harness.
📢 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.

rahulshendre

Structure: LGTM
This is the first official plugin page, so it effectively sets the template for the plugin docs that follow (terraform, ecs, cloud run). The flow works very well 👍

rahulshendre · 2026-06-24T09:36:03Z

+
+### Per-cluster manifests with multiTargets
+
+Each `multiTargets` entry binds a deploy target name to its own manifest paths (and optional tool overrides). Use this when clusters need different manifests — for example region-specific config:


tiny nit: a stray em dash on line 195 (the multiTargets section, "manifests — for example") - swap it for a hyphen 👀

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

mohammedfirdouss · 2026-07-01T09:43:56Z

@eeshaanSA review please

rahulshendre

LGTM 👍
Thanks @mohammedfirdouss

docs(kubernetes_multicluster): add plugin documentation page

d797a0f

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

mohammedfirdouss requested review from a team as code owners May 28, 2026 10:48

mohammedfirdouss requested review from Warashi, ffjlabo, khanhtc1202 and t-kikuc May 28, 2026 10:48

github-actions Bot added the area/docs label May 28, 2026

mohammedfirdouss mentioned this pull request May 28, 2026

[LFX Mentorship T-1 2026] Kubernetes Multi-Cluster Plugin #6446 #6446

Open

Warashi reviewed May 29, 2026

View reviewed changes

Merge branch 'master' into feat/multicluster-plugin-docs-v2

89febd3

mohammedfirdouss added 9 commits May 29, 2026 23:13

docs(kubernetes_multicluster): clarify kubectl is downloaded automati…

e5bb2fc

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

docs(kubernetes_multicluster): remove em-dash in prerequisites section

c50057c

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

docs(kubernetes_multicluster): update stage names to K8S_MULTI_* prefix

a2e200a

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

Merge branch 'master' into feat/multicluster-plugin-docs-v2

5b4d00f

Merge branch 'master' into feat/multicluster-plugin-docs-v2

dfd7592

Merge branch 'master' into feat/multicluster-plugin-docs-v2

2536fce

Merge branch 'master' into feat/multicluster-plugin-docs-v2

5c44768

Merge branch 'master' into feat/multicluster-plugin-docs-v2

3d6d94a

Merge branch 'master' into feat/multicluster-plugin-docs-v2

43304e8

khanhtc1202 previously approved these changes Jun 24, 2026

View reviewed changes

Merge branch 'master' into feat/multicluster-plugin-docs-v2

7cfffc3

rahulshendre reviewed Jun 24, 2026

View reviewed changes

mohammedfirdouss added 2 commits July 1, 2026 08:53

Merge branch 'master' into feat/multicluster-plugin-docs-v2

28fc693

docs: replace em dash with hyphen in kubernetes-multicluster doc

135bc19

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

mohammedfirdouss dismissed khanhtc1202’s stale review via 135bc19 July 1, 2026 08:03

rahulshendre approved these changes Jul 1, 2026

View reviewed changes

mohammedfirdouss added 2 commits July 3, 2026 04:06

Merge branch 'master' into feat/multicluster-plugin-docs-v2

6e36ff9

Merge branch 'master' into feat/multicluster-plugin-docs-v2

72f5958


		### Per-cluster manifests with multiTargets

		Each `multiTargets` entry binds a deploy target name to its own manifest paths (and optional tool overrides). Use this when clusters need different manifests — for example region-specific config:

Uh oh!

Conversation

mohammedfirdouss commented May 28, 2026

Uh oh!

Warashi left a comment

Choose a reason for hiding this comment

Uh oh!

Warashi May 29, 2026

Choose a reason for hiding this comment

Uh oh!

mohammedfirdouss May 29, 2026

Choose a reason for hiding this comment

Uh oh!

Warashi May 29, 2026

Choose a reason for hiding this comment

Uh oh!

mohammedfirdouss May 29, 2026

Choose a reason for hiding this comment

Uh oh!

mohammedfirdouss commented May 29, 2026

Uh oh!

mohammedfirdouss commented Jun 13, 2026

Uh oh!

khanhtc1202 commented Jun 24, 2026

Uh oh!

khanhtc1202 left a comment

Choose a reason for hiding this comment

Uh oh!

codecov Bot commented Jun 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

rahulshendre left a comment

Choose a reason for hiding this comment

Uh oh!

rahulshendre Jun 24, 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 commented Jul 1, 2026

Uh oh!

rahulshendre left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

codecov Bot commented Jun 24, 2026 •

edited

Loading

rahulshendre Jun 24, 2026 •

edited

Loading