-
Notifications
You must be signed in to change notification settings - Fork 208
docs: add 'Contribute to piped Plugins' guide #6398
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.
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
Open
mohammedfirdouss
wants to merge
10
commits into
pipe-cd:master
Choose a base branch
from
mohammedfirdouss:docs/contribute-plugins-guide
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
1eb4e1b
ADD contributing-plugins guide to documentation
mohammedfirdouss 63b2ef5
Merge branch 'master' into docs/contribute-plugins-guide
mohammedfirdouss c94b58b
Merge branch 'master' into docs/contribute-plugins-guide
mohammedfirdouss 4e6bc95
Merge branch 'master' into docs/contribute-plugins-guide
mohammedfirdouss 1b9491d
docs: enhance contributing plugins guide with plugin architecture det…
mohammedfirdouss 91870e8
docs: clarify section titles for contributing official and community …
mohammedfirdouss 7b1bfea
Merge branch 'master' into docs/contribute-plugins-guide
mohammedfirdouss 71276ca
docs: update concepts documentation
mohammedfirdouss 343e397
docs: remove outdated contributing plugins guide
mohammedfirdouss a5828ea
docs: enhance contributing plugins guide with new plugin examples
mohammedfirdouss File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
137 changes: 137 additions & 0 deletions
137
docs/content/en/docs-v1.0.x/contribution-guidelines/contributing-plugins.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,137 @@ | ||
| --- | ||
| title: "Contribute to piped Plugins" | ||
| linkTitle: "Contribute to piped Plugins" | ||
| weight: 4 | ||
| description: > | ||
| This page describes how to contribute plugins for piped. | ||
| --- | ||
|
|
||
| PipeCD's plugin architecture allows anyone to extend piped's capabilities by creating custom plugins. This guide explains how to develop and contribute plugins. | ||
|
|
||
| ## Understanding the plugin architecture | ||
|
|
||
| In PipeCD v1, plugins are the actors that execute deployments on behalf of piped. Instead of piped directly deploying to platforms, plugins handle platform-specific logic while piped's core controls deployment flows. | ||
|
|
||
| **Key concepts:** | ||
|
|
||
| - **Plugins** run as gRPC servers, launched and managed by piped | ||
| - **Deploy targets** define where a plugin deploys (e.g., a Kubernetes cluster) | ||
| - Plugins can be **official** (maintained by PipeCD team) or **community-contributed** | ||
|
|
||
| For a detailed overview, see the [Plugin Architecture blog post](https://pipecd.dev/blog/2024/11/28/overview-of-the-plan-for-pluginnable-pipecd/). | ||
|
|
||
| ## Plugin types | ||
|
|
||
| Plugins can implement one or more of these interfaces: | ||
|
|
||
| | Interface | Purpose | | ||
| |-----------|---------| | ||
| | **Deployment** | Plan and execute deployment stages | | ||
| | **LiveState** | Fetch and build the state of live resources | | ||
| | **Drift** | Calculate drift between live and git-source manifests | | ||
|
|
||
| For example: | ||
| - A Kubernetes plugin implements all three interfaces | ||
| - A Wait stage plugin only implements the Deployment interface | ||
|
|
||
| ## Where plugins live | ||
|
|
||
| - **Official plugins**: Located in `/pkg/app/pipedv1/plugin/` in the [pipecd repository](https://github.com/pipe-cd/pipecd) | ||
| - **Community plugins**: Located in the [pipe-cd/community-plugins](https://github.com/pipe-cd/community-plugins) repository | ||
|
|
||
| ## Getting started | ||
|
|
||
| ### Prerequisites | ||
|
|
||
| - [Go 1.24 or later](https://go.dev/) | ||
| - Understanding of gRPC | ||
| - Familiarity with the platform you're building a plugin for | ||
|
|
||
| ### Study existing plugins | ||
|
|
||
| Before creating a new plugin, study the existing ones: | ||
|
|
||
| | Plugin | Complexity | Good for learning | | ||
| |--------|------------|-------------------| | ||
| | [wait](https://github.com/pipe-cd/pipecd/tree/master/pkg/app/pipedv1/plugin/wait) | Simple | Basic plugin structure | | ||
| | [waitapproval](https://github.com/pipe-cd/pipecd/tree/master/pkg/app/pipedv1/plugin/waitapproval) | Simple | Stage-only plugin | | ||
| | [kubernetes](https://github.com/pipe-cd/pipecd/tree/master/pkg/app/pipedv1/plugin/kubernetes) | Complex | Full-featured plugin | | ||
| | [terraform](https://github.com/pipe-cd/pipecd/tree/master/pkg/app/pipedv1/plugin/terraform) | Complex | Infrastructure as Code plugin | | ||
|
|
||
| Community plugins: | ||
|
|
||
| | Plugin | Description | | ||
| |--------|-------------| | ||
| | [opentofu](https://github.com/pipe-cd/community-plugins/tree/main/plugins/opentofu) | OpenTofu deployment plugin | | ||
|
|
||
| ### Plugin structure | ||
|
|
||
| A minimal plugin needs: | ||
|
|
||
| ``` | ||
| your-plugin/ | ||
| ├── go.mod | ||
| ├── go.sum | ||
| ├── main.go # Entry point, starts gRPC server | ||
| ├── plugin.go # Implements plugin interfaces | ||
| ├── config/ # Plugin-specific configuration | ||
| │ └── application.go | ||
| └── README.md # Documentation | ||
| ``` | ||
|
|
||
| ### Plugin configuration | ||
|
|
||
| Plugins are configured in the piped config: | ||
|
|
||
| ```yaml | ||
| apiVersion: pipecd.dev/v1beta1 | ||
| kind: Piped | ||
| spec: | ||
| plugins: | ||
| - name: your-plugin | ||
| port: 7001 # Any unused port | ||
| url: <PLUGIN_URL> | ||
| deployTargets: # Optional, depends on plugin | ||
| - name: target1 | ||
| config: | ||
| # Plugin-specific config | ||
| ``` | ||
|
|
||
| ## Contributing to official plugins | ||
|
|
||
| 1. **Open an issue** first to discuss your plugin idea with maintainers | ||
| 2. **Fork and clone** the [pipecd repository](https://github.com/pipe-cd/pipecd) | ||
| 3. **Create your plugin** under `/pkg/app/pipedv1/plugin/your-plugin/` | ||
| 4. **Write tests** — see existing plugins for patterns | ||
| 5. **Add a README** documenting configuration and usage | ||
| 6. **Submit a PR** linking to the discussion issue | ||
|
|
||
| ### Build and test | ||
|
|
||
| ```bash | ||
| # Build all plugins | ||
| make build/plugin | ||
|
|
||
| # Run tests | ||
| make test/go | ||
|
|
||
| # Run piped locally with your plugin | ||
| make run/piped CONFIG_FILE=piped-config.yaml EXPERIMENTAL=true INSECURE=true | ||
| ``` | ||
|
|
||
| ## Contributing to community plugins | ||
|
|
||
| The [community-plugins repository](https://github.com/pipe-cd/community-plugins) welcomes plugins that may not fit in the official repo. | ||
|
|
||
| 1. **Fork** the community-plugins repository | ||
| 2. **Create your plugin** following the structure above | ||
| 3. **Submit a PR** with documentation | ||
|
|
||
| ## Resources | ||
|
|
||
| - [RFC: Plugin Architecture](https://github.com/pipe-cd/pipecd/blob/master/docs/rfcs/0015-pipecd-plugin-arch-meta.md) | ||
| - [pipedv1 README](https://github.com/pipe-cd/pipecd/blob/master/cmd/pipedv1/README.md) | ||
| - [Plugin Alpha Release blog](https://pipecd.dev/blog/2025/06/16/plugin-architecture-piped-alpha-version-has-been-released/) | ||
| - [#pipecd Slack channel](https://cloud-native.slack.com/) for questions | ||
|
|
||
| Thank you for contributing to PipeCD plugins! | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We can also add the terraform plugin here, and maybe even some community plugins (Like the openTofu one). Thoughts?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmm, I will say yes, why so is because, it should give contributors more examples to learn from so that they can understand patterns.