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

Duplicated examples about ConfigMaps as volume mounts #45847

Open
skoenig opened this issue Apr 12, 2024 · 9 comments · May be fixed by #46364
Open

Duplicated examples about ConfigMaps as volume mounts #45847

skoenig opened this issue Apr 12, 2024 · 9 comments · May be fixed by #46364
Assignees
Labels
language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@skoenig
Copy link

skoenig commented Apr 12, 2024

The section at https://kubernetes.io/docs/concepts/configuration/configmap/#using-configmaps-as-files-from-a-pod describes how ConfigMaps can be used in as files from a volume. This is already explained with a more complete example of how ConfigMaps can be used in the section before https://kubernetes.io/docs/concepts/configuration/configmap/#configmaps-and-pods (not sure which section was included earlier).
This duplication makes this documentation page appear repetitive and a bit incoherent.

/language en

@k8s-ci-robot k8s-ci-robot added language/en Issues or PRs related to English language needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Apr 12, 2024
@tamilselvan1102
Copy link
Contributor

configmaps-and-pods
explaining well enough sample about to configmap.

using-configmaps-as-files-from-a-pod
explaining spec.volumes level fields

@tamilselvan1102
Copy link
Contributor

it would be good if both are in a section

@tamilselvan1102
Copy link
Contributor

/sig doc

@k8s-ci-robot
Copy link
Contributor

@tamilselvan1102: The label(s) sig/doc cannot be applied, because the repository doesn't have them.

In response to this:

/sig doc

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
Copy link
Contributor

sftim commented Apr 14, 2024

/sig docs
/triage accepted

@k8s-ci-robot k8s-ci-robot added sig/docs Categorizes an issue or PR as relevant to SIG Docs. triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Apr 14, 2024
@pegasas
Copy link
Contributor

pegasas commented Apr 24, 2024

/assign @pegasas

@pegasas
Copy link
Contributor

pegasas commented May 3, 2024

Hi, all,

After seeing this issue carefully, I found this issue is not duplicate.

For configmaps-and-pods explains we can use multiple file in ONE configmap and may be mount in the near future.
For using-configmaps-as-files-from-a-pod explains how configmap are mount to pod/deployment and etc.

In fact it is on different aspects of configmap.
It is both significant in k8s yaml development.

@skoenig
Copy link
Author

skoenig commented May 4, 2024

Thanks for your assessment @pegasas, but I do not know exactly what you meant by "[...] and may be mount in the near future." Can you please elaborate on that?

I agree that it is important to demonstrate different use cases of ConfigMaps. But maybe it would be better educational to explain the ConfigMap object in the first section ConfigMaps and Pods and in the following sections under Using ConfigMaps to show more specifically how this ConfigMap object can be used in different ways. So in addition to the existing sections:

  • Using ConfigMaps as files from a Pod
  • Using ConfigMaps as environment variables

the following could be listed:

  • Using Configmaps as commands and args
  • Using ConfigMaps via the Kubernetes API

All sections could refer to the example ConfigMap listed under ConfigMaps and Pods. This would make this page clear and consistent.

@pegasas
Copy link
Contributor

pegasas commented May 6, 2024

Thanks for your assessment @pegasas, but I do not know exactly what you meant by "[...] and may be mount in the near future." Can you please elaborate on that?

It descripe such a scenario, which is multiple file in one configmap, like core-site.xml and hdfs-site.xml, and mount into hadoop to deploy on k8s. this is common scenario on for configmaps-and-pods.

the following could be listed:

  • Using Configmaps as commands and args
  • Using ConfigMaps via the Kubernetes API

This looks better, it looks like 2 examples on https://kubernetes.io/docs/concepts/configuration/configmap/#configmap-object has elaborated scenarios on

  • Using ConfigMaps as files from a Pod
  • Using ConfigMaps as environment variables

Maybe we can delete these 2 characters and directly refer example on https://kubernetes.io/docs/concepts/configuration/configmap/#configmap-object?

These seems close to your proposal on #45847 (comment)?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants