diff --git a/src/graceful_termination.jl b/src/graceful_termination.jl index 9d74f1e..f3605aa 100644 --- a/src/graceful_termination.jl +++ b/src/graceful_termination.jl @@ -50,7 +50,7 @@ Julia process. ```julia app_status = AppStatus() -graceful_terminator(() -> shutdown(app_status)) +graceful_terminator(() -> shutdown!(app_status)) ``` ## Kubernetes Setup diff --git a/src/health.jl b/src/health.jl index ff54878..cebb3b5 100644 --- a/src/health.jl +++ b/src/health.jl @@ -13,7 +13,7 @@ Construct an application `Deputy` which provides health check endpoints. ## Keywords - `shutdown_handler` (optional): A zero-argument function which allows the user to provide - a custom callback function for when `shutdown(::Deputy)` is called. + a custom callback function for when `shutdown!(::Deputy)` is called. - `shutdown_handler_timeout::Period` (optional): Specifies the maximum execution duration of a `shutdown_handler`. """ diff --git a/src/server.jl b/src/server.jl index 4703ab0..66b9a2b 100644 --- a/src/server.jl +++ b/src/server.jl @@ -12,7 +12,7 @@ Starts a non-blocking `HTTP.Server` responding to requests to `deputy` health ch following health check endpoints are available: - `/health/live`: Is the server is alive/running? -- `/health/ready`: Is the server ready (has `readied(deputy)` been called)? +- `/health/ready`: Is the server ready (has `readied!(deputy)` been called)? These endpoints will respond with HTTP status `200 OK` on success or `503 Service Unavailable` on failure. diff --git a/test/health.jl b/test/health.jl index 901cf0b..36227a1 100644 --- a/test/health.jl +++ b/test/health.jl @@ -177,7 +177,7 @@ end r = HTTP.get("http://$localhost:$port/health/live") @test r.status == 200 - # Faking shutting down. Normal usage would call `shutdown` but we don't want to + # Faking shutting down. Normal usage would call `shutdown!` but we don't want to # terminate our test process. deputy.shutting_down = true