Commits · 03d16baae825e311526a89fda77165fb924e370d · Arm Reference Solutions / dataplane-stack

May 06, 2023

docs: adjust copyright year of README.md · 03d16baa

Yefeng Lin authored May 04, 2023



Copyright (c) 2022 replace with  Copyright (c) 2022-2023

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

Change-Id: I084397cc0f06ac802aae20ff60518ccc9f23885a

03d16baa

Apr 29, 2023

docs: update release tag for 23.05 release · 5ee63a0c

Liangxing Wang authored Apr 28, 2023 and

Liangxing Wang committed Apr 29, 2023



Update release tag for dataplane-stack 23.05 release in quick start
guide and user guide.

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

5ee63a0c

Apr 28, 2023

scripts: add distro version check in setup.sh · 72adc124

Yefeng Lin authored Apr 27, 2023



Check the distro that a user is using before
proceeding to 'apt-get install'.

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: I043428a331e9a78299de5b2a0bf984041582c958

72adc124

changelog: add dataplane stack v23.05 release note · cef6a27b

Liangxing Wang authored Apr 18, 2023 and

Liangxing Wang committed Apr 28, 2023



Add dataplane-stack 23.05 release note.

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

cef6a27b

scripts: resolve shell static analysis issues · 007645d3

Liangxing Wang authored Apr 26, 2023 and

Liangxing Wang committed Apr 28, 2023



Resolve some double quote and variable printf issues reported
by shell static analysis.

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

007645d3

Apr 27, 2023

docs: resolve some typos and adjust sentences structure · d152470a

Yefeng Lin authored Apr 24, 2023 and

Liangxing Wang committed Apr 27, 2023



- Fix some typos in docs
- Adjust sentences structure
- Update words list

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: I2dbe98237c618719eedf36d4a11cc4e92e6a26d9

d152470a

tools: resolve Python static analysis issues · 5f2b9709

Liangxing Wang authored Apr 26, 2023



Resolve space and indentation issues reported by Python static analysis.

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

Change-Id: I95a051123ed5de06727190c0b99052f9febffcba

5f2b9709

docs: update maintainer info · 79ecdc2e

Yefeng Lin authored Apr 25, 2023 and

Liangxing Wang committed Apr 27, 2023



- Update maintainer email to dataplane-stack@arm.com
- Update MAINTAINERS descriptions

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: I9051018cef09293076179a8bc9969eca1f4beb4f

79ecdc2e

doc: correct spellcheck and misspellings · 857411cd

Nathan Brown authored Apr 21, 2023 and

Liangxing Wang committed Apr 27, 2023



Documentation spellcheck reported a handful of misspelled words. Many
were false positives, and were added to the allowlist. Any spelling
mistakes have been corrected.

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

857411cd

doc: add FAQ instructions on specific firmware install · 4de7ab99

Nathan Brown authored Apr 21, 2023 and

Liangxing Wang committed Apr 27, 2023



FAQ instructions used to inform user how to install the latest firmware
version for their NIC. End user may want to install a particular
version, so add steps detailing how to do so.

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

4de7ab99

scripts: resolve shellcheck warnings · d943d527

Yefeng Lin authored Apr 24, 2023 and

Liangxing Wang committed Apr 27, 2023



Export vpp_binary and vppctl_binary variables before being referenced.

Signed-off-by: Yefeng Lin <yefeng.lin@arm.com>
Reviewed-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Liangxing Wang <liangxing.wang@arm.com>

Change-Id: Ie90f3aed87e4589e82a4903648e81e895f482598

d943d527

scripts: remove extra NUL at the end of iperf3 pidfile · 96c25ef0

Yefeng Lin authored Apr 21, 2023 and

Liangxing Wang committed Apr 27, 2023



There is an extra NUL(\0) byte at the end of pidfile
due to iperf3 bug. When stop iperf3 server by pidfile
will raise warning:
command substitution: ignored null byte in input.

Signed-off-by: Yefeng Lin <yefeng.lin@arm.com>
Reviewed-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Nathan Brown <nathan.brown@arm.com>

Change-Id: I51228fa20304087d69e9d44c0a4238a3c21e1b7e

96c25ef0

docs: update version and copyright year · e22f4086

Yefeng Lin authored Apr 21, 2023 and

Liangxing Wang committed Apr 27, 2023



- Update release version to 23.05
- Update copyright year to 2022-2023

Signed-off-by: Yefeng Lin <yefeng.lin@arm.com>
Reviewed-by: Liangxing Wang <liangxing.wang@arm.com>
Reviewed-by: Tianyu Li <tianyu.li@arm.com>
Change-Id: Ic9e5a1891f92fad1884284b372c2eecaf67e658c

e22f4086

