diff --git a/quickstart/README.md b/quickstart/README.md index 4071e8ddc6..8e3c45cdb1 100644 --- a/quickstart/README.md +++ b/quickstart/README.md @@ -3,6 +3,39 @@ This directory contains configuration files for `control-plane` and `piped` for [Quickstart](https://pipecd.dev/docs/quickstart) Guide. + +### Quickstart with raw manifests + +1. create namespace `pipecd` + +``` +kubectl create namespace pipecd +``` + +2. deploy Control Plane to the namespace: pipecd + +``` +kubectl apply -n pipecd -f ./manifests/control-plane.yaml +``` + +3. create piped on the Web UI + +4. overwrite some values in quickstart/manifests/piped.yaml + +| placeholder | description | +| ---- | ---- | +| | piped id | +| | base64-encoded piped key | +| | the manifest repo url | + +5. deploy piped to the namespace: pipecd + +``` +kubectl apply -n pipecd -f ./manifests/piped.yaml +``` + +**About the Manifests** + The manifests directory contains raw Kubernetes manifests files. The 2 files are built using `helm template` command. For `control-plane.yaml`