Commit Graph

23 Commits

Author SHA1 Message Date
Arko Dasgupta 14fbe41991 Update design.md
The roadmap document was outdated, and removed in #2316, so remove the link from here

Signed-off-by: Arko Dasgupta <arko.dasgupta@docker.com>
2020-02-18 17:21:39 -08:00
Euan Harris d297a25283 Merge pull request #1723 from sebradloff/patch-1
Change wording for Endpoint description
2019-06-25 15:09:04 +01:00
mrbeskin 1caeac8b64 clarifications and typo fixes for the design documentation
Signed-off-by: mrbeskin <mrbeskin@gmail.com>
2018-10-21 15:43:25 -05:00
Sebastian Radloff 95f6336157 Clarify endpoint definition in documentation.
Signed-off-by: Sebastian Radloff <sradloff23@gmail.com>
2017-04-22 09:51:02 -04:00
Sebastian Radloff e24adf94a1 Change wording for Endpoint description
I was reading over the description of the Endpoint and it struck me as a bit odd:
`An Endpoint can belong to *only one* network but may only belong to *one* Sandbox.`
I just wanted to rephrase it so that it's clear that an Endpoint has a one to one relationship with the Sandbox and a Network. If that is not the case, then I'm sorry for proposing the change. I'm only just starting to take a deeper dive into Docker networking.

Signed-off-by: Sebastian Radloff <sradloff23@gmail.com>
2017-04-17 10:14:49 -04:00
yuexiao-wang 807f14746d Modify the serial number from 1 to 9
Signed-off-by: yuexiao-wang <wang.yuexiao@zte.com.cn>
2016-10-31 18:28:37 +08:00
Lee Calcote 5c5a43124a design.md: fixed anchor reference
The #Drivers reference needed to be #drivers in order for the anchor to work correctly.

Signed-off-by: Lee Calcote <leecalcote@gmail.com>
2016-06-14 06:30:03 -05:00
allencloud de588f950d fix typos
Signed-off-by: allencloud <allen.sun@daocloud.io>
2016-05-30 18:20:52 +08:00
Darren Stahl 70be85fa40 Change 'an user' to 'a user'
Signed-off-by: Darren Stahl <darst@microsoft.com>
2016-03-22 17:01:26 -07:00
Zach a87a58e2be Changing image file-path in design doc 2015-12-01 18:56:49 -08:00
zachgersh 1d88c10f98 Adds cnm directly to repo 2015-12-01 18:56:49 -08:00
Zach 20e5a0503a Add nice image illustrating CNM
Figured it would be nice to include the visual aid for anyone who wants to refer back it.
2015-12-01 18:56:49 -08:00
Jana Radhakrishnan a5bd12b963 Remove multiple interface in an endpoint
Currently the endpoint data model consists of multiple
interfaces per-endpoint. This seems to be an overkill
since there is no real use case for it. Removing it
to remove unnecessary complexity from the code.

Signed-off-by: Jana Radhakrishnan <mrjana@docker.com>
2015-09-11 09:19:01 -07:00
Alex Chan 2e64ce637b Minor spelling fixes in documentation and code comments 2015-06-26 11:02:54 +01:00
Michael Bridgen 991f50a10c Add note on EndpointInfo semantics
The comments in the code don't explain enough, and this is arguably a
better place for such an explanation.
2015-06-08 17:06:31 +01:00
Sotiris Salloumis 49f742eaff Orthographic corrections
Signed-off-by: Sotiris Salloumis <sotiris.salloumis@gmail.com>

Added notes from dave-tucker

Signed-off-by: Sotiris Salloumis <sotiris.salloumis@gmail.com>

Added Proofing design documentation input from dereckson

Signed-off-by: Sotiris Salloumis <sotiris.salloumis@gmail.com>
2015-05-22 20:19:34 +02:00
Madhu Venugopal c4ce3ac5ce Merge pull request #153 from nerdalert/brent-link-fix
fixing a link in design.md
2015-05-21 01:39:28 -07:00
Jana Radhakrishnan b323d571b5 Driver api refactor
Refactored the driver api so that is aligns well with the design
of endpoint lifecycle becoming decoupled from the container lifecycle.
Introduced go interfaces to obtain address information during CreateEndpoint.
Go interfaces are also used to get data from driver during join.
This sort of deisgn hides the libnetwork specific type details from drivers.

Another adjustment is to provide a list of interfaces during CreateEndpoint. The
goal of this is many-fold:
     * To indicate to the driver that IP address has been assigned by some other
       entity (like a user wanting to use their own static IP for an endpoint/container)
       and asking the driver to honor this. Driver may reject this configuration
       and return an error but it may not try to allocate an IP address and override
       the passed one.
     * To indicate to the driver that IP address has already been allocated once
       for this endpoint by an instance of the same driver in some docker host
       in the cluster and this is merely a notification about that endpoint and the
       allocated resources.
     * In case the list of interfaces is empty the driver is required to allocate and
       assign IP addresses for this endpoint.

Signed-off-by: Jana Radhakrishnan <mrjana@docker.com>
2015-05-18 22:36:00 +00:00
Brent Salisbury 7ae3e91c8d fixing a link in design.md
Signed-off-by: Brent Salisbury <brent.salisbury@docker.com>
2015-05-14 16:02:06 -04:00
Michael Bridgen 614d82390c Make driver packages register themselves via DriverCallback
In the present code, each driver package provides a `New()` method
which constructs a driver of its type, which is then registered with
the controller.

However, this is not suitable for the `drivers/remote` package, since
it does not provide a (singleton) driver, but a mechanism for drivers
to be added dynamically. As a result, the implementation is oddly
dual-purpose, and a spurious `"remote"` driver is added to the
controller's list of available drivers.

Instead, it is better to provide the registration callback to each
package and let it register its own driver or drivers. That way, the
singleton driver packages can construct one and register it, and the
remote package can hook the callback up with whatever the dynamic
driver mechanism turns out to be.

NB there are some method signature changes; in particular to
controller.New, which can return an error if the built-in driver
packages fail to initialise.

Signed-off-by: Michael Bridgen <mikeb@squaremobius.net>
2015-05-11 19:00:06 +01:00
unknown df3cde525a Small typo fixed
Signed-off-by: Kunal Kushwaha <kunal.kushwaha@gmail.com>
2015-05-07 11:11:34 +09:00
Madhu Venugopal 142825b2f3 Updated Design Document
Signed-off-by: Madhu Venugopal <madhu@docker.com>
2015-05-06 13:38:16 -07:00
Dave Tucker 4f7eb502bf Add design documentation
This is an intial pass at the design docs.
Hopefully, we can merge this and then start accepting PRs to improve it!

Signed-off-by: Dave Tucker <dt@docker.com>
2015-05-06 11:53:55 -07:00