moby / libnetwork

networking for containers
Apache License 2.0
2.16k stars 879 forks source link

Please state clearly in README whether this project is limited to docker, and/or has docker as a dependency #1250

Open ghost opened 8 years ago

ghost commented 8 years ago

The README is a bit ambiguous about whether this project can be used easily for other container handling software outside of docker.

At the top of the README it says:

Docker Networking

.. which suggests the project is strongly tied to and possibly depending on docker to work.

However, in design.md it says:

libnetwork project will follow Docker and Linux philosophy of developing small, highly modular and composable tools that work well independently. Libnetwork aims to satisfy that composable need for Networking in Containers.

.. which suggests it is independent or at least meant to be for the future.

Therefore, please state clearly in README whether this project is limited to use with/for docker, and whether it has docker as a required hard dependency when using it. Also if it is an independent project, please change the GitHub short description for the project from "Docker Networking" to something like "Container Networking for use by Docker and possibly other container engines" to make this more clear (and possibly add an explicit note about the possible independent use to the README too)

leecalcote commented 8 years ago

If CNM/libnetwork is to be used independently of Docker engine, it'd be great to see examples of other runtimes or orchestrators leveraging CNM/libnetwork.

leecalcote commented 8 years ago

@nerdalert, is this statement accurate: "CNM was not designed to be container engine agnostic. CNM can only be used with Docker engine. "?

ghost commented 7 years ago

Any update on this? It shouldn't be that hard to decide on what the situation is, and put in a 1-2 sentence remark to clarify this.

GordonTheTurtle commented 7 years ago

@JonasT It has been detected that this issue has not received any activity in over 6 months. Can you please let us know if it is still relevant:

Thank you! This issue will be automatically closed in 1 week unless it is commented on. For more information please refer to https://github.com/docker/libnetwork/issues/1926

ghost commented 7 years ago

Not fixed yet, see current README