Add logo and update diagrams

README.md

@@ -2,15 +2,18 @@
 
 [![build](https://travis-ci.org/stefanprodan/steerer.svg?branch=master)](https://travis-ci.org/stefanprodan/steerer)
 [![release](https://img.shields.io/github/release/stefanprodan/steerer/all.svg)](https://github.com/stefanprodan/steerer/releases)
+[![report](https://goreportcard.com/badge/github.com/stefanprodan/steerer)](https://goreportcard.com/report/github.com/stefanprodan/steerer)
 [![license](https://img.shields.io/github/license/stefanprodan/steerer.svg)](https://github.com/stefanprodan/steerer/blob/master/LICENSE)
 
 Steerer is a Kubernetes operator that automates the promotion of canary deployments
 using Istio routing for traffic shifting and Prometheus metrics for canary analysis.
+The project is currently in experimental phase and it is expected that breaking changes 
+to the API will be made in the upcoming releases.
 
 ### Install 
 
 Before installing Steerer make sure you have Istio setup up with Prometheus enabled. 
-If you are new to Istio you can follow my [GKE service mesh walk-through](https://github.com/stefanprodan/istio-gke).
+If you are new to Istio you can follow my [Istio service mesh walk-through](https://github.com/stefanprodan/istio-gke).
 
 Deploy Steerer in the `istio-system` namespace using Helm:
 
@@ -25,6 +28,8 @@ helm upgrade --install steerer steerer/steerer \
 --set controlLoopInterval=1m
 ```
 
+Steerer is compatible with Kubernetes >1.10.0 and Istio >1.0.0.
+
 ### Usage
 
 Steerer requires two Kubernetes deployments: one for the version you want to upgrade called _primary_ and one for the _canary_.
@@ -149,7 +154,7 @@ spec:
 
 The canary analysis is using the following promql queries:
  
-HTTP requests success rate percentage:
+_HTTP requests success rate percentage_
 
 ```sql
 sum(
@@ -174,7 +179,7 @@ sum(
 )
 ```
 
-HTTP requests milliseconds duration P99:
+_HTTP requests milliseconds duration P99_
 
 ```sql
 histogram_quantile(0.99, 
@@ -190,7 +195,7 @@ histogram_quantile(0.99,
 )
 ```
 
-### Automated canary analysis and promotion
+### Automated canary analysis, promotions and rollbacks
 
 ![steerer-canary](https://github.com/stefanprodan/steerer/blob/master/docs/diagrams/steerer-canary-hpa.png)
 
@@ -235,6 +240,10 @@ Rollout output:
 ```
 kubectl -n test describe rollout/podinfo
 
+Status:
+  Canary Revision:  16271121
+  Failed Checks:    6
+  State:            finished
 Events:
   Type     Reason  Age   From     Message
   ----     ------  ----  ----     -------
@@ -306,3 +315,53 @@ Events:
   Warning  Synced  1m    steerer  Rolling back podinfo-canary.test failed checks threshold reached 10
   Warning  Synced  1m    steerer  Canary failed! Scaling down podinfo.test
 ```
+
+Trigger a new rollout by updating the canary image:
+
+```bash
+kubectl -n test set image deployment/podinfo-canary \
+podinfod=quay.io/stefanprodan/podinfo:1.2.1
+
+kubectl -n test scale deployment/podinfo-canary \
+--replicas=1
+```
+
+Steer detects that the canary revision changed and starts a new rollout:
+
+```
+kubectl -n test describe rollout/podinfo
+
+Status:
+  Canary Revision:  16871136
+  Failed Checks:    0
+  State:            finished
+Events:
+  Type     Reason  Age   From     Message
+  ----     ------  ----  ----     -------
+  Normal   Synced  3m    steerer  Waiting for podinfo.test rollout to finish: 0 of 1 updated replicas are available
+  Normal   Synced  3m    steerer  Starting rollout for podinfo.test
+  Normal   Synced  3m    steerer  Advance rollout podinfo.test weight 10
+  Normal   Synced  3m    steerer  Advance rollout podinfo.test weight 20
+  Normal   Synced  3m    steerer  Advance rollout podinfo.test weight 30
+  Normal   Synced  2m    steerer  Advance rollout podinfo.test weight 40
+  Normal   Synced  2m    steerer  Advance rollout podinfo.test weight 50
+  Normal   Synced  1m    steerer  Advance rollout podinfo.test weight 60
+  Normal   Synced  1m    steerer  Advance rollout podinfo.test weight 70
+  Normal   Synced  55s   steerer  Advance rollout podinfo.test weight 80
+  Normal   Synced  45s   steerer  Advance rollout podinfo.test weight 90
+  Normal   Synced  35s   steerer  Advance rollout podinfo.test weight 100
+  Normal   Synced  25s   steerer  Copying podinfo-canary.test template spec to podinfo.test
+  Warning  Synced  15s   steerer  Waiting for podinfo.test rollout to finish: 1 of 2 updated replicas are available
+  Normal   Synced  5s    steerer  Promotion completed! Scaling down podinfo-canary.test
+```
+
+### Contributing
+
+Steerer is Apache 2.0 licensed and accepts contributions via GitHub pull requests.
+
+When submitting bug reports please include as much details as possible: 
+* which Steerer version
+* which Steerer CRD version
+* which Kubernetes/Istio version
+* what configuration (rollout, virtual service and workloads definitions)
+* what happened (Steerer, Istio Pilot and Proxy logs)

docs/logo/icon-steerer.svg

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg width="512px" height="534px" viewBox="0 0 512 534" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
+    <!-- Generator: Sketch 51.2 (57519) - http://www.bohemiancoding.com/sketch -->
+    <title>istio-refresh</title>
+    <desc>Created with Sketch.</desc>
+    <defs></defs>
+    <g id="Page-1" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
+        <g id="Logo" transform="translate(-82.000000, -67.000000)" fill-rule="nonzero">
+            <g id="istio-refresh">
+                <polygon id="hull" fill="#466BB0" points="467.486761 456 322.182535 499.591268 235 456"></polygon>
+                <polygon id="mainsail" fill="#466BB0" points="322.182535 426.834648 322.182535 267 235 441.365071"></polygon>
+                <polygon id="headsail" fill="#466BB0" points="466.773803 441.608451 336 151 336 427.078028"></polygon>
+                <g id="arrows" transform="translate(338.000000, 338.000000) rotate(-24.000000) translate(-338.000000, -338.000000) translate(82.000000, 82.000000)">
+                    <path d="M256.000042,0 C114.772094,0 0.00128552135,114.771366 0.00128552135,256 C-0.0639978677,260.61614 2.36127785,264.909841 6.34842716,267.236963 C10.3355765,269.564084 15.2668702,269.564084 19.2540195,267.236963 C23.2411688,264.909841 25.6664445,260.61614 25.6011612,256 C25.6011612,128.607834 128.608494,25.6 256.000042,25.6 C335.938457,25.6 406.118967,66.3034496 447.449109,128 L413.301505,128 C408.685388,127.934716 404.391707,130.360004 402.064597,134.347172 C399.737487,138.334341 399.737487,143.265659 402.064597,147.252828 C404.391707,151.239996 408.685388,153.665284 413.301505,153.6 L470.549003,153.6 L486.398923,153.6 L486.398923,70.7176471 C486.446301,67.257803 485.091067,63.9261384 482.642017,61.4817859 C480.192966,59.0374333 476.858715,57.6886086 473.398986,57.7426467 C466.339613,57.8529965 460.702373,63.6580397 460.799047,70.7176471 L460.799047,102.525005 C414.068394,40.3001766 339.69529,0 256.000042,0 Z" id="Shape" fill="#35A2EE"></path>
+                    <path d="M498.998861,243.024998 C491.939488,243.135348 486.302248,248.940392 486.398923,256 C486.398923,383.392166 383.391589,486.4 256.000042,486.4 C176.054933,486.4 105.870698,445.69303 64.5509751,384 L92.9338727,384.024998 C97.54999,384.090282 101.843671,381.664995 104.170781,377.677826 C106.497891,373.690657 106.497891,368.75934 104.170781,364.772171 C101.843671,360.785002 97.54999,358.359715 92.9338727,358.424998 L44.1010713,358.4 C42.4667939,358.077951 40.7853733,358.077951 39.151096,358.4 L25.6011612,358.4 L25.6011612,432.243137 C25.5358778,436.859277 27.9611535,441.152979 31.9483028,443.4801 C35.9354521,445.807221 40.8667458,445.807221 44.8538951,443.4801 C48.8410445,441.152979 51.2663202,436.859277 51.2010368,432.243137 L51.2010368,409.424998 C97.9168162,471.668595 172.282881,512 256.000042,512 C397.227989,512 511.998798,397.228634 511.998798,256 C512.046177,252.540156 510.690943,249.208491 508.241893,246.764138 C505.792842,244.319785 502.458591,242.97096 498.998861,243.024998 Z" id="Path" fill="#1DCBA2"></path>
+                </g>
+            </g>
+        </g>
+    </g>
+</svg>