From 4f00fe66a41a7e63162b7243d212fa6c05aa98c8 Mon Sep 17 00:00:00 2001 From: Piotr Icikowski Date: Sun, 6 Mar 2022 02:04:39 +0100 Subject: [PATCH] Update documentation for GPTS 0.7.3 --- docs/changelog.md | 6 ++++ docs/usage/health.md | 80 +++++++++++++------------------------------- 2 files changed, 30 insertions(+), 56 deletions(-) diff --git a/docs/changelog.md b/docs/changelog.md index 6abedb9..77c0981 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -4,6 +4,12 @@ title: Changelog # Project changelog +## GPTS 0.7.3 + +- Changed liveness and readiness endpoints provider to `github.com/Icikowski/kubeprobes` +- Upgraded project's dependencies +- Updated documentation + ## GPTS 0.7.2 - Updated chart definition diff --git a/docs/usage/health.md b/docs/usage/health.md index 6caef51..8560d44 100644 --- a/docs/usage/health.md +++ b/docs/usage/health.md @@ -6,77 +6,45 @@ title: Liveness & readiness probes Liveness and readiness probe are the way that **GPTS** uses to inform other components about its health. Those are primarily used by Kubernetes, but can be also checked manually. -!!! info "Returned content" - Both endpoints are optimized to return no content and use only status code to indicate whether the service is running (`200 OK`) or not (`503 Service Unavailable`). In order to see whole status message, `?full=1` parameter should be used in requests. +!!! info "No content returned" + Both endpoints are optimized to return no content and use only status code to indicate whether the service is running (`200 OK`) or not (`503 Service Unavailable`). ## Liveness endpoint Liveness endpoint indicates whether application itself (not the exposed service) is up and running. -=== "Standard output" - ```bash - # Change ${GPTS} to proper GPTS healthchecks URL (usually exposed on port 8081) - curl ${GPTS}/live - ``` +```bash +# Change ${GPTS} to proper GPTS healthchecks URL (usually exposed on port 8081) +curl ${GPTS}/live +``` - ???- summary "Example command execution & output" - ```bash - curl http://localhost:8081/live -w "${http_code}" - ``` - ``` - {} - 200 - ``` -=== "Full output" +???- summary "Example command execution & output" ```bash - # Change ${GPTS} to proper GPTS healthchecks URL (usually exposed on port 8081) - curl ${GPTS}/live?full=1 + curl http://localhost:8081/live -w "${http_code}" + ``` + ``` + {} + 200 ``` - - ???- summary "Example command execution & output" - ```bash - curl http://localhost:8081/live?full=1 - ``` - ```json - { - "application": "OK" - } - ``` ## Readiness endpoint -Readiness endpoint indicates whether both application and the exposed service (presented as `gpts`) are up and running. +Readiness endpoint indicates whether both application and the exposed service are up and running. -=== "Standard output" - ```bash - # Change ${GPTS} to proper GPTS healthchecks URL (usually exposed on port 8081) - curl ${GPTS}/ready - ``` - ???- summary "Example command execution & output" - ```bash - curl http://localhost:8081/ready -w "${http_code}" - ``` - ``` - {} - 200 - ``` -=== "Full output" +```bash +# Change ${GPTS} to proper GPTS healthchecks URL (usually exposed on port 8081) +curl ${GPTS}/ready +``` + +???- summary "Example command execution & output" ```bash - # Change ${GPTS} to proper GPTS healthchecks URL (usually exposed on port 8081) - curl ${GPTS}/live?full=1 + curl http://localhost:8081/ready -w "${http_code}" + ``` + ``` + {} + 200 ``` - - ???- summary "Example command execution & output" - ```bash - curl http://localhost:8081/live?full=1 - ``` - ```json - { - "application": "OK", - "gpts": "OK" - } - ``` ## Possible statuses