scripts: improve scripts for use cases · 541d3f5a

Yefeng Lin authored Apr 12, 2023 and

Liangxing Wang committed Apr 27, 2023



- Limit VPP's worker threads to use a single CPU core.
- Cleanup VPP instance if interface set up failed.
- Stop process of VPP and nginx by pid.
- Fix some typos.

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: Ib47c8150d93f865b38b71ad6b9357d607caab445

541d3f5a

docs: warn user of auto-started NGINX service · 2686f582

Liangxing Wang authored Apr 19, 2023



NGINX systemd service will be started automatically after NGINX
package is installed in setup.sh. Provide a note for end user to
be aware of this behavior and stop it.

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

2686f582

doc: increase required CPUs for DUT · 5c223575

Nathan Brown authored Apr 18, 2023 and

Liangxing Wang committed Apr 27, 2023



Setup script requires at least 5 CPUs on the DUT. Update the
documentation to reflect this.

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

5c223575

docs: remove mention of FPGA emulators · 4f1f0368

Nathan Brown authored Apr 14, 2023 and

Liangxing Wang committed Apr 27, 2023



Remove from both overview and FAQ entries.
Update solution architecture image.

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

Change-Id: I48fecfe66914d03e8df3b65a9bb27e2d426cabf6

4f1f0368

docs: remove DUT kernel version with broken link · 4f321e45

Liangxing Wang authored Apr 14, 2023



The DUT kernel version link is broken. Actually users don't need
to use specific kernel version to run dataplane stack.

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

4f321e45

docs: improve routed IP address within VPP L3fwd user guide · 58a157e2

Liangxing Wang authored Apr 17, 2023



Change routed IP address from 10.0.0.0/32 to 10.0.0.1/32 for
consistency with "show ip fib" output and better understanding.

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

58a157e2

docs: improve minor issues within VPP L3fwd user guide · 923d74c4

Nathan Brown authored Apr 14, 2023 and

Liangxing Wang committed Apr 27, 2023



- Provide missing command before sample output
- Improve syntax highlighting
- Provide missing ip neighbor command for suggested experiment

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

923d74c4

docs: update overview for next release · b4d11fe8

Nathan Brown authored Apr 14, 2023 and

Liangxing Wang committed Apr 27, 2023



Update overview section to include information on new features and
updates to repository structure.

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

b4d11fe8

usecase: ssl proxy server node should not require VPP · 80dc0858

Nathan Brown authored Apr 14, 2023 and

Liangxing Wang committed Apr 27, 2023



SSL Proxy user guide suggests end user uses the script to run the nginx
server. The script assumes VPP is built within the dataplane-stack repo.
However, when running the script on a non-DUT node, the user may not
have built VPP yet, as it is not needed.

So, the script breaks when the end user runs it as suggested on the
server node.

This updates the script to only require VPP to be built if the script is
running the nginx server in VPP loopback mode.

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

80dc0858

doc: replace --help with -h · 43381177

Yefeng Lin authored Apr 17, 2023 and

Liangxing Wang committed Apr 27, 2023



The scripts display help information by -h parameter, so
need to replace --help in the documentation with -h.

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

Change-Id: Iaa8babe7e74d423b768adb79ec9fe22b7096422a

43381177

doc: update quickstart guide syntax highlighting · 47675937

Nathan Brown authored Apr 14, 2023 and

Liangxing Wang committed Apr 27, 2023



Use shell syntax highlighting where appropriate in the Quickstart guide
for consistent syntax highlighting across our documentation.

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

Change-Id: Iecaaffb397cbd2e5d3db4d0d3e41c284f6c7b54e

47675937

docs: improve minor issues within DPDK L3fwd user guide · 5973a38f

Liangxing Wang authored Apr 17, 2023



- Improve syntax highlighting
- Remove unused MLNX_OFED Software Download link.

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

5973a38f

doc: warn user of ~ usage · 463ef02b

Nathan Brown authored Apr 14, 2023 and

Liangxing Wang committed Apr 27, 2023



Using ~ inside path variables (like LDP_PATH) will be expanded as the
root user, rather than the user who set the variable. This causes ~ to
refer to the root user's home directory, which is likely not the end
user's intention.

Provide a note on this behavior so end user can avoid using ~.

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

463ef02b

doc: update paths in various user guide · eddd0094

Nathan Brown authored Apr 14, 2023 and

Liangxing Wang committed Apr 27, 2023



SSL Proxy and TCP Termination user guides had references to
"<nw_ds_workspace>/usecase", which should be
"<nw_ds_workspace>/dataplane-stack/usecase".

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

eddd0094

doc: update title in L2 switching user guide · f034483d

Nathan Brown authored Apr 14, 2023 and

