StackV / oscars

MIT License
0 stars 0 forks source link

OSCARS

Synopsis

Short for On-demand Secure Circuits and Advance Reservation System, OSCARS is a freely available open-source product. As developed by the Department of Energy’s high-performance science network ESnet, OSCARS was designed by network engineers who specialize in supporting the U.S. national laboratory system and its data-intensive collaborations.

This project is a complete redesign of the original OSCARS to improve performance and maintainability.

Project Structure

The new OSCARS is a Spring Boot application, made up of three major components:

The main project directory is structured as follows:

bin

Contains script(s) for running and maintaining OSCARS.

doc

Auto-generated documentation; use ./bin/generatedocs.sh at the top-level distribution directory to update. You will need a working installation of javasphinx.

backend

The main application. Handles reservation requests, determines which path (if any) is available to satisfy the request, and reserves the network resources. Key modules include:

frontend

This is a node.js application. The backend module pulls this in as a dependency and serves out the packaged web UI javascript application.

shared

A collection of shared classes used by both the PSS and backend modules. Mostly Data Transfer Objects (DTOs).

pss

The Path Setup Subsystem. The core sends commands to it, and it generates appropriate config and then commits it to network devices through rancid.

topo

Topology-related scripts and utilities; currently mostly ESnet-specific Python code.

clients

Various clients for the new REST API.

nsi

XML classes for the NSI data types.

migration

Scripts and code for migrating OSCARS 0.6 reservations to 1.0

Development

Release Notes

Release Notes can be accessed here