baalajimaestro/traefik
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

Replace ambiguous cli help message wording

Browse source
This commit is contained in:
Jan Sauer 2019-10-07 15:12:05 +02:00 committed by Traefiker Bot
parent 538d5e8be4
commit 668ff71470
2 changed files with 4 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
cmd/healthcheck/healthcheck.go
View file

@ -15,7 +15,7 @@ import (
func NewCmd(traefikConfiguration *static.Configuration, loaders []cli.ResourceLoader) *cli.Command { func NewCmd(traefikConfiguration *static.Configuration, loaders []cli.ResourceLoader) *cli.Command {
return &cli.Command{ return &cli.Command{
Name: "healthcheck", 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, Configuration: traefikConfiguration,
Run: runCmd(traefikConfiguration), Run: runCmd(traefikConfiguration),
Resources: loaders, Resources: loaders,

3
docs/content/operations/ping.md
View file

@ -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` | | `/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` ### `entryPoint`
Enabling /ping on a dedicated EntryPoint. Enabling /ping on a dedicated EntryPoint.