Liangxing Wang committed Apr 27, 2023



Other use cases use "Ethernet Connection" as the section tite, so update
L2 switching to be consistent.

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

f034483d

patches: add a VPP patch to resolve build issue · 3dac3992

Liangxing Wang authored Apr 14, 2023

0001-build-replace-phony-target.patch is just a cherry-pick of [1] to
resolve VPP build issue on some platforms. [1] was already merged in VPP
master branch, but not included in VPP v23.02 release used by
dataplane-stack. This patch will be removed once VPP version in
dataplane-stack is bumped.

[1]: https://gerrit.fd.io/r/c/vpp/+/38349



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

3dac3992

docs: import Sphinx Tabs extension · dfefff82

Liangxing Wang authored Apr 11, 2023



- Import Sphinx Tabs extension.
- Use Sphinx tabs to describe wrk2 building on non-DUT node.

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

dfefff82

docs/scripts: adapt to change in wrk2 code management · 56b3f892

Liangxing Wang authored Apr 10, 2023



- Add make target for traffic generator tools, e.g., wrk2.
- Update SSL reverse proxy user guide and test script to use wrk2
  built via repo manifest method.

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

56b3f892

docs: resolve issues in docs · 6eaacd7e

Yefeng Lin authored Apr 07, 2023 and

Liangxing Wang committed Apr 27, 2023



- Disable DPDK plugin in VPP for software traffic generator
  in L2 switching.
- Enclose the configuration of the software traffic generator
  in double quotes.
- Fix path errors of SSL reverse proxy guide.

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

Change-Id: I28bce61caa23cb966bf8ab299149c359447bd2ff

6eaacd7e

scripts: correct log output and fixed some typos · a336bf1d

Yefeng Lin authored Apr 04, 2023 and

Liangxing Wang committed Apr 27, 2023



- Optimize the log for check-path failure
- Fixed some typos in the scripts

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

a336bf1d

docs: adjust the python venv create and clean · 2a5d0150

Yefeng Lin authored Mar 28, 2023 and

Liangxing Wang committed Apr 27, 2023



- Update pip requirements when the doc/requirements.txt
  is newer than the venv.
- Remove python venv at make doc-clean.
- Replace make with $(MAKE) to recursively call the make command

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

Change-Id: I8457d2fe51d26760dacf97c9bd106ebe5d5bacec

2a5d0150

docs: resolve sphinx spelling check warnings · e09b955c

Liangxing Wang authored Apr 03, 2023



- Fix some spelling errors in docs.
- Update words list for sphinx spelling check.

Signed-off-by: Liangxing Wang <liangxing.wang@arm.com>
Reviewed-by: Nathan Brown <nathan.brown@arm.com>
Reviewed-by: Lijian Zhang <lijian.zhang@arm.com>
Change-Id: I18f9aa3be6c7b60f2cbefc17f9b4248cd9f76d6c

e09b955c

docs/usecase: disable dpdk plugin in vpp for some cases · 8a70fbbf

Liangxing Wang authored Apr 03, 2023



Disable DPDK plugin in VPP for memif and loopback connections to
skip DPDK interfaces enumeration.

Signed-off-by: Liangxing Wang <liangxing.wang@arm.com>
Reviewed-by: Yefeng Lin <yefeng.lin@arm.com>
Change-Id: I277af443e5b4167af5cbcaee972bd0273c78caa8

8a70fbbf

docs/usecase: add ssl reverse proxy usecase · 06fe7e08

Liangxing Wang authored Mar 24, 2023



- Add SSL reverse proxy case setup scripts
- Add SSL reverse proxy case guide
- Support for loopback and interfaces

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

Change-Id: I273d609acfb9602a21f98a143043f17d1a486f38

06fe7e08

docs: add sphinx spelling check · 277e594b

Liangxing Wang authored Mar 30, 2023



Add make target and initial wordlist for sphinx spelling check.

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

277e594b

docs: correct punctuation · fdae377d

Nathan Brown authored Mar 28, 2023 and

Liangxing Wang committed Apr 27, 2023



When introducing a bullet list of links, use a colon instead of a
comma.

Signed-off-by: Nathan Brown <nathan.brown@arm.com>
Reviewed-by: Lijian Zhang <Lijian.Zhang@arm.com>
Change-Id: I6cd2f266285a39c90fb31f381f54c446bbd03ccb

fdae377d

docs/usecase: add tcp termination usecase · 42dfffdc

Yefeng Lin authored Feb 02, 2023 and

Liangxing Wang committed Apr 27, 2023



- Add tcp_term case setup scripts
- Add tcp_term case guide
- Support for DPDK and loopback 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: I3603614cc6a781f735cad5993f26ea2d8659f4da

42dfffdc