diff --git a/README.md b/README.md index 23dc627e..6c795c6a 100644 --- a/README.md +++ b/README.md @@ -24,12 +24,14 @@ helm upgrade --install steerer steerer/steerer \ --set controlLoopInterval=1m ``` -## Usage +### Usage Steerer requires two Kubernetes deployments: one for the version you want to upgrade called _primary_ and one for the _canary_. Each deployment must have a corresponding ClusterIP service that exposes a port named http or https. These services are used as destinations in a Istio virtual service. +![steerer-overview](https://github.com/stefanprodan/steerer/blob/master/docs/diagrams/steerer-overview.png) + Gated rollout stages: * scan for deployments marked for rollout diff --git a/docs/diagrams/steerer-overview.png b/docs/diagrams/steerer-overview.png new file mode 100644 index 00000000..7f059740 Binary files /dev/null and b/docs/diagrams/steerer-overview.png differ