Skip to content
This repository has been archived by the owner on Nov 6, 2020. It is now read-only.

Add readiness check for docker container #9804

Merged
merged 2 commits into from
Oct 26, 2018
Merged

Add readiness check for docker container #9804

merged 2 commits into from
Oct 26, 2018

Conversation

beetahnator
Copy link
Contributor

@beetahnator beetahnator commented Oct 23, 2018 •
edited
Loading

Since parity is built for "mission critical use", I thought other operators may see the need for this.

Adding the curl and jq commands allows for an extremely simple health check to be usable in container orchestrators.

For ease of use, I've added a simple health check script that is ready to go.

Here is an example of it being used in Kubernetes

    spec:
      containers:
        image: parity/parity:stable
        imagePullPolicy: Always
        name: parity
        readinessProbe:
          exec:
            command:
            - /check_sync.sh
          failureThreshold: 3
          initialDelaySeconds: 5
          periodSeconds: 5
          successThreshold: 1
          timeoutSeconds: 1
        resources:
          limits:
            cpu: "1"
            memory: 4Gi
          requests:
            cpu: 500m
            memory: 2Gi

@beetahnator
Update Dockerfile
1958596 
Since parity is built for "mission critical use", I thought other operators may see the need for this.

Adding the `curl` and `jq` commands allows for an extremely simple health check to be usable in container orchestrators.

For example. Here is a health check for a parity docker container running in Kubernetes.

This can be setup as a readiness Probe that would prevent clustered nodes that aren't ready from serving traffic.

```bash
#!/bin/bash

ETH_SYNCING=$(curl -X POST --data '{"jsonrpc":"2.0","method":"eth_syncing","params":[],"id":1}' http://localhost:8545 -H 'Content-Type: application/json')
RESULT=$(echo "$ETH_SYNCING | jq -r .result)

if [ "$RESULT" == "false" ]; then
  echo "Parity is ready to start accepting traffic"
  exit 0
else
  echo "Parity is still syncing the blockchain"
  exit 1
fi
```
@parity-cla-bot
Copy link

It looks like @mazamats hasn't signed our Contributor License Agreement, yet.

The purpose of a CLA is to ensure that the guardian of a project's outputs has the necessary ownership or grants of rights over all contributions to allow them to distribute under the chosen licence.
Wikipedia

You can read and sign our full Contributor License Agreement at the following URL: https://cla.parity.io

Once you've signed, please reply to this thread with [clabot:check] to prove it.

Many thanks,

Parity Technologies CLA Bot

@beetahnator
Copy link
Contributor Author

[clabot:check]

@parity-cla-bot
Copy link

It looks like @mazamats signed our Contributor License Agreement. 👍

Many thanks,

Parity Technologies CLA Bot

@beetahnator beetahnator changed the title Update Dockerfile Add curl and jq to Dockerfile Oct 23, 2018
@5chdn 5chdn added this to the 2.2 milestone Oct 24, 2018
@5chdn 5chdn added A0-pleasereview 🤓 Pull request needs code review. M1-ci 🙉 Continuous integration. labels Oct 24, 2018
@beetahnator beetahnator changed the title Add curl and jq to Dockerfile Add load balancer check for docker container Oct 24, 2018
@beetahnator beetahnator changed the title Add load balancer check for docker container Add readiness check for docker container Oct 25, 2018
@sorpaas sorpaas added A8-looksgood 🦄 Pull request is reviewed well. and removed A0-pleasereview 🤓 Pull request needs code review. labels Oct 26, 2018
@5chdn 5chdn merged commit 9b55169 into openethereum:master Oct 26, 2018
@beetahnator beetahnator deleted the patch-1 branch October 26, 2018 17:05
5chdn
5chdn reviewed Nov 2, 2018
View reviewed changes
scripts/docker/hub/Dockerfile
@@ -31,6 +31,8 @@ COPY artifacts/x86_64-unknown-linux-gnu/$TARGET ./bin/$TARGET
RUN echo "#!/bin/bash \n ${TARGET} \$@" > ./entrypoint.sh
RUN chmod +x ./entrypoint.sh

ADD check_sync.sh /check_sync.sh
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

missing a leading dot here ./check_sync.sh

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The script should still be executable and I would prefer to invoke it from /check_sync.sh rather than /home/parity/check_sync.sh

Either works though, the latter is just more cumbersome.

