Skip to content
Snippets Groups Projects
Select Git revision
  • renovate/mockito-monorepo
  • renovate/io.jsonwebtoken-jjwt-jackson-0.12.x
  • renovate/flyway
  • renovate/io.jsonwebtoken-jjwt-impl-0.12.x
  • renovate/io.jsonwebtoken-jjwt-api-0.12.x
  • renovate/patch-micrometer
  • renovate/org.hibernate.orm-hibernate-envers-6.6.x
  • renovate/org.hibernate.orm-hibernate-envers-7.x
  • develop default protected
  • 312_limits
  • renovate/gradle-9.x
  • 306-pass-proper-kuberconfig-file-content-to-janitor-to-run-operations-on-desired-cluster
  • renovate/com.opencsv-opencsv-5.x
  • release/1.8.0 protected
  • release/1.7.1 protected
  • 284-check-problem-with-refreshing-app-list-cache
  • 270-feduc-k8s-clusters-management
  • release/1.7.0 protected
  • 257-saml-token-as-oidc-token-needs-improvements
  • release/1.6.5 protected
  • v1.7.1 protected
  • v1.7.0 protected
  • v1.6.5 protected
  • v1.6.4 protected
  • v1.6.3 protected
  • v1.6.2 protected
  • v1.6.1 protected
  • v1.6.0 protected
28 results
Compare
Łukasz Łopatowski's avatar
Pull request #862: Updated version to 1.5.1
Lukasz Lopatowski authored 
Merge in NMAAS/nmaas from release/1.5.1 to develop

* commit '037cf68a':
  Updated version to 1.5.1
b3f5d348
History
Łukasz Łopatowski's avatar b3f5d348
History
Name Last commit Last update
docker
gradle/wrapper
src
ws
.gitignore
Dockerfile
build.gradle
build_and_publish.sh
gradlew
gradlew.bat
lombok.config
readme.md
readme.md

NMaaS Platform (back-end)

NMaaS Platform is one of the components of the NMaaS system that implements mechanisms for on-demand network management applications deployment in the cloud environment and connectivity setup between the managed equipment and the running application.

NMaaS applications are containerized and deployed using Helm charts. Platform exposes a REST API consumed by the NMaaS Portal GUI.

Technologies

  • Java 11
  • Spring
  • Spring Boot (2.7+)
  • freemarker
  • Gitlab4j
  • Flyway
  • Kubernetes API client from fabric8

Running NMaaS Platform on local machine

Prerequisites

Install Java 11 jdk

Running the software

In order to build and run the NMaaS Platform software locally execute ./gradlew bootRun in project root directory. By default, the REST API will be exposed at http://localhost:9000/api.

Running NMaaS Platform on dedicated server machine

In order to run the NMaaS Platform on dedicated machine perform the following steps:

  • Build the NMaaS Platform with ./gradlew clean build command project root directory.
  • Retrieve the output executable nmaas-platform-x.x.x.jar file from build/libs directory.
  • Run the NMaaS Platform with java -jar nmaas-platform-x.x.x.jar and optional arguments:
    • --Dlog4j.configurationFile specifying the name of logger (Log4j2) configuration file (located in the same directory as the jar file) to be loaded instead of the built-in one. Please be advised that you have to add that parameter before the -jar parameter.
    • --spring.config.name specifying the name of the properties file (located in the same directory as the jar file) to be loaded instead of the built-in one.

Swagger documentation of the NMaaS Platform REST API

NMaaS Platform by default exposes two endpoints documenting the REST API:

  • /api-docs/spec - Open API specification of the API
  • /api-docs/ui.html - Swagger UI The Swagger endpoint can be disabled in properties file.

Populating NMaaS Platform database with initial data

To initialize the NMaaS Platform database with a default set of data run src/test/shell/init.sh script. Script will load the following data:

  • set of content translation data (from src/test/shell/data/i18n)
  • set of default email templates (from src/test/shell/data/mails)
  • set of default contact form templates (from src/test/shell/data/form_types)
  • set of test NMaaS user domains (from src/test/shell/data/domains)
  • set of NMaaS-compatible application definitions with test subscriptions and comments (from src/test/shell/data/apps)

Complete deployment environment setup for Kubernetes

A dedicated Helm chart has been developed to ease the NMaaS installation inside a Kubernetes cluster. This way both the supported network management applications and the NMaaS core components can be installed within a single K8s cluster. For more information please contact the NMaaS Team.

Building and uploading NMaaS Platform Docker image

In order to build the NMaaS Platform Docker image first alter the build_and_publish.sh with custom REPOSITORY, PACKAGE and TAG values and execute build_and_publish.sh to automatically build and publish nmaas-platform image to selected Docker repository.