Skip to content

OCPBUGS50980 Need to make changes in the garbage collection documentation#89161

Merged
mburke5678 merged 1 commit intoopenshift:mainfrom
mburke5678:nodes-garbage-collect-fix
Mar 7, 2025
Merged

OCPBUGS50980 Need to make changes in the garbage collection documentation#89161
mburke5678 merged 1 commit intoopenshift:mainfrom
mburke5678:nodes-garbage-collect-fix

Conversation

@mburke5678
Copy link
Contributor

@mburke5678 mburke5678 commented Feb 25, 2025

https://issues.redhat.com/browse/OCPBUGS-50980

mention that the imageGCHighThresholdPercent and imageGCLowThresholdPercent should have different values, when they are provided with the same values the kubelet crashes and node goes to NotReady state.

QE review:

  • QE has approved this change.

@ocpdocs-previewbot
Copy link

ocpdocs-previewbot commented Feb 25, 2025

@arnaik-rh
Copy link

@lyman9966 Please work on this.

<9> For image garbage collection: The percent of disk usage (expressed as an integer) that triggers image garbage collection.
<10> For image garbage collection: The percent of disk usage (expressed as an integer) that image garbage collection attempts to free.
<9> For image garbage collection: The percent of disk usage (expressed as an integer) that triggers image garbage collection. This value must be greater than the `imageGCLowThresholdPercent` value.
<10> For image garbage collection: The percent of disk usage (expressed as an integer) that image garbage collection attempts to free. This value must be less than the `imageGCHighThresholdPercent` value.
Copy link

@lyman9966 lyman9966 Feb 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's more correct to modify as:
<10> For image garbage collection: The percent of disk usage (expressed as an integer), to which image garbage collection attempts to free
It means image garbage collection attempts to free the disk usage to this value.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

others looks good to me

@lyman9966
Copy link

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Feb 28, 2025
@mburke5678 mburke5678 force-pushed the nodes-garbage-collect-fix branch from 0cc6e65 to c82d93e Compare March 3, 2025 14:20
@openshift-ci openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label Mar 3, 2025
@openshift-ci
Copy link

openshift-ci bot commented Mar 3, 2025

New changes are detected. LGTM label has been removed.

@mburke5678 mburke5678 added the peer-review-needed Signifies that the peer review team needs to review this PR label Mar 3, 2025
@openshift-ci
Copy link

openshift-ci bot commented Mar 3, 2025

@mburke5678: all tests passed!

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

@mramendi
Copy link
Contributor

mramendi commented Mar 3, 2025

/label peer-review-in-progress
/remove-label peer-review-needed

@openshift-ci openshift-ci bot added peer-review-in-progress Signifies that the peer review team is reviewing this PR and removed peer-review-needed Signifies that the peer review team needs to review this PR labels Mar 3, 2025
Copy link
Contributor

@mramendi mramendi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few peer review nits, fine otherwise, great work

<8> For image garbage collection: The minimum age for an unused image before the image is removed by garbage collection.
<9> For image garbage collection: The percent of disk usage (expressed as an integer) that triggers image garbage collection.
<10> For image garbage collection: The percent of disk usage (expressed as an integer) that image garbage collection attempts to free.
<9> For image garbage collection: Image garbage collection is triggered at the specified percent of disk usage (expressed as an integer). This value must be greater than the `imageGCLowThresholdPercent` value.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why did you change active voice to passive voice? "Percentage of disk usage (expressed as an integer) that triggers the image garbage collection" looks better to me, though it's your call. The new sentence is fine.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mramendi I changed this one to make the language parallel with <10>.

<9> For image garbage collection: The percent of disk usage (expressed as an integer) that triggers image garbage collection.
<10> For image garbage collection: The percent of disk usage (expressed as an integer) that image garbage collection attempts to free.
<9> For image garbage collection: Image garbage collection is triggered at the specified percent of disk usage (expressed as an integer). This value must be greater than the `imageGCLowThresholdPercent` value.
<10> For image garbage collection: Image garbage collection attempts to free resources to the specified percent of disk usage (expressed as an integer). This value must be less than the `imageGCHighThresholdPercent` value.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is not entirely clear if this means that (a) it aims to have the remaining usage of this percent or (b) it attempts to free this percent (so in the example, to free 75% of the disk, leaving 25% used).

The previous formula reads as (b). I suspect the true reading is (a). Ideally, if you don't have this answer handy, could you possibly find out from the SMEs and then clarify the text?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mramendi
According to QE:

It means image garbage collection attempts to free the disk usage to this value.

|`imageGCLowThresholdPercent`
|The percent of disk usage, expressed as an integer, to which image garbage
collection attempts to free. The default is *80*.
collection attempts to free. The default is *80*. This value must be less than the `imageGCHighThresholdPercent` value.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"must be smaller than", I'd suggest.

@mramendi
Copy link
Contributor

mramendi commented Mar 3, 2025

/label peer-review-done
/remove-label peer-review-in-progress

@openshift-ci openshift-ci bot added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-in-progress Signifies that the peer review team is reviewing this PR labels Mar 3, 2025
@mburke5678 mburke5678 merged commit b30d270 into openshift:main Mar 7, 2025
2 checks passed
@mburke5678 mburke5678 deleted the nodes-garbage-collect-fix branch March 7, 2025 18:12
@mburke5678
Copy link
Contributor Author

/cherrypick enterprise-4.12

@mburke5678
Copy link
Contributor Author

/cherrypick enterprise-4.13

@mburke5678
Copy link
Contributor Author

/cherrypick enterprise-4.14

@mburke5678
Copy link
Contributor Author

/cherrypick enterprise-4.15

@mburke5678
Copy link
Contributor Author

/cherrypick enterprise-4.16

@mburke5678
Copy link
Contributor Author

/cherrypick enterprise-4.17

@mburke5678
Copy link
Contributor Author

/cherrypick enterprise-4.18

@openshift-cherrypick-robot

@mburke5678: new pull request created: #89903

Details

In response to this:

/cherrypick enterprise-4.12

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@openshift-cherrypick-robot

@mburke5678: new pull request created: #89904

Details

In response to this:

/cherrypick enterprise-4.13

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@openshift-cherrypick-robot

@mburke5678: new pull request created: #89905

Details

In response to this:

/cherrypick enterprise-4.14

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@openshift-cherrypick-robot

@mburke5678: new pull request created: #89906

Details

In response to this:

/cherrypick enterprise-4.15

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@openshift-cherrypick-robot

@mburke5678: new pull request created: #89907

Details

In response to this:

/cherrypick enterprise-4.16

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@openshift-cherrypick-robot

@mburke5678: new pull request created: #89908

Details

In response to this:

/cherrypick enterprise-4.17

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@openshift-cherrypick-robot

@mburke5678: new pull request created: #89909

Details

In response to this:

/cherrypick enterprise-4.18

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@mburke5678
Copy link
Contributor Author

/cherrypick enterprise-4.19

@openshift-cherrypick-robot

@mburke5678: new pull request created: #89911

Details

In response to this:

/cherrypick enterprise-4.19

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants