Skip to content

Commit 8cc4d1a

Browse files
committed
Add glossary tooltips for resource terms
Help people reading glossary entries understand what those entries mean by the term "resource".
1 parent bea77e0 commit 8cc4d1a

31 files changed

+105
-69
lines changed

content/en/docs/reference/glossary/api-group.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,12 @@ tags:
1111
- fundamental
1212
- architecture
1313
---
14-
A set of related paths in Kubernetes API.
14+
A set of related paths in Kubernetes API.
1515

1616
<!--more-->
17-
You can enable or disable each API group by changing the configuration of your API server. You can also disable or enable paths to specific resources. API group makes it easier to extend the Kubernetes API. The API group is specified in a REST path and in the `apiVersion` field of a serialized object.
17+
18+
You can enable or disable each API group by changing the configuration of your API server. You can also disable or enable paths to specific
19+
{{< glossary_tooltip text="resources" term_id="api-resource" >}}. An API group makes it easier to extend the Kubernetes API.
20+
The API group is specified in a REST path and in the `apiVersion` field of a serialized {{< glossary_tooltip text="object" term_id="object" >}}.
1821

1922
* Read [API Group](/docs/concepts/overview/kubernetes-api/#api-groups-and-versioning) for more information.

content/en/docs/reference/glossary/cadvisor.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@ aka:
99
tags:
1010
- tool
1111
---
12-
cAdvisor (Container Advisor) provides container users an understanding of the resource usage and performance characteristics of their running {{< glossary_tooltip text="containers" term_id="container" >}}.
12+
cAdvisor (Container Advisor) provides container users an understanding of the {{< glossary_tooltip text="resource" term_id="infrastructure-resource" >}}
13+
usage and performance characteristics of their running {{< glossary_tooltip text="containers" term_id="container" >}}.
1314

1415
<!--more-->
1516

content/en/docs/reference/glossary/cgroup.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ aka:
1010
tags:
1111
- fundamental
1212
---
13-
A group of Linux processes with optional resource isolation, accounting and limits.
13+
A group of Linux processes with optional {{< glossary_tooltip text="resource" term_id="infrastructure-resource" >}} isolation, accounting and limits.
1414

1515
<!--more-->
1616

content/en/docs/reference/glossary/container-env-variables.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,4 @@ tags:
1414

1515
<!--more-->
1616

17-
Container environment variables provide information that is required by the running containerized applications along with information about important resources to the {{< glossary_tooltip text="containers" term_id="container" >}}. For example, file system details, information about the container itself, and other cluster resources such as service endpoints.
17+
Container environment variables provide information that is required by the running containerized applications along with information about important related details to the {{< glossary_tooltip text="containers" term_id="container" >}}. For example, file system details, information about the container itself, and other cluster resources such as service endpoints.

content/en/docs/reference/glossary/customresourcedefinition.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,10 @@ tags:
1212
- operation
1313
- extension
1414
---
15-
Custom code that defines a resource to add to your Kubernetes API server without building a complete custom server.
15+
A kind of {{< glossary_tooltip text="API object" term_id="object" >}} that defines a new custom API to add
16+
to your Kubernetes API server, without building a complete custom server.
1617

1718
<!--more-->
1819

19-
Custom Resource Definitions let you extend the Kubernetes API for your environment if the publicly supported API resources can't meet your needs.
20+
CustomResourceDefinitions let you extend the Kubernetes API for your environment if the built-in
21+
{{< glossary_tooltip text="API resources" term_id="api-resource" >}} can't meet your needs.

content/en/docs/reference/glossary/device-plugin.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@ tags:
1212
---
1313
Device plugins run on worker
1414
{{< glossary_tooltip term_id="node" text="Nodes">}} and provide
15-
{{< glossary_tooltip term_id="pod" text="Pods">}} with access to resources,
15+
{{< glossary_tooltip term_id="pod" text="Pods">}} with access to
16+
infrastructure {{< glossary_tooltip text="resources" term_id="infrastructure-resource" >}},
1617
such as local hardware, that require vendor-specific initialization or setup
1718
steps.
1819

content/en/docs/reference/glossary/disruption.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ tags:
1111
---
1212
Disruptions are events that lead to one or more
1313
{{< glossary_tooltip term_id="pod" text="Pods" >}} going out of service.
14-
A disruption has consequences for workload resources, such as
15-
{{< glossary_tooltip term_id="deployment" >}}, that rely on the affected
14+
A disruption has consequences for workload management {{< glossary_tooltip text="resources" term_id="api-resource" >}},
15+
such as {{< glossary_tooltip term_id="deployment" >}}, that rely on the affected
1616
Pods.
1717

1818
<!--more-->

content/en/docs/reference/glossary/endpoint.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,9 @@ aka:
1010
tags:
1111
- networking
1212
---
13-
Endpoints track the IP addresses of Pods with matching {{< glossary_tooltip text="selectors" term_id="selector" >}}.
13+
Legacy {{< glossary_tooltip text="API resource" term_id="api-resource" >}} for tracking the IP addresses of Pods that back
14+
{{< glossary_tooltip text="Services" term_id="service" >}}
1415

1516
<!--more-->
16-
Endpoints can be configured manually for {{< glossary_tooltip text="Services" term_id="service" >}} without selectors specified.
17-
The {{< glossary_tooltip text="EndpointSlice" term_id="endpoint-slice" >}} resource provides a scalable and extensible alternative to Endpoints.
17+
The {{< glossary_tooltip text="EndpointSlice" term_id="endpoint-slice" >}} object kind provides a scalable and extensible
18+
alternative to Endpoints.

content/en/docs/reference/glossary/ephemeral-container.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ A {{< glossary_tooltip term_id="container" >}} type that you can temporarily run
1414

1515
<!--more-->
1616

17-
If you want to investigate a Pod that's running with problems, you can add an ephemeral container to that Pod and carry out diagnostics. Ephemeral containers have no resource or scheduling guarantees, and you should not use them to run any part of the workload itself.
17+
If you want to investigate a Pod that's running with problems, you can add an ephemeral container to that Pod and carry out diagnostics.
18+
Ephemeral containers have no {{< glossary_tooltip text="resource" term_id="infrastructure-resource" >}} or scheduling guarantees,
19+
and you should not use them to run any part of the workload itself.
1820

1921
Ephemeral containers are not supported by {{< glossary_tooltip text="static pods" term_id="static-pod" >}}.

content/en/docs/reference/glossary/event.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,19 @@ id: event
44
date: 2022-01-16
55
full_link: /docs/reference/kubernetes-api/cluster-resources/event-v1/
66
short_description: >
7-
Events are Kubernetes objects that describe some state change in the system.
7+
Kubernetes objects that describe some state change in the cluster.
88
aka:
99
tags:
1010
- core-object
1111
- fundamental
1212
---
13-
Event is a Kubernetes object that describes state change/notable occurrences in the system.
13+
A Kubernetes {{< glossary_tooltip text="object" term_id="object" >}} that describes state changes
14+
or notable occurrences in the cluster.
1415

1516
<!--more-->
16-
Events have a limited retention time and triggers and messages may evolve with time.
17-
Event consumers should not rely on the timing of an event with a given reason reflecting a consistent underlying trigger,
18-
or the continued existence of events with that reason.
19-
17+
Events have a limited retention time and triggers and messages may evolve with time.
18+
Event consumers should not rely on the timing of an event with a given reason reflecting a consistent underlying trigger,
19+
or the continued existence of events with that reason.
2020

2121
Events should be treated as informative, best-effort, supplemental data.
2222

content/en/docs/reference/glossary/finalizer.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@ tags:
1212
- operation
1313
---
1414
Finalizers are namespaced keys that tell Kubernetes to wait until specific
15-
conditions are met before it fully deletes resources marked for deletion.
15+
conditions are met before it fully deletes {{< glossary_tooltip text="resources" term_id="api-resource" >}}
16+
that are marked for deletion.
1617
Finalizers alert {{<glossary_tooltip text="controllers" term_id="controller">}}
1718
to clean up resources the deleted object owned.
1819

@@ -27,5 +28,6 @@ from the target object. When the `metadata.finalizers` field is empty,
2728
Kubernetes considers the deletion complete and deletes the object.
2829

2930
You can use finalizers to control {{<glossary_tooltip text="garbage collection" term_id="garbage-collection">}}
30-
of resources. For example, you can define a finalizer to clean up related resources or
31-
infrastructure before the controller deletes the target resource.
31+
of resources. For example, you can define a finalizer to clean up related
32+
{{< glossary_tooltip text="API resources" term_id="api-resource" >}} or infrastructure before the controller
33+
deletes the object being finalized.

content/en/docs/reference/glossary/group-version-resource.md

+7-4
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,19 @@ title: Group Version Resource
33
id: gvr
44
date: 2023-07-24
55
short_description: >
6-
The API group, API version and name of a Kubernetes API.
6+
The API group, API version and name of a Kubernetes API.
77
88
aka: ["GVR"]
99
tags:
1010
- architecture
1111
---
12-
Means of representing unique Kubernetes API resource.
12+
Means of representing specific Kubernetes APIs uniquely.
1313

1414
<!--more-->
1515

16-
Group Version Resources (GVRs) specify the API group, API version, and resource (name for the object kind as it appears in the URI) associated with accessing a particular id of object in Kubernetes.
16+
Group Version Resources (GVRs) specify the API group, API version, and _resource_ (name for the object kind as it appears in the URI) associated with accessing a particular id of object in Kubernetes.
1717
GVRs let you define and distinguish different Kubernetes objects, and to specify a way of accessing
18-
objects that is stable even as APIs change.
18+
objects that is stable even as APIs change.
19+
20+
In this usage, _resource_ refers to an HTTP resource. Because some APIs are namespaced, a GVR may
21+
not refer to a specific {{< glossary_tooltip text="API resource" term_id="api-resource" >}}.

content/en/docs/reference/glossary/helm-chart.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ id: helm-chart
44
date: 2018-04-12
55
full_link: https://helm.sh/docs/topics/charts/
66
short_description: >
7-
A package of pre-configured Kubernetes resources that can be managed with the Helm tool.
7+
A package of pre-configured Kubernetes configurations that can be managed with the Helm tool.
88
99
aka:
1010
tags:
1111
- tool
1212
---
13-
A package of pre-configured Kubernetes resources that can be managed with the Helm tool.
13+
A package of pre-configured Kubernetes configurations that can be managed with the Helm tool.
1414

1515
<!--more-->
1616

content/en/docs/reference/glossary/horizontal-pod-autoscaler.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,17 @@ id: horizontal-pod-autoscaler
44
date: 2018-04-12
55
full_link: /docs/tasks/run-application/horizontal-pod-autoscale/
66
short_description: >
7-
An API resource that automatically scales the number of pod replicas based on targeted CPU utilization or custom metric targets.
7+
Object that automatically scales the number of pod replicas based on targeted resource utilization or custom metric targets.
88
99
aka:
1010
- HPA
1111
tags:
1212
- operation
1313
---
14-
An API resource that automatically scales the number of {{< glossary_tooltip term_id="pod" >}} replicas based on targeted CPU utilization or custom metric targets.
14+
An {{< glossary_tooltip text="object" term_id="object" >}} that automatically scales the number of {{< glossary_tooltip term_id="pod" >}} replicas,
15+
based on targeted {{< glossary_tooltip text="resource" term_id="infrastructure-resource" >}} utilization or custom metric targets.
1516

1617
<!--more-->
1718

18-
HPA is typically used with {{< glossary_tooltip text="ReplicationControllers" term_id="replication-controller" >}}, {{< glossary_tooltip text="Deployments" term_id="deployment" >}}, or {{< glossary_tooltip text="ReplicaSets" term_id="replica-set" >}}. It cannot be applied to objects that cannot be scaled, for example {{< glossary_tooltip text="DaemonSets" term_id="daemonset" >}}.
19+
HorizontalPodAutoscaler (HPA) is typically used with {{< glossary_tooltip text="Deployments" term_id="deployment" >}}, or {{< glossary_tooltip text="ReplicaSets" term_id="replica-set" >}}. It cannot be applied to objects that cannot be scaled, for example {{< glossary_tooltip text="DaemonSets" term_id="daemonset" >}}.
1920

content/en/docs/reference/glossary/kube-scheduler.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,6 @@ to run on.
1818
<!--more-->
1919

2020
Factors taken into account for scheduling decisions include:
21-
individual and collective resource requirements, hardware/software/policy
22-
constraints, affinity and anti-affinity specifications, data locality,
23-
inter-workload interference, and deadlines.
21+
individual and collective {{< glossary_tooltip text="resource" term_id="infrastructure-resource" >}}
22+
requirements, hardware/software/policy constraints, affinity and anti-affinity specifications,
23+
data locality, inter-workload interference, and deadlines.

content/en/docs/reference/glossary/limitrange.md

+7-3
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,12 @@ related:
1616
- container
1717

1818
---
19-
Provides constraints to limit resource consumption per {{< glossary_tooltip text="Containers" term_id="container" >}} or {{< glossary_tooltip text="Pods" term_id="pod" >}} in a namespace.
19+
Constraints resource consumption per {{< glossary_tooltip text="container" term_id="container" >}} or {{< glossary_tooltip text="Pod" term_id="pod" >}},
20+
specified for a particular {{< glossary_tooltip text="namespace" term_id="namespace" >}}.
2021

2122
<!--more-->
22-
LimitRange limits the quantity of objects that can be created by type,
23-
as well as the amount of compute resources that may be requested/consumed by individual {{< glossary_tooltip text="Containers" term_id="container" >}} or {{< glossary_tooltip text="Pods" term_id="pod" >}} in a namespace.
23+
24+
A [LimitRange](/docs/concepts/policy/limit-range/) either limits the quantity of {{< glossary_tooltip text="API resources" term_id="api-resource" >}}
25+
that can be created (for a particular resource type),
26+
or the amount of {{< glossary_tooltip text="infrastructure resources" term_id="infrastructure-resource" >}}
27+
that may be requested/consumed by individual containers or Pods within a namespace.

content/en/docs/reference/glossary/mixed-version-proxy.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,9 @@ Feature to let a kube-apiserver proxy a resource request to a different peer API
1313

1414
<!--more-->
1515

16-
When a cluster has multiple API servers running different versions of Kubernetes, this
17-
feature enables resource requests to be served by the correct API server.
16+
When a cluster has multiple API servers running different versions of Kubernetes, this
17+
feature enables {{< glossary_tooltip text="resource" term_id="api-resource" >}}
18+
requests to be served by the correct API server.
1819

1920
MVP is disabled by default and can be activated by enabling
2021
the [feature gate](/docs/reference/command-line-tools-reference/feature-gates/) named `UnknownVersionInteroperabilityProxy` when

content/en/docs/reference/glossary/name.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ aka:
1010
tags:
1111
- fundamental
1212
---
13-
A client-provided string that refers to an object in a resource URL, such as `/api/v1/pods/some-name`.
13+
A client-provided string that refers to an object in a {{< glossary_tooltip text="resource" term_id="api-resource" >}}
14+
URL, such as `/api/v1/pods/some-name`.
1415

1516
<!--more-->
1617

content/en/docs/reference/glossary/namespace.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,10 @@ aka:
1010
tags:
1111
- fundamental
1212
---
13-
An abstraction used by Kubernetes to support isolation of groups of resources within a single {{< glossary_tooltip text="cluster" term_id="cluster" >}}.
13+
An abstraction used by Kubernetes to support isolation of groups of {{< glossary_tooltip text="API resources" term_id="api-resource" >}}
14+
within a single {{< glossary_tooltip text="cluster" term_id="cluster" >}}.
1415

1516
<!--more-->
1617

17-
Namespaces are used to organize objects in a cluster and provide a way to divide cluster resources. Names of resources need to be unique within a namespace, but not across namespaces. Namespace-based scoping is applicable only for namespaced objects _(e.g. Deployments, Services, etc)_ and not for cluster-wide objects _(e.g. StorageClass, Nodes, PersistentVolumes, etc)_.
18+
Namespaces are used to organize objects in a cluster and provide a way to divide cluster resources. Names of resources need to be unique within a namespace, but not across namespaces. Namespace-based scoping is applicable only for namespaced resources _(for example: Pods, Deployments, Services)_ and not for cluster-wide resources _(for example: StorageClasses, Nodes, PersistentVolumes)_.
1819

content/en/docs/reference/glossary/network-policy.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,10 @@ tags:
1717

1818
<!--more-->
1919

20-
Network Policies help you declaratively configure which Pods are allowed to connect to each other, which namespaces are allowed to communicate, and more specifically which port numbers to enforce each policy on. `NetworkPolicy` resources use labels to select Pods and define rules which specify what traffic is allowed to the selected Pods. Network Policies are implemented by a supported network plugin provided by a network provider. Be aware that creating a network resource without a controller to implement it will have no effect.
20+
NetworkPolicies help you declaratively configure which Pods are allowed to connect to each other, which namespaces are allowed to communicate,
21+
and more specifically which port numbers to enforce each policy on. NetworkPolicy objects use {{< glossary_tooltip text="labels" term_id="label" >}}
22+
to select Pods and define rules which specify what traffic is allowed to the selected Pods.
23+
24+
NetworkPolicies are implemented by a supported network plugin provided by a network provider.
25+
Be aware that creating a NetworkPolicy object without a controller to implement it will have no effect.
2126

content/en/docs/reference/glossary/node-pressure-eviction.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@ tags:
1212
- operation
1313
---
1414
Node-pressure eviction is the process by which the {{<glossary_tooltip term_id="kubelet" text="kubelet">}} proactively terminates
15-
pods to reclaim resources on nodes.
15+
pods to reclaim {{< glossary_tooltip text="resource" term_id="infrastructure-resource" >}}
16+
on nodes.
1617

1718
<!--more-->
1819

content/en/docs/reference/glossary/operator-pattern.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ aka:
1010
tags:
1111
- architecture
1212
---
13-
The [operator pattern](/docs/concepts/extend-kubernetes/operator/) is a system
13+
The [operator pattern](/docs/concepts/extend-kubernetes/operator/) is a system
1414
design that links a {{< glossary_tooltip term_id="controller" >}} to one or more custom
1515
resources.
1616

content/en/docs/reference/glossary/persistent-volume-claim.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,9 @@ tags:
1111
- core-object
1212
- storage
1313
---
14-
Claims storage resources defined in a {{< glossary_tooltip text="PersistentVolume" term_id="persistent-volume" >}} so that it can be mounted as a volume in a {{< glossary_tooltip text="container" term_id="container" >}}.
14+
Claims storage {{< glossary_tooltip text="resources" term_id="infrastructure-resource" >}} defined in a
15+
{{< glossary_tooltip text="PersistentVolume" term_id="persistent-volume" >}}, so that the storage can be mounted as
16+
a volume in a {{< glossary_tooltip text="container" term_id="container" >}}.
1517

1618
<!--more-->
1719

content/en/docs/reference/glossary/persistent-volume.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,16 @@ id: persistent-volume
44
date: 2018-04-12
55
full_link: /docs/concepts/storage/persistent-volumes/
66
short_description: >
7-
An API object that represents a piece of storage in the cluster. Available as a general, pluggable resource that persists beyond the lifecycle of any individual Pod.
7+
API object that represents a piece of storage in the cluster.
88
99
aka:
1010
tags:
1111
- core-object
1212
- storage
1313
---
14-
An API object that represents a piece of storage in the cluster. Available as a general, pluggable resource that persists beyond the lifecycle of any individual {{< glossary_tooltip text="Pod" term_id="pod" >}}.
14+
An API object that represents a piece of storage in the cluster. Representation of as a general, pluggable storage
15+
{{< glossary_tooltip text="resource" term_id="infrastructure-resource" >}} that can persist beyond the lifecycle of any
16+
individual {{< glossary_tooltip text="Pod" term_id="pod" >}}.
1517

1618
<!--more-->
1719

content/en/docs/reference/glossary/pod-disruption.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,5 @@ Pods on Nodes are terminated either voluntarily or involuntarily.
2121

2222
Voluntary disruptions are started intentionally by application owners or cluster
2323
administrators. Involuntary disruptions are unintentional and can be triggered by
24-
unavoidable issues like Nodes running out of resources, or by accidental deletions.
24+
unavoidable issues like Nodes running out of {{< glossary_tooltip text="resources" term_id="infrastructure-resource" >}},
25+
or by accidental deletions.

0 commit comments

Comments
 (0)