GUACAMOLE-2035: Add start-up period to guacd health check in Dockerfile

[jeloneal]

Added start-period to docker healthcheck. Should fix containers being stuck in starting state for a long time causing issues with certain docker compose setups.

Without the start-period parameter the healthcheck seems to run only after the set interval of 5 minutes. This is way too long if you use the guacamole container within a stack and the depends_on condition "service_healthy". The deployment of the stack will abort.

Tested this fix on my own setup and it fixes the problem for me. Might be useful for others as well.

[necouchman]

@jeloneal : Thanks for the contribution. In order to process this change you will need to get a Jira account and create a ticket, and then tag both the commit messages and the pull request with the Jira issue. Also, please update the commit messages and Jira issue with more descriptive - something along the lines of "Add start-up period to guacd health check in Dockerfile."

For a full list of contribution guidelines, please see the following site: https://guacamole.apache.org/open-source/.

[jeloneal]

@necouchman thanks for the advice. I updated all elements you mentioned and created the according Jira issue.

[necouchman]

Thanks @jeloneal - one more request, could you please re-base this against the patch branch instead of main - I think this qualifies as a patch/fix, and we'll get it merged into that branch.

[jeloneal]

Thanks @jeloneal - one more request, could you please re-base this against the patch branch instead of main - I think this qualifies as a patch/fix, and we'll get it merged into that branch.

@necouchman looks like you already did that or do you mean I shall fork the patch branch first and add my change from there? I'm not an expert with GIthub yet :)

[necouchman]

@jeloneal I changed the PR request, but, as you can see, it now has 21 commits instead of just the one that you pushed. You'll need to do a git rebase within your local branch, and then a force git push to forcibly update the remote branch with those changes. This should re-align things such that the code will match the PR.

[andrechalella]

Hi, any progress in this? I just hit this and it was supposed to be so simple. Current PR status is:

This branch has conflicts that must be resolved
Changes can be cleanly merged.

[juvanj]

I would also like to either configure the health check or the change to disable it.

[andrechalella]

As a stopgap, the fix can be easily inserted in docker-compose.yaml, overriding guacd's default health check.

Example from https://github.com/andrechalella/guacamole-dockge/

services:
  guacd:
    image: guacamole/guacd
    networks:
      - guacamole-network
    restart: unless-stopped
    # Custom health-check is needed until the below PR gets merged,
    # otherwise guacd takes 5 minutes to show as healthy
    # https://github.com/apache/guacamole-server/pull/577
    healthcheck:
      test: ["CMD", "nc", "-z", "127.0.0.1", "4822"]
      interval: 5m
      timeout: 5s
      start_period: 15s

[juvanj]

As a stopgap, the fix can be easily inserted in docker-compose.yaml, overriding guacd's default health check.

Example from https://github.com/andrechalella/guacamole-dockge/

services:
  guacd:
    image: guacamole/guacd
    networks:
      - guacamole-network
    restart: unless-stopped
    # Custom health-check is needed until the below PR gets merged,
    # otherwise guacd takes 5 minutes to show as healthy
    # https://github.com/apache/guacamole-server/pull/577
    healthcheck:
      test: ["CMD", "nc", "-z", "127.0.0.1", "4822"]
      interval: 5m
      timeout: 5s
      start_period: 15s

That helps me very much. I was not aware that the health check from the docker file won't be executed as well and that all of them need to be fine.

However I learned again something and I'm very suprised that someone help so quickly.

Kinds
Jürgen

[necouchman]

@jeloneal You have a change from GUACAMOLE-663 in this pull request, completely unrelated to the health check changes.