Skip to content

Commit

Permalink
comments
Browse files Browse the repository at this point in the history
  • Loading branch information
TheRealFalcon committed Jul 25, 2024
1 parent 80e8a13 commit fd81070
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 7 deletions.
2 changes: 1 addition & 1 deletion doc/examples/part-handler.txt
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ def list_types():
def handle_part(data: Cloud, ctype: str, filename: str, payload: Any):
"""Handle a part with the given mime-type.

This function will get called mulltiple times. The first time is
This function will get called multiple times. The first time is
to allow any initial setup needed to handle parts. It will then get
called once for each part matching the mime-type returned by `list_types`.
Finally, it will get called one last time to allow for any final
Expand Down
13 changes: 7 additions & 6 deletions doc/rtd/explanation/format.rst
Original file line number Diff line number Diff line change
Expand Up @@ -94,8 +94,8 @@ User data script
**Explanation**

A user data script is a single shell script to be executed once per instance.
User data scripts are run relatively late in the boot process, after most
other cloud-init modules have run.
User data scripts are run relatively late in the boot process, during the
'modules:final' stage as part of the "cc_scripts_user" module.

.. _user_data_formats-cloud_boothook:

Expand Down Expand Up @@ -136,7 +136,8 @@ Cloud boothook
A cloud boothook is similar to a :ref:`user data script<user_data_script>`
in that it is a shell script run on boot. The boothook is different in that:

* It is run very early in boot, even before the ``cc_bootcmd`` module
* It is run very early in boot, during the 'init' stage, before any
cloud-init modules are run.
* It is run on every boot
* The environment variable ``INSTANCE_ID`` is set to the current instance ID
for use within the script.
Expand Down Expand Up @@ -247,19 +248,19 @@ Cloud config archive
#cloud-config-archive
- type: "text/cloud-boothook"
content: |
content: |
#!/bin/sh
echo "this is from a boothook." > /var/tmp/boothook.txt
- type: "text/cloud-config"
content: |
content: |
bootcmd:
- echo "this is from a cloud-config." > /var/tmp/bootcmd.txt
**Explanation**

A cloud-config-archive is a way to specify more than one type of data
using YAML. It can be seen as an alternative to building a MIME multi-part
archive manually.
archive for those that would prefer to use YAML.

The format is a list of dictionaries.

Expand Down

0 comments on commit fd81070

Please sign in to comment.