Standardizing Kubernetes Architectural Diagrams - a.k.a Diagram Creation Guide

[dkypuros]

Summary of Feature Request
Kubernetes documentation needs better diagrams. We need a standard set of Kubernetes icons and clear guidelines for content creators to make their own architectural diagrams.

Brief Overview of Project
During a K8s SIG-Docs meeting (November 2019), several SIG Docs members commented on the lack of consistency between Kubernetes icons and diagrams on the official Kubernetes Docs website (see “What is Kubernetes”, and “Kubernetes Components”).

Do you want to help?
Are you interested in helping? Can you join a Zoom call to talk through the effort and help build some icons? Feel free to message me on slack @david.kypuros. We're not ready for a PR, just looking for people to assist with this mini-project.

Please Review for more background

• Kubernetes SIG-DOCS SoW - Kubernetes Architecture Diagrams & Icons

• Istio Example for good direction

[dkypuros]

/assign @dkypuros

[dkypuros]

Artwork Reference (commenting enabled):

Kubernetes Architectural Diagram Guide - Draft v1

Icons Kubernetes Architectural Diagram Guide - Draft v1

Istio-Diagram-Guide - Inspiration from CNCF Friends

[Fale]

Hi,
This is a very interesting topic for me, so thanks for your work!

0. The kube-controller-manager icon is not very clear for me.
1. There are 2 different icons for kube-controller-manager, but I think one of the two should be called clud-controller-manager. I think that both icons are not very clear, as for 0.
2. In Icons Kubernetes Architectural Diagram Guide there alignment problems in the bottom right area
3. The istio-diagram-guide seems to have some access restrictions. Can those be lifted?

Thanks again for the great work :-)

[dkypuros]

Hi,
This is a very interesting topic for me, so thanks for your work!

1. The kube-controller-manager icon is not very clear for me.
2. There are c for kube-controller-manager, but I think one of the two should be called clud-controller-manager. I think that both icons are not very clear, as for 0.
3. In Icons Kubernetes Architectural Diagram Guide there alignment problems in the bottom right area
4. The istio-diagram-guide seems to have some access restrictions. Can those be lifted?

Thanks again for the great work :-)

Awesome feedback!

1. Fixed it. Still not 100% happy with my funky "controller" icons though :-) I welcome any graphical help. All I could think of was "Atari Controllers" ;-)

2. Fixed the "2 different icons". Agree, those two icons aren't clear.

3. Fixed.

4. To get access requires a few steps. I just copied the google draw file, and dropped it here docs.google.com/drawings...

PS
Fale: Ping me on slack if you want edit access. I hang out in the SIG-DOCS channel.

[celestehorgan]

I don't have real feedback for you yet, but wanted to bring up that this section exists in the k8s community repo.

[dkypuros]

I don't have real feedback for you yet, but wanted to bring up that this section exists in the k8s community repo.

I'm taking a closer look at this section...

[tengqm]

/language en

[sftim]

A similar issue: #21763

[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

[sftim]

Still very valuable IMO
/remove-lifecycle stale

[sftim]

If we add this, let's have https://www.kubernetes.dev/docs/ link to it.

[sftim]

/triage accepted

[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-contributor-experience at kubernetes/community.
/lifecycle rotten

[sftim]

/remove-lifecycle rotten
/lifecycle frozen

[mehabhalodiya]

@dkypuros I don't see any updates; so unassigning you. Please feel free to assign, if you come back here again and are willing to work on 🙂
/unassign @dkypuros

[dkypuros]

Thanks. I'll consider it.

…

On Sat, Jan 21, 2023 at 6:12 AM Meha Bhalodiya ***@***.***> wrote: @dkypuros <https://github.com/dkypuros> I don't see any updates; so unassigning you. Please feel free to assign, if you come back here again and are willing to work on 🙂 /unassign @dkypuros <https://github.com/dkypuros> — Reply to this email directly, view it on GitHub <#19811 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AACY2UBQLICWSMFNVZEB5V3WTPHBXANCNFSM4LSCKNTA> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[k8s-triage-robot]

This issue has not been updated in over 1 year, and should be re-triaged.

You can:

• Confirm that this issue is still relevant with /triage accepted (org members only)
• Close this issue with /close

For more details on the triage process, see https://www.kubernetes.dev/docs/guide/issue-triage/

/remove-triage accepted

[divya-mohan0209]

This is still relevant IMO
/triage accepted

[sftim]

We have a diagram guide

/close
as complete

[k8s-ci-robot]

@sftim: Closing this issue.

In response to this:

We have a diagram guide

/close
as complete

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-sigs/prow repository.