vac roadmap dst update

Signed-off-by: ksr <kaiserd@users.noreply.github.com>
This commit is contained in:
ksr 2023-09-09 16:05:22 +02:00
parent 2a68cdd357
commit a31d0c83c7
37 changed files with 972 additions and 19 deletions

View File

@ -0,0 +1,25 @@
# DST
mkdir -p dst/wakurtosis/waku && touch $_/techreport.md
mkdir -p dst/wakurtosis/waku && touch $_/techreport_02.md
mkdir -p dst/wakurtosis/waku && touch $_/gossipsub-topology-analysis.md
mkdir -p dst/wakurtosis/waku && touch $_/features.md
mkdir -p dst/wakurtosis/vac && touch $_/rlog.md
mkdir -p dst/wakurtosis/vac && touch $_/retrospective-rlog.md
mkdir -p dst/wakurtosis/nomos && touch $_/ci-integration.md
mkdir -p dst/wakurtosis/vac && touch $_/maintenance.md
mkdir -p dst/analysis/nomos && touch $_/nomos-simulation-analysis.md
mkdir -p dst/analysis-gsub-model/vac && touch $_/refactoring.md
mkdir -p dst/analysis-gsub-model/status && touch $_/control-messages.md
mkdir -p dst/analysis-shadow/vac && touch $_/shadow-gossipsub-analysis.md
mkdir -p dst/analysis-shadow/waku && touch $_/shadow-waku-relay-analysis.md
mkdir -p dst/eng/vac && touch $_/bundle-simulation-data.md
mkdir -p dst/eng-10ktool/vac && touch $_/bandwidth.md
mkdir -p dst/eng-10ktool/waku && touch $_/waku-protocols.md
mkdir -p dst/software-testing/waku && touch $_/test-plans.md
mkdir -p dst/software-testing/waku && touch $_/test-automation-js-waku.md
mkdir -p dst/software-testing/waku && touch $_/test-automation-nwaku.md
mkdir -p dst/software-testing/waku && touch $_/test-automation-go-waku.md
mkdir -p dst/software-testing/waku && touch $_/interop-testing.md

View File

@ -0,0 +1,43 @@
---
title: "Control Messages"
---
## `vac:dst:analysis-gsub-model:status:control-messages`
---
```mermaid
%%{
init: {
'theme': 'base',
'themeVariables': {
'primaryColor': '#BB2528',
'primaryTextColor': '#fff',
'primaryBorderColor': '#7C0000',
'lineColor': '#F8B229',
'secondaryColor': '#006100',
'tertiaryColor': '#fff'
}
}
}%%
gantt
tickInterval 1month
dateFormat YYYY-MM-DD
section Status
Control Messages: 2023-07-01, 2023-09-15
```
- status: 85%
- CC: Ganesh
### Description
### Justification
### Info
* delayed because of extending Nomos analysis milestone
### Deliverables

View File

@ -0,0 +1,40 @@
---
title: "Refactoring"
---
## `vac:dst:analysis-gsub-model:vac:refactoring`
---
```mermaid
%%{
init: {
'theme': 'base',
'themeVariables': {
'primaryColor': '#BB2528',
'primaryTextColor': '#fff',
'primaryBorderColor': '#7C0000',
'lineColor': '#F8B229',
'secondaryColor': '#006100',
'tertiaryColor': '#fff'
}
}
}%%
gantt
tickInterval 1month
dateFormat YYYY-MM-DD
section Status
Refactoring: 2023-08-01, 2023-09-30
```
- status: 40%
- CC: Ganesh
### Description
### Justification
### Deliverables

View File

@ -0,0 +1,40 @@
---
title: "Basic Shadow Simulation"
---
## `vac:dst:analysis-shadow:vac:basic-shadow-simulation`
---
```mermaid
%%{
init: {
'theme': 'base',
'themeVariables': {
'primaryColor': '#BB2528',
'primaryTextColor': '#fff',
'primaryBorderColor': '#7C0000',
'lineColor': '#F8B229',
'secondaryColor': '#006100',
'tertiaryColor': '#fff'
}
}
}%%
gantt
tickInterval 1month
dateFormat YYYY-MM-DD
section Status
Basic Shadow Simulation: 2023-08-01, 2023-08-31
```
- status: 40%
- CC: Jordi
### Description
### Justification
### Deliverables

