Name and UID glossary terms (#6606)
* add name glossary term * add uid glossary term * use glossary terms in doc * Update uid.yaml * Update name.yamlreviewable/pr6962/r1
parent
01d2be3d17
commit
70ee927cbd
|
@ -0,0 +1,10 @@
|
|||
id: name
|
||||
name: Name
|
||||
full-link: /docs/concepts/overview/working-with-objects/names
|
||||
tags:
|
||||
- fundamental
|
||||
short-description: >
|
||||
A client-provided string that refers to an object in a resource URL, such as `/api/v1/pods/some-name`.
|
||||
long-description: >
|
||||
Only one object of a given kind can have a given name at a time.
|
||||
However, if you delete the object, you can make a new object with the same name.
|
|
@ -0,0 +1,10 @@
|
|||
id: uid
|
||||
name: UID
|
||||
full-link: /docs/concepts/overview/working-with-objects/names
|
||||
tags:
|
||||
- fundamental
|
||||
short-description: >
|
||||
A Kubernetes systems-generated string to uniquely identify objects.
|
||||
long-description: >
|
||||
Every object created over the whole lifetime of a Kubernetes cluster has a distinct UID.
|
||||
It is intended to distinguish between historical occurrences of similar entities.
|
|
@ -9,10 +9,14 @@ All objects in the Kubernetes REST API are unambiguously identified by a Name an
|
|||
|
||||
For non-unique user-provided attributes, Kubernetes provides [labels](/docs/user-guide/labels) and [annotations](/docs/concepts/overview/working-with-objects/annotations/).
|
||||
|
||||
See the [identifiers design doc](https://git.k8s.io/community/contributors/design-proposals/architecture/identifiers.md) for the precise syntax rules for Names and UIDs.
|
||||
|
||||
## Names
|
||||
|
||||
Names are generally client-provided. Only one object of a given kind can have a given name at a time (i.e., they are spatially unique). But if you delete an object, you can make a new object with the same name. Names are used to refer to an object in a resource URL, such as `/api/v1/pods/some-name`. By convention, the names of Kubernetes resources should be up to maximum length of 253 characters and consist of lower case alphanumeric characters, `-`, and `.`, but certain resources have more specific restrictions. See the [identifiers design doc](https://git.k8s.io/community/contributors/design-proposals/architecture/identifiers.md) for the precise syntax rules for names.
|
||||
{% glossary_definition term_id="name" length="all" %}
|
||||
|
||||
By convention, the names of Kubernetes resources should be up to maximum length of 253 characters and consist of lower case alphanumeric characters, `-`, and `.`, but certain resources have more specific restrictions.
|
||||
|
||||
## UIDs
|
||||
|
||||
UIDs are generated by Kubernetes. Every object created over the whole lifetime of a Kubernetes cluster has a distinct UID (i.e., they are spatially and temporally unique).
|
||||
{% glossary_definition term_id="uid" length="all" %}
|
||||
|
|
Loading…
Reference in New Issue