Skip to content

Commit 12ca8f1

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 c566908 commit 12ca8f1

30 files changed

+101
-66
lines changed

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

Lines changed: 5 additions & 2 deletions
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

Lines changed: 2 additions & 1 deletion
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

Lines changed: 1 addition & 1 deletion
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

Lines changed: 1 addition & 1 deletion
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

Lines changed: 4 additions & 2 deletions
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

Lines changed: 2 additions & 1 deletion
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

Lines changed: 2 additions & 2 deletions
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/ephemeral-container.md

Lines changed: 3 additions & 1 deletion
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

Lines changed: 6 additions & 6 deletions
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

Lines changed: 5 additions & 3 deletions
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.

0 commit comments

Comments
 (0)