Browse Source

Adding docs regarding provider support

- also updating the theme configuration so that RedTheDocs can use it

Change-Id: I1e4545552c9e3b7cbf4afe1e69a2873c1f86afdd
Dan Radez 7 months ago
parent
commit
6b98ccbbcc
3 changed files with 60 additions and 1 deletions
  1. 11
    1
      doc/source/conf.py
  2. 1
    0
      doc/source/contributor/index.rst
  3. 48
    0
      doc/source/contributor/provider.rst

+ 11
- 1
doc/source/conf.py View File

@@ -22,7 +22,7 @@ sys.path.insert(0, os.path.abspath('../..'))
22 22
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
23 23
 extensions = [
24 24
     'sphinx.ext.autodoc',
25
-    'openstackdocstheme',
25
+#    'openstackdocstheme',
26 26
 ]
27 27
 
28 28
 # autodoc generation is a bit aggressive and a nuisance when doing heavy
@@ -61,7 +61,17 @@ pygments_style = 'sphinx'
61 61
 # html_theme_path = ["."]
62 62
 # html_theme = '_theme'
63 63
 # html_static_path = ['static']
64
+#try:
65
+    # The openstack theme is much closer to rtd theme
66
+    # but getting an error when using rtd theme locally
67
+    # putting this here to use openstack locally and
68
+    # rtd theme on readthedocs.io
69
+    # intention is to remove this once the local rtd theme is sorted out
70
+#    import openstackdocstheme
64 71
 html_theme = 'openstackdocs'
72
+extensions.append('openstackdocstheme')
73
+#except:
74
+#    html_theme = 'default'
65 75
 
66 76
 # Output file base name for HTML help builder.
67 77
 htmlhelp_basename = '%sdoc' % project

+ 1
- 0
doc/source/contributor/index.rst View File

@@ -6,4 +6,5 @@
6 6
    :maxdepth: 2
7 7
 
8 8
    contributing
9
+   provider
9 10
 

+ 48
- 0
doc/source/contributor/provider.rst View File

@@ -0,0 +1,48 @@
1
+================
2
+Provider Support
3
+================
4
+Networking-Ansible contains provider switch specific functionality in an
5
+Ansible role that enables specific hardware devices per provider switch added
6
+to this role. The openstack-ml2 Ansible role is stored in networking-ansible's
7
+etc/ansible/roles directory. A provider switch will be refered to as just a
8
+provider for the remainder of this document.
9
+
10
+Adding a provider
11
+~~~~~~~~~~~~~~~~~
12
+To add a provider to networking-ansible's capabilities the provider must be
13
+added to the Ansible openstack-ml2 role. To add the provider to the
14
+openstack-ml2 role a new directory using the Ansible Networking module name
15
+[`1`_] must be added that contains files that will define the Ansible tasks
16
+nessessary to perform the respective ML2 action.
17
+
18
+Inside the directory for the provider, a file for default values, plus a file
19
+for each supported action in netwoking-ansible is required. There are currently
20
+five files required to add full functionality for a provider in
21
+networking-ansible.
22
+
23
+* defaults.yaml
24
+
25
+   Defines default values for segmentation name and ID. For example some
26
+   switch vendors use the name "default" and VLAN ID 1 as a default VLAN
27
+   to assign switchports to. Open vSwitch expects no VLAN ID and VLAN name
28
+   in the case that port is not assigned to a specific VLAN.
29
+
30
+* create_network.yaml
31
+
32
+   Defines the Ansible tasks to create a VLAN on a switch.
33
+
34
+* delete_network.yaml
35
+
36
+   Defines the Ansible tasks to delete a VLAN on a switch.
37
+
38
+* update_port.yaml
39
+
40
+   Defines the Ansible tasks to assign a VLAN to a switchport in access mode.
41
+
42
+* delete_port.yaml
43
+
44
+   Defines the Ansible tasks to remove configuration from a switchport.
45
+
46
+[1] https://docs.ansible.com/ansible/2.5/modules/list_of_network_modules.html
47
+
48
+.. _1: https://docs.ansible.com/ansible/2.5/modules/list_of_network_modules.html

Loading…
Cancel
Save