Skip to content

Commit 1459157

Browse files
author
Michael Burke
committed
OCPBUGS-12917: Garbage Collection add descriptions of each type
1 parent 737a435 commit 1459157

File tree

3 files changed

+14
-11
lines changed

3 files changed

+14
-11
lines changed

modules/nodes-nodes-garbage-collection-configuring.adoc

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ You can configure any combination of the following:
2121
* Hard eviction for containers
2222
* Eviction for images
2323
24+
Container garbage collection removes terminated containers. Image garbage collection removes images that are not referenced by any running pods.
25+
2426
.Prerequisites
2527

2628
. Obtain the label associated with the static `MachineConfigPool` CRD for the type of node you want to configure by entering the following command:
@@ -106,15 +108,15 @@ spec:
106108
----
107109
<1> Name for the object.
108110
<2> Specify the label from the machine config pool.
109-
<3> Type of eviction: `evictionSoft` or `evictionHard`.
110-
<4> Eviction thresholds based on a specific eviction trigger signal.
111-
<5> Grace periods for the soft eviction. This parameter does not apply to `eviction-hard`.
112-
<6> Eviction thresholds based on a specific eviction trigger signal.
111+
<3> For container garbage collection: Type of eviction: `evictionSoft` or `evictionHard`.
112+
<4> For container garbage collection: Eviction thresholds based on a specific eviction trigger signal.
113+
<5> For container garbage collection: Grace periods for the soft eviction. This parameter does not apply to `eviction-hard`.
114+
<6> For container garbage collection: Eviction thresholds based on a specific eviction trigger signal.
113115
For `evictionHard` you must specify all of these parameters. If you do not specify all parameters, only the specified parameters are applied and the garbage collection will not function properly.
114-
<7> The duration to wait before transitioning out of an eviction pressure condition.
115-
<8> The minimum age for an unused image before the image is removed by garbage collection.
116-
<9> The percent of disk usage (expressed as an integer) that triggers image garbage collection.
117-
<10> The percent of disk usage (expressed as an integer) that image garbage collection attempts to free.
116+
<7> For container garbage collection: The duration to wait before transitioning out of an eviction pressure condition.
117+
<8> For image garbage collection: The minimum age for an unused image before the image is removed by garbage collection.
118+
<9> For image garbage collection: The percent of disk usage (expressed as an integer) that triggers image garbage collection.
119+
<10> For image garbage collection: The percent of disk usage (expressed as an integer) that image garbage collection attempts to free.
118120

119121
. Run the following command to create the CR:
120122
+

modules/nodes-nodes-garbage-collection-containers.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
[id="nodes-nodes-garbage-collection-containers_{context}"]
99
= Understanding how terminated containers are removed through garbage collection
1010

11-
Container garbage collection can be performed using eviction thresholds.
11+
Container garbage collection removes terminated containers by using eviction thresholds.
1212

1313
When eviction thresholds are set for garbage collection, the node tries to keep any container for any pod accessible from the API. If the pod has been deleted, the containers will be as well. Containers are preserved as long the pod is not deleted and the eviction threshold is not reached. If the node is under disk pressure, it will remove containers and their logs will no longer be accessible using `oc logs`.
1414

modules/nodes-nodes-garbage-collection-images.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,9 @@
77
[id="nodes-nodes-garbage-collection-images_{context}"]
88
= Understanding how images are removed through garbage collection
99

10-
Image garbage collection relies on disk usage as reported by *cAdvisor* on the
11-
node to decide which images to remove from the node.
10+
Image garbage collection removes images that are not referenced by any running pods.
11+
12+
{produt-title} determines which images to remove from a node based on the disk usage that is reported by *cAdvisor*.
1213

1314
The policy for image garbage collection is based on two conditions:
1415

0 commit comments

Comments
 (0)