Skip to content
This repository was archived by the owner on Mar 3, 2025. It is now read-only.

Commit 4ad1966

Browse files
committed
Improve docs.
1 parent bb6ba65 commit 4ad1966

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,14 +25,19 @@ docker pull quay.io/darwinia-network/node-liveness-probe:v0.1.0
2525

2626
- `/readiness` checks if node is still in syncing. This can be used with ReadinessProbe, to make sure RPC requests to a Service will only be served by nodes that have followed up.
2727

28+
## Example
29+
30+
See the full manifests in Kubevali: <https://github.com/darwinia-network/kubevali/blob/master/deploy/manifests/statefulset.yaml>.
31+
2832
## Usage
2933

3034
```yaml
3135
kind: Pod
3236
spec:
3337
containers:
34-
38+
##
3539
# The node container
40+
##
3641
- name: darwinia
3742
image: darwinianetwork/darwinia:NODE_VERSION
3843
# Defining port which will be used to GET plugin health status
@@ -54,7 +59,9 @@ spec:
5459
port: healthz
5560
# ...
5661

62+
##
5763
# The liveness probe sidecar container
64+
##
5865
- name: liveness-probe
5966
image: quay.io/darwinia-network/node-liveness-probe:VERSION
6067
# ...

0 commit comments

Comments
 (0)