diff --git a/doc/deployment_guide/deployment_guide.md b/doc/deployment_guide/deployment_guide.md index 74b6c071ee3ea4c19938e2b99d5696087cc3c1d8..05827701c1745e73615986e2ea37d36e7121c325 100644 --- a/doc/deployment_guide/deployment_guide.md +++ b/doc/deployment_guide/deployment_guide.md @@ -449,7 +449,7 @@ following command: watch -n 1 microk8s.status --wait-ready ``` -<h3><u>Check all resources in Kubernetes</h3></u> +<h3><u id="check-all-resources-in-kubernetes">Check all resources in Kubernetes</h3></u> To retrieve the status of the Kubernetes resources __once__, run the following command: ```bash kubectl get all --all-namespaces @@ -665,10 +665,10 @@ microk8s start Confirm everything is up and running: 1. Periodically [Check the status of Kubernetes](#check-status-of-kubernetes-and-addons) until you see the addons \[dns, ha-cluster, helm3, hostpath-storage, ingress, registry, storage\] in the enabled block. -2. Periodically [Check Kubernetes resources](/1.-Deployment-Guide/1.2.-Install-MicroK8s#check-all-resources-in-kubernetes) until all pods are **Ready** and **Running**. +2. Periodically [Check Kubernetes resources](#check-all-resources-in-kubernetes) until all pods are **Ready** and **Running**. -<h3><u>Deploy TFS controller</h3></u> +<h3><u id="deploy-tfs-controller">Deploy TFS controller</h3></u> First, source the deployment settings defined in the previous section. This way, you do not need to specify the environment variables in each and every command you execute to operate the TFS controller. Be aware to re-source the file if you open new terminal sessions. @@ -704,7 +704,7 @@ The script performs the following steps: - Deploying service monitors to enable monitoring the performance of the components, device drivers and service handlers. - Initialize and configure the Grafana dashboards (if Monitoring component is deployed) - Report a summary of the deployment - - See [Show Deployment and Logs](./1.5.-Show-Deployment-and-Logs) + - See [Show Deployment and Logs](#15-show-deployment-and-logs) ## **1.4. WebUI and Grafana Dashboards** @@ -714,6 +714,7 @@ This section describes how to get access to the TeraFlowSDN controller WebUI and 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. @@ -733,9 +734,10 @@ 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) +The summary report given at the end of the [Deploy TFS controller](#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