docker / docker/docs

Revise documentation for `default-address-pools`

Open
#18,782 3 comments 1 reaction 1 assignee View on GitHub

@dvdksn is already working on this.

Since Nov 25, 2023.

agent/skip agent/triaged area/networking lifecycle/frozen status/triage
Dominant language
Markdown
Stars
4.7k
Forks
8.5k
Avg merge
2d 18h
Merged PRs (30d)
108

Description

Is this a docs issue?
  • 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:

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?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.