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

Compose network documentation: Driver #18799

Closed
1 task done
mr1chter opened this issue Nov 28, 2023 · 3 comments
Closed
1 task done

Compose network documentation: Driver #18799

mr1chter opened this issue Nov 28, 2023 · 3 comments
Labels
area/compose Relates to docker-compose.yml spec or docker-compose binary lifecycle/locked

Comments

@mr1chter
Copy link

mr1chter commented Nov 28, 2023

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

Many examples feature a driver: overlay but the text in the documentation says that host and none are supported. This is mighty confusing. In the next two examples, host and none are used, but for the name attribute. What is this supposed to mean?

Also, the concept of a driver is not explained at all.

Maybe connected to #7439

Location

https://docs.docker.com/compose/compose-file/06-networks/

Suggestion

Maybe it would be great to have just a one-liner or even just a link to the relevant documentation of the network driver concept. This would then also show what "custom drivers" are, that are featured in some of the later examples on the linked page.

As a whole, I'm maybe missing a kind of "default" description. What is set and/or assumed if there is no network section in the compose file?

For context, I'm currently having a situation where docker containers created via compose (no network section in the compose file, single container) can't connect to the internet (meaning ping 8.8.8.8 doesn't work) and I'm completely lost (this might as well also be an issue with my host system setup, not docker, but I haven't figured it out yet).

@mr1chter mr1chter added the status/triage Needs triage label Nov 28, 2023
@aevesdocker aevesdocker added area/compose Relates to docker-compose.yml spec or docker-compose binary and removed status/triage Needs triage labels Nov 28, 2023
@aevesdocker
Copy link
Contributor

Hi @mr1chter, thanks for creating the issue. We have an incoming change to address this. #19276

@mr1chter
Copy link
Author

mr1chter commented Feb 1, 2024

This is great, thanks!

@docker-robot
Copy link

docker-robot bot commented Mar 2, 2024

Closed issues are locked after 30 days of inactivity.
This helps our team focus on active issues.

If you have found a problem that seems similar to this, please open a new issue.

/lifecycle locked

@docker-robot docker-robot bot locked and limited conversation to collaborators Mar 2, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area/compose Relates to docker-compose.yml spec or docker-compose binary lifecycle/locked
Projects
None yet
Development

No branches or pull requests

2 participants