search

defenseunicorns / uds-core

A FOSS secure runtime platform for mission-critical capabilities
https://uds.defenseunicorns.com
GNU Affero General Public License v3.0
52 stars 21 forks source link

Update diagram for operator flow #958

Open mjnagel opened 1 month ago

mjnagel commented 1 month ago

We currently have an out of date flow diagram for the operator/package CR reconciliation. This should be updated to reflect the current state of the operator (noticeable pieces missing are monitoring and sso). It should also be moved somewhere inside of the docs/ folder to ensure it is present in the docs site as a reference. When updating and moving to the docs site we will want to ensure it is still created using code and presents/renders well on the documentation site (at a glance it may require some extra work to get Mermaid supported on Starlight/Astro, or switch to a different diagram tool for creation).

Definition of done: Operator flow diagram includes all current operator reconciliation steps and is rendered on the docs site.

mjnagel commented 1 month ago

We may also want to consider how this interacts/could be combined with https://github.com/defenseunicorns/uds-core/issues/957, but would want to ensure it doesn't get too messy.