Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 11 Next »

Environments

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

ServiceConsumerLinkComments
SCSB UI (Dev)Allhttp://192.168.55.198:9091SCSB's Graphical User Interface (GUI). Primarily used by the development team for initial deployment and unit testing purposes.
SCSB Swagger (Dev)Allhttp://192.168.55.198:9093/swagger-ui.htmlSCSB'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)Allhttps://tst-recap.htcinc.comSCSB's Graphical User Interface (GUI). Primarily used by the quality and functional teams for system and functional testing.
SCSB Swagger (Test)Allhttps://tst-recap.htcinc.com:9093/swagger-ui.htmlSCSB'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)Allhttp://uat-recap.htcinc.com:9091SCSB's Graphical User Interface (GUI). Primarily used by partners to complete User Acceptance Testing
SCSB Swagger (UAT)Allhttp://uat-recap.htcinc.com:9093/swagger-ui.htmlSCSB'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

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


Docker


Installation

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


Getting Started


Fork ReCAP SCSB Repository

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. cd docker
  2. cd dockerfile
  3. Run the following command to check if any existing containers are runnning and if so, stop and remove them
    1. docker ps -a
    2. docker ps -aq | xargs docker rm -f
  4. Deleting images
    1. docker rmi -f $(docker images -q)
  5. Building Dev Container Image from the Dockerfile
    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.
  6. Building ETL Container image
    1. docker build -t scsb-etl .
  7. Running the Dev Container
    1. docker run -i -t scsb-dev /bin/bash
  8. Running the ETL Container
    1. docker run -i -t scsb-etl /bin/bash
  • No labels