Configuring a Plugin

Starting PipeCD v1, you can deploy your application to multiple platforms using plugins.

A plugin represents a deployment capability (like Kubernetes, Terraform, etc.). Each plugin can have one or more deployTargets, where a deploy target represents the environment where your application will be deployed.

Currently, the official plugins maintained by the PipeCD Maintainers are:

• Kubernetes
• Terraform
• Analysis
• ScriptRun
• Wait
• Wait Approval

We are working towards releasing more plugins in the future.

Note:
We also have the PipeCD Community Plugins repository for plugins made by the PipeCD Community.

A plugin is added to the piped configuration inside the spec.plugins array and providing the plugin’s executable URL, the port it should run on, and any deploy targets that belong to it. For more details, see the configuration reference for plugins.

apiVersion: pipecd.dev/v1beta1
kind: Piped
spec:
  repositories:
  plugins:
    - name: plugin_name
      port: 7001
      url: url_to_plugin_binary
      deployTargets:
        - name:
          config: {}

Check out the latest plugin releases on GitHub.

Now, we will see how you can configure plugins for different application types.

Configuring Kubernetes plugin

The Kubernetes plugin enables PipeCD to manage Kubernetes application deployments.

By default, piped deploys Kubernetes application to the cluster where the piped is running in. An external cluster can be connected by specifying the masterURL and kubeConfigPath in deployTargets.

Below is an example configuration for using the Kubernetes plugin:

apiVersion: pipecd.dev/v1beta1
kind: Piped
spec:
  ...
  plugins:
    - name: kubernetes
      port: 7001
      url: https://github.com/pipe-cd/pipecd/releases/download/pkg%2Fapp%2Fpipedv1%2Fplugin%2Fkubernetes%2Fv0.1.0/kubernetes_v0.1.0_darwin_arm64
      deployTargets:
        - name: local
          config:
            kubectlVersion: 1.32.4
            kubeConfigPath: /path/to/.kube/config

See Configuration Reference for Kubernetes plugin for complete configuration details.

Configuring Terraform plugin

The Terraform plugin enables Piped to run Terraform-based deployments. A deploy target represents a Terraform execution environment (e.g., dev/prod workspace, shared variables, drift detection settings).

apiVersion: pipecd.dev/v1beta1
kind: Piped
spec:
  ...
  plugins:
    - name: terraform
      port: 7002
      url: https://github.com/.../terraform_v0.3.0_linux_amd64
      deployTargets:
        - name: tf-dev
          config:
            vars:
              - "project=pipecd"

See Configuration Reference for Terraform plugin for complete configuration details.