Skip to content

Commit 58ee4c0

Browse files
committed
add promotion flow overview diagram
1 parent 3b68159 commit 58ee4c0

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

README.md

+10
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,16 @@
22

33
The pipeline-controller is a Kubernetes controller offering an API (in terms of the `Pipeline` CRD) and automation for implementing continuous delivery (CD) pipelines in an unopinionated fashion. The API allows for defining a pipeline comprised of multiple environments and deployment targets, typically different clusters serving different purposes, e.g. "dev", "staging", "prod". The controller then tracks applications deployed to those environments and provides visibility into their progress while they make their way through the environments.
44

5+
## Pipelines
6+
7+
One part of this project is an API to define a continuous delivery pipeline. Please see [the Go types here](api/v1alpha1/pipeline_types.go) for details on this API.
8+
9+
## Promotion
10+
11+
Another part this project offers is an API and machinery for promoting applications through environments. The following image provides an overview of how the promotion flow is implemented (an editable version of this image is maintained in [Miro](https://miro.com/app/board/uXjVPE5kjdU=/?share_link_id=65605735742)):
12+
13+
![Promotion Flow](/docs/img/promotion-flow.jpg)
14+
515
## Getting Started
616

717
1. Install the CRD on your cluster:

docs/img/promotion-flow.jpg

295 KB
Loading

0 commit comments

Comments
 (0)