Find the right syntax for your YAML multiline strings:
There are two types of formats that YAML supports for strings: block scalar and flow scalar formats. (Scalars are what YAML calls basic values like numbers or strings, as opposed to complex types like arrays or objects.) Block scalars have more control over how they are interpreted, whereas flow scalars have more limited escaping support.
-
Block Style Indicator: The block style indicates how newlines inside the block should behave. If you would like them to be kept as newlines, use the literal style, indicated by a pipe (
|). If instead you want them to be replaced by spaces, use the folded style, indicated by a right angle bracket (>). (To get a newline using the folded style, leave a blank line by putting two newlines in. Lines with extra indentation are also not folded.) -
Block Chomping Indicator: The chomping indicator controls what should happen with newlines at the end of the string. The default, clip, puts a single newline at the end of the string. To remove all newlines, strip them by putting a minus sign (
-) after the style indicator. Both clip and strip ignore how many newlines are actually at the end of the block; to keep them all put a plus sign (+) after the style indicator.
Replace newlines with space, add single newline at end: >
Keep newlines, add single newline at end: |
Replace newlines with spaces, but don't add newline at end: >-
Keep newlines, but no newline at end: |-
Replace newlines with spaces, keep all newlines (if there are more than one) at the end: >+
Keep all newlines everywhere, even at the end: |+
Tags: #ansible #yaml #multiline