docs for ingress; refactor for scope plugin lookups (#752)

Signed-off-by: David Chung <[email protected]>

Author: David Chung

docs/controller/ingress/README.md

@@ -43,7 +43,7 @@ metadata:
 # options block map to pkg/controller/ingress/types/Options
 options:
   # SyncInterval is how often to sync changes between the services and the LB
-  SyncInterval: 1s  # syntax is a string form of Go time.Duration
+  SyncInterval: 10s  # syntax is a string form of Go time.Duration
 
 # properties block map to pkg/controller/ingress/types/Properties
 properties:

docs/controller/ingress/example.yml

@@ -0,0 +1,83 @@
+#
+# Example Ingress YML that will sync services in Docker Swarm to the backend.
+# The backend is specified by the L4Plugin property.
+#
+# To run this:
+#
+# INFRAKIT_MANAGER_BACKEND=swarm infrakit plugin start manager simulator ingress
+#
+# In another console:
+# infrakit ingress controller commit -y path/to/this/file
+#
+# Creating Docker services
+# docker network create --driver overlay --ingress ingress
+# docker service create --network ingress --name t2 --publish 7777:80 nginx
+#
+# Verify that the route has been added in the simulator/lb1:
+# infrakit simulator/lb1 routes ls
+#
+# FRONTEND PORT    PROTOCOL   BACKEND PORT  CERT
+# 7777             TCP        7777  <-- from the swarm service
+# 80               http       8080  <-- from the static route in the config
+#
+# In Docker:
+#  docker service ls
+#ID                  NAME                MODE                REPLICAS            IMAGE               PORTS
+#m4fghruao79i        t2                  replicated          1/1                 nginx:latest        *:7777->80/tcp
+#
+# Remove the service
+# docker service rm t2
+#
+# infrakit simulator/lb1 routes ls  # should be empty
+#
+# FRONTEND PORT    PROTOCOL   BACKEND PORT  CERT
+# 80               http       8080  <-- from the static route
+#
+# Note that there are two loadbalancers configured in this example.  When you scale up / down the
+# shared group/workers, the backends of simulator/lb1 and simulator/lb2 should have the same backend nodes,
+# but the routes are different -- simulator/lb1 routes are driven by Docker swarm services, while the routes
+# for simulator/lb2 is static.
+#
+kind: ingress
+metadata:
+  name: test.com
+  tags:
+    project: testing
+    user: chungers
+
+# options block map to pkg/controller/ingress/types/Options
+options:
+  # SyncInterval is how often to sync changes between the services and the LB
+  SyncInterval: 10s  # syntax is a string form of Go time.Duration
+
+# properties block map to pkg/controller/ingress/types/Properties
+properties:
+  # Note that this section is missing a Vhost (so Vhost is '').  An empty Vhost entry will match all docker swarm
+  # services (since we have not defined the labeling convention for indicating the vhost of a service -- so all
+  # services match to ''.  This is in contrast to the Vhost of the next section, where we use a different vhost
+  # so that the routes for the L4 will not pick up those from Swarm services.
+  - Backends:
+      Groups:
+        - group/workers # This is a group at socket(group), groupID(workers).
+
+    # This is the plugin name of the L4 plugin. When you run `infrakit plugin start ... simulator`
+    # the default socket file name is 'simulator' and there's a default lb2 in the RPC object.
+    L4Plugin: simulator/lb1
+
+    # Plus all the services in Swarm that have --publish <frontend-port>:<container_port>
+    RouteSources:
+      swarm:
+        Host: unix:///var/run/docker.sock
+  - Vhost: system
+    Backends:
+      Groups:
+        - group/workers # This is a group at socket(group), groupID(workers).
+
+    L4Plugin: simulator/lb2
+
+    # Here we have a static route that is always present.
+    Routes:
+      - LoadBalancerPort: 80
+        LoadBalancerProtocol: https
+        Port: 8080
+        Protocol: http

docs/controller/ingress/example2.yml

@@ -0,0 +1,30 @@
+#
+#  A group of workers
+#
+#  Start up -- plugin start should include manager, vanilla, simulator, and group
+#  Then commit
+#
+#  infrakit group controller commit -y docs/controller/enrollment/group.yml
+#
+kind: group
+metadata:
+    name: workers
+properties:
+    Allocation:
+      Size: 5
+    Flavor:
+      Plugin: vanilla
+      Properties:
+        Attachments:
+          - ID: attachid
+            Type: attachtype
+        Init:
+          - docker pull nginx:alpine
+          - docker run -d -p 80:80 nginx-alpine
+        Tags:
+          project: infrakit
+          tier: web
+    Instance:
+      Plugin: simulator/compute
+      Properties:
+        Note: custom field

docs/controller/ingress/group.yml

@@ -3,10 +3,7 @@ package controller
 import (
 	"github.com/docker/infrakit/pkg/cli"
 	"github.com/docker/infrakit/pkg/controller"
-	"github.com/docker/infrakit/pkg/discovery"
 	logutil "github.com/docker/infrakit/pkg/log"
-	"github.com/docker/infrakit/pkg/plugin"
-	controller_rpc "github.com/docker/infrakit/pkg/rpc/controller"
 	"github.com/spf13/cobra"
 )
 
@@ -35,13 +32,3 @@ func Controller(name string, services *cli.Services) *cobra.Command {
 
 	return controller
 }
-
-// Load loads the typed object
-func Load(plugins discovery.Plugins, name string) (controller.Controller, error) {
-	pn := plugin.Name(name)
-	endpoint, err := plugins.Find(pn)
-	if err != nil {
-		return nil, err
-	}
-	return controller_rpc.NewClient(pn, endpoint.Address)
-}

pkg/cli/v0/controller/cmd.go

@@ -27,7 +27,7 @@ func Commit(name string, services *cli.Services) *cobra.Command {
 			os.Exit(1)
 		}
 
-		c, err := Load(services.Scope.Plugins(), name)
+		c, err := services.Scope.Controller(name)
 		if err != nil {
 			return nil
 		}

pkg/cli/v0/controller/commit.go

@@ -36,7 +36,7 @@ func Describe(name string, services *cli.Services) *cobra.Command {
 			}
 		}
 
