...
See also: Overview for a new developer and Newcomer's first steps
FOLIO Design & Architecture
- Okapi : Gateway/Discovery service and Security model - https://wiki.folio.org/display/~vijay/FOLIO+-+Developer+Onboarding+Guide#FOLIODeveloperOnboardingGuide-Design&Architecture
- RMB framework : Core module for all Vertx based modules - https://github.com/folio-org/raml-module-builder#overview
...
The mod-invoice and mod-invoice-storage modules are not included in the testing VagrantBox VMs, so it's easier to practice deployment with these modules:
Download Postman collection collections with all necessary requests or create it by yourself. The storage module should be deployed before the business one: mod-invoice-storage and then mod-invoice.
Deployment collections :
Here is a zip with all the Postman collections to deploy modules.
Deployment Steps
- On Linux, use this first:
sudo ifconfig lo:1 10.0.2.15 upsudo ifconfig lo:0 10.0.2.2 up Assign “okapi.all” permission for diku_admin
Login
Build mod-invoice-storage module : mvn clean install. As a result target/ModuleDescriptor.json is created, which will be used as deployment descriptor for your microservice.
Copy ModuleDescriptor.json into body of “POST Module Descriptor” and run request
Run module from IDEA
Let OKAPI (Api Getway and discovery server) know were is your microservice by send request
Important:“srvcId” and “id” from deployment descriptor must be the same
Port in “url” must be the same with port from IDEA configuration “-Dhttp.port=8097”
Make the microservice accessible from the outside and allow access to it
If everythigs fine – start using APIs
...
If a module was already deployed and a new version needs to be tested for integration tests, it is not necessary to remove the old version: simply add .xxx to the id in the descriptor, with a number higher than the currently deployed one, and the karate tests will automatically use the latest version.
...