Skip to content

Commit

Permalink
Update getting-started.md (#253)
Browse files Browse the repository at this point in the history
  • Loading branch information
worldtiki authored Sep 23, 2022
1 parent c155793 commit 7da40d2
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions docs/about/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,16 +72,21 @@ E.g.:

### File probes
Mittens writes files that can be used as liveness and readiness probes. These files are written to disk as `alive` and `ready` respectively.
If you run mittens as a sidecar you can then define a [liveness command](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#define-a-liveness-command) as follows:
If you run mittens as a sidecar you can then define [liveness and readiness commands](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/) as follows:

```
...
livenessProbe:
exec:
command:
- "cat"
- "alive"
readinessProbe:
exec:
command:
- "cat"
- "ready"
...
...
```

In case such probes are not needed you can disable this feature by setting `file-probe-enabled` to `false`.
Expand Down

0 comments on commit 7da40d2

Please sign in to comment.