diff options
| author | Wesley Wiedenmeier <wesley.wiedenmeier@gmail.com> | 2016-08-28 17:56:17 -0500 |
|---|---|---|
| committer | Scott Moser <smoser@brickies.net> | 2016-09-30 13:21:00 -0400 |
| commit | 1071b9940b4e114cd2eabf290b739f92fbab33de (patch) | |
| tree | a8fbef15c5be9510df93b4544e3bca1f74e2f29a /cloudinit/config/cc_fan.py | |
| parent | 02f6c4bb8cef17b3fe04ef4dc1ef199e20aeb4d9 (diff) | |
| download | vyos-cloud-init-1071b9940b4e114cd2eabf290b739f92fbab33de.tar.gz vyos-cloud-init-1071b9940b4e114cd2eabf290b739f92fbab33de.zip | |
Improve module documentation and doc cleanup.
This adds lots of config module documentation in a standard format.
It will greatly improve the content at readthedocs.
Additionally:
* Add a 'doc' env to tox.ini
* Changed default highlight language for sphinx conf from python to yaml
most examples in documentation are yaml configs
* Updated datasource examples to highlight sh code properly
Diffstat (limited to 'cloudinit/config/cc_fan.py')
| -rw-r--r-- | cloudinit/config/cc_fan.py | 49 |
1 files changed, 31 insertions, 18 deletions
diff --git a/cloudinit/config/cc_fan.py b/cloudinit/config/cc_fan.py index 545fee22..6027fdc7 100644 --- a/cloudinit/config/cc_fan.py +++ b/cloudinit/config/cc_fan.py @@ -15,25 +15,38 @@ # # You should have received a copy of the GNU General Public License # along with this program. If not, see <http://www.gnu.org/licenses/>. + """ -fan module allows configuration of Ubuntu Fan - https://wiki.ubuntu.com/FanNetworking - -Example config: - #cloud-config - fan: - config: | - # fan 240 - 10.0.0.0/8 eth0/16 dhcp - 10.0.0.0/8 eth1/16 dhcp off - # fan 241 - 241.0.0.0/8 eth0/16 dhcp - config_path: /etc/network/fan - -If cloud-init sees a 'fan' entry in cloud-config it will - a.) write 'config_path' with the contents - b.) install the package 'ubuntu-fan' if it is not installed - c.) ensure the service is started (or restarted if was previously running) +Fan +--- +**Summary:** configure ubuntu fan networking + +This module installs, configures and starts the ubuntu fan network system. For +more information about Ubuntu Fan, see: +``https://wiki.ubuntu.com/FanNetworking``. + +If cloud-init sees a ``fan`` entry in cloud-config it will: + + - write ``config_path`` with the contents of the ``config`` key + - install the package ``ubuntu-fan`` if it is not installed + - ensure the service is started (or restarted if was previously running) + +**Internal name:** ``cc_fan`` + +**Module frequency:** per instance + +**Supported distros:** ubuntu + +**Config keys**:: + + fan: + config: | + # fan 240 + 10.0.0.0/8 eth0/16 dhcp + 10.0.0.0/8 eth1/16 dhcp off + # fan 241 + 241.0.0.0/8 eth0/16 dhcp + config_path: /etc/network/fan """ from cloudinit import log as logging |