Docs-V1: Add Installation Pages by eeshaanSA · Pull Request #6328 · pipe-cd/pipecd

eeshaanSA · 2025-10-26T16:52:49Z

Parent PR: #6316

What this PR does:
Add Installation Pages to support V1

Why we need it:

Which issue(s) this PR fixes:

Fixes #

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):

khanhtc1202 · 2025-11-05T08:07:06Z

@eeshaanSA please rebase master to fix the failed tests 👀

Signed-off-by: Eeshaan Sawant <eeshaans1@gmail.com>

…dv1) Signed-off-by: Eeshaan Sawant <eeshaans1@gmail.com>

Signed-off-by: Eeshaan Sawant <eeshaans1@gmail.com>

eeshaanSA · 2025-11-11T15:10:51Z

@eeshaanSA please rebase master to fix the failed tests 👀

The build still fails.

cc @khanhtc1202

codecov · 2025-11-11T15:12:58Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 28.67%. Comparing base (b2deebe) to head (5690f50).

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #6328      +/-   ##
==========================================
- Coverage   28.82%   28.67%   -0.15%     
==========================================
  Files         560      545      -15     
  Lines       59937    59016     -921     
==========================================
- Hits        17277    16923     -354     
+ Misses      41339    40797     -542     
+ Partials     1321     1296      -25

Flag	Coverage Δ
.	`23.27% <ø> (ø)`
.-pkg-app-pipedv1-plugin-analysis	`32.64% <ø> (ø)`
.-pkg-app-pipedv1-plugin-kubernetes	`58.54% <ø> (ø)`
.-pkg-app-pipedv1-plugin-kubernetes_multicluster	`67.63% <ø> (ø)`
.-pkg-app-pipedv1-plugin-scriptrun	`?`
.-pkg-app-pipedv1-plugin-terraform	`?`
.-pkg-app-pipedv1-plugin-wait	`33.92% <ø> (ø)`
.-pkg-app-pipedv1-plugin-waitapproval	`52.71% <ø> (ø)`
.-pkg-plugin-sdk	`50.34% <ø> (ø)`
.-tool-actions-gh-release	`19.23% <ø> (ø)`
.-tool-actions-plan-preview	`25.51% <ø> (ø)`
.-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 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: Eeshaan Sawant <eeshaans1@gmail.com>

eeshaanSA · 2025-11-13T07:09:56Z

@khanhtc1202 LGTM! 🚀

Signed-off-by: Eeshaan Sawant <eeshaans1@gmail.com>

khanhtc1202 · 2025-11-18T08:04:34Z

+  --set-file config.data={PATH_TO_PIPED_CONFIG_FILE} \
+  --set-file secret.data.piped-key={PATH_TO_PIPED_KEY_FILE} \
+  --set-file secret.data.ssh-key={PATH_TO_PRIVATE_SSH_KEY_FILE} \
+  --set args.enableDefaultKubernetesCloudProvider=false \


Suggested change

--set args.enableDefaultKubernetesCloudProvider=false \

we don't have this flag for pipedv1
ref: https://pipecd.dev/blog/2025/09/02/what-is-new-in-pipedv1-plugin-arch-piped/#weird-flag---enable-default-kubernetes-cloud-provider-in-piped-execution

khanhtc1202 · 2025-11-18T08:11:51Z

+      branch: {GIT_BRANCH}
+  syncInterval: 1m
+  plugins:
+    - name: kubernetes


Should use example plugin to keep this config common 👀
https://github.com/pipe-cd/community-plugins/releases/tag/plugins%2Fexample-stage%2Fv0.1.0

How to use example plugin:
https://github.com/pipe-cd/community-plugins/tree/main/plugins/example-stage

But without Kubernetes there will not be any deployment targets, and thus application will not be registered?

So is it better to keep both?

something like this:

plugins: - name: kubernetes port: 7001 url: https://github.com/pipe-cd/pipecd/releases/download/pkg%2Fapp%2Fpipedv1%2Fplugin%2Fkubernetes%2Fv0.1.0/kubernetes_v0.1.0_darwin_arm64 deployTargets: - name: local config: kubectlVersion: 1.32.4 kubeConfigPath: /Users/sawanteeshaan/.kube/config - name: example-stage port: 7002 url: https://github.com/pipe-cd/community-plugins/releases/download/plugins%2Fexample-stage%2Fv0.1.0/example-stage_v0.1.0_darwin_arm64 config: commonMessage: "Hello Middle Earth! This is the wave from UFO!"

But without Kubernetes there will not be any deployment targets, and thus application will not be registered?

You're right about that, the expected behavior in that case will be "not possible to register any application for a given piped, because of no deploy target available".

