summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDan Radez <dradez@redhat.com>2018-11-13 09:48:03 -0500
committerDan Radez <dradez@redhat.com>2018-11-14 07:38:13 -0500
commit90e8ff717b8846790d2c00f7c0026e6106ef5ca7 (patch)
treea79fa6803add3ed204277f6f15d1bb256cf1bdfb
parentd1a2b9a2794a7dae0b3d210bd096c2cf598c8069 (diff)
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
Notes
Notes (review): Code-Review+2: Jakub Libosvar <libosvar@redhat.com> Workflow+1: Jakub Libosvar <libosvar@redhat.com> Verified+2: Zuul Submitted-by: Zuul Submitted-at: Wed, 14 Nov 2018 13:13:46 +0000 Reviewed-on: https://review.openstack.org/617674 Project: openstack/networking-ansible Branch: refs/heads/master
-rw-r--r--doc/source/install/configure.rst24
1 files changed, 19 insertions, 5 deletions
diff --git a/doc/source/install/configure.rst b/doc/source/install/configure.rst
index 6fdbb7c..bdaddef 100644
--- a/doc/source/install/configure.rst
+++ b/doc/source/install/configure.rst
@@ -42,7 +42,6 @@ managed by networking-ansible.
42 ansible_host=10.10.2.250 42 ansible_host=10.10.2.250
43 ansible_user=ansible 43 ansible_user=ansible
44 ansible_pass=password 44 ansible_pass=password
45 mac=01:23:45:67:89:AB
46 45
47 * myhostname is an arbitrary internal identifier used only in ironic's link_local_information. 46 * myhostname is an arbitrary internal identifier used only in ironic's link_local_information.
48 * ansible_network_os is a valid Ansible Networking value to indicate switch type. 47 * ansible_network_os is a valid Ansible Networking value to indicate switch type.
@@ -52,25 +51,40 @@ managed by networking-ansible.
52 * ansible_host is the IP address or hostname used to connect to the switch. 51 * ansible_host is the IP address or hostname used to connect to the switch.
53 * ansible_user username of the credentials used to connect to the switch. 52 * ansible_user username of the credentials used to connect to the switch.
54 * ansible_pass password of the credentials used to connect to the switch. 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 * mac is the MAC address of the switch as provided by lldp. This is optional to provide and 62 * mac is the MAC address of the switch as provided by lldp. This is optional to provide and
56 specific to OpenStack ML2 use cases. It is used for zero touch provisioning using Ironic 63 specific to OpenStack ML2 use cases. It is used for zero touch provisioning using Ironic
57 introspection. Introspection gathers the switch's MAC and node's port provided by lldp 64 introspection. Introspection gathers the switch's MAC and node's port provided by lldp
58 and populates the baremetal node's local_link_information. If this parameter is provided in 65 and populates the baremetal node's local_link_information. If this parameter is provided in
59 the ML2 ini configuration it will be used to match against the lldp provided MAC to 66 the ML2 ini configuration it will be used to match against the lldp provided MAC to
60 populate internally generated ansible playbooks with the appropriate host name for the switch. 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 .. code-block:: ini 73 .. code-block:: ini
65 74
66 ansible_ssh_private_key_file=/path/to/ansible-ssh 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 * ansible_ssh_private_key_file can be used as an alternative to ansible_pass 78 * ansible_ssh_private_key_file can be used as an alternative to ansible_pass
70 to use ssh key authentication instead of password authentication. 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 80 * ansible_ssh_common_args is passed to the ssh command Ansible uses.
72 switch if networking-ansible should not create and delete VLANs on the device. 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#. Restart the Neutron API service 89#. Restart the Neutron API service
76 90