Browse Source

Populating user doc's content, cleaning up other things

Change-Id: I17973f3da376bb6b308cd2b317268bcca0b3ef55
Dan Radez 7 months ago
parent
commit
30098f2f39

+ 1
- 1
CONTRIBUTING.rst View File

@@ -14,4 +14,4 @@ Pull requests submitted through GitHub will be ignored.
14 14
 
15 15
 Bugs should be filed on Storyboard, not GitHub:
16 16
 
17
-   https://storyboard.openstack.org/#!/project/986
17
+   https://storyboard.openstack.org/#!/project/openstack/networking-ansible

+ 5
- 1
README.rst View File

@@ -27,7 +27,11 @@ The Networking-Ansible ML2 Driver consists of the following components:
27 27
 
28 28
 Use Cases
29 29
 ---------
30
-Ironic Baremetal Guests
30
+``Ironic Baremetal Guest Deployment``
31
+
32
+Ironic uses Networking-Ansible to configure the switch ports for the baremetal guests.
33
+Ironic needs to swap the port a baremetal guest is connected to between the
34
+Ironic provisioning network and the tenant VLAN that the guest is assigned.
31 35
 
32 36
 Features
33 37
 --------

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

@@ -61,17 +61,9 @@ 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
71 64
 html_theme = 'openstackdocs'
65
+# It works with RTD this way for some reason.
72 66
 extensions.append('openstackdocstheme')
73
-#except:
74
-#    html_theme = 'default'
75 67
 
76 68
 # Output file base name for HTML help builder.
77 69
 htmlhelp_basename = '%sdoc' % project

+ 7
- 6
doc/source/install/index.rst View File

@@ -8,10 +8,6 @@ environment with Neutron server included.
8 8
 
9 9
 Perform installation configuration steps on each controller node that has a Neutron server running.
10 10
 
11
-.. note::
12
-
13
-   Installation and configuration may vary by distribution.
14
-
15 11
 .. toctree::
16 12
    :maxdepth: 2
17 13
 
@@ -21,6 +17,11 @@ Perform installation configuration steps on each controller node that has a Neut
21 17
    verify.rst
22 18
    next-steps.rst
23 19
 
24
-This chapter assumes a working setup of OpenStack that includes Neutron server following the
25
-`OpenStack Installation Tutorial <https://docs.openstack.org/project-install-guide/rocky/>`_.
20
+.. note::
21
+
22
+   Installation and configuration may vary by distribution.
23
+
24
+This chapter assumes a working setup of OpenStack that includes Neutron server.
25
+For guides to assist in installing and deploying OpenStack visit
26
+`OpenStack Docs <https://docs.openstack.org/>`_.
26 27
 

+ 2
- 2
doc/source/install/install-pip.rst View File

@@ -4,8 +4,8 @@ This section describes how to install the Networking-Ansible ML2 Driver
4 4
 in the case that a package is not available. Networking-Ansible can be
5 5
 installed from PyPI using pip.
6 6
 
7
-Install and configure components
8
---------------------------------
7
+Install components
8
+------------------
9 9
 
10 10
 #. Install the packages:
11 11
 

+ 2
- 2
doc/source/install/install-rdo.rst View File

@@ -6,8 +6,8 @@ This section describes how to install the Networking-Ansible ML2 Driver
6 6
 for Red Hat Enterprise Linux 7, Fedora, and CentOS 7.
7 7
 
8 8
 
9
-Install and configure components
10
---------------------------------
9
+Install components
10
+------------------
11 11
 
12 12
 #. Install the packages:
13 13
 

+ 2
- 2
doc/source/install/install-ubuntu.rst View File

@@ -5,8 +5,8 @@ Install for Ubuntu
5 5
 This section describes how to install the Networking-ansible ML2 Driver
6 6
 for Ubuntu 14.04 (LTS).
7 7
 
8
-Install and configure components
9
---------------------------------
8
+Install components
9
+------------------
10 10
 
11 11
 #. Install the packages:
12 12
 

+ 1
- 2
doc/source/install/next-steps.rst View File

@@ -5,5 +5,4 @@ Next steps
5 5
 
6 6
 Your OpenStack environment now includes the networking-ansible ML2 Driver.
7 7
 
8
-To add additional services, see
9
-https://docs.openstack.org/project-install-guide/rocky/.
8
+To add additional services, see https://docs.openstack.org/.

+ 35
- 1
doc/source/user/index.rst View File

@@ -2,4 +2,38 @@
2 2
 Users guide
3 3
 ===========
4 4
 
5
-Users guide of networking-ansible.
5
+Networking-Ansible is currently tested with one use case, Ironic Baremetal Guests.
6
+In this section this use case will be exercised in a set of example commands to
7
+show how end users would use ironic to provision baremetal nodes. Provisioning
8
+baremetal nodes using ironic with networking-ansible would use networking-ansible
9
+to manage the guest's switch level network configuration. Networking-Ansible is used by
10
+ironic to first assign a baremetal guest's switchport to the Ironic provisoning
11
+network to provision the baremetal guest. After provisoning, the baremetal
12
+guest's switchport is assigned to the VLAN assigned by Neutron to guest's tenant network.
13
+
14
+The example shown here mirrors a user's expereience deploying a guest with
15
+Ironic. The end user's experience using networking-ansible is via Neutron and
16
+Nova. Nova will select a baremetal node as its target when a properly configured
17
+baremetal flavor is provided to the OpenStack server create command.
18
+
19
+#. An administrator will provide Ironic node(s) that are available for
20
+   provisioning and a baremetal flavor.
21
+
22
+  .. code-block:: console
23
+
24
+    openstack baremetal node list
25
+    openstack flavor list
26
+
27
+#. Create a tenant VLAN network and subnet that uses the physical network the guest is attached to.
28
+
29
+  .. code-block:: console
30
+
31
+    openstack network create --provider-network-type vlan --provider-physical-network datacentre my-tenant-net
32
+    openstack subnet create --network tenant-net --subnet-range 192.168.3.0/24 --allocation-pool start=192.168.3.10,end=192.168.3.20 tenant-subnet
33
+
34
+#. Execute server create using the tenant network just created. This assumes
35
+   disk images and keypairs are already created and available.
36
+
37
+  .. code-block:: console
38
+
39
+    openstack server create --image a-baremetal-image --flavor baremetal --nic net-id={my-tenant-net uuid} --key-name my-keypair bm-instance

Loading…
Cancel
Save