Skip to content
Snippets Groups Projects

Added new configuration parameters to control bulk user creation process....

34 files
+ 504
336
Compare changes
  • Side-by-side
  • Inline
Files
34
+ 15
15
# NMaaS Platform
# nmaas Platform
### Technologies
@@ -10,48 +10,48 @@
* Flyway
* Kubernetes API client from fabric8
### Running NMaaS Platform on local machine
### 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.
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
### Running nmaas Platform on dedicated server machine
To run the NMaaS Platform on a dedicated machine, perform the following steps:
+ Build the NMaaS Platform with *./gradlew clean build* command project root directory.
To run the nmaas Platform on a 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:
+ 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
### Swagger documentation of the nmaas Platform REST API
NMaaS Platform by default exposes two endpoints documenting the 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
### 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.
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*)
+ 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.
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](mailto:nmaas-team@lists.geant.org).
Loading