Merge pull request #1187 from rudyfly/network-connect

feature: add network connect for container

Author: HusterWan

README.md

@@ -9,7 +9,6 @@
 
 ![pouchcontainer-logo-800](https://user-images.githubusercontent.com/6755791/39180769-55f3b742-47ea-11e8-8762-78aeedcbba78.png)
 
-
 ## Main Links
 
 - [Introduction](#introduction)

apis/server/network_bridge.go

@@ -77,6 +77,26 @@ func (s *Server) deleteNetwork(ctx context.Context, rw http.ResponseWriter, req
 	return nil
 }
 
+func (s *Server) connectToNetwork(ctx context.Context, rw http.ResponseWriter, req *http.Request) error {
+	networkIDOrName := mux.Vars(req)["id"]
+	connectConfig := &types.NetworkConnect{}
+
+	// decode request body
+	if err := json.NewDecoder(req.Body).Decode(connectConfig); err != nil {
+		return httputils.NewHTTPError(err, http.StatusBadRequest)
+	}
+	// validate request body
+	if err := connectConfig.Validate(strfmt.NewFormats()); err != nil {
+		return httputils.NewHTTPError(err, http.StatusBadRequest)
+	}
+
+	if err := s.ContainerMgr.Connect(ctx, connectConfig.Container, networkIDOrName, connectConfig.EndpointConfig); err != nil {
+		return err
+	}
+	rw.WriteHeader(http.StatusOK)
+	return nil
+}
+
 func (s *Server) disconnectNetwork(ctx context.Context, rw http.ResponseWriter, req *http.Request) error {
 	network := &types.NetworkDisconnect{}
 	// decode request body

apis/server/router.go

@@ -68,10 +68,12 @@ func initRoute(s *Server) http.Handler {
 	s.addRoute(r, http.MethodDelete, "/volumes/{name:.*}", s.removeVolume)
 
 	// network
+
 	s.addRoute(r, http.MethodGet, "/networks", s.listNetwork)
 	s.addRoute(r, http.MethodPost, "/networks/create", s.createNetwork)
 	s.addRoute(r, http.MethodGet, "/networks/{name:.*}", s.getNetwork)
 	s.addRoute(r, http.MethodDelete, "/networks/{name:.*}", s.deleteNetwork)
+	s.addRoute(r, http.MethodPost, "/networks/{id:.*}/connect", s.connectToNetwork)
 	s.addRoute(r, http.MethodPost, "/networks/{name:.*}/disconnect", s.disconnectNetwork)
 
 	// metrics

apis/swagger.yml

@@ -1086,6 +1086,40 @@ paths:
             $ref: "#/responses/500ErrorResponse"
         tags: ["Network"]
 
+  /networks/{id}/connect:
+    post:
+      summary: "Connect a container to a network"
+      operationId: "NetworkConnect"
+      consumes:
+        - "application/json"
+      responses:
+        200:
+          description: "No error"
+        400:
+          description: "bad parameter"
+          schema:
+            $ref: "#/definitions/Error"
+        404:
+          description: "Network or container not found"
+          schema:
+            $ref: "#/responses/404ErrorResponse"
+        500:
+          description: "Server error"
+          schema:
+            $ref: "#/responses/500ErrorResponse"
+      parameters:
+        - name: "id"
+          in: "path"
+          description: "Network ID or name"
+          required: true
+          type: "string"
+        - name: "container"
+          in: "body"
+          required: true
+          schema:
+            $ref: "#/definitions/NetworkConnect"
+      tags: ["Network"]
+
   /networks/{id}/disconnect:
     post:
       summary: "Disconnect a container from a network"
@@ -3135,6 +3169,16 @@ definitions:
       MaximumRetryCount:
         type: "integer"
 
+  NetworkConnect:
+    type: "object"
+    description: "contains the request for the remote API: POST /networks/{id:.*}/connect"
+    properties:
+      Container:
+        type: "string"
+        description: "The ID or name of the container to connect to the network."
+      EndpointConfig:
+        $ref: "#/definitions/EndpointSettings"
+
   NetworkCreateConfig:
     type: "object"
     description: "contains the request for the remote API: POST /networks/create"

apis/types/network_connect.go

@@ -41,6 +41,7 @@ func (n *NetworkCommand) Init(c *Cli) {
 	c.AddCommand(n, &NetworkRemoveCommand{})
 	c.AddCommand(n, &NetworkInspectCommand{})
 	c.AddCommand(n, &NetworkListCommand{})
+	c.AddCommand(n, &NetworkConnectCommand{})
 	c.AddCommand(n, &NetworkDisconnectCommand{})
 }
 
@@ -377,6 +378,91 @@ e495f50913   net1   bridge
 `
 }
 
+// networkConnectDescription is used to describe network connect command in detail and auto generate command doc.
+var networkConnectDescription = "Connect a container to a network in pouchd. " +
+	"It must specify network's name and container's name."
+
+// NetworkConnectCommand is used to implement 'network connect' command.
+type NetworkConnectCommand struct {
+	baseCommand
+
+	ipAddress    string
+	ipv6Address  string
+	links        []string
+	aliases      []string
+	linklocalips []string
+}
+
+// Init initializes NetworkConnectCommand command.
+func (n *NetworkConnectCommand) Init(c *Cli) {
+	n.cli = c
+
+	n.cmd = &cobra.Command{
+		Use:   "connect [OPTIONS] NETWORK CONTAINER",
+		Short: "Connect a container to a network",
+		Long:  networkConnectDescription,
+		Args:  cobra.ExactArgs(2),
+		RunE: func(cmd *cobra.Command, args []string) error {
+			return n.runNetworkConnect(args)
+		},
+		Example: networkConnectExample(),
+	}
+
+	n.addFlags()
+}
+
+// addFlags adds flags for specific command.
+func (n *NetworkConnectCommand) addFlags() {
+	flagSet := n.cmd.Flags()
+
+	flagSet.StringVar(&n.ipAddress, "ip", "", "IP Address")
+	flagSet.StringVar(&n.ipv6Address, "ip6", "", "IPv6 Address")
+	flagSet.StringSliceVar(&n.links, "link", []string{}, "Add link to another container")
+	flagSet.StringSliceVar(&n.aliases, "alias", []string{}, "Add network-scoped alias for the container")
+	flagSet.StringSliceVar(&n.linklocalips, "link-local-ip", []string{}, "Add a link-local address for the container")
+}
+
+// runNetworkConnect is the entry of NetworkConnectCommand command.
+func (n *NetworkConnectCommand) runNetworkConnect(args []string) error {
+	network := args[0]
+	container := args[1]
+	if network == "" {
+		return fmt.Errorf("network name cannot be empty")
+	}
+	if container == "" {
+		return fmt.Errorf("container name cannot be empty")
+	}
+
+	networkReq := &types.NetworkConnect{
+		Container: container,
+		EndpointConfig: &types.EndpointSettings{
+			IPAMConfig: &types.EndpointIPAMConfig{
+				IPV4Address:  n.ipAddress,
+				IPV6Address:  n.ipv6Address,
+				LinkLocalIps: n.linklocalips,
+			},
+			Links:   n.links,
+			Aliases: n.aliases,
+		},
+	}
+
+	ctx := context.Background()
+	apiClient := n.cli.Client()
+	err := apiClient.NetworkConnect(ctx, network, networkReq)
+	if err != nil {
+		return err
+	}
+	fmt.Printf("container %s is connected to network %s\n", container, network)
+
+	return nil
+}
+
+// networkConnectExample shows examples in network connect command, and is used in auto-generated cli docs.
+func networkConnectExample() string {
+	return `$ pouch network connect net1 container1
+container container1 is connected to network net1`
+}
+
 // networkDisconnectDescription is used to describe network disconnect command in detail and auto generate comand doc.
 var networkDisconnectDescription = "Disconnect a container from a network"
 

cli/network.go

@@ -70,5 +70,6 @@ type NetworkAPIClient interface {
 	NetworkRemove(ctx context.Context, networkID string) error
 	NetworkInspect(ctx context.Context, networkID string) (*types.NetworkInspectResp, error)
 	NetworkList(ctx context.Context) ([]types.NetworkResource, error)
+	NetworkConnect(ctx context.Context, network string, req *types.NetworkConnect) error
 	NetworkDisconnect(ctx context.Context, networkID, containerID string, force bool) error
 }

client/interface.go

@@ -0,0 +1,18 @@
+package client
+
+import (
+	"context"
+
+	"github.com/alibaba/pouch/apis/types"
+)
+
+// NetworkConnect connects a container to a network.
+func (client *APIClient) NetworkConnect(ctx context.Context, network string, req *types.NetworkConnect) error {
+	resp, err := client.post(ctx, "/networks/"+network+"/connect", nil, req, nil)
+	if err != nil {
+		return err
+	}
+
+	ensureCloseReader(resp)
+	return nil
+}