Updated documentation and releasing new version with FortiOS support

napalm-automation · Apr 24, 2015 · b467dfa · b467dfa
1 parent a087b3b
commit b467dfa
Show file tree

Hide file tree

Showing 5 changed files with 39 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -7,13 +7,23 @@ NAPALM supports several methods to connect to the devices, to manipulate configu
 Supported Network Operating Systems
 -----------------------------------
 
- * eos - Using [pyEOS](https://github.com/spotify/pyeos). You need version 4.14.6M or superior.
- * junos - Using [junos-eznc](https://github.com/Juniper/py-junos-eznc)
- * iosxr - Using [pyIOSXR](https://github.com/fooelisa/pyiosxr)
+ * EOS - Using [pyEOS](https://github.com/spotify/pyeos). You need version 4.14.6M or superior.
+ * JunOS - Using [junos-eznc](https://github.com/Juniper/py-junos-eznc)
+ * IOS-XR - Using [pyIOSXR](https://github.com/fooelisa/pyiosxr)
+ * FortiOS - Using [pyFG](https://github.com/spotify/pyfg)
+
+|   | EOS  | JunOS  | IOS-XR  | FortiOS  |
+|---|---|---|---|---|
+| **Name** | eos | junos | iosxr | fortios |
+| **Config Management** | Full  | Full  | Full  | Full |
+| **Atomic Changes** | Yes | Yes | Yes | No |
+| **Rollback** | Yes | Yes | Yes | Yes |
 
 Documentation
 =============
 
+Before using the library, please, read the documentation (link below). Specially the "caveats" section:
+
 See the [Read the Docs](http://napalm.readthedocs.org)
 
 Install

diff --git a/docs/eos.rst b/docs/eos.rst
@@ -1,6 +1,9 @@
 EOS
 ----
 
+Rollback
+~~~~~~~~
+
 The rollback feature is supported only when committing from the API. In reality, what the API does during the commit operation is as follows::
 
     copy startup-config flash:rollback-0

diff --git a/docs/fortios.rst b/docs/fortios.rst
@@ -0,0 +1,14 @@
+FortiOS
+-------
+
+Rollback
+~~~~~~~~
+
+To make sure the rollback feature works either use only this API to do changes or remember to save your rollback points on the CLI with the command::
+
+    execute backup config flash your_message
+
+Atomic Changes
+~~~~~~~~~~~~~~
+
+FortiOS' plugin will use the "batch" feature. All commands will not go at the same time but all of them will be processed. The sad true is that FortiOS doesn't have any proper tool to apply large chunks of configuration.
diff --git a/docs/index.rst b/docs/index.rst
@@ -43,4 +43,12 @@ Drivers
    :maxdepth: 2
 
    base
+
+Caveats
+=======
+
+.. toctree::
+   :maxdepth: 2
+
    eos
+   fortios
diff --git a/setup.py b/setup.py
@@ -10,7 +10,7 @@
 
 setup(
     name="napalm",
-    version="0.11",
+    version="0.12",
     packages=find_packages(),
     author="David Barroso",
     author_email="[email protected]",