diff --git a/layers/netutils/LICENSE b/layers/netutils/LICENSE new file mode 100644 index 0000000000000000000000000000000000000000..d645695673349e3947e8e5ae42332d0ac3164cd7 --- /dev/null +++ b/layers/netutils/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/layers/netutils/README.md b/layers/netutils/README.md new file mode 100644 index 0000000000000000000000000000000000000000..525c2d7bb27a195cc8c49ebcd5ad2b2b521d0767 --- /dev/null +++ b/layers/netutils/README.md @@ -0,0 +1,54 @@ +# Overview + +This charm provides basic network utilities that can be run from a Juju-deployed +machine. + +# Usage + +To deploy the charm: +```bash +$ juju deploy cs:~nfv/netutils +``` + +To run an action: +```bash +$ juju run-action netutils/0 ping destination=google.com +$ juju run-action netutils/0 traceroute destination=google.com +``` + +To fetch the output of an action: +```bash +$ juju show-action-output 026b3d4c-0bb2-4818-8d24-9855936cdcdf +results: + output: | + traceroute to google.com (216.58.198.78), 30 hops max, 60 byte packets + 1 ec2-79-125-0-86.eu-west-1.compute.amazonaws.com (79.125.0.86) 1.431 ms 1.410 ms 1.380 ms + 2 100.64.2.73 (100.64.2.73) 1.647 ms 100.64.2.103 (100.64.2.103) 1.247 ms 100.64.2.121 (100.64.2.121) 1.224 ms + 3 100.64.0.232 (100.64.0.232) 1.296 ms 100.64.0.184 (100.64.0.184) 1.515 ms 100.64.0.234 (100.64.0.234) 1.079 ms + 4 100.64.16.37 (100.64.16.37) 0.377 ms 100.64.16.49 (100.64.16.49) 0.347 ms 100.64.16.1 (100.64.16.1) 0.340 ms + 5 176.32.107.12 (176.32.107.12) 0.739 ms 176.32.107.4 (176.32.107.4) 0.875 ms 0.748 ms + 6 178.236.0.111 (178.236.0.111) 0.650 ms 0.641 ms 0.645 ms + 7 72.14.215.85 (72.14.215.85) 0.544 ms 1.508 ms 1.498 ms + 8 209.85.252.198 (209.85.252.198) 0.680 ms 0.659 ms 0.618 ms + 9 64.233.174.27 (64.233.174.27) 0.690 ms 0.682 ms 0.634 ms + 10 dub08s02-in-f14.1e100.net (216.58.198.78) 0.568 ms 0.560 ms 0.595 ms +status: completed +timing: + completed: 2016-06-29 14:50:04 +0000 UTC + enqueued: 2016-06-29 14:50:03 +0000 UTC + started: 2016-06-29 14:50:03 +0000 UTC +``` + +## Scale out Usage + +With great scalability comes great power, but please don't use this to DDoS anyone without their permission. + +## Known Limitations and Issues + +# Contact Information + +## Contributing to the charm + + - The compiled charm can be found [here](https://www.jujucharms.com/u/nfv/netutils). + - [layer/netutils](https://osm.etsi.org/gitweb/?p=osm/juju-charms.git;a=summary/) contains the source of the layer. + - Please add any bugs or feature requests to the [bugzilla](https://osm.etsi.org/bugzilla/buglist.cgi?component=Juju-charms&list_id=426&product=OSM&resolution=---). diff --git a/layers/netutils/actions.yaml b/layers/netutils/actions.yaml new file mode 100644 index 0000000000000000000000000000000000000000..9995f777df835fbe5808593dd1e16f5038a3adf6 --- /dev/null +++ b/layers/netutils/actions.yaml @@ -0,0 +1,32 @@ +nmap: + description: "nmap a thing!" + params: + destination: + description: "destination to scan" + type: string + required: + - destination +ping: + description: 'ping a thing!' + params: + count: + description: "Stop after sending count ECHO_REQUEST packets" + type: integer + default: 30 + destination: + description: "destination of ping request" + type: string + required: + - destination +traceroute: + description: 'trace a thing!' + params: + hops: + description: "Stop tracing after count hops" + type: integer + default: 30 + destination: + description: "destination of traceroute request" + type: string + required: + - destination diff --git a/layers/netutils/actions/nmap b/layers/netutils/actions/nmap new file mode 100755 index 0000000000000000000000000000000000000000..ede4f5b93e74c29b4c5faf3518f1c4d67ef41918 --- /dev/null +++ b/layers/netutils/actions/nmap @@ -0,0 +1,18 @@ +#!/usr/bin/env python3 +import sys +sys.path.append('lib') + +from charms.reactive import main +from charms.reactive import set_state +from charmhelpers.core.hookenv import action_fail + +""" +`set_state` only works here because it's flushed to disk inside the `main()` +loop. remove_state will need to be called inside the action method. +""" +set_state('actions.nmap') + +try: + main() +except Exception as e: + action_fail(repr(e)) diff --git a/layers/netutils/actions/ping b/layers/netutils/actions/ping new file mode 100755 index 0000000000000000000000000000000000000000..9850fe7602a72fad2e32fee1553e5fa010237c53 --- /dev/null +++ b/layers/netutils/actions/ping @@ -0,0 +1,18 @@ +#!/usr/bin/env python3 +import sys +sys.path.append('lib') + +from charms.reactive import main +from charms.reactive import set_state +from charmhelpers.core.hookenv import action_fail + +""" +`set_state` only works here because it's flushed to disk inside the `main()` +loop. remove_state will need to be called inside the action method. +""" +set_state('actions.ping') + +try: + main() +except Exception as e: + action_fail(repr(e)) diff --git a/layers/netutils/actions/traceroute b/layers/netutils/actions/traceroute new file mode 100755 index 0000000000000000000000000000000000000000..229ed327689448b3e0e4f28347e5af10747dc95c --- /dev/null +++ b/layers/netutils/actions/traceroute @@ -0,0 +1,18 @@ +#!/usr/bin/env python3 +import sys +sys.path.append('lib') + +from charms.reactive import main +from charms.reactive import set_state +from charmhelpers.core.hookenv import action_fail + +""" +`set_state` only works here because it's flushed to disk inside the `main()` +loop. remove_state will need to be called inside the action method. +""" +set_state('actions.traceroute') + +try: + main() +except Exception as e: + action_fail(repr(e)) diff --git a/layers/netutils/icon.svg b/layers/netutils/icon.svg new file mode 100644 index 0000000000000000000000000000000000000000..e092eef75dc91ec1c1d85ddfcc3ca157a9c02a27 --- /dev/null +++ b/layers/netutils/icon.svg @@ -0,0 +1,279 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + diff --git a/layers/netutils/layer.yaml b/layers/netutils/layer.yaml new file mode 100644 index 0000000000000000000000000000000000000000..c1bf2cf043ff494d1d5744f39f37c68e8fdd8151 --- /dev/null +++ b/layers/netutils/layer.yaml @@ -0,0 +1,7 @@ +repo: git@github.com:AdamIsrael/layer-netutils.git +includes: ['layer:basic'] # if you use any interfaces, add them here +options: + basic: + packages: + - traceroute + - nmap diff --git a/layers/netutils/metadata.yaml b/layers/netutils/metadata.yaml new file mode 100644 index 0000000000000000000000000000000000000000..c42d9637966362a34ab006aadb867e1f637f296e --- /dev/null +++ b/layers/netutils/metadata.yaml @@ -0,0 +1,15 @@ +name: netutils +summary: A suite of network-related utilities. +maintainer: Adam Israel +description: | + A suite of network-related utilities, such as ping and traceroute, that + can be deployed into a data center in order to diagnose connectivity issues. +tags: + # https://jujucharms.com/docs/stable/authors-charm-metadata + - ops + - network + - performance +series: + - trusty + - xenial +subordinate: false diff --git a/layers/netutils/reactive/layer_netutils.py b/layers/netutils/reactive/layer_netutils.py new file mode 100644 index 0000000000000000000000000000000000000000..8f8db268acbed7ab3ddcf43a00d676d13f08f931 --- /dev/null +++ b/layers/netutils/reactive/layer_netutils.py @@ -0,0 +1,86 @@ +from charmhelpers.core.hookenv import ( + config, + status_set, + action_get, + action_set, + action_fail, + log, +) + +from charms.reactive import ( + when, + when_not, + set_state as set_flag, + remove_state as remove_flag, +) + +import subprocess + + +@when_not('netutils.ready') +def ready(): + status_set('active', 'Ready!') + set_flag('netutils.ready') + + +@when('actions.nmap') +def nmap(): + err = '' + try: + result, err = _run('nmap {}'.format(action_get('destination'))) + except: + action_fail('nmap command failed:' + err) + else: + action_set({'outout': result}) + finally: + remove_flag('actions.nmap') + + +@when('actions.ping') +def ping(): + err = '' + try: + result, err = _run('ping -qc {} {}'.format( + action_get('count'), action_get('destination')) + ) + + except: + action_fail('ping command failed:' + err) + else: + # Here you can send results back from ping, if you had time to parse it + action_set({'output': result}) + finally: + remove_flag('actions.ping') + + + +@when('actions.traceroute') +def traceroute(): + try: + result, err = _run('traceroute -m {} {}'.format(action_get('hops'), action_get('destination'))) + except: + action_fail('traceroute command failed') + else: + # Here you can send results back from ping, if you had time to parse it + action_set({'output': result}) + finally: + remove_flag('actions.traceroute') + + + +def _run(cmd, env=None): + if isinstance(cmd, str): + cmd = cmd.split() if ' ' in cmd else [cmd] + + log(cmd) + p = subprocess.Popen(cmd, + env=env, + stdout=subprocess.PIPE, + stderr=subprocess.PIPE) + stdout, stderr = p.communicate() + retcode = p.poll() + if retcode > 0: + raise subprocess.CalledProcessError(returncode=retcode, + cmd=cmd, + output=stderr.decode("utf-8").strip()) + return (stdout.decode('utf-8'), stderr.decode('utf-8')) diff --git a/layers/netutils/tests/00-setup b/layers/netutils/tests/00-setup new file mode 100755 index 0000000000000000000000000000000000000000..f0616a560a811bae78d7872dd433d612909c73cd --- /dev/null +++ b/layers/netutils/tests/00-setup @@ -0,0 +1,5 @@ +#!/bin/bash + +sudo add-apt-repository ppa:juju/stable -y +sudo apt-get update +sudo apt-get install amulet python-requests -y diff --git a/layers/netutils/tests/10-deploy b/layers/netutils/tests/10-deploy new file mode 100755 index 0000000000000000000000000000000000000000..ef269cdaaa5799d1ecc07373e80814705724f9d7 --- /dev/null +++ b/layers/netutils/tests/10-deploy @@ -0,0 +1,31 @@ +#!/usr/bin/python3 + +import amulet +import requests +import unittest + + +class TestCharm(unittest.TestCase): + def setUp(self): + self.d = amulet.Deployment() + + self.d.add('layer-netutils') + self.d.expose('layer-netutils') + + self.d.setup(timeout=900) + self.d.sentry.wait() + + self.unit = self.d.sentry['layer-netutils'][0] + + def test_service(self): + # test we can access over http + page = requests.get('http://{}'.format(self.unit.info['public-address'])) + self.assertEqual(page.status_code, 200) + # Now you can use self.d.sentry[SERVICE][UNIT] to address each of the units and perform + # more in-depth steps. Each self.d.sentry[SERVICE][UNIT] has the following methods: + # - .info - An array of the information of that unit from Juju + # - .file(PATH) - Get the details of a file on that unit + # - .file_contents(PATH) - Get plain text output of PATH file from that unit + # - .directory(PATH) - Get details of directory + # - .directory_contents(PATH) - List files and folders in PATH on that unit + # - .relation(relation, service:rel) - Get relation data from return service