charms/layers/netutils/README.md

   1 # Overview
   2
   3 This charm provides basic network utilities that can be run from a Juju-deployed
   4 machine.
   5
   6 # Usage
   7
   8 To deploy the charm:
   9 ```bash
  10 $ juju deploy cs:~nfv/netutils
  11 ```
  12
  13 To run an action:
  14 ```bash
  15 $ juju run-action netutils/0 ping destination=google.com
  16 $ juju run-action netutils/0 traceroute destination=google.com
  17 ```
  18
  19 To fetch the output of an action:
  20 ```bash
  21 $ juju show-action-output 026b3d4c-0bb2-4818-8d24-9855936cdcdf
  22 results:
  23   output: |
  24     traceroute to google.com (216.58.198.78), 30 hops max, 60 byte packets
  25      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
  26      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
  27      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
  28      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
  29      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
  30      6  178.236.0.111 (178.236.0.111)  0.650 ms  0.641 ms  0.645 ms
  31      7  72.14.215.85 (72.14.215.85)  0.544 ms  1.508 ms  1.498 ms
  32      8  209.85.252.198 (209.85.252.198)  0.680 ms  0.659 ms  0.618 ms
  33      9  64.233.174.27 (64.233.174.27)  0.690 ms  0.682 ms  0.634 ms
  34     10  dub08s02-in-f14.1e100.net (216.58.198.78)  0.568 ms  0.560 ms  0.595 ms
  35 status: completed
  36 timing:
  37   completed: 2016-06-29 14:50:04 +0000 UTC
  38   enqueued: 2016-06-29 14:50:03 +0000 UTC
  39   started: 2016-06-29 14:50:03 +0000 UTC
  40 ```
  41 ## iperf3
  42
  43 Because iperf3 has a client and server component, the netutils charm can operate
  44 as both. Setting the iperf3 configuration value to True will start iperf3 in
  45 server mode, running as a daemon.
  46 ```
  47 $ juju deploy cs:~nfv/netutils client
  48 $ juju deploy cs:~nfv/netutils server iperf3=True
  49 $ juju run-action client/0 iperf host=<ip of server> [...]
  50 ```
  51
  52 ## Scale out Usage
  53
  54 With great scalability comes great power, but please don't use this to DDoS anyone without their permission.
  55
  56 ## Known Limitations and Issues
  57
  58 # Contact Information
  59
  60 ## Contributing to the charm
  61
  62   - The compiled charm can be found [here](https://www.jujucharms.com/u/nfv/netutils).
  63   - [layer/netutils](https://osm.etsi.org/gitweb/?p=osm/juju-charms.git;a=summary/) contains the source of the layer.
  64   - 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=---).