cloud-init-dev team mailing list archive

[Jason Butz <jasonbutz@xxxxxxxxx>]

Jason Butz has proposed merging ~jasonbutz/cloud-init:user-data-include-file-format-documentation into cloud-init:master.

Commit message:
Explain Error Behavior In User Data Include File Format

While troubleshooting an issue with a deploy I discovered that
if an error occurs while reading a file there will not be any attempts
to read any other files listed. This behavior makes logical sense as the
order of scripts may be important. However, I could not find this
behavior documented anywhere.

I wish to add this information to the documentation to aid others in
troubleshooting issues they may run into.

Requested reviews:
  cloud-init commiters (cloud-init-dev)

For more details, see:
https://code.launchpad.net/~jasonbutz/cloud-init/+git/cloud-init/+merge/329595
-- 
Your team cloud-init commiters is requested to review the proposed merge of ~jasonbutz/cloud-init:user-data-include-file-format-documentation into cloud-init:master.

diff --git a/doc/rtd/topics/format.rst b/doc/rtd/topics/format.rst
index 436eb00..e25289a 100644
--- a/doc/rtd/topics/format.rst
+++ b/doc/rtd/topics/format.rst
@@ -85,6 +85,7 @@ This content is a ``include`` file.
 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.
 Ie, 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.
 
 Begins with: ``#include`` or ``Content-Type: text/x-include-url``  when using a MIME archive.