1
0
Fork 0
mirror of https://github.com/moby/moby.git synced 2022-11-09 12:21:53 -05:00
moby--moby/libnetwork
Jana Radhakrishnan a9fa764cbb Move network types to types package
This is need to decouple types from netutils which has linux
dependencies. This way the client code which needs network types
can just pull in types package which makes client code platform
agnostic.

Signed-off-by: Jana Radhakrishnan <mrjana@docker.com>
2015-05-20 20:28:46 +00:00
..
api Move network types to types package 2015-05-20 20:28:46 +00:00
client Client to make use of REST API 2015-05-19 14:10:30 -07:00
cmd Move network types to types package 2015-05-20 20:28:46 +00:00
docs Driver api refactor 2015-05-18 22:36:00 +00:00
driverapi Driver api refactor 2015-05-18 22:36:00 +00:00
drivers Move network types to types package 2015-05-20 20:28:46 +00:00
etchosts Remove pkg directory 2015-05-16 16:12:13 -07:00
Godeps Godep update to pull in parsers and term packages 2015-05-19 14:10:30 -07:00
ipallocator Simplify the code in the RegisterSubnet method of ipallocator. 2015-05-12 00:44:34 +00:00
iptables Porting https://github.com/docker/docker/pull/12437 2015-05-19 15:28:48 -07:00
netlabel Remove pkg directory 2015-05-16 16:12:13 -07:00
netutils Move network types to types package 2015-05-20 20:28:46 +00:00
options Remove pkg directory 2015-05-16 16:12:13 -07:00
portallocator Remove pkg directory 2015-05-16 16:12:13 -07:00
portmapper Optional Userland Proxy 2015-05-18 18:13:39 -07:00
resolvconf Remove pkg directory 2015-05-16 16:12:13 -07:00
sandbox Move network types to types package 2015-05-20 20:28:46 +00:00
test/integration Initial bats based integration tests for testing daemon network configs 2015-04-25 07:33:48 -07:00
types Move network types to types package 2015-05-20 20:28:46 +00: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 Fix panic on leave of host driver endpont leave 2015-05-19 17:14:00 +00:00
drivers.go Make driver packages register themselves via DriverCallback 2015-05-11 19:00:06 +01:00
endpoint.go Move network types to types package 2015-05-20 20:28:46 +00:00
endpoint_info.go Move network types to types package 2015-05-20 20:28:46 +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 Move network types to types package 2015-05-20 20:28:46 +00:00
LICENSE Initial commit 2015-02-19 17:20:15 -08:00
MAINTAINERS Add MAINTAINERS 2015-04-01 14:43:06 +01:00
Makefile Fix Makefile 2015-05-19 11:06:56 -07:00
network.go Driver api refactor 2015-05-18 22:36:00 +00:00
README.md Driver api refactor 2015-05-18 22:36:00 +00: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.DriverInfo()
		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.