cloudfoundry / cloudfoundry/cli

Add support for health check timeout configuration

Open
#2,366 1 comment 0 reactions 1 assignee View on GitHub

@gururajsh is already working on this.

Since Sep 27, 2024.

feature-request
Dominant language
Go
Stars
1.9k
Forks
990
Avg merge
1d 7h
Merged PRs (30d)
8

Description

What's the user value of this feature request?
Health check configuration will be made more convenient for users not familiar with the CF APIs.

Who is the functionality for?
CF users willing to configure CF health checks via the CF CLI.

Who else is affected by the change?
This feature isn't a breaking change. It suggest to extend the current options supported by cf set-health-check.

Describe the solution you'd like
The CF V3 APIs support a timeout parameter as described in the docs. I'm suggesting to add an additional option to the cf set-health-check command which is called --timeout and can be used to configure the duration in seconds that health checks can fail before the process is restarted.

Describe alternatives you've considered
A workaround is to use the CF APIs directly to set the health check timeout. This can work like this:

cf app <my-app-name> --guid #get app guid
cf curl /v3/apps/<app-guid>/processes #list app processes information
cf curl -H "Content-Type: application/json" -X PATCH -d @health-conf.json /v3/processes/<process-from-previous-command> 

The content of health-conf.json could be something like this:

...
"health_check": {
        "type": "http",
        "data": {
          "timeout": 120,
          "invocation_timeout": null,
          "endpoint": "/health"
        }
      }
...

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.