commit e48b23e1631b24e54e1296a8022127b03f73c927 Author: Frode Nordahl Date: Mon Jan 29 16:21:25 2018 +0100 Initial commit diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..15b9c60 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,5 @@ +dist: trusty +language: python +script: + - pep8 . + - flake8 . diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..7a4a3ea --- /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. \ No newline at end of file diff --git a/README b/README new file mode 100644 index 0000000..f825921 --- /dev/null +++ b/README @@ -0,0 +1,5 @@ +# Overview +This is a interface for use with implementing BGP releations between Juju +Charms. + +Take a look at the Quagga Charm for example usage. diff --git a/interface.yaml b/interface.yaml new file mode 100644 index 0000000..da69545 --- /dev/null +++ b/interface.yaml @@ -0,0 +1,4 @@ +name: bgp +summary: BGP interface +version: 1 +repo: https://github.com/fnordahl/interface-bgp.git diff --git a/provides.py b/provides.py new file mode 100644 index 0000000..100fbde --- /dev/null +++ b/provides.py @@ -0,0 +1,126 @@ +# Copyright 2018 Frode Nordahl +# +# 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. + +import charmhelpers.core as ch_core +import charmhelpers.contrib.network.ip as ch_net_ip +from charms import reactive +import netaddr + + +class BGPEndpoint(reactive.Endpoint): + def generate_asn(self): + """ + Generate unique 32-bit Private Use [RFC6996] ASn. + + This is useful to automate configuration of BGP routers that is part + of a Clos Network Topology with a Layer 3-Only routed design. [RFC7938] + + Assumption: + - Unit has a IPv4 address and it is unique to the deployment. + + Implementation: + - A private 32-bit ASn has a range of 4 200 000 000 - 4 294 967 294 + which leaves us with 94 967 294 possible endpoints. + - Within a deployment it is less likelly that the 4 most significant + bits of the IP address differ between units. + - If we cap the 4 most significant bits of the IPv4 address to be + within the range of 0 and 4, the decimal representation of the + resulting IPv4 address fits nicely into that range. + + Note: + - This implementation generates ASn in the following range: + 4 211 081 215 - 4 294 967 294 + - Leaving the following range for any static configuration needs: + 4 200 000 000 - 4 211 081 214 + """ + asn_base = 4211081215 + mask = netaddr.IPAddress('5.255.255.255') + unit_ip = netaddr.IPAddress( + ch_core.hookenv.unit_get('private-address')) + masked_ip = unit_ip & mask + + asn = asn_base + int(masked_ip) + + # XXX: This assert should be removed from code and put in a unit test + assert asn <= 4294967294 + + return asn + + def publish_info(self, asn=None): + """ + Publish the AS Number and IP address of any extra-bindings of this + BGP Endpoint over the relationship. + + If no AS Number is provided a unique 32-bit Private Use [RFC6996] ASn + will be generated. + """ + if asn: + myasn = asn + else: + myasn = self.generate_asn() + + # network_get will return addresses for extra-bindings regardless of + # extra-bindings being bound to a network space. detect actual space + # bindings by comparing returned addresses to what we have for the + # relation itself. + for relation in self.relations: + rel_network = ch_core.hookenv.network_get( + self.expand_name('{endpoint_name}'), + relation_id=relation.relation_id) + rel_addrs = [a['address'] + for a in + rel_network['bind-addresses'][0]['addresses']] + extra_bindings = [] + for binding in ch_core.hookenv.metadata()['extra-bindings']: + bind_network = ch_core.hookenv.network_get( + binding, + relation_id=relation.relation_id) + bind_addrs = [a['address'] + for a in + bind_network['bind-addresses'][0]['addresses']] + if not set(bind_addrs).issubset(set(rel_addrs)): + extra_bindings.extend( + bind_network['bind-addresses'][0]['addresses']) + relation.to_publish['asn'] = myasn + relation.to_publish['extra_bindings'] = extra_bindings + + def get_received_info(self): + neighbors = [] + for relation in self.relations: + for unit in relation.units: + if not ('asn' in unit.received and + 'extra_bindings' in unit.received): + ch_core.hookenv.log('Skip get_received_info() ' + 'relation incomplete...', + level=ch_core.hookenv.DEBUG) + continue + links = [] + for addrinfo in unit.received['extra_bindings']: + # filter list of networks to those we have interfaces + # configured for + ip = ch_net_ip.get_address_in_network(addrinfo['cidr']) + if ip: + links.append( + {'local': ip, + 'remote': addrinfo['address'], + 'cidr': addrinfo['cidr']} + ) + ch_core.hookenv.log("links: '{}'".format(links)) + neighbors.append({ + 'asn': unit.received['asn'], + 'links': links, + 'relation_id': relation.relation_id, + 'remote_unit_name': unit.unit_name, + }) + return neighbors diff --git a/requires.py b/requires.py new file mode 120000 index 0000000..1b4a6a9 --- /dev/null +++ b/requires.py @@ -0,0 +1 @@ +provides.py \ No newline at end of file