From 0c61c9bba8cedfb91c7507e1f34522cdd825afdf Mon Sep 17 00:00:00 2001 From: Maximiliano Estudies Date: Fri, 21 Oct 2022 14:28:23 +0200 Subject: [PATCH 1/4] add quick-start-guide --- quick-start-guide.org | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 quick-start-guide.org diff --git a/quick-start-guide.org b/quick-start-guide.org new file mode 100644 index 0000000..df954db --- /dev/null +++ b/quick-start-guide.org @@ -0,0 +1,35 @@ +* Requirements +** Poetry + installation guide +** virtualenv + you need the virtualenv package. In my case I installed it with pip3 and this didn't work. + I had to uninstall the package (also running pip3 uninstall virtualenv didn't work, I had to do ~rm -rf /usr/lib/python3/dist-packages/virtualenv~) + and then install it with ~apt install virtualenv~ +* Installation + clone the git repository + cd into munet and run ~make install~ + If the command fails and you see something like this: + #+begin_src bash + Creating virtualenv munet in /home/maximiliano/munet/.venv + + ModuleNotFoundError + + No module named 'virtualenv.seed.via_app_data' + #+end_src + you probably are trying to use the virtualenv package from pip3 (see virtualenv) +* Running the program + To run the program you can type ~make run~. You will be prompted for your sudo password. This is necessary because you need admin privileges to create namespaces + You can have a look in examples/frr/ospf/ospf/munet.yaml for an example configuration. The program looks for the munet.yaml configuratin on the working directory, + so you will need to copy the contents of the example directory into the base directory + + the ~make run~ command is an alias to: + #+begin_src bash + sudo -E env -u VIRTUAL_ENV PATH= poetry run python3 -m munet + #+end_src + so you can also run this command directly on other directories that have a munet.yaml config file + + if running the program fails with: + #+begin_src bash + FileNotFoundError: munet.{json,toml,yaml} + #+end_src + it means that it failed to find the configuration file From c2b38d4350a0326ddee0a9faff728006f76310f7 Mon Sep 17 00:00:00 2001 From: Maximiliano Estudies Date: Fri, 21 Oct 2022 14:42:01 +0200 Subject: [PATCH 2/4] typos and capitalization --- quick-start-guide.org | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/quick-start-guide.org b/quick-start-guide.org index df954db..d08838a 100644 --- a/quick-start-guide.org +++ b/quick-start-guide.org @@ -1,12 +1,14 @@ +* Quick start guide + This are the steps to get the software running under Ubuntu 20.04 * Requirements ** Poetry - installation guide + [[https://python-poetry.org/docs/#installation][installation guide]] ** virtualenv - you need the virtualenv package. In my case I installed it with pip3 and this didn't work. + You will need the virtualenv package. In my case I installed it with pip3 and it didn't work. I had to uninstall the package (also running pip3 uninstall virtualenv didn't work, I had to do ~rm -rf /usr/lib/python3/dist-packages/virtualenv~) - and then install it with ~apt install virtualenv~ + and then reinstall it with ~apt install virtualenv~ * Installation - clone the git repository + Clone the git repository cd into munet and run ~make install~ If the command fails and you see something like this: #+begin_src bash @@ -16,19 +18,19 @@ No module named 'virtualenv.seed.via_app_data' #+end_src - you probably are trying to use the virtualenv package from pip3 (see virtualenv) + you probably are trying to use the virtualenv package from pip3 (see [[virtualenv]]) * Running the program To run the program you can type ~make run~. You will be prompted for your sudo password. This is necessary because you need admin privileges to create namespaces - You can have a look in examples/frr/ospf/ospf/munet.yaml for an example configuration. The program looks for the munet.yaml configuratin on the working directory, + You can have a look in examples/frr/ospf/ospf/munet.yaml for an example configuration. The program looks for the munet.yaml configuration on the working directory, so you will need to copy the contents of the example directory into the base directory - the ~make run~ command is an alias to: + The ~make run~ command is an alias to: #+begin_src bash sudo -E env -u VIRTUAL_ENV PATH= poetry run python3 -m munet #+end_src so you can also run this command directly on other directories that have a munet.yaml config file - if running the program fails with: + If running the program fails with: #+begin_src bash FileNotFoundError: munet.{json,toml,yaml} #+end_src From 840a5539a3078030a26107c1293014594d044a1c Mon Sep 17 00:00:00 2001 From: Maximiliano Estudies Date: Fri, 21 Oct 2022 14:43:57 +0200 Subject: [PATCH 3/4] options and indent --- quick-start-guide.org | 63 ++++++++++++++++++++++--------------------- 1 file changed, 32 insertions(+), 31 deletions(-) diff --git a/quick-start-guide.org b/quick-start-guide.org index d08838a..3924fe7 100644 --- a/quick-start-guide.org +++ b/quick-start-guide.org @@ -1,37 +1,38 @@ +#+OPTIONS: \n:t * Quick start guide This are the steps to get the software running under Ubuntu 20.04 -* Requirements -** Poetry - [[https://python-poetry.org/docs/#installation][installation guide]] -** virtualenv - You will need the virtualenv package. In my case I installed it with pip3 and it didn't work. - I had to uninstall the package (also running pip3 uninstall virtualenv didn't work, I had to do ~rm -rf /usr/lib/python3/dist-packages/virtualenv~) - and then reinstall it with ~apt install virtualenv~ -* Installation - Clone the git repository - cd into munet and run ~make install~ - If the command fails and you see something like this: - #+begin_src bash - Creating virtualenv munet in /home/maximiliano/munet/.venv +** Requirements +*** Poetry + [[https://python-poetry.org/docs/#installation][installation guide]] +*** virtualenv + You will need the virtualenv package. In my case I installed it with pip3 and it didn't work. + I had to uninstall the package (also running pip3 uninstall virtualenv didn't work, I had to do ~rm -rf /usr/lib/python3/dist-packages/virtualenv~) + and then reinstall it with ~apt install virtualenv~ +** Installation + Clone the git repository. + cd into munet and run ~make install~ + If the command fails and you see something like this: + #+begin_src bash + Creating virtualenv munet in /home/maximiliano/munet/.venv - ModuleNotFoundError + ModuleNotFoundError - No module named 'virtualenv.seed.via_app_data' - #+end_src - you probably are trying to use the virtualenv package from pip3 (see [[virtualenv]]) -* Running the program - To run the program you can type ~make run~. You will be prompted for your sudo password. This is necessary because you need admin privileges to create namespaces - You can have a look in examples/frr/ospf/ospf/munet.yaml for an example configuration. The program looks for the munet.yaml configuration on the working directory, - so you will need to copy the contents of the example directory into the base directory + No module named 'virtualenv.seed.via_app_data' + #+end_src + you probably are trying to use the virtualenv package from pip3 (see [[virtualenv]]) +** Running the program + To run the program you can type ~make run~. You will be prompted for your sudo password. This is necessary because you need admin privileges to create namespaces + You can have a look in examples/frr/ospf/ospf/munet.yaml for an example configuration. The program looks for the munet.yaml configuration on the working directory, + so you will need to copy the contents of the example directory into the base directory - The ~make run~ command is an alias to: - #+begin_src bash - sudo -E env -u VIRTUAL_ENV PATH= poetry run python3 -m munet - #+end_src - so you can also run this command directly on other directories that have a munet.yaml config file + The ~make run~ command is an alias to: + #+begin_src bash + sudo -E env -u VIRTUAL_ENV PATH= poetry run python3 -m munet + #+end_src + so you can also run this command directly on other directories that have a munet.yaml config file - If running the program fails with: - #+begin_src bash - FileNotFoundError: munet.{json,toml,yaml} - #+end_src - it means that it failed to find the configuration file + If running the program fails with: + #+begin_src bash + FileNotFoundError: munet.{json,toml,yaml} + #+end_src + it means that it failed to find the configuration file From 9e0cda7ad1b0dfacc0c641c20a6d9dd51f6c3c91 Mon Sep 17 00:00:00 2001 From: Maximiliano Estudies Date: Fri, 21 Oct 2022 14:49:56 +0200 Subject: [PATCH 4/4] punctuation --- quick-start-guide.org | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/quick-start-guide.org b/quick-start-guide.org index 3924fe7..8eee793 100644 --- a/quick-start-guide.org +++ b/quick-start-guide.org @@ -10,7 +10,7 @@ and then reinstall it with ~apt install virtualenv~ ** Installation Clone the git repository. - cd into munet and run ~make install~ + cd into munet and run ~make install~. If the command fails and you see something like this: #+begin_src bash Creating virtualenv munet in /home/maximiliano/munet/.venv