Skip to content

docs: add comprehensive introduction to plugins page #6737

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

Open
tanupriyasingh1 wants to merge 1 commit into
base: master
Choose a base branch
from
+56 −3
Open

docs: add comprehensive introduction to plugins page #6737

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 56 additions & 3 deletions docs/content/en/docs-v1.0.x/plugins/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,61 @@ title: "Plugins"
linkTitle: "Plugins"
weight: 2
description: >
Learn more about Plugins in PipeCD v1.
Extend PipeCD's deployment capabilities with a modular, gRPC-based plugin architecture.
---

> **Note:**
> The Plugins section is a work in progress. Check back soon. Happy PipeCDing!
# Introduction to PipeCD Plugins

In **PipeCD v1**, the core engine is designed to be platform-agnostic. This means that instead of building every deployment provider (like Kubernetes, Terraform, or Lambda) directly into the core code, PipeCD uses a **modular plugin architecture**.

## What is a PipeCD Plugin?

A plugin is a standalone binary that implements the `pipedv1/plugin` interface. It communicates with the **Piped agent** over **gRPC**. This allows the community to build and maintain support for new deployment platforms without modifying the PipeCD core.

## Why the Plugin-First Approach?

- **Decoupling**: Platform-specific logic is isolated from the core GitOps engine.
- **Extensibility**: Easily add support for custom or proprietary deployment workflows.
- **Stability**: Core updates don't break platform-specific logic, and vice versa.

---

## 📘 Plugin Development Book (In Progress)

The Plugin Development Book is currently being translated from Japanese into English
and will be hosted here within PipeCD docs. It guides contributors through building
a complete PipeCD v1 plugin from scratch — from project setup to testing with `piped`.

### What the Book Covers

| Chapter | Topic |
|---------|-------|
| 01 | Introduction |
| 02 | Plugin functionality |
| 03 | Technology selection |
| 04 | Project initialization |
| 05 | Adding dependencies |
| 06 | Plugin types |
| 07 | First step in plugin implementation |
| 08 | Satisfying the `DeploymentPlugin` interface |
| 09 | Defining configuration types |
| 10 | Temporarily satisfying the interface |
| 11 | Implementing `FetchDefinedStages` |
| 12 | Implementing `DetermineVersions` |
| 13 | Implementing `DetermineStrategy` |
| 14 | Implementing `BuildPipelineSyncStages` |
| 15 | Implementing `BuildQuickSyncStages` |
| 16 | Introducing `ExecuteStage` |
| 17 | `ExecuteStage`: DIFF stage |
| 18 | `ExecuteStage`: SYNC stage |
| 19 | `ExecuteStage`: ROLLBACK stage |
| 20 | Modifying `main` |
| 21 | Testing with `piped` |
| 22 | Conclusion |

> **Note:** This book was originally written based on PipeCD's Alpha Release (June 2025).
> Always refer to the latest PipeCD documentation alongside it.

Follow the progress or contribute: [tracking issue #6679](https://github.com/pipe-cd/pipecd/issues/6679)

> **Interested in contributing?** Join the discussion in the `#pipecd` CNCF Slack channel!
Loading