Expose the StaticRoutes API #63

jameinel · 2017-02-23T16:44:36Z

This implements support for listing StaticRoutes.
https://docs.ubuntu.com/maas/2.0/en/api#static-route

The only thing it supports is reading all of them. It doesn't support creating them, or reading just a single one of them. However, that's all we concretely need for Juju's use case. (MaaS doesn't let you look up static routes by source/destination subnets, etc. So we always have to read all of them and then find the ones we care about from there.)

This is necessary to implement Static Route support for containers in Juju:
https://bugs.launchpad.net/juju/+bug/1653708

Start by implementing Static Route handler in the test service, in preparation for updating the actual code base to interact with the test service.

Controller.StaticRoutes() now works, and we have some direct tests of parsing the values from a canned MAAS response, and a test service that can also be populated with routes.

reedobrien

Seems a lot of type checking in code rather than letting the compiler do it. Mostly nits and questions, but seems good to me.

I am not too familiar with maas api and it is >500 line change so you should get another +1.

Also there's no QA steps to verify.

reedobrien · 2017-02-23T17:38:03Z

interfaces.go

+	// Destination is the subnet that a machine wants to send packets to. We
+	// want to configure a route to that subnet via GatewayIP
+	Destination() Subnet
+	// GatewayIP is the IPAddress of the


reedobrien · 2017-02-23T17:38:25Z

interfaces.go

+	// inside Source should use GatewayIP to reach Destination addresses.)
+	Source() Subnet
+	// Destination is the subnet that a machine wants to send packets to. We
+	// want to configure a route to that subnet via GatewayIP


reedobrien · 2017-02-23T17:40:23Z

interfaces.go

+	// Metric is the routing metric that determines whether this route will
+	// take precedence over similar routes (there may be a route for 10/8, but
+	// also a more concrete route for 10.0/16 that should take precedence if it
+	// applies.) Metric should be a non-negative integer.


why isn't it a uint if it should not be negative?

IMO, 2 reasons

config.Schema doesn't support Uint

It allows you to have an "invalid" value inline. I don't know if that will actually be used, but "ID" is also actually a uint on the MAAS side, but is always presented as an 'int', so I followed suit.

reedobrien · 2017-02-23T17:45:49Z

interfaces.go

+	// want to configure a route to that subnet via GatewayIP
+	Destination() Subnet
+	// GatewayIP is the IPAddress of the
+	GatewayIP() string


why not a net.IPAddr? (after reading through I think I get why we arent' using net.IPAddr, net.IPNet, and friends.) Alas...

reedobrien · 2017-02-23T17:46:18Z

staticroute.go

+)
+
+type staticRoute struct {
+	// Add the controller in when we need to do things with the staticRoute.


Copied from Spaces, I can just remove it.

reedobrien · 2017-02-23T17:52:18Z

staticroute.go

+	if err != nil {
+		return nil, errors.Annotatef(err, "static-route base schema check failed")
+	}
+	valid := coerced.([]interface{})


So we convert []interface to a stringmap and then convert it back to []interface? If source is valid, why not just use it?

Coerce returns an interface{}, what we have is a list of interfaces []interface{}. We don't have a StringMap, because that's not how Golang works.

I see. My brain ignored the [] in the type assertion.

reedobrien · 2017-02-23T17:56:31Z

staticroute.go

+	return readStaticRouteList(valid, readFunc)
+}
+
+// readStaticRouteList expects the values of the sourceList to be string maps.


Again wondering why sourceList isn't a a slice of string maps (or an interface that has a StringMaps method which returns one). I'm sure for historical reasons.

reedobrien · 2017-02-23T18:04:31Z

staticroute.go

+	}
+	valid := coerced.(map[string]interface{})
+	// From here we know that the map returned from the schema coercion
+	// contains fields of the right type.


Smells like typechecking:)

so we have a "map[string]interface{}", but we know the type of all the contents that the schema has defined (valid["resource_uri"] must be a 'string' because it was defined in the schema, and Coerce would have given an error if it was the wrong type.)

reedobrien · 2017-02-23T18:17:35Z

testservice_staticroutes.go

