Skip to content
Snippets Groups Projects
Commit 8d58416d authored by Vojdan Kjorveziroski's avatar Vojdan Kjorveziroski
Browse files

Further changes for JRES 2024

parent a6fb3c78
No related branches found
No related tags found
1 merge request!23Resolve "Update the all-in-one VM guide"
# All-in-one nmaas VM Image
An all-in-one VirtualBox VM image with an installed single node K3s Kubernetes cluster and a deployment of nmaas is available for download. The goal of this image is to be able to get a local nmaas environment suitable for basic experiments as fast as possible. The installed software includes:
- Single node K3s cluster
- GitLab
- nmaas
- Stakater Reloader component for automatic restarting of containers that have mounted a ConfigMap that has changed
- Ingress Nginx
Most notably, the all-in-one VM image does not include a LoadBalancer implementation and it is up to the user to install and configure one. As a result, the deployment of some applications in the catalog that rely on `LoadBalancer` type Services will not work (e.g., PostgreSQL). Users are advised to install [MetalLB manually](https://metallb.universe.tf/installation/) and [configuring](https://metallb.universe.tf/configuration/) it depending on their local environment and network setup.
The access details for the nmaas VM are:
- OS Login:
- Username: `nmaas`
- Password: `password`
- GitLab
- Username: `root`
- Password: `nmaasPassword123`
- nmaas
- Username: `admin`
- Password: `saamn`
The VM image is based on the lightweight Ubuntu distribution Lubuntu and has a full user interface. By default it uses a NAT type VirtualBox adapter, so it can be deployed even in restrictive networks. Access to the GitLab instance, nmaas itself, and any applications deployed from nmaas is possible via the built-in Mozilla Firefox web browser. Upon first launching the browser, the user will see that quick access links are already available for these locations in the bookmark toolbar.
...@@ -7,5 +7,6 @@ This section contains the materials for tutorials and workshops where the nmaas ...@@ -7,5 +7,6 @@ This section contains the materials for tutorials and workshops where the nmaas
To fully leverage the content in these materials, access to an nmaas test instance is advised. This can be accomplish by: To fully leverage the content in these materials, access to an nmaas test instance is advised. This can be accomplish by:
- deploying a local Kubernetes cluster and then deploying an nmaas test instance in it. - deploying a [local Kubernetes cluster](./deploying-local-kubernetes-cluster.md) and then [deploying an nmaas test instance in it](./deploying-nmaas-test-instance.md).
- registering for an account on the [managed vNOC Playground instance](https://nmaas.geant.org) or the [managed vLAB instance](https://vlab.dev.nmaas.eu), depending on the use-case that you are interested in. - registering for an account on the [managed vNOC Playground instance](https://nmaas.geant.org) or the [managed vLAB instance](https://vlab.dev.nmaas.eu), depending on the use-case that you are interested in.
- downloading the ready-made all-in-one nmaas test VM image. Please note that this VM image does not have a `LoadBalancer` implementation installed and it is up to the user to install and configure one. More details about the all-in-one nmaas image are available on the [corresponding docs page](./all-in-one-vm-image.md).
\ No newline at end of file
...@@ -30,6 +30,6 @@ ...@@ -30,6 +30,6 @@
| Oxidized Test Instance URL | https://oxidized-demo.nmaas.10.99.99.150.nip.io | | Oxidized Test Instance URL | https://oxidized-demo.nmaas.10.99.99.150.nip.io |
| Oxidized Test Instance HTTP Username | nmaas_demo | | Oxidized Test Instance HTTP Username | nmaas_demo |
| Oxidized Test Instance HTTP Password | nmaasdemo | | Oxidized Test Instance HTTP Password | nmaasdemo |
| UptimeKuma Test Instance URL | https://uptimekuma-demo.nmaas.10.99.99.150.nip.io | | UptimeKuma Test Instance URL | https://uptimekuma-demo.nmaas.10.99.99.150.nip.io |
| UptimeKuma Test Instance Username | nmaas_demo | | UptimeKuma Test Instance Username | nmaas_demo |
| UptimeKuma Test Instance Password | nmaasdemo! | | UptimeKuma Test Instance Password | nmaasdemo! |
\ No newline at end of file \ No newline at end of file
...@@ -2,8 +2,6 @@ ...@@ -2,8 +2,6 @@
Network management is an essential part of any production network, no matter its size. However, organizations often face staff shortages or lack the required resources to properly monitor their network. nmaas (Network Management as a Service) is a GÉANT production service that allows effortless deployment of many open-source network monitoring tools on demand, with minimal initial configuration by the end users. Based on the Kubernetes container orchestrator, and deployable on private infrastructure as well, a dedicated nmaas instance can be used as a central point for monitoring many distributed networks, by utilizing VPN tunnels. New applications can be added to the nmaas catalogue at any time using Helm charts, an industry standard package manager for Kubernetes. nmaas hides the operational complexity from end users who access the service through a web application from where they can manage and configure their existing application instances or deploy new ones. Network management is an essential part of any production network, no matter its size. However, organizations often face staff shortages or lack the required resources to properly monitor their network. nmaas (Network Management as a Service) is a GÉANT production service that allows effortless deployment of many open-source network monitoring tools on demand, with minimal initial configuration by the end users. Based on the Kubernetes container orchestrator, and deployable on private infrastructure as well, a dedicated nmaas instance can be used as a central point for monitoring many distributed networks, by utilizing VPN tunnels. New applications can be added to the nmaas catalogue at any time using Helm charts, an industry standard package manager for Kubernetes. nmaas hides the operational complexity from end users who access the service through a web application from where they can manage and configure their existing application instances or deploy new ones.
Users can also evaluate nmaas on their own infrastructure by either following this tutorial or by simply [downloading the already prepared virtual machine](https://drive1.demo.renater.fr/index.php/s/rp2awZ6sMnNFQwK). If you want to follow this tutorial, please make sure that you have either downloaded the [pre-prepared VM](../all-in-one-vm-image.md) or have followed the necessary steps for deploying a local Kubernetes clusters and installing an nmaas test instance. After completing these prerequisites, this tutorial continues with [setting up a demo network environment](./p3_demo-network-environment.md), where virtualized demo networking devices are used that can later act as monitoring targets for the applications deployed by nmaas. The process of deploying such monitoring applications from the list of supported applications in the nmaas catalog is described in the part on [monitoring the demo network environment](./p4_monitoring-demo-network-environment.md). The tutorial is concluded with [instructions on adding a custom application](./p5_adding_custom_app.md), allowing advanced users to add their own applications to the nmaas catalog, thus making it available to all potential users of their nmaas instance.
If you want to follow this tutorial, please make sure that you have either downloaded the pre-prepared VM or have followed the necessary steps for deploying a local Kubernetes clusters and installing an nmaas test instance. After completing these prerequisites, this tutorial continues with [setting up a demo network environment](./p3_demo-network-environment.md), where virtualized demo networking devices are used that can later act as monitoring targets for the applications deployed by nmaas. The process of deploying such monitoring applications from the list of supported applications in the nmaas catalog is described in the part on [monitoring the demo network environment](./p4_monitoring-demo-network-environment.md). The tutorial is concluded with [instructions on adding a custom application](./p5_adding_custom_app.md), allowing advanced users to add their own applications to the nmaas catalog, thus making it available to all potential users of their nmaas instance.
For users who choose to download the already prepared virtual machine and avoid the whole setup process, the [Appendix](./appendix.md) gives an overview of all the credentials that have been used. For users who choose to download the already prepared virtual machine and avoid the whole setup process, the [Appendix](./appendix.md) gives an overview of all the credentials that have been used.
\ No newline at end of file
...@@ -16,7 +16,7 @@ This tutorial will assume that VirtualBox is used, even though the discussion sh ...@@ -16,7 +16,7 @@ This tutorial will assume that VirtualBox is used, even though the discussion sh
The virtual machine where FreeRTR will be installed requires at least two network interfaces, one primary and one additional for each FreeRTR process. The virtual machine where FreeRTR will be installed requires at least two network interfaces, one primary and one additional for each FreeRTR process.
The addition of new interfaces can be easily accomplished from the VirtualBox VM settings screen, using the Network section. Each new interface is represented by a new tab, named `Adapter 1`, `Adapter 2`... For the new interface, choose `Attached to: NAT` and **make sure to select the NAT network created in [Part 1](./p1_local-kubernetes-cluster.md#creating-a-new-nat-network-in-virtualbox) and that Promiscuous Mode is set to Allow All** in the Advanced section. If Promiscuous Mode is not enabled, unfortunately pcapInt will not be able to work properly. The addition of new interfaces can be easily accomplished from the VirtualBox VM settings screen, using the Network section. Each new interface is represented by a new tab, named `Adapter 1`, `Adapter 2`... For the new interface, choose `Attached to: NAT` and **make sure to select a `NAT network` created and that Promiscuous Mode is set to Allow All** in the Advanced section. If Promiscuous Mode is not enabled, unfortunately pcapInt will not be able to work properly.
## Installing FreeRTR ## Installing FreeRTR
......
...@@ -29,6 +29,7 @@ nav: ...@@ -29,6 +29,7 @@ nav:
- Introduction: 'tutorials-workshops/introduction.md' - Introduction: 'tutorials-workshops/introduction.md'
- Deploying a Local Kubernetes Cluster: 'tutorials-workshops/deploying-local-kubernetes-cluster.md' - Deploying a Local Kubernetes Cluster: 'tutorials-workshops/deploying-local-kubernetes-cluster.md'
- Deploying an nmaas Test Instance: 'tutorials-workshops/deploying-nmaas-test-instance.md' - Deploying an nmaas Test Instance: 'tutorials-workshops/deploying-nmaas-test-instance.md'
- All-in-one nmaas VM image: 'tutorials-workshops/all-in-one-vm-image.md'
- JRES 2022: - JRES 2022:
- Introduction: 'tutorials-workshops/jres2022/introduction.md' - Introduction: 'tutorials-workshops/jres2022/introduction.md'
- Demo Network Environment: 'tutorials-workshops/jres2022/p3_demo-network-environment.md' - Demo Network Environment: 'tutorials-workshops/jres2022/p3_demo-network-environment.md'
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment