Skip to content

docs: add Disruptoor walkthrough example matching README - #1493

Open
imitater-dou wants to merge 1 commit into
ethpandaops:mainfrom
imitater-dou:docs-readme-disruptoor-path-20261002
Open

imitater-dou wants to merge 1 commit into
ethpandaops:mainfrom
imitater-dou:docs-readme-disruptoor-path-20261002

Conversation

@imitater-dou

@imitater-dou imitater-dou commented Oct 2, 2026 •

Copy link
Copy Markdown

Summary

The README Disruptoor section already links to .github/tests/examples/disruptoor.yaml, but that file was missing (404). The earlier path retarget to .github/tests/disruptoor.yaml fixed the 404, but that CI config is a participants_matrix (1 EL × 2 CLs × count: 4 → 8 participants) with [el, cl] partitions/shaping and no port_publisher.additional_services, so it does not match the walkthrough.

This change keeps the README path and adds an opt-in example that matches the documented two-node walkthrough.

Example contents

  • 2 participants (geth/lighthouse)
  • additional_services: dora, disruptoor
  • port_publisher.additional_services.enabled: true
  • CL-only partition between participants 1 and 2
  • Shaping on participant 1 with components: all, delay: 50ms, jitter: 10ms, include_control: true

Repro

  1. Before: curl -sI https://raw.githubusercontent.com/ethpandaops/ethereum-package/main/.github/tests/examples/disruptoor.yaml → 404
  2. After merge: same URL → 200, and the file matches the README Disruptoor section

Verification

  • Compared against README Disruptoor prose (two-node, CL partition, components: all shaping, port publisher)
  • Confirmed components: all is accepted by src/disruptoor/disruptoor_launcher.star (get_components)
  • Left .github/tests/disruptoor.yaml untouched for CI

Osraka commented Oct 12, 2026

Copy link
Copy Markdown

The path fix is correct, but the target config does not match the surrounding walkthrough. In .github/tests/disruptoor.yaml, participants_matrix expands to 1 EL × 2 CLs × count: 4 = 8 participants, not a two-node network. Both partitioning and shaping target [el, cl], not CL-only / all, and the config has no port_publisher.additional_services. Once the link works, the documented command would launch a materially larger network than the prose suggests. Could we either point this section at a separate small example, or update the walkthrough to describe this CI config accurately? I checked the matrix expansion in src/package_io/input_parser.star; I could not run Kurtosis locally.

Add .github/tests/examples/disruptoor.yaml so the README Disruptoor
section points at a real two-node config (CL partition + node-1 shaping,
Dora, port_publisher.additional_services) instead of the larger CI
matrix under .github/tests/disruptoor.yaml.

Signed-off-by: ADou <ikun3.1415927@gmail.com>
@imitater-dou
imitater-dou force-pushed the docs-readme-disruptoor-path-20261002 branch from b689146 to 2bcc702 Compare October 14, 2026 07:11
@imitater-dou imitater-dou changed the title docs: fix Disruptoor example path in README docs: add Disruptoor walkthrough example matching README Oct 14, 2026
@imitater-dou

Copy link
Copy Markdown
Author

Thanks @Osraka — updated to add .github/tests/examples/disruptoor.yaml as a small two-node walkthrough example (CL partition, components: all shaping, Dora, port_publisher.additional_services) and keep the README path pointed at that file instead of the larger CI matrix under .github/tests/disruptoor.yaml.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants