Internal Errigal Collaboration Wiki

User Tools

Site Tools

Trace: • mdc • support_request • proxy
onboarding:proxy:start

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
onboarding:proxy:start [2022/10/03 10:49] – 10.91.110.100onboarding:proxy:start [2022/11/01 20:11] (current) – [Overview] 10.91.110.4
Line 1: Line 1:
 ====== IDMS PROXY  Development Details ====== ====== IDMS PROXY  Development Details ======
-Updated by Anna Dowling 10/11/2020+Updated by Anna Dowling 03/10/2022
    
   * See also: [[onboarding:mobile:start|IDMS Mobile (Mobile Navigator)]]   * See also: [[onboarding:mobile:start|IDMS Mobile (Mobile Navigator)]]
   * See also: [[onboarding:nova:start|EMS Nova (EMS Nova)]]   * See also: [[onboarding:nova:start|EMS Nova (EMS Nova)]]
 +  * See also: [[development:applications:ticketer_lite|Ticketer Lite (Ticketer Lite)]]
  
 ===== Overview ===== ===== Overview =====
  
-The idms proxy application is utilised as a api gateway for the mobile navigator application(idms-mobile) and mes-nova. It provides data integration points for device, alarm, ticket and discovered data within Errigal's network access. Currently this is a service oriented application with little front end capabilities apart from its status check page. +The idms proxy application is utilised as a api gateway for the mobile navigator application(idms-mobile) and ems-nova. It provides data integration points for device, alarm, ticket and discovered data within Errigal's network access. Currently this is a service oriented application with little front end capabilities apart from its status check page. 
  
  
Line 18: Line 19:
   * http://localhost:8099/idms-proxy/api/v0   * http://localhost:8099/idms-proxy/api/v0
   * http://localhost:8099/idms-proxy/status (status health page)   * http://localhost:8099/idms-proxy/status (status health page)
 +  * http://localhost:8099/idms-proxy/api-docs.yaml
 +  * http://localhost:8099/idms-proxy/api-docs
 +  * http://localhost:8099/idms-proxy/swagger-ui.html
  
 ===== Project Documents ===== ===== Project Documents =====
Line 38: Line 42:
   * Ticket data - Ticketer   * Ticket data - Ticketer
   * IDMS Database   * IDMS Database
-  * Nova Data: Elastic Search+  * Nova Data: Elastic Search (populated using elastic replicator application) 
 +  * SSE events for nova front end.
  
 ===== Architecture ===== ===== Architecture =====
-{{ :onboarding:proxy:idms_mobile_architecture.png?600 |}}+{{ :onboarding:proxy:idms_proxy_architecture.drawio.png?600 |}} 
 + 
 +  * DRAW IO Link to diagram: https://app.diagrams.net/#G1vi_8w7F2sZgi673qMcR_zscc5_N1sHFn 
 ===== Development Configuration ===== ===== Development Configuration =====
 Project can be pointed at local or server deployed version of all api endpoints listed above.  Project can be pointed at local or server deployed version of all api endpoints listed above. 
Line 47: Line 55:
  
 ===== API Testing =====  ===== API Testing ===== 
-For api testing either [idms-mobile](https://bitbucket.org/errigal/idms-mobile/src) or [postman](https://www.postman.com/) can be utilised.+For api testing either [idms-mobile](https://bitbucket.org/errigal/idms-mobile/src) or [postman](https://www.postman.com/) can be utilised. All apis are documented using open-api with swagger, see details below on how to access: 
 + 
 +==== OPEN API Documentation ==== 
 + 
 +To view the api docs using open-api run the app locally and hit the following link: 
 + 
 +  * http://localhost:8099/idms-proxy/swagger-ui.html 
 + 
 +Docs can be generated in yaml or json using the following links: 
 + 
 +  * Yaml: http://localhost:8099/idms-proxy/api-docs.yaml 
 +  * Json: http://localhost:8099/idms-proxy/api-docs 
 + 
 +A pdf generator can be used to output the pdf of the api docs if required: https://www.swdoc.org/ 
 +Reference:  
 + 
 +  * [Open-API SpringBoot tutorial](https://www.baeldung.com/spring-rest-openapi-documentation)
  
 ===== Proxy Status ===== ===== Proxy Status =====
Line 196: Line 220:
 === Ansible Playbooks === === Ansible Playbooks ===
 <code> <code>
-ansible-playbook -i ../env-configuration/ENV/hosts.ini --diff idms-proxy.yml --ask-vault-pass --extra-vars "jenkins_build_name='idms-proxy-feature-branches/job/BRANCH' appFileExtension='.jar' jenkins_job_build_num=NUMBER actions='upload,stop,deploy,configure,start'" + ansible-playbook -i ../env-configuration/nova/hosts.ini --diff --vault-id @prompt idms-proxy.yml --extra-vars "jenkins_build_name='idms-proxy-feature-branches/job/jobName' appFileExtension='.jar' jenkins_job_build_num=buildNumber actions='upload,stop,deploy,configure,start'" 
- +
-ansible-playbook -i ../env-configuration/ENV/hosts --diff --vault-id @prompt restart-idms-proxy.yml  +
- +
-ansible-playbook -i ../env-configuration/ENV/hosts --diff --vault-id @prompt shutdown-idms-proxy.yml +
- +
-ansible-playbook -i ../env-configuration/ENV/hosts --diff --vault-id @prompt startup-idms-proxy.yml  +
 </code> </code>
  
 === Jenkins Build === === Jenkins Build ===
-http://jenkins.errigal.com:8080/job/idms-proxy/+https://jenkins.errigal.com:8443/job/idms-proxy/
onboarding/proxy/start.1664790544.txt.gz · Last modified: 2022/10/03 10:49 by 10.91.110.100

Page Tools

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki