1
0
Fork 0
mirror of https://github.com/moby/moby.git synced 2022-11-09 12:21:53 -05:00
moby--moby/libnetwork
Alessandro Boch 1e91009978 Network and Endpoint query methods to return error on not found
- As requested by Docker committers

Signed-off-by: Alessandro Boch <aboch@docker.com>
2015-05-15 16:18:04 -07:00
..
api Network and Endpoint query methods to return error on not found 2015-05-15 16:18:04 -07:00
client Fixed an intermittent issue in the libnetwork test 2015-05-13 00:22:00 +00:00
cmd Make driver packages register themselves via DriverCallback 2015-05-11 19:00:06 +01:00
docs Make driver packages register themselves via DriverCallback 2015-05-11 19:00:06 +01:00
driverapi Fixed some convoluted texts in remote.md and fixed a remote driver bug 2015-05-07 11:55:46 -07:00
drivers Fix issue in ipv6 when a non-default link-local ipv6 address is present. 2015-05-12 23:43:06 +00:00
Godeps Initial libnetwork rest api 2015-05-14 12:18:44 -07:00
ipallocator Simplify the code in the RegisterSubnet method of ipallocator. 2015-05-12 00:44:34 +00:00
netutils Fixed an intermittent issue in the libnetwork test 2015-05-13 00:22:00 +00:00
pkg Changed portallocator New() method to Get() 2015-05-14 21:59:17 +00:00
portmapper Changed portallocator New() method to Get() 2015-05-14 21:59:17 +00:00
sandbox Make endpoint Join and Leave multi-thread safe 2015-05-10 17:36:04 +00:00
test/integration Initial bats based integration tests for testing daemon network configs 2015-04-25 07:33:48 -07:00
types Refactor driverapi, sandbox pkgs 2015-04-21 09:44:39 -07:00
.gitignore Create a build image to avoid install-deps every time 2015-05-11 21:17:12 +01:00
circle.yml Report Code Coverage and Add Status Badges 2015-04-14 16:19:55 +01:00
controller.go Network and Endpoint query methods to return error on not found 2015-05-15 16:18:04 -07:00
drivers.go Make driver packages register themselves via DriverCallback 2015-05-11 19:00:06 +01:00
endpoint.go Fix DNS entry update issue 2015-05-15 21:01:53 +00:00
error.go Network and Endpoint query methods to return error on not found 2015-05-15 16:18:04 -07:00
libnetwork_internal_test.go Make driver packages register themselves via DriverCallback 2015-05-11 19:00:06 +01:00
libnetwork_test.go Network and Endpoint query methods to return error on not found 2015-05-15 16:18:04 -07:00
LICENSE Initial commit 2015-02-19 17:20:15 -08:00
MAINTAINERS Add MAINTAINERS 2015-04-01 14:43:06 +01:00
Makefile Fixed an intermittent issue in the libnetwork test 2015-05-13 00:22:00 +00:00
network.go Network and Endpoint query methods to return error on not found 2015-05-15 16:18:04 -07:00
README.md Updated Design Document 2015-05-06 13:38:16 -07:00
ROADMAP.md Updated Design Document 2015-05-06 13:38:16 -07:00
system.go Remove golint warnings 2015-03-04 13:29:28 -08:00

libnetwork - networking for containers

Circle CI Coverage Status GoDoc

Libnetwork provides a native Go implementation for connecting containers

The goal of libnetwork is to deliver a robust Container Network Model that provides a consistent programming interface and the required network abstractions for applications.

NOTE: libnetwork project is under heavy development and is not ready for general use.

Design

Please refer to the design for more information.

Using libnetwork

There are many networking solutions available to suit a broad range of use-cases. libnetwork uses a driver / plugin model to support all of these solutions while abstracting the complexity of the driver implementations by exposing a simple and consistent Network Model to users.

        // Create a new controller instance
        controller := libnetwork.New()

        // Select and configure the network driver
        networkType := "bridge"

        driverOptions := options.Generic{}
        genericOption := make(map[string]interface{})
        genericOption[netlabel.GenericData] = driverOptions
        err := controller.ConfigureNetworkDriver(networkType, genericOption)
        if err != nil {
                return
        }

        // Create a network for containers to join.
        // NewNetwork accepts Variadic optional arguments that libnetwork and Drivers can make of
        network, err := controller.NewNetwork(networkType, "network1")
        if err != nil {
                return
        }

        // For each new container: allocate IP and interfaces. The returned network
        // settings will be used for container infos (inspect and such), as well as
        // iptables rules for port publishing. This info is contained or accessible
        // from the returned endpoint.
        ep, err := network.CreateEndpoint("Endpoint1")
        if err != nil {
                return
        }

        // A container can join the endpoint by providing the container ID to the join
        // api which returns the sandbox key which can be used to access the sandbox
        // created for the container during join.
        // Join acceps Variadic arguments which will be made use of by libnetwork and Drivers
        _, err = ep.Join("container1",
                libnetwork.JoinOptionHostname("test"),
                libnetwork.JoinOptionDomainname("docker.io"))
        if err != nil {
                return
        }

		// libentwork client can check the endpoint's operational data via the Info() API
		epInfo, err := ep.Info()
		mapData, ok := epInfo[netlabel.PortMap]
		if ok {
			portMapping, ok := mapData.([]netutils.PortBinding)
			if ok {
				fmt.Printf("Current port mapping for endpoint %s: %v", ep.Name(), portMapping)
			}
		}

Current Status

Please watch this space for updates on the progress.

Currently libnetwork is nothing more than an attempt to modularize the Docker platform's networking subsystem by moving it into libnetwork as a library.

Future

Please refer to roadmap for more information.

Contributing

Want to hack on libnetwork? Docker's contributions guidelines apply.

Code and documentation copyright 2015 Docker, inc. Code released under the Apache 2.0 license. Docs released under Creative commons.