docs: document per-frequency shell script MIME types#6891
Open
Ahmedaltu wants to merge 5 commits into
Open
Conversation
Add a dedicated subsection explaining text/x-shellscript-per-boot, text/x-shellscript-per-instance, and text/x-shellscript-per-once content types, including their execution frequency, on-disk script directories, and pointers to the handler and modules. Fixes canonical#6283 Signed-off-by: Ahmed Al-Tuwaijari <altuwaijari.ahmed@gmail.com>
There was a problem hiding this comment.
Pull request overview
Adds documentation to the MIME multi-part archive user-data format explaining the three per-frequency shell script MIME content types and where those scripts land on disk, with pointers to the relevant cloud-init modules/handler.
Changes:
- Document
text/x-shellscript-per-boot,text/x-shellscript-per-instance, andtext/x-shellscript-per-oncesemantics in the MIME docs. - Document the corresponding on-disk script directories under
/var/lib/cloud/scripts/. - Link the behavior to the
cc_scripts_per_*modules andcloudinit/handlers/shell_script_by_frequency.py.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+80
to
+85
| Per-frequency shell scripts | ||
| --------------------------- | ||
|
|
||
| Cloud-init supports three MIME content types for controlling how often a | ||
| shell script runs: | ||
|
|
Author
There was a problem hiding this comment.
Good point. The issue also requested rows in the content-type table and a multipart example. I can add those in a follow-up commit if the maintainers consider it in scope for this PR, or open a separate PR for those additions.
…only Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Ahmed Al-Tuwaijari <altuwaijari.ahmed@gmail.com>
…hmedaltu/cloud-init into docs/per-script-frequencies-v2
holmanb
requested changes
May 27, 2026
Signed-off-by: Ahmed Al-Tuwaijari <altuwaijari.ahmed@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add a dedicated subsection to the MIME multi-part archive documentation
explaining the three per-frequency shell script MIME types:
Includes on-disk script directories and pointers to the handler
(cloudinit/handlers/shell_script_by_frequency.py) and the relevant
modules.
Fixes #6283