Edit and redo ConfigMap docs #35160

tomkivlin · 2022-07-19T09:21:19Z

Move exiting content on optional ConfigMaps into the "Understanding ConfigMaps and Pods" section to make it more generic (was a sub-section within "Add ConfigMap data to a Volume" and re-worded it slightly.

Also added in content from #2334, which was removed in #2568.

Resolves #9829

netlify · 2022-07-19T09:32:54Z

✅ Pull request preview available for checking

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`ad33b0c`
🔍 Latest deploy log	https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/62dfaa99b292d60008cf3508
😎 Deploy Preview	https://deploy-preview-35160--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

sftim · 2022-07-20T21:17:11Z

/retitle Edit and redo ConfigMap docs

We avoid putting PR references (eg #2334) in PR titles.

sftim

Thanks. Some suggestions about the optional ConfigMaps. We shouldn't imply that the behavior is always the same - those optional ConfigMaps might actually exist.

content/en/docs/tasks/configure-pod-container/configure-pod-configmap.md

…nfigmap.md Co-authored-by: Tim Bannister <tim@scalefactory.com>

sftim

@shannonxtreme would you like to comment on this one? I know you've been looking at the tech writing in the secrets-and-configmaps area recently.

shannonxtreme

I made some suggestions for clarity. Thank you for this PR :)

shannonxtreme · 2022-07-25T19:42:12Z

content/en/docs/tasks/configure-pod-container/configure-pod-configmap.md

@@ -675,7 +657,7 @@ data:

 ### Restrictions

- You must create a ConfigMap before referencing it in a Pod specification (unless you mark the ConfigMap as "optional"). If you reference a ConfigMap that doesn't exist, the Pod won't start. Likewise, references to keys that don't exist in the ConfigMap will prevent the pod from starting.
+- You must create a ConfigMap before referencing it in a Pod specification, or mark the ConfigMap as "optional" (see [Optional ConfigMaps](#optional-configmaps)). If you reference a ConfigMap that doesn't exist, or hasn't been marked as "optional" the Pod won't start. Likewise, references to keys that don't exist in the ConfigMap will prevent the pod from starting.


Feels like this makes the sentence harder to understand.

Suggested change

- You must create a ConfigMap before referencing it in a Pod specification, or mark the ConfigMap as "optional" (see [Optional ConfigMaps](#optional-configmaps)). If you reference a ConfigMap that doesn't exist, or hasn't been marked as "optional" the Pod won't start. Likewise, references to keys that don't exist in the ConfigMap will prevent the pod from starting.

- You must create the `ConfigMap` object before you reference it in a Pod specification. Alternatively, mark the ConfigMap reference as `optional` in the Pod spec (see [Optional ConfigMaps](#optional-configmaps)). If you reference a ConfigMap that doesn't exist and you don't mark the reference as `optional`, the Pod won't start. Similarly, references to keys that don't exist in the ConfigMap will also prevent the Pod from starting, unless you mark the key references as `optional`.

Updated in ad33b0c

content/en/docs/tasks/configure-pod-container/configure-pod-configmap.md

…nfigmap.md Co-authored-by: Shannon Kularathna <ax3shannonkularathna@gmail.com>

tomkivlin · 2022-07-26T08:50:34Z

Thanks, @shannonxtreme - I have made the updates as suggested.

shannonxtreme · 2022-07-26T11:16:42Z

Thank you for doing this !

/lgtm

k8s-ci-robot · 2022-07-26T11:17:00Z

LGTM label has been added.

Git tree hash: 021a8f0ca4d854e3803b3907c632943b56eddfe1

tomkivlin · 2022-07-26T11:18:32Z

Thank you for doing this !

/lgtm

No worries, thanks for the feedback and support.

sftim

Thanks

/approve

sftim · 2022-07-26T12:21:15Z

content/en/docs/tasks/configure-pod-container/configure-pod-configmap.md

-In a Pod, or pod template, you can mark a reference to a ConfigMap as _optional_.
-If the ConfigMap is non-existent, the configuration for which it provides data in the Pod (e.g. environment variable, mounted volume) will be empty.
+You can mark a reference to a ConfigMap as _optional_ in a Pod specification.
+If the ConfigMap doesn't exist, the configuration for which it provides data in the Pod (e.g. environment variable, mounted volume) will be empty.


A nit: we avoid Latin phrases and their abbreviations.

k8s-ci-robot · 2022-07-26T12:22:38Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sftim

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~content/en/OWNERS~~ [sftim]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

small edit and add back content from PR#2334

673d1d7

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jul 19, 2022

k8s-ci-robot requested review from jimangel and kbhawkey July 19, 2022 09:21

k8s-ci-robot added language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. labels Jul 19, 2022

k8s-ci-robot changed the title ~~small edit and add back content from PR#2334~~ Edit and redo ConfigMap docs Jul 20, 2022

sftim reviewed Jul 20, 2022

View reviewed changes

content/en/docs/tasks/configure-pod-container/configure-pod-configmap.md Outdated Show resolved Hide resolved

sftim reviewed Jul 20, 2022

View reviewed changes

content/en/docs/tasks/configure-pod-container/configure-pod-configmap.md Outdated Show resolved Hide resolved

tomkivlin and others added 6 commits July 21, 2022 07:49

Update content/en/docs/tasks/configure-pod-container/configure-pod-co…

00984b3

…nfigmap.md Co-authored-by: Tim Bannister <tim@scalefactory.com>

Update content/en/docs/tasks/configure-pod-container/configure-pod-co…

9513b63

…nfigmap.md Co-authored-by: Tim Bannister <tim@scalefactory.com>

Update content/en/docs/tasks/configure-pod-container/configure-pod-co…

9289136

…nfigmap.md Co-authored-by: Tim Bannister <tim@scalefactory.com>

Update content/en/docs/tasks/configure-pod-container/configure-pod-co…

8066c73

…nfigmap.md Co-authored-by: Tim Bannister <tim@scalefactory.com>

Update content/en/docs/tasks/configure-pod-container/configure-pod-co…

a24f7c6

…nfigmap.md Co-authored-by: Tim Bannister <tim@scalefactory.com>

Update content/en/docs/tasks/configure-pod-container/configure-pod-co…

461f5c7

…nfigmap.md Co-authored-by: Tim Bannister <tim@scalefactory.com>

k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jul 21, 2022

tomkivlin and others added 2 commits July 21, 2022 07:50

Update content/en/docs/tasks/configure-pod-container/configure-pod-co…

b0b5f5f

…nfigmap.md Co-authored-by: Tim Bannister <tim@scalefactory.com>

Update configure-pod-configmap.md

7e16543

k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jul 21, 2022

sftim reviewed Jul 25, 2022

View reviewed changes

shannonxtreme reviewed Jul 25, 2022

View reviewed changes

tomkivlin and others added 3 commits July 26, 2022 09:19

Update content/en/docs/tasks/configure-pod-container/configure-pod-co…

c3f86b7

…nfigmap.md Co-authored-by: Shannon Kularathna <ax3shannonkularathna@gmail.com>

Update content/en/docs/tasks/configure-pod-container/configure-pod-co…

748d4a9

…nfigmap.md Co-authored-by: Shannon Kularathna <ax3shannonkularathna@gmail.com>

updates from Shannon feedback

ad33b0c

k8s-ci-robot assigned shannonxtreme Jul 26, 2022

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 26, 2022

sftim reviewed Jul 26, 2022

View reviewed changes

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 26, 2022

k8s-ci-robot merged commit fb8577a into kubernetes:main Jul 26, 2022

wULLSnpAXbWZGYDYyhWTKKspEQoaYxXyhoisqHf mentioned this pull request Jan 9, 2023

Feat/auto clean up berops/claudie#490

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Edit and redo ConfigMap docs #35160

Edit and redo ConfigMap docs #35160

tomkivlin commented Jul 19, 2022 •

edited

netlify bot commented Jul 19, 2022 •

edited

sftim commented Jul 20, 2022

sftim left a comment

sftim left a comment

shannonxtreme left a comment

shannonxtreme Jul 25, 2022

tomkivlin Jul 26, 2022

tomkivlin commented Jul 26, 2022

shannonxtreme commented Jul 26, 2022

k8s-ci-robot commented Jul 26, 2022

tomkivlin commented Jul 26, 2022

sftim left a comment

sftim Jul 26, 2022

k8s-ci-robot commented Jul 26, 2022

Edit and redo ConfigMap docs #35160

Edit and redo ConfigMap docs #35160

Conversation

tomkivlin commented Jul 19, 2022 • edited

netlify bot commented Jul 19, 2022 • edited

✅ Pull request preview available for checking

sftim commented Jul 20, 2022

sftim left a comment

Choose a reason for hiding this comment

sftim left a comment

Choose a reason for hiding this comment

shannonxtreme left a comment

Choose a reason for hiding this comment

shannonxtreme Jul 25, 2022

Choose a reason for hiding this comment

tomkivlin Jul 26, 2022

Choose a reason for hiding this comment

tomkivlin commented Jul 26, 2022

shannonxtreme commented Jul 26, 2022

k8s-ci-robot commented Jul 26, 2022

tomkivlin commented Jul 26, 2022

sftim left a comment

Choose a reason for hiding this comment

sftim Jul 26, 2022

Choose a reason for hiding this comment

k8s-ci-robot commented Jul 26, 2022

tomkivlin commented Jul 19, 2022 •

edited

netlify bot commented Jul 19, 2022 •

edited