From 60a1184d56e04cb06dc9b9001dd2f887f0dc0c9b Mon Sep 17 00:00:00 2001
From: Vojdan Kjorveziroski <vojdan.kjorveziroski@finki.ukim.mk>
Date: Mon, 3 Jun 2024 18:03:15 +0200
Subject: [PATCH] Update the virtual lab pages with the new name
---
.../bulk-application-deployment.md | 12 +++++------
.../virtual-lab/bulk-domain-deployment.md | 6 +++---
docs/use-cases/virtual-lab/domain-groups.md | 8 ++++----
.../virtual-lab/vlab-introduction.md | 20 +++++++++----------
4 files changed, 23 insertions(+), 23 deletions(-)
diff --git a/docs/use-cases/virtual-lab/bulk-application-deployment.md b/docs/use-cases/virtual-lab/bulk-application-deployment.md
index 3956e21..24ecff3 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 1a9af34..35f689d 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 9fc7636..f39fb09 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 4d84eaf..9a5182e 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
--
GitLab