Skip to content

Commit 5834ae8

Browse files
mariashameowlia
authored andcommitted
Update readiness health checks RFC with CLI options
1 parent 1812a0b commit 5834ae8

File tree

1 file changed

+35
-3
lines changed

1 file changed

+35
-3
lines changed

toc/rfc/rfc-draft-readiness-healthchecks.md

Lines changed: 35 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ than the current option.
4141

4242
## Types of readiness healthcheck
4343

44-
Readiness healthcheck can be either "http" or "tcp" type. The format of healthcheck
44+
Readiness healthcheck can be either "http" or "port" type. The format of healthcheck
4545
type is [similar to liveness
4646
healthcheck](https://docs.cloudfoundry.org/devguide/deploy-apps/healthchecks.html).
4747
The "process" healthcheck type will not be supported since it doesn't make sense
@@ -90,6 +90,10 @@ applications:
9090
readiness-health-check-type: http # 👈 new property
9191
```
9292

93+
New `routable` field in CC API [process stats
94+
object](https://v3-apidocs.cloudfoundry.org/version/3.141.0/index.html#the-process-stats-object)
95+
with values `true` or `false` will display the routable status of the process.
96+
9397
### LRP Design
9498

9599
The readiness healthcheck data will be apart of the desired LRP object.
@@ -117,13 +121,41 @@ The readiness healthcheck data will be apart of the desired LRP object.
117121
},
118122
```
119123

124+
### CLI Changes
125+
126+
The `routable` field of the process stats API object property will be used in
127+
CF CLI `cf app` output.
128+
129+
```
130+
state routable since cpu memory disk logging details
131+
#0 running yes 2023-06-27T15:07:14Z 0.6% 46.8M of 192M 179M of 1G 0/s of unlimited
132+
#1 running no 2023-06-27T15:11:43Z 0.0% 0 of 0 0 of 0 0/s of 0/s
133+
#2 running yes 2023-06-27T15:11:43Z 0.0% 0 of 192M 0 of 1G 0/s of 0/s
134+
```
135+
136+
New CLI options will be added to `cf push` command:
137+
138+
* `--readiness-endpoint` will allows to set the endpoint for http readiness
139+
checks.
140+
* `--readiness-health-check-type` will allows to set the type of the readiness
141+
check: "http" or "port".
142+
143+
New CLI commands will be added:
144+
145+
* `get-readiness-health-check` shows the readiness health check performed on an
146+
app instance
147+
* `set-readiness-health-check` updates the readiness health check performed on
148+
an app instance
149+
120150
### Logging and Metrics
121151

122152
#### App logs
123153

124154
When AI readiness healthcheck succeeds a log line is printed to AI logs:
125-
"Container became ready". When AI readiness healthcheck fails a log line is
126-
printed to AI logs: "Container became not ready".
155+
"Container passed the readiness health check. Container marked ready and added
156+
to route pool". When AI readiness healthcheck fails a log line is printed to AI
157+
logs: "Container failed the readiness health check. Container marked not ready
158+
and removed from route pool".
127159

128160
#### App events
129161

0 commit comments

Comments
 (0)