afonso/core-extra
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

docs: adjustments for tutorial 1 to working order

Browse source
This commit is contained in:
Blake Harnden 2023-06-05 13:07:59 -07:00
parent 580916f2f0
commit 75a92f3a38
4 changed files with 22 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
daemon/core/configservices/utilservices/templates/ipforward.sh
View file

@ -13,4 +13,5 @@ sysctl -w net.ipv4.conf.default.rp_filter=0
sysctl -w net.ipv4.conf.${devname}.forwarding=1
sysctl -w net.ipv4.conf.${devname}.send_redirects=0
sysctl -w net.ipv4.conf.${devname}.rp_filter=0
sysctl -w net.ipv6.conf.${devname}.forwarding=1
% endfor

2
docs/tutorials/common/grpc.md
View file

@ -18,5 +18,5 @@ the remaining steps of a given section.
```
4. You will be presented with sessions to join, select the one created by the script
<p align="center">
<img src="images/tutorial-common/running-join.png" width="75%">
<img src="/static/tutorial-common/running-join.png" width="75%">
</p>

30
docs/tutorials/tutorial1.md
View file

@ -1,10 +1,12 @@
# Tutorial 1 - Wired Network
## Overview
This tutorial will cover some use cases when using a wired 2 node
scenario in CORE.
<p align="center">
<img src="images/tutorial1/scenario.png" width="75%">
<img src="/static/tutorial1/scenario.png" width="75%">
</p>
## Files
@ -44,11 +46,11 @@ between nodes in CORE.
```
* In the GUI menu bar select **File->Open...**, then navigate to and select **scenario.xml**
<p align="center">
<img src="images/tutorial-common/running-open.png" width="75%">
<img src="/static/tutorial-common/running-open.png" width="75%">
</p>
* You can now click on the **Start Session** button to run the scenario
<p align="center">
<img src="images/tutorial1/scenario.png" width="75%">
<img src="/static/tutorial1/scenario.png" width="75%">
</p>
* Open a terminal on **n1** by double clicking it in the GUI
* Run the following in **n1** terminal
@ -82,11 +84,11 @@ traffic being sent/received among many other uses.
```
* In the GUI menu bar select **File->Open...**, then navigate to and select **scenario.xml**
<p align="center">
<img src="images/tutorial-common/running-open.png" width="75%">
<img src="/static/tutorial-common/running-open.png" width="75%">
</p>
* You can now click on the **Start Session** button to run the scenario
<p align="center">
<img src="images/tutorial1/scenario.png" width="75%">
<img src="/static/tutorial1/scenario.png" width="75%">
</p>
* Open a terminal on **n1** by double clicking it in the GUI
* Open a terminal on **n2** by double clicking it in the GUI
@ -121,20 +123,20 @@ beneficial for understanding how software will behave in adverse conditions.
```
* In the GUI menu bar select **File->Open...**, then navigate to and select **scenario.xml**
<p align="center">
<img src="images/tutorial-common/running-open.png" width="75%">
<img src="/static/tutorial-common/running-open.png" width="75%">
</p>
* You can now click on the **Start Session** button to run the scenario
<p align="center">
<img src="images/tutorial1/scenario.png" width="75%">
<img src="/static/tutorial1/scenario.png" width="75%">
</p>
* Right click the link between **n1** and **n2**
* Select **Configure**
<p align="center">
<img src="images/tutorial1/link-config.png" width="75%">
<img src="/static/tutorial1/link-config.png" width="75%">
</p>
* Update the loss to **25**
<p align="center">
<img src="images/tutorial1/link-config-dialog.png" width="50%">
<img src="/static/tutorial1/link-config-dialog.png" width="50%">
</p>
* Open a terminal on **n1** by double clicking it in the GUI
* Run the following in **n1** terminal
@ -164,11 +166,11 @@ within the nodes of our scenario.
```
* In the GUI menu bar select **File->Open...**, then navigate to and select **scenario.xml**
<p align="center">
<img src="images/tutorial-common/running-open.png" width="75%">
<img src="/static/tutorial-common/running-open.png" width="75%">
</p>
* You can now click on the **Start Session** button to run the scenario
<p align="center">
<img src="images/tutorial1/scenario.png" width="75%">
<img src="/static/tutorial1/scenario.png" width="75%">
</p>
* Open a terminal on **n1** by double clicking it in the GUI
* Run the following in **n1** terminal
@ -214,11 +216,11 @@ using `tail -f` to observe the output of running software.
```
* In the GUI menu bar select **File->Open...**, then navigate to and select **scenario_service.xml**
<p align="center">
<img src="images/tutorial-common/running-open.png" width="75%">
<img src="/static/tutorial-common/running-open.png" width="75%">
</p>
* You can now click on the **Start Session** button to run the scenario
<p align="center">
<img src="images/tutorial1/scenario.png" width="75%">
<img src="/static/tutorial1/scenario.png" width="75%">
</p>
* Open a terminal on **n1** by double clicking it in the GUI
* Run the following in **n1** terminal
@ -247,4 +249,4 @@ using `tail -f` to observe the output of running software.
[10.0.0.21:44362] hello world
```
--8<-- "common/grpc.md"
--8<-- "tutorials/common/grpc.md"

3
mkdocs.yml
View file

@ -38,6 +38,9 @@ nav:
- Overview: install.md
- Ubuntu: install_ubuntu.md
- CentOS: install_centos.md
- Tutorials:
- Setup: tutorials/setup.md
- Tutorial 1: tutorials/tutorial1.md
- Detailed Topics:
- GUI: gui.md
- Node Types: