wakurtosis/README.md

Wakurtosis
=====================
Starting version for Waku network simulations (https://github.com/waku-org/pm/issues/2)

More info about Kurtosis: https://docs.kurtosis.com/

### How to use:

#### Before using this repository note that: 

- **You are using Kurtosis version 0.70.2**. This is important, as they are working on it and changes can be huge depending on different versions. You can find all Kurtosis versions [here](https://github.com/kurtosis-tech/kurtosis-cli-release-artifacts/releases).
- The topology files that will be used by default are defined in `config/topology_generated/`. This topology is created with the [gennet](gennet-module/Readme.md) module.
- Kurtosis can set up services in a parallel manner, defined in the `config.json` file (see below).
- Only `kurtosis` and `docker` are needed to run this.

#### How to run

From the root of the repo run:

`./build.sh`

`./run.sh <measurement_infra> [enclave_name] [config_file]` 

There are 4 different measurements: `cadvisor`, `dstats`, `host-proc`, `container-proc`. The other parameters are optional.

By default, the enclave name is `wakurtosis` and the config file is in `config/config.json`. 

#### JSON main configuration file options

These are arguments that can be modified:

- _prng_seed_: int. Seed to reproduce results.
- _enclave_name_: string. Default: **wakurtosis**. Defines the name of the Kurtosis enclave being created.
- _topology_path_: string. Topology information that will be read.
- _jobs_: int. Defines how many services will be instantiated at the same time.
- _interconnect_nodes_: It allows to skip the interconnection phase of the topology.
- _interconnection_batch_: int. If nodes are being connected by a given topology, this tells kurtosis how many connections will try to set up in the same node at a time. Used to avoid timeouts if a node has a lot of connections.

- [Gennet](gennet-module/Readme.md) module configuration
- [WLS](wls-module/README.md) module configuration
Modified readme 2022-12-12 15:48:26 +00:00			`Wakurtosis`
Initial commit 2022-10-13 16:46:01 +00:00			`=====================`
Modified readme 2022-12-12 15:48:26 +00:00			`Starting version for Waku network simulations (https://github.com/waku-org/pm/issues/2)`

Refactor (#18) * Modified configuration files and added example of list of topics into general configuration * Refactored main.star into different star files * Deleted unnecesary files from previous module * Moved and changed .star files * Moved config files * Added parser and small topology as file * Updated README.md * Modified imports to have them in a more clean structure. * Removed unnecessary information in topology files * Number of Test messages and delay between message added as variable * Updated README.md 2022-12-23 12:21:42 +00:00			`More info about Kurtosis: https://docs.kurtosis.com/`
Modified readme 2022-12-12 15:48:26 +00:00
			`### How to use:`

Refactor (#18) * Modified configuration files and added example of list of topics into general configuration * Refactored main.star into different star files * Deleted unnecesary files from previous module * Moved and changed .star files * Moved config files * Added parser and small topology as file * Updated README.md * Modified imports to have them in a more clean structure. * Removed unnecessary information in topology files * Number of Test messages and delay between message added as variable * Updated README.md 2022-12-23 12:21:42 +00:00			`#### Before using this repository note that:`
Modified readme 2022-12-12 15:48:26 +00:00
Nomos testing in master (#141) * Changed gennet to generate simple nomos topology * Added nomos node to build.sh * Updated nomos yaml trait * Added nomos variables to system_variables.star * Prepared nomos_builder.star * Modify gennet to work with nomos topology and traits * Gennet currently doesn't support mixed topologies between waku and nomos nodes. * Restructured config.json to add separated testing and simulation functionalities * Added assertions.star file * Modified wakurtosis to set up integration tests * Updated kurtosis version in README.md 2023-07-30 11:42:18 +00:00			`- You are using Kurtosis version 0.70.2. This is important, as they are working on it and changes can be huge depending on different versions. You can find all Kurtosis versions [here](https://github.com/kurtosis-tech/kurtosis-cli-release-artifacts/releases).`
Modified documentation accordingly 2023-02-12 01:15:55 +00:00			- The topology files that will be used by default are defined in `config/topology_generated/`. This topology is created with the [gennet](gennet-module/Readme.md) module.
Added parallelism and interconnection batch as parameters. 2023-02-12 02:01:38 +00:00			- Kurtosis can set up services in a parallel manner, defined in the `config.json` file (see below).
Refactor (#18) * Modified configuration files and added example of list of topics into general configuration * Refactored main.star into different star files * Deleted unnecesary files from previous module * Moved and changed .star files * Moved config files * Added parser and small topology as file * Updated README.md * Modified imports to have them in a more clean structure. * Removed unnecessary information in topology files * Number of Test messages and delay between message added as variable * Updated README.md 2022-12-23 12:21:42 +00:00			- Only `kurtosis` and `docker` are needed to run this.
Modified readme 2022-12-12 15:48:26 +00:00
Refactor (#18) * Modified configuration files and added example of list of topics into general configuration * Refactored main.star into different star files * Deleted unnecesary files from previous module * Moved and changed .star files * Moved config files * Added parser and small topology as file * Updated README.md * Modified imports to have them in a more clean structure. * Removed unnecessary information in topology files * Number of Test messages and delay between message added as variable * Updated README.md 2022-12-23 12:21:42 +00:00			`#### How to run`
Cleaned Readme and testing pycharm changes 2022-12-14 11:51:15 +00:00
Updated to provide an explanation on how to run the bash script and added new parameters 2023-01-12 15:26:05 +00:00			`From the root of the repo run:`
Cleaned Readme and testing pycharm changes 2022-12-14 11:51:15 +00:00
Updated documentation 2023-06-09 16:27:00 +00:00			`./build.sh`

			`./run.sh <measurement_infra> [enclave_name] [config_file]`
Modified readme 2022-12-12 15:48:26 +00:00
Updated documentation 2023-06-09 16:27:00 +00:00			There are 4 different measurements: `cadvisor`, `dstats`, `host-proc`, `container-proc`. The other parameters are optional.
Updated readme and using topology file 2022-12-20 11:09:21 +00:00
Updated documentation 2023-06-09 16:27:00 +00:00			By default, the enclave name is `wakurtosis` and the config file is in `config/config.json`.
Refactor (#18) * Modified configuration files and added example of list of topics into general configuration * Refactored main.star into different star files * Deleted unnecesary files from previous module * Moved and changed .star files * Moved config files * Added parser and small topology as file * Updated README.md * Modified imports to have them in a more clean structure. * Removed unnecessary information in topology files * Number of Test messages and delay between message added as variable * Updated README.md 2022-12-23 12:21:42 +00:00
Implemented the logic to load a main config file 2023-01-04 13:18:05 +00:00			`#### JSON main configuration file options`

Combining the 2 config file parameters into a single one 2023-01-05 17:35:05 +00:00			`These are arguments that can be modified:`
Implemented the logic to load a main config file 2023-01-04 13:18:05 +00:00
Modified documentation accordingly 2023-02-12 01:15:55 +00:00			`- _prng_seed_: int. Seed to reproduce results.`
Updated to provide an explanation on how to run the bash script and added new parameters 2023-01-12 15:26:05 +00:00			`- _enclave_name_: string. Default: wakurtosis. Defines the name of the Kurtosis enclave being created.`
Updated documentation 2023-06-09 16:27:00 +00:00			`- _topology_path_: string. Topology information that will be read.`
Added parallelism and interconnection batch as parameters. 2023-02-12 02:01:38 +00:00			`- _jobs_: int. Defines how many services will be instantiated at the same time.`
Updated documentation 2023-06-09 16:27:00 +00:00			`- _interconnect_nodes_: It allows to skip the interconnection phase of the topology.`
Added parallelism and interconnection batch as parameters. 2023-02-12 02:01:38 +00:00			`- _interconnection_batch_: int. If nodes are being connected by a given topology, this tells kurtosis how many connections will try to set up in the same node at a time. Used to avoid timeouts if a node has a lot of connections.`
Modified documentation accordingly 2023-02-12 01:15:55 +00:00
			`- [Gennet](gennet-module/Readme.md) module configuration`
Updated documentation 2023-06-09 16:27:00 +00:00			`- [WLS](wls-module/README.md) module configuration`
Updated to provide an explanation on how to run the bash script and added new parameters 2023-01-12 15:26:05 +00:00