Skip to content

Docs: Add doc for migrating to v1 #6301

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.

Sign up for GitHub

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

Jump to bottom
Merged
khanhtc1202 merged 15 commits into from
Oct 15, 2025
Merged

Docs: Add doc for migrating to v1 #6301

khanhtc1202 merged 15 commits into from
Oct 15, 2025

Conversation

@eeshaanSA
Copy link
Contributor

@eeshaanSA eeshaanSA commented Oct 8, 2025

What this PR does:

Adds a page that helps user understand the process of safely migrating from pipedv0 to pipedv1.

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

@eeshaanSA
docs/ add-v0-to-v1-migrating-doc
807fdf0 
Signed-off-by: Eeshaan Sawant <eeshaans1@gmail.com>
@eeshaanSA eeshaanSA requested a review from a team as a code owner October 8, 2025 10:21
@eeshaanSA
Copy link
Contributor Author

eeshaanSA commented Oct 8, 2025

@khanhtc1202 please check, thanks!

@eeshaanSA
Docs/fix typos
cde0576 
Signed-off-by: Eeshaan Sawant <eeshaans1@gmail.com>
khanhtc1202
khanhtc1202 reviewed Oct 9, 2025
View reviewed changes
khanhtc1202
khanhtc1202 reviewed Oct 9, 2025
View reviewed changes
khanhtc1202
khanhtc1202 reviewed Oct 9, 2025
View reviewed changes
khanhtc1202
khanhtc1202 reviewed Oct 9, 2025
View reviewed changes
@eeshaanSA @khanhtc1202
Update docs/content/en/docs-dev/migrating-from-v0-to-v1/_index.md
450f2e0 
Co-authored-by: Khanh Tran <32532742+khanhtc1202@users.noreply.github.com>
Signed-off-by: Eeshaan Sawant <100678386+eeshaanSA@users.noreply.github.com>
@codecov
Copy link

codecov bot commented Oct 10, 2025 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 36.53%. Comparing base (cdf13a1) to head (4ee5b44).
⚠️ Report is 9 commits behind head on master.

Additional details and impacted files 
@@            Coverage Diff             @@
##           master    #6301      +/-   ##
==========================================
+ Coverage   28.75%   36.53%   +7.77%     
==========================================
  Files         560       52     -508     
  Lines       59858     5338   -54520     
==========================================
- Hits        17215     1950   -15265     
+ Misses      41322     3282   -38040     
+ Partials     1321      106    -1215
Flag Coverage Δ
. ?
.-pkg-app-pipedv1-plugin-analysis 32.64% <ø> (ø)
.-pkg-app-pipedv1-plugin-kubernetes ?
.-pkg-app-pipedv1-plugin-kubernetes_multicluster ?
.-pkg-app-pipedv1-plugin-scriptrun ?
.-pkg-app-pipedv1-plugin-terraform ?
.-pkg-app-pipedv1-plugin-wait ?
.-pkg-app-pipedv1-plugin-waitapproval ?
.-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.

@eeshaanSA
update migratingv0-v1/index.md
525314c 
Signed-off-by: Eeshaan Sawant <eeshaans1@gmail.com>
@eeshaanSA
update/index.md
4ee5b44 
Signed-off-by: Eeshaan Sawant <eeshaans1@gmail.com>
@eeshaanSA
Copy link
Contributor Author

eeshaanSA commented Oct 10, 2025

cc @khanhtc1202

khanhtc1202
khanhtc1202 reviewed Oct 10, 2025
View reviewed changes
khanhtc1202
khanhtc1202 reviewed Oct 10, 2025
View reviewed changes
khanhtc1202
khanhtc1202 reviewed Oct 10, 2025
View reviewed changes
khanhtc1202
khanhtc1202 reviewed Oct 10, 2025
View reviewed changes
khanhtc1202
khanhtc1202 reviewed Oct 10, 2025
View reviewed changes
docs/content/en/docs-dev/migrating-from-v0-to-v1/_index.md
```bash
./piped piped --config-file=<PATH_TO_PIPEDV1_CONFIG_FILE> --tools-dir=/tmp/piped-bin --insecure=true
```

Copy link
Member

@khanhtc1202 khanhtc1202 Oct 10, 2025

Choose a reason for hiding this comment

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

Should mention that we also have pipedv1 as a container image, which is released here
https://github.com/pipe-cd/pipecd/pkgs/container/pipedv1-exp

So, if users prefer to install piped in any other way (such as in CloudRun, on VM, or ECS Fargate, etc.), which requires a container image of piped, they can use that published container image.

Copy link
Contributor Author

@eeshaanSA eeshaanSA Oct 10, 2025

Choose a reason for hiding this comment

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

a different option altogether or under Option 1?

Copy link
Contributor Author

@eeshaanSA eeshaanSA Oct 10, 2025

Choose a reason for hiding this comment

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

@khanhtc1202

Copy link
Contributor Author

@eeshaanSA eeshaanSA Oct 14, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

@khanhtc1202 what about this?

Copy link
Member

@khanhtc1202 khanhtc1202 Oct 15, 2025

