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

pro: honor but warn on custom ubuntu_advantage in /etc/cloud/cloud.cfg #5030

Conversation

blackboxsw
Copy link
Collaborator

Add RENAMED_MODULES to allow support for custom /etc/cloud/cloud.cfg.d/* which may still contain the old ubuntu_advantage module name instead of ubuntu_pro.

While the typical package upgrade path would replace ubuntu_avantage with ubuntu_pro in /etc/cloud/cloud.cfg. It's possible a customer has a customized /etc/cloud/cloud.cfg that they do not wish to update with the version delivered by the cloud-init upstream package.

In cases where ubuntu_advantage is listed in system config, allow cloud-init to WARN about the rename, but still load and run ubuntu_pro.

Fixes GH-5019

Proposed Commit Message

<type>(optional scope): <summary>  # no more than 72 characters

A description of what the change being made is and why it is being
made if the summary line is insufficient.  This should be wrapped at
72 characters.

If you need to write multiple paragraphs, feel free.

Fixes GH-NNNNN (GitHub Issue number. Remove line if irrelevant)
LP: #NNNNNN (Launchpad bug number. Remove line if irrelevant)

Additional Context

Test Steps

Checklist

Merge type

  • Squash merge using "Proposed Commit Message"
  • Rebase and merge unique commits. Requires commit messages per-commit each referencing the pull request number (#<PR_NUM>)

cloudinit/config/modules.py Outdated Show resolved Hide resolved
@blackboxsw blackboxsw force-pushed the support-renamed-modules-in-stale-cloud-config branch from bcd738c to 7ec9f0e Compare March 8, 2024 17:00
@blackboxsw blackboxsw requested a review from holmanb March 8, 2024 17:02
@blackboxsw blackboxsw force-pushed the support-renamed-modules-in-stale-cloud-config branch 3 times, most recently from c25364a to bc23ca1 Compare March 8, 2024 17:32
Copy link
Member

@holmanb holmanb left a comment

Choose a reason for hiding this comment

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

One nit, otherwise LGTM. Thanks!

tests/integration_tests/modules/test_ubuntu_pro.py Outdated Show resolved Hide resolved
Add RENAMED_MODULES to allow support for custom /etc/cloud/cloud.cfg.d/*
which may still contain the old ubuntu_advantage module name instead of
ubuntu_pro.

While the typical package upgrade path would replace ubuntu_avantage
with ubuntu_pro in /etc/cloud/cloud.cfg. It's possible a customer has
a customized /etc/cloud/cloud.cfg that they do not wish to update
with the version delivered by the cloud-init upstream package.

In cases where ubuntu_advantage is listed in system config, allow
cloud-init to WARN about the rename, but still load and run ubuntu_pro.

Fixes canonicalGH-5019
@blackboxsw blackboxsw force-pushed the support-renamed-modules-in-stale-cloud-config branch from bc23ca1 to ff8c553 Compare March 9, 2024 04:07
@blackboxsw blackboxsw merged commit 3fd0e43 into canonical:main Mar 9, 2024
25 of 28 checks passed
holmanb pushed a commit to holmanb/cloud-init that referenced this pull request Mar 9, 2024
canonical#5030)

Add RENAMED_MODULES to allow support for custom /etc/cloud/cloud.cfg.d/*
which may still contain the old ubuntu_advantage module name instead of
ubuntu_pro.

While the typical package upgrade path would replace ubuntu_avantage
with ubuntu_pro in /etc/cloud/cloud.cfg. It's possible a customer has
a customized /etc/cloud/cloud.cfg that they do not wish to update
with the version delivered by the cloud-init upstream package.

In cases where ubuntu_advantage is listed in system config, allow
cloud-init to WARN about the rename, but still load and run ubuntu_pro.

Fixes canonicalGH-5019
holmanb pushed a commit to holmanb/cloud-init that referenced this pull request Mar 9, 2024
canonical#5030)

Add RENAMED_MODULES to allow support for custom /etc/cloud/cloud.cfg.d/*
which may still contain the old ubuntu_advantage module name instead of
ubuntu_pro.

While the typical package upgrade path would replace ubuntu_avantage
with ubuntu_pro in /etc/cloud/cloud.cfg. It's possible a customer has
a customized /etc/cloud/cloud.cfg that they do not wish to update
with the version delivered by the cloud-init upstream package.

In cases where ubuntu_advantage is listed in system config, allow
cloud-init to WARN about the rename, but still load and run ubuntu_pro.

Fixes canonicalGH-5019
@holmanb holmanb mentioned this pull request Mar 9, 2024
1 task
holmanb pushed a commit that referenced this pull request Mar 11, 2024
#5030)

Add RENAMED_MODULES to allow support for custom /etc/cloud/cloud.cfg.d/*
which may still contain the old ubuntu_advantage module name instead of
ubuntu_pro.

While the typical package upgrade path would replace ubuntu_avantage
with ubuntu_pro in /etc/cloud/cloud.cfg. It's possible a customer has
a customized /etc/cloud/cloud.cfg that they do not wish to update
with the version delivered by the cloud-init upstream package.

In cases where ubuntu_advantage is listed in system config, allow
cloud-init to WARN about the rename, but still load and run ubuntu_pro.

Fixes GH-5019
holmanb pushed a commit to holmanb/cloud-init that referenced this pull request Mar 12, 2024
canonical#5030)

Add RENAMED_MODULES to allow support for custom /etc/cloud/cloud.cfg.d/*
which may still contain the old ubuntu_advantage module name instead of
ubuntu_pro.

While the typical package upgrade path would replace ubuntu_avantage
with ubuntu_pro in /etc/cloud/cloud.cfg. It's possible a customer has
a customized /etc/cloud/cloud.cfg that they do not wish to update
with the version delivered by the cloud-init upstream package.

In cases where ubuntu_advantage is listed in system config, allow
cloud-init to WARN about the rename, but still load and run ubuntu_pro.

Fixes canonicalGH-5019
holmanb pushed a commit that referenced this pull request Mar 12, 2024
#5030)

Add RENAMED_MODULES to allow support for custom /etc/cloud/cloud.cfg.d/*
which may still contain the old ubuntu_advantage module name instead of
ubuntu_pro.

While the typical package upgrade path would replace ubuntu_avantage
with ubuntu_pro in /etc/cloud/cloud.cfg. It's possible a customer has
a customized /etc/cloud/cloud.cfg that they do not wish to update
with the version delivered by the cloud-init upstream package.

In cases where ubuntu_advantage is listed in system config, allow
cloud-init to WARN about the rename, but still load and run ubuntu_pro.

Fixes GH-5019
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.

ubuntu_advantage not valid as module key in base config after rename to ubuntu_pro
3 participants