Merge ~dmzoneill/charm-advanced-routing:dev/upgrade into ~dmzoneill/charm-advanced-routing:master

[David O Neill]

Upgraded to reactive and added static routing

 - Upgraded charm to reactive
 - Cleaned up old libraries
 - Add parser, extensibility to different routing, table, rule configuration options
 - Change to json blob in juju config item
 - Added multiple sanity checks and verification + better juju logging
 - Added functionality testing with libjuju

  expected config: based on example_config.yaml

  root@juju-720cde-24:/home/ubuntu# cat /etc/iproute2/rt_tables.d/juju-managed.conf
  100 SF1

  root@juju-720cde-24:/home/ubuntu# cat /usr/local/sbin/if-down/95-juju_routing
  # This file is managed by Juju.
  sudo ip rule del from 192.170.2.0/24 to 192.170.2.0/24 lookup SF1
  sudo ip route del 6.6.6.0/24 via 10.191.86.2
  sudo ip route del default via 10.191.86.2 table SF1 dev eth0
  sudo ip route flush table SF1
  sudo ip rule del table SF1
  sudo ip route flush cache

  root@juju-720cde-24:/home/ubuntu# cat /usr/local/sbin/if-up/95-juju_routing
  # This file is managed by Juju.
  sudo ip route flush cache
  # Table: name SF1
  sudo ip route replace default via 10.191.86.2 table SF1 dev eth0
  sudo ip route replace 6.6.6.0/24 via 10.191.86.2
  sudo ip rule add from 192.170.2.0/24 to 192.170.2.0/24 lookup SF1

[Drew Freiberger (afreiberger)]

See comments inline.

review: Needs Fixing

25b0cd4... by David O Neill on 2019-08-28

Fixes and improvements from review 371884 MR

https://code.launchpad.net/~dmzoneill/charm-advanced-routing/+git/charm-advanced-routing/+merge/371884

 * replaced format for all string formatting
 * replaced exits with raise exception
 * solved a bug of duplicate entries in ip/down script
 * numerous of code tidy ups and best practices
 * linted it
 * updates for unit and functional testing

[Drew Freiberger (afreiberger)]

Now that you're raising excceptions, you can catch them in the reactive state machine and set statuses based off of a try: setup: except: set_state(blocked, blocked due to error "foo" in setup

[Jeremy Lounder (jldev)]

This merge was already completed via an intermediary branch.

review: Approve

[Paul Goins (vultaire)]

The MR here is for merging into David's branch, however these commits are the exact same (hashes and all) as the first 2 commits in the central repo.

Unmerged commits

25b0cd4... by David O Neill on 2019-08-28

Fixes and improvements from review 371884 MR

https://code.launchpad.net/~dmzoneill/charm-advanced-routing/+git/charm-advanced-routing/+merge/371884

 * replaced format for all string formatting
 * replaced exits with raise exception
 * solved a bug of duplicate entries in ip/down script
 * numerous of code tidy ups and best practices
 * linted it
 * updates for unit and functional testing

2a2c57d... by David O Neill on 2019-08-26

Migrate from hooks to reactive based charm

Upgraded to reactive and added static routing

 - Upgraded charm to reactive
 - Cleaned up old libraries
 - Add parser, extensibility to different routing, table, rule configuration options
 - Change to json blob in juju config item
 - Added multiple sanity checks and verification + better juju logging
 - Added functionality testing with libjuju

  expected config: based on example_config.yaml

  root@juju-720cde-24:/home/ubuntu# cat /etc/iproute2/rt_tables.d/juju-managed.conf
  100 SF1

  root@juju-720cde-24:/home/ubuntu# cat /usr/local/sbin/if-down/95-juju_routing
  # This file is managed by Juju.
  sudo ip rule del from 192.170.2.0/24 to 192.170.2.0/24 lookup SF1
  sudo ip route del 6.6.6.0/24 via 10.191.86.2
  sudo ip route del default via 10.191.86.2 table SF1 dev eth0
  sudo ip route flush table SF1
  sudo ip rule del table SF1
  sudo ip route flush cache

  root@juju-720cde-24:/home/ubuntu# cat /usr/local/sbin/if-up/95-juju_routing
  # This file is managed by Juju.
  sudo ip route flush cache
  # Table: name SF1
  sudo ip route replace default via 10.191.86.2 table SF1 dev eth0
  sudo ip route replace 6.6.6.0/24 via 10.191.86.2
  sudo ip rule add from 192.170.2.0/24 to 192.170.2.0/24 lookup SF1

Co-authored-by: Diko Parvanov <email address hidden>

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..ebec07a
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,12 @@
+*.swp
+*~
+.idea
+.tox
+.vscode
+/builds/
+/deb_dist
+/dist
+/repo-info
+__pycache__
+
+
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..d645695
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..a8c1fd7
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,49 @@
+help:
+	@echo "This project supports the following targets"
+	@echo ""
+	@echo " make help - show this text"
+	@echo " make submodules - make sure that the submodules are up-to-date"
+	@echo " make lint - run flake8"
+	@echo " make test - run the unittests and lint"
+	@echo " make unittest - run the tests defined in the unittest subdirectory"
+	@echo " make functional - run the tests defined in the functional subdirectory"
+	@echo " make release - build the charm"
+	@echo " make clean - remove unneeded files"
+	@echo ""
+
+submodules:
+	@echo "Cloning submodules"
+	@git submodule update --init --recursive
+
+lint:
+	@echo "Running flake8"
+	@tox -e lint
+
+test: unittest functional lint
+
+unittest:
+	@tox -e unit
+
+functional: build
+	@PYTEST_KEEP_MODEL=$(PYTEST_KEEP_MODEL) \
+	    PYTEST_CLOUD_NAME=$(PYTEST_CLOUD_NAME) \
+	    PYTEST_CLOUD_REGION=$(PYTEST_CLOUD_REGION) \
+	    tox -e functional
+
+build:
+	@echo "Building charm to base directory $(JUJU_REPOSITORY)"
+	@-git describe --tags > ./repo-info
+	@LAYER_PATH=./layers INTERFACE_PATH=./interfaces TERM=linux \
+		JUJU_REPOSITORY=$(JUJU_REPOSITORY) charm build . --force
+
+release: clean build
+	@echo "Charm is built at $(JUJU_REPOSITORY)/builds"
+
+clean:
+	@echo "Cleaning files"
+	@if [ -d .tox ] ; then rm -r .tox ; fi
+	@if [ -d .pytest_cache ] ; then rm -r .pytest_cache ; fi
+	@find . -iname __pycache__ -exec rm -r {} +
+
+# The targets below don't depend on a file
+.PHONY: lint test unittest functional build release clean help submodules
diff --git a/README b/README
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/README
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f03175f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,49 @@
+# Overview
+
+This subordinate charm allows for the configuration of simple policy routing rules on the deployed host
+and adding routing to configured services via a JSON.
+
+# Usage
+
+
+# Build
+```
+cd charm-advanced-routing
+make build
+```
+
+# Usage
+Add to an existing application using juju-info relation.
+
+Example:
+```
+juju deploy cs:~canonical-bootstack/routing
+juju add-relation ubuntu advanced-routing
+```
+
+# Configuration                                                                 
+The user can configure the following parameters:
+* enable-advanced-routing: Enable routing. This requires for the charm to have JSON with routing information configured: ```juju config advanced-routing --file path/to/your/config```
+
+A example_config.json file is provided with the codebase.
+
+# Testing                                                                       
+To run lint tests:
+```bash
+tox -e lint
+
+```
+To run unit tests:
+```bash
+tox -e unit
+```
+Functional tests have been developed using python-libjuju, deploying a simple ubuntu charm and adding the charm as a subordinate.
+
+To run tests using python-libjuju:
+```bash
+tox -e functional
+```
+
+# Contact Information
+David O Neill <[e-mail]>
+
diff --git a/config.yaml b/config.yaml
new file mode 100644
index 0000000..eb6c6de
--- /dev/null
+++ b/config.yaml
@@ -0,0 +1,17 @@
+options:
+  enable-advanced-routing:
+    type: boolean
+    default: False
+    description: |
+      Wheter to use the custom routing configuration provided by the charm.
+  advanced-routing-config:
+    type: string
+    default: ""
+    description: |
+      A json array consisting of objects, e.g.
+      [ {
+          "type": "route", 
+          "net": "192.170.1.0/24", 
+          "device": "eth5"
+      }, { ... } ]
+      @ see exmaple_config.yaml for more examples
\ No newline at end of file
diff --git a/example_config.yaml b/example_config.yaml
new file mode 100644
index 0000000..6785806
--- /dev/null
+++ b/example_config.yaml
@@ -0,0 +1,27 @@
+settings:
+  advanced-routing-config:
+    value: |-
+      [ {
+          "type": "table",
+          "table": "SF1"
+      }, {
+          "type": "route",
+          "default_route": true,  
+          "net": "192.170.1.0/24",
+          "gateway": "10.191.86.2",      
+          "table": "SF1",
+          "metric": 101,
+          "device": "eth0"
+      }, {
+          "type": "route",
+          "net": "6.6.6.0/24",
+          "gateway": "10.191.86.2"
+      }, {
+          "type": "rule",
+          "from-net": "192.170.2.0/24",
+          "to-net": "192.170.2.0/24",
+          "table": "SF1",
+          "priority": 101
+      } ]
+  enable-advanced-routing:
+    value: true
diff --git a/icon.svg b/icon.svg
new file mode 100644
index 0000000..e092eef
--- /dev/null
+++ b/icon.svg
@@ -0,0 +1,279 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+
+<svg
+   xmlns:dc="http://purl.org/dc/elements/1.1/"
+   xmlns:cc="http://creativecommons.org/ns#"
+   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+   xmlns:svg="http://www.w3.org/2000/svg"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:xlink="http://www.w3.org/1999/xlink"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   width="96"
+   height="96"
+   id="svg6517"
+   version="1.1"
+   inkscape:version="0.48+devel r12274"
+   sodipodi:docname="Juju_charm_icon_template.svg">
+  <defs
+     id="defs6519">
+    <linearGradient
+       inkscape:collect="always"
+       xlink:href="#Background"
+       id="linearGradient6461"
+       gradientUnits="userSpaceOnUse"
+       x1="0"
+       y1="970.29498"
+       x2="144"
+       y2="970.29498"
+       gradientTransform="matrix(0,-0.66666669,0.6660448,0,-866.25992,731.29077)" />
+    <linearGradient
+       id="Background">
+      <stop
+         id="stop4178"
+         offset="0"
+         style="stop-color:#b8b8b8;stop-opacity:1" />
+      <stop
+         id="stop4180"
+         offset="1"
+         style="stop-color:#c9c9c9;stop-opacity:1" />
+    </linearGradient>
+    <filter
+       style="color-interpolation-filters:sRGB;"
+       inkscape:label="Inner Shadow"
+       id="filter1121">
+      <feFlood
+         flood-opacity="0.59999999999999998"
+         flood-color="rgb(0,0,0)"
+         result="flood"
+         id="feFlood1123" />
+      <feComposite
+         in="flood"
+         in2="SourceGraphic"
+         operator="out"
+         result="composite1"
+         id="feComposite1125" />
+      <feGaussianBlur
+         in="composite1"
+         stdDeviation="1"
+         result="blur"
+         id="feGaussianBlur1127" />
+      <feOffset
+         dx="0"
+         dy="2"
+         result="offset"
+         id="feOffset1129" />
+      <feComposite
+         in="offset"
+         in2="SourceGraphic"
+         operator="atop"
+         result="composite2"
+         id="feComposite1131" />
+    </filter>
+    <filter
+       style="color-interpolation-filters:sRGB;"
+       inkscape:label="Drop Shadow"
+       id="filter950">
+      <feFlood
+         flood-opacity="0.25"
+         flood-color="rgb(0,0,0)"
+         result="flood"
+         id="feFlood952" />
+      <feComposite
+         in="flood"
+         in2="SourceGraphic"
+         operator="in"
+         result="composite1"
+         id="feComposite954" />
+      <feGaussianBlur
+         in="composite1"
+         stdDeviation="1"
+         result="blur"
+         id="feGaussianBlur956" />
+      <feOffset
+         dx="0"
+         dy="1"
+         result="offset"
+         id="feOffset958" />
+      <feComposite
+         in="SourceGraphic"
+         in2="offset"
+         operator="over"
+         result="composite2"
+         id="feComposite960" />
+    </filter>
+    <clipPath
+       clipPathUnits="userSpaceOnUse"
+       id="clipPath873">
+      <g
+         transform="matrix(0,-0.66666667,0.66604479,0,-258.25992,677.00001)"
+         id="g875"
+         inkscape:label="Layer 1"
+         style="fill:#ff00ff;fill-opacity:1;stroke:none;display:inline">
+        <path
+           style="fill:#ff00ff;fill-opacity:1;stroke:none;display:inline"
+           d="m 46.702703,898.22775 50.594594,0 C 138.16216,898.22775 144,904.06497 144,944.92583 l 0,50.73846 c 0,40.86071 -5.83784,46.69791 -46.702703,46.69791 l -50.594594,0 C 5.8378378,1042.3622 0,1036.525 0,995.66429 L 0,944.92583 C 0,904.06497 5.8378378,898.22775 46.702703,898.22775 Z"
+           id="path877"
+           inkscape:connector-curvature="0"
+           sodipodi:nodetypes="sssssssss" />
+      </g>
+    </clipPath>
+    <filter
+       inkscape:collect="always"
+       id="filter891"
+       inkscape:label="Badge Shadow">
+      <feGaussianBlur
+         inkscape:collect="always"
+         stdDeviation="0.71999962"
+         id="feGaussianBlur893" />
+    </filter>
+  </defs>
+  <sodipodi:namedview
+     id="base"
+     pagecolor="#ffffff"
+     bordercolor="#666666"
+     borderopacity="1.0"
+     inkscape:pageopacity="0.0"
+     inkscape:pageshadow="2"
+     inkscape:zoom="4.0745362"
+     inkscape:cx="18.514671"
+     inkscape:cy="49.018169"
+     inkscape:document-units="px"
+     inkscape:current-layer="layer1"
+     showgrid="true"
+     fit-margin-top="0"
+     fit-margin-left="0"
+     fit-margin-right="0"
+     fit-margin-bottom="0"
+     inkscape:window-width="1920"
+     inkscape:window-height="1029"
+     inkscape:window-x="0"
+     inkscape:window-y="24"
+     inkscape:window-maximized="1"
+     showborder="true"
+     showguides="true"
+     inkscape:guide-bbox="true"
+     inkscape:showpageshadow="false">
+    <inkscape:grid
+       type="xygrid"
+       id="grid821" />
+    <sodipodi:guide
+       orientation="1,0"
+       position="16,48"
+       id="guide823" />
+    <sodipodi:guide
+       orientation="0,1"
+       position="64,80"
+       id="guide825" />
+    <sodipodi:guide
+       orientation="1,0"
+       position="80,40"
+       id="guide827" />
+    <sodipodi:guide
+       orientation="0,1"
+       position="64,16"
+       id="guide829" />
+  </sodipodi:namedview>
+  <metadata
+     id="metadata6522">
+    <rdf:RDF>
+      <cc:Work
+         rdf:about="">
+        <dc:format>image/svg+xml</dc:format>
+        <dc:type
+           rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
+        <dc:title></dc:title>
+      </cc:Work>
+    </rdf:RDF>
+  </metadata>
+  <g
+     inkscape:label="BACKGROUND"
+     inkscape:groupmode="layer"
+     id="layer1"
+     transform="translate(268,-635.29076)"
+     style="display:inline">
+    <path
+       style="fill:url(#linearGradient6461);fill-opacity:1;stroke:none;display:inline;filter:url(#filter1121)"
+       d="m -268,700.15563 0,-33.72973 c 0,-27.24324 3.88785,-31.13513 31.10302,-31.13513 l 33.79408,0 c 27.21507,0 31.1029,3.89189 31.1029,31.13513 l 0,33.72973 c 0,27.24325 -3.88783,31.13514 -31.1029,31.13514 l -33.79408,0 C -264.11215,731.29077 -268,727.39888 -268,700.15563 Z"
+       id="path6455"
+       inkscape:connector-curvature="0"
+       sodipodi:nodetypes="sssssssss" />
+  </g>
+  <g
+     inkscape:groupmode="layer"
+     id="layer3"
+     inkscape:label="PLACE YOUR PICTOGRAM HERE"
+     style="display:inline" />
+  <g
+     inkscape:groupmode="layer"
+     id="layer2"
+     inkscape:label="BADGE"
+     style="display:none"
+     sodipodi:insensitive="true">
+    <g
+       style="display:inline"
+       transform="translate(-340.00001,-581)"
+       id="g4394"
+       clip-path="none">
+      <g
+         id="g855">
+        <g
+           inkscape:groupmode="maskhelper"
+           id="g870"
+           clip-path="url(#clipPath873)"
+           style="opacity:0.6;filter:url(#filter891)">
+          <path
+             transform="matrix(1.4999992,0,0,1.4999992,-29.999795,-237.54282)"
+             d="m 264,552.36218 a 12,12 0 1 1 -24,0 A 12,12 0 1 1 264,552.36218 Z"
+             sodipodi:ry="12"
+             sodipodi:rx="12"
+             sodipodi:cy="552.36218"
+             sodipodi:cx="252"
+             id="path844"
+             style="color:#000000;fill:#000000;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:4;marker:none;visibility:visible;display:inline;overflow:visible;enable-background:accumulate"
+             sodipodi:type="arc" />
+        </g>
+        <g
+           id="g862">
+          <path
+             sodipodi:type="arc"
+             style="color:#000000;fill:#f5f5f5;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:4;marker:none;visibility:visible;display:inline;overflow:visible;enable-background:accumulate"
+             id="path4398"
+             sodipodi:cx="252"
+             sodipodi:cy="552.36218"
+             sodipodi:rx="12"
+             sodipodi:ry="12"
+             d="m 264,552.36218 a 12,12 0 1 1 -24,0 A 12,12 0 1 1 264,552.36218 Z"
+             transform="matrix(1.4999992,0,0,1.4999992,-29.999795,-238.54282)" />
+          <path
+             transform="matrix(1.25,0,0,1.25,33,-100.45273)"
+             d="m 264,552.36218 a 12,12 0 1 1 -24,0 A 12,12 0 1 1 264,552.36218 Z"
+             sodipodi:ry="12"
+             sodipodi:rx="12"
+             sodipodi:cy="552.36218"
+             sodipodi:cx="252"
+             id="path4400"
+             style="color:#000000;fill:#dd4814;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:4;marker:none;visibility:visible;display:inline;overflow:visible;enable-background:accumulate"
+             sodipodi:type="arc" />
+          <path
+             sodipodi:type="star"
+             style="color:#000000;fill:#f5f5f5;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:3;marker:none;visibility:visible;display:inline;overflow:visible;enable-background:accumulate"
+             id="path4459"
+             sodipodi:sides="5"
+             sodipodi:cx="666.19574"
+             sodipodi:cy="589.50385"
+             sodipodi:r1="7.2431178"
+             sodipodi:r2="4.3458705"
+             sodipodi:arg1="1.0471976"
+             sodipodi:arg2="1.6755161"
+             inkscape:flatsided="false"
+             inkscape:rounded="0.1"
+             inkscape:randomized="0"
+             d="m 669.8173,595.77657 c -0.39132,0.22593 -3.62645,-1.90343 -4.07583,-1.95066 -0.44938,-0.0472 -4.05653,1.36297 -4.39232,1.06062 -0.3358,-0.30235 0.68963,-4.03715 0.59569,-4.47913 -0.0939,-0.44198 -2.5498,-3.43681 -2.36602,-3.8496 0.18379,-0.41279 4.05267,-0.59166 4.44398,-0.81759 0.39132,-0.22593 2.48067,-3.48704 2.93005,-3.4398 0.44938,0.0472 1.81505,3.67147 2.15084,3.97382 0.3358,0.30236 4.08294,1.2817 4.17689,1.72369 0.0939,0.44198 -2.9309,2.86076 -3.11469,3.27355 C 669.9821,591.68426 670.20862,595.55064 669.8173,595.77657 Z"
+             transform="matrix(1.511423,-0.16366377,0.16366377,1.511423,-755.37346,-191.93651)" />
+        </g>
+      </g>
+    </g>
+  </g>
+</svg>
diff --git a/interfaces/.empty b/interfaces/.empty
new file mode 100644
index 0000000..792d600
--- /dev/null
+++ b/interfaces/.empty
@@ -0,0 +1 @@
+#
diff --git a/layer.yaml b/layer.yaml
new file mode 100644
index 0000000..3399b95
--- /dev/null
+++ b/layer.yaml
@@ -0,0 +1,2 @@
+includes:
+  - 'layer:basic'
diff --git a/layers/.empty b/layers/.empty
new file mode 100644
index 0000000..792d600
--- /dev/null
+++ b/layers/.empty
@@ -0,0 +1 @@
+#
diff --git a/lib/AdvancedRoutingHelper.py b/lib/AdvancedRoutingHelper.py
new file mode 100644
index 0000000..73526a5
--- /dev/null
+++ b/lib/AdvancedRoutingHelper.py
@@ -0,0 +1,132 @@
+"""Routing module."""
+import errno
+import os
+import subprocess
+
+from RoutingEntry import RoutingEntryType
+
+from RoutingValidator import RoutingConfigValidator
+
+from charmhelpers.core import hookenv
+from charmhelpers.core.host import (
+    CompareHostReleases,
+    lsb_release,
+)
+
+
+class AdvancedRoutingHelper:
+    """Helper class for routing."""
+
+    if_script = '95-juju_routing'
+    common_location = '/usr/local/sbin/'  # trailing slash
+    net_tools_up_path = '/etc/network/if-up.d/'  # trailing slash
+    net_tools_down_path = '/etc/network/if-down.d/'  # trailing slash
+    netplan_up_path = '/etc/networkd-dispatcher/routable.d/'  # trailing slash
+    netplan_down_path = '/etc/networkd-dispatcher/off.d/'  # trailing slash
+    policy_routing_service_path = '/etc/systemd/system/'  # trailing slash
+    ifup_path = None
+    ifdown_path = None
+
+    def __init__(self):
+        """Init function."""
+        hookenv.log('Init {}'.format(self.__class__.__name__), level=hookenv.INFO)
+        self.pre_setup()
+
+    def pre_setup(self):
+        """Create folder path for the ifup/down scripts."""
+        if not os.path.exists(self.common_location + 'if-up/'):
+            os.makedirs(self.common_location + 'if-up/')
+            hookenv.log('Created {}'.format(self.common_location + 'if-up/'), level=hookenv.INFO)
+        if not os.path.exists(self.common_location + 'if-down/'):
+            os.makedirs(self.common_location + 'if-down/')
+            hookenv.log('Created {}'.format(self.common_location + 'if-down/'), level=hookenv.INFO)
+
+        self.ifup_path = '{}if-up/{}'.format(self.common_location, self.if_script)
+        self.ifdown_path = '{}if-down/{}'.format(self.common_location, self.if_script)
+
+        # check for service file of charm-policy-routing, and block if its present
+        if os.path.exists(self.policy_routing_service_path + 'charm-pre-install-policy-routing.service'):
+            hookenv.log('It looks like charm-policy-routing is enabled. '
+                        ' charm-pre-install-policy-routing.service', 'WARNING')
+            hookenv.status_set('blocked', 'Please disable charm-policy-routing')
+            raise Exception('Please disable charm-policy-routing')
+
+    def post_setup(self):
+        """Symlinks the up/down scripts from the if.up/down or netplan scripts location."""
+        hookenv.log('Symlinking into distro specific network manager', level=hookenv.INFO)
+        release = lsb_release()['DISTRIB_CODENAME'].lower()
+        if CompareHostReleases(release) < "bionic":
+            self.symlink_force(self.ifup_path, '{}{}'.format(self.net_tools_up_path, self.if_script))
+            self.symlink_force(self.ifdown_path, '{}{}'.format(self.net_tools_down_path, self.if_script))
+        else:
+            self.symlink_force(self.ifup_path, '{}{}'.format(self.netplan_up_path, self.if_script))
+            self.symlink_force(self.ifdown_path, '{}{}'.format(self.netplan_down_path, self.if_script))
+
+    def setup(self):
+        """Modify the interfaces configurations."""
+        RoutingConfigValidator()
+
+        hookenv.log('Writing {}'.format(self.ifup_path), level=hookenv.INFO)
+        # Modify if-up.d
+        with open(self.ifup_path, 'w') as ifup:
+            ifup.write("# This file is managed by Juju.\n")
+            ifup.write("ip route flush cache\n")
+            for entry in RoutingEntryType.entries:
+                ifup.write(entry.addline)
+            os.chmod(self.ifup_path, 0o755)
+
+        hookenv.log('Writing {}'.format(self.ifdown_path), level=hookenv.INFO)
+        # Modify if-down.d
+        with open(self.ifdown_path, 'w') as ifdown:
+            ifdown.write("# This file is managed by Juju.\n")
+            for entry in list(reversed(RoutingEntryType.entries)):
+                ifdown.write(entry.removeline)
+            ifdown.write("ip route flush cache\n")
+            os.chmod(self.ifdown_path, 0o755)
+
+        self.post_setup()
+
+    def apply_routes(self):
+        """Apply the new routes to the system."""
+        hookenv.log('Applying routing rules', level=hookenv.INFO)
+        for entry in RoutingEntryType.entries:
+            entry.apply()
+
+    def remove_routes(self):
+        """Cleanup job."""
+        hookenv.log('Removing routing rules', level=hookenv.INFO)
+        if os.path.exists(self.ifdown_path):
+            try:
+                subprocess.check_call(["sh", "-c", self.ifdown_path], shell=True)
+            except subprocess.CalledProcessError:
+                # Either rules are removed or not valid
+                hookenv.log('ifdown script failed. Maybe rules are already gone?', 'WARNING')
+
+        # remove files
+        if os.path.exists(self.ifup_path):
+            os.remove(self.ifup_path)
+        if os.path.exists(self.ifdown_path):
+            os.remove(self.ifdown_path)
+
+        # remove symlinks
+        release = lsb_release()['DISTRIB_CODENAME'].lower()
+        try:
+            if CompareHostReleases(release) < "bionic":
+                os.remove('{}{}'.format(self.net_tools_up_path, self.if_script))
+                os.remove('{}{}'.format(self.net_tools_down_path, self.if_script))
+            else:
+                os.remove('{}{}'.format(self.netplan_up_path, self.if_script))
+                os.remove('{}{}'.format(self.netplan_down_path, self.if_script))
+        except Exception:
+            hookenv.log('Nothing to clean up', 'WARNING')
+
+    def symlink_force(self, target, link_name):
+        """Ensures accute symlink by removing any existing links."""
+        try:
+            os.symlink(target, link_name)
+        except OSError as e:
+            if e.errno == errno.EEXIST:
+                os.remove(link_name)
+                os.symlink(target, link_name)
+            else:
+                raise e
diff --git a/lib/RoutingEntry.py b/lib/RoutingEntry.py
new file mode 100644
index 0000000..a6d6ed8
--- /dev/null
+++ b/lib/RoutingEntry.py
@@ -0,0 +1,221 @@
+"""RoutingEntry Classes.
+
+This module contains the following abstract type and
+concrete implementations, thta model a routing table
+
+                       RoutingEntryType
+            ---------------------------------------
+           |                    |                  |
+     RoutingEntryTable  RoutingEntryRoute  RoutingEntryRule
+"""
+import subprocess
+
+from charmhelpers.core import hookenv
+
+
+class RoutingEntryType(object):
+    """Abstract type RoutingEntryType."""
+
+    entries = []  # static <RoutingEntryType>[]
+    config = None  # config entry
+
+    def __init__(self):
+        """Constructor."""
+        hookenv.log('Init {}'.format(self.__class__.__name__), level=hookenv.INFO)
+        pass
+
+    def exec_cmd(self, cmd, pipe=False):
+        """Runs a subprocess and returns True or False on success."""
+        try:
+            if pipe:
+                hookenv.log('Subprocess check shell: {} {}'.format(self.__class__.__name__, cmd), level=hookenv.INFO)
+                command = ' '.join(cmd)
+                ps = subprocess.Popen(command, shell=True, stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
+                ps.communicate()
+                return True if ps.returncode == 0 else False
+            else:
+                hookenv.log('Subprocess check: {} {}'.format(self.__class__.__name__, cmd), level=hookenv.INFO)
+                subprocess.check_call(cmd)
+                return True
+        except subprocess.CalledProcessError as error:
+            hookenv.log(error, level=hookenv.ERROR)
+            return False
+
+    @staticmethod
+    def add_rule(newrule):
+        """Due to config-change/install etc hooks etc.
+
+        The validator may be called multiple times
+        The static list will get duplicate items added
+        """
+        for rule in RoutingEntryType.entries:
+            if rule.addline == newrule.addline:
+                return
+        RoutingEntryType.entries.append(newrule)
+
+    def apply(self):
+        """Not implemented, should override in strategy."""
+        raise NotImplementedError
+
+    def create_line(self):
+        """Not implemented, should override in strategy."""
+        raise NotImplementedError
+
+    @property
+    def addline(self):
+        """Not implemented, should override in strategy."""
+        raise NotImplementedError
+
+    @property
+    def removeline(self):
+        """Not implemented, should override in strategy."""
+        raise NotImplementedError
+
+
+class RoutingEntryTable(RoutingEntryType):
+    """Concrete RoutingEntryType Strategy."""
+
+    table_name_file = '/etc/iproute2/rt_tables.d/juju-managed.conf'
+    table_index_counter = 100  # static
+    tables = []
+
+    def __init__(self, config):
+        """Adds unique tables to the tables list."""
+        hookenv.log('Created {}'.format(self.__class__.__name__), level=hookenv.INFO)
+        super().__init__()
+        self.config = config
+
+        if self.config['table'] not in RoutingEntryTable.tables:
+            RoutingEntryTable.tables.append(self.config['table'])
+
+    def create_line(self):
+        """Not implemented in this base class."""
+        raise NotImplementedError
+
+    def apply(self):
+        """Opens iproute tables and adds the known list of tables into this file."""
+        with open(RoutingEntryTable.table_name_file, 'w') as rt_table_file:
+            num = RoutingEntryTable.table_index_counter
+            for tbl in RoutingEntryTable.tables:
+                rt_table_file.write("{} {}\n".format(num, tbl))
+                num += 1
+
+    @property
+    def addline(self):
+        """Returns the add line for the ifup script."""
+        return "# Table: name {}\n".format(self.config['table'])
+
+    @property
+    def removeline(self):
+        """Returns the remove line for the ifdown script."""
+        line = "ip route flush table {}\n".format(self.config['table'])
+        line += "ip rule del table {}\n".format(self.config['table'])
+        return line
+
+
+class RoutingEntryRoute(RoutingEntryType):
+    """Concrete RoutingEntryType Strategy."""
+
+    def __init__(self, config):
+        """Nothing special in this constructor."""
+        hookenv.log('Created {}'.format(self.__class__.__name__), level=hookenv.INFO)
+        super().__init__()
+        self.config = config
+
+    def create_line(self):
+        """Creates and returns the command line for this rule object."""
+        cmd = ["ip", "route", "replace"]
+
+        # default route in table
+        if 'default_route' in self.config.keys():
+            cmd.append("default")
+            cmd.append("via")
+            cmd.append(self.config['gateway'])
+            cmd.append("table")
+            cmd.append(self.config['table'])
+            if 'device' in self.config.keys():
+                cmd.append("dev")
+                cmd.append(self.config['device'])
+        # route in any given table or none
+        else:
+            cmd.append(self.config['net'])
+            if 'gateway' in self.config.keys():
+                cmd.append("via")
+                cmd.append(self.config['gateway'])
+            if 'device' in self.config.keys():
+                cmd.append("dev")
+                cmd.append(self.config['device'])
+            if 'table' in self.config.keys():
+                cmd.append("table")
+                cmd.append(self.config['table'])
+            if 'metric' in self.config.keys():
+                cmd.append("metric")
+                cmd.append(str(self.config['metric']))
+
+        return cmd
+
+    def apply(self):
+        """Applies this rule object to the system."""
+        super().exec_cmd(self.create_line())
+
+    @property
+    def addline(self):
+        """Returns the add line for the ifup script."""
+        return ' '.join(self.create_line()) + "\n"
+
+    @property
+    def removeline(self):
+        """Returns the remove line for the ifdown script."""
+        return ' '.join(self.create_line()).replace(" replace ", " del ") + "\n"
+
+
+class RoutingEntryRule(RoutingEntryType):
+    """Concrete RoutingEntryType Strategy."""
+
+    def __init__(self, config):
+        """Nothing special in this constructor."""
+        hookenv.log('Created {}'.format(self.__class__.__name__), level=hookenv.INFO)
+        super().__init__()
+        self.config = config
+
+    def create_line(self):
+        """Creates and returns the command line for this rule object."""
+        cmd = ["ip", "rule", "add", "from", self.config['from-net']]
+
+        if 'to-net' in self.config.keys():
+            cmd.append("to")
+            cmd.append(self.config['to-net'])
+            cmd.append("lookup")
+            if 'table' in self.config.keys():
+                cmd.append(self.config['table'])
+            else:
+                cmd.append('main')
+        else:
+            if 'table' in self.config.keys():
+                cmd.append(self.config['table'])
+            if 'priority' in self.config.keys():
+                cmd.append(self.config['priority'])
+
+        return cmd
+
+    def apply(self):
+        """Applies this rule object to the system."""
+        if self.is_duplicate() is False:
+            # ip rule replace not supported, check for duplicates
+            super().exec_cmd(self.create_line())
+
+    @property
+    def addline(self):
+        """Returns the add line for the ifup script."""
+        return ' '.join(self.create_line()) + "\n"
+
+    @property
+    def removeline(self):
+        """Returns the remove line for the ifdown script."""
+        return ' '.join(self.create_line()).replace(" add ", " del ") + "\n"
+
+    def is_duplicate(self):
+        """Ip rule add does not prevent duplicates in older kernel versions."""
+        # https://patchwork.ozlabs.org/patch/624553/
+        parts = ' '.join(self.create_line()).split("add ")
+        return self.exec_cmd(["ip", "rule", "|", "grep", "\"" + parts[1] + "\""], pipe=True)
diff --git a/lib/RoutingValidator.py b/lib/RoutingValidator.py
new file mode 100644
index 0000000..24d780c
--- /dev/null
+++ b/lib/RoutingValidator.py
@@ -0,0 +1,182 @@
+"""RoutingValidator Class.
+
+Validates the entire json configuration constructing a model.
+"""
+import ipaddress
+import json
+import pprint
+import re
+import subprocess
+
+from RoutingEntry import (
+    RoutingEntryRoute,
+    RoutingEntryRule,
+    RoutingEntryTable,
+    RoutingEntryType,
+)
+
+from charmhelpers.core import hookenv
+
+
+class RoutingConfigValidator:
+    """Validates the enitre json configuration constructing model of rules."""
+
+    def __init__(self):
+        """Init function."""
+        hookenv.log('Init {}'.format(self.__class__.__name__), level=hookenv.INFO)
+
+        self.pattern = re.compile("^([a-zA-Z0-9-]+)$")
+        self.tables = []
+        self.config = self.read_configurations()
+        self.verify_config()
+
+    def read_configurations(self):
+        """Read and parse the JSON configuration file."""
+        json_decoded = []
+        conf = hookenv.config()
+
+        if conf['advanced-routing-config']:
+            try:
+                json_decoded = json.loads(conf['advanced-routing-config'])
+                hookenv.log('Read json config from juju config', level=hookenv.INFO)
+            except ValueError:
+                hookenv.status_set('blocked', 'JSON format invalid.')
+                raise Exception('JSON format invalid.')
+        else:
+            hookenv.status_set('blocked', 'JSON invalid or not set in charm config')
+            raise Exception('JSON format invalid.')
+        return json_decoded
+
+    def verify_config(self):
+        """Iterates the entries in the config checking each type for sanity."""
+        hookenv.log('Verifying json config', level=hookenv.INFO)
+        type_order = ['table', 'route', 'rule']
+
+        for entry_type in type_order:
+            # get all the tables together first, so that we can provide strict relations
+            for conf in self.config:
+                if 'type' not in conf:
+                    hookenv.status_set('blocked', 'Bad config: \'type\' not found in routing entry')
+                    hookenv.log('type not found in rule', level=hookenv.ERROR)
+                    raise Exception('type not found in rule')
+                if entry_type == "table" and entry_type == conf['type']:
+                    self.verify_table(conf)
+                if entry_type == "route" and entry_type == conf['type']:
+                    self.verify_route(conf)
+                if entry_type == "rule" and entry_type == conf['type']:
+                    self.verify_rule(conf)
+
+    def verify_table(self, conf):
+        """Verify rules."""
+        hookenv.log('Verifying table \n{}'.format(pprint.pformat(conf)), level=hookenv.INFO)
+        if 'table' not in conf:
+            hookenv.status_set('blocked', 'Bad network config: \'table\' missing in rule')
+            raise Exception('Bad network config: \'table\' missing in rule')
+
+        if self.pattern.match(conf['table']) is False:
+            hookenv.status_set('blocked', 'Bad network config: garbage table name in table [0-9a-zA-Z-]')
+            raise Exception('Bad network config: garbage table name in table [0-9a-zA-Z-]')
+
+        if conf['table'] in self.tables:
+            hookenv.status_set('blocked', 'Bad network config: duplicate table name')
+            raise Exception('Bad network config: duplicate table name')
+
+        self.tables.append(conf['table'])
+        RoutingEntryType.add_rule(RoutingEntryTable(conf))
+
+    def verify_route(self, conf):
+        """Verify routes."""
+        hookenv.log('Verifying route \n{}'.format(pprint.pformat(conf)), level=hookenv.INFO)
+        try:
+            ipaddress.ip_address(conf['gateway'])
+        except ValueError as error:
+            hookenv.log('Bad gateway IP: {} - {}'.format(conf['gateway'], error), level=hookenv.INFO)
+            hookenv.status_set('blocked', 'Bad gateway IP: {} - {}'.format(conf['gateway'], error))
+            raise Exception('Bad gateway IP: {} - {}'.format(conf['gateway'], error))
+
+        try:
+            ipaddress.ip_network(conf['net'])
+        except ValueError as error:
+            hookenv.log('Bad network config: {} - {}'.format(conf['net'], error), level=hookenv.INFO)
+            hookenv.status_set('blocked', 'Bad network config: {} - {}'.format(conf['net'], error))
+            raise Exception('Bad network config: {} - {}'.format(conf['net'], error))
+
+        if 'table' in conf:
+            if self.pattern.match(conf['table']) is False:
+                hookenv.log('Bad network config: garbage table name in rule [0-9a-zA-Z]', level=hookenv.INFO)
+                hookenv.status_set('blocked', 'Bad network config')
+                raise Exception('Bad network config: garbage table name in rule [0-9a-zA-Z]')
+            if conf['table'] not in self.tables:
+                hookenv.log('Bad network config: table reference not defined', level=hookenv.INFO)
+                hookenv.status_set('blocked', 'Bad network config')
+                raise Exception('Bad network config: table reference not defined')
+
+        if 'default_route' in conf:
+            if isinstance(conf['default_route'], bool):
+                hookenv.log('Bad network config: default_route should be bool', level=hookenv.INFO)
+                hookenv.status_set('blocked', 'Bad network config')
+                raise Exception('Bad network config: default_route should be bool')
+            if 'table' not in conf:
+                hookenv.log('Bad network config: replacing the default route in main table blocked', level=hookenv.INFO)
+                hookenv.status_set('blocked', 'Bad network config')
+                raise Exception('Bad network config: replacing the default route in main table blocked')
+
+        if 'device' in conf:
+            if self.pattern.match(conf['device']) is False:
+                hookenv.log('Bad network config: garbage device name in rule [0-9a-zA-Z-]', level=hookenv.INFO)
+                hookenv.status_set('blocked', 'Bad network config')
+                raise Exception('Bad network config: garbage device name in rule [0-9a-zA-Z-]')
+            try:
+                subprocess.check_call(["ip", "link", "show", conf['device']])
+            except subprocess.CalledProcessError as error:
+                hookenv.log('Device {} does not exist'.format(conf['device']), level=hookenv.INFO)
+                hookenv.status_set('blocked', 'Bad network config')
+                raise Exception('Device {} does not exist, {}'.format(conf['device'], error))
+
+        if 'metric' in conf:
+            try:
+                int(conf['metric'])
+            except ValueError:
+                hookenv.log('Bad network config: metric expected to be integer', level=hookenv.INFO)
+                hookenv.status_set('blocked', 'Bad network config')
+                raise Exception('Bad network config: metric expected to be integer')
+
+        RoutingEntryType.add_rule(RoutingEntryRoute(conf))
+
+    def verify_rule(self, conf):
+        """Verify rules."""
+        hookenv.log('Verifying rule \n{}'.format(pprint.pformat(conf)), level=hookenv.INFO)
+
+        try:
+            ipaddress.ip_network(conf['from-net'])
+        except ValueError as error:
+            hookenv.status_set('blocked', 'Bad network config: {} - {}'.format(conf['from-net'], error))
+            raise Exception('Bad network config: {} - {}'.format(conf['from-net'], error))
+
+        if 'to-net' in conf:
+            try:
+                ipaddress.ip_network(conf['to-net'])
+            except ValueError as error:
+                hookenv.status_set('blocked', 'Bad network config: {} - {}'.format(conf['to-net'], error))
+                raise Exception('Bad network config: {} - {}'.format(conf['to-net'], error))
+
+        if 'table' not in conf:
+            hookenv.status_set('blocked', 'Bad network config: \'table\' missing in rule')
+            raise Exception('Bad network config: \'table\' missing in rule')
+
+        if conf['table'] not in self.tables:
+            hookenv.status_set('blocked', 'Bad network config: table reference not defined')
+            raise Exception('Bad network config: table reference not defined')
+
+        if self.pattern.match(conf['table']) is False:
+            hookenv.status_set('blocked', 'Bad network config: garbage table name in rule [0-9a-zA-Z-]')
+            raise Exception('Bad network config: garbage table name in rule [0-9a-zA-Z-]')
+
+        if 'priority' in conf:
+            try:
+                int(conf['priority'])
+            except ValueError:
+                hookenv.status_set('blocked', 'Bad network config: priority expected to be integer')
+                raise Exception('Bad network config: priority expected to be integer')
+
+        RoutingEntryType.add_rule(RoutingEntryRule(conf))
diff --git a/metadata.yaml b/metadata.yaml
new file mode 100644
index 0000000..8984ae6
--- /dev/null
+++ b/metadata.yaml
@@ -0,0 +1,16 @@
+name: advanced-routing
+maintainer: David O Neill <[e-mail]>
+summary: Routing configuration editor
+description: |
+  This charm can be deployed alongside principle charms to enable custom
+  network routes management.
+subordinate: true
+series:
+  - xenial
+  - bionic
+tags:
+    - misc
+requires:
+  juju-info:
+    interface: juju-info
+    scope: container
diff --git a/reactive/advanced_routing.py b/reactive/advanced_routing.py
new file mode 100644
index 0000000..c1ddbb1
--- /dev/null
+++ b/reactive/advanced_routing.py
@@ -0,0 +1,56 @@
+"""Reactive charm hooks."""
+from charmhelpers.core.hookenv import (
+    Hooks,
+    config,
+    status_set,
+)
+
+from charms.reactive import (
+    hook,
+    set_flag,
+    when,
+    when_not,
+)
+
+from AdvancedRoutingHelper import AdvancedRoutingHelper
+
+hooks = Hooks()
+advanced_routing = AdvancedRoutingHelper()
+
+
+@when_not('advanced-routing.installed')
+def install_routing():
+    """Install the charm."""
+    if config('enable-advanced-routing'):
+        advanced_routing.setup()
+        advanced_routing.apply_routes()
+        set_flag('advanced-routing.installed')
+
+    status_set('active', 'Unit is ready.')
+
+
+@hook('upgrade-charm')
+def upgrade_charm():
+    """Handle resource-attach and config-changed events."""
+    if config('enable-advanced-routing'):
+        status_set('maintenance', 'Installing new static routes.')
+        advanced_routing.remove_routes()
+        advanced_routing.setup()
+        advanced_routing.apply_routes()
+
+    status_set('active', 'Unit is ready.')
+
+
+@when('config.changed.enable-advanced-routing')
+def reconfigure_routing():
+    """Handle routing configuration change."""
+    if config('enable-advanced-routing'):
+        status_set('maintenance', 'Installing routes.')
+        advanced_routing.remove_routes()
+        advanced_routing.setup()
+        advanced_routing.apply_routes()
+    else:
+        status_set('maintenance', 'Removing routes.')
+        advanced_routing.remove_routes()
+
+    status_set('active', 'Unit is ready.')
diff --git a/requirements.txt b/requirements.txt
new file mode 100644
index 0000000..6dae81c
--- /dev/null
+++ b/requirements.txt
@@ -0,0 +1,3 @@
+# Include python requirements here
+charmhelpers
+charms.reactive
\ No newline at end of file
diff --git a/revision b/revision
new file mode 100644
index 0000000..d00491f
--- /dev/null
+++ b/revision
@@ -0,0 +1 @@
+1
diff --git a/tests/bundles/bionic.yaml b/tests/bundles/bionic.yaml
new file mode 100644
index 0000000..65ab84b
--- /dev/null
+++ b/tests/bundles/bionic.yaml
@@ -0,0 +1,45 @@
+series: bionic
+description: "charm-advanced-routing test bundle"
+machines:
+  "0":
+    constraints: "arch=amd64"
+relations:
+  - - "testhost:juju-info"
+    - "charm-advanced-routing:juju-info"
+applications:
+  testhost:
+    charm: "ubuntu"
+    options:
+      hostname: "testhost"
+    num_units: 1
+    to:
+      - "0"
+  charm-advanced-routing:
+    charm: "../.."
+    series: bionic
+    num_units: 0
+    options:
+      advanced-routing-config: |-
+        [ {
+            "type": "table",
+            "table": "SF1"
+        }, {
+            "type": "route",
+            "default_route": true,  
+            "net": "192.170.1.0/24",
+            "gateway": "10.191.86.2",      
+            "table": "SF1",
+            "metric": 101,
+            "device": "eth0"
+        }, {
+            "type": "route",
+            "net": "6.6.6.0/24",
+            "gateway": "10.191.86.2"
+        }, {
+            "type": "rule",
+            "from-net": "192.170.2.0/24",
+            "to-net": "192.170.2.0/24",
+            "table": "SF1",
+            "priority": 101
+        } ]
+      enable-advanced-routing: true
diff --git a/tests/bundles/overlays/bionic.yaml.j2 b/tests/bundles/overlays/bionic.yaml.j2
new file mode 100644
index 0000000..5da69ca
--- /dev/null
+++ b/tests/bundles/overlays/bionic.yaml.j2
@@ -0,0 +1,2 @@
+applications:
+  {{ charm_name }}:
diff --git a/tests/functional/conftest.py b/tests/functional/conftest.py
new file mode 100644
index 0000000..1b22cb8
--- /dev/null
+++ b/tests/functional/conftest.py
@@ -0,0 +1,71 @@
+#!/usr/bin/python3
+"""
+Reusable pytest fixtures for functional testing.
+
+Environment variables
+---------------------
+
+test_preserve_model:
+if set, the testing model won't be torn down at the end of the testing session
+"""
+
+import asyncio
+import os
+import subprocess
+import uuid
+
+from juju.controller import Controller
+
+from juju_tools import JujuTools
+
+import pytest
+
+
[e-mail](scope='module')
+def event_loop():
+    """Override the default pytest event loop.
+
+    Do this too allow for fixtures using a broader scope.
+    """
+    loop = asyncio.get_event_loop_policy().new_event_loop()
+    asyncio.set_event_loop(loop)
+    loop.set_debug(True)
+    yield loop
+    loop.close()
+    asyncio.set_event_loop(None)
+
+
[e-mail](scope='module')
+async def controller():
+    """Connect to the current controller."""
+    _controller = Controller()
+    await _controller.connect_current()
+    yield _controller
+    await _controller.disconnect()
+
+
[e-mail](scope='module')
+async def model(controller):
+    """Live only for the duration of the test."""
+    model_name = "functest-{}".format(str(uuid.uuid4())[-12:])
+    _model = await controller.add_model(model_name,
+                                        cloud_name=os.getenv('PYTEST_CLOUD_NAME'),
+                                        region=os.getenv('PYTEST_CLOUD_REGION'),
+                                        )
+    # https://github.com/juju/python-libjuju/issues/267
+    subprocess.check_call(['juju', 'models'])
+    while model_name not in await controller.list_models():
+        await asyncio.sleep(1)
+    yield _model
+    await _model.disconnect()
+    if not os.getenv('PYTEST_KEEP_MODEL'):
+        await controller.destroy_model(model_name)
+        while model_name in await controller.list_models():
+            await asyncio.sleep(1)
+
+
[e-mail](scope='module')
+async def jujutools(controller, model):
+    """Juju tools."""
+    tools = JujuTools(controller, model)
+    return tools
diff --git a/tests/functional/juju_tools.py b/tests/functional/juju_tools.py
new file mode 100644
index 0000000..5e4a1cc
--- /dev/null
+++ b/tests/functional/juju_tools.py
@@ -0,0 +1,69 @@
+"""Juju tools."""
+import base64
+import pickle
+
+import juju
+
+# from juju.errors import JujuError
+
+
+class JujuTools:
+    """Juju tools."""
+
+    def __init__(self, controller, model):
+        """Init."""
+        self.controller = controller
+        self.model = model
+
+    async def run_command(self, cmd, target):
+        """Run a command on a unit.
+
+        :param cmd: Command to be run
+        :param unit: Unit object or unit name string
+        """
+        unit = (
+            target
+            if isinstance(target, juju.unit.Unit)
+            else await self.get_unit(target)
+        )
+        action = await unit.run(cmd)
+        return action.results
+
+    async def remote_object(self, imports, remote_cmd, target):
+        """Run command on target machine and returns a python object of the result.
+
+        :param imports: Imports needed for the command to run
+        :param remote_cmd: The python command to execute
+        :param target: Unit object or unit name string
+        """
+        python3 = "python3 -c '{}'"
+        python_cmd = ('import pickle;'
+                      'import base64;'
+                      '{}'
+                      'print(base64.b64encode(pickle.dumps({})), end="")'
+                      .format(imports, remote_cmd))
+        cmd = python3.format(python_cmd)
+        results = await self.run_command(cmd, target)
+        return pickle.loads(base64.b64decode(bytes(results['Stdout'][2:-1], 'utf8')))
+
+    async def file_stat(self, path, target):
+        """Run stat on a file.
+
+        :param path: File path
+        :param target: Unit object or unit name string
+        """
+        imports = 'import os;'
+        python_cmd = ('os.stat("{}")'
+                      .format(path))
+        print("Calling remote cmd: " + python_cmd)
+        return await self.remote_object(imports, python_cmd, target)
+
+    async def file_contents(self, path, target):
+        """Return the contents of a file.
+
+        :param path: File path
+        :param target: Unit object or unit name string
+        """
+        cmd = 'cat {}'.format(path)
+        result = await self.run_command(cmd, target)
+        return result['Stdout']
diff --git a/tests/functional/requirements.txt b/tests/functional/requirements.txt
new file mode 100644
index 0000000..f76bfbb
--- /dev/null
+++ b/tests/functional/requirements.txt
@@ -0,0 +1,6 @@
+flake8
+juju
+mock
+pytest
+pytest-asyncio
+requests
diff --git a/tests/functional/test_routing.py b/tests/functional/test_routing.py
new file mode 100644
index 0000000..96a0235
--- /dev/null
+++ b/tests/functional/test_routing.py
@@ -0,0 +1,54 @@
+#!/usr/bin/python3.6
+"""Main module for functional testing."""
+
+import os
+
+import pytest
+
+pytestmark = pytest.mark.asyncio
+SERIES = ['bionic', 'xenial']
+
+############
+# FIXTURES #
+############
+
+
[e-mail](scope='module', params=SERIES)
+async def deploy_app(request, model):
+    """Deploy the advanced-routing charm as a subordinate of ubuntu."""
+    release = request.param
+
+    await model.deploy(
+        'ubuntu',
+        application_name='ubuntu-' + release,
+        series=release,
+        channel='stable'
+    )
+    advanced_routing = await model.deploy(
+        '{}/builds/advanced-routing'.format(os.getenv('JUJU_REPOSITORY')),
+        application_name='advanced-routing-' + release,
+        series=release,
+        num_units=0,
+    )
+    await model.add_relation(
+        'ubuntu-' + release,
+        'advanced-routing-' + release
+    )
+
+    await model.block_until(lambda: advanced_routing.status == 'active')
+    yield advanced_routing
+
+
[e-mail](scope='module')
+async def unit(deploy_app):
+    """Return the advanced-routing unit we've deployed."""
+    return deploy_app.units.pop()
+
+#########
+# TESTS #
+#########
+
+
+async def test_deploy(deploy_app):
+    """Test the deployment."""
+    assert deploy_app.status == 'active'
diff --git a/tests/unit/conftest.py b/tests/unit/conftest.py
new file mode 100644
index 0000000..fbf31d7
--- /dev/null
+++ b/tests/unit/conftest.py
@@ -0,0 +1,80 @@
+#!/usr/bin/python3
+"""Configurations for tests."""
+import subprocess
+import unittest.mock as mock
+import pytest
+
+from charmhelpers.core.host import (
+    CompareHostReleases,
+    lsb_release,
+)
+
[e-mail]
+def mock_layers(monkeypatch):
+    """Layers mock."""
+    import sys
+    sys.modules['charms.layer'] = mock.Mock()
+    sys.modules['reactive'] = mock.Mock()
+
+    # Mock any functions in layers that need to be mocked here
+    def options(layer):
+        # mock options for layers here
+        if layer == 'example-layer':
+            options = {'port': 9999}
+            return options
+        else:
+            return None
+
+    monkeypatch.setattr('AdvancedRoutingHelper.layer.options', options)
+
+
[e-mail]
+def mock_hookenv_config(monkeypatch):
+    """Hookenv mock."""
+    import yaml
+
+    def mock_config():
+        cfg = {}
+        yml = yaml.load(open('./config.yaml'))
+
+        # Load all defaults
+        for key, value in yml['options'].items():
+            cfg[key] = value['default']
+
+        # Manually add cfg from other layers
+        # cfg['my-other-layer'] = 'mock'
+        return cfg
+
+    monkeypatch.setattr('AdvancedRoutingHelper.hookenv.config', mock_config)
+
+
[e-mail]
+def mock_remote_unit(monkeypatch):
+    """Remote unit mock."""
+    monkeypatch.setattr('AdvancedRoutingHelper.hookenv.remote_unit', lambda: 'unit-mock/0')
+
+
[e-mail]
+def mock_charm_dir(monkeypatch):
+    """Charm dir mock."""
+    monkeypatch.setattr('AdvancedRoutingHelper.hookenv.charm_dir', lambda: '/mock/charm/dir')
+
+
[e-mail]
+def advanced_routing_helper(tmpdir, mock_hookenv_config, mock_charm_dir, monkeypatch):
+    """Routing fixture."""
+    from AdvancedRoutingHelper import AdvancedRoutingHelper
+    helper = AdvancedRoutingHelper
+
+    monkeypatch.setattr('AdvancedRoutingHelper.AdvancedRoutingHelper', lambda: helper)
+
+    return helper
+
[e-mail]
+def mock_check_call(monkeypatch):
+    """Requests.get() mocked to return {'mock_key':'mock_response'}."""
+
+    def mock_get(*args, **kwargs):
+        return True
+
+    monkeypatch.setattr(subprocess, "check_call", mock_get)
\ No newline at end of file
diff --git a/tests/unit/requirements.txt b/tests/unit/requirements.txt
new file mode 100644
index 0000000..566d7c1
--- /dev/null
+++ b/tests/unit/requirements.txt
@@ -0,0 +1,8 @@
+# Include python requirements here
+charmhelpers
+charms.reactive
+mock
+pytest
+pytest-cov
+os-client-config
+os-testr>=0.4.1
\ No newline at end of file
diff --git a/tests/unit/test_AdvancedRoutingHelper.py b/tests/unit/test_AdvancedRoutingHelper.py
new file mode 100644
index 0000000..c24d1dc
--- /dev/null
+++ b/tests/unit/test_AdvancedRoutingHelper.py
@@ -0,0 +1,154 @@
+import os
+import pytest
+import shutil
+import subprocess
+
+from unittest import mock
+
+import RoutingValidator
+
+class TestAdvancedRoutingHelper():
+    """Main test class."""
+
+    test_dir = '/tmp/test/charm-advanced-routing/'  # trailing slash
+    test_ifup_path = test_dir + 'symlink_test/ifup/'
+    test_ifdown_path = test_dir + 'symlink_test/ifdown/'
+    test_netplanup_path = test_dir + 'symlink_test/netplanup/'
+    test_netplandown_path = test_dir + 'symlink_test/netplandown/'
+    test_script = 'test-script'
+
+    def setup_class(self):
+        try:
+            shutil.rmtree(self.test_dir)
+        except:
+            pass
+
+        os.makedirs(self.test_dir)
+        os.makedirs(self.test_ifdown_path)
+        os.makedirs(self.test_ifup_path)
+        os.makedirs(self.test_netplandown_path)
+        os.makedirs(self.test_netplanup_path)
+
+    def test_pytest(self, advanced_routing_helper):
+        """Simple pytest sanity test."""
+        assert True
+
+    def test_constructor(self, advanced_routing_helper):
+        """No test required"""
+        pass
+
+    def test_pre_setup(self, advanced_routing_helper):
+        """Test pre_setup"""
+
+        test_obj = advanced_routing_helper
+
+        test_obj.common_location = self.test_dir
+        test_obj.if_script = self.test_script
+        test_obj.policy_routing_service_path = self.test_dir
+
+        try:
+            os.remove(test_obj.policy_routing_service_path + 'charm-pre-install-policy-routing.service')
+        except:
+            pass
+
+        test_obj.pre_setup(test_obj)
+
+        uppath = test_obj.common_location + 'if-up/'
+        downpath = test_obj.common_location + 'if-down/'
+
+        assert os.path.exists(uppath)
+        assert os.path.exists(downpath)
+
+        assert test_obj.ifup_path == uppath + test_obj.if_script
+        assert test_obj.ifdown_path == downpath + test_obj.if_script
+
+        # touch file to cause the exception
+        try:
+            with open(test_obj.policy_routing_service_path + 'charm-pre-install-policy-routing.service', "w+") as f:
+                f.write('dont care\n')
+        except:
+            pass  # dont care
+
+        with pytest.raises(Exception):
+            test_obj.pre_setup(test_obj)
+
+    def test_post_setup(self, advanced_routing_helper):
+        """Test post_setup"""
+        #test_obj = advanced_routing_helper
+        assert True
+
+    def test_setup(self, advanced_routing_helper):
+        """Test setup"""
+
+        def noop():
+            pass
+
+        test_obj = advanced_routing_helper
+        test_obj.common_location = self.test_dir
+        test_obj.if_script = self.test_script
+        test_obj.ifup_path = '{}if-up/{}'.format(self.test_dir, self.test_script)
+        test_obj.ifdown_path = '{}if-down/{}'.format(self.test_dir, self.test_script)
+
+        test_obj.post_setup = noop
+        RoutingValidator.RoutingConfigValidator.__init__ = mock.Mock(return_value=None)
+        test_obj.setup(test_obj)
+
+        assert os.path.exists(test_obj.ifup_path)
+        assert os.path.exists(test_obj.ifdown_path)
+        
+        assert True
+
+    def test_apply_routes(self, advanced_routing_helper):
+        """Test post_setup"""
+        #test_obj = advanced_routing_helper
+        assert True
+
+    def test_remove_routes(self, advanced_routing_helper, mock_check_call):
+        """Test post_setup"""
+        test_obj = advanced_routing_helper
+
+        with mock.patch('charmhelpers.core.host.lsb_release') as lsbrelBionic:
+            test_obj.netplan_up_path = self.test_netplanup_path
+            test_obj.netplan_down_path = self.test_netplandown_path
+            lsbrelBionic.return_value = "bionic"
+            test_obj.remove_routes(test_obj)
+
+        with mock.patch('charmhelpers.core.host.lsb_release') as lsbrelArtful:
+            test_obj.net_tools_up_path = self.test_ifup_path
+            test_obj.net_tools_down_path = self.test_ifdown_path
+            lsbrelArtful.return_value = "artful"
+            test_obj.remove_routes(test_obj)
+            
+        assert os.path.exists(test_obj.ifup_path) == False
+        assert os.path.exists(test_obj.ifdown_path) == False
+
+        assert True
+
+    def test_symlink_force(self, advanced_routing_helper):
+        """Test symlink_force"""
+        test_obj = advanced_routing_helper
+
+        target = self.test_dir + 'testfile'
+        link = self.test_dir + 'testlink'
+
+        try:
+            os.remove(target)
+        except:
+            pass  # dont care
+
+        # touch target file to link to
+        try:
+            with open(target, "w+") as f:
+                f.write('dont care\n')
+        except:
+            pass  # dont care
+
+        assert os.path.exists(target)
+
+        # link it
+        test_obj.symlink_force(test_obj, target, link)
+        assert os.path.exists(link)
+
+        # link it again
+        test_obj.symlink_force(test_obj, target, link)
+        assert os.path.exists(link)
diff --git a/tox.ini b/tox.ini
new file mode 100644
index 0000000..5351ddd
--- /dev/null
+++ b/tox.ini
@@ -0,0 +1,46 @@
+[tox]
+skipsdist=True
+envlist = unit, functional
+skip_missing_interpreters = True
+
+[testenv]
+basepython = python3
+setenv =
+  PYTHONPATH = .
+
+[testenv:unit]
+commands = pytest -o log_cli=true --full-trace  -v --ignore {toxinidir}/tests/functional
+deps = -r{toxinidir}/tests/unit/requirements.txt
+       -r{toxinidir}/requirements.txt
+setenv = PYTHONPATH={toxinidir}/lib
+whitelist_externals = pytest
+
+[testenv:functional]
+passenv =
+  HOME
+  JUJU_REPOSITORY
+  PATH
+  PYTEST_KEEP_MODEL
+  PYTEST_CLOUD_NAME
+  PYTEST_CLOUD_REGION
+commands = pytest -v --ignore {toxinidir}/tests/unit
+deps = -r{toxinidir}/tests/functional/requirements.txt
+       -r{toxinidir}/requirements.txt
+
+[testenv:lint]
+commands = flake8
+deps =
+    flake8
+    flake8-docstrings
+    flake8-import-order
+    pep8-naming
+    flake8-colors
+
+[flake8]
+exclude =
+    .git,
+    __pycache__,
+    .tox,
+ignore=D401,C901
+max-line-length = 120
+max-complexity = 10