From a40da17faa6c0d2c7d2dcf43076c6a5b8491df4a Mon Sep 17 00:00:00 2001 From: Miguel Lavalle Date: Wed, 31 May 2017 14:58:39 -0500 Subject: Fix typos and other errors in documentation While reading the documentation, I found typos and other errors. This patchset fixes them. Change-Id: I2bf83a26da58845337dd77e56a8c77aa63084f2f Signed-off-by: Miguel Lavalle --- README | 2 +- docs/development/design/architecture.rst | 8 ++++---- docs/development/design/introduction.rst | 2 +- docs/development/design/usecases.rst | 2 +- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/README b/README index 04d252a4..9872f35f 100644 --- a/README +++ b/README @@ -1 +1 @@ -This code deploys the ODL-Openstack maanger. +This code deploys the ODL-Openstack manager. diff --git a/docs/development/design/architecture.rst b/docs/development/design/architecture.rst index 98520ecf..b190a18f 100644 --- a/docs/development/design/architecture.rst +++ b/docs/development/design/architecture.rst @@ -65,8 +65,8 @@ NSP (NSH Path) NSI (NSH Index) The NSI is the Hop in the Service Chain. The NSI starts at 255 and is - decremented by every SF. If the NSI reaches 0, then the packet is dropped - which avoids loop detections. + decremented by every SF. If the NSI reaches 0, then the packet is dropped, + which avoids loops. NSH also has metadata fields, but that's beyond the scope of this architecture. @@ -88,7 +88,7 @@ VNF Manager In OPNFV SFC, a VNF Manager is needed to spin-up VMs for Service Functions. It has been decided to use the OpenStack Tacker VNF Mgr to spin-up and manage -the life cylcle of the SFs. Tacker will receive the ODL SFC configuration, +the life cycle of the SFs. Tacker will receive the ODL SFC configuration, manage the SF VMs, and forward the configuration to ODL SFC. The following sequence diagram details the interactions with the VNF Mgr: @@ -105,7 +105,7 @@ The following image details the Network Topology used in OPNFV Danube SFC: OVS NSH patch workaround ++++++++++++++++++++++++ -When using NSH with VXLAN tunnels, its important that the VXLAN tunnel is +When using NSH with VXLAN tunnels, it is important that the VXLAN tunnel is terminated in the SF VM. This allows the SF to see the NSH header, allowing it to decrement the NSI and also to use the NSH metadata. When using VXLAN with OpenStack, the tunnels are not terminated in the VM, but in the "br-int" OVS diff --git a/docs/development/design/introduction.rst b/docs/development/design/introduction.rst index f7b7df76..d56eae9f 100644 --- a/docs/development/design/introduction.rst +++ b/docs/development/design/introduction.rst @@ -6,5 +6,5 @@ Introduction The `OPNFV Service Function Chaining (SFC) `_ project aims to provide the ability to define an ordered list of a network services (e.g. firewalls, NAT, QoS). -These service are then "stitched" together in the network to create a service chain. +These services are then "stitched" together in the network to create a service chain. This project provides the infrastructure to install the upstream ODL SFC implementation project in an NFV environment. diff --git a/docs/development/design/usecases.rst b/docs/development/design/usecases.rst index cc20ecea..d3562b89 100644 --- a/docs/development/design/usecases.rst +++ b/docs/development/design/usecases.rst @@ -22,6 +22,6 @@ Use Case 2 - One chain traverses two service functions ****************************************************** This use case creates two service functions, and a chain that makes the traffic -flow through both of them. More information is available in OPNFV-SFC wiki: +flow through both of them. More information is available in the OPNFV-SFC wiki: https://wiki.opnfv.org/display/sfc/Functest+SFC-ODL+-+Test+2 -- cgit 1.2.3-korg