Website: Issue with k8s.io/docs/tutorials/kubernetes-basics/expose/expose-intro/

[guludo]

This is a Bug Report

Problem:

It looks like the legend of the figure under Services and Labels is wrong - the purple cubes are representing containers whereas the legend refers to them as pods.

Proposed Solution:

My proposal the the legend:

• <circle> Pod
• <purple cube> Container
• <hexagon> Node

Page to Update:
https://kubernetes.io/docs/tutorials/kubernetes-basics/expose/expose-intro/

[thecrudge]

Hi @guludo , I think you make a good argument

/sig docs
/help
/assign
/priority awaiting-more-evidence

[k8s-ci-robot]

@thecrudge:
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:

Hi @guludo , I think you make a good argument

/sig docs
/help
/assign
/priority awaiting-more-evidence

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.

[sftim]

I had a look at this. To me it's clear the purple cubes represent Pods.

How can SIG Docs best make it clear to all readers that:

• these are indeed Pods
• it does not matter whether the Pods for app=B (or indeed app=A) consist of one or several containers
• Kubernetes manages Pods as the principal resource, not containers

?

[guludo]

I think keeping the purple cubes as Pods in that figure makes it inconsistent with the previous figures, where circles represent pods and the cubes represent containers (here for example). Additionally, note that, in the figure, the IP addresses are "attached" to the circles (which makes sense if one thinks of them as pods).

IMHO, consistency is important for a better reading experience...

[thecrudge]

In the example you provided it is explaining what a pod is with regards to containers (teal cube). In this context, Im inclined to agree with Tim that as far as kubernetes is concerned, a pod is the smallest unit of that kubernetes controls, not a container. Which is what the tutorial is concerned with. In this example, you're exposing a service on the pod. If the layer of abstraction you're suggesting were to be added to the tutorial, it may take away from tutorial itself, or cause confusion.

[sftim]

It sounds like it'd be a good idea to talk about Pods and, ideally, use a different symbol for Pods vs containers (not just a different color).

[guludo]

Hm. I think I get your point now, guys.

A reader that is following the tutorials from the beginning is very likely to associate the purple cube with a container, since cubes were used for containers in previous pages. As @sftim suggested, it would be better to use a different symbol for Pods. As a matter of fact, that symbol already exists - the circle.

Thus, one option, to keep the abstraction at the level of Pods, would be removing the cubes from the picture so as to avoid accidental association with containers.

EDIT:
I know the legend makes it clear the cubes are pods in the figure, but I think they are redundant since we already have the pods represented as circles (well, I think so). Additionally, I, as a reader, had the impression that something in the diagram didn't seem right when I looked at the legend (although it wasn't, technically).

[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]

/remove-lifecycle stale

[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.