From 668ff71470b641bcbb2301db10c3ed61eee95339 Mon Sep 17 00:00:00 2001 From: Jan Sauer Date: Mon, 7 Oct 2019 15:12:05 +0200 Subject: [PATCH] Replace ambiguous cli help message wording --- cmd/healthcheck/healthcheck.go | 2 +- docs/content/operations/ping.md | 3 +++ 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/cmd/healthcheck/healthcheck.go b/cmd/healthcheck/healthcheck.go index 829e473aa..bf1c2762f 100644 --- a/cmd/healthcheck/healthcheck.go +++ b/cmd/healthcheck/healthcheck.go @@ -15,7 +15,7 @@ import ( func NewCmd(traefikConfiguration *static.Configuration, loaders []cli.ResourceLoader) *cli.Command { return &cli.Command{ Name: "healthcheck", - Description: `Calls Traefik /ping to check the health of Traefik (the API must be enabled).`, + Description: `Calls Traefik /ping endpoint (disabled by default) to check the health of Traefik.`, Configuration: traefikConfiguration, Run: runCmd(traefikConfiguration), Resources: loaders, diff --git a/docs/content/operations/ping.md b/docs/content/operations/ping.md index 26c03fca4..b0640207b 100644 --- a/docs/content/operations/ping.md +++ b/docs/content/operations/ping.md @@ -29,6 +29,9 @@ You can customize the `entryPoint` where the `/ping` is active with the `entryPo |---------|---------------|-----------------------------------------------------------------------------------------------------| | `/ping` | `GET`, `HEAD` | A simple endpoint to check for Traefik process liveness. Return a code `200` with the content: `OK` | +!!! note + The `cli` comes with a [`healthcheck`](./cli.md#healthcheck) command which can be used for calling this endpoint. + ### `entryPoint` Enabling /ping on a dedicated EntryPoint.