docs(v1): add comprehensive piped configuration reference#6644
docs(v1): add comprehensive piped configuration reference#6644shivansh-gohem wants to merge 5 commits intopipe-cd:masterfrom
Conversation
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>
|
@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! |
|
@shivansh-gohem, thank you again for this. Let us work towards getting this merged. PTAL this comment |
|
|
|
The SecretManagement section says KEY_PAIR: https://github.com/pipe-cd/pipecd/blob/master/pkg/configv1/piped.go#L507 |
|
port is marked as required? But Validate() only checks name and url Should be optional. |
|
Removing chartRepositories is correct for v1, but can you add a note saying where they moved? |
rahulshendre
left a comment
There was a problem hiding this comment.
+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
… notes Signed-off-by: Shivansh Sahu <sahushivansh142@gmail.com>
|
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! |
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
ApplicationandPipedconfiguration reviews properly isolated.Key Documentation Updates:
platformProviderswith the newpluginsand nesteddeployTargetsspecifications.SecretManagement,EventWatcher, andGit.NotificationRouteandNotificationReceiver(includingNotificationReceiverSlackandNotificationReceiverWebhookper review feedback).Which issue(s) this PR fixes:
Split from #6584
Fixes #6542