+			err = json.NewEncoder(w).Encode(server.staticRoutes[ID])
+		}
+		checkError(err)
+	case "POST":


These imply there's something to test for PUT and POST. If there isn't they should prolly just be handled by default -- or be a TODO.

I was copying this, but I went ahead and put in at least http.StatusNotImplemented.

reedobrien · 2017-02-23T18:19:06Z

testservice_staticroutes.go

+	return postedStaticRoute
+}
+
+// NewStaticRoute creates a Static Route in the test server


jameinel

For the overall comments-

We are converting from a JSON string into a typed object. I believe we are choosing to do so via schema.Coerce instead of json.Unmarshal because Unmarshal is very loose in its interpretation of your content. I believe that schema.Coerce enforces that fields that are flagged as 'must be there' will cause an error if it isn't there, rather than silently using the zero value, etc.

At the very least, I wouldn't change the mechanism for deserializing json strings for one type vs using what all the other types did.

jameinel · 2017-02-23T19:00:18Z

interfaces.go

+	// inside Source should use GatewayIP to reach Destination addresses.)
+	Source() Subnet
+	// Destination is the subnet that a machine wants to send packets to. We
+	// want to configure a route to that subnet via GatewayIP


jameinel · 2017-02-23T19:00:39Z

interfaces.go

+	// Destination is the subnet that a machine wants to send packets to. We
+	// want to configure a route to that subnet via GatewayIP
+	Destination() Subnet
+	// GatewayIP is the IPAddress of the


jameinel · 2017-02-23T19:01:52Z

interfaces.go

+	// Metric is the routing metric that determines whether this route will
+	// take precedence over similar routes (there may be a route for 10/8, but
+	// also a more concrete route for 10.0/16 that should take precedence if it
+	// applies.) Metric should be a non-negative integer.


IMO, 2 reasons

config.Schema doesn't support Uint

It allows you to have an "invalid" value inline. I don't know if that will actually be used, but "ID" is also actually a uint on the MAAS side, but is always presented as an 'int', so I followed suit.

jameinel · 2017-02-23T19:02:06Z

staticroute.go

+)
+
+type staticRoute struct {
+	// Add the controller in when we need to do things with the staticRoute.


Copied from Spaces, I can just remove it.

jameinel · 2017-02-23T19:04:12Z

staticroute.go

+	checker := schema.List(schema.StringMap(schema.Any()))
+	coerced, err := checker.Coerce(source, nil)
+	if err != nil {
+		return nil, errors.Annotatef(err, "static-route base schema check failed")


This is checking that we have a list of objects (eg [{}, {}, {}], which is supposed to be true regardless of what version of the API we are talking to.

I think this was a deliberate choice from the people implementing the maas parser that you break apart parsing a list of objects into a top level 'parse it into a list' and then intermediate 'parse it into version-specific objects'.

jameinel · 2017-02-23T19:05:11Z

staticroute.go

+	if err != nil {
+		return nil, errors.Annotatef(err, "static-route base schema check failed")
+	}
+	valid := coerced.([]interface{})


Coerce returns an interface{}, what we have is a list of interfaces []interface{}. We don't have a StringMap, because that's not how Golang works.

jameinel · 2017-02-23T19:08:02Z

staticroute.go

+	}
+	valid := coerced.(map[string]interface{})
+	// From here we know that the map returned from the schema coercion
+	// contains fields of the right type.


so we have a "map[string]interface{}", but we know the type of all the contents that the schema has defined (valid["resource_uri"] must be a 'string' because it was defined in the schema, and Coerce would have given an error if it was the wrong type.)

jameinel · 2017-02-23T19:12:26Z

testservice_staticroutes.go

+			err = json.NewEncoder(w).Encode(server.staticRoutes[ID])
+		}
+		checkError(err)
+	case "POST":


I was copying this, but I went ahead and put in at least http.StatusNotImplemented.

jameinel · 2017-02-23T19:12:45Z

testservice_staticroutes.go

+	return postedStaticRoute
+}
+
+// NewStaticRoute creates a Static Route in the test server


howbazaar · 2017-02-27T04:15:11Z

staticroute.go

+		"source":       schema.StringMap(schema.Any()),
+		"destination":  schema.StringMap(schema.Any()),
+		"gateway_ip":   schema.String(),
+		"metric":       schema.ForceInt(),