View File

@ -0,0 +1,44 @@
---
title: "Shadow Gossipsub Analysis"
---
## `vac:dst:analysis-shadow:vac:shadow-gossipsub-analysis`
---
```mermaid
%%{
init: {
'theme': 'base',
'themeVariables': {
'primaryColor': '#BB2528',
'primaryTextColor': '#fff',
'primaryBorderColor': '#7C0000',
'lineColor': '#F8B229',
'secondaryColor': '#006100',
'tertiaryColor': '#fff'
}
}
}%%
gantt
tickInterval 1month
dateFormat YYYY-MM-DD
section Status
Shadow Gossipsub Analysis: 2023-09-01, 2023-10-31
```
- status: 0%
- CC: Jordi
### Description
* develop a gossipsub node with allows to set desired message rates and other properties
* try to get to a higher node number (50k?)
* research log post
### Justification
### Deliverables

View File

@ -0,0 +1,40 @@
---
title: "Shadow Waku Relay Analysis"
---
## `vac:dst:analysis-shadow:waku:shadow-waku-relay-analysis`
---
```mermaid
%%{
init: {
'theme': 'base',
'themeVariables': {
'primaryColor': '#BB2528',
'primaryTextColor': '#fff',
'primaryBorderColor': '#7C0000',
'lineColor': '#F8B229',
'secondaryColor': '#006100',
'tertiaryColor': '#fff'
}
}
}%%
gantt
tickInterval 1month
dateFormat YYYY-MM-DD
section Status
Shadow Waku Relay Analysis: done, 2023-10-01, 2023-11-30
```
- status: 0%
- CC: Jordi
### Description
### Justification
### Deliverables

View File

