canonical / bundle-kubeflow

Charmed Kubeflow
Apache License 2.0
104 stars 50 forks source link

Create a spec for the high level architecture of the Profiles Automator charm #1143

Open kimwnasptd opened 1 week ago

kimwnasptd commented 1 week ago

Context

This is sub-step for https://github.com/canonical/bundle-kubeflow/issues/1142

We'll need to have a spec that will document the design decisions and architecture of how to create the Profile Automator charm. The ongoing spec is KF107.

The architectural parts that will need more attention are:

  1. If we should have a dedicated Profile Automator, and multiple source-integration charms
  2. What the common code/library should be doing
    1. Should it be abstracting the logic of creating Profiles?
    2. Should it be abstracting the logic for representing profiles?

The goal of this is once we have the spec we can then start working on any common code needed and the charms that will take care of updating the Profiles from a GH repo source.

What needs to get done

  1. Write down pros/cons of having github-profiles-automator charm vs github-automator + github-profiles-ir charms
  2. Write down what the common library should be doing in both cases, with step by step examples
  3. Have a sync and make the decision on the final architecture, based on the guidance of the decision maker
  4. Update the spec

Definition of Done

  1. The spec is approved
  2. We can start working on the logic for both the GitHub source logic and the Profiles Automator
syncronize-issues-to-jira[bot] commented 1 week ago

Thank you for reporting us your feedback!

The internal ticket has been created: https://warthogs.atlassian.net/browse/KF-6532.

This message was autogenerated