wave-k8s / wave

Kubernetes configuration tracking controller
Apache License 2.0
661 stars 81 forks source link

Add documentation in ReadMe.md #19

Closed JoelSpeed closed 5 years ago

JoelSpeed commented 5 years ago

Add some documentation to the project to help people install and get started with the project

JoelSpeed commented 5 years ago

Documentation

JoelSpeed commented 5 years ago

One request I have though: Add a section about how having PDBs is important. Without them, the update on config change may well make an application unavailable.

I'm not convinced that is true, the Deployment controller doesn't use PDBs, it uses health checks to check whether the pods are healthy or not before removing the older pods.

If the Pods literally wont start, the rollout gets paused, if they start but don't meet the health checks, the rollout gets paused. People should set their rolling update strategies appropriately but the defaults will work for most people