docs icon indicating copy to clipboard operation
docs copied to clipboard

Revise documentation for `default-address-pools`

Open polarathene opened this issue 1 year ago • 2 comments
trafficstars

Is this a docs issue?

  • [X] My issue is about the documentation content or website

Type of issue

I can't find what I'm looking for

Description

I could find this myself since I was aware of it from participating in a review that added the information, but recall difficulty finding such information prior.

Main concern is the current location is not as visible for users seeking it as it's not strictly related to IPv6. I've seen this confusion with users recently, thus opening an issue for their benefit 👍


Current docs reference from IPv6 page:

image

Source reference:

https://github.com/moby/moby/blob/ce1ee98aba41e117c59bf17a108191eed14e9b9c/libnetwork/ipamutils/utils.go#L18-L27

@dvdksn and @akerouanton discussed to add a page dedicated to describing IP allocation and how that works, so we can cover this in the follow-up. - Source

It's a lengthy PR review discussion, so perhaps that was referring to "follow-up" as within the same PR, but users may have trouble discovering this non-IPv6 specific information that lives in the IPv6 docs only.


Previous docs issues requesting this information:

  • https://github.com/docker/docs/issues/8663
  • https://github.com/docker/docs/issues/7127

Location

https://docs.docker.com/config/daemon/ipv6/#dynamic-ipv6-subnet-allocation

Suggestion

The default-address-pools information could be extracted from IPv6 page to it's own page? The dockerd reference page has a related config/option should probably also reference it for easier discovery?

polarathene avatar Nov 24 '23 22:11 polarathene

There hasn't been any activity on this issue for a long time. If the problem is still relevant, mark the issue as fresh with a /remove-lifecycle stale comment. If not, this issue will be closed in 14 days. This helps our maintainers focus on the active issues.

Prevent issues from auto-closing with a /lifecycle frozen comment.

/lifecycle stale

docker-robot[bot] avatar Mar 15 '24 01:03 docker-robot[bot]

/remove-lifecycle stale

polarathene avatar Mar 15 '24 06:03 polarathene