doc: Update docs on boothooks #5541
Conversation
Address the concern in canonical#4542
aciba90
force-pushed
the
boothook_docs_update
branch
from
54fce9d
to
2a32e18
Compare
SC-1657 Fixes canonicalGH-4542
aciba90
force-pushed
the
boothook_docs_update
branch
from
2a32e18
to
15cbfaf
Compare
There was a problem hiding this comment.
Hmmm...I'm currently overhauling the user formats page per #4739 and a separate entry in our spreadsheet.
Is there any way we can just capture the new info here but remove any of the non-boothook related changes or formatting changes?
| The file contains a list of URLs, one per line. Each of the URLs will be read | ||
| and their content will be passed through this same set of rules, i.e., the | ||
| content read from the URL can be gzipped, MIME multi-part, or plain text. If | ||
| an error occurs reading a file the remaining files will not be read. |
There was a problem hiding this comment.
what is meant by "set of rules". and why is it the same for all urls? This might need re-written for dummies like me :P
| :ref:`Network boot stage<boot-Network>`, even before ``cc_bootcmd``. | ||
|
|
||
| This can be used when something has to be configured very early on boot, | ||
| potentially on every boot, with less convenience as ``cc_bootcmd`` but more |
There was a problem hiding this comment.
| potentially on every boot, with less convenience as ``cc_bootcmd`` but more | |
| potentially on every boot, with less convenience than ``cc_bootcmd``, but more |
| flexibility. | ||
|
|
||
| .. note:: | ||
| Boothooks are execute on every boot. |
There was a problem hiding this comment.
| Boothooks are execute on every boot. | |
| Boothooks are executed on every boot. |
| Boothooks are execute on every boot. | ||
| The environment variable ``INSTANCE_ID`` will be set to the current instance | ||
| ID. ``INSTANCE_ID`` can be used to implement a `once-per-instance` type of | ||
| functionality. |
There was a problem hiding this comment.
maybe add a final little sentence saying as demonstrated below in [link to "Example of once-per-instance script" section]
| @@ -121,6 +193,48 @@ The :command:`make-mime` subcommand takes pairs of (filename, "text/" mime | |||
| subtype) separated by a colon (e.g., ``config.yaml:cloud-config``) and emits a | |||
| MIME multipart message to :file:`stdout`. | |||
|
|
|||
| User data format to Mime Content type mapping | |||
There was a problem hiding this comment.
should "Mime Content" be lowercase?
| +----------------------------+----------------------------+ | ||
| | x-shellscript-per-boot | x-shellscript-per-boot | | ||
| +----------------------------+----------------------------+ | ||
|
|
There was a problem hiding this comment.
I think i might just be dense or have overlooked something, but I am unsure of what to do with this information now.
Where do I put Content-Type: text/<content-type>? I just don't know how or where this is used. "content-type" doesn't seem to appear really anywhere else in these docs.
|
|
||
| Content-Type: text/<content-type> | ||
|
|
||
| Below is a mapping of a specific user data format to the `content-type` |
There was a problem hiding this comment.
Not sure if this in an improvement but still i feel like this sentence is a little bit confusing.
| Below is a mapping of a specific user data format to the `content-type` | |
| Below is a mapping of each specific user data format to the `content-type` |
I have created #5546 with only changes related to boothook, please feel free to merge, integrate it in your PR or whatever, thanks! Closing this one. |
Proposed Commit Message
Additional Context
This PR builds-up on top of #4650.
Test Steps
Merge type