Skip to content

Docs v1: add plugins overview page #6984

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

Merged
mohammedfirdouss merged 2 commits into from
Jul 8, 2026
Merged

Docs v1: add plugins overview page #6984

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f52377f
add plugins overview page for v1 docs
rahulshendre Jul 7, 2026
2a2f46d
Merge branch 'master' into plugins-overview
rahulshendre Jul 8, 2026
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
44 changes: 41 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,46 @@ title: "Plugins"
linkTitle: "Plugins"
weight: 2
description: >
Learn more about Plugins in PipeCD v1.
This section describes the plugins available for PipeCD v1 and how to use them.
---

> **Note:**
> The Plugins section is a work in progress. Check back soon. Happy PipeCDing!
In PipeCD v1, plugins handle deployments. `piped` runs each configured plugin as a separate process and communicates with it over gRPC, so which platforms your `piped` can deploy to depends on which plugins you configure. See more about [plugins](../concepts/#plugins).

There are two types of plugins:

- **Deployment plugins**: handle the deployment for a specific platform such as Kubernetes or Terraform.
- **Stage plugins**: provide pipeline stages that can be used with any deployment plugin, such as `WAIT` or `ANALYSIS`.

## Official plugins

The PipeCD maintainers develop and maintain the following plugins. Each plugin is versioned and released independently. You can download the plugin binaries from the [releases page](https://github.com/pipe-cd/pipecd/releases).

### Deployment plugins

| Plugin | Description |
|--------|-------------|
| Kubernetes | Deploys applications to a Kubernetes cluster. Supports quick sync and pipeline sync with canary, baseline, and blue-green strategies. |
| Kubernetes multi-cluster | Deploys a single application to multiple Kubernetes clusters with one pipeline. |
| Terraform | Applies infrastructure changes by running `terraform plan` and `terraform apply` in a pipeline. |
| Amazon ECS | Deploys applications to Amazon ECS. |

### Stage plugins

| Plugin | Stage | Description |
|--------|-------|-------------|
| Wait | `WAIT` | Waits for a specified duration before continuing the pipeline. |
| Wait approval | `WAIT_APPROVAL` | Pauses the pipeline until a user approves the deployment. |
| Analysis | `ANALYSIS` | Evaluates the deployment by querying metrics, logs, or HTTP endpoints. |
| Script run | `SCRIPT_RUN` | Runs arbitrary commands as a pipeline stage. |

## Community plugins

The PipeCD community maintains additional plugins in the [community-plugins repository](https://github.com/pipe-cd/community-plugins). Visit the repository for a list of available plugins and their documentation.

## Using a plugin

To add a plugin to your `piped` and register deploy targets, see [Configuring a plugin](../user-guide/managing-piped/configuring-a-plugin/).

## Writing your own plugin

Anyone can develop a plugin for PipeCD. See the [plugin development guide](../contribution-guidelines/contributing-plugins/) to get started.
Loading