[dpdk-dev,v2,2/2] doc/guides: updated testpmd app user guide for vxlan/nvgre encap/decap

  Updated the testpmd user guide documentation with how to used new action
types RTE_FLOW_ACTION_VXLAN_ENCAP, RTE_FLOW_ACTION_VXLAN_DECAP,
RTE_FLOW_ACTION_NVGRE_ENCAP, RTE_FLOW_ACTION_NVGRE_DECAP capabilities.

Signed-off-by: Mohammad Abdul Awal <mohammad.abdul.awal@intel.com>
---
 doc/guides/testpmd_app_ug/testpmd_funcs.rst | 50 +++++++++++++++++++++++++++++
 1 file changed, 50 insertions(+)
  

Hi Awal,

> -----Original Message-----
> From: Awal, Mohammad Abdul
> Sent: Friday, May 11, 2018 6:14 PM
> To: dev@dpdk.org; Iremonger, Bernard <bernard.iremonger@intel.com>;
> adrien.mazarguil@6wind.com
> Subject: [PATCH v2 2/2] doc/guides: updated testpmd app user guide for
> vxlan/nvgre encap/decap
> 
> Updated the testpmd user guide documentation with how to used new action

Typo, "used" in line above should be "use".

> types RTE_FLOW_ACTION_VXLAN_ENCAP, RTE_FLOW_ACTION_VXLAN_DECAP,
> RTE_FLOW_ACTION_NVGRE_ENCAP, RTE_FLOW_ACTION_NVGRE_DECAP
> capabilities.
> 
> Signed-off-by: Mohammad Abdul Awal <mohammad.abdul.awal@intel.com>
> ---
>  doc/guides/testpmd_app_ug/testpmd_funcs.rst | 50
> +++++++++++++++++++++++++++++
>  1 file changed, 50 insertions(+)
> 
> diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> index 542c217..6ee3ff3 100644
> --- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> +++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> @@ -3559,6 +3559,56 @@ This section lists supported actions and their
> attributes, if any.
> 
>    - ``ethertype``: Ethertype.
> 
> +- ``vxlan_encap``: encapsulate the inner flow with pattern of headers
> +  according to RFC7348.
> +
> +  - ``eth_dst {MAC-48}``: outer ether destination.
> +
> +  - ``eth_src {MAC-48}``: outer ether source.
> +
> +  - ``eth_type {unsigned}``: outer ether type.
> +
> +  - ``vlan_tci {unsigned}``: outer vlan tci.
> +
> +  - ``ipv4_dst {ipv4 address}``: outer ipv4 destination.
> +
> +  - ``ipv4_src {ipv4 address}``: outer ipv4 source.
> +
> +  - ``ipv4_proto {unsigned}``: outer ipv4 proto.
> +
> +  - ``udp_dst {unsigned}``: outer udp destination.
> +
> +  - ``udp_src {unsigned}``: outer udp source.
> +
> +  - ``vxlan_vni {unsigned}``: outer vxlan vni.
> +
> +  - ``end``: outer vxlan header pattern end.
> +
> +- ``vxlan_decap``: decapsulate the vxlan tunnel flow according to RFC7348.
> +
> +- ``nvgre_encap``: encapsulate the inner flow with pattern of headers
> +  according to RFC7637.
> +
> +  - ``eth_dst {MAC-48}``: outer ether destination.
> +
> +  - ``eth_src {MAC-48}``: outer ether source.
> +
> +  - ``eth_type {unsigned}``: outer ether type.
> +
> +  - ``vlan_tci {unsigned}``: outer vlan tci.
> +
> +  - ``ipv4_dst {ipv4 address}``: outer ipv4 destination.
> +
> +  - ``ipv4_src {ipv4 address}``: outer ipv4 source.
> +
> +  - ``ipv4_proto {unsigned}``: outer ipv4 proto.
> +
> +  - ``nvgre_vsni {unsigned}``: outer nvgre vsni.
> +
> +  - ``end``: outer nvgre header pattern end.
> +
> +- ``nvgre_decap``: decapsulate the nvgre tunnel flow according to RFC7637.
> +
>  Destroying flow rules
>  ~~~~~~~~~~~~~~~~~~~~~

