Skip to content

Conversation

@holmanb
Copy link
Member

@holmanb holmanb commented Nov 10, 2023

Summary

User, developer, and maintainer confusion regarding the naming of cloud-init services makes reasoning and communicating about cloud-init stages unnecessarily confusing. This is a proposal to change cloud-init's stages to a clearer standard of names.

Additional Context

There are lots of examples of confusion regarding current names. This change will require a downstream patch in Ubuntu and require distro changes for any distro which carries downstream packaging. I'm happy to help drive those externally too, to get to a cleaner commandline interface so we can spend less time explaining points of confusion in this awful stage naming convention to users and collaborators.

Please do note that the final say of whether this change lands ultimately rests in the hands of those that are much more familiar and comfortable with our current names than those who will benefit the most: our users, first time or infrequent contributors, or external projects trying to interact with cloud-init.

Docs, test, and manpage changes will not be implemented until feedback has been gathered regarding this change. A forum for discussion regarding this change is available on the page of the public specification for this change.

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>)

The name of this systemd service causes endless confusion.

A sysadmin might reasonably assume that cloud-init can be controlled via:

    systemctl {stop,start,restart} cloud-init

Bug reports regularly include commands like that.

This is especially confusing because cloud-init.service completes before
cloud-config.target, but cloud-config.service completes before
cloud-config.target.

Unify all vocabulary about cloud-init's stages to align with the
ordering:

    init-local -> init-network, init-config, init-final

Reducing the duplicate name will make future bug reporting, intuitive
use of, and conversation about cloud-init ordering much simpler.
@holmanb holmanb force-pushed the holmanb/unify-service-names branch 3 times, most recently from 603fbda to 609ba0a Compare November 11, 2023 02:44
@holmanb holmanb force-pushed the holmanb/unify-service-names branch from bda8e9e to 32edcc4 Compare November 14, 2023 10:20
Using multiple different conflicting names for the same things causes
endless confusion. Standardize the commandline interface.
@holmanb holmanb force-pushed the holmanb/unify-service-names branch from 32edcc4 to e9dee69 Compare November 14, 2023 11:32
@github-actions
Copy link

Hello! Thank you for this proposed change to cloud-init. This pull request is now marked as stale as it has not seen any activity in 14 days. If no activity occurs within the next 7 days, this pull request will automatically close.

If you are waiting for code review and you are seeing this message, apologies! Please reply, tagging TheRealFalcon, and he will ensure that someone takes a look soon.

(If the pull request is closed and you would like to continue working on it, please do tag TheRealFalcon to reopen it.)

@github-actions github-actions bot added the stale-pr Pull request is stale; will be auto-closed soon label Nov 29, 2023
@holmanb holmanb removed the stale-pr Pull request is stale; will be auto-closed soon label Nov 29, 2023
@github-actions
Copy link

Hello! Thank you for this proposed change to cloud-init. This pull request is now marked as stale as it has not seen any activity in 14 days. If no activity occurs within the next 7 days, this pull request will automatically close.

If you are waiting for code review and you are seeing this message, apologies! Please reply, tagging TheRealFalcon, and he will ensure that someone takes a look soon.

(If the pull request is closed and you would like to continue working on it, please do tag TheRealFalcon to reopen it.)

@github-actions github-actions bot added the stale-pr Pull request is stale; will be auto-closed soon label Dec 14, 2023
@holmanb holmanb removed the stale-pr Pull request is stale; will be auto-closed soon label Dec 14, 2023
@github-actions
Copy link

github-actions bot commented Jan 4, 2024

Hello! Thank you for this proposed change to cloud-init. This pull request is now marked as stale as it has not seen any activity in 14 days. If no activity occurs within the next 7 days, this pull request will automatically close.

If you are waiting for code review and you are seeing this message, apologies! Please reply, tagging TheRealFalcon, and he will ensure that someone takes a look soon.

(If the pull request is closed and you would like to continue working on it, please do tag TheRealFalcon to reopen it.)

@github-actions github-actions bot added the stale-pr Pull request is stale; will be auto-closed soon label Jan 4, 2024
@holmanb holmanb removed the stale-pr Pull request is stale; will be auto-closed soon label Jan 5, 2024
@TheRealFalcon
Copy link
Contributor

@holmanb , I'm not really sure what to do with this PR. Conceptually, it's a great idea, but it also feels like a monumental change to just merge any time soon. Also, depending on how much of this gets patched out, that will be a fairly significant maintenance burden for existing distros for a fairly long time.

In your linked spec, you mention:

If this progresses, I intend to reach out to those communities that I am familiar with to notify them in advance of these required changes

Do you think it's worth reaching out to impacted maintainers first? We have the discourse spec, but I'm not sure very many people have actually seen it. At the very least, I think we need another discussion with the rest of the cloud-init upstream devs to determine if we think it is worth the maintenance from our end.

If that's not happening anytime soon, I'm thinking it might be better to close this PR. The branch still exists and can be viewed/modified as needed. Otherwise this branch will just sit here collecting merge conflicts and stale PR checks.

@holmanb
Copy link
Member Author

holmanb commented Jan 8, 2024

If that's not happening anytime soon, I'm thinking it might be better to close this PR.

Fair enough, sounds good

@holmanb holmanb closed this Jan 8, 2024
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.

2 participants