Skip to content

docs(v1): add comprehensive piped configuration reference#6644

Merged
mohammedfirdouss merged 7 commits into
pipe-cd:masterfrom
shivansh-gohem:docs-piped-v1
Jul 21, 2026
Merged

docs(v1): add comprehensive piped configuration reference#6644
mohammedfirdouss merged 7 commits into
pipe-cd:masterfrom
shivansh-gohem:docs-piped-v1

Conversation

@shivansh-gohem

Copy link
Copy Markdown
Contributor

What this PR does / Why we need it:
This PR provides the structured and updated v1 configuration reference for the Piped agent (piped.config).

Note: This PR was split from #6584 per maintainer request (@eeshaanSA) to keep the Application and Piped configuration reviews properly isolated.

Key Documentation Updates:

  • Documented the shift to the new v1 plugin-based architecture.
  • Replaced legacy platformProviders with the new plugins and nested deployTargets specifications.
  • Added detailed, structured markdown tables for internal configurations like SecretManagement, EventWatcher, and Git.
  • Added comprehensive routing tables for NotificationRoute and NotificationReceiver (including NotificationReceiverSlack and NotificationReceiverWebhook per review feedback).
  • Cleaned out outdated v0 configuration references.

Which issue(s) this PR fixes:
Split from #6584
Fixes #6542

@eeshaanSA

Copy link
Copy Markdown
Contributor

@mohammedfirdouss, @rahulshendre could you please kindly review this PR?

Also, please let us hold this, and wait for #6584 to get merged before we can actually merge this. Thanks!

@eeshaanSA

Copy link
Copy Markdown
Contributor

@shivansh-gohem, thank you again for this. Let us work towards getting this merged.

PTAL this comment

@mohammedfirdouss

mohammedfirdouss commented Apr 30, 2026

Copy link
Copy Markdown
Contributor

groups and ignoreGroups are missing from the NotificationRoute table but both fields are still in the v1 struct: https://github.com/pipe-cd/pipecd/blob/master/pkg/configv1/piped.go#L302-L303. They should be added back.

@mohammedfirdouss

Copy link
Copy Markdown
Contributor

The SecretManagement section says config: object with no breakdown. The v1 config has two types, each with required fields. They still exist

KEY_PAIR: https://github.com/pipe-cd/pipecd/blob/master/pkg/configv1/piped.go#L507
GCP_KMS: https://github.com/pipe-cd/pipecd/blob/master/pkg/configv1/piped.go#L563

@mohammedfirdouss

Copy link
Copy Markdown
Contributor

port is marked as required? But Validate() only checks name and url
https://github.com/pipe-cd/pipecd/blob/master/pkg/configv1/piped.go#L671

Should be optional.

@mohammedfirdouss

mohammedfirdouss commented Apr 30, 2026

Copy link
Copy Markdown
Contributor

Removing chartRepositories is correct for v1, but can you add a note saying where they moved?
In v1 they go under plugins[].config for the relevant plugin. @shivansh-gohem

@rahulshendre rahulshendre left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

+1 to all of @mohammedfirdouss points.

One addition alongside the chartRepositories migration note: chartRegistries also moved to spec.plugins[].config on the Kubernetes plugin but isn't mentioned in the doc. source

@shivansh-gohem

Copy link
Copy Markdown
Contributor Author

Thanks for the thorough reviews, @mohammedfirdouss and @rahulshendre! Great catches on all of these.

I have updated the PR with the following changes:

(i) Added groups and ignoreGroups back to NotificationRoute.

(ii) Added the SecretManagementKeyPair and SecretManagementGCPKMS breakdown tables.

(iii) Changed port in PipedPlugin to Optional.

(iv) Added an explicit note in the intro explaining that chartRepositories and chartRegistries have moved to spec.plugins[].config.

The latest commit is pushed. PTAL!

@github-actions

github-actions Bot commented Jun 3, 2026

Copy link
Copy Markdown
Contributor

This PR is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 7 days.

@github-actions github-actions Bot added the Stale label Jun 3, 2026
@mohammedfirdouss

Copy link
Copy Markdown
Contributor

@shivansh-gohem resolve the conflicts

@github-actions github-actions Bot removed the Stale label Jun 4, 2026
@rahulshendre

Copy link
Copy Markdown
Contributor

hey @shivansh-gohem, let's get this merged

could you rebase when you get time?
if you're caught up with other stuff I'm happy to help with it, just let me know. I'll re-review right after : )

@rahulshendre

Copy link
Copy Markdown
Contributor

@shivansh-gohem, any progress on this one 👀

Signed-off-by: Shivansh Sahu <sahushivansh142@gmail.com>
…er review

Signed-off-by: Shivansh Sahu <sahushivansh142@gmail.com>
Signed-off-by: Shivansh Sahu <sahushivansh142@gmail.com>
Signed-off-by: Shivansh Sahu <sahushivansh142@gmail.com>
@rahulshendre

Copy link
Copy Markdown
Contributor

I have rebased onto master and addressed the remaining feedback, repoId casing, hookURL XOR logic, filled SecretManagementGCPKMS, added planPreview section, fixed heading level

PTAL when you have time @khanhtc1202 @mohammedfirdouss @eeshaanSA @armistcxy

@mohammedfirdouss
mohammedfirdouss merged commit 1b07992 into pipe-cd:master Jul 21, 2026
60 checks passed
@mohammedfirdouss

Copy link
Copy Markdown
Contributor

LGTM!. Thanks @shivansh-gohem

@github-actions

Copy link
Copy Markdown
Contributor

Thank you for contributing to PipeCD, @shivansh-gohem! The changes in this pull request will be part of the upcoming release!

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.

[EPIC]Need structured and updated configuration references for App config file and piped config file

5 participants