ddorgan added a commit that referenced this pull request Nov 7, 2018
@ddorgan
Fix docker push (broken since #9804)
38cfe26
5chdn pushed a commit that referenced this pull request Nov 27, 2018
@beetahnator @5chdn
Add readiness check for docker container (#9804)
9947513 
* Update Dockerfile

Since parity is built for "mission critical use", I thought other operators may see the need for this.

Adding the `curl` and `jq` commands allows for an extremely simple health check to be usable in container orchestrators.

For example. Here is a health check for a parity docker container running in Kubernetes.

This can be setup as a readiness Probe that would prevent clustered nodes that aren't ready from serving traffic.

```bash
#!/bin/bash

ETH_SYNCING=$(curl -X POST --data '{"jsonrpc":"2.0","method":"eth_syncing","params":[],"id":1}' http://localhost:8545 -H 'Content-Type: application/json')
RESULT=$(echo "$ETH_SYNCING | jq -r .result)

if [ "$RESULT" == "false" ]; then
  echo "Parity is ready to start accepting traffic"
  exit 0
else
  echo "Parity is still syncing the blockchain"
  exit 1
fi
```

* add sync check script
@5chdn 5chdn mentioned this pull request Nov 27, 2018
Merged
10 tasks
5chdn added a commit that referenced this pull request Nov 28, 2018
@5chdn
Backports for stable 2.1.7 (#9975)
126208c 
* version: bump stable to 2.1.7

* Adjust requests costs for light client (#9925)

* PIP Table Cost relative to average peers instead of max peers

* Add tracing in PIP new_cost_table

* Update stat peer_count

* Use number of leeching peers for Light serve costs

* Fix test::light_params_load_share_depends_on_max_peers (wrong type)

* Remove (now) useless test

* Remove `load_share` from LightParams.Config
Prevent div. by 0

* Add LEECHER_COUNT_FACTOR

* PR Grumble: u64 to u32 for f64 casting

* Prevent u32 overflow for avg_peer_count

* Add tests for LightSync::Statistics

* Fix empty steps (#9939)

* Don't send empty step twice or empty step then block.

* Perform basic validation of locally sealed blocks.

* Don't include empty step twice.

* prevent silent errors in daemon mode, closes #9367 (#9946)

* Fix light client informant while syncing (#9932)

* Add `is_idle` to LightSync to check importing status

* Use SyncStateWrapper to make sure is_idle gets updates

* Update is_major_import to use verified queue size as well

* Add comment for `is_idle`

* Add Debug to `SyncStateWrapper`

* `fn get` -> `fn into_inner`

*  ci: rearrange pipeline by logic (#9970)

* ci: rearrange pipeline by logic

* ci: rename docs script

* Add readiness check for docker container (#9804)

* Update Dockerfile

Since parity is built for "mission critical use", I thought other operators may see the need for this.

Adding the `curl` and `jq` commands allows for an extremely simple health check to be usable in container orchestrators.

For example. Here is a health check for a parity docker container running in Kubernetes.

This can be setup as a readiness Probe that would prevent clustered nodes that aren't ready from serving traffic.

```bash
#!/bin/bash

ETH_SYNCING=$(curl -X POST --data '{"jsonrpc":"2.0","method":"eth_syncing","params":[],"id":1}' http://localhost:8545 -H 'Content-Type: application/json')
RESULT=$(echo "$ETH_SYNCING | jq -r .result)

if [ "$RESULT" == "false" ]; then
  echo "Parity is ready to start accepting traffic"
  exit 0
else
  echo "Parity is still syncing the blockchain"
  exit 1
fi
```

* add sync check script

* Fix docker script (#9854)


* Dockerfile: change source path of the newly added check_sync.sh (#9869)

* Do not use the home directory as the working dir in docker (#9834)

* Do not create a home directory.

* Re-add -m flag

* fix docker build (#9971)

* bump smallvec to 0.6 in ethcore-light, ethstore and whisper (#9588)

* bump smallvec to 0.6 in ethcore-light, ethstore and whisper

* bump transaction-pool

* Fix test.

* patch cargo to use tokio-proto from git repo

this makes sure we no longer depend on smallvec 0.2.1 which is
affected by servo/rust-smallvec#96

* use patched version of untrusted 0.5.1

* ci: allow audit to fail
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@5chdn 5chdn 5chdn approved these changes

@sorpaas sorpaas sorpaas approved these changes

Assignees
No one assigned
Labels
A8-looksgood 🦄 Pull request is reviewed well. M1-ci 🙉 Continuous integration.
Projects
None yet
Milestone
2.2
Development

Successfully merging this pull request may close these issues.
4 participants
@beetahnator @parity-cla-bot @sorpaas @5chdn