I think at this point, to install piped, you don't need that k8s plugin. Also, on "registering application docs", we will have docs like "you need to ensure your piped configured required plugins to perform your app deployment, please check how to configure piped's plugins for details".

Therefore, I suggest not showing information that is not relevant at the time to minimize confusion.

Yeah, sounds ideal. I will change it!

Signed-off-by: Eeshaan Sawant <eeshaans1@gmail.com>

eeshaanSA · 2025-11-19T08:56:06Z

cc @khanhtc1202

khanhtc1202

Let's merge it for now, will update it later 👀

eeshaanSA changed the title ~~Docs-V1: Add Installation Pages~~ WIP:Docs-V1: Add Installation Pages Oct 26, 2025

eeshaanSA marked this pull request as ready for review November 4, 2025 03:49

eeshaanSA requested a review from a team as a code owner November 4, 2025 03:49

eeshaanSA requested review from Warashi, ffjlabo and khanhtc1202 November 4, 2025 03:49

eeshaanSA added 4 commits November 11, 2025 20:16

ADD v1/docs/installation (init commit, WIP)

b7f60e3

Signed-off-by: Eeshaan Sawant <eeshaans1@gmail.com>

UPDATE installtion/k8s , installation/local-machine (Support for pipe…

ff60371

…dv1) Signed-off-by: Eeshaan Sawant <eeshaans1@gmail.com>

update installation files

6e4f6a8

Signed-off-by: Eeshaan Sawant <eeshaans1@gmail.com>

add missing link, fix struct

27e839c

Signed-off-by: Eeshaan Sawant <eeshaans1@gmail.com>

eeshaanSA force-pushed the v1docs/installation branch from bbba0ca to 27e839c Compare November 11, 2025 14:46

eeshaanSA added 3 commits November 11, 2025 20:36

minor changes

28c3b77

Signed-off-by: Eeshaan Sawant <eeshaans1@gmail.com>

changes

8c9af6a

Signed-off-by: Eeshaan Sawant <eeshaans1@gmail.com>

changes

5690f50

Signed-off-by: Eeshaan Sawant <eeshaans1@gmail.com>

eeshaanSA commented Nov 12, 2025

View reviewed changes

Comment thread docs/content/en/docs-v0.55.x/installation/install-piped/installing-on-kubernetes.md Outdated

eeshaanSA and others added 2 commits November 13, 2025 12:38

ADDBACK/ installing-on-k8s

52f4173

Signed-off-by: Eeshaan Sawant <eeshaans1@gmail.com>

Merge branch 'master' into v1docs/installation

12e9e1b

Merge branch 'master' into v1docs/installation

d2e48d6

eeshaanSA changed the title ~~WIP:Docs-V1: Add Installation Pages~~ Docs-V1: Add Installation Pages Nov 15, 2025

UPDATE title & descrp for installtion

9149eba

Signed-off-by: Eeshaan Sawant <eeshaans1@gmail.com>

khanhtc1202 reviewed Nov 18, 2025

View reviewed changes

Comment thread docs/content/en/docs-v1.0.x/installation/install-piped/installing-on-kubernetes.md Outdated

khanhtc1202 reviewed Nov 18, 2025

View reviewed changes

Comment thread docs/content/en/docs-v1.0.x/installation/install-piped/installing-on-kubernetes.md Outdated

UPDATE piped config

b28d360

Signed-off-by: Eeshaan Sawant <eeshaans1@gmail.com>

khanhtc1202 approved these changes Nov 24, 2025

View reviewed changes

khanhtc1202 merged commit fc32466 into pipe-cd:master Nov 24, 2025
43 checks passed

github-actions Bot mentioned this pull request Dec 23, 2025

Release v0.56.0 #6387

Closed

github-actions Bot mentioned this pull request May 11, 2026

Release v0.56.0 #6759

Merged

Conversation

eeshaanSA commented Oct 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

khanhtc1202 commented Nov 5, 2025

Uh oh!

eeshaanSA commented Nov 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov Bot commented Nov 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

eeshaanSA commented Nov 13, 2025

Uh oh!

khanhtc1202 Nov 18, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

khanhtc1202 Nov 18, 2025 • 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!

eeshaanSA Nov 18, 2025

Choose a reason for hiding this comment

Uh oh!

khanhtc1202 Nov 19, 2025 • 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!

eeshaanSA Nov 19, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

eeshaanSA commented Nov 19, 2025

Uh oh!

khanhtc1202 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

eeshaanSA commented Oct 26, 2025 •

edited

Loading

eeshaanSA commented Nov 11, 2025 •

edited

Loading

codecov Bot commented Nov 11, 2025 •

edited

Loading

khanhtc1202 Nov 18, 2025 •

edited

Loading

khanhtc1202 Nov 19, 2025 •

edited

Loading