mirrors/PairDrop
1
0
Fork 0
mirror of https://github.com/schlagmichdoch/PairDrop.git synced 2025-04-21 07:16:18 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

docker-swarm-usage reworked

Browse source
This commit is contained in:
Allan Nordhøy 2023-07-08 12:59:58 +00:00 • committed by GitHub
parent 2d0ea9a2f1
commit 044d7aa20d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 19 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

34
docs/docker-swarm-usage.md
View file

@ -2,42 +2,46 @@
## Healthcheck ## Healthcheck
The [Docker Image](../Dockerfile) includes a Healthcheck with the following options: The [Docker Image](../Dockerfile) includes a health check with the following options:
``` ```
--interval=30s --interval=30s
``` ```
> Specifies the time interval at which the health check should be performed. In this case, the health check will be performed every 30 seconds. > Specifies the time interval to run the health check. \
> In this case, the health check is performed every 30 seconds.
<br> <br>
``` ```
--timeout=10s --timeout=10s
``` ```
> Specifies the amount of time to wait for a response from the health check command. If the response does not arrive within 10 seconds, the health check will be considered a failure. > Specifies the amount of time to wait for a response from the \"healthcheck\" command. \
> If the response does not arrive within 10 seconds, the health check fails.
<br> <br>
``` ```
--start-period=5s --start-period=5s
``` ```
> Specifies the amount of time to wait before starting the health check process. In this case, the health check process will begin 5 seconds after the container is started. > Specifies the amount of time to wait before starting the health check process. \
> In this case, the health check process will begin 5 seconds after the container is started.
<br> <br>
``` ```
--retries=3 --retries=3
``` ```
> Specifies the number of times Docker should retry the health check before considering the container to be unhealthy. > Specifies the number of times Docker should retry the health check \
> before considering the container to be unhealthy.
<br> <br>
The CMD instruction is used to define the command that will be run as part of the health check. The CMD instruction is used to define the command that will be run as part of the health check. \
In this case, the command is `wget --quiet --tries=1 --spider http://localhost:3000/ || exit 1`. This command will attempt to connect to `http://localhost:3000/` In this case, the command is `wget --quiet --tries=1 --spider http://localhost:3000/ || exit 1`. \
and if it fails it will exit with a status code of `1`. If this command returns a status code other than `0`, the health check will be considered a failure. This command will attempt to connect to `http://localhost:3000/` \
and if it fails it will exit with a status code of `1`. \
If this command returns a status code other than `0`, the health check fails.
Overall, this HEALTHCHECK instruction is defining a health check process that will run every 30 seconds, wait up to 10 seconds for a response, Overall, this HEALTHCHECK instruction is defining a health check process \
begin 5 seconds after the container is started, and retry up to 3 times. that runs every 30 seconds, and waits up to 10 seconds for a response, \
The health check will consist of attempting to connect to http://localhost:3000/ and will consider the container to be unhealthy if it is unable to connect. begins 5 seconds after the container is started, and retries up to 3 times. \
The health check attempts to connect to http://localhost:3000/ \
and will considers the container unhealthy if unable to connect.