zegl / kube-score

Kubernetes object analysis with recommendations for improved reliability and security. kube-score actively prevents downtime and bugs in your Kubernetes YAML and Charts. Static code analysis for Kubernetes.

Home Page:https://kube-score.com

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Documentation on the use of livenessProbe

binboum opened this issue · comments

Hello :)

We recently used within the company in which I work kube-score in order to improve the quality of our deliverables.

I noticed that on the livenessProbe level documentation : https://github.com/zegl/kube-score/blob/master/README_PROBES.md#livenessprobe

There were these recommendations :

kube-score recommends:

  • If you don't know why you need a livenessProbe, don't configure it.
  • It should never, be the same as your readinessProbe.
  • The livenessProbe should never depend on downstream dependencies, such as databases or other services.

I don't know how the message is interpreted in general.
However, I find this message ambiguous, and in my opinion, It would be a little more educational by encouraging the user to understand his use and it is he who will make the choice knowingly.

I would have preferred a more educational twist like :

image

Here : kubernetes/website#16607 (comment)

PR discussion : kubernetes/website#39930