-		controller, err := Load(services.Scope.Plugins(), name)
+		controller, err := services.Scope.Controller(name)
 		if err != nil {
 			return nil
 		}

pkg/cli/v0/controller/describe.go

@@ -30,7 +30,7 @@ func Backends(name string, services *cli.Services) *cobra.Command {
 				os.Exit(1)
 			}
 
-			l4, err := Load(services.Scope.Plugins(), name)
+			l4, err := services.Scope.L4(name)
 			if err != nil {
 				return nil
 			}
@@ -56,7 +56,7 @@ func Backends(name string, services *cli.Services) *cobra.Command {
 				os.Exit(1)
 			}
 
-			l4, err := Load(services.Scope.Plugins(), name)
+			l4, err := services.Scope.L4(name)
 			if err != nil {
 				return nil
 			}
@@ -81,7 +81,7 @@ func Backends(name string, services *cli.Services) *cobra.Command {
 			os.Exit(1)
 		}
 
-		l4, err := Load(services.Scope.Plugins(), name)
+		l4, err := services.Scope.L4(name)
 		if err != nil {
 			return nil
 		}

pkg/cli/v0/loadbalancer/backends.go

@@ -2,10 +2,7 @@ package loadbalancer
 
 import (
 	"github.com/docker/infrakit/pkg/cli"
-	"github.com/docker/infrakit/pkg/discovery"
 	logutil "github.com/docker/infrakit/pkg/log"
-	"github.com/docker/infrakit/pkg/plugin"
-	loadbalancer_rpc "github.com/docker/infrakit/pkg/rpc/loadbalancer"
 	"github.com/docker/infrakit/pkg/spi/loadbalancer"
 )
 
@@ -18,13 +15,3 @@ func init() {
 			Backends,
 		})
 }
-
-// Load loads the typed object
-func Load(plugins discovery.Plugins, name string) (loadbalancer.L4, error) {
-	pn := plugin.Name(name)
-	endpoint, err := plugins.Find(pn)
-	if err != nil {
-		return nil, err
-	}
-	return loadbalancer_rpc.NewClient(pn, endpoint.Address)
-}

pkg/cli/v0/loadbalancer/cmd.go

@@ -56,7 +56,7 @@ func Routes(name string, services *cli.Services) *cobra.Command {
 			return err
 		}
 
-		l4, err := Load(services.Scope.Plugins(), name)
+		l4, err := services.Scope.L4(name)
 		if err != nil {
 			return nil
 		}
@@ -84,7 +84,7 @@ func Routes(name string, services *cli.Services) *cobra.Command {
 			os.Exit(1)
 		}
 
-		l4, err := Load(services.Scope.Plugins(), name)
+		l4, err := services.Scope.L4(name)
 		if err != nil {
 			return nil
 		}
@@ -116,7 +116,7 @@ func Routes(name string, services *cli.Services) *cobra.Command {
 			os.Exit(1)
 		}
 
-		l4, err := Load(services.Scope.Plugins(), name)
+		l4, err := services.Scope.L4(name)
 		if err != nil {
 			return nil
 		}