@ -0,0 +1,48 @@
---
title: "Simulation Analysis"
---
## `vac:dst:analysis:nomos:simulation-analysis`
---
```mermaid
%%{
init: {
'theme': 'base',
'themeVariables': {
'primaryColor': '#BB2528',
'primaryTextColor': '#fff',
'primaryBorderColor': '#7C0000',
'lineColor': '#F8B229',
'secondaryColor': '#006100',
'tertiaryColor': '#fff'
}
}
}%%
gantt
tickInterval 1month
dateFormat YYYY-MM-DD
section Status
Simulation Analysis: 2023-08-01, 2023-09-15
```
- status: 70%
- CC: Ganesh
### Description
### Justification
### Info
Extended:
* include signature aggregation into analysis
* write analysis section in Carnot paper
* [nomos node](https://github.com/logos-co/nomos-node)
* [nomos simulations](https://github.com/logos-co/nomos-simulations)
### Deliverables

View File

@ -0,0 +1,44 @@
---
title: "Bandwidth Test"
---
## `vac:dst:eng-10ktool:vac:bandwidth`
---
```mermaid
%%{
init: {
'theme': 'base',
'themeVariables': {
'primaryColor': '#BB2528',
'primaryTextColor': '#fff',
'primaryBorderColor': '#7C0000',
'lineColor': '#F8B229',
'secondaryColor': '#006100',
'tertiaryColor': '#fff'
}
}
}%%
gantt
tickInterval 1month
dateFormat YYYY-MM-DD
section Status
Bandwidth Test: 2023-08-01, 2023-10-31
```
- status: 20%
- CC: Alberto
### Description
A first version of tool that allows running >10k gossipsub / waku relay nodes.
The tool should measure bandwidth usage per node and bundle the simulation data for analaysis.
### Justification
### Deliverables
* https://github.com/vacp2p/cs-codex-dist-tests

View File

@ -0,0 +1,41 @@
---
title: "QoS"
---
## `vac:dst:eng-10ktool:vac:qos`
---
```mermaid
%%{
init: {
'theme': 'base',
'themeVariables': {
'primaryColor': '#BB2528',
'primaryTextColor': '#fff',
'primaryBorderColor': '#7C0000',
'lineColor': '#F8B229',
'secondaryColor': '#006100',
'tertiaryColor': '#fff'
}
}
}%%
gantt
tickInterval 1month
dateFormat YYYY-MM-DD
section Status
QoS 10ktool: 2023-11-01, 2023-12-31
```
- status: 0%
- CC: Alberto
### Description
Add QoS parameter support to the 10k tool.
### Justification
### Deliverables

View File

@ -0,0 +1,48 @@
---
title: "Waku Protocols"
---
## `vac:dst:eng-10ktool:waku:waku-protocols`
---
```mermaid
%%{
init: {
'theme': 'base',
'themeVariables': {
'primaryColor': '#BB2528',
'primaryTextColor': '#fff',
'primaryBorderColor': '#7C0000',
'lineColor': '#F8B229',
'secondaryColor': '#006100',
'tertiaryColor': '#fff'
}
}
}%%
gantt
tickInterval 1month
dateFormat YYYY-MM-DD
section Status
Waku Protocols: 2023-11-01, 2023-12-31
```
- status: 0%
- CC: Alberto
### Description
So far, we tested gossip / relay, as well as discv5.
This milestone comprises running further Waku protocols, namely:
* filter
* lightpush
* store
* peer exchange
### Justification
### Deliverables

View File

@ -0,0 +1,20 @@
---
title: "Bundle Simulation Data"
---
## `vac:acz:rlnp2p:waku:production-readiness`
---
- status: ongoing
- CC:
### Description
The Vac DST engineering team runs simulations, bundles the resulting data, and delivers.
### Justification
### Deliverables

View File

@ -23,38 +23,35 @@ lastmod: 2023-09-08
### `analysis::`
* [[ roadmap/vac/dst/analysis/g/nomos/nomos-simulation-analysis | nomos-simulation-analysis ]]
* [[ roadmap/vac/dst/analysis/nomos/nomos-simulation-analysis | simulation-analysis ]]
### `analysis:gsub-model`
* [[ roadmap/vac/dst/analysis/gsub-model/vac/refactoring | refactoring ]]
* [[ roadmap/vac/dst/analysis/gsub-model/status/control-messages | control-messages ]]
* [[ roadmap/vac/dst/analysis-gsub-model/vac/refactoring | refactoring ]]
* [[ roadmap/vac/dst/analysis-gsub-model/status/control-messages | control-messages ]]
### `analysis:shadow:`
* [[ roadmap/vac/dst/analysis/shadow/vac/shadow-basic-simulation | shadow-basic-simulation ]]
* [[ roadmap/vac/dst/analysis/shadow/vac/shadow-gossipsub-analysis | shadow-gossipsub-analysis ]]
* [[ roadmap/vac/dst/analysis/shadow/waku/shadow-waku-relay-analysis | shadow-waku-relay-analysis ]]
* [[ roadmap/vac/dst/analysis-shadow/vac/shadow-basic-simulation | shadow-basic-simulation ]]
* [[ roadmap/vac/dst/analysis-shadow/vac/shadow-gossipsub-analysis | shadow-gossipsub-analysis ]]
* [[ roadmap/vac/dst/analysis-shadow/waku/shadow-waku-relay-analysis | shadow-waku-relay-analysis ]]
### `eng::`
* [[ roadmap/vac/dst/eng/g/vac/bundle-simulation-data | bundle-simulation-data ]]
* [[ roadmap/vac/dst/eng/vac/bundle-simulation-data | bundle-simulation-data ]]
### `eng:10ksim:`
* [[ roadmap/vac/dst/eng/10ktool/vac/bandwidth | bandwidth-test ]]
* [[ roadmap/vac/dst/eng/10ktool/vac/bandwidth | QoS ]]
* [[ roadmap/vac/dst/eng/10ktool/waku/waku-protocols | waku-protocols ]]
* [[ roadmap/vac/dst/eng-10ktool/vac/bandwidth-test | bandwidth-test ]]
* [[ roadmap/vac/dst/eng-10ktool/vac/qos | QoS ]]
* [[ roadmap/vac/dst/eng-10ktool/waku/waku-protocols | waku-protocols ]]
### `software-testing:test-plans`
### `software-testing:waku`
* [[ roadmap/vac/dst/software-testing/g/waku/test-plans | test-plans ]]
### `software-testing:test-automation`
* [[ roadmap/vac/dst/software-testing/test-automation/waku/js-waku | js-waku ]]
* [[ roadmap/vac/dst/software-testing/test-automation/waku/nwaku | nwaku ]]
* [[ roadmap/vac/dst/software-testing/test-automation/waku/go-waku | go-waku ]]
* [[ roadmap/vac/dst/software-testing/test-automation/waku/interop-testing | interop-testing ]]
* [[ roadmap/vac/dst/software-testing/waku/test-plans | test-plans ]]
* [[ roadmap/vac/dst/software-testing/waku/js-waku | test-automation-js-waku ]]
* [[ roadmap/vac/dst/software-testing/waku/nwaku | test-automation-nwaku ]]
* [[ roadmap/vac/dst/software-testing/waku/go-waku | test-automation-go-waku ]]
* [[ roadmap/vac/dst/software-testing/waku/interop-testing | interop-testing ]]

View File

@ -0,0 +1,42 @@
---
title: "Interop Testing"
---
## `vac:dst:software-testing:waku:interop-testing`
---
```mermaid
%%{
init: {
'theme': 'base',
'themeVariables': {
'primaryColor': '#BB2528',
'primaryTextColor': '#fff',
'primaryBorderColor': '#7C0000',
'lineColor': '#F8B229',
'secondaryColor': '#006100',
'tertiaryColor': '#fff'
}
}
}%%
gantt
tickInterval 1month
dateFormat YYYY-MM-DD
section Status
Interop Testing: 2023-09-01, 2024-02-29
```
- status: 0%
- CC: Florin, Alex, Roman
### Description
* filter nwaku service node + js waku client node (t, Florin)
* nwaku <> go-waku interop (t, Alex)
### Justification
### Deliverables

View File

@ -0,0 +1,48 @@
---
title: "Test Automation go-waku"
---
## `vac:dst:software-testing:waku:test-automation-go-waku`
---
```mermaid
%%{
init: {
'theme': 'base',
'themeVariables': {
'primaryColor': '#BB2528',
'primaryTextColor': '#fff',
'primaryBorderColor': '#7C0000',
'lineColor': '#F8B229',
'secondaryColor': '#006100',
'tertiaryColor': '#fff'
}
}
}%%
gantt
tickInterval 1month
dateFormat YYYY-MM-DD
section Status
Test Automation go-waku: 2023-10-01, 2024-02-29
```
- status: 0%
- CC: Roman
### Description
* filter (t) ← first group of tests added in PR to JS waku
* lightpush (t)
* store (t)
* relay
* peer exchange
* discv5
* peer & connection management
* CI integration
### Justification
### Deliverables

View File

@ -0,0 +1,52 @@
---
title: "Test Automation js-waku"
---
## `vac:dst:software-testing:waku:test-automation-js-waku`
---
```mermaid
%%{
init: {
'theme': 'base',
'themeVariables': {
'primaryColor': '#BB2528',
'primaryTextColor': '#fff',
'primaryBorderColor': '#7C0000',
'lineColor': '#F8B229',
'secondaryColor': '#006100',
'tertiaryColor': '#fff'
}
}
}%%
gantt
tickInterval 1month
dateFormat YYYY-MM-DD
section Status
Test Automation js-waku: 2023-09-15, 2024-02-29
```
- status: 10%
- CC: Florin
### Description
* filter (t) ← first group of tests added in PR to JS waku
* lightpush (t)
* store (t)
* relay
* peer exchange
* discv5
* peer & connection management
* CI integration
* Interoperability (t)
Additional requirements:
It should be possible to choose the nwaku version the js waku test use (done via github actions inputs)
### Justification
### Deliverables

View File

@ -0,0 +1,40 @@
---
title: "Test Automation nwaku"
---
## `vac:dst:software-testing:waku:test-automation-nwaku`
---
```mermaid
%%{
init: {
'theme': 'base',
'themeVariables': {
'primaryColor': '#BB2528',
'primaryTextColor': '#fff',
'primaryBorderColor': '#7C0000',
'lineColor': '#F8B229',
'secondaryColor': '#006100',
'tertiaryColor': '#fff'
}
}
}%%
gantt
tickInterval 1month
dateFormat YYYY-MM-DD
section Status
Test Automation nwaku: 2023-09-15, 2024-02-29
```
- status: 0%
- CC: Alex
### Description
### Justification
### Deliverables

View File

@ -0,0 +1,53 @@
---
title: "Test Plans"
---
## `vac:dst:software-testing:waku:test-plans`
---
```mermaid
%%{
init: {
'theme': 'base',
'themeVariables': {
'primaryColor': '#BB2528',
'primaryTextColor': '#fff',
'primaryBorderColor': '#7C0000',
'lineColor': '#F8B229',
'secondaryColor': '#006100',
'tertiaryColor': '#fff'
}
}
}%%
gantt
tickInterval 1month
dateFormat YYYY-MM-DD
section Status
Test Plans: 2023-09-01, 2024-02-29
```
- status: 15%
- CC: Florin
### Description
unit + integration test
(contains actually understanding the protocols, critically engage with the protocols)
(instruct the engineer)
* filter (t)
* lightpush (t)
* store (t)
* relay ()
* peer exchange
* discv5
* peer & connection management
* interoperability (t, starting)
* simulation plans
### Justification
### Deliverables
* [test plans](https://www.notion.so/Waku-2b93b558eb3b4de482c45babb8581a2b)

View File

@ -0,0 +1,49 @@
---
title: "CI Integration"
---
## `vac:dst:wakurtosis:nomos:ci-integration`
---
```mermaid
%%{
init: {
'theme': 'base',
'themeVariables': {
'primaryColor': '#BB2528',
'primaryTextColor': '#fff',
'primaryBorderColor': '#7C0000',
'lineColor': '#F8B229',
'secondaryColor': '#006100',
'tertiaryColor': '#fff'
}
}
}%%
gantt
tickInterval 1month
dateFormat YYYY-MM-DD
section Status
CI Integration: done, 2023-07-01, 2023-07-31
```
- status: 100%
- CC: Alberto
### Description
Add Nomos integration to wakurtosis so Nomos can be also used in it.
### Justification
Nomos is under constant developmet.
With this integration, each time a change is done, a continuous integration test is done, making sure the consensus protocol works properly with a few nodes.
### Info
We stopped working on a follow up milestone since we deprecated Wakurtosis in favour of our new 10ktool.
### Deliverables
* first version of Nomos CI integration (https://github.com/vacp2p/wakurtosis/pull/141)

View File

@ -0,0 +1,46 @@
---
title: "Wakurtosis Maintenance"
---
## `vac:dst:wakurtosis:vac:wakurtosis-maintenance`
---
```mermaid
%%{
init: {
'theme': 'base',
'themeVariables': {
'primaryColor': '#BB2528',
'primaryTextColor': '#fff',
'primaryBorderColor': '#7C0000',
'lineColor': '#F8B229',
'secondaryColor': '#006100',
'tertiaryColor': '#fff'
}
}
}%%
gantt
tickInterval 1month
dateFormat YYYY-MM-DD
section Status
Wakurtosis Maintenance: done, 2023-01-01, 2023-08-31
```
- status: 100%
- CC: Alberto
### Description
Keep up to date the tool if there are crashing changes in the services that are being used in it (Waku, Nomos…)
### Justification
Services being used are in constant change, thus it can lead wakurtosis to break.
### Info
* Wakurtosis is deprecated. We do not actively maintain it anymore.
### Deliverables

View File

@ -0,0 +1,45 @@
---
title: "Rlog: Wakurtosis Retrospective"
---
## `vac:dst:wakurtosis:waku:retrospective-rlog`
---
```mermaid
%%{
init: {
'theme': 'base',
'themeVariables': {
'primaryColor': '#BB2528',
'primaryTextColor': '#fff',
'primaryBorderColor': '#7C0000',
'lineColor': '#F8B229',
'secondaryColor': '#006100',
'tertiaryColor': '#fff'
}
}
}%%
gantt
tickInterval 1month
dateFormat YYYY-MM-DD
section Status
Wakurtosis Retrospective: 2023-08-01, 2023-09-30
```
- status: 20%
- CC: Jordi
### Description
Research log discussing what would we have needed from Wakurtosis to make it work for us beyond our smaller solution.
Why did we decide to drop Kurtosis and work towards a Kubernetes-based solution now.
### Justification
### Info
* [Alberto's Opinion](https://www.notion.so/Alberto-s-Opinion-5f1af38a2e274f42baad0e322629f3a9)
### Deliverables

View File

@ -0,0 +1,45 @@
---
title: "Wakurtosis Rlog"
---
## `vac:dst:wakurtosis:waku:rlog`
---
```mermaid
%%{
init: {
'theme': 'base',
'themeVariables': {
'primaryColor': '#BB2528',
'primaryTextColor': '#fff',
'primaryBorderColor': '#7C0000',
'lineColor': '#F8B229',
'secondaryColor': '#006100',
'tertiaryColor': '#fff'
}
}
}%%
gantt
tickInterval 1month
dateFormat YYYY-MM-DD
section Status
Rlog Wakurtosis: 2023-06-01, 2023-08-31
```
- status: 90%
- CC: Jordi
### Description
Research log post based on the Wakurtosis tech reports and addendum.
### Justification
### Info
* delayed because of holidays / other prios
### Deliverables

View File

@ -0,0 +1,43 @@
---
title: "Wakurtosis Features"
---
## `vac:dst:wakurtosis:waku:wakurtosis-features`
---
```mermaid
%%{
init: {
'theme': 'base',
'themeVariables': {
'primaryColor': '#BB2528',
'primaryTextColor': '#fff',
'primaryBorderColor': '#7C0000',
'lineColor': '#F8B229',
'secondaryColor': '#006100',
'tertiaryColor': '#fff'
}
}
}%%
gantt
tickInterval 1month
dateFormat YYYY-MM-DD
section Status
Wakurtosis Features: done, 2023-04-01, 2023-07-31
```
- status: 100%
- CC: Alberto
### Description
* Features requested by Waku for the simulations done in wakurtosis (e.g. discv5 support).
### Justification
* Discv5 is an important protocol to test. Also, we should be able to work with offline data once the simulation is finished.
### Deliverables

View File

@ -0,0 +1,60 @@
---
title: "Gossipsub Topology Analysis"
---
## `vac:dst:wakurtosis:waku:gossipsub-topology-analysis`
---
```mermaid
%%{
init: {
'theme': 'base',
'themeVariables': {
'primaryColor': '#BB2528',
'primaryTextColor': '#fff',
'primaryBorderColor': '#7C0000',
'lineColor': '#F8B229',
'secondaryColor': '#006100',
'tertiaryColor': '#fff'
}
}
}%%
gantt
tickInterval 1month
dateFormat YYYY-MM-DD
section Status
Gossipsub Topology Analysis: 2023-07-01, 2023-10-15
```
- status: 60%
- CC: Ganesh
### Description
Analysis of the topology of a gossipsub topic mesh.
Comprises:
* research log post
* shadow integration
* Logos research call talk; also get input during the discussion regarding which areas we should go deeper into, and what would help Logos projects the most.
### Info
Extended deadline because:
* added research log post to the milestone goals + more analysis goals (e.g stability/dynamics)
* added analysing simple gossipsub node (in addition to Waku relay)
- Relevant data has to be collected on the gossipsub-layer which increased the complexity of this milestone
* shadow integration
* more focus on nomos simulation analysis + extended analysis
Note: This analysis module will be usable outside of Wakurtosis, too.
This is the reason we continue on this milestone, even though Wakurtosis is deprecated now.
### Justification
### Deliverables