diff --git a/README.md b/README.md
index a5b1cb48ff7df92f117f129c400dc8d1b2f93133..e8541cd064b78f74f8df3577dbee4961f7d1bb08 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
-# NMaaS Documentation
+# nmaas Documentation
-This repository contains the source files for the [docs.nmaas.eu](https://docs.nmaas.eu) website. It provides information on both the self-hosted NMaaS version, as well as the hosted one.
+This repository contains the source files for the [docs.nmaas.eu](https://docs.nmaas.eu) website. It provides information on both the self-hosted nmaas version, as well as the hosted one.
## Contributing to the Documentation
diff --git a/docs/about.md b/docs/about.md
index be2381d2ce13ffea398b80cf84be0b0c992f2ac9..cee1db0fd3f2a7f74673a3483f38de7a10ac2245 100644
--- a/docs/about.md
+++ b/docs/about.md
@@ -1,6 +1,6 @@
-**NMaaS Platform** is actively developed and maintained as part of the [GÉANT GN5-1](https://geant.org/gn5-1/) project co-funded by the European Union.
+**nmaas Platform** is actively developed and maintained as part of the [GÉANT GN5-1](https://geant.org/gn5-1/) project co-funded by the European Union.
-NMaaS components are open-source licensed under the Apache 2.0 Licence.
+nmaas components are open-source licensed under the Apache 2.0 Licence.
## Useful links
diff --git a/docs/contact.md b/docs/contact.md
index 6e79bb547bd8ce473ca28d3db54d4cefc1fb1f1b..b84106a4b49f7e64cd14d408c3b09b1b2de06225 100644
--- a/docs/contact.md
+++ b/docs/contact.md
@@ -1,7 +1,7 @@
# Contact
-## NMaaS Mailing Lists
+## nmaas Mailing Lists
-- [nmaas@lists.geant.org](mailto:nmaas@lists.geant.org): If you want to reach NMaaS core team members
-- [nmaas-users@lists.geant.org](mailto:nmaas-users@lists.geant.org): Discussions related to NMaaS usage and development ([subscribe here](https://lists.geant.org/sympa/info/nmaas-users))
-- [nmaas-announce@lists.geant.org](mailto:nmaas-announce@lists.geant.org): Announcements shared by the NMaaS team with the community ([subscribe here](https://lists.geant.org/sympa/info/nmaas-announce))
+- [nmaas@lists.geant.org](mailto:nmaas@lists.geant.org): If you want to reach nmaas core team members
+- [nmaas-users@lists.geant.org](mailto:nmaas-users@lists.geant.org): Discussions related to nmaas usage and development ([subscribe here](https://lists.geant.org/sympa/info/nmaas-users))
+- [nmaas-announce@lists.geant.org](mailto:nmaas-announce@lists.geant.org): Announcements shared by the nmaas team with the community ([subscribe here](https://lists.geant.org/sympa/info/nmaas-announce))
diff --git a/docs/faq.md b/docs/faq.md
index 316c287a3e78df44e31bb52bddf5e9e168c44d30..cec3139995dfd32d753b86dfd6e922c58d8085dc 100644
--- a/docs/faq.md
+++ b/docs/faq.md
@@ -1,87 +1,87 @@
# NMAAS FAQ
-The following NMaaS-related questions are answered on this page:
-
-- [How can I contact the NMaaS Team members?](#how-can-i-contact-the-nmaas-team-members)
-- [How can I test NMaaS?](#how-can-i-test-nmaas)
-- [How can I start monitoring my infrastructure with NMaaS?](#how-can-i-start-monitoring-my-infrastructure-with-nmaas)
-- [How can I request creation of new NMaaS domain for my NREN / Institution / Project?](#how-can-i-request-creation-of-new-nmaas-domain-for-my-nreninstitutionproject)
-- [How can I deploy NMaaS on my own intrastructure?](#how-can-i-deploy-nmaas-on-my-own-infrastructure)
-- [Where can I find NMaaS User Guide?](#where-can-i-find-nmaas-user-guide)
-- [Where can I find NMaaS Administrator Guide?](#where-can-i-find-nmaas-administrator-guide)
-- [What applications are currently supported by NMaaS?](#what-applications-are-currently-supported-by-nmaas)
-- [What type of VPNs are established by NMaaS?](#what-type-of-vpns-are-established-by-nmaas)
-- [What VPN solutions are supported by NMaaS?](#what-vpn-solutions-are-supported-by-nmaas)
-- [What are NMaaS VPN requirements?](#what-are-nmaas-vpn-requirements)
-
-## How can I contact the NMaaS Team members?
-
-The NMaaS Team can be contacted either by:
+The following nmaas-related questions are answered on this page:
+
+- [How can I contact the nmaas Team members?](#how-can-i-contact-the-nmaas-team-members)
+- [How can I test nmaas?](#how-can-i-test-nmaas)
+- [How can I start monitoring my infrastructure with nmaas?](#how-can-i-start-monitoring-my-infrastructure-with-nmaas)
+- [How can I request creation of new nmaas domain for my NREN / Institution / Project?](#how-can-i-request-creation-of-new-nmaas-domain-for-my-nreninstitutionproject)
+- [How can I deploy nmaas on my own intrastructure?](#how-can-i-deploy-nmaas-on-my-own-infrastructure)
+- [Where can I find nmaas User Guide?](#where-can-i-find-nmaas-user-guide)
+- [Where can I find nmaas Administrator Guide?](#where-can-i-find-nmaas-administrator-guide)
+- [What applications are currently supported by nmaas?](#what-applications-are-currently-supported-by-nmaas)
+- [What type of VPNs are established by nmaas?](#what-type-of-vpns-are-established-by-nmaas)
+- [What VPN solutions are supported by nmaas?](#what-vpn-solutions-are-supported-by-nmaas)
+- [What are nmaas VPN requirements?](#what-are-nmaas-vpn-requirements)
+
+## How can I contact the nmaas Team members?
+
+The nmaas Team can be contacted either by:
<div style="margin-left: 20px">
<li>contact form available at <a href="http://nmaas.eu/about?type=CONTACT">http://nmaas.eu/about?type=CONTACT</a></li>
<li>email sent to <a href="mailto:nmaas@lists.geant.org">nmaas@lists.geant.org</a></li>
</div>
-## How can I test NMaaS?
+## How can I test nmaas?
-In order to test NMaaS visit the NMaaS sandbox instance at https://nmaas.geant.org.
+In order to test nmaas visit the nmaas sandbox instance at https://nmaas.geant.org.
-Once You log in to the Portal, the NMaaS administrator will receive an automatic notification and will add You as a member of the pre-configured Test domain. In this domain, You will be able to freely browse, deploy and access applications.
+Once You log in to the Portal, the nmaas administrator will receive an automatic notification and will add You as a member of the pre-configured Test domain. In this domain, You will be able to freely browse, deploy and access applications.
-More information about the NMaaS sandbox is available at [NMaaS Playground page](https://wiki.geant.org/display/NMAAS/NMaaS+Playground).
+More information about the nmaas sandbox is available at [nmaas Playground page](https://wiki.geant.org/display/NMAAS/NMaaS+Playground).
-## How can I start monitoring my infrastructure with NMaaS?
-The GÉANT NMaaS production service is available at https://nmaas.eu where users have the possibility to log in with their eduGAIN accounts.
+## How can I start monitoring my infrastructure with nmaas?
+The GÉANT nmaas production service is available at https://nmaas.eu where users have the possibility to log in with their eduGAIN accounts.
However, in order to be able to deploy network management applications user needs to be assigned to a domain.
-In order to request new dedicated domain creation refer to question <i>"How can I request creation of new NMaaS domain for my NREN/Institution/Project?"</i>
+In order to request new dedicated domain creation refer to question <i>"How can I request creation of new nmaas domain for my NREN/Institution/Project?"</i>
-## How can I request creation of new NMaaS domain for my NREN/Institution/Project?
+## How can I request creation of new nmaas domain for my NREN/Institution/Project?
-In order to request a new NMaaS domain on the GÉANT production service fill in and submit the form available at https://nmaas.eu/about?type=NEW_DOMAIN_REQUEST.
+In order to request a new nmaas domain on the GÉANT production service fill in and submit the form available at https://nmaas.eu/about?type=NEW_DOMAIN_REQUEST.
You will be requested to provide some basic information about the domain to be created and a brief justification of the request.
-Your request will be reviewed by the NMaaS Team and You will receive a reply as soon as possible.
+Your request will be reviewed by the nmaas Team and You will receive a reply as soon as possible.
In case of any issues, You can also email your request directly to nmaas@lists.geant.org.
-## How can I deploy NMaaS on my own infrastructure?
+## How can I deploy nmaas on my own infrastructure?
-The complete information about the deployment of NMaaS instance is available at [NMaaS Installation Guide](https://wiki.geant.org/display/NMAAS/NMaaS+Installation+Guide).
+The complete information about the deployment of nmaas instance is available at [nmaas Installation Guide](self-hosted-nmaas/install-guide.md)).
-What are the technical requirement for the underlying NMaaS infrastructure?
+What are the technical requirement for the underlying nmaas infrastructure?
-The complete information about the requirements for the NMaaS Kubernetes cluster are available at [NMaaS Cluster Requirements](https://wiki.geant.org/display/NMAAS/NMaaS+Cluster+Requirements).
+The complete information about the requirements for the nmaas Kubernetes cluster are available at [nmaas Cluster Requirements](https://wiki.geant.org/display/NMAAS/NMaaS+Cluster+Requirements).
-## Where can I find NMaaS User Guide?
-The NMaaS User Guide is available at [NMaaS User Guide](https://wiki.geant.org/display/NMAAS/NMaaS+User+Guide).
+## Where can I find nmaas User Guide?
+The nmaas User Guide is available at [nmaas User Guide](guides/user-guide.md).
-## Where can I find NMaaS Administrator Guide?
-The NMaaS Administrator guide is under preparation ...
+## Where can I find nmaas Administrator Guide?
+The nmaas Administrator guide is under preparation and an initial version is available at [nmaas Administrator Guide](guides/domain-admin-guide.md)
-## What applications are currently supported by NMaaS?
-For the up to date information about the supported applications refer to page NMaaS Tools.
+## What applications are currently supported by nmaas?
+For the up to date information about the supported applications refer to page nmaas Tools.
-It is also possible to browse all the applications in on NMaaS Portal directly at https://nmaas.eu.
+It is also possible to browse all the applications in on nmaas Portal directly at https://nmaas.eu.
-## What type of VPNs are established by NMaaS?
-Two types of VPN connections are configured before a user is able to deploy and effectively used NMaaS applications:
+## What type of VPNs are established by nmaas?
+Two types of VPN connections are configured before a user is able to deploy and effectively used nmaas applications:
-- **site-to-site VPN** connection as a secure tunnel from the customer's management VLAN to NMaaS infrastructure, used for monitoring of the network equipment
-- **client-access VPN** used by the network operators, from their own workstations, to access and configure the deployed network management applications within NMaaS.
+- **site-to-site VPN** connection as a secure tunnel from the customer's management VLAN to nmaas infrastructure, used for monitoring of the network equipment
+- **client-access VPN** used by the network operators, from their own workstations, to access and configure the deployed network management applications within nmaas.
-## What VPN solutions are supported by NMaaS?
+## What VPN solutions are supported by nmaas?
Currently, two site-to-site VPN technologies are actively supported: OpenVPN and WireGuard.
For client-access VPN we are using OpenVPN.
-## What are NMaaS VPN requirements?
-To use NMaaS, prospective customers require two VPN connections:
+## What are nmaas VPN requirements?
+To use nmaas, prospective customers require two VPN connections:
-- site-to-site VPN connection, establishing a secure tunnel from the customer's management VLAN to NMaaS, used for monitoring of the network equipment
-- client-access VPN used by the network operators, from their own workstations, to access and configure the deployed network management applications within NMaaS.
+- site-to-site VPN connection, establishing a secure tunnel from the customer's management VLAN to nmaas, used for monitoring of the network equipment
+- client-access VPN used by the network operators, from their own workstations, to access and configure the deployed network management applications within nmaas.
Currently, two site-to-site VPN technologies are actively supported: OpenVPN and WireGuard.
@@ -90,28 +90,28 @@ More details are available in the subsections below.
<details>
<summary>Site-to-site VPN setup...</summary>
<h3>Site-to-site VPN</h3>
-In order to be able to use NMaaS, a secure site-to-site tunnel connection is required that will be used for all the monitoring traffic between the network management applications deployed on the NMaaS infrastructure and the customer's network devices. As mentioned above, two VPN technologies are currently actively supported for establishing a site-to-site VPN tunnel: OpenVPN and WireGuard. Any one of these can be chosen, depending on the customer's preference or existing networking stack.
+In order to be able to use nmaas, a secure site-to-site tunnel connection is required that will be used for all the monitoring traffic between the network management applications deployed on the nmaas infrastructure and the customer's network devices. As mentioned above, two VPN technologies are currently actively supported for establishing a site-to-site VPN tunnel: OpenVPN and WireGuard. Any one of these can be chosen, depending on the customer's preference or existing networking stack.
<h4>Required Information</h4>
-No matter the chosen VPN technology, the NMaaS team requires the following information before VPN connectivity can be established:
+No matter the chosen VPN technology, the nmaas team requires the following information before VPN connectivity can be established:
<div style="margin-left: 20px">
-<li>a list of subnets in your local network that you would like to be reachable from NMaaS. This is required so that we can configure the necessary routing rules and policies on our side. Most likely this will be your management VLAN(s)</li>
+<li>a list of subnets in your local network that you would like to be reachable from nmaas. This is required so that we can configure the necessary routing rules and policies on our side. Most likely this will be your management VLAN(s)</li>
<li>the public IP of the device that you will use to establish the VPN connection</li>
</div>
-If WireGuard is the chosen connection method, then information about the public keys will have to be exchanged between the customer and the NMaaS team as well.
+If WireGuard is the chosen connection method, then information about the public keys will have to be exchanged between the customer and the nmaas team as well.
<h4>Establishing the VPN connection</h4>
-Once the necessary information has been exchanged, the NMaaS team will provision the necessary VPN and the customer will be sent additional information on how to connect to it. This information will include:
+Once the necessary information has been exchanged, the nmaas team will provision the necessary VPN and the customer will be sent additional information on how to connect to it. This information will include:
<div style="margin-left: 20px">
-<li>the VPN tunnel subnet used for interconnecting the customer's site to NMaaS</li>
-<li>the private subnet that has been assigned to the customer and that will be used as an IP pool for every deployed application through NMaaS</li>
+<li>the VPN tunnel subnet used for interconnecting the customer's site to nmaas</li>
+<li>the private subnet that has been assigned to the customer and that will be used as an IP pool for every deployed application through nmaas</li>
<li>a list of additional auxiliary subnets for which the necessary routing information will have to be added by the customer at their end</li>
</div>
-If the customer does not have an existing network device that can be used for terminating the VPN connection, then a simple GNU/Linux virtual machine can be deployed, no matter the chosen VPN technology. This virtual machine will act as a VPN client in terms of the site-to-site tunnel , and as a gateway towards the NMaaS infrastructure for all the network devices in the customer's network. The customer must make sure that appropriate routing rules are configured so that traffic destined for the NMaaS subnets goes through the VPN client, and not through the default gateway in this scenario.
+If the customer does not have an existing network device that can be used for terminating the VPN connection, then a simple GNU/Linux virtual machine can be deployed, no matter the chosen VPN technology. This virtual machine will act as a VPN client in terms of the site-to-site tunnel , and as a gateway towards the nmaas infrastructure for all the network devices in the customer's network. The customer must make sure that appropriate routing rules are configured so that traffic destined for the nmaas subnets goes through the VPN client, and not through the default gateway in this scenario.
<br><br>
<div style="border: 2px solid gray; border-radius: 5px; padding: 10px;">
-The customer should make sure that the appropriate routing rules are configured in their network so that their VPN client acts as a gateway towards the NMaaS' subnets.
+The customer should make sure that the appropriate routing rules are configured in their network so that their VPN client acts as a gateway towards the nmaas' subnets.
</div>
<h4>Testing the VPN connection</h4>
-After establishing the VPN connection, the client can perform a simple test to verify that everything is working as expected. The test involves accessing a special IP address on port 80. This special address is customer dependent and will be provided by the NMaaS team during the registration process. Any command line utility that can open TCP sessions on an arbitrary port can be used for this test, depending on the platform that you are testing from.
+After establishing the VPN connection, the client can perform a simple test to verify that everything is working as expected. The test involves accessing a special IP address on port 80. This special address is customer dependent and will be provided by the nmaas team during the registration process. Any command line utility that can open TCP sessions on an arbitrary port can be used for this test, depending on the platform that you are testing from.
<br>
Note that ICMP and echo requests are not supported on this IP, and ping is not expected to work.
</details>
@@ -119,25 +119,25 @@ Note that ICMP and echo requests are not supported on this IP, and ping is not e
<details>
<summary>Client-access VPN setup...</summary>
<h3>Client-access VPN</h3>
-A client-access VPN connection is used for accessing and interacting with the deployed applications within NMaaS. In order to provide greater security and isolation between the customers, by default, all applications deployed by NMaaS are accessible only through the respective client-access profiles, and not publicly. However, the option for publicly exposing a given application is also possible. Currently, the preferred way for establishing the client-access connections is by using an OpenVPN tunnel, since it offers stable packages for all major operating systems.
+A client-access VPN connection is used for accessing and interacting with the deployed applications within nmaas. In order to provide greater security and isolation between the customers, by default, all applications deployed by nmaas are accessible only through the respective client-access profiles, and not publicly. However, the option for publicly exposing a given application is also possible. Currently, the preferred way for establishing the client-access connections is by using an OpenVPN tunnel, since it offers stable packages for all major operating systems.
<br>
-The only information required before the client-access profiles can be generated is a list of individuals, along with their full names and email addresses that should have access to the new NMaaS domain being created.
+The only information required before the client-access profiles can be generated is a list of individuals, along with their full names and email addresses that should have access to the new nmaas domain being created.
<h4>Testing the VPN connection</h4>
-The client-access connection can be tested in a similar fashion to the site-to-site connection. The operator, after connecting to the NMaaS VPN server can simply open a browser and type in the IP address provided by the NMaaS team during the registration process.
+The client-access connection can be tested in a similar fashion to the site-to-site connection. The operator, after connecting to the nmaas VPN server can simply open a browser and type in the IP address provided by the nmaas team during the registration process.
</details>
<details>
<summary>Required information for the VPN profiles...</summary>
<h3>Required information for the VPN profiles</h3>
-In conclusion, accessing NMaaS requires two types of VPN connections: a site-to-site, and a client-access.
+In conclusion, accessing nmaas requires two types of VPN connections: a site-to-site, and a client-access.
<br>
-Before the site-to-site profiles can be created, NMaaS requires the following information:
+Before the site-to-site profiles can be created, nmaas requires the following information:
<div style="margin-left: 20px">
<li>the public IP of the device that will act as the VPN client</li>
<li>a list of additional auxiliary subnets for which the necessary routing information will have to be added by the customer at their end</li>
</div><br>
Before the client-access profile can be created, the following information is needed:
<div style="margin-left: 20px">
-<li>a list of individuals that need access to the applications deployed in the new NMaaS domain, including their full names and email addresses.</li>
+<li>a list of individuals that need access to the applications deployed in the new nmaas domain, including their full names and email addresses.</li>
</div>
</details>
diff --git a/docs/guides/application-manager-guide.md b/docs/guides/application-manager-guide.md
index 8c2f48cf58110ee65c83c4e868e3553202096a62..3c820f828dc8de98c547ee9f012027070bd5de80 100644
--- a/docs/guides/application-manager-guide.md
+++ b/docs/guides/application-manager-guide.md
@@ -5,13 +5,13 @@
## Introduction
-The information about applications supported by given NMaaS instance is managed from the NMaaS Portal level.
+The information about applications supported by a given nmaas instance is managed from the nmaas Portal of the given installatio.
A dedicated wizard composed of several forms was developed to ease this management operation and guide the user (with appropriate role assigned) through the process of adding new or updating existing application information.
In order to access the applications management area user should open the `Settings` drop down menu available on the top navigation bar and click the Applications button.
-The main view lists all the applications available in this particular NMaaS installation or a filtered list of applications to which a given user has management access. For each application its `Name` and `Owner` user is provided. When an application entry is clicked subsequent information about available versions of particular application and their status is displayed.
+The main view lists all the applications available in this particular nmaas installation or a filtered list of applications to which a given user has management access. For each application its `Name` and `Owner` user is provided. When an application entry is clicked subsequent information about available versions of particular application and their status is displayed.
The application version statuses are the following:
@@ -40,33 +40,33 @@ From this view an `Application manager` can perform the following actions:
!!! info
- The applications from the NMaaS portfolio are being deployed on Kubernetes. To this end each application has to be containerized and described in the form of a Helm chart.
+ The applications from the nmaas portfolio are being deployed on Kubernetes. To this end each application has to be containerized and described in the form of a Helm chart.
!!! info
The application administration option is available only for users with System administrator or Application manager roles assigned.
The Application manager has the possibility to add new applications to the portfolio as well as to manage applications user owns (meaning applications added by the user or for which the System administrator assigned the user as an owner.
-## Adding New Application
+## Adding a New Application
-Once granted the `Application manager` role user is able to submit new applications to the system.
+Once granted the `Application manager` role, the user is able to submit new applications to the system.
A complete application definition in the system comprises on one side a general set of information about the application (e.g. its name and logo) and on the other side data specific to particular version of the application (e.g. its deployment details). It is assumed that the general part is common for all the versions of the applications however the specific details may vary for different versions.
The required data will need to be provided on a number of forms.
-First user is requested to confirm that he has the right to publish particular application on NMaaS (for example by verifying its license conditions).
+First, the user is requested to confirm that they have the right to publish particular application on nmaas (for example by verifying its license conditions).
-In order to proceed user should check the checkbox and click on the Next button.
+In order to proceed the user should check the checkbox and click on the `Next` button.
!!! warning
- If users leaves the new application wizard before submitting the information on the last form all the entered data will be lost
+ If the users leaves the new application wizard before submitting the information on the last form all the entered data will be lost.
!!! info
- A newly pushed application needs to be reviewed and approved by the `System administrator`. Only then is becomes `Active` and available in the portfolio
+ A newly pushed application needs to be reviewed and approved by the `System administrator`. Only then is becomes `Active` and available in the portfolio.
### Providing Application Basic Information
@@ -79,7 +79,7 @@ The first basic information form comprises the following fields:
- `Project website` - link to the original website with additional information about the Application
- `Link to source code` - link to the repository with source code of the Application (e.g. on GitHub)
- `Link to project issues` - link to the website for publishing and tracking issues related with Application (e.g. on GitHub)
-- `NMaaS Documentation URL` - link to a custom NMaaS provider website containing additional documentation about the Application (e.g. deployment options and consideration)
+- `nmaas Documentation URL` - link to a custom nmaas provider website containing additional documentation about the Application (e.g. deployment options and consideration)
- `Select tags for application` *(mandatory)* - selection of tags that best describe the Application from an existing list
- A`dd new tags for your application` - names of new (not found on the drop down selector) tags to be assigned to the Application (multiple tags can be provided, each tag needs to be confirmed with `Enter`)
@@ -89,7 +89,7 @@ The first basic information form comprises the following fields:
-In order to proceed user should click on the `Next` button.
+In order to proceed, the user should click on the `Next` button.
### Providing Application Logo and Screenshots
@@ -100,7 +100,7 @@ Once `Choose` button is clicked a file selection window is displayed allowing th
!!! info
- Multiple graphical file formats are supported including `svg`, `png` and `jpg`
+ Multiple graphical file formats are supported including `svg`, `png` and `jpg`.
In order to proceed user should click on the `Next` button.
@@ -122,7 +122,7 @@ By default only input fields for texts in English are displayed. Dedicated field
The fourth form enables the `Application manager` to enter all the necessary information to allow for a fully automated deployment of new instances of particular Application.
-NMaaS applications are deployed using Helm thus is it mandatory to provide the respective Helm chart details and all the custom parameters to be passed as values during Helm chart installation.
+nmaas applications are deployed using Helm thus is it mandatory to provide the respective Helm chart details and all the custom parameters to be passed as values during Helm chart installation.
#### General information fields
@@ -137,7 +137,7 @@ NMaaS applications are deployed using Helm thus is it mandatory to provide the r
!!! info
- In general enabling user direct access to running containers shell of given Application is strongly discouraged. However, in order to allow such access and mitigate at least some of the risks, a built-in shell terminal was made available in the Portal.
+ In general, enabling direct user access to running containers of a given application is strongly discouraged. However, in order to allow such access and mitigate at least some of the risks, a built-in shell terminal was made available in the Portal.
#### Global Deploy Parameters
diff --git a/docs/guides/domain-admin-guide.md b/docs/guides/domain-admin-guide.md
index 9f1deabd5718d8999973b3d6e0794b4043e4c184..15d0aae33b8425a70120a9132d36b4cb4d21dc4c 100644
--- a/docs/guides/domain-admin-guide.md
+++ b/docs/guides/domain-admin-guide.md
@@ -2,12 +2,12 @@
## Domain Administrator Role
-Before being able to deploy and/or access application instances via the NMaaS Portal user needs to be assigned to a Domain.
+Before being able to deploy and/or access application instances via the nmaas Portal user needs to be assigned to a Domain.
!!! info
In order to apply for a new domain creation submit the form available at https://nmaas.eu/about?type=NEW_DOMAIN_REQUEST.
-Within a domain user can be granted one of three roles as described in the [NMaaS User Guide](./user-guide.md). Domain needs to have at least one `Domain administrator`.
+Within a domain user can be granted one of three roles as described in the [nmaas User Guide](./user-guide.md). Domain needs to have at least one `Domain administrator`.
The initial assignment of that role in newly created domain is performed by administrators based on the received domain creation request.
diff --git a/docs/guides/user-guide.md b/docs/guides/user-guide.md
index 558720b459f3c043346d0f4f07a101542b72130f..3a90cb18e14df92bdf4bac722ef0c76c69c0b96a 100644
--- a/docs/guides/user-guide.md
+++ b/docs/guides/user-guide.md
@@ -3,9 +3,9 @@
!!! warning Work in Progress
This guide is currently a work in progress. Some sections might be missing or contain incomplete information.
-## 1. NMaaS Domains
+## 1. nmaas Domains
-A domain in NMaaS corresponds to a dedicated and isolated tenant environment created within the system for particular institution, project, team or in general a group of users.
+A domain in nmaas corresponds to a dedicated and isolated tenant environment created within the system for particular institution, project, team or in general a group of users.
!!! info "Domain Assignment"
User can be assigned to multiple domains.
@@ -13,9 +13,9 @@ A domain in NMaaS corresponds to a dedicated and isolated tenant environment cre
!!! info "Requesting a New Domain"
In order to apply for a new domain creation submit the form available at https://nmaas.eu/about?type=NEW_DOMAIN_REQUEST.
-## 2. Introduction to NMaaS User Roles
+## 2. Introduction to nmaas User Roles
-NMaaS specifies user roles on two levels: global (system) level and user domain level.
+nmaas specifies user roles on two levels: global (system) level and user domain level.
Roles on each level can be assigned independently.
@@ -30,7 +30,7 @@ The remaining roles on the global level are:
- **System administrator** - gives the user the complete system administration rights in the Portal (including user, domain and application management)
!!! info "Additional Information"
- For Application manager and Domain administrator user guides visit [NMaaS Application Manager Guide](./application-manager-guide.md) and [NMaaS Domain Admin Guide](./domain-admin-guide.md)
+ For Application manager and Domain administrator user guides visit [nmaas Application Manager Guide](./application-manager-guide.md) and [nmaas Domain Admin Guide](./domain-admin-guide.md)
### 2.2 Domain Level Roles
@@ -48,19 +48,19 @@ These roles are assigned per user domain. A single user may have different roles
!!! info "VPN Requirements"
In order to access the applications running within a particular domain user needs to connect to a dedicated VPN that is being set up independently of the user account within the Portal
-## 3. NMaaS Portal
+## 3. nmaas Portal
-NMaaS web-based graphical user interface can be accessed by browsing to address https://nmaas.eu.
+nmaas web-based graphical user interface can be accessed by browsing to address https://nmaas.eu.
-NMaaS landing page contains a basic set of information about the NMaaS concept and the service. Users are required to log in to gain access to the actual application market.
+nmaas landing page contains a basic set of information about the nmaas concept and the service. Users are required to log in to gain access to the actual application market.
-The NMaaS Portal in available in four languages including English, French, German and Polish (though still not all texts might be properly translated in languages apart from English).
+The nmaas Portal in available in four languages including English, French, German and Polish (though still not all texts might be properly translated in languages apart from English).
### 3.1 About
-The About page available from the top bar menu contains information about current and past NMaaS software versions and a contact form being the preferred way of reaching out to the NMaaS team regarding any subject.
+The About page available from the top bar menu contains information about current and past nmaas software versions and a contact form being the preferred way of reaching out to the nmaas team regarding any subject.
## 4. User Login
@@ -87,7 +87,7 @@ Registration form contains several mandatory fields, which are: `Username`, `Pas
The provided `Username` has to be at least 3 letters long.
-The user also has to confirm that he has read the NMaaS Privacy Notice text.
+The user also has to confirm that they have read the nmaas Privacy Notice text.
There are also few optional fields, namely `First name`, `Last name` and `Domain selection`.
@@ -97,11 +97,11 @@ A user needs to be assigned a specific role within particular domain in order to
## 6. Application Market
-After the user account has been activated by the NMaaS administrator (in the case when the user submitted the registration form), they are able to log in and are granted a basic access to the main NMaaS applications view. Same access rights are granted to users that log in through eduGAIN for the first time.
+After the user account has been activated by the nmaas administrator (in the case when the user submitted the registration form), they are able to log in and are granted a basic access to the main nmaas applications view. Same access rights are granted to users that log in through eduGAIN for the first time.
-On the `Applications` tab all of the applications supported by NMaaS are enlisted. Applications can be filtered by tags and sorted by few criteria. User can also search them by name.
+On the `Applications` tab all of the applications supported by nmaas are enlisted. Applications can be filtered by tags and sorted by few criteria. User can also search them by name.
Single application tile consists of the logo, name, brief description and current rating of the application. Clicking on a tile redirects the user to the application’s details page.
@@ -110,7 +110,7 @@ Single application tile consists of the logo, name, brief description and curren
## 7. Application Subscriptions and Instances
-Once a user is granted a role inside a particular Domain they are able to view the content of the `Subscriptions` tab. This view comprises applications subscribed for his domain by a Domain administrator. Only these applications can be further deployed in the NMaaS cloud within the scope of particular domain.
+Once a user is granted a role inside a particular Domain they are able to view the content of the `Subscriptions` tab. This view comprises applications subscribed for his domain by a Domain administrator. Only these applications can be further deployed in the nmaas cloud within the scope of particular domain.
In order to subscribe to a given application user needs to open the details view of chosen application and click the `Subscribe` button.
@@ -125,7 +125,7 @@ Application instances are described by custom Name assigned during deployment, n
### 8.1 Application Details View
-On the application details page user can view a basic description of the application, example screenshots of the user interface, references to its website, code repository, website for registering issues and the versions of the application currently available on NMaaS.
+On the application details page user can view a basic description of the application, example screenshots of the user interface, references to its website, code repository, website for registering issues and the versions of the application currently available on nmaas.
@@ -152,7 +152,7 @@ The installation process comprises few steps including subscription validation,
Once the installation process is completed the user is provided with a way or multiple ways of accessing the deployed application instance depending on the application (in majority of cases a link for accessing the web-based UI).
!!! info "Importance of the Provided Instance Name"
- Providing a suitable instance name is important since it is later on used to create a FQDN unique for this application instance following pattern: `<instance name>.<user domain name>.<NMaaS base domain>` (e.g. vminstance.pllab.nmaas.eu)
+ Providing a suitable instance name is important since it is later on used to create a FQDN unique for this application instance following pattern: `<instance name>.<user domain name>.<nmaas base domain>` (e.g. vminstance.pllab.nmaas.eu)
!!! info "Application Deployment Notifications"
User is notified with an email once the new application instance becomes available
@@ -173,7 +173,7 @@ Once all required fields are populated user can select the *Apply configuration*
Once the application instance reaches the `Active` state it can be accessed by the user.
-Multiple access methods are supported by NMaaS and each of the applications supports one or more of them.
+Multiple access methods are supported by nmaas and each of the applications supports one or more of them.
@@ -284,7 +284,7 @@ For applications that support the Git-based configuration management model, mean
-Upon key upload or update in the Portal, user information is synchronized with the user account created on the GitLab instance associated with given NMaaS installation.
+Upon key upload or update in the Portal, user information is synchronized with the user account created on the GitLab instance associated with given nmaas installation.
### 9.4 Password Change
@@ -297,9 +297,9 @@ On clicking the `Change password` button, a new window will be displayed where t
## 10. Contact Form
-An easy and recommended way for contacting the NMaaS Team is through the Contact Form.
+An easy and recommended way for contacting the nmaas Team is through the Contact Form.
-The Contact Form is available on the About page along with the information about the versions of the NMaaS software.
+The Contact Form is available on the About page along with the information about the versions of the nmaas software.
diff --git a/docs/img/favicon.ico b/docs/img/favicon.ico
index 2cb7f9d9710124cd8eb447960fcc4710854b37a2..3f1a6d0b085b289ede1fb0078657388f168c2214 100644
Binary files a/docs/img/favicon.ico and b/docs/img/favicon.ico differ
diff --git a/docs/img/nmaas-new.jpg b/docs/img/nmaas-new.jpg
new file mode 100644
index 0000000000000000000000000000000000000000..d46da1b1edc1c7fe69da3ea58ad8dc5b6686d224
Binary files /dev/null and b/docs/img/nmaas-new.jpg differ
diff --git a/docs/img/nmaas_blue_gr.png b/docs/img/nmaas_blue_gr.png
new file mode 100644
index 0000000000000000000000000000000000000000..2790aa3f466f627706c59bdf8ecb8ad0e1f6499b
Binary files /dev/null and b/docs/img/nmaas_blue_gr.png differ
diff --git a/docs/img/nmaas_white.png b/docs/img/nmaas_white.png
new file mode 100644
index 0000000000000000000000000000000000000000..2192d14b1552bfa701b2bde3dfc983568039276e
Binary files /dev/null and b/docs/img/nmaas_white.png differ
diff --git a/docs/img/nmaas_white_text.png b/docs/img/nmaas_white_text.png
new file mode 100644
index 0000000000000000000000000000000000000000..6d2eb6d91986afee91f45d17c29304a0e96fe940
Binary files /dev/null and b/docs/img/nmaas_white_text.png differ
diff --git a/docs/index.md b/docs/index.md
index 0c28861bc70997769e2660aeae56dc179a21cc55..854c71c74c7398d9b1fc342d9c2ec976c9e4aa10 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -1,17 +1,24 @@
-# **NMaaS** home
+# **nmaas** Home
-## **Overview**
+nmaas or nmaas Platform is an open-source orchestration software that allows deployment of various containerized applications in a Kubernetes cluster. It is a versatile solution with many possible use-cases, two of which are currently actively supported in the context of the GÉANT project:
-The cost and complexity of developing and integrating in-house network management may be too high for many NRENs (National Research and Education Networks), institutions, projects or teams. Off-the-shelf solutions might not be suitable and might be costly.
+- nmaas Virtual NOC
+- nmaas Virtual Lab
-Network Management as a Service (NMaaS) aims to support these users in providing an effective, efficient network and service management platform. NMaaS enables management and monitoring of user networks through on-demand deployment of network management tools in a Kubernetes-based cloud infrastructure. Using a multi-tenant approach and software based VPNs, each NREN or institution has private access to their network management systems and services from a highly available cloud based platform.
+All use-cases take advantage of the same version of the nmaas Platform, and all of the functionality is available in the base version of the software. What distinguishes them is the way in which they are utilized.
-NMaaS is meant for smaller and emerging NRENs, campuses, small organisations or distributed research projects that may have limited resources to develop and/or maintain their own NMS infrastructure or planned to outsource these activities. By using a shared and supported platform, institutions can focus solely on the monitoring and management of their service components. It is also suitable for use in those NRENs which provide campus network management service (CNaaS) to their institutions. Using NMaaS, NRENs can easily provide per-campus network management software instances.
+nmaas Virtual NOC is the new name for what was formerly known as NMaaS (Network Management as a Service). With the pivot of the nmaas Platform to a general purpose application orchestration tool, not limited solely to network management, NMaaS was renamed to nmaas Virtual NOC to avoid any confusion. More details about the Virtual NOC use-case are available on the [nmaas Virtual NOC page](use-cases/virtual-noc/vnoc-introduction.md).
-## Managed NMaaS
+nmaas Virtual Lab is a brand new use-case built on top of the nmaas Platform, introducing many new exciting features that ease the process of organizing hands-on exercises in an educational context. More information about the Virtual Lab use-case is available on the [nmaas Virtual Lab page](use-cases/virtual-lab/vlab-introduction.md).
-NMaaS (https://nmaas.eu) is offered within the GÉANT project as a [managed service](https://docs.nmaas.eu/managed-nmaas/introduction/) since December 2018. Currently, the portfolio of tools offered by NMaaS consists of over 30 applications including Oxidized, LibreNMS, Prometheus, Grafana, Zabbix, NetBox and others.
+## Managed nmaas Instances
-## Self-hosted NMaaS
+The nmaas team offers access to multiple managed instances, depending on the use-case and overall context:
-NMaaS [self-hosting](https://docs.nmaas.eu/self-hosted-nmaas/introduction/) options are also available for users having access to an existing Kubernetes infrastructure.
+- [The nmaas Virtual NOC production instance](managed-nmaas/introduction.md/#the-virtual-noc-managed-instance) available on [https://nmaas.eu](https://nmaas.eu)
+- [The nmaas Virtual Lab pilots instance](managed-nmaas/introduction.md/#the-virtual-lab-managed-instance) available on [https://vlab.dev.nmaas.eu](https://vlab.dev.nmaas.eu).
+- [The generic Playground instance](managed-nmaas/nmaas-playground-instance.md) for testing out the overall feature set of nmaas.
+
+## Self-hosted nmaas
+
+nmaas [self-hosting](https://docs.nmaas.eu/self-hosted-nmaas/introduction/) options are also available for users having access to an existing Kubernetes infrastructure.
diff --git a/docs/managed-nmaas/introduction.md b/docs/managed-nmaas/introduction.md
index a2afe54dcceddcbd8232489ad396f2d967c7f01b..733eff12346fa45b9feca3cc8110f3ff521af2c2 100644
--- a/docs/managed-nmaas/introduction.md
+++ b/docs/managed-nmaas/introduction.md
@@ -1,3 +1,14 @@
-# Introduction to Managed NMaaS
+# Introduction to Managed nmaas Instances
-Work in progress. Content will be provided soon!
+The GEANT project offers two managed instances of nmaas, dedicated to specific use-cases:
+
+- The nmaas Virtual NOC managed instance hosted at [https://nmaas.eu](https://nmaas.eu)
+- The nmaas Virtual Lab managed instance hosted at [https://vlab.dev.nmaas.eu](https://vlab.dev.nmaas.eu)
+
+## The Virtual NOC Managed Instance
+
+The [nmaas Virtual NOC managed instance](https://nmaas.eu) is aimed at NRENs or NREN end-institutions and provides an effortless way of getting started with basic network monitoring and management. Potential users can request on-boarding into the nmaas Virtual NOC managed instance by filling out the `New domain request` form available on [https://nmaas.eu/about](https://nmaas.eu/about).
+
+## The Virtual Lab Managed Instance
+
+The [nmaas Virtual Lab managed instance](https://vlab.dev.nmaas.eu) acts as a demo environment for testing the newly developed features enabling the Virtual Lab use-case. It can support small scale exercises with around 20 students. In cases of bigger courses, institutions are encouraged to deploy an nmaas instance locally, on their own infrastructure. Interested users in either evaluating nmaas Virtual Lab on the managed instance or deploying it on their own infrastructure can get in touch with the nmaas team using one of the [contact methods](../contact.md).
\ No newline at end of file
diff --git a/docs/managed-nmaas/nmaas-playground-instance.md b/docs/managed-nmaas/nmaas-playground-instance.md
index 102c004897058420d1bee9d0e2736b1c00e4a48e..fe859d030a3eed3f8fa52998824000b561511f04 100644
--- a/docs/managed-nmaas/nmaas-playground-instance.md
+++ b/docs/managed-nmaas/nmaas-playground-instance.md
@@ -1,37 +1,37 @@
-# NMaaS Playground Instance
+# nmaas Playground Instance
## Introduction
-NMaaS Playground is an NMaaS central installation that can be used by anyone interested in testing latest versions of NMaaS.
+The nmaas Playground is a central installation that can be used by anyone interested in testing latest versions of the nmaas Platform.
It is available at [https://nmaas.geant.org](https://nmaas.geant.org).
-NMaaS Playground is deployed on GÉANT's infrastructure and is maintained by the NMaaS Team.
+The nmaas Playground is deployed on GÉANT's infrastructure and is maintained by the nmaas Team.
-Any questions or requests related with using the NMaaS Playground should be directed to [nmaas@lists.geant.org](mailto:nmaas@lists.geant.org).
+Any questions or requests related with using the nmaas Playground should be directed to [nmaas@lists.geant.org](mailto:nmaas@lists.geant.org).
-It is important to note that the NMaaS Playground is tailored to enable users to browse and deploy NMaaS tools right away without any unnecessary overhead. However, this implies that the user isolation, access and data security rules applied on this NMaaS installation are not so strict as in the case of the official NMaaS production service (e.g. no dedicated VPNs are deployed).
+It is important to note that the nmaas Playground is tailored to enable users to browse and deploy nmaas tools right away without any unnecessary overhead. However, this implies that the user isolation, access and data security rules applied on this nmaas installation are not so strict as in the case of the official nmaas Virtual NOC production service (e.g. no dedicated VPNs are deployed).
!!! warning Usage Disclaimer
- NMaaS Playground should be used only for testing purposes and not for monitoring of actual user equipment
+ The nmaas Playground should be used only for testing purposes and not for monitoring of actual user equipment.
-For any information on how to use NMaaS refer the official NMaaS User Guide.
+For any information on how to use nmaas refer the official [nmaas User Guide](../guides/user-guide.md).
-## Accessing the Playground
+## Accessing the nmaas Playground
-In order to use the Playground a new user should either fill in the registration form to create a local account in the system or use the Federated login option.
+In order to use the nmaas Playground a new user should either fill in the registration form to create a local account in the system or use the Federated login option.
In both cases, the system administrator will have to manually add the new user to a Test domain that is pre-configured in the system.
-NMaaS domain corresponds to an institution, team or project (e.g. NREN, end institution, team within the GÉANT Project) whose users will be able to deploy instances of tools available in the NMaaS portfolio in order to manage and/or monitor the equipment within that domain.
+An nmaas domain corresponds to an institution, team or project (e.g. NREN, end-institution, team within the GÉANT Project) whose users will be able to deploy instances of tools available in the nmaas portfolio in order to manage and/or monitor the equipment within that domain.
-## Deploying NMaaS Tools
+## Deploying nmaas Tools
-The main purpose of using the NMaaS Playground is to deploy and access test instances of NMaaS Tools. From more information about the tools currently supported by NMaaS refer to [the application list](../nmaas-applications/application-list.md).
+The main purpose of using the nmaas Playground is to deploy and access test instances of nmaas Tools. From more information about the tools currently supported by nmaas refer to [the application list](../nmaas-applications/application-list.md).
-Running a network management tool without any equipment that can be monitored would not present the full potential of NMaaS. Therefore a virtual user network with various types of devices has been deployed and connected to the Test domain.
+Running a network management tool without any equipment that can be monitored would not present the full potential of nmaas. Therefore a virtual user network with various types of devices has been deployed and connected to the Test domain.
-While deploying a tool in the NMaaS Playground users can choose any subset of available devices to be monitored.
+While deploying a tool in the nmaas Playground users can choose any subset of available devices to be monitored.
The following table presents all the equipment available in the virtual user network together with any relevant information that later on needs to be provided in the configuration wizard during deployment of particular tool.
@@ -39,12 +39,10 @@ For example when deploying new instance of the Oxidized application, the user wi
| Device Identifier | Device Type | IP Address/URL | SSH Username/Password | SNMP Version/Community |
|-------------------|---------------------------|----------------|---------------------------|------------------------|
-| ... | ... | ... | ... | ... |
-| vmx-31 | Virtual Juniper MX Router | 10.0.0.31 | `geant` / `geant123` | v2c / `nmaas-public` |
| vmx-c1 | Virtual Juniper MX Router | 10.0.0.1 | `geant` / `geant123` | v2c / `nmaas-public` |
| vmx-c2 | Virtual Juniper MX Router | 10.0.0.2 | `geant` / `geant123` | v2c / `nmaas-public` |
-## Demo Instances of NMaaS Applications
+## Demo Instances of nmaas Applications
A set of tools have been deployed by default in the Test domain and configured to monitor the resources of the virtual user network and servers.
diff --git a/docs/nmaas-applications/application-list.md b/docs/nmaas-applications/application-list.md
index 1af736e7d9082ed25b91f27eaf5a8df49c0f0a58..3332eba5082d7b42c1966c727f4ce8808272d8e0 100644
--- a/docs/nmaas-applications/application-list.md
+++ b/docs/nmaas-applications/application-list.md
@@ -1,6 +1,6 @@
# List of Supported Applications
-This is a continuously updated list of currently supported applications on NMaaS. Note that not all applications are supported across all environments, some are supported only on the managed server, while others can only be supported on self-hosted installations.
+This is a continuously updated list of currently supported applications on nmaas. Note that not all applications are supported across all environments, some are supported only on the managed server, while others can only be supported on self-hosted installations.
| No | Application name | Helm chart name | App Version (Helm chart version given in brackets) | Environment |
|:--:|:------------------------------------:|:---------------------------------------:|:------------------------------------------------------------------------------------------------------------------------------------------:|-----------------------|
diff --git a/docs/nmaas-applications/general-app-deployment.md b/docs/nmaas-applications/general-app-deployment.md
index a95589fd82f6c8dd34544cfb6595c80bc38ea6d9..4423ae973d5788ba367fc0c866a1bc922455b886 100644
--- a/docs/nmaas-applications/general-app-deployment.md
+++ b/docs/nmaas-applications/general-app-deployment.md
@@ -1,12 +1,12 @@
# General Application Deployment
-This page explains the basic set of steps that need to be undertaken during application deployment on NMaaS.
+This page explains the basic set of steps that need to be undertaken during application deployment on nmaas.
-## NMaaS Tool Deployment Process
+## nmaas Tool Deployment Process
-A basic set of steps required to deploy an instance of an NMaaS application is the following:
+A basic set of steps required to deploy an instance of an nmaas application is the following:
-1. Log in to NMaaS Portal
+1. Log in to nmaas Portal
2. Choose application from the market
3. Request deployment and provide a custom name for the new instance
4. Follow the automated installation steps
@@ -19,7 +19,7 @@ The whole process shouldn't take more than several minutes.
-## NMaaS Tool Configuration Process
+## nmaas Tool Configuration Process
During the tool deployment process user is asked to fill in a form and provide basic configuration data for the new tool instance.
@@ -34,10 +34,10 @@ From this point any change to the configuration of a running tool instance shoul
3. Apply desired modifications, commit and push altered files back to the remote repository.
4. Wait for a couple of minutes in order for the new configuration to be loaded and applied by the tool instance.
-Note: Git repositories containing application configuration files are hosted on a dedicated private GitLab instance operated by the NMaaS Team.
+Note: Git repositories containing application configuration files are hosted on a dedicated private GitLab instance operated by the nmaas Team.
Note: Users should upload their public SSH key using the Profile page before deploying a new instance of a tool in order to be able to clone the Git repository afterwards.
## Specific Application Tutorials
-Tutorials for each of the supported applications currently in the NMaaS catalog are available in the [Application Deployment Tutorials Section](./tutorials/librenms.md).
\ No newline at end of file
+Tutorials for each of the supported applications currently in the nmaas catalog are available in the [Application Deployment Tutorials Section](./tutorials/librenms.md).
\ No newline at end of file
diff --git a/docs/nmaas-applications/new-application.md b/docs/nmaas-applications/new-application.md
index 37085d12621e29cb285b8fd1e286bd74cc1fcb5d..3d1780a8a3ecd0b21150970ab2e8d8df9dc578e2 100644
--- a/docs/nmaas-applications/new-application.md
+++ b/docs/nmaas-applications/new-application.md
@@ -1,13 +1,13 @@
# Adding a new Application
-Anyone can submit an application to be included to the NMaaS catalog, thus making it available to all users of the production instance. Each application should have at least one official maintainer who will regularly pull changes from the upstream project and provide updated Docker images and Helm charts. The source code for each Helm chart should be hosted in a separate Git repository.
+Anyone can submit an application to be included to the nmaas catalog, thus making it available to all users of the production instance. Each application should have at least one official maintainer who will regularly pull changes from the upstream project and provide updated Docker images and Helm charts. The source code for each Helm chart should be hosted in a separate Git repository.
A brief guide on how a new chart repository can be set up using the GitHub platform is presented below.
Please note that we do not require the use of GitHub or mandate a specific code hosting service. Any platform that is publicly accessible would suffice.
!!! note "Process Explanation"
- Applying for an application to be added to the NMaaS catalog is a two-step process. First, the chart needs to be created, and then a brief proposal submitted to the NMaaS team via email. After reviewing the chart, the user who submitted it will be assigned a new role on the production instance of NMaaS (https://nmaas.eu) – <i><u>tool manager</u></i>, which allows uploading of new versions and parameter changes.
+ Applying for an application to be added to the nmaas catalog is a two-step process. First, the chart needs to be created, and then a brief proposal submitted to the nmaas team via email. After reviewing the chart, the user who submitted it will be assigned a new role on the production instance of nmaas (https://nmaas.eu) – <i><u>tool manager</u></i>, which allows uploading of new versions and parameter changes.
## Step 1: Create a new GitHub Repository
@@ -258,7 +258,7 @@ You can find the generated link to your GitHub Pages website by navigating to Se
## Step 7: Generating a README File with Default Values for the Chart
-Each chart submitted for addition to the NMaaS catalog must have a README file containing all of the parameters that can be altered during its deployment. Such a README file can either be created manually or automatically. Helm-docs is one such tool for automated generation of chart descriptions.
+Each chart submitted for addition to the nmaas catalog must have a README file containing all of the parameters that can be altered during its deployment. Such a README file can either be created manually or automatically. Helm-docs is one such tool for automated generation of chart descriptions.
- Download the latest release of helm-docs from the official Releases page: https://github.com/norwoodj/helm-docs/releases
@@ -292,7 +292,7 @@ The workflow for releasing a new version of a chart is:
- creating a new pull request to merge these changes to `master`. At this point the linting task will be executed.
- merge the changes to the `master` branch. At this point the release task will be executed.
-If you want to see your chart added to the NMaaS catalog please contact [nmaas-admin@lists.geant.org](mailto:nmaas-admin@lists.geant.org) with the following information:
+If you want to see your chart added to the nmaas catalog please contact [nmaas-admin@lists.geant.org](mailto:nmaas-admin@lists.geant.org) with the following information:
- URL to the upstream source-code repository of the proposed application
- Brief description of its features
diff --git a/docs/nmaas-applications/tutorials/booked.md b/docs/nmaas-applications/tutorials/booked.md
index 1ef1adb38fbda16f197d7e67c32f7ef6b8637776..17917e3a7ffa6cac43ccdc1098f4ae12b5c8ff3c 100644
--- a/docs/nmaas-applications/tutorials/booked.md
+++ b/docs/nmaas-applications/tutorials/booked.md
@@ -11,7 +11,7 @@ A web-based calendar and resource scheduling system that allows administered man
## Default Credentials
-As stated in the [Base tab](#base-tab) section, the admin username is the administrator's email address that is specified during the deployment process directly from the NMaaS web interface. The default password is simply `password`. Users are strongly encouraged to change the default password of their admin accounts after the initial login.
+As stated in the [Base tab](#base-tab) section, the admin username is the administrator's email address that is specified during the deployment process directly from the nmaas web interface. The default password is simply `password`. Users are strongly encouraged to change the default password of their admin accounts after the initial login.
## Configuration wizard
diff --git a/docs/nmaas-applications/tutorials/changedetectionio.md b/docs/nmaas-applications/tutorials/changedetectionio.md
index 1dabf40398dc433f92fcfa9ac3ec627f4b1c17d2..d83137ea7be1c64c28b2244acf287ed4da2a7256 100644
--- a/docs/nmaas-applications/tutorials/changedetectionio.md
+++ b/docs/nmaas-applications/tutorials/changedetectionio.md
@@ -2,11 +2,11 @@
[ChangeDetection.io](https://github.com/dgtlmoon/changedetection.io) is an open-source tool for website change detection. It is capable of monitoring HTML and JSON files and can send various types of notifications when a change is detected.
-Using XPath or CSS selectors it is also possible to only watch specific page elements. Interactive websites relying heavily on JavaScript can be crawled using a headless Chrome instance which is also deployed on NMaaS together with the base application.
+Using XPath or CSS selectors it is also possible to only watch specific page elements. Interactive websites relying heavily on JavaScript can be crawled using a headless Chrome instance which is also deployed on nmaas together with the base application.
## Customizable Parameters
-ChangeDetection.io does not have any parameters that need to be customized during the initial deployment on NMaaS.
+ChangeDetection.io does not have any parameters that need to be customized during the initial deployment on nmaas.
All configuration is done from the built-in configuration manager accessible once the application is deployed.
@@ -36,7 +36,7 @@ All configuration is done from the built-in configuration manager accessible onc
ChangeDetection.io has support for various notification providers, using the [Apprise library](https://github.com/caronc/apprise). Details about each supported notification provider are given on the [Apprise Wiki](https://github.com/caronc/apprise/wiki), as well as on the [ChangeDetection.io wiki](https://github.com/caronc/apprise/wiki) pages.
-In terms of the managed NMaaS production instance, users can leverage the built-in mail sender, using the following configuration:
+In terms of the managed nmaas production instance, users can leverage the built-in mail sender, using the following configuration:
```
mailto://nmaas.eu:587?smtp=nmaas-postfix.nmaas-system&from=changedetection.$domain-name@nmaas.eu&to=$dest-email
diff --git a/docs/nmaas-applications/tutorials/gp4l-orchestrator.md b/docs/nmaas-applications/tutorials/gp4l-orchestrator.md
index 23c3632eb6087b3ab084d0c9d666860679ac52e4..b72f2c47e5737dffe983369bd3594c1229743336 100644
--- a/docs/nmaas-applications/tutorials/gp4l-orchestrator.md
+++ b/docs/nmaas-applications/tutorials/gp4l-orchestrator.md
@@ -30,7 +30,7 @@ Configuration parameters to be provided by the user are explained in the list be
- `Password for the Uptime Kuma web server` - password related to the defined username
- `Password for the Uptime Kuma API` - password used to authenticate to the Uptime Kuma API
- `Oxidized Git repository URL` - URL to the Git repository related to the Oxidized instance that is to be used
-- `Email addresses to receive the generated repository access SSH public key` - once the Camunda orchestrator is setup and initialized it will generate a pair of ssh keys used to access the Oxidized Git repository. The public key of this pair will be sent to this email address and will then need to be copy pasted to the NMaaS user profile. (Note: check the junk folder)
+- `Email addresses to receive the generated repository access SSH public key` - once the Camunda orchestrator is setup and initialized it will generate a pair of ssh keys used to access the Oxidized Git repository. The public key of this pair will be sent to this email address and will then need to be copy pasted to the nmaas user profile. (Note: check the junk folder)
- `The name to use for all Git commits created by Camunda` - name under which all Git changes will be made
- `The email to use for all Git commits created by Camunda` - email under which all Git changes will be made
diff --git a/docs/nmaas-applications/tutorials/grafana.md b/docs/nmaas-applications/tutorials/grafana.md
index 164078f62de03f3599c3f436ca58b64b39dd7731..463646d21d4373c94782ef663241d522bcdbca26 100644
--- a/docs/nmaas-applications/tutorials/grafana.md
+++ b/docs/nmaas-applications/tutorials/grafana.md
@@ -15,9 +15,9 @@ Configuration parameters to be provided by the user are explained in the subsect
- `Grafana admin username` - Username to be used to access the Grafana user interface
- `Grafana admin password` - Password to be used to access the Grafana user interface
- `Connect to existing Prometheus instance` ***[Optional]*** - If selected, additional fields are displayed allowing to provide information about a Prometheus instance that should be added as a default data source in Grafana
-- `NMaaS Prometheus instance` / `External Prometheus instance` - Switch between the type of Prometheus instance that should be used as the data source
+- `nmaas Prometheus instance` / `External Prometheus instance` - Switch between the type of Prometheus instance that should be used as the data source
- `Data source name` - The custom data source name that will be assigned to this Prometheus instance
-- `Select Prometheus instance` *(if NMaaS Prometheus instance is selected)* - Pick list allowing to select an instance of Prometheus deployed and already running in the same domain as the Grafana being configured
+- `Select Prometheus instance` *(if nmaas Prometheus instance is selected)* - Pick list allowing to select an instance of Prometheus deployed and already running in the same domain as the Grafana being configured
- `Prometheus instance address` *(if External Prometheus instance is selected)* - URL of the standalone Prometheus instance to be used
### Additional tab
diff --git a/docs/nmaas-applications/tutorials/icinga2.md b/docs/nmaas-applications/tutorials/icinga2.md
index b717a862f51f058a90440b8b90e2bd465591a1b6..08f0dd22667deffdcbc4ffb1de29f2062fde9fcf 100644
--- a/docs/nmaas-applications/tutorials/icinga2.md
+++ b/docs/nmaas-applications/tutorials/icinga2.md
@@ -6,6 +6,6 @@ Icinga 2 is a monitoring system which checks the availability of your network re
Scalable and extensible, Icinga can monitor large, complex environments across multiple locations.
-Icinga 2 is the monitoring server and requires Icinga Web 2 on top in your Icinga Stack, which is already included as part of the NMaaS deployment.
+Icinga 2 is the monitoring server and requires Icinga Web 2 on top in your Icinga Stack, which is already included as part of the nmaas deployment.
The configuration can be easily managed with either the Icinga Director, config management tools or plain text within the Icinga DSL.
\ No newline at end of file
diff --git a/docs/nmaas-applications/tutorials/librenms.md b/docs/nmaas-applications/tutorials/librenms.md
index 5b1cf07fdfd474ceb9347ea15f129c782118fadc..ae170aabde0cb5edff58c1e46c0ab19892e5a72e 100644
--- a/docs/nmaas-applications/tutorials/librenms.md
+++ b/docs/nmaas-applications/tutorials/librenms.md
@@ -8,11 +8,9 @@ LibreNMS is an auto-discovering PHP/MySQL/SNMP based network monitoring system w
Configuration parameters to be provided by the user are divided into two tabs: *Base tab* and *Advanced tab*.
-<!--  -->
-
<figure markdown>
- 
- <figcaption>NMaaS LibreNMS Application Wizard</figcaption>
+ 
+ <figcaption>nmaas LibreNMS Application Wizard</figcaption>
</figure>
### Base Tab
diff --git a/docs/nmaas-applications/tutorials/maildev.md b/docs/nmaas-applications/tutorials/maildev.md
index ed97540c278bd504274a49c93e39dfe095bfb95d..bbc6ee62a618e88a213e2dda4447f421d5ae4057 100644
--- a/docs/nmaas-applications/tutorials/maildev.md
+++ b/docs/nmaas-applications/tutorials/maildev.md
@@ -6,11 +6,11 @@ MailDev is a simple application that can be used during the development process
MailDev provides a web interface where all "sent" emails can be previewed. MailDev itself does not send the emails to their final destination, instead just logs them so that they are visible on the web interface and discards them. This makes it possible to use MailDev for testing purposes, without having to worry about rate limits, deliverability, or spam.
-## Deploying MailDev on NMaaS
+## Deploying MailDev on nmaas
-The MailDev application on NMaaS is primarily aimed at users of the virtual lab use-case. For production applications instantiated on the managed instance of NMaaS, it is possible to use the NMaaS email server, and this is the case by default for most tools already in the catalog.
+The MailDev application on nmaas is primarily aimed at users of the virtual lab use-case. For production applications instantiated on the managed instance of nmaas, it is possible to use the nmaas email server, and this is the case by default for most tools already in the catalog.
-To deploy and configure MailDev on NMaaS, the following steps need to be performed:
+To deploy and configure MailDev on nmaas, the following steps need to be performed:
- Subscribe to the application from the Application list.
- Navigate to the Subscriptions page and initiate the deployment of a new MailDev instnace, by entering the name and desired version.
@@ -20,7 +20,7 @@ To deploy and configure MailDev on NMaaS, the following steps need to be perform
<figcaption>Fig. 1: New MailDev Instance</figcaption>
</figure>
-- Use the deployment wizard to further customize your new MailDev instance. The current version of the deployment wizard allows the set up of a basic HTTP authentication to the MailDev web interface. This might be useful if multiple users have access to your NMaaS domain.
+- Use the deployment wizard to further customize your new MailDev instance. The current version of the deployment wizard allows the set up of a basic HTTP authentication to the MailDev web interface. This might be useful if multiple users have access to your nmaas domain.
<figure markdown>
{ width="350" }
@@ -36,7 +36,7 @@ To deploy and configure MailDev on NMaaS, the following steps need to be perform
Once deployed, the MailDev web interface becomes available. At this point, any existing application which supports SMTP based notifications can be configured to use the MailDev SMTP implementation with the following settings:
-- SMTP server address: (the correct hostname is shown in the access modes modal on NMaaS)
+- SMTP server address: (the correct hostname is shown in the access modes modal on nmaas)
- SMTP server port: 1025
- SMTP Username: /
- SMTP Password: /
diff --git a/docs/nmaas-applications/tutorials/oxidized.md b/docs/nmaas-applications/tutorials/oxidized.md
index 2569fd76bf103dc9d0ed03031321d1697d73c3e4..cb623684af6ddb97e2402f50275e8c5d293846c8 100644
--- a/docs/nmaas-applications/tutorials/oxidized.md
+++ b/docs/nmaas-applications/tutorials/oxidized.md
@@ -26,7 +26,7 @@ Multiple devices can be configured by using the `Add device` button.
### Configuration Update
-Oxidized allows for updating tools configuration during runtime. User should follow the steps described on the [NMaaS Tool Configuration Process](../general-app-deployment.md#nmaas-tool-configuration-process) page.
+Oxidized allows for updating tools configuration during runtime. User should follow the steps described on the [nmaas Tool Configuration Process](../general-app-deployment.md#nmaas-tool-configuration-process) page.
Inside the repository two files are being created by default, namely `config` and `router.db`, and are placed in the `base` directory.
diff --git a/docs/nmaas-applications/tutorials/spa.md b/docs/nmaas-applications/tutorials/spa.md
index b46429a3a2d837a928d304036f395e7d888ce181..50f5d7638c53e356438990c9361595fa04ef11c7 100644
--- a/docs/nmaas-applications/tutorials/spa.md
+++ b/docs/nmaas-applications/tutorials/spa.md
@@ -6,7 +6,7 @@
The Service Provider Architecture (SPA) is a service management digital platform providing the general processes and components necessary to manage the CSP services via a user-friendly web graphical user interface (Self-Service Portal).
-The platform in NMaaS has been prepared to manage E-Line service (L2 end-to-end connectivity) implemented by the OpenNSA application with a test default configuration and virtual simplified network topology. Users can familiarize with the SPA without the need of setting up the platform from the scratch.
+The platform in nmaas has been prepared to manage E-Line service (L2 end-to-end connectivity) implemented by the OpenNSA application with a test default configuration and virtual simplified network topology. Users can familiarize with the SPA without the need of setting up the platform from the scratch.
Just log in to the portal and start creating new circuits in a simple network to see how it works.
diff --git a/docs/nmaas-applications/tutorials/uptime-kuma.md b/docs/nmaas-applications/tutorials/uptime-kuma.md
index b1e823a9d4994b8da6174c43b37fac7b61c9ee67..3c7c2b4cb4dd62bb6d7c9889213c007059f42b94 100644
--- a/docs/nmaas-applications/tutorials/uptime-kuma.md
+++ b/docs/nmaas-applications/tutorials/uptime-kuma.md
@@ -13,9 +13,9 @@
- various other application specific monitors for PostgreSQL, MariaDB, MongoDB, etc...
- design and create status pages
-## Uptime Kuma on NMaaS
+## Uptime Kuma on nmaas
-Uptime Kuma on NMaaS is fully supported in two flavors:
+Uptime Kuma on nmaas is fully supported in two flavors:
- standalone flavor, identical with the upstream release, without any modifications.
- extended flavor which also supports API access using a [third-party API extension](https://github.com/MedAziz11/Uptime-Kuma-Web-API).
@@ -24,7 +24,7 @@ Refer to the sections below for more details regarding deployment options for th
### Deploiying the Standalone Version of Uptime Kuma
-As with any other application available in the NMaaS catalog, the deployment process for the standalone version is:
+As with any other application available in the nmaas catalog, the deployment process for the standalone version is:
1. Subscribe your domain to the Uptime Kuma application from the `Applications` page.
2. Deploy a new instance of Uptime Kuma, providing a unique name for it.
@@ -34,7 +34,7 @@ As with any other application available in the NMaaS catalog, the deployment pro
### Deploying Uptime Kuma together with an API Server
-NMaaS also offers an extended flavor of Uptime Kuma, one that comes collocated with the open-source API server implementation by [MedAziz11/Uptime-Kuma-Web-API](https://github.com/MedAziz11/Uptime-Kuma-Web-API). The deployment process for this flavor, differs somewhat from the standalone version, taking into account the additional features. The deployment steps are:
+nmaas also offers an extended flavor of Uptime Kuma, one that comes collocated with the open-source API server implementation by [MedAziz11/Uptime-Kuma-Web-API](https://github.com/MedAziz11/Uptime-Kuma-Web-API). The deployment process for this flavor, differs somewhat from the standalone version, taking into account the additional features. The deployment steps are:
1. Subscribe your domain to the Uptime Kuma application from the `Applications` page.
2. Deploy a new instance of Uptime Kuma, providing a unique name for it.
@@ -45,7 +45,7 @@ NMaaS also offers an extended flavor of Uptime Kuma, one that comes collocated w
<figcaption>Fig. 1: Uptime Kuma Deployment Wizard</figcaption>
</figure>
-4. Enter the username and password for the default Uptime Kuma user. NMaaS will automatically initialize a new user with the specified credentials, and the first run page will be skipped once the application is deployed. The user will be able to directly login.
+4. Enter the username and password for the default Uptime Kuma user. nmaas will automatically initialize a new user with the specified credentials, and the first run page will be skipped once the application is deployed. The user will be able to directly login.
5. Enter the password for the API user. The API user is different from the Uptime Kuma user. The default username for the API user is `admin`. This username cannot be changed at the moment.
6. Finish the deployment process and access the Uptime Kuma web interface and the API's OpenAPI documentation.
@@ -65,4 +65,4 @@ NMaaS also offers an extended flavor of Uptime Kuma, one that comes collocated w
**The default username for the API is always `admin`.**
!!! danger
- Changing the user's password from the Uptime Kuma web interface after the application has been deployed will make the API addon nonfunctional. Contact the NMaaS team in case a password change is necessary.
\ No newline at end of file
+ Changing the user's password from the Uptime Kuma web interface after the application has been deployed will make the API addon nonfunctional. Contact the nmaas team in case a password change is necessary.
\ No newline at end of file
diff --git a/docs/nmaas-applications/tutorials/zabbix.md b/docs/nmaas-applications/tutorials/zabbix.md
index 57fd862afe088fb969c170c8cd2db5c3c3a6900c..2fb764bc862474f01f4fd8bdc28de0ee81248b01 100644
--- a/docs/nmaas-applications/tutorials/zabbix.md
+++ b/docs/nmaas-applications/tutorials/zabbix.md
@@ -4,6 +4,6 @@
Zabbix is a mature and effortless enterprise-class open source monitoring solution for network monitoring and application monitoring of millions of metrics.
-The Zabbix application included in the NMaaS catalog uses TimescaleDB for better performance.
+The Zabbix application included in the nmaas catalog uses TimescaleDB for better performance.
After deployment, use the default `Admin/zabbix` credentials to login.
\ No newline at end of file
diff --git a/docs/overrides/partials/copyright.html b/docs/overrides/partials/copyright.html
index c352d6910bb67eab49e983f068721fcb4c1bfc16..829a2dbfa59e42b4c107d535a56b087fd1a1e079 100644
--- a/docs/overrides/partials/copyright.html
+++ b/docs/overrides/partials/copyright.html
@@ -28,6 +28,6 @@
Made with
<span class="twemoji heart">
{% include ".icons/octicons/heart-fill-24.svg" %}
- </span> by NMaaS contributors and <a href="https://squidfunk.github.io/mkdocs-material/">Material for MkDocs</a>
+ </span> by nmaas contributors and <a href="https://squidfunk.github.io/mkdocs-material/">Material for MkDocs</a>
{% endif %}
</div>
\ No newline at end of file
diff --git a/docs/self-hosted-nmaas/install-guide.md b/docs/self-hosted-nmaas/install-guide.md
index 575ac15394a08058fd7192cde1554aa1df3937b4..317de3220da04505c7efd6816389379cfcf0d3e5 100644
--- a/docs/self-hosted-nmaas/install-guide.md
+++ b/docs/self-hosted-nmaas/install-guide.md
@@ -1,21 +1,21 @@
-# NMaaS Installation Guide
+# nmaas Installation Guide
## Requirements
-To install NMaaS into an existing Kubernetes cluster, the following requirements must be met:
+To install nmaas into an existing Kubernetes cluster, the following requirements must be met:
- Kubernetes version `>=1.16`
- Helm v3 support in the Kubernetes cluster
- Existing ingress controller, preferably with a default TLS certificate set (more information available below)
- An integration with an external load-balancer or MetalLB for bare-metal deployments, so that IPs can be assigned to `LoadBalancer` services.
-## NMaaS Components
+## nmaas Components
-NMaaS is comprised of multiple components, and a brief description for each one is provided in the [self-hosting introduction](./introduction.md) page.
+nmaas is comprised of multiple components, and a brief description for each one is provided in the [self-hosting introduction](./introduction.md) page.
## Installation
-The NMaaS installation is a two-step process - first an instance of GItLab must be deployed and configured, and then NMaaS itself. The two components cannot be deployed at the same time, since during the deployment process NMaaS requires a GitLab API key to be specified.
+The nmaas installation is a two-step process - first an instance of GItLab must be deployed and configured, and then nmaas itself. The two components cannot be deployed at the same time, since during the deployment process nmaas requires a GitLab API key to be specified.
### GitLab Installation
@@ -37,10 +37,10 @@ GitLab can be deployed using the [official Helm chart](https://docs.gitlab.com/r
!!! success "GitLab Version"
- `4.8.2` is the latest version of the GitLab chart that has been tested with the latest version of NMaaS.
+ `4.8.2` is the latest version of the GitLab chart that has been tested with the latest version of nmaas.
-Bellow is a snippet of the mandatory parameters that must be specified during GitLab's deployment, so that it will be compatible with NMaaS. The complete list of supported value parameters is available in the [official GitLab Helm chart Git repository](https://gitlab.com/gitlab-org/charts/gitlab).
+Bellow is a snippet of the mandatory parameters that must be specified during GitLab's deployment, so that it will be compatible with nmaas. The complete list of supported value parameters is available in the [official GitLab Helm chart Git repository](https://gitlab.com/gitlab-org/charts/gitlab).
```yaml title="gitlab-values.yaml"
certmanager:
@@ -145,7 +145,7 @@ Note that the built-in PostgreSQL chart that can be automatically deployed toget
In case an external PostgreSQL instance will be used then the secret specified in `.Values.global.psql.password.secret` must be created automatically. Also, keep in mind the warning given above, if a regular PostgreSQL user is specified, the `btree` and `trgm` extensions must be enabled beforehand.
!!! info "GitLab Email Sending"
- NMaaS does not rely on email sending via GitLab, so both the email and smtp sections in the value files can be left with their default values - unconfigured. However, users are free to customize these sections according to their own environments.
+ nmaas does not rely on email sending via GitLab, so both the email and smtp sections in the value files can be left with their default values - unconfigured. However, users are free to customize these sections according to their own environments.
Once all configuration parameters have been specified, GitLab can be installed using the following Helm v3 command:
@@ -165,9 +165,9 @@ Once GitLab has been deployed, it can be accessed by navigating to `gitlab.<TLD>
Note that after deployment, by default, anyone can register to your newly deployed GitLab instance. This can be configured by logging in as the root GitLab user.
- Users are advised to determine whether public exposure of the GitLab web interface is needed at all. NMaaS' GitLab integration can work even if only public access to the GitLab SSH interface is provided, since repository cloning always relies on SSH as the transport protocol.
+ Users are advised to determine whether public exposure of the GitLab web interface is needed at all. nmaas' GitLab integration can work even if only public access to the GitLab SSH interface is provided, since repository cloning always relies on SSH as the transport protocol.
-To create a GitLab API token that can be used by NMaaS, perform the following steps:
+To create a GitLab API token that can be used by nmaas, perform the following steps:
- Login to GitLab using the root account;
- Click on the avatar image in the top right corner and select `Settings`;
@@ -179,13 +179,13 @@ To create a GitLab API token that can be used by NMaaS, perform the following st
GitLab supports SSH access to any created repositories. If you want to allow your users to clone the repositories where their application configuration is stored, then you will have to alter the GitLab Shell service, and change its type to LoadBalancer, so that a routable IP address will be assigned to it.
-### NMaaS Installation
+### nmaas Installation
-The source code for the NMaaS Helm chart is publicly available on [nmaas-platform/nmaas-chart](https://gitlab.software.geant.org/nmaas/nmaas-chart). The `README.md` file provides details on all the customizable `value` parameters for a given chart version.
+The source code for the nmaas Helm chart is publicly available on [nmaas-platform/nmaas-chart](https://gitlab.software.geant.org/nmaas/nmaas-chart). The `README.md` file provides details on all the customizable `value` parameters for a given chart version.
-The following manual steps must be performed before deploying NMaaS:
+The following manual steps must be performed before deploying nmaas:
-- Creating a private/public SSH keypair so that NMaaS Platform can access NMaaS Helm:
+- Creating a private/public SSH keypair so that nmaas Platform can access nmaas Helm:
```bash
#!/bin/bash
@@ -210,14 +210,14 @@ The following manual steps must be performed before deploying NMaaS:
kubectl create secret generic -n $NMAAS_NAMESPACE nmaas-sp-secret --from-literal=secret=<SSO_SHARED_KEY>
```
-- Create the NMaaS Janitor secret containing the GitLab API key, generated previously:
+- Create the nmaas Janitor secret containing the GitLab API key, generated previously:
```bash
export NMAAS_NAMESPACE="nmaas-system"
kubectl create secret generic -n $NMAAS_NAMESPACE nmaas-gitlab-janitor-token --from-literal=secret=<GITLAB_API_TOKEN>
```
-Once the required secrets have been created, NMaaS can be deployed using the following command (make sure to deploy in the same namespace as GitLab):
+Once the required secrets have been created, nmaas can be deployed using the following command (make sure to deploy in the same namespace as GitLab):
```bash
export NMAAS_NAMESPACE="nmaas-system"
@@ -225,14 +225,14 @@ helm repo add nmaas https://artifactory.software.geant.org/artifactory/nmaas-hel
helm install -f values.yaml --namespace $NMAAS_NAMESPACE --version 1.0.0 nmaas nmaas/nmaas
```
-It is recommended to use `nmaas-system` as the namespace where NMaaS and all associated components (PostgreSQL, GitLab) will be deployed.
+It is recommended to use `nmaas-system` as the namespace where nmaas and all associated components (PostgreSQL, GitLab) will be deployed.
-!!! warning "NMaaS Deployment Time"
- Please allow at least 10 minutes for NMaaS to be fully deployed, depending on hardware configuration and resource utilization.
+!!! warning "nmaas Deployment Time"
+ Please allow at least 10 minutes for nmaas to be fully deployed, depending on hardware configuration and resource utilization.
#### Verifying the Installation
-You can verify that NMaaS has been successfully deployed by navigating to its ingress URL from your browser, logging in as the admin user and selecting `Settings -> Monitoring`. From this location, you can execute checks for all the required components of NMaaS. A fully functional installation should return a successful response for all monitors.
+You can verify that nmaas has been successfully deployed by navigating to its ingress URL from your browser, logging in as the admin user and selecting `Settings -> Monitoring`. From this location, you can execute checks for all the required components of nmaas. A fully functional installation should return a successful response for all monitors.
## Administrator Information
@@ -240,10 +240,10 @@ For more detailed instructions, refer to the [Domain Admin Guide](../guides/doma
### Creating New Domains
-Creating a new customer domain within NMaaS is a two-step process:
+Creating a new customer domain within nmaas is a two-step process:
-1. First, the new domain should be added from the NMaaS web interface. The following steps should be performed.
- - Login to the NMaaS Portal as the administrator user (the default administrator username is `admin` and the desired password is passed as a installation parameter);
+1. First, the new domain should be added from the nmaas web interface. The following steps should be performed.
+ - Login to the nmaas Portal as the administrator user (the default administrator username is `admin` and the desired password is passed as a installation parameter);
- Navigate to `Settings -> Domains`;
- Click the `Add` button and enter the required parameters specific to the newly created domain:
- `Name` - full name of given domain (e.g. `Test Domain`)
@@ -251,7 +251,7 @@ Creating a new customer domain within NMaaS is a two-step process:
- `Kubernetes namespace` *(Optional)* - a namespace dedicated for this domain to be created in the next step
- `Kubernetes storage class` *(Optional)* - a specific storage class to be used for persistent volumes created in this domain (typically should be left blank)
- `Kubernetes ingress class` *(Optional)* - a ingress class supported by the ingress controller deployed for this domain (should be left blank if a single common controller supports all the domains)
- - `External service domain` - a base URL for accessing all applications deployed in this domain (typically should contain the Codename and the URL of NMaaS itself, e.g. `testdom.nmaas.example.com`)
+ - `External service domain` - a base URL for accessing all applications deployed in this domain (typically should contain the Codename and the URL of nmaas itself, e.g. `testdom.nmaas.example.com`)
- `DCN deployment type` - by default should be set to `Manual`
- `DCN status` - by default should be set to `Configured`
- `Customer networks` *(to be removed)* - list of network prefixes to which applications deployed in this domain should have access (thought this parameter is currently mandatory it is not used for any automated actions so any initial values can be provided)
@@ -286,8 +286,8 @@ Creating a new customer domain within NMaaS is a two-step process:
## Additional Documentation
-An online user guide is available at [NMaaS User Guide](../guides/user-guide.md) page.
+An online user guide is available at [nmaas User Guide](../guides/user-guide.md) page.
-Information about the NMaaS applications deployment and configuration process and the NMaaS portfolio is available on the [NMaaS Tools](../nmaas-applications/general-app-deployment.md) page.
+Information about the nmaas applications deployment and configuration process and the nmaas portfolio is available on the [nmaas Tools](../nmaas-applications/general-app-deployment.md) page.
-In case of any questions please contact the NMaaS Team at [nmaas@lists.geant.org](mailto:nmaas@lists.geant.org).
\ No newline at end of file
+In case of any questions please contact the nmaas Team at [nmaas@lists.geant.org](mailto:nmaas@lists.geant.org).
\ No newline at end of file
diff --git a/docs/self-hosted-nmaas/introduction.md b/docs/self-hosted-nmaas/introduction.md
index 4777fe236cf673cf4b2f819db9abe7c271431359..3f4f6593af517bd0b3395bd3c9d6accf58c333ee 100644
--- a/docs/self-hosted-nmaas/introduction.md
+++ b/docs/self-hosted-nmaas/introduction.md
@@ -1,52 +1,52 @@
# Introduction
-Interested users have the option of self-hosting the NMaaS software on their own infrastructure. Depending on the environment, two guides are available:
+Interested users have the option of self-hosting the nmaas software on their own infrastructure. Depending on the environment, two guides are available:
-- The [production installation guide](./install-guide.md) which provides instructions on installing NMaaS on a full-fledged Kubernetes cluster involving multiple cluster nodes.
-- The [local installation guide](./local-dev-environment/introduction.md) which provides instructions on installing NMaaS for evaluation purposes in smaller environments, consisting even of a single Kubernetes node.
+- The [production installation guide](./install-guide.md) which provides instructions on installing nmaas on a full-fledged Kubernetes cluster involving multiple cluster nodes.
+- The [local installation guide](./local-dev-environment/introduction.md) which provides instructions on installing nmaas for evaluation purposes in smaller environments, consisting even of a single Kubernetes node.
-Note that apart from the infrastructure aspects, both guides share similarities when it comes to the actual NMaaS deployment, and can be consulted in parallel.
+Note that apart from the infrastructure aspects, both guides share similarities when it comes to the actual nmaas deployment, and can be consulted in parallel.
-## NMaaS Components
+## nmaas Components
-NMaaS' architecture is made up of three primary components and three helper components.
+nmaas' architecture is made up of three primary components and three helper components.
-The primary components have all been developed within the GEANT project and these are: the NMaaS Portal, the NMaas Platform, and the NMaaS Janitor.
+The primary components have all been developed within the GÉANT project and these are: the nmaas Portal, the nmaas Platform, and the nmaas Janitor.
-The helper components are represented as popular open-source software which has been packaged as Docker containers. These include: NMaaS Helm, NMaaS Postfix, and NMaaS Service Provider (SP).
+The helper components are represented as popular open-source software which has been packaged as Docker containers. These include: nmaas Helm, nmaas Postfix, and nmaas Service Provider (SP).
More details about the role that each of these components play are provided in the subsections below.
-### NMaaS Platform
+### nmaas Platform
-NMaaS Platform is the central NMaaS component, exposing a REST API consumed by the NMaaS Portal. It stores the application catalog, the users, as well as information about any deployed applications. Upon a new request for an application deployment, it connects to the NMaaS Helm component and executes the necessary Helm command via an SSH connection. It also communicates with a self-hosted instance of GitLab, in order to provision boilerplate configuration files for the deployed application instances by the users, allowing them to make any additional configuration changes exclusively through Git.
+nmaas Platform is the central nmaas component, exposing a REST API consumed by the nmaas Portal. It stores the application catalog, the users, as well as information about any deployed applications. Upon a new request for an application deployment, it connects to the nmaas Helm component and executes the necessary Helm command via an SSH connection. It also communicates with a self-hosted instance of GitLab, in order to provision boilerplate configuration files for the deployed application instances by the users, allowing them to make any additional configuration changes exclusively through Git.
**External dependencies: PostgreSQL database, self-hosted GitLab instance**
-### NMaaS Portal
+### nmaas Portal
-NMaaS Portal represents the front-end application of NMaaS that consumes the REST API offered by NMaaS Platform. NMaaS Portal is a Angular based application that is run in user's browser.
+nmaas Portal represents the front-end application of nmaas that consumes the REST API offered by nmaas Platform. nmaas Portal is an Angular based application that is run in user's browser.
-### NMaaS Janitor
+### nmaas Janitor
-The NMaaS Janitor is a helper service that interacts with the self-hosted GitLab API, and deploys the boilerplate configuration templates within the Kubernetes cluster. NMaaS Janitor is also used to retrieve the status of Kubernetes services and load balancer IPs assigned to them. For this reason it also needs privileges to use the Kubernetes API, albeit not as permissive as NMaaS Helm.
+The nmaas Janitor is a helper service that interacts with the self-hosted GitLab API, and deploys the boilerplate configuration templates within the Kubernetes cluster. nmaas Janitor is also used to retrieve the status of Kubernetes services and load balancer IPs assigned to them. For this reason it also needs privileges to use the Kubernetes API, albeit not as permissive as nmaas Helm.
-### NMaaS Helm
+### nmaas Helm
-NMaaS Helm interacts with the Kubernetes API of the underlying cluster where NMaaS is deployed, and manages it through the Helm v3 client. As a a result, it requires the cluster-admin Kubernetes role. Whenever a new application is deployed, the NMaaS Platform opens an SSH connection to NMaaS Helm and executes the required Helm command.
+nmaas Helm interacts with the Kubernetes API of the underlying cluster where nmaas is deployed, and manages it through the Helm v3 client. As a a result, it requires the cluster-admin Kubernetes role. Whenever a new application is deployed, the nmaas Platform opens an SSH connection to nmaas Helm and executes the required Helm command.
-### NMaaS Postfix
+### nmaas Postfix
-NMaaS Postfix is an in-cluster mail server that is used by any deployed applications to send emails to external destinations. It does not require any authentication before sending emails, and it can either be configured as a standalone mail server, or it can use a smart host, routing all outgoing emails through some other email server (e.g. Gmail).
+nmaas Postfix is an in-cluster mail server that is used by any deployed applications to send emails to external destinations. It does not require any authentication before sending emails, and it can either be configured as a standalone mail server, or it can use a smart host, routing all outgoing emails through some other email server (e.g. Gmail).
-!!! warning "NMaaS Postfix without a Smart Host"
+!!! warning "nmaas Postfix without a Smart Host"
- If NMaaS Postfix is not configured to use an external mail service for sending the emails, than most likely all outgoing emails will be marked as spam, and users will face delivery problems when sending alerts from their deployed applications.
+ If nmaas Postfix is not configured to use an external mail service for sending the emails, than most likely all outgoing emails will be marked as spam, and users will face delivery problems when sending alerts from their deployed applications.
-### NMaaS Service Provider (SP)
+### nmaas Service Provider (SP)
-The NMaaS SP is an in-cluster SAML Proxy that allows for SSO user login based on SAML. The NMaaS SP component is composed of Apache HTTP server and a Shibboleth Service Provider (Shibboleth SP) software. NMaaS SP is initially configured to authenticate with eduGAIN as the federated Identify Provider but can be customized to work with any compliant IdP.
+The nmaas SP is an in-cluster SAML Proxy that allows for SSO user login based on SAML. The nmaas SP component is composed of Apache HTTP server and a Shibboleth Service Provider (Shibboleth SP) software. nmaas SP is initially configured to authenticate with eduGAIN as the federated Identify Provider but can be customized to work with any compliant IdP.
-!!! warning "NMaaS SP is still in a Testing Phase"
+!!! warning "nmaas SP is still in a Testing Phase"
- The in-cluster NMaaS SP was developed some time back but was never thoroughly tested. However NMaaS development team can provide guidelines on how to setup a NMaaS SAML Proxy on a dedicated VM. Such a setup is currently used for NMaaS production service. Nevertheless basic username and password based log in is available at all times.
\ No newline at end of file
+ The in-cluster nmaas SP was developed some time back but was never thoroughly tested. However nmaas development team can provide guidelines on how to setup a nmaas SAML Proxy on a dedicated VM. Such a setup is currently used for nmaas production service. Nevertheless basic username and password based log in is available at all times.
\ No newline at end of file
diff --git a/docs/self-hosted-nmaas/local-dev-environment/appendix.md b/docs/self-hosted-nmaas/local-dev-environment/appendix.md
index 1727e3c7d42f21bf41ba647b4b9e2ddb9128efaf..eaf6caa720f17e28f7404eddf27d590cb1fbf5e6 100644
--- a/docs/self-hosted-nmaas/local-dev-environment/appendix.md
+++ b/docs/self-hosted-nmaas/local-dev-environment/appendix.md
@@ -1,4 +1,4 @@
-# Appendix: Default Credentials for the NMaaS Development Virtual Machine
+# Appendix: Default Credentials for the nmaas Development Virtual Machine
!!! note Virtual Machine Download
@@ -13,10 +13,10 @@
| Port for Telnet Access FreeRTR Instance #1 | 1124 |
| Virtual Machine Username | nmaas |
| Virtual Machine Password | nmaas |
-| NMaaS URL | https://nmaas.10.99.99.150.nip.io |
-| NMaaS Admin Username | admin |
-| NMaaS Admin Password | saamn |
-| NMaaS API Secret | saamn |
+| nmaas URL | https://nmaas.10.99.99.150.nip.io |
+| nmaas Admin Username | admin |
+| nmaas Admin Password | saamn |
+| nmaas API Secret | saamn |
| GitLab URL | https://gitlab.nmaas.10.99.99.150.nip.io/users/sign_in |
| GitLab Admin Username | root |
| GitLab Admin Password | nmaasgitlab |
diff --git a/docs/self-hosted-nmaas/local-dev-environment/introduction.md b/docs/self-hosted-nmaas/local-dev-environment/introduction.md
index 0789fa7fe44e032224100be51d58c0006d7a9b42..1d24c3a844f4c022ec143e821d125862146eb1d5 100644
--- a/docs/self-hosted-nmaas/local-dev-environment/introduction.md
+++ b/docs/self-hosted-nmaas/local-dev-environment/introduction.md
@@ -1,11 +1,11 @@
# Introduction to the Local Development Environment
-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). After downloading the virtual machine image, users are advised to follow [part 1](./p1_local-kubernetes-cluster.md) in order to set up the necessary VirtualBox NAT network which is required by the VM so that all of its components can run as expected, and the subnets described in the [Appendix](./appendix.md) remain unchanged.
+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). After downloading the virtual machine image, users are advised to follow [part 1](./p1_local-kubernetes-cluster.md) in order to set up the necessary VirtualBox NAT network which is required by the VM so that all of its components can run as expected, and the subnets described in the [Appendix](./appendix.md) remain unchanged.
By the end of this 5 part tutorial, users should have an exact replica of the setup done within the virtual machine.
-This tutorial begins with [part 1](./p1_local-kubernetes-cluster.md) where a local Kubernetes cluster is initialized allowing users to choose between two lightweight Kubernetes distributions - MicroK8s or K3s. It then proceeds with [part 2](./p2_installing-nmaas.md) where the NMaaS installation procedure is explained, along with all required dependencies. In [part 3](./p3_demo-network-environment.md), a simple method is described for setting up virtualized demo networking devices that can later be used 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 [part 4](./p4_monitoring-demo-network-environment.md). The tutorial is concluded with [part 5](./p5_adding_custom_app.md), allowing advanced users to add their own custom applications to the NMaaS catalog, thus making it available to all potential users of their NMaaS instance.
+This tutorial begins with [part 1](./p1_local-kubernetes-cluster.md) where a local Kubernetes cluster is initialized allowing users to choose between two lightweight Kubernetes distributions - MicroK8s or K3s. It then proceeds with [part 2](./p2_installing-nmaas.md) where the nmaas installation procedure is explained, along with all required dependencies. In [part 3](./p3_demo-network-environment.md), a simple method is described for setting up virtualized demo networking devices that can later be used 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 [part 4](./p4_monitoring-demo-network-environment.md). The tutorial is concluded with [part 5](./p5_adding_custom_app.md), allowing advanced users to add their own custom 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.
\ No newline at end of file
diff --git a/docs/self-hosted-nmaas/local-dev-environment/p1_local-kubernetes-cluster.md b/docs/self-hosted-nmaas/local-dev-environment/p1_local-kubernetes-cluster.md
index c9e75baec08e61205f90b218893b56631ef72935..b651307975cbfd3222fa0d0b8a9f8a95c217b8bc 100644
--- a/docs/self-hosted-nmaas/local-dev-environment/p1_local-kubernetes-cluster.md
+++ b/docs/self-hosted-nmaas/local-dev-environment/p1_local-kubernetes-cluster.md
@@ -1,6 +1,6 @@
# Part 1: Deploying a Local Kubernetes Cluster
-This tutorial will assume that NMaaS is installed in a virtual machine that is completely isolated from any production environment. However, the discussed steps are applicable to bare-metal hardware as well, once the correct network strategy has been identified by the system administrator.
+This tutorial will assume that nmaas is installed in a virtual machine that is completely isolated from any production environment. However, the discussed steps are applicable to bare-metal hardware as well, once the correct network strategy has been identified by the system administrator.
## Virtual Machine Prerequisites
@@ -13,12 +13,12 @@ This tutorial will assume that NMaaS is installed in a virtual machine that is c
Although we will focus on VirtualBox, any virtualization software can be used, depending on the user's preference. Virtualbox 6 is an open-source virtualization software which can be downloaded for free from the [official website](https://www.virtualbox.org/wiki/Downloads).
-After installation, additional network configuration needs to be done before a Kubernetes cluster can be set up. The following network configuration creates a completely isolated network environment from the production network. NMaaS will only be accessible from the host operating system where the virtual machine is deployed.
+After installation, additional network configuration needs to be done before a Kubernetes cluster can be set up. The following network configuration creates a completely isolated network environment from the production network. nmaas will only be accessible from the host operating system where the virtual machine is deployed.
Our virtual machine will need three network interfaces in total:
- 3 NAT type network adapters (from the same NAT network) which are created manually in Virtualbox (one for Kubernetes, two for freeRTR)
-- **Optional:** 1 Host-only type network adapter which is also created manually in Virtualbox - for accessing the NAT network from the host system. Using this approach, the NMaaS instance deployed inside the virtual machine will be made accessible by adding a custom route on the host operating system towards the NAT network, traversing the host-only interfaces.
+- **Optional:** 1 Host-only type network adapter which is also created manually in Virtualbox - for accessing the NAT network from the host system. Using this approach, the nmaas instance deployed inside the virtual machine will be made accessible by adding a custom route on the host operating system towards the NAT network, traversing the host-only interfaces.
DHCP should not be enabled for the second or third NAT interfaces, but DHCP should be enabled for the first NAT interface. If an optional host interface has been added, DHCP should be enabled on it as well.
@@ -34,11 +34,11 @@ Detailed description of the required configuration steps is given below.
-- If the pre-prepared NMaaS VirtualBox image is used, make sure to select the exact same Network CIDR (10.99.99.0/24) since all NMaaS components have already been installed and expect addresses in the 10.99.99.0/24 range.
+- If the pre-prepared nmaas VirtualBox image is used, make sure to select the exact same Network CIDR (10.99.99.0/24) since all nmaas components have already been installed and expect addresses in the 10.99.99.0/24 range.
### Optional: Creating a New Host-Only Network in Virtualbox
-If the NMaaS installation needs to be accessible from other networks, one option is to add a Host-Only interface to the virtual machine that will act as a transit between the outside networks and the internal VirtualBox NAT network configured in the previous step.
+If the nmaas installation needs to be accessible from other networks, one option is to add a Host-Only interface to the virtual machine that will act as a transit between the outside networks and the internal VirtualBox NAT network configured in the previous step.
- Navigate to `File -> Host Network Manager` and click on the green `Create` Button.
@@ -52,7 +52,7 @@ If the NMaaS installation needs to be accessible from other networks, one option
Create a regular virtual machine in VirtualBox, using the latest Ubuntu 20.04 ISO. The following parameters need to be altered:
-- Allocate sufficient memory to the virtual machine. 12GB is the minimum amount which will support a complete NMaaS installation, along with the possibility for deploying additional applications via the catalog.
+- Allocate sufficient memory to the virtual machine. 12GB is the minimum amount which will support a complete nmaas installation, along with the possibility for deploying additional applications via the catalog.
- Allocate sufficient number of CPU cores, depending on the performance of your system.
- In the `Network` configuration tab, add three adapters:
- Adapter 1: NAT Network (Select the network created [previously](./p1_local-kubernetes-cluster.md#creating-a-new-nat-network-in-virtualbox))
@@ -238,7 +238,7 @@ Once the assigned IP to the LoadBalancer Service has been acquired by executing
##### Helm
-Helm is a package manager for Kubernetes allowing seamless installation of complex application. NMaaS and all of its dependencies have also been packaged as Helm charts, thus easing their deployment process.
+Helm is a package manager for Kubernetes allowing seamless installation of complex application. nmaas and all of its dependencies have also been packaged as Helm charts, thus easing their deployment process.
```bash
microk8s enable helm3
@@ -255,7 +255,7 @@ microk8s helm3 list --all-namespaces
!!! danger "Helm Version"
- Unfortunately, the Helm version installed in this manner, as an official MicroK8s addon is too old. A newer version, if needed, can be installed by following the instructions available below. **Please note that the GitLab chart, which is a dependency of NMaaS requires a newer Helm version than the one installed as a MicroK8s addon.**
+ Unfortunately, the Helm version installed in this manner, as an official MicroK8s addon is too old. A newer version, if needed, can be installed by following the instructions available below. **Please note that the GitLab chart, which is a dependency of nmaas requires a newer Helm version than the one installed as a MicroK8s addon.**
###### Installing a Newer Helm Version
@@ -428,7 +428,7 @@ To install Helm, we need to first download the latest binary for our architectur
##### Ingress Nginx
-The last application that needs to be installed before we can move on to installing the NMaaS components is Ingress Nginx. Since we have already configured Helm, the Ingress Nginx installation is simple.
+The last application that needs to be installed before we can move on to installing the nmaas components is Ingress Nginx. Since we have already configured Helm, the Ingress Nginx installation is simple.
- Customize the values.yaml file according to the local environment:
@@ -460,7 +460,7 @@ The last application that needs to be installed before we can move on to install
helm install -f ingress-values.yaml --namespace nmaas-system nmaas-ingress ingress-nginx/ingress-nginx
```
- We have chosen to install `ingress-nginx` in the `nmaas-system` namespace, which will house all the other NMaaS components as well.
+ We have chosen to install `ingress-nginx` in the `nmaas-system` namespace, which will house all the other nmaas components as well.
!!! danger "Note About Helm Errors"
diff --git a/docs/self-hosted-nmaas/local-dev-environment/p2_installing-nmaas.md b/docs/self-hosted-nmaas/local-dev-environment/p2_installing-nmaas.md
index 756d97998b5eb9203b26d98c5af9d851fc6f7dcf..c343722c0cc53121365e0642a98200381dbdefd2 100644
--- a/docs/self-hosted-nmaas/local-dev-environment/p2_installing-nmaas.md
+++ b/docs/self-hosted-nmaas/local-dev-environment/p2_installing-nmaas.md
@@ -1,6 +1,6 @@
-# Part 2: Installing NMaaS
+# Part 2: Installing nmaas
-Once a working Kubernetes cluster has been deployed, we are ready to proceed to the next step - installing NMaaS.
+Once a working Kubernetes cluster has been deployed, we are ready to proceed to the next step - installing nmaas.
All the necessary components will be installed in a single namespace – `nmaas-system`. If this namespace has not been created so far, execute:
@@ -10,7 +10,7 @@ kubectl create namespace nmaas-system
## GitLab Installation
-The first NMaaS dependency that we will set up is GitLab, a self-hosted web based Git repository hosting service. Many applications that are deployed by NMaaS users store their configuration data in a Git repository, allowing easier editing, and version management.
+The first nmaas dependency that we will set up is GitLab, a self-hosted web based Git repository hosting service. Many applications that are deployed by nmaas users store their configuration data in a Git repository, allowing easier editing, and version management.
GitLab has an official Helm chart, and we will use it to create a basic GitLab installation locally. Some parameters must be customized in the values.yaml file before deployment:
@@ -124,14 +124,14 @@ Once GitLab has been deployed, it should be possible to navigate to the login pa
- `Allow requests to the local network from web hooks and services` = checked
- `Allow requests to the local network from system hooks` = checked
-The final step before installing NMaaS itself is to generate a GitLab personal access token which will allow NMaaS to connect to the GitLab API. This can be done from the User Profile page:
+The final step before installing nmaas itself is to generate a GitLab personal access token which will allow nmaas to connect to the GitLab API. This can be done from the User Profile page:
- Click on the user avatar in the right-hand corner of the screen, Edit Profile. Select Access Tokens from the left-hand navigation menu. Give a new name for the authentication token, as well as an optional expiry date. Check all scopes.
- Store the token until the next section, where we will create a new secret containing it.
-## NMaaS Installation
+## nmaas Installation
-The final step is to install NMaaS. NMaaS uses SSH communication to connect between components, so we need to create an SSH key pair and store it in a Kubernetes secret. This can be done by executing the following commands:
+The final step is to install nmaas. nmaas uses SSH communication to connect between components, so we need to create an SSH key pair and store it in a Kubernetes secret. This can be done by executing the following commands:
```bash
#!/bin/bash
@@ -145,12 +145,12 @@ kubectl create secret generic nmaas-helm-key-private -n <NMAAS_NAMESPACE> --from
kubectl create secret generic nmaas-helm-key-public -n <NMAAS_NAMESPACE> --from-file=helm=$tmpdir/key.pub
```
-A few parameters need to be customized in the values.yaml file, to reflect the environment where NMaaS is deployed.
+A few parameters need to be customized in the values.yaml file, to reflect the environment where nmaas is deployed.
- `global.wildcardCertificateName` – the name of the secret containing the TLS certificate to be used to secure the HTTP communication
-- `global.nmaasDomain` – the hostname where NMaaS will be accessible.
+- `global.nmaasDomain` – the hostname where nmaas will be accessible.
- `platform.properties.adminEmail` – the email address which will receive various notifications such as new user sign-up, deployment errors, new application versions...
-- `platform.adminPassword.literal` – the password used to login as the admin user in the NMaaS Portal.
+- `platform.adminPassword.literal` – the password used to login as the admin user in the nmaas Portal.
- `platform.properties.k8s.ingress.certificate.issuerOrWildcardName` – the name of the wilcard certificate to be used for customer deployed applications, or the name of the cert-manager issuer to use if certificates are issued ad-hoc.
- `platform.properties.k8s.ingress.controller.ingressClass` – the ingress class to be used for deployed applications. Should be set to nginx in the case of K3s and public in the case of MicroK8s.
- `platform.properties.k8s.ingress.controller.publicIngressClass` – the ingress class to be used for applications where the users have explicitly selected to enable public access (e.g. without a VPN). Since this is a local deployment, the value of this parameter should equal the value set in `platform.properties.k8s.ingress.controller.ingressClass`.
@@ -205,14 +205,14 @@ janitor:
gitlabApiUrl: http://nmaas-gitlab-webservice-default:8181/api/v4
```
-Once the values.yaml file has been customized, NMaaS can be deployed by executing:
+Once the values.yaml file has been customized, nmaas can be deployed by executing:
```bash
helm repo add nmaas https://artifactory.software.geant.org/artifactory/nmaas-helm
helm install -f nmaas-values.yaml --namespace nmaas-system nmaas --version 1.1.2 nmaas/nmaas
```
-NMaaS also requires an the stakater autoreloader component, which can simply be installed using the commands below. This component takes care of restarting the affected pods whenever a configuration change is submitted via GitLab.
+nmaas also requires an the stakater autoreloader component, which can simply be installed using the commands below. This component takes care of restarting the affected pods whenever a configuration change is submitted via GitLab.
```bash
helm repo add stakater https://stakater.github.io/stakater-charts
@@ -222,4 +222,4 @@ helm install config-reload --namespace nmaas-system stakater/reloader
After the installation, login as the `admin` user should be possible with the configured password.
-
\ No newline at end of file
+
\ No newline at end of file
diff --git a/docs/self-hosted-nmaas/local-dev-environment/p3_demo-network-environment.md b/docs/self-hosted-nmaas/local-dev-environment/p3_demo-network-environment.md
index 366348fb8db18f72df31cde87f19f12fabb18569..98f1a66428f5ab6026bcacf2b2324f8c1a9e2b06 100644
--- a/docs/self-hosted-nmaas/local-dev-environment/p3_demo-network-environment.md
+++ b/docs/self-hosted-nmaas/local-dev-environment/p3_demo-network-environment.md
@@ -4,7 +4,7 @@
These instructions are heavily based on the excellent blog posts and FreeRTR Docs written by [Fréderic Loui](https://twitter.com/FredericLoui) and the RARE team.
-If there are existing network elements ready to be monitored by NMaaS applications, then this part can be completely skipped.
+If there are existing network elements ready to be monitored by nmaas applications, then this part can be completely skipped.
## Configuring VirtualBox
@@ -163,7 +163,7 @@ The addition of new interfaces can be easily accomplished from the VirtualBox VM
- Adding a default route: `ipv4 route v1 0.0.0.0 0.0.0.0 192.168.1.1`
- Configuring a static IP: `ipv4 addr 192.168.1.17 255.255.255.0`
- - The sensor directives need to be left as they are, since they configure the Prometheus Exporter which will be scrapped using an NMaaS hosted Prometheus instance which we will deploy in the next part.
+ - The sensor directives need to be left as they are, since they configure the Prometheus Exporter which will be scrapped using an nmaas hosted Prometheus instance which we will deploy in the next part.
5. As a last step before starting the FreeRTR process, we need to bring up our second interface and disable hardware offloading:
@@ -282,4 +282,4 @@ If automatic startup of the virtual devices is desired, a SystemD service unit c
systemctl enable --now pcap-freertr-r1
```
-We are now ready to configure monitoring and configuration backup of our virtual router using tools from the NMaaS catalog.
\ No newline at end of file
+We are now ready to configure monitoring and configuration backup of our virtual router using tools from the nmaas catalog.
\ No newline at end of file
diff --git a/docs/self-hosted-nmaas/local-dev-environment/p4_monitoring-demo-network-environment.md b/docs/self-hosted-nmaas/local-dev-environment/p4_monitoring-demo-network-environment.md
index 13aaa90b4771dbb4653747211b8d870c01cb87e1..c8cf9b18af90b32517fd216fc9834c1cf0d65de6 100644
--- a/docs/self-hosted-nmaas/local-dev-environment/p4_monitoring-demo-network-environment.md
+++ b/docs/self-hosted-nmaas/local-dev-environment/p4_monitoring-demo-network-environment.md
@@ -1,10 +1,10 @@
-# Part 4: Monitoring the Demo Network Environment with NMaaS
+# Part 4: Monitoring the Demo Network Environment with nmaas
-## Registering a new Local NMaaS User
+## Registering a new Local nmaas User
-Registering a new local NMaaS user can be done from the NMaaS homepage.
+Registering a new local nmaas user can be done from the nmaas homepage.
-
+
Once all of the required fields (denoted by a red *) are filled, and the privacy policy accepted, the registration form can be submitted.
@@ -12,7 +12,7 @@ After submission, an administrator approval is required before being able to log
### Approving the New User (as Admin) and Creating a New Domain
-To approve a newly registered user, login as the NMaaS admin, and navigate to `Settings -> Users` from the right-hand side navigation menu. Hover over the cog next to the new user and select `Enable`.
+To approve a newly registered user, login as the nmaas admin, and navigate to `Settings -> Users` from the right-hand side navigation menu. Hover over the cog next to the new user and select `Enable`.
@@ -28,7 +28,7 @@ Once enabled, the user should be made part of an existing domain. Since we curre
```
- For a local deployment, leave the Kubernetes storage class field empty, and set Kubernetes Ingress class to the ingress class available in the cluster (public for MicroK8s, nginx for K3s)
-- As External service domain set the domain codename, suffixed by the NMaaS URL. For example, if the domain codename is demo, then External service domain should be set to `demo.nmaas.<INGRESS_LB_IP>.nip.io`.
+- As External service domain set the domain codename, suffixed by the nmaas URL. For example, if the domain codename is demo, then External service domain should be set to `demo.nmaas.<INGRESS_LB_IP>.nip.io`.
- Set the DCN deployment type to `Manual` and tick `DCN Configured`.
- Set a dummy customer network, for example `127.0.0.1/24`.
@@ -92,18 +92,18 @@ By now we have configured Prometheus to monitor the devices in our environment,
Grafana is an open-source application that can generate graphs from different data sources, including Prometheus.
-To deploy Grafana in an NMaaS environment, the same general steps can be used as before:
+To deploy Grafana in an nmaas environment, the same general steps can be used as before:
- subscribing to the Grafana application from the Applications page
- creating a new instance from the Subscriptions page
-The configuration wizard that becomes available once the deployment enters the Deployed phase is different in the case of Grafana. Apart from specifying the Grafana username and password that can be used for accessing the web interface, users have the option of directly choosing an existing Prometheus instance that has been deployed within their NMaaS domain, and adding it as a data source to Grafana. This can be accomplished by ticking the `Connect to existing Prometheus instance` checkbox, and selecting the `NMaaS Prometheus Instance` radio button.
+The configuration wizard that becomes available once the deployment enters the Deployed phase is different in the case of Grafana. Apart from specifying the Grafana username and password that can be used for accessing the web interface, users have the option of directly choosing an existing Prometheus instance that has been deployed within their nmaas domain, and adding it as a data source to Grafana. This can be accomplished by ticking the `Connect to existing Prometheus instance` checkbox, and selecting the `nmaas Prometheus Instance` radio button.
-Of course, a Grafana instance hosted on NMaaS can be used for connecting to external data sources as well. In this case, the checkbox `Connect to existing Prometheus instance` can simply be left unchecked.
+Of course, a Grafana instance hosted on nmaas can be used for connecting to external data sources as well. In this case, the checkbox `Connect to existing Prometheus instance` can simply be left unchecked.
Once the application is deployed, it can be accessed by selecting the `Actions -> Access` button. After login, users can verify that the previously deployed Prometheus instance has been added as a Data Source by selecting the cog icon on the left hand side and choosing `Data Sources`.
@@ -134,7 +134,7 @@ After importing the dashboard, a redirect is immediately issued, and the defined
Oxidized is an open-source application that is capable of fetching the configuration of remote devices and if enabled, version it using an internal or external Git repository.
-In our demo scenario, we will use Oxidized to periodically fetch the configuration from the available network elements. To do so, we must first deploy Oxidized in our NMaaS domain.
+In our demo scenario, we will use Oxidized to periodically fetch the configuration from the available network elements. To do so, we must first deploy Oxidized in our nmaas domain.
The deployment steps for Oxidized are very similar to the other applications that have been deployed so far:
@@ -297,11 +297,11 @@ The second column, the IP addresses, should be replaced with the IP addresses of
The final step is to simply commit the changes that have been made. If this is the first time that Git is used, then the global Git `user.name` and `email` should be set:
```bash
-git config --global user.name "NMaaS Demo"
+git config --global user.name "nmaas Demo"
git config --global user.email "nmaas_demo@example.com"
```
-Any value can be used for these parameters, they are not related to NMaaS.
+Any value can be used for these parameters, they are not related to nmaas.
The changes can be committed and pushed to the remote repository using:
diff --git a/docs/self-hosted-nmaas/local-dev-environment/p5_adding_custom_app.md b/docs/self-hosted-nmaas/local-dev-environment/p5_adding_custom_app.md
index 86d2ff60284704983e61f49589d6ed460467042d..1127843b23f40324665e19c341f40ce18de27e4c 100644
--- a/docs/self-hosted-nmaas/local-dev-environment/p5_adding_custom_app.md
+++ b/docs/self-hosted-nmaas/local-dev-environment/p5_adding_custom_app.md
@@ -1,12 +1,12 @@
-# Part 5: Adding a Custom Application to the NMaaS Catalog
+# Part 5: Adding a Custom Application to the nmaas Catalog
-Any application that has an existing Helm chart can be added to the NMaaS catalog. In this example we will use the popular uptime monitoring application - [UptimeKuma](https://github.com/louislam/uptime-kuma).
+Any application that has an existing Helm chart can be added to the nmaas catalog. In this example we will use the popular uptime monitoring application - [UptimeKuma](https://github.com/louislam/uptime-kuma).
-The agenda is to first create a regular Helm chart, without introducing any NMaaS dependencies, thus keeping it reusable across platforms. Then, we will add this Helm chart as a new application to the NMaaS catalog.
+The agenda is to first create a regular Helm chart, without introducing any nmaas dependencies, thus keeping it reusable across platforms. Then, we will add this Helm chart as a new application to the nmaas catalog.
## Creating a Helm Chart
-NMaaS does not mandate any requirements when creating Helm charts. If Helm best practices are followed, then there should not be any problem in integrating the application to the NMaaS catalog.
+nmaas does not mandate any requirements when creating Helm charts. If Helm best practices are followed, then there should not be any problem in integrating the application to the nmaas catalog.
The boilerplate code for a new Helm chart can be generated using the helm create command:
@@ -254,19 +254,19 @@ persistence:
existingClaim: ""
```
-Note that no NMaaS specific information has been used in the chart. The same chart can be used to create an instance of the uptime-kuma application on any Kubernetes cluster.
+Note that no nmaas specific information has been used in the chart. The same chart can be used to create an instance of the uptime-kuma application on any Kubernetes cluster.
Once the chart has been created, it should be uploaded to a Helm repository. There are many providers which allow hosting of Helm charts free of charge.
-!!! note "Submitting an Application to the NMaaS catalog"
+!!! note "Submitting an Application to the nmaas catalog"
For more information, please have a look at our dedicated guide where a step-by-step explanation is provided on using GitHub for hosting and publishing Helm charts - [Adding a New Application](../../nmaas-applications/new-application.md).
-## Adding a new Application to the NMaaS Catalog
+## Adding a new Application to the nmaas Catalog
-After the chart has been updated to a public Helm repository, the new application wizard can be used to add it to the NMaaS catalog.
+After the chart has been updated to a public Helm repository, the new application wizard can be used to add it to the nmaas catalog.
-- Login as the administrator user within the NMaaS portal and choose `Settings -> Applications`.
+- Login as the administrator user within the nmaas portal and choose `Settings -> Applications`.
- Click on the blue `Add` button in the top-left corner.
- The new application wizard consists of 7 steps. These steps are:
- General information
@@ -283,7 +283,7 @@ In the sections that follow we elaborate further on each step.
### Step 1: General Information
-The general information step provides a brief description of the process for adding a new application to the NMaaS catalog.
+The general information step provides a brief description of the process for adding a new application to the nmaas catalog.
Users are required only to tick the `I read the general instructions above checkbox before proceeding to the next step, Basic application information`.
@@ -305,7 +305,7 @@ Before uploading any images, please ensure that you have the appropriate copyrig
### Step 4: Application Descriptions
-NMaaS supports localization in multiple languages. By default the Application descriptions steps shows input fields for `Brief description` and `Full description` of the application in English. These fields should be used to provide a brief introduction for new users to the applications, explaining its features, as well as any default username or passwords that have been used and users are expected to change.
+nmaas supports localization in multiple languages. By default the Application descriptions steps shows input fields for `Brief description` and `Full description` of the application in English. These fields should be used to provide a brief introduction for new users to the applications, explaining its features, as well as any default username or passwords that have been used and users are expected to change.
Translation of the content can be provided for additional languages by choosing the `Select optional languages` dropdown in the bottom left corner.
@@ -320,7 +320,7 @@ The deployment specification page contains common parameters that should be para
The basic application information is consisted of the following fields:
- **Chart name** – the name of the Helm chart that has been uploaded to a public repository. All instances created by end-users will actually be Releases of this chart.
-- **Chart version** – the chart version to be used for creating new application instances. Note that NMaaS fully supports application versioning, and more than one application version can be active and available in the NMaaS catalog at a given point in time. Additional versions can be added once the application has been integrated into the catalog.
+- **Chart version** – the chart version to be used for creating new application instances. Note that nmaas fully supports application versioning, and more than one application version can be active and available in the nmaas catalog at a given point in time. Additional versions can be added once the application has been integrated into the catalog.
- **Helm Chart repository URL address** – the full URL to the Helm repository where the chart is hosted.
- **Expose web user interface** – whether the application being added to the catalog exposes a web interface that should be reachable by users. In the case of UptimeKuma, this should be ticked.
- **Allow SSH access** – whether the application being added to the catalog comes with a built-in SSH server through which the users can directly connect to the container where the application is running, e.g., for additional configuration.
@@ -329,7 +329,7 @@ The basic application information is consisted of the following fields:
#### Global Deploy Parameters
-The global deploy parameters allow the administrator to pass some globally defined NMaaS variables to the Helm Release during its deployment. For example, many applications allow users to specify outbound SMTP servers which can be used for external email sending. Since NMaaS already has an SMTP component, any deployed application can simply use the configured and tested NMaaS email server. In this case, the system variables `SMTP_HOSTNAME`, `SMTP_PORT`, `SMTP_USERNAME`, `SMTP_PASSWORD` can be passed to arbitrary Helm value keys.
+The global deploy parameters allow the administrator to pass some globally defined nmaas variables to the Helm Release during its deployment. For example, many applications allow users to specify outbound SMTP servers which can be used for external email sending. Since nmaas already has an SMTP component, any deployed application can simply use the configured and tested nmaas email server. In this case, the system variables `SMTP_HOSTNAME`, `SMTP_PORT`, `SMTP_USERNAME`, `SMTP_PASSWORD` can be passed to arbitrary Helm value keys.
For example, the following configuration would pass the global `SMTP_HOSTNAME` deploy parameter as the `config.smtp.host` chart parameter whenever a new Release is created:
@@ -350,11 +350,11 @@ In the case of UptimeKuma, we do not need to configure any global deploy paramet
#### Static Global Deploy Parameters
-Static global deploy parameters allow the application administrator to specify custom parameters that should be passed to the chart whenever a new Release is being created. Please note that this is different than `Global Deploy Parameters` which were used to pass an ***internal*** NMaaS parameter to each new Release.
+Static global deploy parameters allow the application administrator to specify custom parameters that should be passed to the chart whenever a new Release is being created. Please note that this is different than `Global Deploy Parameters` which were used to pass an ***internal*** nmaas parameter to each new Release.
In the case of static global deploy parameters, there is no limitation on what can be passed as a value.
-Let's assume that our chart has a values.yaml parameter that enables or disables new user registration, and this parameter is set to enable by default. If we want to disable new user registrations for each new Release and do not want the NMaaS user to have an option to enable registrations, then we can simple disable this behavior using a static global deploy parameter. An example is given below.
+Let's assume that our chart has a values.yaml parameter that enables or disables new user registration, and this parameter is set to enable by default. If we want to disable new user registrations for each new Release and do not want the nmaas user to have an option to enable registrations, then we can simple disable this behavior using a static global deploy parameter. An example is given below.
@@ -379,9 +379,9 @@ In the case of UptimeKuma, the following configuration is required:
#### Access Methods
-The Access Methods section allows the application administrator to customize the parameters related to external access. As previously, NMaaS parameters are mapped to the appropriate parameters exposed by the Chart's values.yaml file.
+The Access Methods section allows the application administrator to customize the parameters related to external access. As previously, nmaas parameters are mapped to the appropriate parameters exposed by the Chart's values.yaml file.
-Most of the parameters are self-explanatory, but some warrant additional attention. For example: the `INGRESS_CLASS` parameter will contain the ingress class that should be used for the newly deployed ingress object once the Helm Release is created. This is an essential information, since NMaaS supports per-domain ingress controllers. Without this information, the wrong ingress controller will most like be used for serving, or the application would not be accessible at all.
+Most of the parameters are self-explanatory, but some warrant additional attention. For example: the `INGRESS_CLASS` parameter will contain the ingress class that should be used for the newly deployed ingress object once the Helm Release is created. This is an essential information, since nmaas supports per-domain ingress controllers. Without this information, the wrong ingress controller will most like be used for serving, or the application would not be accessible at all.
In the case of UptimeKuma, the following configuration is required:
@@ -393,7 +393,7 @@ In the Configuration Templates step the administrator can specify which chart pa
-Let's presume that the chart exposes a `global.notifications.certificateExpiry` parameter which customizes whether the application will send certificate expiry notifications for added monitors or not. We can allow the NMaaS users to customize this parameter in the following way.
+Let's presume that the chart exposes a `global.notifications.certificateExpiry` parameter which customizes whether the application will send certificate expiry notifications for added monitors or not. We can allow the nmaas users to customize this parameter in the following way.
- This parameter would best be modeled by a checkbox, so we drag-and-drop the checkbox component from the left hand side toolbar to the main canvas.
- In the `Display` tab enter basic information about the new form field, such as its label, description, and optional tooltip that will be shown on hover.
@@ -416,6 +416,6 @@ If no additional changes need to be made, the application can be submitted by cl
### Approving the Application
-Before the application will be shown to all users of the NMaaS instance, it must be activated. This can be done from the Applications page by simply expanding the list of application versions, hovering on the cog button, selecting the `Change state` option and setting the state to `Active`.
+Before the application will be shown to all users of the nmaas instance, it must be activated. This can be done from the Applications page by simply expanding the list of application versions, hovering on the cog button, selecting the `Change state` option and setting the state to `Active`.
\ No newline at end of file
diff --git a/docs/use-cases/virtual-lab/bulk-application-deployment.md b/docs/use-cases/virtual-lab/bulk-application-deployment.md
index 3956e210dc15b592d825466e5388a0235cf2ad0d..24ecff396d031a6ed0b8c0c8497ea8f954db58ae 100644
--- a/docs/use-cases/virtual-lab/bulk-application-deployment.md
+++ b/docs/use-cases/virtual-lab/bulk-application-deployment.md
@@ -1,20 +1,20 @@
# Bulk Application Deployment
-The "bulk application deployment" feature allows NMaaS administrators to deploy many application instances at once. This is useful for scenarios where NMaaS is used simply as an orchestration platform, and the end-users of the deployed applications should not be required to have an NMaaS account.
+The "bulk application deployment" feature allows nmaas administrators to deploy many application instances at once. This is useful for scenarios where nmaas is used simply as an orchestration platform, and the end-users of the deployed applications should not be required to have an nmaas account.
## Bulk Application Deployment in the Context of Virtual Lab
-When using NMaaS for the virtual lab use-case, teachers might want to deploy individual application instances for each student taking part in a course, without going over the account provisioning process first. There can be many reasons for taking this approach, such as:
+When using nmaas for the virtual lab use-case, teachers might want to deploy individual application instances for each student taking part in a course, without going over the account provisioning process first. There can be many reasons for taking this approach, such as:
-- the NMaaS web UI is deployed in an isolated network without public access
+- the nmaas web UI is deployed in an isolated network without public access
- the students are not experienced enough with the use of PaaS-like platforms
-- the process defined by the home institution regarding on-boarding of new users to NMaaS is too time consuming
+- the process defined by the home institution regarding on-boarding of new users to nmaas is too time consuming
-After bulk deploying the applications, teachers can simply share the connection information with the students, completely abstracting away the use of NMaaS, and hiding any implementational details.
+After bulk deploying the applications, teachers can simply share the connection information with the students, completely abstracting away the use of nmaas, and hiding any implementational details.
## Using Bulk Application Deployment
-The bulk application deployment feature can be accessed by navigating to `Advanced -> Bulk application deployments`. Note that currently this feature is only available to global NMaaS administrators.
+The bulk application deployment feature can be accessed by navigating to `Advanced -> Bulk application deployments`. Note that currently this feature is only available to global nmaas administrators.
The overview page shows a history of past bulk application deployments, with options either to see more details about a given deployment, or create a new one.
diff --git a/docs/use-cases/virtual-lab/bulk-domain-deployment.md b/docs/use-cases/virtual-lab/bulk-domain-deployment.md
index 1a9af342955f938589ee8c35847cd98260658cc7..35f689dcd526559e1eba657f15e7cb431189e1ed 100644
--- a/docs/use-cases/virtual-lab/bulk-domain-deployment.md
+++ b/docs/use-cases/virtual-lab/bulk-domain-deployment.md
@@ -1,10 +1,10 @@
# Bulk Domain Deployment
-The "bulk domain deployment" feature in NMaaS allows administrators to provision new domains and users in bulk. This is useful in cases where large groups of people should be registered at once, such as in the case with the virtual lab scenario.
+The "bulk domain deployment" feature in nmaas allows administrators to provision new domains and users in bulk. This is useful in cases where large groups of people should be registered at once, such as in the case with the virtual lab scenario.
## Bulk Domain Deployment in the Context of Virtual Lab
-When NMaaS is used for virtual lab deployments, teachers might need to create new accounts for all enrolled students in a given course, create corresponding domains, and join them to appropriate[domain groups](./domain-groups.md). All of these tasks can be accomplished using the bulk domain deployment functionality.
+When nmaas is used for virtual lab deployments, teachers might need to create new accounts for all enrolled students in a given course, create corresponding domains, and join them to appropriate[domain groups](./domain-groups.md). All of these tasks can be accomplished using the bulk domain deployment functionality.
## Using Bulk Domain Deployment
@@ -23,7 +23,7 @@ domain,username,networks,domainGroups,email
```
!!! notice "Registering New Users"
- Non-existent users can also be referenced in the CSV file for bulk domain deployment. In such cases, the user is automatically provisioned. Access to the NMaaS platform is provided to users after using the `Forgot password` functionality, and activating their account using the provided email address during the bulk domain provisioning.
+ Non-existent users can also be referenced in the CSV file for bulk domain deployment. In such cases, the user is automatically provisioned. Access to the nmaas platform is provided to users after using the `Forgot password` functionality, and activating their account using the provided email address during the bulk domain provisioning.
!!! notice "Domain Groups"
During bulk domain deployment, if any non-existent domain groups referenced in the CSV file are automatically created. After the domain import is completed, administrators should make sure to whitelist the desired applications for deployment, since by default all applications are blacklisted for new domain groups.
diff --git a/docs/use-cases/virtual-lab/domain-groups.md b/docs/use-cases/virtual-lab/domain-groups.md
index 9fc76367835ee2ce604050356868dfe445ab046c..f39fb09fcfa37ef8649075495b14ec8dd65b73e1 100644
--- a/docs/use-cases/virtual-lab/domain-groups.md
+++ b/docs/use-cases/virtual-lab/domain-groups.md
@@ -1,10 +1,10 @@
-# Domain Groups in NMaaS
+# Domain Groups in nmaas
-"Domain groups" is an NMaaS feature that allows NMaaS administrators to restrict which applications are available for deployment to given domains. This feature is useful for scenarios where a group of domains should have access to a restricted set of applications, instead of the whole catalog.
+"Domain groups" is an nmaas feature that allows nmaas administrators to restrict which applications are available for deployment to given domains. This feature is useful for scenarios where a group of domains should have access to a restricted set of applications, instead of the whole catalog.
## Domain Groups in the Context of Virtual Lab
-An example scenario for domain groups and one for which they were originally developed is virtual lab. When organizing virtual labs on NMaaS, it is expected that many different users might need access to a different set of applications, but not to the whole catalog at once. This is the case when a university uses NMaaS for conducting virtual labs for multiple courses. Students enrolled in course A might need access to applications 1, 2, and 3, while students in course B might need access to applications 4, 5, and 6. Assuming that the complete NMaaS catalog also includes applications aimed at the teaching staff which might require additional compute resources or present security risks when deployed by students, such applications should not be deployable in the students' domains.
+An example scenario for domain groups and one for which they were originally developed is virtual lab. When organizing virtual labs on nmaas, it is expected that many different users might need access to a different set of applications, but not to the whole catalog at once. This is the case when a university uses nmaas for conducting virtual labs for multiple courses. Students enrolled in course A might need access to applications 1, 2, and 3, while students in course B might need access to applications 4, 5, and 6. Assuming that the complete nmaas catalog also includes applications aimed at the teaching staff which might require additional compute resources or present security risks when deployed by students, such applications should not be deployable in the students' domains.
## Using Domain Groups
@@ -18,7 +18,7 @@ In the scenario described above, `test-domain` would have access to all 5 applic
!!! warning "Initial Domain Group Settings"
- When creating a domain group for the first time, all of the applications are blacklisted. This means that a domain part of a single domain group where application policies have not been defined yet will not be able to deploy any application on NMaaS.
+ When creating a domain group for the first time, all of the applications are blacklisted. This means that a domain part of a single domain group where application policies have not been defined yet will not be able to deploy any application on nmaas.
Domain groups can be managed by selecting the `Domain groups` option from the settings dropdown in the navigational menu (represented by a cog icon). Administrators are given the option to manually create a new domain group, manage domain group memberships, and alter the list of whitelisted/blacklisted applications for a given domain group.
diff --git a/docs/use-cases/virtual-lab/vlab-introduction.md b/docs/use-cases/virtual-lab/vlab-introduction.md
index 4d84eaf0d6b8302c74206b563cc513f111ee0d9b..9a5182eb04df301f5a704d99914e903b89d7c83f 100644
--- a/docs/use-cases/virtual-lab/vlab-introduction.md
+++ b/docs/use-cases/virtual-lab/vlab-introduction.md
@@ -1,27 +1,27 @@
-# Introduction to NMaaS Virtual Lab
+# Introduction to nmaas Virtual Lab
-NMaaS Virtual Lab is a new NMaaS use-case aimed at educational communities. The core idea is to leverage the existing NMaaS functionality of on-demand application deployment and repurpose it in a learning context. This approach would allow NMaaS to be further used in the process of both formal, supervised, education (e.g., university courses), as well as for informal, and self-paced education (MOOCs, short demos, tutorials). During the initial planning, a number of scenarios have been envisioned, including:
+nmaas Virtual Lab is a new use-case for the nmaas Platform aimed at educational communities. The core idea is to leverage the existing nmaas platform functionality of on-demand application deployment and repurpose it in a learning context. This approach would allow nmaas to be further used in the process of both formal, supervised, education (e.g., university courses), as well as for informal, and self-paced education (MOOCs, short demos, tutorials). During the initial planning, a number of scenarios have been envisioned, including:
- deployment of randomized, black-box containers for studying common software vulnerabilities;
- offloading of resource-intensive workloads on a centralized and powerful Kubernetes cluster, including JupyterLab servers, data processing pipelines, and simulations;
- creation of personalized, portable development environments with all necessary services included, such as a web-based integrated development environments (IDEs), relational databases, message queues, application servers, etc...
- making use of limited compute resources to serve as many users as possible through the deployment of ephemeral containers that are active only while used and paused when idle. Reactivation can be attempted at any point in time, preserving all previous data.
-The overall use-case along with its distinct scenarios has the potential to bring a number of benefits to both learners and educators. In the subsections below we elaborate on the underlying NMaaS features which make these benefits possible in more details.
+The overall use-case along with its distinct scenarios has the potential to bring a number of benefits to both learners and educators. In the subsections below we elaborate on the underlying nmaas Virtual Lab features which make these benefits possible in more details.
-## NMaaS Virtual Lab from the Perspective of Educators
+## nmaas Virtual Lab from the Perspective of Educators
-Organizing hands-on exercises where all students can participate is often a challenging and time-consuming task for educators. It entails hardware provisioning, configuration, application deployment, user management, per tenant isolation, and integration with existing platforms, such as learning management systems (LMS) and grading systems. Depending on the subject area and technical proficiency of the educators and supporting staff, this manual approach does not scale for moderate and large groups of students. To overcome these issues, NMaaS will implement the following features, with the end-goal of making the organization of hands-on exercises by educators as effortless as possible:
+Organizing hands-on exercises where all students can participate is often a challenging and time-consuming task for educators. It entails hardware provisioning, configuration, application deployment, user management, per tenant isolation, and integration with existing platforms, such as learning management systems (LMS) and grading systems. Depending on the subject area and technical proficiency of the educators and supporting staff, this manual approach does not scale for moderate and large groups of students. To overcome these issues, nmaas will implement the following features, with the end-goal of making the organization of hands-on exercises by educators as effortless as possible:
- centralized provisioning and management of user profiles together with support for bulk user imports from LMS exports;
- individual, isolated, workspace (domain) for each and every user where they can deploy available applications on-demand, without interference from other participants;
- shared domains between multiple users for scenarios where team work is expected;
-- personalized catalog of applications for each user through the introduction of domain groups. Each domain group can contain one or more domains, precisely specifying what applications are available for deployment by the users. This allows the same - NMaaS instance to be reused for multiple courses at the same, where each user can be enrolled into multiple courses, and would have access only to previously whitelisted applications;
+- personalized catalog of applications for each user through the introduction of domain groups. Each domain group can contain one or more domains, precisely specifying what applications are available for deployment by the users. This allows the same - nmaas instance to be reused for multiple courses at the same, where each user can be enrolled into multiple courses, and would have access only to previously whitelisted applications;
- bulk deployment of application instances across multiple domains for scenarios where the application deployment should not be done by the users themselves.
-## NMaaS Virtual Lab from the Perspective of Learners
+## nmaas Virtual Lab from the Perspective of Learners
-Due to the challenging nature of organizing hands-on exercises, learners are usually required to deploy the necessary applications on their own workstations, either directly or in an isolated environment through the use of containers or virtual machines. This approach requires that each participant not only have the necessary hardware resources, but also to posses the required technical know-how for setting up and debugging the environment, which is usually not the main focus of the exercise itself. To make hands-on exercises more accessible to all learners, no matter their background or area of study, NMaaS will offer the following features:
+Due to the challenging nature of organizing hands-on exercises, learners are usually required to deploy the necessary applications on their own workstations, either directly or in an isolated environment through the use of containers or virtual machines. This approach requires that each participant not only have the necessary hardware resources, but also to posses the required technical know-how for setting up and debugging the environment, which is usually not the main focus of the exercise itself. To make hands-on exercises more accessible to all learners, no matter their background or area of study, nmaas will offer the following features:
- an accessible web portal where users can login and gain access to a curated catalog of applications they can explore;
- a simple deployment of application instances through the use of a deployment wizard which visually guides the user through the necessary steps;
@@ -30,7 +30,7 @@ an isolated environment for experimenting, where depending on the application ca
## The Road Ahead
-The vision for the NMaaS virtual lab use-case is to make it as easy as possible to deploy and use, both from the educators and learners perspective. By leveraging the possibility to add custom applications to the catalog, it is expected that each deployment will have a unique set of deployable applications. Through the introduction of catalog federation, it should be possible for different institutions to share their application templates, fostering collaboration, and knowledge exchange, bringing added value to the whole NMaaS ecosystem. It should be recognized that NMaaS does not necessarily have to be limited to organizing hands-on exercises for learners. As a result of its multi-tenancy, a single NMaaS instance can also be used by the educators themselves, making use of the compute capacity for running resource intensive processing pipelines or Jupyter notebooks. It can also be used by the supporting staff for easy deployment and management of network services which, of course, is the original use-case of NMaaS.
+The vision for nmaas Virtual Lab is to make it as easy as possible to deploy and use, both from the educators and learners perspective. By leveraging the possibility to add custom applications to the catalog, it is expected that each deployment will have a unique set of deployable applications. Through the introduction of catalog federation, it should be possible for different institutions to share their application templates, fostering collaboration, and knowledge exchange, bringing added value to the whole nmaas ecosystem. It should be recognized that nmaas does not necessarily have to be limited to organizing hands-on exercises for learners. As a result of its multi-tenancy, a single nmaas instance can also be used by the educators themselves, making use of the compute capacity for running resource intensive processing pipelines or Jupyter notebooks. It can also be used by the supporting staff for easy deployment and management of network services which, of course, is the original use-case of nmaas (now known as nmaas for Virtual NOC).
## Demos
@@ -38,6 +38,6 @@ The first video below demonstrates the deployment process of an application from
-The second video below showcases how NMaaS can be used as a remote development environment for various programming languages (Python in this particular case).
+The second video below showcases how nmaas Virtual Lab can be used as a remote development environment for various programming languages (Python in this particular case).
\ No newline at end of file
diff --git a/docs/use-cases/virtual-noc/vnoc-introduction.md b/docs/use-cases/virtual-noc/vnoc-introduction.md
new file mode 100644
index 0000000000000000000000000000000000000000..e9a0c4dc8dfa8a9341a2842e26bd42dc93d163c3
--- /dev/null
+++ b/docs/use-cases/virtual-noc/vnoc-introduction.md
@@ -0,0 +1,32 @@
+# Introduction to nmaas Virtual NOC
+
+Today’s network services are complex with heterogeneous network infrastructures and increasing numbers of value added services and features. Services are becoming increasingly mission critical for end users and the need to provide an integrated view of network and service management will become vital.
+
+The cost and complexity of developing and integrating in-house network management may be too high for many NRENs and institutions. nmaas Virtual NOC aims to support these users to provide an effective, efficient network and service management platform.
+
+## What does nmaas Virtual NOC offer?
+
+nmaas Virtual NOC provides a portfolio of network management applications run on a per-user, secured network monitoring infrastructure. A managed instance of nmaas Virtual NOC is available on [https://nmaas.eu](https://nmaas.eu). [Self-hosting](../../self-hosted-nmaas/introduction.md) is also possible, since all of the components are open-source. The managed instance caters to the following aspects:
+
+- Providing, managing and maintaining the infrastructure of the nmaas service portal, platform and selected tools.
+- Supporting users in using the system, and the selected tools for monitoring their networks via nmaas Virtual NOC.
+- Supporting users that contribute their software to the nmaas Virtual NOC system.
+- nmaas Virtual NOC users are organizations that do not want to own NMS infrastructure themselves and/or want to outsource network management, as well as organizations and/or individuals that are searching for quality network management software or who want to share their software within the community. nmaas Virtual NOC provides multiple benefits, as a system, an application marketplace, and as a service.
+
+nmaas Virtual NOC simplifies domain network management by providing the infrastructure and tools via a cloud-based, multi-tenant and secure network management system. It enables the deployment of network management tools, as well as management and monitoring of client networks, although nmaas Virtual NOC does not monitor and manage the network by itself.
+
+The selection of tools that is and/or can be made available to users is not limited to network management tools and can be easily extended. This allows the same underlying software, the nmaas Platform, to be utilized in multiple scenarios, a prime example being the [nmaas Virtual Lab use-case](../virtual-lab/vlab-introduction.md).
+
+## What is the target group of nmaas Virtual NOC?
+
+nmaas Virtual NOC has been designed to be as flexible as possible to support a wide range of users, including:
+
+- **Small and Emerging NRENs** - Smaller NRENs may have limited resources to develop their own network management systems. By using a shared and supported platform, NRENs can focus on the monitoring and management of their service components.
+- **Small Organisations** - nmaas Virtual NOC is ideally suited to support the needs of institutional users - either on an NREN hosted nmaas Virtual NOC deployment or on the managed instance.
+- **Distributed Research Projects** - By using a managed platform, these projects can focus on their core research and development activities.
+
+## How Can I Get Started with nmaas Virtual NOC?
+
+If you are NREN or an institution under an NREN and you would like to use the managed nmaas for Virtual NOC instance provided by the GÉANT project, [get in touch with us](../../contact.md). Users interested in self-hosting nmaas Virtual NOC are welcome to visit the dedicated pages for setting up a [demo environment](../../self-hosted-nmaas/local-dev-environment/introduction.md) or deploying nmaas for Virtual NOC on their [own infrastructure](../../self-hosted-nmaas/introduction.md).
+
+A [playground instance](../../managed-nmaas/nmaas-playground-instance.md) hosted by GÉANT is also available.
\ No newline at end of file
diff --git a/docs/what-is-nmaas.md b/docs/what-is-nmaas.md
index 1e7689a012ebd4dd0439127e050c3572921d2f37..992c41d231b70add216491eb9d52504611bcef4e 100644
--- a/docs/what-is-nmaas.md
+++ b/docs/what-is-nmaas.md
@@ -1,5 +1,5 @@
-# What is **NMaaS**?
+# What is **nmaas**?
-NMaaS is an [open source](https://gitlab.software.geant.org/nmaas) framework originally developed within the [GÉANT](https://geant.org/projects/) project for orchestration of on-demand deployment of applications in a Kubernetes-based cloud environment.
+The nmaas platform is an [open source](https://gitlab.software.geant.org/nmaas) framework originally developed within the [GÉANT](https://geant.org/projects/) project for orchestration of on-demand deployment of applications in a Kubernetes-based cloud environment.
-With a simple self-service web interface, NMaaS applications are easily deployed within an isolated tenant environment assigned to a given institution or team. An application’s lifecycle (configuration updates and re-deployments) is fully managed following a GitOps approach: a specific Git repository is tightly associated with every deployed application and a set of CI/CD pipelines ensure proper re-deployments of the applications following every update on the Git master branch.
\ No newline at end of file
+With a simple self-service web interface, nmaas applications are easily deployed within an isolated tenant environment assigned to a given institution or team. An application’s lifecycle (configuration updates and re-deployments) is fully managed following a GitOps approach: a specific Git repository is tightly associated with every deployed application and a set of CI/CD pipelines ensure proper re-deployments of the applications following every update on the Git master branch, ensuring consistent configuration.
\ No newline at end of file
diff --git a/mkdocs.yml b/mkdocs.yml
index e084f715d3b9cd7605a49da1aeab0aba2ba3838f..52ad9189b4f83668b5ea1897bbac0d965a6b6492 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -1,33 +1,35 @@
-site_name: NMaaS Documentation
+site_name: nmaas Documentation
site_url: 'https://docs.nmaas.eu'
nav:
- Home: index.md
- - What is NMaaS?: 'what-is-nmaas.md'
- - NMaaS Guides:
+ - What is nmaas?: 'what-is-nmaas.md'
+ - nmaas Guides:
- Application Manager Guide: 'guides/application-manager-guide.md'
- Domain Admin Guide: 'guides/domain-admin-guide.md'
- User Guide: 'guides/user-guide.md'
- - Managed NMaaS:
+ - Managed nmaas:
- Introduction: 'managed-nmaas/introduction.md'
- - NMaaS Playground Instance: 'managed-nmaas/nmaas-playground-instance.md'
- - Self-Hosted NMaaS:
+ - nmaas Playground Instance: 'managed-nmaas/nmaas-playground-instance.md'
+ - Self-Hosted nmaas:
- Introduction: 'self-hosted-nmaas/introduction.md'
- Installation Guide: 'self-hosted-nmaas/install-guide.md'
- Local Development Environment:
- Introduction: 'self-hosted-nmaas/local-dev-environment/introduction.md'
- Part 1 - Deploying a Local Kubernetes Cluster: 'self-hosted-nmaas/local-dev-environment/p1_local-kubernetes-cluster.md'
- - Part 2 - Installing NMaaS: 'self-hosted-nmaas/local-dev-environment/p2_installing-nmaas.md'
+ - Part 2 - Installing nmaas: 'self-hosted-nmaas/local-dev-environment/p2_installing-nmaas.md'
- Part 3 - Demo Network Environment: 'self-hosted-nmaas/local-dev-environment/p3_demo-network-environment.md'
- Part 4 - Monitoring the Demo Network Environment: 'self-hosted-nmaas/local-dev-environment/p4_monitoring-demo-network-environment.md'
- Part 5 - Adding a Custom Application: 'self-hosted-nmaas/local-dev-environment/p5_adding_custom_app.md'
- Appendix - Credentials: 'self-hosted-nmaas/local-dev-environment/appendix.md'
- - NMaaS Use-Cases:
+ - nmaas Use-Cases:
+ - Virtual NOC:
+ - Introduction: 'use-cases/virtual-noc/vnoc-introduction.md'
- Virtual Lab:
- Introduction: 'use-cases/virtual-lab/vlab-introduction.md'
- Bulk Domain Deployment: 'use-cases/virtual-lab/bulk-domain-deployment.md'
- Domain Groups: 'use-cases/virtual-lab/domain-groups.md'
- Bulk Application Deployment: 'use-cases/virtual-lab/bulk-application-deployment.md'
- - NMaaS Applications:
+ - nmaas Applications:
- General Application Deployment: 'nmaas-applications/general-app-deployment.md'
- List of Supported Applications: 'nmaas-applications/application-list.md'
- Adding a New Application: 'nmaas-applications/new-application.md'
@@ -65,20 +67,20 @@ nav:
- GP4L Orchestrator: 'nmaas-applications/tutorials/gp4l-orchestrator.md'
- Apache Airflow: 'nmaas-applications/tutorials/apache-airflow.md'
- Blog:
- - NMaaS-101 - "Hello NMaaS !": 'blog/blog1/nmaas-101-1.md'
- - NMaaS-101 - "I can help! But... Please could you open these two doors?": 'blog/blog2/nmaas-101-2.md'
- - NMaaS-101 - "My name is Oxidized and I'm a nifty configuration management tool": 'blog/blog3/nmaas-101-3.md'
- - NMaaS-101 - "Prometheus" : 'blog/blog4/nmaas-101-4.md'
+ - nmaas-101 - "Hello nmaas!": 'blog/blog1/nmaas-101-1.md'
+ - nmaas-101 - "I can help! But... Please could you open these two doors?": 'blog/blog2/nmaas-101-2.md'
+ - nmaas-101 - "My name is Oxidized and I'm a nifty configuration management tool": 'blog/blog3/nmaas-101-3.md'
+ - nmaas-101 - "Prometheus" : 'blog/blog4/nmaas-101-4.md'
- Release Notes:
- '1.6.0': 'release-notes/1.6.0.md'
- '1.5.4': 'release-notes/1.5.4.md'
- - NMaaS Presentations: 'nmaas-presentations.md'
+ - nmaas Presentations: 'nmaas-presentations.md'
- FAQ: faq.md
- Contact: contact.md
- About: about.md
theme:
- logo: 'img/NMaaS-logo-transparent-white.png'
+ logo: 'img/nmaas_white_text.png'
custom_dir: docs/overrides
favicon: 'img/favicon.ico'
name: 'material'