I see that section 4.14.1 has been updated to document the syntax of the encap and decap actions, which look fine. 
However my comment on the v1 patch about adding some sample encap and decap rules has not been addressed.
My understanding is, that it is a two stage process where the tunnel endpoint flow is created first and the encapsulated flow is then created, this is not obvious from the syntax description section.
I think it would be useful to add some sample flows after section 4.12.8
> 
> --
> 2.7.4
  

On 14/05/2018 11:35, Iremonger, Bernard wrote:
> Hi Awal,
>
>> -----Original Message-----
>> From: Awal, Mohammad Abdul
>> Sent: Friday, May 11, 2018 6:14 PM
>> To: dev@dpdk.org; Iremonger, Bernard <bernard.iremonger@intel.com>;
>> adrien.mazarguil@6wind.com
>> Subject: [PATCH v2 2/2] doc/guides: updated testpmd app user guide for
>> vxlan/nvgre encap/decap
>>
>> Updated the testpmd user guide documentation with how to used new action
> Typo, "used" in line above should be "use".
Will fix.
>
>> types RTE_FLOW_ACTION_VXLAN_ENCAP, RTE_FLOW_ACTION_VXLAN_DECAP,
>> RTE_FLOW_ACTION_NVGRE_ENCAP, RTE_FLOW_ACTION_NVGRE_DECAP
>> capabilities.
>>
>> Signed-off-by: Mohammad Abdul Awal <mohammad.abdul.awal@intel.com>
>> ---
>>   doc/guides/testpmd_app_ug/testpmd_funcs.rst | 50
>> +++++++++++++++++++++++++++++
>>   1 file changed, 50 insertions(+)
>>
>> diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
>> b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
>> index 542c217..6ee3ff3 100644
>> --- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
>> +++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
>> @@ -3559,6 +3559,56 @@ This section lists supported actions and their
>> attributes, if any.
>>
>>     - ``ethertype``: Ethertype.
>>
>> +- ``vxlan_encap``: encapsulate the inner flow with pattern of headers
>> +  according to RFC7348.
>> +
>> +  - ``eth_dst {MAC-48}``: outer ether destination.
>> +
>> +  - ``eth_src {MAC-48}``: outer ether source.
>> +
>> +  - ``eth_type {unsigned}``: outer ether type.
>> +
>> +  - ``vlan_tci {unsigned}``: outer vlan tci.
>> +
>> +  - ``ipv4_dst {ipv4 address}``: outer ipv4 destination.
>> +
>> +  - ``ipv4_src {ipv4 address}``: outer ipv4 source.
>> +
>> +  - ``ipv4_proto {unsigned}``: outer ipv4 proto.
>> +
>> +  - ``udp_dst {unsigned}``: outer udp destination.
>> +
>> +  - ``udp_src {unsigned}``: outer udp source.
>> +
>> +  - ``vxlan_vni {unsigned}``: outer vxlan vni.
>> +
>> +  - ``end``: outer vxlan header pattern end.
>> +
>> +- ``vxlan_decap``: decapsulate the vxlan tunnel flow according to RFC7348.
>> +
>> +- ``nvgre_encap``: encapsulate the inner flow with pattern of headers
>> +  according to RFC7637.
>> +
>> +  - ``eth_dst {MAC-48}``: outer ether destination.
>> +
>> +  - ``eth_src {MAC-48}``: outer ether source.
>> +
>> +  - ``eth_type {unsigned}``: outer ether type.
>> +
>> +  - ``vlan_tci {unsigned}``: outer vlan tci.
>> +
>> +  - ``ipv4_dst {ipv4 address}``: outer ipv4 destination.
>> +
>> +  - ``ipv4_src {ipv4 address}``: outer ipv4 source.
>> +
>> +  - ``ipv4_proto {unsigned}``: outer ipv4 proto.
>> +
>> +  - ``nvgre_vsni {unsigned}``: outer nvgre vsni.
>> +
>> +  - ``end``: outer nvgre header pattern end.
>> +
>> +- ``nvgre_decap``: decapsulate the nvgre tunnel flow according to RFC7637.
>> +
>>   Destroying flow rules
>>   ~~~~~~~~~~~~~~~~~~~~~
> I see that section 4.14.1 has been updated to document the syntax of the encap and decap actions, which look fine.
> However my comment on the v1 patch about adding some sample encap and decap rules has not been addressed.
> My understanding is, that it is a two stage process where the tunnel endpoint flow is created first and the encapsulated flow is then created, this is not obvious from the syntax description section.
> I think it would be useful to add some sample flows after section 4.12.8
The two stage process may be a PMD implementation specific. Since we do 
not have any underlying hw yet to exploit the tunnel API, adding a 
specific example will make user more confused. Using the above 
description will enable a user to create a flow to take into account 
nvgre/vxlan encap decap actions.

