Skip to content

Commit 67668d5

Browse files
tas-runtime-bottas-runtime-bot
committed
Sync README.md
1 parent 865f89d commit 67668d5

File tree

1 file changed

+23
-106
lines changed

1 file changed

+23
-106
lines changed

‎README.md‎

Lines changed: 23 additions & 106 deletions
Original file line numberDiff line numberDiff line change
@@ -1,115 +1,32 @@
1-
# healthcheck
1+
# Healthcheck
22

3-
**Note**: This repository should be imported as `code.cloudfoundry.org/healthcheck`.
3+
Healthcheck implements startup, liveness, and readiness healthchecks for
4+
app containers.
45

5-
Common healthcheck for buildpacks and docker.
6+
> \[!NOTE\]
7+
>
8+
> This repository should be imported as
9+
> `code.cloudfoundry.org/healthcheck`.
610
7-
## Reporting issues and requesting features
11+
# Docs
812

9-
Please report all issues and feature requests in [cloudfoundry/diego-release](https://github.com/cloudfoundry/diego-release/issues).
13+
- [Startup Healthchecks](./docs/010-startup.md)
14+
- [Liveness Healthchecks](./docs/020-liveness.md)
15+
- [Readiness Healthchecks](./docs/030-readiness.md)
1016

11-
## Types of Healthchecks
17+
# Contributing
1218

13-
### Startup Healthcheck
19+
See the [Contributing.md](./.github/CONTRIBUTING.md) for more
20+
information on how to contribute.
1421

15-
```
16-
# HTTP Startup Healthcheck
17-
./healthcheck -uri=URI \
18-
-startup-interval=INTERVAL \
19-
[-port=PORT]
20-
[-timeout=TIMEOUT] \
21-
[-startup-timeout=STARTUP_TIMEOUT]
22+
# Working Group Charter
2223

23-
# TCP Startup Healthcheck
24-
./healthcheck \
25-
-startup-interval=INTERVAL \
26-
[-port=PORT]
27-
[-timeout=TIMEOUT] \
28-
[-startup-timeout=STARTUP_TIMEOUT]
29-
```
24+
This repository is maintained by [App Runtime
25+
Platform](https://github.com/cloudfoundry/community/blob/main/toc/working-groups/app-runtime-platform.md)
26+
under `Diego` area.
3027

31-
| Flag | Default | Description |
32-
|---|---|---|
33-
| uri | no default | URI to healthcheck. Required for HTTP healthchecks. |
34-
| port | 8080 | Port to healthcheck. |
35-
| timeout | 1s | Dial timeout when connecting to app. |
36-
| startup-interval | 0s | If set, starts the healthcheck in startup mode, i.e. do not exit until the healthcheck passes. Runs checks every startup-interval. Required for startup healthchecks. |
37-
| startup-timeout | 60s | Only relevant if healthcheck is running in startup mode. When the timeout is set to a non-zero value, the healthcheck will return non-zero with any errors if this timeout is hit without the healthcheck passing. |
38-
39-
The startup healthcheck should be used when an app is starting up. It will return zero when the healthcheck gets a successful response. It will return non-zero when it does not get a successful response within the timeouts; this means that the app did not start in the timeout provided.
40-
41-
### Liveness Healthcheck
42-
43-
```
44-
# HTTP Liveness Healthcheck
45-
./healthcheck -uri=URI \
46-
-liveness-interval=INTERVAL \
47-
[-port=PORT]
48-
[-timeout=TIMEOUT]
49-
50-
# TCP Liveness Healthcheck
51-
./healthcheck \
52-
-liveness-interval=INTERVAL \
53-
[-port=PORT]
54-
[-timeout=TIMEOUT]
55-
```
56-
57-
| Flag | Default | Description |
58-
|---|---|---|
59-
| uri | no default | URI to healthcheck. Required for HTTP healthchecks. |
60-
| port | 8080 | Port to healthcheck. |
61-
| timeout | 1s | Dial timeout when connecting to app. |
62-
| liveness-interval | 0s | If set, starts the healthcheck in liveness mode, i.e. the app is alive and hasn't crashed, do not exit until the healthcheck fails. runs checks every liveness-interval. Required for liveness healthchecks. |
63-
64-
The Liveness healthcheck should be used once the app has passed the startup healthcheck. This healthcheck will return non-zero when the healthcheck gets a failure response. This indicates that the app was running, but something has gone wrong. As long as the healthcheck keeps getting a healthy response from the app, then it will not stop running.
65-
66-
### Until Ready Readiness Healthcheck
67-
68-
```
69-
# HTTP Until Ready Readiness Healthcheck
70-
./healthcheck -uri=URI \
71-
-until-ready-interval=INTERVAL \
72-
[-port=PORT]
73-
[-timeout=TIMEOUT]
74-
75-
# TCP Until Ready Readiness Healthcheck
76-
./healthcheck \
77-
-until-ready-interval=INTERVAL \
78-
[-port=PORT]
79-
[-timeout=TIMEOUT]
80-
```
81-
82-
| Flag | Default | Description |
83-
|---|---|---|
84-
| uri | no default | URI to healthcheck. Required for HTTP healthchecks. |
85-
| port | 8080 | Port to healthcheck. |
86-
| timeout | 1s | Dial timeout when connecting to app. |
87-
| until-ready-interval | 0s | If set, starts the healthcheck in until-ready mode, i.e. do not exit until the healthcheck passes and the app is ready to serve traffic. Runs checks every until-ready-interval. Required for until ready readiness healthchecks. |
88-
89-
The until ready readiness healthcheck will return zero when the healthcheck gets a successful response. This indicates that the app is running and ready to be routed to. As long as the healthcheck keeps getting a failure response from the app, then it will not stop running.
90-
91-
92-
### Until Failure Readiness Healthcheck
93-
94-
```
95-
# HTTP Until Failure Readiness Healthcheck
96-
./healthcheck -uri=URI \
97-
-readiness-interval=INTERVAL \
98-
[-port=PORT]
99-
[-timeout=TIMEOUT]
100-
101-
# TCP Until Failure Readiness Healthcheck
102-
./healthcheck \
103-
-readiness-interval=INTERVAL \
104-
[-port=PORT]
105-
[-timeout=TIMEOUT]
106-
```
107-
108-
| Flag | Default | Description |
109-
|---|---|---|
110-
| uri | no default | URI to healthcheck. Required for HTTP healthchecks. |
111-
| port | 8080 | Port to healthcheck. |
112-
| timeout | 1s | Dial timeout when connecting to app. |
113-
| readiness-interval | 0s | If set, starts the healthcheck in readiness mode, i.e. the app is ready to serve traffic, i.e. do not exit until the healthcheck fails because the target isn't serving traffic or another process doesn't exist. Runs checks every readiness-interval. Required for until failure readiness healthchecks. |
114-
115-
The until ready failure healthcheck will return non-zero when the healthcheck gets a failure response. This indicates that the app is no longer ready to be routed to. As long as the healthcheck keeps getting a success response from the app, then it will not stop running.
28+
> \[!IMPORTANT\]
29+
>
30+
> Content in this file is managed by the [CI task
31+
> `sync-readme`](https://github.com/cloudfoundry/wg-app-platform-runtime-ci/blob/c83c224ad06515ed52f51bdadf6075f56300ec93/shared/tasks/sync-readme/metadata.yml)
32+
> and is generated by CI following a convention.

0 commit comments

Comments
 (0)