Skip to content

Latest commit

 

History

History
100 lines (85 loc) · 4.29 KB

render-ws.md

File metadata and controls

100 lines (85 loc) · 4.29 KB
Raw

Render Web Services

The Render Web Services module provides level 2 REST APIs to persisted collections of tile and transform specifications (see data model). The Render Web Services API documentation identifies the specific supported APIs.

Deployment Architecture

The Render Web Services module is packaged as a Java web application archive (war file) deployed on a Jetty web server/container. It connects to a MongoDB database where tile and transform specifications are persisted (see data model).

The web server and database components can be run on the same machine for small scale processing or evaluation purposes. For large scale processing needs, each component should be deployed on separate machines that are tuned for their specific purpose.

Basic Installation

These installation instructions cover setup of an evaluation instance with a collocated web server and database running on Ubuntu 22.04.

Note: In lieu of running these steps manually, you may prefer to use a Docker deployment instead. Finally, if you'd like to run this exact installation process along with the Render Web Services Example in Docker, you can use this Dockerfile.

1. Install Git and Maven

sudo apt-get install -y git maven

2. Clone the Repository

git clone https://github.com/saalfeldlab/render.git

3. Install JDK and Jetty

# assumes cloned render repository is in ./render
cd ./render
./render-ws/src/main/scripts/install.sh

4. Build the Render Modules

# assumes current directory is still the cloned render repository root (./render)
export JAVA_HOME=`readlink -m ./deploy/*jdk*`
mvn package

5. Deploy Web Service

# assumes current directory is still the cloned render repository root (./render)
cp render-ws/target/render-ws-*.war deploy/jetty_base/webapps/render-ws.war

6. Install MongoDB 6.0.4

These instructions were taken from https://www.mongodb.com/docs/v6.0/tutorial/install-mongodb-on-ubuntu/#install-mongodb-community-edition

# needed for access to https mongodb resources
apt-get install -y apt-transport-https gnupg wget

# steps from https://www.mongodb.com/docs/v6.0/tutorial/install-mongodb-on-ubuntu/#install-mongodb-community-edition
wget -qO - https://www.mongodb.org/static/pgp/server-6.0.asc | sudo apt-key add -
echo "deb [ arch=amd64,arm64 ] https://repo.mongodb.org/apt/ubuntu jammy/mongodb-org/6.0 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-6.0.list
sudo apt-get update

# note: you will be prompted to select a geographic area and city for tzdata
sudo apt-get install -y mongodb-org=6.0.4 mongodb-org-database=6.0.4 mongodb-org-server=6.0.4 mongodb-org-mongos=6.0.4 mongodb-org-tools=6.0.4

echo "mongodb-org hold" | sudo dpkg --set-selections
echo "mongodb-org-database hold" | sudo dpkg --set-selections
echo "mongodb-org-server hold" | sudo dpkg --set-selections
echo "mongodb-mongosh hold" | sudo dpkg --set-selections
echo "mongodb-org-mongos hold" | sudo dpkg --set-selections
echo "mongodb-org-tools hold" | sudo dpkg --set-selections

# Create systemd service file
# NOTE: This file has to be named mongodb.service (instead of mongod.service) for some reason
sudo curl -o /lib/systemd/system/mongodb.service "https://raw.githubusercontent.com/mongodb/mongo/v6.0/rpm/mongod.service"

7. Start MongoDB

# NOTE: The service has to be mongodb (instead of mongod) for some reason.
sudo service mongodb start

8. Start Jetty

# assumes current directory is still the cloned render repository root (./render)
deploy/jetty_base/jetty_wrapper.sh start

Using the Installation

The Render Web Services Example workflow steps demonstrate how this installation can be used for a small example project.