Skip to content

admin: dns: merge from the build dir#1251

Merged
devin-donnelly merged 1 commit intokubernetes:masterfrom
philips:add-details-from-dns-docs
Oct 5, 2016
Merged

admin: dns: merge from the build dir#1251
devin-donnelly merged 1 commit intokubernetes:masterfrom
philips:add-details-from-dns-docs

Conversation

@philips
Copy link
Copy Markdown
Contributor

@philips philips commented Sep 17, 2016

Try and clean this mess up where the build dir has user facing docs and move them here.

Ref: kubernetes/kubernetes#32931


This change is Reviewable

@girishkalele
Copy link
Copy Markdown

cc @thockin who originally wrote the build/kube-dns README

Comment thread docs/admin/dns.md Outdated

## What things get DNS names?

Every Service defined in the cluster (including the DNS server itself) will be
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.

Try to avoid future tense "will be".

"Every Service defined in the cluster (including the DNS server itself) is assigned a DNS name."

Comment thread docs/admin/dns.md
When enabled, pods are assigned a DNS A record in the form of `pod-ip-address.my-namespace.pod.cluster.local`.

For example, a pod with ip `1.2.3.4` in the namespace `default` with a dns name of `cluster.local` would have an entry: `1-2-3-4.default.pod.cluster.local`.

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.

Extra whitespace.

Comment thread docs/admin/dns.md Outdated
Given a Pod with the hostname set to "foo" and the subdomain set to "bar", and a headless Service named "bar" in the same namespace, the pod will see it's own FQDN as "foo.bar.my-namespace.svc.cluster.local". DNS will serve an A record at that name, pointing to the Pod's IP.

With v1.2, the Endpoints object also has a new annotation `endpoints.beta.kubernetes.io/hostnames-map`. Its value is the json representation of map[string(IP)][endpoints.HostRecord], for example: '{"10.245.1.6":{HostName: "my-webserver"}}'.
If the Endpoints are for a headless service, then A records will be created with the format <hostname>.<service name>.<pod namespace>.svc.<cluster domain>
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.

will be -> is

Comment thread docs/admin/dns.md Outdated
name: busybox
```

If there exists a headless service in the same namespace as the pod and with the same name as the subdomain, the cluster's KubeDNS Server will also return an A record for the Pod's fully qualified hostname.
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.

will also return -> also returns

Comment thread docs/admin/dns.md Outdated
```

If there exists a headless service in the same namespace as the pod and with the same name as the subdomain, the cluster's KubeDNS Server will also return an A record for the Pod's fully qualified hostname.
Given a Pod with the hostname set to "foo" and the subdomain set to "bar", and a headless Service named "bar" in the same namespace, the pod will see it's own FQDN as "foo.bar.my-namespace.svc.cluster.local". DNS will serve an A record at that name, pointing to the Pod's IP.
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.

will serve -> serves

Comment thread docs/admin/dns.md Outdated
`pod.beta.kubernetes.io/hostname` annotation value.

v1.2 introduces a beta feature where the user can specify a Pod annotation, `pod.beta.kubernetes.io/subdomain`, to specify what the Pod's subdomain should be.
If the annotation is specified, the fully qualified Pod hostname will be "<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>".
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.

Passive voice.

If the annotation is specified -> If you specify the annotation

Comment thread docs/admin/dns.md Outdated
Currently when a pod is created, its hostname is the Pod's `metadata.name` value.

With v1.2, users can specify a Pod annotation, `pod.beta.kubernetes.io/hostname`, to specify what the Pod's hostname should be.
If the annotation is specified, the annotation value takes precendence over the Pod's name, to be the hostname of the pod.
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.

Passive voice.

If the annotation is specified -> If you specify the annotation

"the annotation value takes precendence over the Pod name and becomes the hostname for that Pod."

@philips
Copy link
Copy Markdown
Contributor Author

philips commented Sep 20, 2016

@devin-donnelly thanks, I think I addresses all of your feedback.

Copy link
Copy Markdown
Contributor

@devin-donnelly devin-donnelly left a comment

Choose a reason for hiding this comment

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

Just one more nit; I think you got stuck between sentence edits here.

Comment thread docs/admin/dns.md Outdated
configured to tell individual containers to use the DNS Service's IP to resolve DNS names.

Every Service defined in the cluster (including the DNS server itself) will be
A scheduled DNS Pod and Service on the cluster, and the kubelets configured to
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.

Looks like this is an incomplete sentence. How about:

"Kubernetes DNS schedules a DNS Pod and Service on th cluster, and configures the kubelets to tell individual containers to use the DNS Service's IP to resolve DNS names."

@devin-donnelly
Copy link
Copy Markdown
Contributor

Just one more nit, @philips .

@philips philips force-pushed the add-details-from-dns-docs branch from 885fb63 to dfee30a Compare September 28, 2016 22:40
Try and clean this mess up where the build dir has user facing docs and move them here.

Ref: kubernetes/kubernetes#32931
@philips philips force-pushed the add-details-from-dns-docs branch from dfee30a to 8aa10a6 Compare September 28, 2016 22:41
@philips
Copy link
Copy Markdown
Contributor Author

philips commented Sep 28, 2016

@devin-donnelly Addressed feedback, thanks for the review!

@philips
Copy link
Copy Markdown
Contributor Author

philips commented Sep 30, 2016

@devin-donnelly What is the next step here? Sorry to keep bugging but I want to get this cleaned up.

@devin-donnelly devin-donnelly merged commit 49c83f4 into kubernetes:master Oct 5, 2016
mikutas pushed a commit to mikutas/k8s-website that referenced this pull request Sep 22, 2022
Signed-off-by: Charles Pretzer <charles@buoyant.io>
Okabe-Junya pushed a commit to Okabe-Junya/website that referenced this pull request Dec 4, 2023
Signed-off-by: Mr. Erlison <sisal.cordame_0a@icloud.com>

Signed-off-by: Mr. Erlison <sisal.cordame_0a@icloud.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants