Commit 6b76b189 authored by Lluis Gifre Renom's avatar Lluis Gifre Renom
Browse files

Tutorial: 

- added section in deployment for deploy and log inspection, and troubleshooting
- extended list of experiments with placeholders for pending experiments
- updated Table of Content in README.md
parent 6b1ff3e8

tutorial/1-0-deployment.md

+1 −0
Original line number Diff line number Diff line
@@ -9,3 +9,4 @@ configuring MicroK8s, and deploying and reporting the status of the TeraFlowSDN 
- [1.2. Install MicroK8s Kubernetes platform](./1-2-install-microk8s.md)

- [1.3. Deploy TeraFlowSDN over MicroK8s](./1-3-deploy-tfs.md)

- [1.4. Access TeraFlowSDN WebUI and Grafana Dashboards](./1-4-access-webui.md)

- [1.5. Show Deployment and Log per Component](./1-5-deploy-logs-troubleshooting.md)

tutorial/1-3-deploy-tfs.md

+2 −11
Original line number Diff line number Diff line
@@ -84,14 +84,5 @@ The script does the following steps: 
7. Create an ingress controller listening at port 80 for HTTP connections to enable external access to the TeraFlowSDN

   WebUI, Grafana Dashboards, Context Debug endpoints, and Compute NBI interfaces.

8. Initialize and configure the Grafana dashboards

9. Report a summary of the deployment





## 1.3.6. Report the deployment of the TFS controller

The summary report given at the end of the deployment can be generated manually running the following command. You can

avoid sourcing `my_deploy.sh` if it has been already done.

```bash

cd ~/tfs-ctrl

source my_deploy.sh

./show_deploy.sh

```
 
9. Report a summary of the deployment (see 

   [1.5. Show Deployment and Log per Component](./1-5-deploy-logs-troubleshooting.md))

tutorial/1-5-deploy-logs-troubleshooting.md

0 → 100644
+32 −0
Original line number Diff line number Diff line 
# 1.5. Show Deployment and Log per Component



This section presents some helper scripts to inspect the status of the deployment and the logs of the components. These

scripts are particularly helpful for troubleshooting during execution of experiments, development, and debugging.





## 1.5.1. Report the deployment of the TFS controller



The summary report given at the end of the [Deploy TFS controller](./1-3-deploy-tfs.md#135-deploy-tfs-controller)

procedure can be generated manually at any time by running the following command. You can avoid sourcing `my_deploy.sh`

if it has been already done.

```bash

cd ~/tfs-ctrl

source my_deploy.sh

./show_deploy.sh

```



Use this script to validate that all the pods, deployments, replica sets, ingress controller, etc. are ready and have

the appropriate state, e.g., "running" for Pods, and the services are deployed and have appropriate IP addresses and

port numbers.





## 1.5.2. Report the log of a specific TFS controller component



A number of scripts are pre-created in the `scripts` folder to facilitate the inspection of the component logs. For

instance, to dump the log of the Context component, run the following command. You can avoid sourcing `my_deploy.sh`

if it has been already done.



```bash

source my_deploy.sh

./scripts/show_logs_context.sh

```

tutorial/2-0-run-experiments.md

+4 −2
Original line number Diff line number Diff line
@@ -6,5 +6,7 @@ commands you might need, configuring the network topology, and executing differe 


## Table of Content:

- [2.1. Configure the Python environment](./2-1-python-environment.md)

- [2.2. Execute OFC'22 Experiment (WORK IN PROGRESS)](./2-2-ofc22.md)

- [2.3. Execute OECC/PSC'22 Experiment (WORK IN PROGRESS)](./2-3-oeccpsc22.md)
 
- [2.2. OFC'22 Demo - Bootstrap devices, Monitor device Endpoints, Manage L3VPN Services](./2-2-ofc22.md)

- [2.3. OECC/PSC'22 Demo (WORK IN PROGRESS)](./2-3-oeccpsc22.md)

- [2.4. ECOC'22 Demo (PENDING)](./2-4-ecoc22.md)

- [2.5. NFV-SDN'22 Demo (PENDING)](./2-5-nfvsdn22.md)

tutorial/2-3-oeccpsc22.md

+1 −1
Original line number Diff line number Diff line 
# 2.3. OECC/PSC'22 (WORK IN PROGRESS)

# 2.3. OECC/PSC'22 Demo (WORK IN PROGRESS)



Check [Old Version](./../oeccpsc22/README.md)