Browse Source

Updating configuration parameters

- Adding designation for which are OpenStack specific
- Adding indication that valid ansible parameters that are not
  documented in these docs are passed through and can be used.

Change-Id: I9879965d5a252c3f288562f7aab4b48b40d58616
changes/74/617674/2
Dan Radez 7 months ago
parent
commit
90e8ff717b
1 changed files with 19 additions and 5 deletions
  1. 19
    5
      doc/source/install/configure.rst

+ 19
- 5
doc/source/install/configure.rst View File

@@ -42,7 +42,6 @@ managed by networking-ansible.
42 42
       ansible_host=10.10.2.250
43 43
       ansible_user=ansible
44 44
       ansible_pass=password
45
-      mac=01:23:45:67:89:AB
46 45
 
47 46
     * myhostname is an arbitrary internal identifier used only in ironic's link_local_information.
48 47
     * ansible_network_os is a valid Ansible Networking value to indicate switch type.
@@ -52,25 +51,40 @@ managed by networking-ansible.
52 51
     * ansible_host is the IP address or hostname used to connect to the switch.
53 52
     * ansible_user username of the credentials used to connect to the switch.
54 53
     * ansible_pass password of the credentials used to connect to the switch.
54
+
55
+    OpenStack Specific parameters:
56
+
57
+    .. code-block:: ini
58
+
59
+      mac=01:23:45:67:89:AB
60
+      manage_vlans=True
61
+
55 62
     * mac is the MAC address of the switch as provided by lldp. This is optional to provide and
56 63
       specific to OpenStack ML2 use cases. It is used for zero touch provisioning using Ironic
57 64
       introspection. Introspection gathers the switch's MAC and node's port provided by lldp
58 65
       and populates the baremetal node's local_link_information. If this parameter is provided in
59 66
       the ML2 ini configuration it will be used to match against the lldp provided MAC to
60 67
       populate internally generated ansible playbooks with the appropriate host name for the switch.
68
+    * manage_vlans is optional and defaults to True. Set this to False for a
69
+      switch if networking-ansible should not create and delete VLANs on the device.
61 70
 
62
-    Additional available parameters:
71
+    Additional parameters and examples:
63 72
 
64 73
     .. code-block:: ini
65 74
 
66 75
       ansible_ssh_private_key_file=/path/to/ansible-ssh
67
-      manage_vlans=True
76
+      ansible_ssh_common_args='-o ProxyCommand="ssh -W %h:%p -q user@hostname"'
68 77
 
69 78
     * ansible_ssh_private_key_file can be used as an alternative to ansible_pass
70 79
       to use ssh key authentication instead of password authentication.
71
-    * manage_vlans is optional and defaults to True. Set this to False for a
72
-      switch if networking-ansible should not create and delete VLANs on the device.
80
+    * ansible_ssh_common_args is passed to the ssh command Ansible uses.
81
+      In the example above the ProxyCommand is used to connect to a switch through a proxy.
82
+
83
+    Parameters pass through automatically:
73 84
 
85
+    * All parameters not mentioned here are passed from neutron to ansible through inventory.
86
+      Any inventory parameter that is supported by the version of Ansible should be able to
87
+      be defined in the switch's configuration stanza and will passed to Ansible.
74 88
 
75 89
 #. Restart the Neutron API service
76 90
 

Loading…
Cancel
Save