Clarify name must be lowercase in docs, to match code

We restrict DNS_SUBDOMAIN to lowercase for sanity.
duda · Jan 20, 2015 · 3ba8af0 · 3ba8af0
1 parent 6ff26d9
commit 3ba8af0
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/docs/design/identifiers.md b/docs/design/identifiers.md
@@ -12,10 +12,10 @@ Name
 : A non-empty string guaranteed to be unique within a given scope at a particular time; used in resource URLs; provided by clients at creation time and encouraged to be human friendly; intended to facilitate creation idempotence and space-uniqueness of singleton objects, distinguish distinct entities, and reference particular entities across operations.
 
 [rfc1035](http://www.ietf.org/rfc/rfc1035.txt)/[rfc1123](http://www.ietf.org/rfc/rfc1123.txt) label (DNS_LABEL)
-: An alphanumeric (a-z, A-Z, and 0-9) string, with a maximum length of 63 characters, with the '-' character allowed anywhere except the first or last character, suitable for use as a hostname or segment in a domain name
+: An alphanumeric (a-z, and 0-9) string, with a maximum length of 63 characters, with the '-' character allowed anywhere except the first or last character, suitable for use as a hostname or segment in a domain name
 
 [rfc1035](http://www.ietf.org/rfc/rfc1035.txt)/[rfc1123](http://www.ietf.org/rfc/rfc1123.txt) subdomain (DNS_SUBDOMAIN)
-: One or more rfc1035/rfc1123 labels separated by '.' with a maximum length of 253 characters
+: One or more lowercase rfc1035/rfc1123 labels separated by '.' with a maximum length of 253 characters
 
 [rfc4122](http://www.ietf.org/rfc/rfc4122.txt) universally unique identifier (UUID)
 : A 128 bit generated value that is extremely unlikely to collide across time and space and requires no central coordination

diff --git a/docs/identifiers.md b/docs/identifiers.md
@@ -2,7 +2,7 @@
 All objects in the Kubernetes REST API are identified by a Name and a UID.
 
 ## Names
-Names are user-provided.  Only one object of a given kind can have a given name at a time.  But if you delete an object, you can make a new object with the same name.  Names are the used to refer to an object in a resource URL, such as `/api/v1beta3/pods/some.name`.   Names may be up to maximum length of 253 characters and consist of alphanumeric characters, `-`, and `.`.  See the [identifiers design doc](design/identifiers.md) for the precise syntax rules for names.
+Names are user-provided.  Only one object of a given kind can have a given name at a time.  But if you delete an object, you can make a new object with the same name.  Names are the used to refer to an object in a resource URL, such as `/api/v1beta3/pods/some.name`.   Names may be up to maximum length of 253 characters and consist of lower case alphanumeric characters, `-`, and `.`.  See the [identifiers design doc](design/identifiers.md) for the precise syntax rules for names.
 
 ## UIDs
 UID are generated by Kubernetes.  Every object created over the whole lifetime of a Kubernetes cluster has a distinct UID.