@@ -69,7 +69,7 @@ An introduction to using resources with kubectl can be found in [the object mana
69
69
- [ When to use a different type] ( #when-to-use-a-different-type )
70
70
71
71
72
- The conventions of the [ Kubernetes API] ( https://kubernetes.io/docs/api/ ) (and related APIs in the
72
+ The conventions of the [ Kubernetes API] ( https://kubernetes.io/docs/concepts/overview/kubernetes- api/ ) (and related APIs in the
73
73
ecosystem) are intended to ease client development and ensure that configuration
74
74
mechanisms can be implemented that work across a diverse set of use cases
75
75
consistently.
@@ -148,8 +148,8 @@ the full list. Some objects may be singletons (the current user, the system
148
148
defaults) and may not have lists.
149
149
150
150
In addition, all lists that return objects with labels should support label
151
- filtering (see [ the labels documentation] ( https://kubernetes.io/docs/user-guide /labels/ ) ), and most
152
- lists should support filtering by fields (see
151
+ filtering (see [ the labels documentation] ( https://kubernetes.io/docs/concepts/overview/working-with-objects /labels/ ) ),
152
+ and most lists should support filtering by fields (see
153
153
[ the fields documentation] ( https://kubernetes.io/docs/concepts/overview/working-with-objects/field-selectors/ ) ).
154
154
155
155
Examples: ` PodList ` , ` ServiceList ` , ` NodeList ` .
@@ -188,7 +188,7 @@ is independent of the specific resource schema.
188
188
189
189
Two additional subresources, ` proxy ` and ` portforward ` , provide access to
190
190
cluster resources as described in
191
- [ accessing the cluster] ( https://kubernetes.io/docs/user-guide/accessing-the -cluster/ ) .
191
+ [ accessing the cluster] ( https://kubernetes.io/docs/tasks/access-application-cluster/access -cluster/ ) .
192
192
193
193
The standard REST verbs (defined below) MUST return singular JSON objects. Some
194
194
API endpoints may deviate from the strict REST pattern and return resources that
@@ -229,12 +229,12 @@ called "metadata":
229
229
230
230
* namespace: a namespace is a DNS compatible label that objects are subdivided
231
231
into. The default namespace is 'default'. See
232
- [ the namespace docs] ( https://kubernetes.io/docs/user-guide /namespaces/ ) for more.
232
+ [ the namespace docs] ( https://kubernetes.io/docs/concepts/overview/working-with-objects /namespaces/ ) for more.
233
233
* name: a string that uniquely identifies this object within the current
234
- namespace (see [ the identifiers docs] ( https://kubernetes.io/docs/user-guide/identifiers / ) ).
234
+ namespace (see [ the identifiers docs] ( https://kubernetes.io/docs/concepts/overview/working-with-objects/names / ) ).
235
235
This value is used in the path when retrieving an individual object.
236
236
* uid: a unique in time and space value (typically an RFC 4122 generated
237
- identifier, see [ the identifiers docs] ( https://kubernetes.io/docs/user-guide/identifiers / ) )
237
+ identifier, see [ the identifiers docs] ( https://kubernetes.io/docs/concepts/overview/working-with-objects/names / ) )
238
238
used to distinguish between objects with the same name that have been deleted
239
239
and recreated
240
240
@@ -264,10 +264,10 @@ Once the deletionTimestamp is set, this value may not be unset or be set further
264
264
into the future, although it may be shortened or the resource may be deleted
265
265
prior to this time.
266
266
* labels: a map of string keys and values that can be used to organize and
267
- categorize objects (see [ the labels docs] ( https://kubernetes.io/docs/user-guide /labels/ ) )
267
+ categorize objects (see [ the labels docs] ( https://kubernetes.io/docs/concepts/overview/working-with-objects /labels/ ) )
268
268
* annotations: a map of string keys and values that can be used by external
269
269
tooling to store and retrieve arbitrary metadata about this object (see
270
- [ the annotations docs] ( https://kubernetes.io/docs/user-guide /annotations/ ) )
270
+ [ the annotations docs] ( https://kubernetes.io/docs/concepts/overview/working-with-objects /annotations/ ) )
271
271
272
272
Labels are intended for organizational purposes by end users (select the pods
273
273
that match this label query). Annotations enable third-party automation and
@@ -526,9 +526,10 @@ the reported status reflects the most recent desired status.
526
526
#### References to related objects
527
527
528
528
References to loosely coupled sets of objects, such as
529
- [ pods] ( https://kubernetes.io/docs/user-guide/pods/ ) overseen by a
530
- [ replication controller] ( https://kubernetes.io/docs/user-guide/replication-controller/ ) , are usually
531
- best referred to using a [ label selector] ( https://kubernetes.io/docs/user-guide/labels/ ) . In order to
529
+ [ pods] ( https://kubernetes.io/docs/concepts/workloads/pods/ ) overseen by a
530
+ [ replication controller] ( https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/ ) ,
531
+ are usually best referred to using a
532
+ [ label selector] ( https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors ) . In order to
532
533
ensure that GETs of individual objects remain bounded in time and space, these
533
534
sets may be queried via separate API queries, but will not be expanded in the
534
535
referring object's status.
@@ -720,7 +721,8 @@ detailed explanation of how it works and why it needed to be introduced, see
720
721
All compatible Kubernetes APIs MUST support "name idempotency" and respond with
721
722
an HTTP status code 409 when a request is made to POST an object that has the
722
723
same name as an existing object in the system. See
723
- [the identifiers docs](https://kubernetes.io/docs/user-guide/identifiers/) for details.
724
+ [the identifiers docs](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/)
725
+ for details.
724
726
725
727
Names generated by the system may be requested using `metadata.generateName`.
726
728
GenerateName indicates that the name should be made unique by the server prior
@@ -1671,7 +1673,8 @@ called `Fooable`, not `IsFooable`.
1671
1673
[DNS_LABEL](https://git.k8s.io/design-proposals-archive/architecture/identifiers.md).
1672
1674
* The `kube-` prefix is reserved for Kubernetes system namespaces, e.g. `kube-system` and `kube-public`.
1673
1675
* See
1674
- [the namespace docs](https://kubernetes.io/docs/user-guide/namespaces/) for more information.
1676
+ [the namespace docs](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/)
1677
+ for more information.
1675
1678
1676
1679
# # Label, selector, and annotation conventions
1677
1680
@@ -1704,7 +1707,7 @@ that hard to consistently apply schemas that ensure uniqueness. One just needs
1704
1707
to ensure that at least one value of some label key in common differs compared
1705
1708
to all other comparable resources. We could/should provide a verification tool
1706
1709
to check that. However, development of conventions similar to the examples in
1707
- [Labels](https://kubernetes.io/docs/user-guide /labels/) make uniqueness straightforward. Furthermore,
1710
+ [Labels](https://kubernetes.io/docs/concepts/overview/working-with-objects /labels/) make uniqueness straightforward. Furthermore,
1708
1711
relatively narrowly used namespaces (e.g., per environment, per application) can
1709
1712
be used to reduce the set of resources that could potentially cause overlap.
1710
1713
0 commit comments