Skip to content

Commit 594d391

Browse files
authored
Merge pull request #7244 from ChristopherFry/cfry/api-conventions-kubernetes-docs-links
Fix kubernetes doc links in api conventions doc
2 parents 3ff3b12 + b8e17d9 commit 594d391

File tree

1 file changed

+18
-15
lines changed

1 file changed

+18
-15
lines changed

contributors/devel/sig-architecture/api-conventions.md

+18-15
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ An introduction to using resources with kubectl can be found in [the object mana
6969
- [When to use a different type](#when-to-use-a-different-type)
7070

7171

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
7373
ecosystem) are intended to ease client development and ensure that configuration
7474
mechanisms can be implemented that work across a diverse set of use cases
7575
consistently.
@@ -148,8 +148,8 @@ the full list. Some objects may be singletons (the current user, the system
148148
defaults) and may not have lists.
149149

150150
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
153153
[the fields documentation](https://kubernetes.io/docs/concepts/overview/working-with-objects/field-selectors/)).
154154

155155
Examples: `PodList`, `ServiceList`, `NodeList`.
@@ -188,7 +188,7 @@ is independent of the specific resource schema.
188188

189189
Two additional subresources, `proxy` and `portforward`, provide access to
190190
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/).
192192

193193
The standard REST verbs (defined below) MUST return singular JSON objects. Some
194194
API endpoints may deviate from the strict REST pattern and return resources that
@@ -229,12 +229,12 @@ called "metadata":
229229

230230
* namespace: a namespace is a DNS compatible label that objects are subdivided
231231
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.
233233
* 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/)).
235235
This value is used in the path when retrieving an individual object.
236236
* 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/))
238238
used to distinguish between objects with the same name that have been deleted
239239
and recreated
240240

@@ -264,10 +264,10 @@ Once the deletionTimestamp is set, this value may not be unset or be set further
264264
into the future, although it may be shortened or the resource may be deleted
265265
prior to this time.
266266
* 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/))
268268
* annotations: a map of string keys and values that can be used by external
269269
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/))
271271

272272
Labels are intended for organizational purposes by end users (select the pods
273273
that match this label query). Annotations enable third-party automation and
@@ -526,9 +526,10 @@ the reported status reflects the most recent desired status.
526526
#### References to related objects
527527

528528
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
532533
ensure that GETs of individual objects remain bounded in time and space, these
533534
sets may be queried via separate API queries, but will not be expanded in the
534535
referring object's status.
@@ -720,7 +721,8 @@ detailed explanation of how it works and why it needed to be introduced, see
720721
All compatible Kubernetes APIs MUST support "name idempotency" and respond with
721722
an HTTP status code 409 when a request is made to POST an object that has the
722723
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.
724726

725727
Names generated by the system may be requested using `metadata.generateName`.
726728
GenerateName indicates that the name should be made unique by the server prior
@@ -1671,7 +1673,8 @@ called `Fooable`, not `IsFooable`.
16711673
[DNS_LABEL](https://git.k8s.io/design-proposals-archive/architecture/identifiers.md).
16721674
* The `kube-` prefix is reserved for Kubernetes system namespaces, e.g. `kube-system` and `kube-public`.
16731675
* 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.
16751678

16761679
## Label, selector, and annotation conventions
16771680

@@ -1704,7 +1707,7 @@ that hard to consistently apply schemas that ensure uniqueness. One just needs
17041707
to ensure that at least one value of some label key in common differs compared
17051708
to all other comparable resources. We could/should provide a verification tool
17061709
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,
17081711
relatively narrowly used namespaces (e.g., per environment, per application) can
17091712
be used to reduce the set of resources that could potentially cause overlap.
17101713

0 commit comments

Comments
 (0)