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.

Sign up for GitHub

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

Jump to bottom

updating Pod DNS config example to use documentation IP address #39169

Merged
merged 3 commits into from
Feb 8, 2023
Merged

updating Pod DNS config example to use documentation IP address #39169

merged 3 commits into from
Feb 8, 2023

Conversation

reetasingh
Copy link
Contributor

@reetasingh reetasingh commented Jan 30, 2023 •
edited
Loading

Fix #39166
Problem:
https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/#pod-dns-config uses 1.2.3.4 as the example DNS server. It's better to use an IP address reserved for documentation.

Proposed Solution:
Change the example manifest and web page to use IP address 192.0.2.1 ( from the 192.0.2.0/24 block)

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Jan 30, 2023
@k8s-ci-robot k8s-ci-robot requested a review from bowei January 30, 2023 19:15
@k8s-ci-robot k8s-ci-robot added the language/en Issues or PRs related to English language label Jan 30, 2023
@k8s-ci-robot k8s-ci-robot added the sig/docs Categorizes an issue or PR as relevant to SIG Docs. label Jan 30, 2023
@netlify
Copy link

netlify bot commented Jan 30, 2023 •
edited
Loading

✅ Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit 1b56f0d
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/63e343d9f9723a000877ee69
😎 Deploy Preview https://deploy-preview-39169--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

kundan2707
kundan2707 reviewed Jan 31, 2023
View reviewed changes
Copy link
Contributor

@kundan2707 kundan2707 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@tengqm
Copy link
Contributor

tengqm commented Jan 31, 2023

I don't think this is necessary. 1.2.3.4 reads more like an intented, fake DNS server address.
Changing this to something more realistic may be confusing.

/hold

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jan 31, 2023
@reetasingh
Copy link
Contributor Author

I don't think this is necessary. 1.2.3.4 reads more like an intented, fake DNS server address. Changing this to something more realistic may be confusing.

/hold

sftim whats your thought about this?

sftim
sftim reviewed Feb 1, 2023
View reviewed changes
content/en/examples/service/networking/custom-dns.yaml Outdated
@@ -10,7 +10,7 @@ spec:
dnsPolicy: "None"
dnsConfig:
nameservers:
- 1.2.3.4
- 192.0.2.1
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To address @tengqm's reservation, how about:

Suggested change
- 192.0.2.1
- 192.0.2.1 # this is an example

or use an AS112 IP address, such as 10.42.0.1?

Suggested change
- 192.0.2.1
- 10.42.0.1 # this is an example

How about either of those approaches? I notice that the IPv6 example is already using a documentation IP address.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding a comment is good and clear enough.
Thanks.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note added, please review

@reetasingh reetasingh requested review from tengqm and sftim and removed request for bowei, bradtopol, tengqm and sftim February 6, 2023 08:20
@tengqm
Copy link
Contributor

tengqm commented Feb 6, 2023

/hold cancel
/label tide/merge-method-squash
/lgtm

@k8s-ci-robot k8s-ci-robot added tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. and removed do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. labels Feb 6, 2023
@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 6, 2023
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: ea55adac65ec3440ca5ea6182c49c8af6770671f

tengqm
tengqm reviewed Feb 6, 2023
View reviewed changes
content/en/docs/concepts/services-networking/dns-pod-service.md
@@ -306,7 +306,7 @@ When the Pod above is created, the container `test` gets the following contents
in its `/etc/resolv.conf` file:

```
nameserver 1.2.3.4
nameserver 192.0.2.1
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please add a comment like # 192.0.2.1 is an example IP.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

  Lines that contain a semicolon (;) or hash character (#) in the
  first column are treated as comments.

For resolv.conf, that comment does need to be on a line by itself.

@reylejano
Copy link
Member

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: reylejano

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:

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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 6, 2023
@reylejano
Copy link
Member

@reetasingh ,
Can you push an empty commit to restart the tests
On your reetasingh:reetas_update_dns branch, you can do
git commit --allow-empty -m "empty commit"
git push origin reetas_update_dns

@reylejano
Copy link
Member

/retest

@reetasingh
Copy link
Contributor Author

@reetasingh , Can you push an empty commit to restart the tests On your reetasingh:reetas_update_dns branch, you can do git commit --allow-empty -m "empty commit" git push origin reetas_update_dns

Hi @reylejano pushed an empty commit

@k8s-ci-robot k8s-ci-robot merged commit f78e3bf into kubernetes:main Feb 8, 2023
@windsonsea windsonsea mentioned this pull request Feb 8, 2023
Merged
@reetasingh reetasingh mentioned this pull request Feb 9, 2023
Closed
9 tasks
DonatoHorn pushed a commit to DonatoHorn/website that referenced this pull request Jun 25, 2023
@reetasingh @DonatoHorn
updating Pod DNS config example to use documentation IP address (kube…
6cc5e61 
…rnetes#39169)

* updating Pod DNS config example to use documentation IP address

* add this is an example in note

* empty commit
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kundan2707 kundan2707 kundan2707 left review comments

@sftim sftim sftim left review comments

@tengqm tengqm tengqm left review comments

Assignees

@tengqm tengqm

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Pod DNS config example does not use documentation IP address
6 participants
@reetasingh @tengqm @k8s-ci-robot @reylejano @sftim @kundan2707