Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Diagram for Operator Resource Tree #957

Open
mjnagel opened this issue Oct 23, 2024 · 0 comments
Open

Diagram for Operator Resource Tree #957

mjnagel opened this issue Oct 23, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation operator Issues pertaining to the UDS Operator (Pepr)

Comments

@mjnagel
Copy link
Contributor

mjnagel commented Oct 23, 2024

Our operator has significant responsibility in the UDS stack and creates a number of child resources during reconciliation of a Package. We would like to document/diagram visually the resource stack that corresponds with pieces of a Package spec, i.e. a given expose entry will create a virtualservice and serviceentry. This diagram should be created in code ideally, or at least in an easily editable format so that it can be updated in the future when pieces of the Package spec change.

Stylistically it may be helpful to review this diagram from Pepr which has a similar style of drawing connections from the "code" (in our case Package spec) to the effect (in our case created resources).

Definition of done: Diagram of what is produced from the Package reconciliation, mapped visually to the spec of the Package CR.

@mjnagel mjnagel added documentation Improvements or additions to documentation operator Issues pertaining to the UDS Operator (Pepr) labels Oct 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation operator Issues pertaining to the UDS Operator (Pepr)
Projects
None yet
Development

No branches or pull requests

2 participants