Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The Shared Collection Service Bus (SCSB) is a middleware application deployed in AWS. Environment details are listed below:

Environment

Service

URL

Consumer

Purpose

Link

Dockerized

Comments

Notes

SCSB UI

Dev

All

http://

dev-recap.htcinc.com:9090/search

Dev environment

Yes

Meant only for developers to test latest code.

Dev ETL process UI

http://dev-recap.htcinc.com:9094

The UI through which ETL process can be initiated

Yes

To be used to load bib records from MarcXML files.

Dev Solr

http://dev-recap.htcinc.com:8983

Solr Indexes

No

Will be blocked in TST/PROD

Dev Indexing and Matching Algorithm UI

http://dev-recap.htcinc.com:9090/

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

http

<ip address>

SCSB's Graphical User Interface (GUI). Primarily used by the development team for initial deployment and unit testing purposes.

SCSB Swagger

All

http://<ip address:<port>/swagger-ui/index.html

SCSB's REST APIs are exposed through this port. Swagger documentation provides information on API parameters and lets users try the services. Primarily used by the development team for initial deployment and unit testing purposes.

SCSB UI (Test)

All

https://tst-recap.htcinc.com

:9090/search

Test environment

Yes

Meant only for functionals and QA to test latest code.

Test ETL process UI

http

SCSB's Graphical User Interface (GUI). Primarily used by the quality and functional teams for system and functional testing.

SCSB Swagger (Test)

All

https://tst-recap.htcinc.com:

9094

The UI through which ETL process can be initiated

Yes

To be used to load bib records from MarcXML files.

Test Solr

http://tst-recap.htcinc.com:8983

Solr Indexes

No

Will be blocked in TST/PROD

Test Indexing and Matching Algorithm UI

http://tst-recap.htcinc.com:9090/

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

http://qa-recap.htcinc.com

QA environment

Yes

Regression/Automation before production deployment.

Prod

http://recap.htcinc.com

Production environment

Yes

Production.

DevOps

http://devops-recap.htcinc.com

Dev Ops

No

Jenkins, FTP etc..

UAThttp://uat-recap.htcinc.com:9090/searchUAT EnvironmentYesMeant for partners to conduct their User Acceptance Testing.Swagger UI

<Environment>:9094/swagger-ui.html

Example: http://dev

<port>/swagger-ui/index.html

SCSB's REST APIs are exposed through this port. Swagger documentation provides information on API parameters and lets users try the services. Primarily used by the quality and functional teams for system and functional testing.

SCSB UI (UAT)

All

https://uat-recap.htcinc.com

SCSB's Graphical User Interface (GUI). Primarily used by partners to complete User Acceptance Testing

SCSB Swagger (UAT)

All

https://uat-recap.htcinc.com:

9094

<port>/swagger-ui/index.html

The UI through which exposed REST APIs of ReCAP can be viewed and tested.Yes

Meant to help all stake holders to test and use the REST APIs in their respective environments.

...

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".

...

In order to install Docker, please visit https://docs.docker.com and follow the instructions for your Operating System (Mac, Linux, Windows etc..)

...

You need to have a github account before you can do this. The main repo is at https://github.com/ResearchCollectionsAndPreservation/docker.
Once forked, clone the repository onto your local machine by following the steps below;

  1. Create a directory in your file system: mkdir recap-middleware
  2. git clone https://github.com/**username**/docker.git

Once the repository has been downloaded, change into the directory. You will see a folder called docker.

...

  1. docker ps -a
  2. docker ps -aq | xargs docker rm -f

...

  1. docker rmi -f $(docker images -q)

...

  1. docker build -t scsb-dev . - Here scsb-dev is the image name; you can name it whatever you like. The . indicates the current directory where the Dockerfile.

...

  1. docker build -t scsb-etl .

...

  1. docker run -i -t scsb-dev /bin/bash

...

SCSB's REST APIs are exposed through this port. Swagger documentation provides information on API parameters and lets users try the services. Primarily used by partners to complete User Acceptance Testing