Components overview - softgitron/potku-console GitHub Wiki

A brief overview of the scope for each seperate module. All communication between the modules will be done through the core using its standardized API interface. More detailed technical documentation will be found in dedicated files for each component as the planning progresses.

Core module

  • Facilitates communication between the modules
  • Handles (almost) the whole state of the application
  • Handles database access and general permission checks
  • Processes commands from internal the IPC API

REST API module

  • Custom component that handles REST calls
  • Acts as a buffer between the internet and the core
  • Translates the recieved data into the standard core API format

Cloud modules

  • Responsible for communicating with the cloud provider (provision service) specific APIs
  • Each module is dedicated to a specific cloud provider's infrastructure
  • Controls the remote VM's / container's startup, shutdown and configuration

Service modules

  • Controls the server software inside the remote VM / container
  • Each instance is dedicated to a specific type of service (game server, http server, etc.)
  • Components are stateless and query their state from the core
  • Listens for and responds to communications from the (game) clients and (game) servers
⚠️ **GitHub.com Fallback** ⚠️