Logo

Contents:

  • Project Introduction
  • Tutorials
  • Contribution Guidelines
  • Architecture Documentation
    • Architecture Overview
    • Project Structure
    • API Documentation
    • Authentication
    • Database Documentation
    • Architectural Decision Log
  • Pilot and Transpilemanager Documentation
  • Cli Documentation of the Flask app
  • qunicorn_core package
  • Glossary
  • Changelog
  • Disclaimer
qunicorn_core
  • Architecture Documentation
  • View page source

Architecture Documentation

Contents:

  • Architecture Overview
    • Vision
    • Component Overview and Interactions
    • Domain model
    • Sequence Diagram for Creating a Deployment
    • Sequence Diagram for Creating a Job from a Deployment
  • Project Structure
    • Structure of the project
  • API Documentation
    • Generated Documentation
    • Available Endpoints
  • Authentication
    • Start Keycloak
    • Create a User
    • Get an Authentication Token
    • Start Qunicorn
  • Database Documentation
    • Domain model
    • Detailed model description
  • Architectural Decision Log
    • 1. Template
    • 2. Use Markdown Architectural Decision Records
    • 3. Restructuring of Qunicorn Project
    • 4. Update Python Version to 3.11.0
    • 5. REST Decisions
    • 6. How to Map Dtos to Database Objects and wise versa
    • 7. Introducing the transpile manager
    • 8. Refactoring of the pilots
    • 9. How to mark unused code
    • 10. Job Results
    • 11. Result Types of Jobs
Previous Next

© Copyright 2023, Arne Bartenbach, Gabriel Bonnet, Daniel Georg, Nora Hengst, Lukas Januschke, Maximilian Kuhn, Fadil Furkan Lokman, Julian Obst, Christoph Walcher, Vladimir Yussupov.

Built with Sphinx using a theme provided by Read the Docs.