VEuPathDB Dataset Installer Service (VDI)

Table of Contents

• Links
  • Compose Stack & Configuration
  • Documentation
  • Schema
• Development
  • Repository Structure
  • Building VDI Components
  • Common Tasks
• License

Links

Compose Stack & Configuration

• https://github.com/VEuPathDB/vdi-compose-stack

Documentation

• HTTP API

• Full Stack Config

• Plugin Config

Schema

JSON schema files for use with editor validation & autocomplete when editing configuration files.

• Service Stack Configuration Schema

• Plugin-Specific Configuration Schema
  (a subset of the full config schema)

Development

Repository Structure

Component Source

• Gradle Build Conventions

• Shared Components

  • Config File JSON Schema

• Core VDI Service Components

  • REST Service

  • Dataset Processing Lanes

  • Background Processes

  • App DB Queries

  • Reconciler Core

• VDI Plugin Handler Server

• Internal Cache DB DDL

Building VDI Components

Docker Images

VDI Core Server

make build-image

Internal Cache DB

make build-db

Source Compilation

VDI Core Server

make build-core-server

Regenerate RAML-Based Source

make raml-gen

Plugin Server

make raml-gen

Common Tasks

Release a New Version

The core service and plugin server are versioned together, however they are presently built differently.

Plugin Server

When pushing up a new git tag, a GitHub workflow will automatically be triggered to build and release the plugin server. That workflow will then open pull requests on each of the individual plugin repositories to update their copies of the server to the newest version.

Core Server

The core server docker image build and push to DockerHub is handled in Jenkins.

Update Dependencies

Dependency version updates are automatically suggested once per week by GitHub’s Dependabot, however if manual updates are needed, the JVM dependencies for the full stack are declared in the dependency catalog.
(ref Gradle Version Catalogs)

License

Copyright 2020 VEuPathDB

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.