Skip to content

docs: clarify that --data-path-addr doesn't restrict access#4997

Merged
thaJeztah merged 1 commit intodocker:masterfrom
dvdksn:doc-vxlan-listen-addr
May 13, 2024
Merged

docs: clarify that --data-path-addr doesn't restrict access#4997
thaJeztah merged 1 commit intodocker:masterfrom
dvdksn:doc-vxlan-listen-addr

Conversation

@dvdksn
Copy link
Contributor

@dvdksn dvdksn commented Apr 9, 2024

- What I did

Added a paragraph that clarifies the scope of the --data-path-addr for docker swarm init.

Relates to moby/moby#47667

- How I did it

- How to verify it

- Description for the changelog

- A picture of a cute animal (not mandatory but encouraged)

@dvdksn dvdksn requested a review from thaJeztah as a code owner April 9, 2024 10:59
@dvdksn
Copy link
Contributor Author

dvdksn commented Apr 9, 2024

cc @corhere

@dvdksn dvdksn self-assigned this Apr 9, 2024
@codecov-commenter
Copy link

codecov-commenter commented Apr 9, 2024

Codecov Report

Merging #4997 (faf096b) into master (c23a404) will decrease coverage by 0.03%.
The diff coverage is n/a.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #4997      +/-   ##
==========================================
- Coverage   61.04%   61.02%   -0.03%     
==========================================
  Files         295      295              
  Lines       20648    20648              
==========================================
- Hits        12605    12600       -5     
- Misses       7147     7150       +3     
- Partials      896      898       +2     

@dvdksn dvdksn force-pushed the doc-vxlan-listen-addr branch from c77e7a0 to faf096b Compare April 9, 2024 11:08
@thaJeztah
Copy link
Member

Wondering if we should borrow some wording from --advertise-addr. Effectively (if my interpretation is correct here), --data-path-addr is advertising the address to use (I guess in hindsight, the flag should've been named to reflect that?)

### <a name="advertise-addr"></a> Specify interface for outbound control plane traffic (--advertise-addr)
The `--advertise-addr` flag specifies the address that will be advertised to
other members of the swarm for API access and overlay networking. If
unspecified, Docker will check if the system has a single IP address, and use
that IP address with the listening port (see `--listen-addr`). If the system
has multiple IP addresses, `--advertise-addr` must be specified so that the
correct address is chosen for inter-manager communication and overlay
networking.
It is also possible to specify a network interface to advertise that
interface's address; for example `--advertise-addr eth0:2377`.
Specifying a port is optional. If the value is a bare IP address or interface
name, the default port 2377 is used.

Copy link
Member

@thaJeztah thaJeztah left a comment

Choose a reason for hiding this comment

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

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants