...
The Shared Collection Service Bus (SCSB) is a middleware application deployed in AWS. Environment details are listed below:
Environment
URL
Purpose
Dockerized
Notes
Dev
Dev environment
Yes
Meant only for developers to test latest code.
Dev ETL process UI
The UI through which ETL process can be initiated
Yes
To be used to load bib records from MarcXML files.
Dev Solr
Solr Indexes
No
Will be blocked in TST/PROD
Dev Indexing and Matching Algorithm UI
The UI through which the Solr indexing and matching algorithm processes can be initiated.
Yes
To be used to index records and generate matching algorithm reports.
Test
Test environment
Yes
Meant only for functionals and QA to test latest code.
Test ETL process UI
The UI through which ETL process can be initiated
Yes
To be used to load bib records from MarcXML files.
Test Solr
Solr Indexes
No
Will be blocked in TST/PROD
Test Indexing and Matching Algorithm UI
The UI through which the Solr indexing and matching algorithm processes can be initiated.
Yes
To be used to index records and generate matching algorithm reports.
Pre-Prod
QA environment
Yes
Regression/Automation before production deployment.
Prod
Production environment
Yes
Production.
DevOps
Dev Ops
No
Jenkins, FTP etc..
| Service | Consumer | Link | Comments |
|---|---|---|---|
| SCSB UI | All | <environment>:9091 | SCSB's Graphical User Interface (GUI). |
| SCSB Swagger | All | <environment>:9093 | SCSB's REST APIs are exposed through this port. Swagger documentation provides information on API parameters and lets users try the services. |
| SCSB ActiveMQ Queue | All | <environment>:61616 | External applications using SCSB's services can listen in here for responses from deferred services. |
| SCSB ETL | Development Team | <environment>:9094 | SCSB's ETL process to load bibliographic records for initital accession. |
| SCSB Solr Server | Development Team | <environment>:8983 | SCSB's Solr Server's dashboard. |
| SCSB Solr Admin | Development Team | <environment>:9090 | SCSB's Solr Admin user interface. Also allows generating reports and running the Matching Algorithm process. |
| SCSB ActiveMQ Admin | Development Team | <environment>:8161 | SCSB's ActiveMQ administrator dashboard |
| HTC CAS | Internal | <environment>:8080 | The Central Authentication Service (CAS) of HTC is hosted here. |
| SCSB Shiro | Internal | <environment>:9092 | Internal Project |
| SCSB Circ | Internal | <environment>:9095 | Internal Project |
where, <environment> is
- http://192.168.55.198 - Dev Environment, used by the development team for initial deployment and unit testing purposes
- https://tst-recap.htcinc.com - Test Environment, used by the quality and functional teams for running system and functional testing.
- http://uat-recap.htcinc.com
...
<Environment>:9094/swagger-ui.html
Example: http://dev-recap.htcinc.com:9094/swagger-ui.html
...
- - UAT Environment, used by partners to complete User Acceptance Testing
Development Environment
The first thing a developer will need to do is to setup the development environment. It is common for developers to be working in different environments (Windows, Linux, Mac OS etc..) especially on open source projects and distributed teams. In order to set up a development environment which typically would involve installing softwares like Java, MySQL, tomcat, PHP etc, it can take up anywhere from hours to days depending on what all is required.
To minimize the effort and to ensure every developer is working with the same software versions (i.e development environment), we are going to use Docker Containers to install the "ReCAP Dev Environment".
...