Autogenerate route names if host is not specified - second version with plugin based allocator support

pkg/cmd/server/origin/master.go

@@ -65,6 +65,7 @@ import (
 	clientauthorizationregistry "github.com/openshift/origin/pkg/oauth/registry/clientauthorization"
 	oauthetcd "github.com/openshift/origin/pkg/oauth/registry/etcd"
 	projectregistry "github.com/openshift/origin/pkg/project/registry/project"
+	routeallocationcontroller "github.com/openshift/origin/pkg/route/controller/allocation"
 	routeetcd "github.com/openshift/origin/pkg/route/registry/etcd"
 	routeregistry "github.com/openshift/origin/pkg/route/registry/route"
 	"github.com/openshift/origin/pkg/service"
@@ -85,12 +86,14 @@ import (
 	rolebindingregistry "github.com/openshift/origin/pkg/authorization/registry/rolebinding"
 	subjectaccessreviewregistry "github.com/openshift/origin/pkg/authorization/registry/subjectaccessreview"
 	"github.com/openshift/origin/pkg/cmd/server/bootstrappolicy"
+	routeplugin "github.com/openshift/origin/plugins/route/allocation/simple"
 )
 
 const (
 	OpenShiftAPIPrefix        = "/osapi"
 	OpenShiftAPIV1Beta1       = "v1beta1"
 	OpenShiftAPIPrefixV1Beta1 = OpenShiftAPIPrefix + "/" + OpenShiftAPIV1Beta1
+	OpenShiftRouteSubdomain   = "router.default.local"
 	swaggerAPIPrefix          = "/swaggerapi/"
 )
 
@@ -197,6 +200,7 @@ func (c *MasterConfig) InstallProtectedAPI(container *restful.Container) []strin
 	imageRepositoryMappingStorage := imagerepositorymapping.NewREST(imageRegistry, imageRepositoryRegistry)
 	imageRepositoryTagStorage := imagerepositorytag.NewREST(imageRegistry, imageRepositoryRegistry)
 	imageStreamImageStorage := imagestreamimage.NewREST(imageRegistry, imageRepositoryRegistry)
+	routeAllocator := c.RouteAllocator()
 
 	// TODO: with sharding, this needs to be changed
 	deployConfigGenerator := &deployconfiggenerator.DeploymentConfigGenerator{
@@ -238,7 +242,7 @@ func (c *MasterConfig) InstallProtectedAPI(container *restful.Container) []strin
 		"templateConfigs": templateregistry.NewREST(),
 		"templates":       templateetcd.NewREST(c.EtcdHelper),
 
-		"routes": routeregistry.NewREST(routeEtcd),
+		"routes": routeregistry.NewREST(routeEtcd, routeAllocator),
 
 		"projects": projectregistry.NewREST(kclient.Namespaces(), c.ProjectAuthorizationCache),
 
@@ -739,6 +743,26 @@ func (c *MasterConfig) RunDeploymentImageChangeTriggerController() {
 	controller.Run()
 }
 
+// RouteAllocator returns a route allocation controller.
+func (c *MasterConfig) RouteAllocator() *routeallocationcontroller.RouteAllocationController {
+	factory := routeallocationcontroller.RouteAllocationControllerFactory{
+		OSClient:   c.OSClient,
+		KubeClient: c.KubeClient(),
+	}
+
+	subdomain := os.Getenv("OPENSHIFT_ROUTE_SUBDOMAIN")
+	if len(subdomain) == 0 {
+		subdomain = OpenShiftRouteSubdomain
+	}
+
+	plugin, err := routeplugin.NewSimpleAllocationPlugin(subdomain)
+	if err != nil {
+		glog.Fatalf("Route plugin initialization failed: %v", err)
+	}
+
+	return factory.Create(plugin)
+}
+
 // ensureCORSAllowedOrigins takes a string list of origins and attempts to covert them to CORS origin
 // regexes, or exits if it cannot.
 func (c *MasterConfig) ensureCORSAllowedOrigins() []*regexp.Regexp {

pkg/route/api/types.go

@@ -30,6 +30,18 @@ type RouteList struct {
 	Items         []Route `json:"items"`
 }
 
+// RouterShard has information of a routing shard and is used to
+// generate host names and routing table entries when a routing shard is
+// allocated for a specific route.
+type RouterShard struct {
+	// Shard name uniquely identifies a router shard in the "set" of
+	// routers used for routing traffic to the services.
+	ShardName string
+
+	// The DNS suffix for the shard ala: shard-1.v3.openshift.com
+	DNSSuffix string
+}
+
 // TLSConfig defines config used to secure a route and provide termination
 type TLSConfig struct {
 	// Termination indicates termination type.  If termination type is not set, any termination config will be ignored

pkg/route/api/v1beta1/types.go

@@ -30,6 +30,20 @@ type RouteList struct {
 	Items         []Route `json:"items"`
 }
 
+// RouterShard has information of a routing shard and is used to
+// generate host names and routing table entries when a routing shard is
+// allocated for a specific route.
+// Caveat: This is WIP and will likely undergo modifications when sharding
+//         support is added.
+type RouterShard struct {
+	// Shard name uniquely identifies a router shard in the "set" of
+	// routers used for routing traffic to the services.
+	ShardName string `json:"shardName"`
+
+	// The DNS suffix for the shard ala: shard-1.v3.openshift.com
+	DNSSuffix string `json:"dnsSuffix"`
+}
+
 // TLSConfig defines config used to secure a route and provide termination
 type TLSConfig struct {
 	// Termination indicates termination type.  If termination type is not set, any termination config will be ignored

pkg/route/controller/allocation/controller.go

@@ -0,0 +1,46 @@
+package allocation
+
+import (
+	"github.com/golang/glog"
+
+	"github.com/openshift/origin/pkg/route"
+	routeapi "github.com/openshift/origin/pkg/route/api"
+)
+
+// RouteAllocationController abstracts the details of how routes are
+// allocated to router shards.
+type RouteAllocationController struct {
+	Plugin route.AllocationPlugin
+}
+
+// Allocate a router shard for the given route.
+func (c *RouteAllocationController) AllocateRouterShard(route *routeapi.Route) (*routeapi.RouterShard, error) {
+
+	glog.V(4).Infof("Allocating router shard for Route: %s [alias=%s]",
+		route.ServiceName, route.Host)
+
+	shard, err := c.Plugin.Allocate(route)
+
+	if err != nil {
+		glog.Errorf("unable to allocate router shard: %v", err)
+		return shard, err
+	}
+
+	glog.V(4).Infof("Route %s allocated to shard %s [suffix=%s]",
+		route.ServiceName, shard.ShardName, shard.DNSSuffix)
+
+	return shard, err
+}
+
+// Generate a host name for the given route and router shard combination.
+func (c *RouteAllocationController) GenerateHostname(route *routeapi.Route, shard *routeapi.RouterShard) string {
+	glog.V(4).Infof("Generating host name for Route: %s",
+		route.ServiceName)
+
+	s := c.Plugin.GenerateHostname(route, shard)
+
+	glog.V(4).Infof("Route: %s, generated host name/alias=%s",
+		route.ServiceName, s)
+
+	return s
+}

pkg/route/controller/allocation/controller_test.go

@@ -0,0 +1,87 @@
+package allocation
+
+import (
+	"fmt"
+	"testing"
+
+	kapi "github.com/GoogleCloudPlatform/kubernetes/pkg/api"
+	routeapi "github.com/openshift/origin/pkg/route/api"
+)
+
+type TestAllocationPlugin struct {
+	Name string
+}
+
+func (p *TestAllocationPlugin) Allocate(route *routeapi.Route) (*routeapi.RouterShard, error) {
+
+	return &routeapi.RouterShard{ShardName: "test", DNSSuffix: "openshift.test"}, nil
+}
+
+func (p *TestAllocationPlugin) GenerateHostname(route *routeapi.Route, shard *routeapi.RouterShard) string {
+	if len(route.ServiceName) > 0 && len(route.Namespace) > 0 {
+		return fmt.Sprintf("%s-%s.%s", route.ServiceName, route.Namespace, shard.DNSSuffix)
+	}
+
+	return "test-test-test.openshift.test"
+}
+
+func TestRouteAllocationController(t *testing.T) {
+	tests := []struct {
+		name  string
+		route *routeapi.Route
+	}{
+		{
+			name: "No Name",
+			route: &routeapi.Route{
+				ObjectMeta: kapi.ObjectMeta{
+					Namespace: "namespace",
+				},
+				ServiceName: "service",
+			},
+		},
+		{
+			name: "No namespace",
+			route: &routeapi.Route{
+				ObjectMeta: kapi.ObjectMeta{
+					Name: "name",
+				},
+				ServiceName: "nonamespace",
+			},
+		},
+		{
+			name: "No service name",
+			route: &routeapi.Route{
+				ObjectMeta: kapi.ObjectMeta{
+					Name:      "name",
+					Namespace: "foo",
+				},
+			},
+		},
+		{
+			name: "Valid route",
+			route: &routeapi.Route{
+				ObjectMeta: kapi.ObjectMeta{
+					Name:      "name",
+					Namespace: "foo",
+				},
+				Host:        "www.example.org",
+				ServiceName: "serviceName",
+			},
+		},
+	}
+
+	plugin := &TestAllocationPlugin{Name: "test allocation plugin"}
+	fac := &RouteAllocationControllerFactory{nil, nil}
+	allocator := fac.Create(plugin)
+	for _, tc := range tests {
+		shard, err := allocator.AllocateRouterShard(tc.route)
+		if err != nil {
+			t.Errorf("Test case %s got an error %s", tc.name, err)
+			continue
+		}
+		name := allocator.GenerateHostname(tc.route, shard)
+		if len(name) <= 0 {
+			t.Errorf("Test case %s got %d length name", tc.name, len(name))
+		}
+	}
+}

pkg/route/controller/allocation/doc.go

@@ -0,0 +1,2 @@
+// Package allocation contains all the route allocation controllers.
+package allocation

pkg/route/controller/allocation/factory.go

@@ -0,0 +1,23 @@
+package allocation
+
+import (
+	kclient "github.com/GoogleCloudPlatform/kubernetes/pkg/client"
+
+	osclient "github.com/openshift/origin/pkg/client"
+	"github.com/openshift/origin/pkg/route"
+)
+
+// RouteAllocationControllerFactory creates a RouteAllocationController
+// that allocates router shards to specific routes.
+type RouteAllocationControllerFactory struct {
+	// Client is is an OpenShift client.
+	OSClient osclient.Interface
+
+	// KubeClient is a Kubernetes client.
+	KubeClient kclient.Interface
+}
+
+// Create a RouteAllocationController instance.
+func (factory *RouteAllocationControllerFactory) Create(plugin route.AllocationPlugin) *RouteAllocationController {
+	return &RouteAllocationController{Plugin: plugin}
+}

pkg/route/controller/allocation/test/controller.go

@@ -0,0 +1,30 @@
+package test
+
+import (
+	"fmt"
+
+	routeapi "github.com/openshift/origin/pkg/route/api"
+	"github.com/openshift/origin/pkg/route/controller/allocation"
+)
+
+type TestAllocationPlugin struct {
+	Name string
+}
+
+func (p *TestAllocationPlugin) Allocate(route *routeapi.Route) (*routeapi.RouterShard, error) {
+
+	return &routeapi.RouterShard{ShardName: "test", DNSSuffix: "openshift.test"}, nil
+}
+
+func (p *TestAllocationPlugin) GenerateHostname(route *routeapi.Route, shard *routeapi.RouterShard) string {
+	if len(route.ServiceName) > 0 && len(route.Namespace) > 0 {
+		return fmt.Sprintf("%s-%s.%s", route.ServiceName, route.Namespace, shard.DNSSuffix)
+	}
+
+	return "test-test-test.openshift.test"
+}
+
+func NewTestRouteAllocationController() *allocation.RouteAllocationController {
+	plugin := &TestAllocationPlugin{"test route allocation plugin"}
+	return &allocation.RouteAllocationController{Plugin: plugin}
+}

pkg/route/controller/doc.go

@@ -0,0 +1,2 @@
+// Package controller contains all the route handling controllers.
+package controller

pkg/route/interfaces.go

@@ -0,0 +1,19 @@
+package route
+
+import (
+	api "github.com/openshift/origin/pkg/route/api"
+)
+
+// AllocationPlugin is the interface the route controller dispatches
+// requests for RouterShard allocation and name generation.
+type AllocationPlugin interface {
+	Allocate(*api.Route) (*api.RouterShard, error)
+	GenerateHostname(*api.Route, *api.RouterShard) string
+}
+
+// RouteAllocator is the interface for the route allocation controller
+// which handles requests for RouterShard allocation and name generation.
+type RouteAllocator interface {
+	AllocateRouterShard(*api.Route) (*api.RouterShard, error)
+	GenerateHostname(*api.Route, *api.RouterShard) string
+}

pkg/route/registry/route/rest.go

@@ -11,18 +11,21 @@ import (
 	"github.com/GoogleCloudPlatform/kubernetes/pkg/runtime"
 	"github.com/GoogleCloudPlatform/kubernetes/pkg/watch"
 
+	"github.com/openshift/origin/pkg/route"
 	"github.com/openshift/origin/pkg/route/api"
 	"github.com/openshift/origin/pkg/route/api/validation"
 )
 
 // REST is an implementation of RESTStorage for the api server.
 type REST struct {
-	registry Registry
+	registry  Registry
+	allocator route.RouteAllocator
 }
 
-func NewREST(registry Registry) *REST {
+func NewREST(registry Registry, allocator route.RouteAllocator) *REST {
 	return &REST{
-		registry: registry,
+		registry:  registry,
+		allocator: allocator,
 	}
 }
 
@@ -71,6 +74,15 @@ func (rs *REST) Create(ctx kapi.Context, obj runtime.Object) (runtime.Object, er
 		return nil, errors.NewConflict("route", route.Namespace, fmt.Errorf("Route.Namespace does not match the provided context"))
 	}
 
+	shard, err := rs.allocator.AllocateRouterShard(route)
+	if err != nil {
+		return nil, fmt.Errorf("allocation error: %s for route: %#v", err, obj)
+	}
+
+	if len(route.Host) == 0 {
+		route.Host = rs.allocator.GenerateHostname(route, shard)
+	}
+
 	if errs := validation.ValidateRoute(route); len(errs) > 0 {
 		return nil, errors.NewInvalid("route", route.Name, errs)
 	}
@@ -82,7 +94,7 @@ func (rs *REST) Create(ctx kapi.Context, obj runtime.Object) (runtime.Object, er
 
 	escapeNewLines(route.TLS)
 
-	err := rs.registry.CreateRoute(ctx, route)
+	err = rs.registry.CreateRoute(ctx, route)
 	if err != nil {
 		return nil, err
 	}