Add examples of proxying ping #2102

deitch · 2017-09-11T16:38:29Z

via regular entrypoint and dedicated entrypoint.

Description

Add examples of how to expose /ping on one of:

a regular entrypoint
a dedicated port entrypoint

This is distinct from running it on the normal admin port (default to :8080) and allows you to expose /ping to other networks without exposing the admin port.

As requested by @ldez .

Closes #2094

ldez

Thanks 👍

ldez · 2017-09-11T16:43:09Z

docs/user-guide/examples.md

@@ -296,3 +296,76 @@ defaultEntryPoints = ["http"]
 IdleTimeout = "360s"
 ProvidersThrottleDuration = "5s"
 ```
+
+## Securing Ping Health Check
+The `/ping` health-check URL is enabled together with the web admin panel, enabled with the command-line `--web` or config file option `[web]`. Thus, if you have a regular path for `/foo` and an entrypoint on `:80`, you would access them as follows:


Could add an empty line between the before this line?
Could you put one sentence by line?

Sure, updating now. Out of curiosity, why? I have never seen markdown done with a CRLF between each sentence.

In Markdown, \n between two sentences is replaced by a simple (Expect in Github 😉 )

https://daringfireball.net/projects/markdown/syntax#p

ldez · 2017-09-11T16:43:21Z

docs/user-guide/examples.md

+* Admin panel: `http://hostname:8080/`
+* Ping URL: `http://hostname:8080/ping`
+
+However, for security reasons, you may want to be able to expose the `/ping` health-check URL to outside health-checkers, e.g. an Internet service or cloud load-balancer, _without_ exposing your admin panel's port. In many environments, the security staff may not _allow_ you to expose it.


Could you put one sentence by line?

ldez · 2017-09-11T16:44:25Z

docs/user-guide/examples.md

+The above creates a new backend called `traefik`, lisenting on `http://localhost:8080`, i.e. the local admin port. We only expose the admin panel via the `frontend` named `traefikadmin`, and only expose the `/ping` Path.
+
+## Enable ping health check on dedicated port
+If you do not want to or cannot expose the health-check on a regular entrypoint - e.g. your security rules do not allow it, or you have a conflicting path - then you can enable health-check on its own entrypoint. Use the following config:


Could add an empty line between the before this line?
Could you put one sentence by line?

ldez · 2017-09-11T16:45:12Z

docs/user-guide/examples.md

+
+Note the unique port for `/ping`.
+
+In the above example, it is _very_ important that you create a named dedicated entrypoint, and do **not** include it in `defaultEntryPoints`. Otherwise, you are likely to expose _all_ services via that entrypoint.


Could you put one sentence by line?
And could you add empty line at the end of this file?

ldez · 2017-09-11T16:46:07Z

docs/user-guide/examples.md

+* Admin panel: `http://hostname:8080/`
+* Ping URL: `http://hostname:8082/ping`
+
+Note the unique port for `/ping`.


Could you replace unique by dedicated

deitch · 2017-09-11T17:00:48Z

Updated. Back to you.

ldez

You can show the render here: https://deploy-preview-2102--traefik-docs.netlify.com/user-guide/examples/

ldez · 2017-09-11T17:14:49Z

docs/user-guide/examples.md

+The above creates a new backend called `traefik`, lisenting on `http://localhost:8080`, i.e. the local admin port.
+We only expose the admin panel via the `frontend` named `traefikadmin`, and only expose the `/ping` Path.
+
+## Enable ping health check on dedicated port


## -> ###

deitch · 2017-09-11T17:33:07Z

Uh oh, needs rebase...

deitch · 2017-09-11T17:36:25Z

Rebased

deitch · 2017-09-12T05:20:27Z

@ldez are there any outstanding changes requested? I think we got them all?

nmengin

@deitch Many thanks for your PR.
I have a few remarks/propositions/questions.

nmengin · 2017-09-12T07:55:55Z

docs/user-guide/examples.md

+```
+
+The above creates a new backend called `traefik`, lisenting on `http://localhost:8080`, i.e. the local admin port.
+We only expose the admin panel via the `frontend` named `traefikadmin`, and only expose the `/ping` Path.


s/lisenting/listening/

nmengin · 2017-09-12T08:15:59Z

docs/user-guide/examples.md

+* Admin panel: `http://hostname:8080/`
+* Ping URL: `http://hostname:8082/ping`
+
+Note the dedicated port for `/ping`.


Maybe adding the port number in the note?

nmengin · 2017-09-12T08:16:09Z

docs/user-guide/examples.md

+
+Note the dedicated port for `/ping`.
+
+In the above example, it is _very_ important that you create a named dedicated entrypoint, and do **not** include it in `defaultEntryPoints`.


s/that you create a named dedicated entrypoint/to create a dedicated entrypoint/ ?

and do not include it in defaultEntryPoints

I don't understand what cannot be included in the defaultEntryPoint. Can you develop?

nmengin · 2017-09-12T08:21:41Z

docs/user-guide/examples.md

+Note the dedicated port for `/ping`.
+
+In the above example, it is _very_ important that you create a named dedicated entrypoint, and do **not** include it in `defaultEntryPoints`.
+Otherwise, you are likely to expose _all_ services via that entrypoint.


