From 8d16cd6b830d68f6aa3674b79d175e87aa1fb61b Mon Sep 17 00:00:00 2001 From: Zihong Zheng Date: Tue, 3 Oct 2017 16:43:47 -0700 Subject: [PATCH] Add TOC and fix links for kube-dns documentation (#5748) --- docs/concepts/services-networking/dns-pod-service.md | 5 +++++ docs/concepts/workloads/controllers/statefulset.md | 6 +++--- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/docs/concepts/services-networking/dns-pod-service.md b/docs/concepts/services-networking/dns-pod-service.md index bf3779981a..42e38447c1 100644 --- a/docs/concepts/services-networking/dns-pod-service.md +++ b/docs/concepts/services-networking/dns-pod-service.md @@ -5,6 +5,9 @@ approvers: title: DNS Pods and Services --- +* TOC +{:toc} + ## Introduction As of Kubernetes 1.3, DNS is a built-in service launched automatically using the addon manager [cluster add-on](http://releases.k8s.io/{{page.githubbranch}}/cluster/addons/README.md). @@ -30,6 +33,8 @@ DNS query for `foo.bar`. The following sections detail the supported record types and layout that is supported. Any other layout or names or queries that happen to work are considered implementation details and are subject to change without warning. +For more up-to-date specification, see +[Kubernetes DNS-Based Service Discovery](https://github.com/kubernetes/dns/blob/master/docs/specification.md). ### Services diff --git a/docs/concepts/workloads/controllers/statefulset.md b/docs/concepts/workloads/controllers/statefulset.md index 7e2e0fcd87..93997a38d3 100644 --- a/docs/concepts/workloads/controllers/statefulset.md +++ b/docs/concepts/workloads/controllers/statefulset.md @@ -123,8 +123,8 @@ is `$(statefulset name)-$(ordinal)`. The example above will create three Pods named `web-0,web-1,web-2`. A StatefulSet can use a [Headless Service](/docs/concepts/services-networking/service/#headless-services) to control the domain of its Pods. The domain managed by this Service takes the form: -`$(service name).$(namespace).svc.cluster.local`, where "cluster.local" -is the [cluster domain](http://releases.k8s.io/{{page.githubbranch}}/cluster/addons/dns/README.md). +`$(service name).$(namespace).svc.cluster.local`, where "cluster.local" is the +cluster domain. As each Pod is created, it gets a matching DNS subdomain, taking the form: `$(podname).$(governing service domain)`, where the governing service is defined by the `serviceName` field on the StatefulSet. @@ -139,7 +139,7 @@ Cluster Domain | Service (ns/name) | StatefulSet (ns/name) | StatefulSet Domain kube.local | foo/nginx | foo/web | nginx.foo.svc.kube.local | web-{0..N-1}.nginx.foo.svc.kube.local | web-{0..N-1} | Note that Cluster Domain will be set to `cluster.local` unless -[otherwise configured](http://releases.k8s.io/{{page.githubbranch}}/cluster/addons/dns/README.md). +[otherwise configured](/docs/concepts/services-networking/dns-pod-service/#how-it-works). ### Stable Storage