ves-io-schema-healthcheck-API-Create
On This Page:
Examples of creating healthcheck
Usecase:
Create healthcheck-productpage to check health of productpage in bookinfo application
Request using vesctl:
vesctl configuration create healthcheck -i healthcheck.yaml
where file healthcheck.yaml has following contents (healthcheck.CreateRequest):
RequestJSON:
{
"metadata": {
"name": "healthcheck-productpage",
"namespace": "documentation"
},
"spec": {
"http_health_check": {
"host_header": "productpage.internal.bookinfo.com",
"path": "/healthcheck"
},
"timeout": 3,
"interval": 10,
"unhealthy_threshold": 3,
"healthy_threshold": 2,
"jitter_percent": 20
}
}
vesctl yaml response:
ResponseJSON:
{
"metadata": {
"name": "healthcheck-productpage",
"namespace": "documentation",
"labels": {},
"annotations": {},
"description": "",
"disable": false
},
"system_metadata": {
"uid": "4e0e10dc-9a14-403b-b86c-adc6ab043891",
"creation_timestamp": "2024-03-21T14:05:30.160162Z",
"deletion_timestamp": null,
"modification_timestamp": null,
"initializers": null,
"finalizers": [],
"tenant": "acmecorp",
"creator_class": "examplesvc",
"creator_id": "examplesvc",
"object_index": 0,
"owner_view": null,
"labels": {}
},
"spec": {
"http_health_check": {
"host_header": "productpage.internal.bookinfo.com",
"path": "/healthcheck",
"headers": {},
"request_headers_to_remove": [],
"use_http2": false,
"expected_status_codes": []
},
"timeout": 3,
"interval": 10,
"jitter": 0,
"unhealthy_threshold": 3,
"healthy_threshold": 2,
"jitter_percent": 20
}
}
Request using curl:
curl -X 'POST' -d '{"metadata":{"name":"healthcheck-productpage","namespace":"documentation"},"spec":{"http_health_check":{"host_header":"productpage.internal.bookinfo.com","path":"/healthcheck"},"timeout":3,"interval":10,"unhealthy_threshold":3,"healthy_threshold":2,"jitter_percent":20}}' -H 'Content-Type: application/json' -H 'X-Volterra-Useragent: v1/pgm=_var_folders_2__8qnt6fwd5dvglr1xqq6l8b7w0000gp_T_go-build3109416560_b001_apidocs.test/host=C02FN35BMD6R/svc=S:examplesvc/site=mytestce01' 'https://acmecorp.console.ves.volterra.io/api/config/namespaces/documentation/healthchecks'
curl response:
HTTP/1.1 200 OK
Content-Length: 1028
Content-Type: application/json
Date: Thu, 21 Mar 2024 14:05:30 GMT
Vary: Accept-Encoding
{
"metadata": {
"name": "healthcheck-productpage",
"namespace": "documentation",
"labels": {
},
"annotations": {
},
"description": "",
"disable": false
},
"system_metadata": {
"uid": "4e0e10dc-9a14-403b-b86c-adc6ab043891",
"creation_timestamp": "2024-03-21T14:05:30.160162Z",
"deletion_timestamp": null,
"modification_timestamp": null,
"initializers": null,
"finalizers": [
],
"tenant": "acmecorp",
"creator_class": "examplesvc",
"creator_id": "examplesvc",
"object_index": 0,
"owner_view": null,
"labels": {
}
},
"spec": {
"http_health_check": {
"host_header": "productpage.internal.bookinfo.com",
"path": "/healthcheck",
"headers": {
},
"request_headers_to_remove": [
],
"use_http2": false,
"expected_status_codes": [
]
},
"timeout": 3,
"interval": 10,
"jitter": 0,
"unhealthy_threshold": 3,
"healthy_threshold": 2,
"jitter_percent": 20
}
}