>> --
>> 2.7.4
  

On 5/14/2018 4:42 PM, Mohammad Abdul Awal wrote:
> 
> 
> On 14/05/2018 11:35, Iremonger, Bernard wrote:
>> Hi Awal,
>>
>>> -----Original Message-----
>>> From: Awal, Mohammad Abdul
>>> Sent: Friday, May 11, 2018 6:14 PM
>>> To: dev@dpdk.org; Iremonger, Bernard <bernard.iremonger@intel.com>;
>>> adrien.mazarguil@6wind.com
>>> Subject: [PATCH v2 2/2] doc/guides: updated testpmd app user guide for
>>> vxlan/nvgre encap/decap
>>>
>>> Updated the testpmd user guide documentation with how to used new action
>> Typo, "used" in line above should be "use".
> Will fix.

Hi Awal,

If this is the only change I can fix this while merging. Are you planning a new
version of the set?
  

On 6/14/2018 6:14 PM, Ferruh Yigit wrote:
> On 5/14/2018 4:42 PM, Mohammad Abdul Awal wrote:
>>
>>
>> On 14/05/2018 11:35, Iremonger, Bernard wrote:
>>> Hi Awal,
>>>
>>>> -----Original Message-----
>>>> From: Awal, Mohammad Abdul
>>>> Sent: Friday, May 11, 2018 6:14 PM
>>>> To: dev@dpdk.org; Iremonger, Bernard <bernard.iremonger@intel.com>;
>>>> adrien.mazarguil@6wind.com
>>>> Subject: [PATCH v2 2/2] doc/guides: updated testpmd app user guide for
>>>> vxlan/nvgre encap/decap
>>>>
>>>> Updated the testpmd user guide documentation with how to used new action
>>> Typo, "used" in line above should be "use".
>> Will fix.
> 
> Hi Awal,
> 
> If this is the only change I can fix this while merging. Are you planning a new
> version of the set?

I just recognized that Nelio has a set that replaces this one:
https://dpdk.org/dev/patchwork/patch/41144/
https://dpdk.org/dev/patchwork/patch/41145/

Are you OK to continue with above patches and mark this set as superseded?
  

Hi Ferruh,


On 14/06/2018 18:19, Ferruh Yigit wrote:
> On 6/14/2018 6:14 PM, Ferruh Yigit wrote:
>> On 5/14/2018 4:42 PM, Mohammad Abdul Awal wrote:
>>>
>>> On 14/05/2018 11:35, Iremonger, Bernard wrote:
>>>> Hi Awal,
>>>>
>>>>> -----Original Message-----
>>>>> From: Awal, Mohammad Abdul
>>>>> Sent: Friday, May 11, 2018 6:14 PM
>>>>> To: dev@dpdk.org; Iremonger, Bernard <bernard.iremonger@intel.com>;
>>>>> adrien.mazarguil@6wind.com
>>>>> Subject: [PATCH v2 2/2] doc/guides: updated testpmd app user guide for
>>>>> vxlan/nvgre encap/decap
>>>>>
>>>>> Updated the testpmd user guide documentation with how to used new action
>>>> Typo, "used" in line above should be "use".
>>> Will fix.
>> Hi Awal,
>>
>> If this is the only change I can fix this while merging. Are you planning a new
>> version of the set?
> I just recognized that Nelio has a set that replaces this one:
> https://dpdk.org/dev/patchwork/patch/41144/
> https://dpdk.org/dev/patchwork/patch/41145/
>
> Are you OK to continue with above patches and mark this set as superseded?
I am OK marking my patches to be superseded by Neilo's patchset.