Skip to content

Commit

Permalink
Update garbage-collection.md
Browse files Browse the repository at this point in the history
The documentation about the feature gate  and option field "ImageMaximumGCAge" is misleading.
The option field for the kubelet configuration is camelCase and needs to start with a lowercase "i" instead of an uppercase "I" (like for the feature gate option).
  • Loading branch information
chillje committed Jun 13, 2024
1 parent 450e619 commit 9768237
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions content/en/docs/concepts/architecture/garbage-collection.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,10 +146,10 @@ regardless of disk usage. This is a kubelet setting that you configure for each

To configure the setting, enable the `ImageMaximumGCAge`
[feature gate](/docs/reference/command-line-tools-reference/feature-gates/) for the kubelet,
and also set a value for the `ImageMaximumGCAge` field in the kubelet configuration file.
and also set a value for the `imageMaximumGCAge` field in the kubelet configuration file.

The value is specified as a Kubernetes _duration_;
Valid time units for the `ImageMaximumGCAge` field in the kubelet configuration file are:
Valid time units for the `imageMaximumGCAge` field in the kubelet configuration file are:
- "ns" for nanoseconds
- "us" or "µs" for microseconds
- "ms" for milliseconds
Expand All @@ -163,7 +163,7 @@ which means 12 hours and 45 minutes.
{{< note >}}
This feature does not track image usage across kubelet restarts. If the kubelet
is restarted, the tracked image age is reset, causing the kubelet to wait the full
`ImageMaximumGCAge` duration before qualifying images for garbage collection
`imageMaximumGCAge` duration before qualifying images for garbage collection
based on image age.
{{< /note>}}

Expand Down Expand Up @@ -208,4 +208,4 @@ configure garbage collection:

* Learn more about [ownership of Kubernetes objects](/docs/concepts/overview/working-with-objects/owners-dependents/).
* Learn more about Kubernetes [finalizers](/docs/concepts/overview/working-with-objects/finalizers/).
* Learn about the [TTL controller](/docs/concepts/workloads/controllers/ttlafterfinished/) that cleans up finished Jobs.
* Learn about the [TTL controller](/docs/concepts/workloads/controllers/ttlafterfinished/) that cleans up finished Jobs.

0 comments on commit 9768237

Please sign in to comment.