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

Clarify subiquity docs #5957

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

holmanb
Copy link
Member

@holmanb holmanb commented Jan 9, 2025

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

Cloud-init ignores this key and its contents. Dispell confusion with clearer
messaging and more user-friendly language.
Schema validation is automatically checked and reported through
cloud-init status. Eliminate unnecessary manual verification as well as
the autoinstall key check which is unnecessary due to activation_key.
@github-actions github-actions bot added the documentation This Pull Request changes documentation label Jan 9, 2025
@@ -73,14 +46,6 @@ class TestHandleAutoinstall:
@pytest.mark.parametrize(
"cfg,snap_list,subp_calls,logs,snap_wait_called",
[
pytest.param(
Copy link
Member Author

@holmanb holmanb Jan 9, 2025

Choose a reason for hiding this comment

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

This never happens in the codebase due to activate_by_schema_keys: autoinstall.

@holmanb holmanb force-pushed the holmanb/subiquity-docs branch from 0f463e9 to 578b76b Compare January 9, 2025 20:56
@@ -38,33 +38,6 @@
)


class TestvalidateConfigSchema:
Copy link
Member Author

Choose a reason for hiding this comment

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

Coverage on this module remains at 100% after removing these tests.

cloud-init on the target system. See
`the Ubuntu installer documentation <https://canonical-subiquity.readthedocs-hosted.com/en/latest/reference/autoinstall-reference.html#user-data>`_
for more information.
The autoinstaller might pass part of this configuration to cloud-init
Copy link
Contributor

Choose a reason for hiding this comment

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

We're using "Ubuntu installer" and "autoinstaller" interchangeably here - could we standardise on one for consistency?

Copy link
Contributor

@s-makin s-makin left a comment

Choose a reason for hiding this comment

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

Just one small nit, leaving a pre-emptive approval

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 Jan 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This Pull Request changes documentation stale-pr Pull request is stale; will be auto-closed soon
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants