The test-infra architecture diagram is out of date

[spiffxp]

/kind documentation
/kind bug

I visited https://github.com/spiffxp/test-infra/blob/write-some-docs/docs/architecture.svg and saw an architecture that is wildly out of date, eg:

• has mungegithub
• has tot
• missing boskos
• missing spyglass

I count this as a bug since this diagram is one of the first links in our repo, and it's definitely misleading.

[stevekuznetsov]

:yikes:

[spiffxp]

While this bug is still open, I recommend checking out the SIG Testing Intro presented a KubeCon NA 2018, find video and slides at https://github.com/kubernetes/community/tree/master/sig-testing#presentations. The final diagram is a bit dense so I tried to walk through how we got to the rube goldberg thing we have going on now.

[spiffxp]

/sig testing
/priority important-longterm

[fejta-bot]

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

[fejta-bot]

Stale issues rot after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle rotten

[fejta-bot]

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/close

[k8s-ci-robot]

@fejta-bot: Closing this issue.

In response to this:

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[spiffxp]

/reopen
/remove-lifecycle rotten
/help-wanted

[k8s-ci-robot]

@spiffxp: Reopened this issue.

In response to this:

/reopen
/remove-lifecycle rotten
/help-wanted

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[fejta-bot]

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

[spiffxp]

/remove-lifecycle stale
/help

[k8s-ci-robot]

@spiffxp:
This request has been marked as needing help from a contributor.

Please ensure the request meets the requirements listed here.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-help command.

In response to this:

/remove-lifecycle stale
/help

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[hasheddan]

@spiffxp I'd like to help out here both in creating a new diagram and documenting other parts of the repo. For instance, I was recently looking at the kubekins-e2e image because it is so prevalent across jobs and there is pretty minimal documentation on it and other Docker images used. I wonder what would be a good format for a sort of "Intro to test-infra" guide. This may be outside the scope of this issue, but I wanted to see if you had thoughts on the matter?

[fejta-bot]

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

[fejta-bot]

Stale issues rot after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle rotten

[hh]

/assign @BobyMCbobs

[spiffxp]

Was presented at k8s-infra meeting today. Thank you for picking this up

Good followup: depict the clusters, projects and orgs involved. Service cluster, build clusters, Google.com, kubernetes.io, etc

[pacoxu]

Kubernetes Test Infrastructure (Last updated 2020-03-04)

https://raw.githubusercontent.com/kubernetes/test-infra/master/docs/architecture.svg

2020 -> 2021 😄

[BenTheElder]

this was updated pretty recently, should the follow-up be a follow-up or should we keep tracking here?
if the latter we should update the milestone

[listx]

Velodrome is still in the SVG.

[spiffxp]

/milestone v1.23
What I discussed during the most recent meeting is:

1. there are likely still some stale things (good catch @listx)
2. being able to draw boxes around what lives within google.com and what lives within kubernetes.io would be helpful for wg-k8s-infra

I'll try to clarify 1 since that's a little too vague to be actionable right now

[spiffxp]

I've taken an alternate crack at this over in kubernetes/k8s.io#2635

It doesn't get a much into the mechanics of Prow, but more all of the other things that prow interacts with

[spiffxp]

/assign
I'm not removing help as I could still use plenty of help in suggesting edits and better tools to use to document this stuff

[spiffxp]

I browsed through https://xosh.org/text-to-diagram/ to see if I could find a non-proprietary tool that could accomplish the same sort of thing I did with kubernetes/k8s.io#2635

• Ilograph looks neat, is paid for multiple users though:
  • complex sample: https://app.ilograph.com/demo.ilograph.Ilograph/Request
  • docs: https://www.ilograph.com/docs/
  • pricing: https://www.ilograph.com/pricing.html
• Mermaid doesn't quite do architecture diagrams with icons: https://mermaid-js.github.io/mermaid-live-editor/
• PlantUML does component diagrams with some predefined groups and nesting, and appears to support theming: https://plantuml.com/component-diagram
  • https://www.planttext.com/ seems to be one way to use it
  • Kroki seems like an intermediary but its PlantUML examples are interesting: https://kroki.io/examples.html
• drawthe.net doesn't have gcp icons but seems versatile: http://go.drawthe.net/

[spiffxp]

cc @hh

[MeNsaaH]

@spiffxp have we considered https://github.com/mingrammer/diagrams? Looks great.

[ameukam]

GCP released a new diagramming tool : https://cloud.google.com/blog/topics/developers-practitioners/introducing-google-cloud-architecture-diagramming-tool

[MeNsaaH]

This is heavily bundled with GCP. What of AWS workloads?

[BenTheElder]

This is heavily bundled with GCP. What of AWS workloads?

test-infra runs on GCP (due to https://www.cncf.io/announcements/2020/12/17/cloud-native-computing-foundation-receives-renewed-3-million-cloud-credit-grant-from-google-cloud/), FWIW.

When it isn't reasonable to DIY infra all the way down, we use off the shelf offerings sometimes. Sometimes not often enough 🙃

spiffxp is out for a while right now, I think mostly it would be good to have a rendered result like we have now.

[vatsalparekh]

if this is still relevant, would like to be a part
/assign

[listx]

At least for the Prow components, there is an architecture diagram at https://docs.prow.k8s.io/docs/overview/architecture/.