Lijian Zhang authored Aug 23, 2022 and Liangxing Wang committed Apr 27, 2023

Only the release version of project online document [2] is accessible to
public, and the latest version link [1] is made invisible.

The online document link [0] will be redirected to the lastest release
version of document, which is the v22.06 release [2] as of now.

[0] https://dataplane-stack.docs.arm.com
[1] https://dataplane-stack.docs.arm.com/en/latest
[2] https://dataplane-stack.docs.arm.com/en/nw-ds-2022.06.30/



Signed-off-by: Lijian Zhang <Lijian.Zhang@arm.com>
Reviewed-by: Yefeng Lin <Yefeng.Lin@arm.com>
Reviewed-by: Liangxing Wang <Liangxing.Wang@arm.com>
Change-Id: I4e40e83c9b03d82773706c03560b66c3d5bc80ea

Tianyu Li authored Mar 03, 2023 and Liangxing Wang committed Apr 27, 2023

Update DPDK version to v22.11
Update VPP version to v23.02

Signed-off-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Lijian Zhang <Lijian.Zhang@arm.com>
Reviewed-by: Yefeng Lin <Yefeng.Lin@arm.com>

Change-Id: I0e776d773737a0eb3317ed813962513abd336ba6

Tianyu Li authored Mar 01, 2023 and Liangxing Wang committed Apr 27, 2023

Use Mellanox DPDK driver in VPP quickstart and user guide due to
stabilty issue in native rdma driver.

Signed-off-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Lijian Zhang <lijian.zhang@arm.com>
Reviewed-by: Liangxing Wang <liangxing.wang@arm.com>
Change-Id: Id2df226965244941216ceb33ae2c4027904d8bc7

Yefeng Lin authored Nov 25, 2022 and Liangxing Wang committed Apr 27, 2023

- Add vpp L2 switching case setup scripts
- Add vpp L2 switching case guide
- Support for DPDK and memif interface

Signed-off-by: Yefeng Lin <yefeng.lin@arm.com>
Signed-off-by: Liangxing Wang <liangxing.wang@arm.com>
Reviewed-by: Nathan Brown <nathan.brown@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>

Change-Id: I24ddbee77541a508c6b2804e1308aa6f59235a46

Yefeng Lin authored Feb 10, 2023 and Liangxing Wang committed Apr 27, 2023

license-check logic is extended to parse and understand
multiple copyright years other than the current year.

Signed-off-by: Yefeng Lin <yefeng.lin@arm.com>
Reviewed-by: Liangxing Wang <liangxing.wang@arm.com>
Reviewed-by: Nathan Brown <nathan.brown@arm.com>

Change-Id: If9f6de4af096302cb2f45664f8140cb5a98e77c8

Nathan Brown authored Feb 21, 2023 and Liangxing Wang committed Apr 18, 2023

Sphinx inserts a period at end of Copyright section. This causes the
copyright section to be published as "Arm Limited..". Removing this
period fixes this to "Arm Limited."

Signed-off-by: Nathan Brown <nathan.brown@arm.com>
Reviewed-by: Liangxing Wang <liangxing.wang@arm.com>
Change-Id: I22d229f383668e51483a59dfdd4e0b342abf3bab

- Keep "Feedback and Support" section consistent in README.md and
overview.rst.
- Remove support@arm.com, as customer support is not available yet by
Customer Support team.
- Replace 'Fast Model' with more formal 'Fixed Virtual Platforms', and
update the architecture diagram accordingly.
- Mention software traffic generator support in the future.

Signed-off-by: Lijian Zhang <Lijian.Zhang@arm.com>
Reviewed-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Willen Yang <Willen.Yang@arm.com>

Change-Id: I6c8028343c37bed292756713f460d19886c11b30

- Update the changelog & release note per release note review guidance and
referencing on other projects' best practice.

Signed-off-by: Lijian Zhang <Lijian.Zhang@arm.com>
Reviewed-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Willen Yang <Willen.Yang@arm.com>

Change-Id: Iee60e5f8fa8304340c083ed08a300e14fc413945

Jieqiang Wang authored Jun 13, 2022 and Tianyu Li committed Jun 14, 2022

Fix typo and unify headers in README.md

Signed-off-by: Jieqiang Wang <jieqiang.wang@arm.com>
Reviewed-by: Lijian Zhang <lijian.zhang@arm.com>
Reviewed-by: Tianyu Li <tianyu.li@arm.com>

Change-Id: I3e237662ea091d6679f8f660c4e683f359190256

Signed-off-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Lijian Zhang <Lijian.Zhang@arm.com>
Reviewed-by: Jieqiang Wang <Jieqiang.Wang@arm.com>

Change-Id: I720d4b3cd6561ddddbdd6f705c0758fbc5dfea74

Jieqiang Wang authored Jun 06, 2022 and Lijian Zhang committed Jun 09, 2022

Fix typo and improve sentence readability in documentation.

Signed-off-by: Jieqiang Wang <jieqiang.wang@arm.com>
Reviewed-by: Lijian Zhang <lijian.zhang@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>

Change-Id: I06ce3bb3527a8d924035f2bc0abfc8194111f92f

OFED driver has to be installed and then NIC firmware is required to be
updated if running solution in a fresh installed environment.

Signed-off-by: Lijian Zhang <Lijian.Zhang@arm.com>
Reviewed-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>

Change-Id: If1544549e6f24382fc9f17d27750c1a2d450215e

Updated the validated kernel and gcc version in quickstart guide.

Signed-off-by: Lijian Zhang <Lijian.Zhang@arm.com>
Reviewed-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>

Change-Id: I18020997196df12be67a20e62f9c4ceffdfd460b

Tianyu Li authored Jun 06, 2022 and Lijian Zhang committed Jun 09, 2022

The instructions provided for VPP use the native
driver's RDMA interface. These instructions work with
Mellanox NICs only. Add note that clarifies this
limitation.

Signed-off-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Lijian Zhang <Lijian.Zhang@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>

Change-Id: I0233398c2d93003175ef75ec519be78fe22eb91f

Jieqiang Wang authored Jun 06, 2022 and Lijian Zhang committed Jun 09, 2022

The Mellanox NICs do not need binding to Linux driver.
Make this notice prominent to the users.

Signed-off-by: Jieqiang Wang <jieqiang.wang@arm.com>
Reviewed-by: Lijian Zhang <lijian.zhang@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>

Change-Id: I484257f4a2e1ce44177f1966db52b3acb57cf2b7

Jieqiang Wang authored Jun 06, 2022 and Lijian Zhang committed Jun 09, 2022

Add note to inform users compilation of dataplane-stack might take some
time.

Signed-off-by: Jieqiang Wang <jieqiang.wang@arm.com>
Reviewed-by: Lijian Zhang <lijian.zhang@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>

Change-Id: I127a736d953469b9b47fec6f34b321238f1f61f4

build directory was created to store intermediate files during
compilation or solution execution. As it's not used and removed, so
update the document accordingly.

Signed-off-by: Lijian Zhang <Lijian.Zhang@arm.com>
Reviewed-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>

Change-Id: Icc280e0ec5a67a7a4fc6315cea921166f865c7fb

Tianyu Li authored Jun 06, 2022 and Lijian Zhang committed Jun 09, 2022

IXIA traffic generator is not part of the release.
The solution does not limit the traffic generator to IXIA only,
and will support any traffic generators available to end users.

Signed-off-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Lijian Zhang <Lijian.Zhang@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>

Change-Id: I208a76a3dfd071120e95b28c4520fb9abc04c59e

Nathan Brown authored May 23, 2022 and Lijian Zhang committed Jun 09, 2022

Change backup of grub settings from /etc/default/grubbak to
/etc/default/grub.bak.

Signed-off-by: Nathan Brown <nathan.brown@arm.com>
Suggested-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
Reviewed-by: Lijian Zhang <Lijian.Zhang@arm.com>

Change-Id: Ib5f1f2e838d459b9767409f42fc0b6c7a05a5515

Joyce Kong authored Jun 06, 2022 and Lijian Zhang committed Jun 09, 2022

Use active voice than passive voice for shorter
and more objective description if possible.

Signed-off-by: Joyce Kong <joyce.kong@arm.com>
Reviewed-by: Lijian Zhang <lijian.zhang@arm.com>

Change-Id: I07d1d90fff2992e030e22e6be178c2778b1ffd74

