EOSC Node Registry (demo)

This repository contains the source code for a demonstration version of the EOSC Node Registry. See the EOSC Node Registry Architecture document for further details.

Prerequisites

Java 21 or greater is required to build and run this application.

Quick Start

1. Check prerequisites and install any required software.
2. Clone the repository to your local workspace.
3. Build the application using mvn clean verify.
4. Run the application using the following command: mvn exec:java.

Getting Started

To compile this application, run:

bash mvn install

This will create a WAR suitable for deploying on Java Application servers (e.g. Tomcat, Jetty...).

To compile and run this application locally run:

bash mvn jetty:run

The application will run locally at http://localhost:8080/.

Docker

To create a Docker image, run:

bash mvn install jib:dockerBuild -Dimage=IMAGE_TAG

Substitute IMAGE_TAG for a desired image tag. The application can then be run using docker run -p 8080:8080 IMAGE_TAG and will be hosted on http://localhost:8080/.

Options

To set url environment variable for nodedRegistry component:

bash export NODEREGISTRY_URL="http://localhost:1336"

Project Structure

This project uses the standard Maven project structure.

``` text

├── .mvn # Maven wrapper. ├── src # Contains all source code and assets for the application. | ├── main | | ├── java # Contains release source code of the application. | | └── resources # Contains release resources assets. | └── wepapp # Contains home page. | └── test | ├── java # Contains test source code. | └── resources # Contains test resource assets. └── target # The output directory for the build. ```

Technology Stack

Several frameworks are used in this application.

| Framework/Technology | Description | | -------------------------------------------------- | --------------------------------------------------------- | | Spring-boot | Use to create Spring-powered, production-grade applications and services | | com.h2database | Java SQL database | | org.apache.logging.log4j | Java logging framework | | Springdoc-openapi | Helps with automating the generation of API documentation using Spring Boot projects | | junit-jupiter-api | Java unit testing framework | | Gson | Java library used to convert Java Objects and/or Strings into their JSON representation | | Apache HttpComponents client | Http client | | com.google.cloud.tools | Use for building Docker and OCI images for Java applications | | org.sonarsource.scanner.maven | SonarQube scanner for Maven| | com.mycila | Checks that each source file has licence header | | org.jacoco | Java code coverage library | | org.apache.maven.plugins | Executes the unit tests of a Maven application or project |

Configuration

The initial list of nodes (and their attributes) is configured using nodes.cvs.

``` text Each line contains the details of a single node as a set of blocks.ttp client Each block is separated using a comma. Lists of items within a block are separate using a semicolon. The order of blocks is * node ID * node name * logo URI * PID URI * legal entity [Legal Entity Name;Legal Entity ROR ID] * capabilities - list of triples separated by a semicolon - [capability name;capability endpoint URI; capability version]

For example 1,CESSDA Node,https://example.com/cessdalogo.png,hdl:20.500.12345/cessda [CESSDA ERIC;https://cessda.eu/RORID], https://cessda.eu/api,[Service Monitoring;https://example.com/api/service-monitoring;1.2]; [Resource Catalogue;https://example.com/api/resource-catalogue;3.0]; [Management System (including Helpdesk);https://example.com/api/management-system;1.3] ```

Resources

Issue Tracker

Swagger API docs

Running Swagger tests

• for Search for node by ID, use any value between 1 to 10 inclusive
• for Search for nodes by capability, use one of
  • Resource Catalogue
  • Identity Management
  • Application Workflow Management
  • Service Monitoring
  • Service Accounting
  • Order Management
  • Management System (including Helpdesk)