Skip to content

Commit

Permalink
Improve docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
wi1dcard committed Aug 16, 2021
1 parent bb6ba65 commit 4ad1966
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,19 @@ docker pull quay.io/darwinia-network/node-liveness-probe:v0.1.0

- `/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.

## Example

See the full manifests in Kubevali: <https://github.com/darwinia-network/kubevali/blob/master/deploy/manifests/statefulset.yaml>.

## Usage

```yaml
kind: Pod
spec:
containers:

##
# The node container
##
- name: darwinia
image: darwinianetwork/darwinia:NODE_VERSION
# Defining port which will be used to GET plugin health status
Expand All @@ -54,7 +59,9 @@ spec:
port: healthz
# ...

##
# The liveness probe sidecar container
##
- name: liveness-probe
image: quay.io/darwinia-network/node-liveness-probe:VERSION
# ...
Expand Down

0 comments on commit 4ad1966

Please sign in to comment.