There is a ForceUint now.

jameinel · 2017-02-27T07:49:45Z

$$merge$$

jujubot · 2017-02-27T07:50:05Z

Status: merge request accepted. Url: http://juju-ci.vapour.ws:8080/job/github-merge-juju-gomaasapi

2.1.1 static routes for containers ## Description of change This change allows Juju to propagate Static Route information that MAAS declares into containers. It depends on this patch to gomaasapi: juju/gomaasapi#63. (I updated dependencies.tsv for my version of the code, but we should update dependencies to match the final merge.) The other changes to dependencies.tsv are just reordering because of how the file was generated. We use the Static Routes API https://docs.ubuntu.com/maas/2.0/en/api#static-route to find what routes are needed, and apply them based on their Source subnet. We add a post-up and a pre-down rule that uses 'ip route add'. This differs slightly from MAAS and Curtin that use "route add", but it means we can use CIDR instead of netmask. http://bazaar.launchpad.net/~curtin-dev/curtin/trunk/view/head:/curtin/net/__init__.py#L380 ## QA steps Using MAAS create a static route for one of your subnets (you can do so via the web ui by looking at the source subnet). You'll need to create destination subnets for it to route to. Afterwards, deploy a node, and you should see that "ip route show" lists that static route. You should then be able to deploy a container onto that machine using the same space. It should have the same route. Without this patch (stock juju 2.1.0) it should not. ## Documentation changes Potentially we should document static routes with containers, but it feels a bit like people using static routes just expect it to work. ## Bug reference [lp:1653708](https://bugs.launchpad.net/juju/+bug/1653708)

jameinel added 3 commits February 23, 2017 19:11

Start working on StaticRoutes.

bdc9408

Start by implementing Static Route handler in the test service, in preparation for updating the actual code base to interact with the test service.

Finish wiring up all of the static route objects.

92b7ec2

Controller.StaticRoutes() now works, and we have some direct tests of parsing the values from a canned MAAS response, and a test service that can also be populated with routes.

go fmt

51e6b37

reedobrien approved these changes Feb 23, 2017

View reviewed changes

jameinel commented Feb 23, 2017

View reviewed changes

Review comments from Reed

9ea0710

jameinel mentioned this pull request Feb 24, 2017

2.1.1 static routes for containers juju/juju#7034

Merged

howbazaar approved these changes Feb 27, 2017

View reviewed changes

jujubot merged commit cfbc096 into juju:master Feb 27, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Expose the StaticRoutes API #63

Expose the StaticRoutes API #63

jameinel commented Feb 23, 2017 •

edited

Loading

reedobrien left a comment

reedobrien Feb 23, 2017

jameinel Feb 23, 2017

reedobrien Feb 23, 2017

jameinel Feb 23, 2017

reedobrien Feb 23, 2017

jameinel Feb 23, 2017

reedobrien Feb 23, 2017

reedobrien Feb 23, 2017

jameinel Feb 23, 2017

reedobrien Feb 23, 2017

jameinel Feb 23, 2017

reedobrien Feb 23, 2017

reedobrien Feb 23, 2017

reedobrien Feb 23, 2017

jameinel Feb 23, 2017

reedobrien Feb 23, 2017

jameinel Feb 23, 2017

reedobrien Feb 23, 2017

jameinel Feb 23, 2017

jameinel left a comment

jameinel Feb 23, 2017

jameinel Feb 23, 2017

jameinel Feb 23, 2017

jameinel Feb 23, 2017

jameinel Feb 23, 2017

jameinel Feb 23, 2017

jameinel Feb 23, 2017

jameinel Feb 23, 2017

jameinel Feb 23, 2017

howbazaar Feb 27, 2017

jameinel commented Feb 27, 2017

jujubot commented Feb 27, 2017

Expose the StaticRoutes API #63

Expose the StaticRoutes API #63

Conversation

jameinel commented Feb 23, 2017 • edited Loading

reedobrien left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jameinel left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jameinel commented Feb 27, 2017

jujubot commented Feb 27, 2017

jameinel commented Feb 23, 2017 •

edited

Loading