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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

- 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

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

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

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

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

- 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

- 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

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

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

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

- 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

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

- 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

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

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

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

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

There is actually no valid information in the 'design' section, so just
remove this part from the project document.

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

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