README.md

NDN-DPDK Activation Sample

This is a Node.js application that generates activation parameters for NDN-DPDK service.

• fw-args.ts: forwarder activation parameters.
• gen-args.ts: traffic generator activation parameters.
• gen-config.ts: traffic generator activation parameters.
• fileserver-args.ts: file server activation parameters.

Usage

1. Make a copy of this directory to somewhere outside the NDN-DPDK repository.
2. Run corepack pnpm install to install dependencies.
3. Open the directory in Visual Studio Code or some other editor that recognizes TypeScript definitions. If the NDN-DPDK installation is on a remote machine, you may use the Remote-SSH plugin.
4. Open a .ts file in the editor, and make changes. The editor can provide hints on available options.
5. Run corepack pnpm typecheck to verify your arguments conform to the TypeScript definitions.
6. Run corepack pnpm -s start [filename] | jq to see the JSON document.
7. Run corepack pnpm -s start [filename] | ndndpdk-ctrl [subcommand] to send the activation command to NDN-DPDK.

Available Samples

Forwarder: activate with fw-args.ts

corepack pnpm -s start fw-args.ts | ndndpdk-ctrl activate-forwarder

Traffic generator: activate with gen-args.ts, use traffic pattern in gen-config.ts

corepack pnpm -s start gen-args.ts | ndndpdk-ctrl activate-trafficgen
corepack pnpm -s start gen-config.ts | ndndpdk-ctrl start-trafficgen

File server: activate with fileserver-args.ts

corepack pnpm -s start fileserver-args.ts | ndndpdk-ctrl activate-fileserver