Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add diagrams to NAT Traversal tests #388

Closed
11 tasks done
emmacasolin opened this issue Jun 24, 2022 · 4 comments · Fixed by #441
Closed
11 tasks done

Add diagrams to NAT Traversal tests #388

emmacasolin opened this issue Jun 24, 2022 · 4 comments · Fixed by #441
Assignees
@tegefaulkes
Labels
documentation Improvements or additions to documentation procedure Action that must be executed r&d:polykey:core activity 4 End to End Networking behind Consumer NAT Devices

Comments

@emmacasolin
Copy link
Contributor

emmacasolin commented Jun 24, 2022 •
edited
Loading

Specification

The NAT traversal tests are complex and rely on many utility functions, making it difficult to know what is happening in these tests. It would be helpful to have diagrams at the top of each test showing the architecture of the namespaces and agents involved in each test.

Diagrams needed:

  • DMZ
    • Agent 1 (DMZ) -> Agent 2 (DMZ)
    • Agent 1 (DMZ) -> Seed Node -> Agent 2 (DMZ)
  • Endpoint-independent mapping (EIM)
    • Agent 1 (EIM) -> Agent 2 (DMZ)
    • Agent 1 (DMZ) -> Agent 2 (EIM)
    • Agent 1 (EIM) -> Agent 2 (EIM)
    • Agent 1 (EIM) -> Seed Node -> Agent 2 (EIM)
    • Agent 1 (EIM) -> Seed Node -> Agent 2 (EDM)
  • Endpoint-dependent mapping (EDM)
    • Agent 1 (EDM) -> Agent 2 (DMZ)
    • Agent 1 (DMZ) -> Agent 2 (EDM)
    • Agent 1 (EDM) -> Seed Node -> Agent 2 (EDM)
    • Agent 1 (EDM) -> Seed Node -> Agent 2 (EIM)

Additional context

Tasks

  1. Create diagrams for each of the NAT tests using ASCII flow
  2. Modify test descriptions where necessary to make them clearer
@emmacasolin emmacasolin added the development Standard development label Jun 24, 2022
@emmacasolin emmacasolin self-assigned this Jun 24, 2022
emmacasolin added a commit that referenced this issue Jun 24, 2022
@emmacasolin
feat: added diagrams to DMZ tests
72e3296 
#388
tegefaulkes pushed a commit that referenced this issue Jun 24, 2022
@emmacasolin @tegefaulkes
feat: added diagrams to DMZ tests
856388b 
#388
@CMCDragonkai CMCDragonkai added procedure Action that must be executed and removed development Standard development labels Jun 28, 2022
@CMCDragonkai
Copy link
Member

This is a procedure, not development.

@CMCDragonkai
Copy link
Member

I think you've already done some of this in 856388b. What more is there to do? You should list out the tasks here.

@teebirdy teebirdy added the r&d:polykey:core activity 4 End to End Networking behind Consumer NAT Devices label Jul 24, 2022
@CMCDragonkai CMCDragonkai added the documentation Improvements or additions to documentation label Jul 29, 2022
This was referenced Dec 8, 2023
Closed
Merged
@emmacasolin
Copy link
Contributor Author

Remaining diagrams are all being added in #441

@CMCDragonkai
Copy link
Member

Awesome, please keep doing the diagrams as you are doing your testnet tests too.

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

@tegefaulkes tegefaulkes

Labels
documentation Improvements or additions to documentation procedure Action that must be executed r&d:polykey:core activity 4 End to End Networking behind Consumer NAT Devices
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Integration tests for testnet.polykey.io MatrixAI/Polykey
4 participants
@CMCDragonkai @tegefaulkes @emmacasolin @teebirdy