Joyce Kong authored Jun 06, 2022 and Lijian Zhang committed Jun 09, 2022

Modify the sentences with past tense, progressive
tense or future tense to present tense for more
objective description if possible.

Signed-off-by: Joyce Kong <joyce.kong@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>

Change-Id: I499e906e152c46ff356a521df3a08a7d3bd66733

Joyce Kong authored Jun 06, 2022 and Lijian Zhang committed Jun 09, 2022

Unify the phrase form for titles in the same level.

Signed-off-by: Joyce Kong <joyce.kong@arm.com>
Reviewed-by: Lijian Zhang <lijian.zhang@arm.com>

Change-Id: Ia1917b6357eb85924d9807f97c4b0a35a2a7e093

Tianyu Li authored Jun 06, 2022 and Lijian Zhang committed Jun 09, 2022

Remove IPv6 related description to be consistent between DPDK and VPP.
Full support for IPv6 feature will be added in later release.

Signed-off-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Lijian Zhang <Lijian.Zhang@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>

Change-Id: Ib6a5d578c3140e1458ae5eac7f15d20abd7e4e95

Joyce Kong authored Jun 07, 2022 and Lijian Zhang committed Jun 09, 2022

For dataplane solution architecture figure,
- Remove deliverables.
- Change the colors.
- Add title below the figure.

Signed-off-by: Joyce Kong <joyce.kong@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>

Change-Id: I4150db29b7d3e855996c0c36ad05e4cb2eec4097

The Q2 release version will be v22.06.
The unnecessary links to document files are removed.

Signed-off-by: Lijian Zhang <Lijian.Zhang@arm.com>
Reviewed-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>

Change-Id: I337c4941095f861fe7d2fe9c7556dfbae229f19e

'set -x' prints shell commands and their arguments as they are executed
which makes the output of setup.sh too verbose to follow, so disable the
verbose output for end users to capture critical messages more easily.

Signed-off-by: Lijian Zhang <Lijian.Zhang@arm.com>
Reviewed-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>

Change-Id: Ie5c012e88603d4989fa46e4788d32265630e55a0

The git-repo has to be installed manually because repo installed via
apt-get has issues on Ubuntu.
Updated the utilities required if running solution on a fresh installed
environment.

Signed-off-by: Lijian Zhang <Lijian.Zhang@arm.com>
Reviewed-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>

Change-Id: I9591181a77cea5239091835da61295fb4269fef3

The solution use cases are validated on Ampere Altra and Ubuntu 20.04
platform, so limit the supported platforms to Ampere Altra only.

Signed-off-by: Lijian Zhang <Lijian.Zhang@arm.com>
Reviewed-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>

Change-Id: Ib88ce3a773911617d7c8e85dbef84c1e35dcd5ab

Briefly decribe what VPP IPv4 L3fwd is and how it works in user guide.

Signed-off-by: Lijian Zhang <Lijian.Zhang@arm.com>
Reviewed-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>

Change-Id: I63928fe07db4b773b5249764bb034c95c8ebf576

Tianyu Li authored Jun 06, 2022 and Lijian Zhang committed Jun 09, 2022

Signed-off-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Lijian Zhang <Lijian.Zhang@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>

Change-Id: I18dc47f95add24a9102083171000d1ba8ab679b9

Tianyu Li authored Jun 01, 2022 and Lijian Zhang committed Jun 09, 2022

Add ARP entry to resolve MAC address for next hop,
no longer depends on traffic generator's ARP reply.

Signed-off-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>

Change-Id: I77860bce9677a33d010a2748005fde6f49409269

Tianyu Li authored May 17, 2022 and Lijian Zhang committed Jun 09, 2022

- Remove unused section
- Add steps on setup and build
- Validate ip route entry
- Add extra port guide
- Add links to support other types of NIC
- Add advanced instructions

Signed-off-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Nathan Brown <nathan.brown@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
Reviewed-by: Lijian Zhang <Lijian.Zhang@arm.com>

Change-Id: Ieb4ae759aa6dcaf1d6b6b2ee9a27862a3719bacb

Nathan Brown authored May 11, 2022 and Lijian Zhang committed Jun 09, 2022

Add following sections to the common user guide section:
- Download code
- Configure DUT
- Build
- Reboot.

Add the following sections to the DPDK user guide:
- Examples for commands to run other than quickstart provided command
- Validating with traffic flow
- Instructions on RSS
- Instructions on modifying default forwarding rules for FIB/EM/LPM
- Add Resources section
- Include multiple drop-down sections for further details
- Apply more consistent formatting
- Remove pronoun usage

Signed-off-by: Nathan Brown <nathan.brown@arm.com>
Signed-off-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
Reviewed-by: Lijian Zhang <Lijian.Zhang@arm.com>
Reviewed-by: Tianyu Li <Tianyu.Li@arm.com>

Change-Id: Ia46ddc88f4b1050f48ce35a84be44ed1a6ea3c9d

Honnappa Nagarahalli authored May 26, 2022 and Lijian Zhang committed Jun 09, 2022

Make the description of the DPDK devbind script in stop section of the
l3fwd application consistent with bind section.

Signed-off-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
Reviewed-by: Lijian Zhang <lijian.zhang@arm.com>
Reviewed-by: Nathan Brown <nathan.brown@arm.com>

Change-Id: I622ec304a19c26f3fc8a096ea338ac7e889ac43e

Tianyu Li authored May 30, 2022 and Lijian Zhang committed Jun 09, 2022

VPP version 22.02 has a known issue and doesn't support invoke with
relative path without './'.
Add './' to invoke VPP with relative path in the quickstart guide.

Signed-off-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
Reviewed-by: Lijian Zhang <Lijian.Zhang@arm.com>

Change-Id: Ibcc96bd0e7df7ced96367e10067bd40abb2b5db5

Honnappa Nagarahalli authored May 26, 2022 and Lijian Zhang committed Jun 09, 2022

When VPP boots up, it displays warnings about unsupported PCI devices
and errors about plugins which are not loaded by default. There might
be other errors which can be ignored safely for the use cases
in quick start guide.

Signed-off-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
Signed-off-by: Lijian Zhang <lijian.zhang@arm.com>
Reviewed-by: Lijian Zhang <lijian.zhang@arm.com>

Change-Id: Idd3d302641bcae14a5b81268706c45a38b9e6414

Honnappa Nagarahalli authored May 26, 2022 and Lijian Zhang committed Jun 09, 2022

Prefix sudo to commands that need root privileges. This is more accurate
and improves user experience.

Signed-off-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
Reviewed-by: Lijian Zhang <lijian.zhang@arm.com>
Reviewed-by: Nathan Brown <nathan.brown@arm.com>
Reviewed-by: Tianyu Li <tianyu.li@arm.com>

Change-Id: I1c480ab1ccb9cdb0a1f7ab04016908bb4968e7dc

Add information on expected end users and their skills.
Improve DUT hardware and software requirements.
Add reference to changelog.

Signed-off-by: Lijian Zhang <Lijian.Zhang@arm.com>
Reviewed-by: Nathan Brown <Nathan.Brown@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>

Change-Id: Iafe47541833bd12adedbbcfc2381fa64f311d900

Nathan Brown authored May 20, 2022 and Lijian Zhang committed Jun 09, 2022

This commit cleans up multiple things in the quickstart
guide. Notably, it:
    - applies consistent formatting
    - applies consistent naming
    - rearranges some headings and their levels
    - improves phrasing of certain sections for clarity and brevity
    - keeps setup.sh echos consistent with quickstart guide
    - has setup.sh install lshw package in case user does not have it
      installed

Signed-off-by: Nathan Brown <nathan.brown@arm.com>
Reviewed-by: Lijian Zhang <lijian.zhang@arm.com>
Reviewed-by: Tianyu Li <tianyu.li@arm.com>

Change-Id: I951e94fae5d580d9b816321b6b809dc36e451ee9

Nathan Brown authored May 13, 2022 and Lijian Zhang committed Jun 09, 2022

Adds explanation of dpdk-devbind.py to quickstart guide.
Also fixes minor formatting issue in quickstart guide.

Signed-off-by: Nathan Brown <nathan.brown@arm.com>
Reviewed-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
Reviewed-by: Lijian Zhang <lijian.zhang@arm.com>

Change-Id: I1a8b96f791367ccbdfb0c0146e242b06aa9f8516