controlplane

PipeCD Control Plane

Development

Prerequisites

• Go 1.26 or later
• NodeJS v24.10.0 or later
• Docker
• kind (If you want to run Control Plane locally)
• helm 3.8 (If you want to run Control Plane locally)

Repositories

• pipecd: contains all source code and documentation of PipeCD project.

Commands

• make build/go: builds all go modules including controlplane, piped, pipectl.
• make test/go: runs all unit tests of go modules.
• make test/integration: runs integration tests.
• make gen/code: generate Go and Typescript code from protos and mock configs. You need to run it if you modified any proto or mock definition files.

For the full list of available commands, please see the Makefile at the root of repository.

How to run Control Plane locally

1. Start running a Kubernetes cluster (If you don't have any Kubernetes cluster to use)

   make up/local-cluster
   

   Once it is no longer used, run make down/local-cluster to delete it.

2. Install the web dependencies module

   make update/web-deps
   

3. Install Control Plane into the local cluster

   make run/controlplane
   

   Once all components are running up, use kubectl port-forward to expose the installed Control Plane on your localhost:

   kubectl -n pipecd port-forward svc/controlplane 8080
   

4. Access to the local Control Plane web console

   Point your web browser to http://localhost:8080 to login with the configured static admin account: project = quickstart, username = hello-pipecd, password = hello-pipecd.

How to run Piped locally and add an application to your cluster

See How to run Piped agent locally.

How to set up OIDC provider(Keycloak) locally

Run make setup-local-oidc to set up local OIDC provider(keycloak). This will create a new Keycloak realm and an OIDC client for PipeCD. See Local Keycloak for more details.