User Guide

This guide is for developers who have PipeCD installed for them and are using PipeCD to deploy their applications.

Note: You must have at least one activated/running Piped to enable using any of the following features of PipeCD. Please refer to Piped installation docs if you do not have any Piped in your pocket.


Adding an application

This page describes how to add a new application.

Configuring deployment

This page describes how to configure the deployment for each specific application kind.

Triggering a deployment

This page describes when a deployment is triggered automatically and how to manually trigger a deployment.

Rolling back a deployment

This page describes when a deployment is rolled back automatically and how to manually rollback a deployment.

Cancelling a deployment

This page describes how to cancel a running deployment.

Adding a manual approval stage

This page describes how to add a manual approval stage.

Adding a wait stage

This page describes how to add a WAIT stage.

Automated deployment analysis

This page describes how to configure Automated Deployment Analysis feature.

Deployment chain

Specific guide for configuring chain of deployments.

Application live state

The live states of application components as well as their health status.

Configuration drift detection

Automatically detecting the configuration drift.

Secret management

Storing secrets safely in the Git repository.

Event watcher

A helper facility to automatically update files when it finds out a new event.

Plan preview

Enables the ability to preview the deployment plan against a given commit before merging.

Insights

This page describes how to see delivery performance.

Command-line tool: pipectl

This page describes how to install and use pipectl to manage PipeCD’s resources.

Configuration reference

This page describes all configurable fields in the application configuration and analysis template.

Examples

Some examples of PipeCD in action!


Last modified May 25, 2022: Release v0.32.0 (#3675) (05a257e8)