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

Update the guides with the new name

parent 8c74a24c
No related branches found
No related tags found
1 merge request!7Resolve "TNC improvements"
...@@ -5,7 +5,7 @@ ...@@ -5,7 +5,7 @@
## Introduction ## 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. 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.
...@@ -47,26 +47,26 @@ From this view an `Application manager` can perform the following actions: ...@@ -47,26 +47,26 @@ From this view an `Application manager` can perform the following actions:
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. 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. 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. 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.
![Adding new application wizard - step 1](./img/app-manager-s03.png) ![Adding new application wizard - step 1](./img/app-manager-s03.png)
!!! warning !!! 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 !!! 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 ### Providing Application Basic Information
...@@ -79,7 +79,7 @@ The first basic information form comprises the following fields: ...@@ -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 - `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 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) - `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 - `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`) - 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: ...@@ -89,7 +89,7 @@ The first basic information form comprises the following fields:
![Adding new application wizard - step 2](./img/app-manager-s04.png) ![Adding new application wizard - step 2](./img/app-manager-s04.png)
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 ### Providing Application Logo and Screenshots
...@@ -100,7 +100,7 @@ Once `Choose` button is clicked a file selection window is displayed allowing th ...@@ -100,7 +100,7 @@ Once `Choose` button is clicked a file selection window is displayed allowing th
![Adding new application wizard - step 3](./img/app-manager-s05.png) ![Adding new application wizard - step 3](./img/app-manager-s05.png)
!!! info !!! 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. 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 ...@@ -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. 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 #### General information fields
...@@ -137,7 +137,7 @@ NMaaS applications are deployed using Helm thus is it mandatory to provide the r ...@@ -137,7 +137,7 @@ NMaaS applications are deployed using Helm thus is it mandatory to provide the r
![Adding new application wizard - step 5](./img/app-manager-s07.png) ![Adding new application wizard - step 5](./img/app-manager-s07.png)
!!! info !!! 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 #### Global Deploy Parameters
......
...@@ -2,12 +2,12 @@ ...@@ -2,12 +2,12 @@
## Domain Administrator Role ## 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 !!! info
In order to apply for a new domain creation submit the form available at https://nmaas.eu/about?type=NEW_DOMAIN_REQUEST. 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. The initial assignment of that role in newly created domain is performed by administrators based on the received domain creation request.
......
...@@ -3,9 +3,9 @@ ...@@ -3,9 +3,9 @@
!!! warning Work in Progress !!! warning Work in Progress
This guide is currently a work in progress. Some sections might be missing or contain incomplete information. 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" !!! info "Domain Assignment"
User can be assigned to multiple domains. User can be assigned to multiple domains.
...@@ -13,9 +13,9 @@ A domain in NMaaS corresponds to a dedicated and isolated tenant environment cre ...@@ -13,9 +13,9 @@ A domain in NMaaS corresponds to a dedicated and isolated tenant environment cre
!!! info "Requesting a New Domain" !!! 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. 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. Roles on each level can be assigned independently.
...@@ -30,7 +30,7 @@ The remaining roles on the global level are: ...@@ -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) - **System administrator** - gives the user the complete system administration rights in the Portal (including user, domain and application management)
!!! info "Additional Information" !!! 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 ### 2.2 Domain Level Roles
...@@ -48,19 +48,19 @@ These roles are assigned per user domain. A single user may have different roles ...@@ -48,19 +48,19 @@ These roles are assigned per user domain. A single user may have different roles
!!! info "VPN Requirements" !!! 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 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 portal](./img/user-guide-s01.png) ![NmaaS portal](./img/user-guide-s01.png)
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 ### 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 ## 4. User Login
...@@ -87,7 +87,7 @@ Registration form contains several mandatory fields, which are: `Username`, `Pas ...@@ -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 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`. 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 ...@@ -97,11 +97,11 @@ A user needs to be assigned a specific role within particular domain in order to
## 6. Application Market ## 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.
![Application market](./img/user-guide-s04.png) ![Application market](./img/user-guide-s04.png)
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. 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 ...@@ -110,7 +110,7 @@ Single application tile consists of the logo, name, brief description and curren
## 7. Application Subscriptions and Instances ## 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. 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 ...@@ -125,7 +125,7 @@ Application instances are described by custom Name assigned during deployment, n
### 8.1 Application Details View ### 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.
![Application details](./img/user-guide-s05.png) ![Application details](./img/user-guide-s05.png)
...@@ -152,7 +152,7 @@ The installation process comprises few steps including subscription validation, ...@@ -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). 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" !!! 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" !!! info "Application Deployment Notifications"
User is notified with an email once the new application instance becomes available 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* ...@@ -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. 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.
![Application access](./img/user-guide-s19.png) ![Application access](./img/user-guide-s19.png)
![Application access](./img/user-guide-s09.png) ![Application access](./img/user-guide-s09.png)
...@@ -284,7 +284,7 @@ For applications that support the Git-based configuration management model, mean ...@@ -284,7 +284,7 @@ For applications that support the Git-based configuration management model, mean
![User SSH add](./img/user-guide-s16.png) ![User SSH add](./img/user-guide-s16.png)
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 ### 9.4 Password Change
...@@ -297,9 +297,9 @@ On clicking the `Change password` button, a new window will be displayed where t ...@@ -297,9 +297,9 @@ On clicking the `Change password` button, a new window will be displayed where t
## 10. Contact Form ## 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.
![Contact form](./img/user-guide-s18.png) ![Contact form](./img/user-guide-s18.png)
......
...@@ -3,7 +3,7 @@ site_url: 'https://docs.nmaas.eu' ...@@ -3,7 +3,7 @@ site_url: 'https://docs.nmaas.eu'
nav: nav:
- Home: index.md - Home: index.md
- What is nmaas?: 'what-is-nmaas.md' - What is nmaas?: 'what-is-nmaas.md'
- NMaaS Guides: - nmaas Guides:
- Application Manager Guide: 'guides/application-manager-guide.md' - Application Manager Guide: 'guides/application-manager-guide.md'
- Domain Admin Guide: 'guides/domain-admin-guide.md' - Domain Admin Guide: 'guides/domain-admin-guide.md'
- User Guide: 'guides/user-guide.md' - User Guide: 'guides/user-guide.md'
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment