drsybren/Flamenco
1
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases Wiki Activity
8e05024267
Flamenco/FEATURES.md

2.6 KiB
Raw Blame History

Flamenco-NG Features

This file lists the features that ought to be implemented at some point in time. It will likely be expanded over time while forgotten features of Flamenco v2 are rediscovered.

Note that list is not in any specific order.

Manager

  • OpenAPI implementation that actually runs as a server process
  • Process lifecycle management, clean shutdown
  • Task Scheduler
  • Unify command definition (type/parameters in persistence layer, name/settings in API layer)
  • Job status change handling
  • Port the old 'fail-requested' task status handling code to the new Manager
  • Task timeout monitoring
  • Worker Blacklisting & failed task requeueing
  • Worker timeout monitoring
  • Worker-assigned task re-queueing on sign-off
  • Variable replacement
  • Configuration file reading
  • Configuration provisioning support
  • Shaman integration
  • Worker sleep schedule
  • Web frontend for Worker management
  • Web frontend for Job & Task management
  • Web frontend for configuration management
  • Frontend authentication
  • Worker API authentication
  • User/Job Submission API authentication
  • Last rendered image display
  • Per-job last rendered image
  • Auto-removal of old Workers
  • Shaman/Job settings: Distinction between "can be auto-deleted" jobs and "must be kept around" jobs.
  • Sending data upstream to Flamenco Overwatch
  • Job archival / task cleanup

Worker

  • OpenAPI client that actually runs as a process
  • Process lifecycle management, clean shutdown
  • Task executor
  • Command runner
  • Log uploader
  • POSIX signal handling (sleep/wake up)

Both

  • Worker registration & auto-reregistration
  • Worker API authentication
  • Worker sign on/off
  • Worker status change management, including lazy status changes
  • Task status change handling
  • Worker test mode
  • Worker registration secret (to protect the Manager from arbitrary Workers registering)
  • SSDP/UPnP for automatic Manager finding

Blender Add-on

  • Communication with the Flamenco Manager API
  • Job construction
  • BAT-packing & uploading to Shaman
  • User authentication

Nice to have / new features

  • Notification system to push "job done" messages to. Ideally would be in a form/shape that allows sending a message to Rocket.Chat, Matrix, Telegram, Discord, email, webbrowser, push URL-encoded/JSON/XML to some URL, stuff like that. Idea by Dan McLaughlin.
  • Notification client inside Blender itself, so that you get a message when your job is done.