diff options
| -rw-r--r-- | doc/index.rst | 1 | ||||
| -rw-r--r-- | doc/networking-guide.rst | 89 |
2 files changed, 90 insertions, 0 deletions
diff --git a/doc/index.rst b/doc/index.rst index ed72c05d3..c8f96d18d 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -59,6 +59,7 @@ Kolla Services swift-guide kibana-guide bifrost + networking-guide kuryr-guide Developer Docs diff --git a/doc/networking-guide.rst b/doc/networking-guide.rst new file mode 100644 index 000000000..77eacce0d --- /dev/null +++ b/doc/networking-guide.rst @@ -0,0 +1,89 @@ +.. _networking-guide: + +============================ +Enabling Neutron Extensions +============================ + +Overview +======== +Kolla deploys Neutron by default as OpenStack networking component. This guide +describes configuring and running Neutron extensions like LBaaS, +Networking-SFC, QoS, etc. + +Networking-SFC +============== + +Preparation and deployment +-------------------------- + +Modify the configuration file ``/etc/kolla/globals.yml`` and change +the following: + +:: + + neutron_plugin_agent: "sfc" + +Networking-SFC is an additional Neutron plugin. For SFC to work, this plugin +has to be installed in ``neutron-server`` container as well. Modify the +configuration file ``/etc/kolla/kolla-build.conf`` and add the following +contents: + +:: + + [neutron-server-plugin-networking-sfc] + type = git + location = https://github.com/openstack/networking-sfc.git + reference = mitaka + +Verification +------------ + +Verify the build and deploy operation of Networking-SFC container. Successful +deployment will bring up an SFC container in the list of running containers. +Run the following command to login into the ``neutron-server`` container: + +:: + + docker exec -it neutron_server bash + +Neutron should provide the following CLI extensions. + +:: + + #neutron help|grep port + + port-chain-create [port_chain] Create a Port Chain. + port-chain-delete [port_chain] Delete a given Port Chain. + port-chain-list [port_chain] List Port Chains that belong + to a given tenant. + port-chain-show [port_chain] Show information of a + given Port Chain. + port-chain-update [port_chain] Update Port Chain's + information. + port-pair-create [port_pair] Create a Port Pair. + port-pair-delete [port_pair] Delete a given Port Pair. + port-pair-group-create [port_pair_group] Create a Port Pair + Group. + port-pair-group-delete [port_pair_group] Delete a given + Port Pair Group. + port-pair-group-list [port_pair_group] List Port Pair Groups + that belongs to a given tenant. + port-pair-group-show [port_pair_group] Show information of a + given Port Pair Group. + port-pair-group-update [port_pair_group] Update Port Pair + Group's information. + port-pair-list [port_pair] List Port Pairs that belongs + to a given tenant. + port-pair-show [port_pair] Show information of a given + Port Pair. + port-pair-update [port_pair] Update Port Pair's + information. + +For setting up a testbed environment and creating a port chain, please refer +to the following link: + + https://wiki.openstack.org/wiki/Neutron/ServiceInsertionAndChaining + +For the source code, please refer to the following link: + + https://github.com/openstack/networking-sfc |