From da6422058ca1741efd7f0aab6cbdc1e923c58938 Mon Sep 17 00:00:00 2001 From: Royer Yangali <royer.yangali@etsi.org> Date: Fri, 6 Sep 2024 00:31:55 +0200 Subject: [PATCH] TEST: testing if parent assigns a md file --- .../configure_your_machine/configure_your_machine.md | 12 ++++++++++++ doc/deployment_guide/deployment_guide.md | 10 ++++++++++ 2 files changed, 22 insertions(+) create mode 100644 doc/deployment_guide/configure_your_machine/configure_your_machine.md create mode 100644 doc/deployment_guide/deployment_guide.md diff --git a/doc/deployment_guide/configure_your_machine/configure_your_machine.md b/doc/deployment_guide/configure_your_machine/configure_your_machine.md new file mode 100644 index 0000000..81bb942 --- /dev/null +++ b/doc/deployment_guide/configure_your_machine/configure_your_machine.md @@ -0,0 +1,12 @@ +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.-Configure-your-Machine/1.1.1.-Physical-Server) + - [1.1.2. Oracle Virtual Box](./1.1.-Configure-your-Machine/1.1.2.-Oracle-Virtual-Box) + - [1.1.3. VMWare Fusion](./1.1.-Configure-your-Machine/1.1.3.-VMWare-Fusion) + - [1.1.4. OpenStack](./1.1.-Configure-your-Machine/1.1.4.-OpenStack) + - [1.1.5. Vagrant Box](./1.1.-Configure-your-Machine/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. diff --git a/doc/deployment_guide/deployment_guide.md b/doc/deployment_guide/deployment_guide.md new file mode 100644 index 0000000..a6464de --- /dev/null +++ b/doc/deployment_guide/deployment_guide.md @@ -0,0 +1,10 @@ +This section walks you through the process of deploying TeraFlowSDN on top of a machine running [MicroK8s Kubernetes platform](https://microk8s.io). +The guide includes the details on configuring and installing the machine, installing and +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) -- GitLab