Do you want to say that if you don't specify a rule on the frontend (rule = "Path:/ping") you can expose all the web admin paths through the ping entrypoint?

deitch · 2017-09-12T08:57:35Z

Thanks @nmengin ; updating now.

deitch · 2017-09-12T08:58:27Z

Updated.

ldez

LGTM

nmengin

LGTM 📖 👏

juliens

LGTM

…trypoint

traefiker added size/M status/0-needs-triage labels Sep 11, 2017

traefiker added this to the 1.4 milestone Sep 11, 2017

ldez changed the title ~~Add examples of proxying ping via regular entrypoint and dedicated en…~~ Add examples of proxying ping Sep 11, 2017

ldez added area/documentation status/2-needs-review and removed status/0-needs-triage labels Sep 11, 2017

ldez suggested changes Sep 11, 2017

View reviewed changes

traefiker added the contributor/waiting-for-corrections label Sep 11, 2017

deitch force-pushed the ping-examples branch from 3d5dc7e to 5483fdd Compare September 11, 2017 17:00

ldez removed the contributor/waiting-for-corrections label Sep 11, 2017

ldez suggested changes Sep 11, 2017

View reviewed changes

traefiker added the contributor/waiting-for-corrections label Sep 11, 2017

deitch force-pushed the ping-examples branch from 5483fdd to b7201c4 Compare September 11, 2017 17:32

ldez removed the contributor/waiting-for-corrections label Sep 11, 2017

deitch force-pushed the ping-examples branch from b7201c4 to ab1ee9a Compare September 11, 2017 17:36

ldez added the area/api label Sep 11, 2017

nmengin requested changes Sep 12, 2017

View reviewed changes

traefiker added the contributor/waiting-for-corrections label Sep 12, 2017

deitch force-pushed the ping-examples branch from ab1ee9a to 09f5dd3 Compare September 12, 2017 08:58

ldez removed the contributor/waiting-for-corrections label Sep 12, 2017

ldez approved these changes Sep 13, 2017

View reviewed changes

nmengin approved these changes Sep 13, 2017

View reviewed changes

juliens approved these changes Sep 13, 2017

View reviewed changes

juliens added status/3-needs-merge and removed status/2-needs-review labels Sep 13, 2017

traefiker added the status/4-merge-in-progress label Sep 13, 2017

Add examples of proxying ping via regular entrypoint and dedicated en…

04bfdcc

…trypoint

traefiker force-pushed the ping-examples branch from 09f5dd3 to 04bfdcc Compare September 13, 2017 12:58

traefiker removed the status/4-merge-in-progress label Sep 13, 2017

traefiker merged commit 883028d into traefik:v1.4 Sep 13, 2017

traefiker removed the status/3-needs-merge label Sep 13, 2017

traefiker mentioned this pull request Sep 13, 2017

Separate ping from dashboard? #2094

Closed

deitch deleted the ping-examples branch September 13, 2017 13:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add examples of proxying ping #2102

Add examples of proxying ping #2102

deitch commented Sep 11, 2017 •

edited by ldez

Loading

ldez left a comment

ldez Sep 11, 2017

deitch Sep 11, 2017

ldez Sep 11, 2017

ldez Sep 11, 2017

ldez Sep 11, 2017

ldez Sep 11, 2017

ldez Sep 11, 2017

deitch commented Sep 11, 2017

ldez left a comment

ldez Sep 11, 2017

deitch Sep 11, 2017

deitch commented Sep 11, 2017

deitch commented Sep 11, 2017

deitch commented Sep 12, 2017

nmengin left a comment •

edited

Loading

nmengin Sep 12, 2017

nmengin Sep 12, 2017

nmengin Sep 12, 2017 •

edited

Loading

nmengin Sep 12, 2017

deitch commented Sep 12, 2017

deitch commented Sep 12, 2017

ldez left a comment

nmengin left a comment

juliens left a comment


		Note the unique port for `/ping`.

		In the above example, it is _very_ important that you create a named dedicated entrypoint, and do not include it in `defaultEntryPoints`. Otherwise, you are likely to expose _all_ services via that entrypoint.


		Note the dedicated port for `/ping`.

		In the above example, it is _very_ important that you create a named dedicated entrypoint, and do not include it in `defaultEntryPoints`.

Add examples of proxying ping #2102

Add examples of proxying ping #2102

Conversation

deitch commented Sep 11, 2017 • edited by ldez Loading

Description

ldez left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

deitch commented Sep 11, 2017

ldez left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

deitch commented Sep 11, 2017

deitch commented Sep 11, 2017

deitch commented Sep 12, 2017

nmengin left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nmengin Sep 12, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

deitch commented Sep 12, 2017

deitch commented Sep 12, 2017

ldez left a comment

Choose a reason for hiding this comment

nmengin left a comment

Choose a reason for hiding this comment

juliens left a comment

Choose a reason for hiding this comment

deitch commented Sep 11, 2017 •

edited by ldez

Loading

nmengin left a comment •

edited

Loading

nmengin Sep 12, 2017 •

edited

Loading