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

Page to describe lifecycle of events #689

Closed
Tracked by #770
agardnerIT opened this issue Jan 24, 2023 · 3 comments · Fixed by #1470
Closed
Tracked by #770

Page to describe lifecycle of events #689

agardnerIT opened this issue Jan 24, 2023 · 3 comments · Fixed by #1470
Assignees
Labels
documentation Improvements or additions to documentation stale

Comments

@agardnerIT
Copy link
Contributor

The KLT has a lifecycle of it's own. A page is needed to describe the "flow" of these events.

https://cloud-native.slack.com/archives/C046WBJN3PA/p1674543498592699

@StackScribe StackScribe self-assigned this Feb 2, 2023
@StackScribe StackScribe added the documentation Improvements or additions to documentation label Feb 2, 2023
@StackScribe
Copy link
Contributor

Detailed source from @agardnerIT and Ondrej at https://cloud-native.slack.com/archives/C046WBJN3PA/p1674543498592699

  • List Kubernetes events by phase
  • Give details about what each phase does. I think they each call a specific CRD; the description can link to the reference page for each CRD
  • Show excerpts from logs or whatever a user has to detail the execution as it happened and where they can identify where an error occurred.
  • Explicitly list the k8s events that are not part of this flow

@agardnerIT
Copy link
Contributor Author

Libraries exist to create diagrams as code. For example, to draw the lifecycle described in the Slack thread above, one can do this:

https://play.d2lang.com/?script=rJGxTsQwDIb3PIV1zOkD3ICExO1IsEcmMculjeU4SH17RDMUBEkzdE7s7__91URXuJd38hoBmeMK9gMCcUzrTItOK87RmAdIAj4tSxWRjY8lK4lDZsdCrk44xXzPU-fRZUWlPD0xvwg9bw9v30OvxXuiQAGshdO330SSULjCJcmlFZ4-MRbc-rUg-5f_ULd9wUidM3m_C5pqFuxj_5R_LSiKUujrbU0d4o7NmS65A_h5y5aSfrfxDYMxRpWarwAAAP__&theme=0&sketch=0&layout=dagre&

@github-actions
Copy link
Contributor

github-actions bot commented Aug 2, 2023

This issue has been automatically marked as stale because it has not had recent activity. It will be
closed if no further activity occurs. Thank you for your contributions.

@github-actions github-actions bot added the stale label Aug 2, 2023
@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Aug 10, 2023
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 stale
Projects
Archived in project
2 participants