New Charm: flannel-docker

Bug #1413776 reported by Charles Butler on 2015-01-22
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Juju Charms Collection
Charles Butler

Bug Description

I have written a new charm that I feel is a good submission for a reference charm utilizing flannel for the purpose of networking docker containers

What this charm provides:

A flannel runtime for X86 based hosts to establish private networking for cross-host container networking. This allows containers to be deployed in HA situations, as well as extending the 'farm' to run on multiple hosts, and communicate amongst themselves.

This charm has not been tested with any of the other docker charms, and has a hard dependency on the relationship structure of the proposed docker charm in bug# 1413775 - and that charm should be treated as a predependency to this merge.

The tests are scoped strictly to flannel, and it comes with full documentation on the development focus repository on Github here:

I look forward to any feedback you might have

Related branches

Review Queue (review-queue) wrote :

This items has failed automated testing! Results available here

Cory Johns (johnsca) wrote :


Thank you for this contribution, and this is an exciting step toward getting better Docker integration with Juju. I had a couple of minor notes, but overall this seems good (Amulet test passes, icon & README look good, etc). +1

* The lint check fails with: "ERROR: Unable to find an inventory file, specify one with -i ?" This is reminiscent of an error I saw on the docker charm when using an out-dated Makefile, so I'm guessing there is a fix from there that needs to be applied here

* The Amulet tests contain `amulet.raise_status()` statements, which don't play well with the unittest.TestCase pattern. Those should be changed to `self.assertEqual()` or at least ``.

* The start hook symlink is missing, which could cause issues if a unit is restarted

Matt Bruzek (mbruzek) wrote :

I took a look at this charm as well and had the same error when running make lint. Looking at the Makefile, I see the lint target looking for the file docs/faux-inventory.conf but I see no file like that in the charm.

Both python tests also fail.


The test calls out a local:trusty/docker charm that was not on my system when I ran the tests. I would recommend changing the charm to deploy the personal namespaced charm cs:~lazypower/trusty/docker so the test can pass in automation.

The setUpClass method is decorated as a @classmethod, but uses an argument named "self". According to the docs ( a class method receives the class as the first argument. I would recommend renaming the variable "cls" to follow convention here. This may seem like a nit, but I recently discovered this difference when debugging a nasty error in the setUpClass() method of my own tests, and got better results when I realized the agument was *not* an instance of the class but the class object itself. I have also been writing this tests using the argument "self" incorrectly, so you might have seen one of my tests use it incorrectly.

# 99-autogen

This test also fails in bundletester and since you have a real test ( I would recommend removing the file. Before you delete the file please notice that the setUpClass method correctly uses the cls variable.

Let me know when you make the updates and I will be happy to review this charm again. Thanks!

Changed in charms:
status: New → In Progress
Changed in charms:
assignee: nobody → Charles Butler (lazypower)
Changed in charms:
status: In Progress → Fix Committed
Matt Bruzek (mbruzek) wrote :

I ran this branch in our automated testing infrastructure and the code passes for all environments!


Thanks for the work here Charles!

Charles Butler (lazypower) wrote :

a quick update note re: missing start hook

The start hook is actually a no-op in this case, as it has an upstart job that controls the flannel service. The missing start hook works as expected - flannel is only configured to become part of the system services after the network relationship is joined.

Good catch though!

Matt Bruzek (mbruzek) on 2015-04-02
Changed in charms:
status: Fix Committed → Fix Released
To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers