Skip to content

Commit 9d9d19c

Browse files
ssaengsdanaelhe
andauthored
APPS-5889: add docs for liveness_health_check (digitalocean#1024)
* adding openapi changes. * remove default, fix lint * fix ref * add missing example --------- Co-authored-by: danaelhe <42972711+danaelhe@users.noreply.github.com>
1 parent 5c1de35 commit 9d9d19c

File tree

3 files changed

+59
-0
lines changed

3 files changed

+59
-0
lines changed
Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
type: object
2+
properties:
3+
failure_threshold:
4+
type: integer
5+
format: int32
6+
description: The number of failed health checks before considered unhealthy.
7+
minimum: 1
8+
maximum: 50
9+
example: 18
10+
11+
port:
12+
type: integer
13+
format: int64
14+
description: The port on which the health check will be performed.
15+
example: 80
16+
maximum: 65535
17+
minimum: 1
18+
19+
http_path:
20+
type: string
21+
description: The route path used for the HTTP health check ping. If not set, the HTTP health check will be disabled and a TCP health check used instead.
22+
example: /health
23+
24+
initial_delay_seconds:
25+
type: integer
26+
format: int32
27+
description: The number of seconds to wait before beginning health checks.
28+
minimum: 0
29+
maximum: 3600
30+
example: 30
31+
32+
period_seconds:
33+
type: integer
34+
format: int32
35+
description: The number of seconds to wait between health checks.
36+
minimum: 1
37+
maximum: 300
38+
example: 10
39+
40+
success_threshold:
41+
type: integer
42+
format: int32
43+
description: The number of successful health checks before considered healthy.
44+
example: 1
45+
minimum: 1
46+
maximum: 1
47+
48+
timeout_seconds:
49+
type: integer
50+
format: int32
51+
description: The number of seconds after which the check times out.
52+
minimum: 1
53+
maximum: 120
54+
example: 1

specification/resources/apps/models/app_service_spec.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@ allOf:
1313
health_check:
1414
$ref: app_service_spec_health_check.yml
1515

16+
liveness_health_check:
17+
$ref: app_health_check_spec.yml
18+
1619
protocol:
1720
type: string
1821
description: |

specification/resources/apps/models/app_worker_spec.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ allOf:
55
properties:
66
termination:
77
$ref: app_worker_spec_termination.yml
8+
liveness_health_check:
9+
$ref: app_health_check_spec.yml
810
required:
911
- name
1012

0 commit comments

Comments
 (0)