Choose a reason for hiding this comment

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

Yes, because the option 1 specifies to run piped using the helm command (including configmap and so on) to a Kubernetes cluster, while we can install piped just as a container in other platforms (like ecs fargate, cloud run service, etc), You can read about piped installation on the docs.
My point here is to add a note like: The container image of pipedv1 is available here (link provided), if users prefer to install piped in any other ways (such as in CloudRun, on VM, or ECS Fargate, etc.), which requires a container image of piped, they can use that published pipedv1 container image.

Copy link
Member

@khanhtc1202 khanhtc1202 Oct 15, 2025

Choose a reason for hiding this comment

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

cc @eeshaanSA

Copy link
Contributor Author

@eeshaanSA eeshaanSA Oct 15, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Understood. Making the changes.

Thanks!

@khanhtc1202
Copy link
Member

khanhtc1202 commented Oct 10, 2025

Thanks @eeshaanSA , I left some comments. Also, please be sure links and mentioned versions refer to the same target as discussed here: #6301 (comment)

khanhtc1202
khanhtc1202 reviewed Oct 10, 2025
View reviewed changes
eeshaanSA and others added 5 commits October 10, 2025 14:48
@eeshaanSA @khanhtc1202
Update docs/content/en/docs-dev/migrating-from-v0-to-v1/_index.md
0d599a6 
Co-authored-by: Khanh Tran <32532742+khanhtc1202@users.noreply.github.com>
Signed-off-by: Eeshaan Sawant <100678386+eeshaanSA@users.noreply.github.com>
@eeshaanSA
update /migratev1-v0
b6360bc 
Signed-off-by: Eeshaan Sawant <eeshaans1@gmail.com>
@eeshaanSA @khanhtc1202
Update docs/content/en/docs-dev/migrating-from-v0-to-v1/_index.md
971546f 
Co-authored-by: Khanh Tran <32532742+khanhtc1202@users.noreply.github.com>
Signed-off-by: Eeshaan Sawant <100678386+eeshaanSA@users.noreply.github.com>
@eeshaanSA @khanhtc1202
Update docs/content/en/docs-dev/migrating-from-v0-to-v1/_index.md
668467b 
Co-authored-by: Khanh Tran <32532742+khanhtc1202@users.noreply.github.com>
Signed-off-by: Eeshaan Sawant <100678386+eeshaanSA@users.noreply.github.com>
@eeshaanSA
added analyis providers detail
8a2fb6c 
Signed-off-by: Eeshaan Sawant <eeshaans1@gmail.com>
khanhtc1202
khanhtc1202 reviewed Oct 14, 2025
View reviewed changes
khanhtc1202
khanhtc1202 reviewed Oct 14, 2025
View reviewed changes
eeshaanSA and others added 5 commits October 14, 2025 18:38
@eeshaanSA @khanhtc1202
Update docs/content/en/docs-dev/migrating-from-v0-to-v1/_index.md
8e73070 
Co-authored-by: Khanh Tran <32532742+khanhtc1202@users.noreply.github.com>
Signed-off-by: Eeshaan Sawant <100678386+eeshaanSA@users.noreply.github.com>
@eeshaanSA @khanhtc1202
Update docs/content/en/docs-dev/migrating-from-v0-to-v1/_index.md
1dc00ac 
fix typo

Co-authored-by: Khanh Tran <32532742+khanhtc1202@users.noreply.github.com>
Signed-off-by: Eeshaan Sawant <100678386+eeshaanSA@users.noreply.github.com>
@eeshaanSA
update/migrating-doc (added container install, some final grammar fixes)
2222000 
Signed-off-by: Eeshaan Sawant <eeshaans1@gmail.com>
@eeshaanSA
update docs/migrating-doc (improve readibility)
e3a0a7c 
Signed-off-by: Eeshaan Sawant <eeshaans1@gmail.com>
@eeshaanSA
update docs/migration-doc (replace change app-config example)
b2f2d2f 
Signed-off-by: Eeshaan Sawant <eeshaans1@gmail.com>
@eeshaanSA
Copy link
Contributor Author

eeshaanSA commented Oct 15, 2025

@khanhtc1202, made the changes. Please check. Thanks!

khanhtc1202
khanhtc1202 approved these changes Oct 15, 2025
View reviewed changes
Copy link
Member

@khanhtc1202 khanhtc1202 left a comment

Choose a reason for hiding this comment

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

LGTM, thank you 👌

@khanhtc1202 khanhtc1202 merged commit c8c6ade into pipe-cd:master Oct 15, 2025
43 checks passed
@github-actions github-actions bot mentioned this pull request Dec 23, 2025
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@khanhtc1202 khanhtc1202 khanhtc1202 approved these changes

@Warashi Warashi Awaiting requested review from Warashi Warashi is a code owner automatically assigned from pipe-cd/pipecd-approvers

@t-kikuc t-kikuc Awaiting requested review from t-kikuc t-kikuc is a code owner automatically assigned from pipe-cd/pipecd-approvers

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@eeshaanSA @khanhtc1202