diff --git a/doc/deployment_guide/deployment_guide.md b/doc/deployment_guide/deployment_guide.md index a6464dec6576e2c325bf521f5814ab65d52411d9..1ce19b8b08096e79c80aaf0777d838398ee065db 100644 --- a/doc/deployment_guide/deployment_guide.md +++ b/doc/deployment_guide/deployment_guide.md @@ -3,8 +3,26 @@ The guide includes the details on configuring and installing the machine, instal configuring MicroK8s, and deploying and reporting the status of the TeraFlowSDN controller. -- [1.1. Configure your Machine](./1.-Deployment-Guide/1.1.-Configure-your-Machine) -- [1.2. Install MicroK8s](./1.-Deployment-Guide/1.2.-Install-MicroK8s) -- [1.3. Deploy TeraFlowSDN](./1.-Deployment-Guide/1.3.-Deploy-TeraFlowSDN) -- [1.4. WebUI and Grafana Dashboards](./1.-Deployment-Guide/1.4.-WebUI-and-Grafana-Dashboards) -- [1.5. Show Deployment and Logs](./1.-Deployment-Guide/1.5.-Show-Deployment-and-Logs) +# 1.1. Configure your Machine + +In this section, we describe how to configure a machine (physical or virtual) to be used as the deployment, execution, and development environment for the ETSI TeraFlowSDN controller. Choose your preferred environment below and follow the instructions provided. + +**NOTE**: If you already have a remote physical server fitting the requirements specified in this section feel free to use it instead of deploying a local VM. Check [1.1.1. Physical Server](./1.1.-Configure-your-Machine/1.1.1.-Physical-Server) for further details. + +Virtualization platforms tested are: +## 1.1.1. Physical Server + +## 1.1.2. Oracle Virtual Box + +## 1.1.3. VMWare Fusion + +## 1.1.4. OpenStack + +## 1.1.5. Vagrant Box + +Other virtualization environments might be used; in that case, you will need to adapt these instructions to your particular case. If you want to contribute with details on how you used other hypervisors or platforms, [contact](https://labs.etsi.org/rep/tfs/controller/-/wikis/home#contact) the TFS team through Slack. + +# 1.2. Install MicroK8s +# 1.3. Deploy TeraFlowSDN +# 1.4. WebUI and Grafana Dashboards +# 1.5. Show Deployment and Logs