From 8ed9dc83b78d9e23dd489a030baf3ed43c14d78c Mon Sep 17 00:00:00 2001
From: Royer Yangali <royer.yangali@etsi.org>
Date: Fri, 18 Oct 2024 17:39:29 +0200
Subject: [PATCH] ADDS: adding Show Deployment and Logs section

---
 doc/deployment_guide/deployment_guide.md | 50 ++++++++++++++++++++++++
 1 file changed, 50 insertions(+)

diff --git a/doc/deployment_guide/deployment_guide.md b/doc/deployment_guide/deployment_guide.md
index 6dd3ef9..434c19d 100644
--- a/doc/deployment_guide/deployment_guide.md
+++ b/doc/deployment_guide/deployment_guide.md
@@ -708,4 +708,54 @@ The script performs the following steps:
   - See [Show Deployment and Logs](./1.5.-Show-Deployment-and-Logs)
 
 ## **1.4. WebUI and Grafana Dashboards**
+
+This section describes how to get access to the TeraFlowSDN controller WebUI and the monitoring Grafana dashboards.
+
+<h3><u>Access the TeraFlowSDN WebUI</h3></u>
+If you followed the installation steps based on MicroK8s, you got an ingress controller installed that exposes on TCP port 80.
+
+Besides, the ingress controller defines the following reverse proxy paths (on your local machine):
+- `http://127.0.0.1/webui`: points to the WebUI of TeraFlowSDN.
+- `http://127.0.0.1/grafana`: points to the Grafana dashboards.
+  This endpoint brings access to the monitoring dashboards of TeraFlowSDN.
+  The credentials for the `admin`user are those defined in the `my_deploy.sh` script, in the `TFS_GRAFANA_PASSWORD` variable.
+- `http://127.0.0.1/restconf`: points to the Compute component NBI based on RestCONF. 
+  This endpoint enables connecting external software, such as ETSI OpenSourceMANO NFV Orchestrator, to TeraFlowSDN.
+
+**Note**: In the creation of the VM, a forward from host TCP port 8080 to VM's TCP port 80 is configured, so the WebUIs and REST APIs of TeraFlowSDN should be exposed on the endpoint `127.0.0.1:8080` of your local machine instead of `127.0.0.1:80`.
+
 ## **1.5. Show Deployment and Logs**
+
+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.
+
+
+<h3><u>Report the deployment of the TFS controller</h3></u>
+
+The summary report given at the end of the [Deploy TFS controller](./1.3.-Deploy-TeraFlowSDN#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
+./deploy/show.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.
+
+
+<h3><u>Report the log of a specific TFS controller component</h3></u>
+
+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
+```
-- 
GitLab