Skip to content

Trivial doc tidying.#2686

Merged
justinsb merged 5 commits into
kubernetes:masterfrom
rk295:rk-dns-controller-doc
Jul 14, 2017
Merged

Trivial doc tidying.#2686
justinsb merged 5 commits into
kubernetes:masterfrom
rk295:rk-dns-controller-doc

Conversation

@rk295

@rk295 rk295 commented Jun 6, 2017

Copy link
Copy Markdown
Contributor

I pulled the command line options out of the source and into this doc to
save other people the trouble of digging into the source. Hope nobody
minds!


This change is Reviewable

I pulled the command line options out of the source and into this doc to
save other people the trouble of digging into the source. Hope nobody
minds!
@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jun 6, 2017
@k8s-ci-robot

Copy link
Copy Markdown
Contributor

Hi @rk295. Thanks for your PR.

I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with @k8s-bot ok to test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

I understand the commands that are listed here.

Details

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. I understand the commands that are listed here.

@ghost

ghost commented Jun 8, 2017

Copy link
Copy Markdown

Thanks for documenting those flags! I verified that no content is lost in the other parts, and they're all sensible changes.

I would like to ask you to keep the line width <= 80 or <=72 in dns-controller/README.md, so the docs are still easily readable from the terminal.

@rk295

rk295 commented Jun 8, 2017

Copy link
Copy Markdown
Contributor Author

Thanks for the review @WillemMali, I've pushed some changes that tidies them up. I've kept flags.md to <=80 and README.md to <=72.

@ghost

ghost commented Jun 8, 2017

Copy link
Copy Markdown

Looks good to me! I again verified no content was misplaced.

One Git-related suggestion for the future: you can force-push over the commit in your fork, this is correctly picked up by the CI system. If you end up getting conflicts you can rebase onto master, fix the conflicts there and then force-commit again. This way you always end up with a single commit for the PR.

(Also, I love rebase workflows, I'm so glad I learned how to do that here.)

It's really no problem at all, thanks for the PR! @chrislovecnm could you give this one the green light?

@rk295

rk295 commented Jun 8, 2017

Copy link
Copy Markdown
Contributor Author

@WillemMali wicked, thanks. I'll go read about force-pushing over the existing commit!

@chrislovecnm

Copy link
Copy Markdown
Contributor

@k8s-bot ok to test

@k8s-ci-robot k8s-ci-robot removed the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Jun 8, 2017
@chrislovecnm

Copy link
Copy Markdown
Contributor

Need @justinsb or @sethpollack to review. They are far more familiar with the dns controller ;)

Comment thread dns-controller/README.md
but for now we just expose it via DNS.

`dns.alpha.kubernetes.io/external` will set up records for accessing the resource externally
The dns-controller recognizes annotations on nodes.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I don't think it supports annotations on nodes. It just sets up internal ALIAS records.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I'm unsure either tbh, I only slightly improved the formatting in this file, I can't vouch for its accuracy.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

It does!

Comment thread dns-controller/README.md

`dns.alpha.kubernetes.io/external` creates a Route53 A record with `public` IPs of all the nodes
`dns.alpha.kubernetes.io/internal` creates a Route53 A record with `private` IPs of all the nodes
* `dns.alpha.kubernetes.io/external` creates a Route53 A record with

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

It creates CNAME's for hostnames and A records for IP addresses

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Happy to change the wording to reflect that.

Comment thread dns-controller/README.md
`public` IPs of all the nodes
* `dns.alpha.kubernetes.io/internal` creates a Route53 A record with
`private` IPs of all the nodes

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

You can also add the annotations to pods. It will create an A record for pods that are HostNetwork=true

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Ok, I'll re-word to explain that.

@justinsb

justinsb commented Jun 9, 2017

Copy link
Copy Markdown
Member

Generally LGTM - if you clean up some of the things @sethpollack has observed we can merge IMO!

Thanks @rk295

@chrislovecnm

Copy link
Copy Markdown
Contributor

What is the status on this?

@justinsb

Copy link
Copy Markdown
Member

Going to merge & we can iterate, unless I hear an objection from @sethpollack

@sethpollack

Copy link
Copy Markdown
Contributor

Go for it.

@justinsb justinsb merged commit 9c1ef82 into kubernetes:master Jul 14, 2017
@justinsb

Copy link
Copy Markdown
Member

Thanks @rk295 and @sethpollack

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

Labels

cncf-cla: yes Indicates the PR's author has signed the CNCF CLA.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants