Deployed 8ed9dc83 to develop in public with MkDocs 1.6.1 and mike 2.1.3

<li>See <a href="./1.5.-Show-Deployment-and-Logs">Show Deployment and Logs</a></li>

<li>See <a href="./1.5.-Show-Deployment-and-Logs">Show Deployment and Logs</a></li>

</ul>

</ul>

<h2 id="14-webui-and-grafana-dashboards"><strong>1.4. WebUI and Grafana Dashboards</strong></h2>

<h2 id="14-webui-and-grafana-dashboards"><strong>1.4. WebUI and Grafana Dashboards</strong></h2>

<p>This section describes how to get access to the TeraFlowSDN controller WebUI and the monitoring Grafana dashboards.</p>

<h3><u>Access the TeraFlowSDN WebUI</h3>

<p></u>

If you followed the installation steps based on MicroK8s, you got an ingress controller installed that exposes on TCP port 80.</p>

<p>Besides, the ingress controller defines the following reverse proxy paths (on your local machine):

- <code>http://127.0.0.1/webui</code>: points to the WebUI of TeraFlowSDN.

- <code>http://127.0.0.1/grafana</code>: points to the Grafana dashboards.

  This endpoint brings access to the monitoring dashboards of TeraFlowSDN.

  The credentials for the <code>admin</code>user are those defined in the <code>my_deploy.sh</code> script, in the <code>TFS_GRAFANA_PASSWORD</code> variable.

- <code>http://127.0.0.1/restconf</code>: points to the Compute component NBI based on RestCONF. 

  This endpoint enables connecting external software, such as ETSI OpenSourceMANO NFV Orchestrator, to TeraFlowSDN.</p>

<p><strong>Note</strong>: 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 <code>127.0.0.1:8080</code> of your local machine instead of <code>127.0.0.1:80</code>.</p>

<h2 id="15-show-deployment-and-logs"><strong>1.5. Show Deployment and Logs</strong></h2>

<h2 id="15-show-deployment-and-logs"><strong>1.5. Show Deployment and Logs</strong></h2>

<p>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.</p>

<h3><u>Report the deployment of the TFS controller</h3>

<p></u></p>

<p>The summary report given at the end of the <a href="./1.3.-Deploy-TeraFlowSDN#deploy-tfs-controller">Deploy TFS controller</a>

procedure can be generated manually at any time by running the following command.

You can avoid sourcing <code>my_deploy.sh</code> if it has been already done.</p>

<pre><code class="language-bash">cd ~/tfs-ctrl

source my_deploy.sh

./deploy/show.sh

</code></pre>

<p>Use this script to validate that all the pods, deployments, replica sets, ingress 

controller, etc. are ready and have the appropriate state, e.g., <em>running</em> for Pods, and 

the services are deployed and have appropriate IP addresses and port numbers.</p>

<h3><u>Report the log of a specific TFS controller component</h3>

<p></u></p>

<p>A number of scripts are pre-created in the <code>scripts</code> 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 <code>my_deploy.sh</code> if it has been already done.</p>

<pre><code class="language-bash">source my_deploy.sh

./scripts/show_logs_context.sh

</code></pre>