Skip to content
Snippets Groups Projects

Resolve "TNC improvements"

Merged Resolve "TNC improvements"
74-tnc-improvements into master
Merged Vojdan Kjorveziroski requested to merge 74-tnc-improvements into master
Viewing commit cc88b1dc
Prev Next
Show latest version
4 files
+ 35
− 35
Compare changes
  • Side-by-side
  • Inline
Files
4
docs/guides/application-manager-guide.md
+ 12
− 12
@@ -5,7 +5,7 @@
## 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.
@@ -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.
## 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.
![Adding new application wizard - step 1](./img/app-manager-s03.png)
!!! 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:
![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
@@ -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)
!!! 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
![Adding new application wizard - step 5](./img/app-manager-s07.png)
!!! 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