Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc(upgrade): auto image cleanup not working in some upgrade paths #644

Merged
merged 1 commit into from
Oct 7, 2024

Conversation

starbops
Copy link
Member

Adding notes about the automatic image cleanup issue for the following upgrade paths:

  • Upgrading from v1.3.1 to v1.3.2
  • Upgrading from v1.2.2 to v1.3.1

Related issue: harvester/harvester#6620

Copy link

github-actions bot commented Sep 25, 2024

Name Link
🔨 Latest commit 3745440
😎 Deploy Preview https://67034fc42c58db128474bf9d--harvester-preview.netlify.app

@starbops starbops marked this pull request as ready for review September 25, 2024 03:32
Copy link
Member

@bk201 bk201 left a comment

Choose a reason for hiding this comment

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

LGTM!

Copy link
Member

@w13915984028 w13915984028 left a comment

Choose a reason for hiding this comment

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

LGTM, thanks.

Copy link
Contributor

@jillian-maroket jillian-maroket left a comment

Choose a reason for hiding this comment

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

Let me know if you have concerns about the changes.


### 2. Automatic image cleanup is not functioning

Due to an incomplete image list packaged in the published ISO image, the automatic image cleanup procedure will not work when users upgrade Harvester from v1.2.2 to v1.3.1. This does not impact the Harvester upgrade as a whole. To clean up container images manually after the upgrade ends, please refer to the [script](https://github.com/harvester/upgrade-helpers/blob/main/bin/harv-purge-images.sh). For more information, see [issue #6620](https://github.com/harvester/harvester/issues/6620).
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Due to an incomplete image list packaged in the published ISO image, the automatic image cleanup procedure will not work when users upgrade Harvester from v1.2.2 to v1.3.1. This does not impact the Harvester upgrade as a whole. To clean up container images manually after the upgrade ends, please refer to the [script](https://github.com/harvester/upgrade-helpers/blob/main/bin/harv-purge-images.sh). For more information, see [issue #6620](https://github.com/harvester/harvester/issues/6620).
Automatic image cleanup, which is part of the upgrade process, cannot be performed if an incomplete image list is packaged in the published Harvester ISO. This issue does not block the upgrade, and you can use a [script](https://github.com/harvester/upgrade-helpers/blob/main/bin/harv-purge-images.sh) to manually clean up container images after the upgrade is completed. For more information, see [issue #6620](https://github.com/harvester/harvester/issues/6620).

Copy link
Member Author

Choose a reason for hiding this comment

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

Sorry, I cannot tell the vibe of the suggested version here. I'll make my point: it's our oversight not to pack the image list in the ISO image. It's not the user's misoperation that causes the issue, and they're not expected to do anything to fix it. Also, only the affected upgrade paths will have this known issue updated in their respective documentation pages, so I think there's no need to generalize it by adding an "if." Please ignore the comment if I totally get your point wrong. Thank you.

Copy link
Contributor

Choose a reason for hiding this comment

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

I was not going for a specific "vibe". I simply misunderstood what supposedly happens. Here's the new suggestion:

Because the published Harvester ISO contains an incomplete image list, automatic image cleanup cannot be performed during an upgrade from v1.2.2 to v1.3.1. This issue does not block the upgrade, and you can use this script to manually clean up container images after the upgrade is completed. For more information, see issue #6620.

Copy link
Member Author

Choose a reason for hiding this comment

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

I updated the paragraph according to the suggestion. Thank you.

Copy link
Contributor

@jillian-maroket jillian-maroket left a comment

Choose a reason for hiding this comment

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

I edited the suggestion.


### 2. Automatic image cleanup is not functioning

Due to an incomplete image list packaged in the published ISO image, the automatic image cleanup procedure will not work when users upgrade Harvester from v1.2.2 to v1.3.1. This does not impact the Harvester upgrade as a whole. To clean up container images manually after the upgrade ends, please refer to the [script](https://github.com/harvester/upgrade-helpers/blob/main/bin/harv-purge-images.sh). For more information, see [issue #6620](https://github.com/harvester/harvester/issues/6620).
Copy link
Contributor

Choose a reason for hiding this comment

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

I was not going for a specific "vibe". I simply misunderstood what supposedly happens. Here's the new suggestion:

Because the published Harvester ISO contains an incomplete image list, automatic image cleanup cannot be performed during an upgrade from v1.2.2 to v1.3.1. This issue does not block the upgrade, and you can use this script to manually clean up container images after the upgrade is completed. For more information, see issue #6620.

Adding notes about the automatic image cleanup issue for the following upgrade paths:
- Upgrading from v1.3.1 to v1.3.2
- Upgrading from v1.2.2 to v1.3.1

Signed-off-by: Zespre Chang <zespre.chang@suse.com>
Co-authored-by: Jillian <67180770+jillian-maroket@users.noreply.github.com>
@starbops starbops merged commit 626253a into harvester:main Oct 7, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants