Skip to content
Snippets Groups Projects
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
No related branches found
No related tags found
1 merge request!54Release 2.0.0
...@@ -9,3 +9,4 @@ configuring MicroK8s, and deploying and reporting the status of the TeraFlowSDN ...@@ -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.2. Install MicroK8s Kubernetes platform](./1-2-install-microk8s.md)
- [1.3. Deploy TeraFlowSDN over MicroK8s](./1-3-deploy-tfs.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.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)
...@@ -84,14 +84,5 @@ The script does the following steps: ...@@ -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 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. WebUI, Grafana Dashboards, Context Debug endpoints, and Compute NBI interfaces.
8. Initialize and configure the Grafana dashboards 8. Initialize and configure the Grafana dashboards
9. Report a summary of the deployment 9. Report a summary of the deployment (see
[1.5. Show Deployment and Log per Component](./1-5-deploy-logs-troubleshooting.md))
## 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
```
# 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
```
...@@ -6,5 +6,7 @@ commands you might need, configuring the network topology, and executing differe ...@@ -6,5 +6,7 @@ commands you might need, configuring the network topology, and executing differe
## Table of Content: ## Table of Content:
- [2.1. Configure the Python environment](./2-1-python-environment.md) - [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.2. OFC'22 Demo - Bootstrap devices, Monitor device Endpoints, Manage L3VPN Services](./2-2-ofc22.md)
- [2.3. Execute OECC/PSC'22 Experiment (WORK IN PROGRESS)](./2-3-oeccpsc22.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)
# 2.3. OECC/PSC'22 (WORK IN PROGRESS) # 2.3. OECC/PSC'22 Demo (WORK IN PROGRESS)
Check [Old Version](./../oeccpsc22/README.md) Check [Old Version](./../oeccpsc22/README.md)
# 2.4. ECOC'22 Demo (PENDING)
# 2.5. NFV-SDN'22 Demo (PENDING)
# 3.2. Development Commands, Tricks, and Hints (WORK IN PROGRESS) # 3.2. Development Commands, Tricks, and Hints (WORK IN PROGRESS)
## 3.2.1. Report the log of a specific TFS controller component
A number of scripts are pre-created 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.
__Note__: these commands should be run on the VM, not in the Docker-based runtime environment.
```bash
source my_deploy.sh
./scripts/show_logs_context.sh
```
## Items to be addressed: ## Items to be addressed:
- pytest flags: --log-level=INFO --verbose -o log_cli=true -o log_file=my_log_file.log -o log_file_level=DEBUG - pytest flags: --log-level=INFO --verbose -o log_cli=true -o log_file=my_log_file.log -o log_file_level=DEBUG
......
...@@ -27,10 +27,13 @@ with the ETSI TeraFlowSDN controller, contact the ETSI TeraFlowSDN OSG team thro ...@@ -27,10 +27,13 @@ with the ETSI TeraFlowSDN controller, contact the ETSI TeraFlowSDN OSG team thro
- [1.2. Install MicroK8s Kubernetes platform](./1-2-install-microk8s.md) - [1.2. Install MicroK8s Kubernetes platform](./1-2-install-microk8s.md)
- [1.3. Deploy TeraFlowSDN over MicroK8s](./1-3-deploy-tfs.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.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)
- [2. Run Experiments Guide (WORK IN PROGRESS)](./2-0-run-experiments.md) - [2. Run Experiments Guide (WORK IN PROGRESS)](./2-0-run-experiments.md)
- [2.1. Configure the Python environment](./2-1-python-environment.md) - [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.2. OFC'22 Demo - Bootstrap devices, Monitor device Endpoints, Manage L3VPN Services](./2-2-ofc22.md)
- [2.3. Execute OECC/PSC'22 Experiment (WORK IN PROGRESS)](./2-3-oeccpsc22.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)
- [3. Development Guide (WORK IN PROGRESS)](./3-0-development.md) - [3. Development Guide (WORK IN PROGRESS)](./3-0-development.md)
- [3.1. Configure VSCode and Connect to the VM](./3-1-configure-vscode.md) - [3.1. Configure VSCode and Connect to the VM](./3-1-configure-vscode.md)
- [3.2. Development Commands, Tricks, and Hints (WORK IN PROGRESS)](./3-2-develop-cth.md) - [3.2. Development Commands, Tricks, and Hints (WORK IN PROGRESS)](./3-2-develop-cth.md)
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment