Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Swarm section to the Docker Provider Documentation #5874

Merged
merged 5 commits into from Nov 27, 2019
Merged

Add Swarm section to the Docker Provider Documentation #5874

merged 5 commits into from Nov 27, 2019

Conversation

dduportal
Copy link
Contributor

@dduportal dduportal commented Nov 20, 2019

What does this PR do?

This PR aims at adding a Swarm section in the Docker provider documentation,
introducing the following changes:

  • [Docker provider documentation] Elaborate that Swarm Mode is supported + elaborate and moving upfront the "Routing Configuration" for Docker standalone
  • [Docker provider documentation] Add a section "Routing Configuration with Labels" for Docker standalone to elaborate the concept (as the quickstart is not really explicit about the "label" magic), and mention other tools that could be used if Docker is used in background
  • [Docker provider documentation] Add a section "Port Detection" for Docker standalone to explain the port detection mechanism
  • [Docker provider documentation] Add a section "Docker API Access" for Docker standalone with the content around security moved here (and adapted to recent publications as it was for Traefik v1)
  • [Docker provider documentation] Add a full section "Docker Swarm Mode", mirroring the 3 sub sections added to standalone (labels, port and api access) to elaborate on the swarm mode specifics.
  • [Docker provider & Docker routing documentations] Minor adaptations to adapt to the new sections introduction (moving configuration examples, adding internal links, etc.)

Motivation

More

  • [ ] Added/updated tests
  • Added/updated documentation

Additional Notes

Copy link
Contributor

@dtomcej dtomcej left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking good, just a few comments!

docs/content/providers/docker.md Outdated Show resolved Hide resolved
docs/content/providers/docker.md Outdated Show resolved Hide resolved
docs/content/providers/docker.md Outdated Show resolved Hide resolved
docs/content/providers/docker.md Outdated Show resolved Hide resolved
docs/content/providers/docker.md Outdated Show resolved Hide resolved
Copy link
Contributor

@dtomcej dtomcej left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM
:shipit:

mpl
mpl previously requested changes Nov 21, 2019
Copy link
Collaborator

@mpl mpl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just a quick pass about english/typoes. I haven't given any thought about the document's structure and contents.

docs/content/providers/docker.md Outdated Show resolved Hide resolved
docs/content/providers/docker.md Outdated Show resolved Hide resolved
docs/content/providers/docker.md Outdated Show resolved Hide resolved
docs/content/providers/docker.md Outdated Show resolved Hide resolved
Copy link
Member

@ldez ldez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Member

@jbdoumenjou jbdoumenjou left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

dduportal and others added 5 commits November 27, 2019 16:06
…specific sections for docker itself

Signed-off-by: dduportal <1522731+dduportal@users.noreply.github.com>
Signed-off-by: dduportal <1522731+dduportal@users.noreply.github.com>
Co-Authored-By: Daniel Tomcej <daniel.tomcej@gmail.com>
Co-Authored-By: mpl <mathieu.lonjaret@gmail.com>
@traefiker traefiker merged commit 2685e06 into traefik:v2.0 Nov 27, 2019
v2 automation moved this from To review to Done Nov 27, 2019
@traefiker traefiker mentioned this pull request Nov 27, 2019
20 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
v2
Done
Development

Successfully merging this pull request may close these issues.

None yet

6 participants