General To-Do List

[scott-taubman]

This is an ever changing list of things that need to happen to reach 1.0 (or whatever we call the initial release). This is not intended to be persistent list. Completed items may be cleared off from time to time. It's just intended to be a place to record things that have to happen as we think of them.

Must Haves

These are to be considered the hard requirements.

General

• Look and Feel
  • Switch to a better supported CSS component library #201
  • Rework environment switching and accessing management pages
  • Initial landing page (the "Hello User" page)
• View tasking by workflow run (unify "tasks" and "workflow runs"?)
• Support for file parameters
  • File parameters #144
  • Improve File Upload Error Handling #204
  • Add file parameter support to the API #213
  • Update scheduled task UI to properly handle file parameters #220
• Settings / Config
  • Auth Provider Administration #154
  • Create internal help docs to link to instead of the allauth docs
  • Create provider specific validators so that we can report errors in the provider json
  • Move S3 related settings to constance and the admin pages #217
• Centralize table rendering logic #197
• Add filtering support to the list views #146
• Workflows
  • Workflow Execution via the UI #268
  • WorkflowRun parameter validation
  • Rework step function selection
• Scheduled Tasks
  • Adapt scheduled tasks to work with workflows #234
  • Rework ScheduledTask function selection #235
• Deployment Readiness #139

CLI

• Cleanup package tarball #179
• Add package change confirmation to publish CLI command #190

Known Bugs

• Accessing the UI before any environments exist throws an error.
• python: date and datetime types are passed to the function as strings rather than their correct types.
• Functions without parameters cannot be scheduled #196

Tech Debt

• Documentation
• More Unit and integration tests
• More robust handling of external connections (e.g. exception handling for redis and rabbitmq)
• More robust exception handling in general
  • Builder should record errors on any exceptions thrown #206

Bonus Features

These are not must-haves, but if we find ourselves with time to spare these would be nice to have

• User onboarding (walk a user through creating an account and a team)
• Private runners
  • Runner registration #83
  • Runner tagging for restricting tasks to certain runners
• Refine (or remove?) /users endpoint response (public vs private, remove unwanted fields)
• Deal with additional parameters in tasking (parameters not present in the function schema)

Future Roadmap

Placeholder section for features that we may want to throw on a future roadmap

Features

• Runners that are not dependent on docker-in-docker (kubernetes, ecs, etc. native)
• Task parameter secrets (individual task parameters that won't be stored or echoed back)
• Provide a more scalable solution for results and log storage (Log streaming solution #255).

Tech Debt

• Refactor listener code to be reusable between runner and django app
• Improve re-use of permission / queryset filtering logic between api and ui views