tvkitchen / countertop

The entry point for developers who want to set up a TV Kitchen.
https://tv.kitchen
GNU Lesser General Public License v3.0
6 stars 2 forks source link

Create the SousChef #30

Closed slifty closed 4 years ago

slifty commented 4 years ago

Task

Description

First off, do we want to actually use this terminology -- so far it has not made its way into code.

Second though, the task is to create the sous chef at least in a skeletal form. It will EVENTUALLY be responsible for:

  1. Loading configurations (recipes)
  2. Accepting new video streams
  3. Registering topics with kafka based on the configuration
  4. Creating the line cooks
  5. Sharing events / data to the event emitter (fine with completely punting on this part though, even in terms of the stubs)

This task will not involve implementing all of this, but it will mean defining at least the stubbed methods and potentially some of the stubbed out supporting classes for it.

Other related parallel stubs might include:

Relevant Resources / Research

None.

Related Issues

Issue #23

slifty commented 4 years ago

We talked through the naming side of this as part of the discussion in #31

Short story is we think that the countertop is a fine name for the broad swath of "where work gets done" but the less legible terms like "Sous Chef" and "Line Cook" are probably best kept out of the code.

They might live on in conversation and maybe even somewhere in documentation, but instead of new SousChef() we would want something like new CoordinationEngine(). This also captures the spirit of "someone should be able to know what a piece of code does without having to understand the entire architecture."

slifty commented 4 years ago

I'm going to close this issue for two reasons:

  1. The sous chef now exists (CountertopCoordinator).
  2. The original scope of this issue is obsolete, since the responsibilities around, for instance, ingestion have evolved.

I'm creating a new issue that actually captures the next step from a development perspective.