From f3ca430d94ea07764c1caa16cb7078766796d314 Mon Sep 17 00:00:00 2001 From: Benjamin Gilbert Date: Fri, 21 Feb 2020 12:04:58 -0500 Subject: [PATCH] docs: document inline property on files[].append[] It's possible to append inline contents but this wasn't documented. --- docs/configuration-v1_0.md | 3 ++- docs/configuration-v1_1-exp.md | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/configuration-v1_0.md b/docs/configuration-v1_0.md index 6c6a41a3..911fdef2 100644 --- a/docs/configuration-v1_0.md +++ b/docs/configuration-v1_0.md @@ -61,7 +61,8 @@ The Fedora CoreOS configuration is a YAML document conforming to the following s * **_hash_** (string): the hash of the config, in the form `-` where type is `sha512`. * **_append_** (list of objects): list of contents to be appended to the file. Follows the same stucture as `contents` * **_compression_** (string): the type of compression used on the contents (null or gzip). Compression cannot be used with S3. - * **_source_** (string): the URL of the contents to append. Supported schemes are `http`, `https`, `tftp`, `s3`, and [`data`][rfc2397]. When using `http`, it is advisable to use the verification option to ensure the contents haven't been modified. + * **_source_** (string): the URL of the contents to append. Supported schemes are `http`, `https`, `tftp`, `s3`, and [`data`][rfc2397]. When using `http`, it is advisable to use the verification option to ensure the contents haven't been modified. Mutually exclusive with `inline`. + * **_inline_** (string): the contents to append. Mutually exclusive with `source`. * **_verification_** (object): options related to the verification of the appended contents. * **_hash_** (string): the hash of the config, in the form `-` where type is `sha512`. * **_mode_** (integer): the file's permission mode. If not specified, the permission mode for files defaults to 0644 or the existing file's permissions if `overwrite` is false, `source` is unspecified, and a file already exists at the path. diff --git a/docs/configuration-v1_1-exp.md b/docs/configuration-v1_1-exp.md index cea0f85d..ec32632c 100644 --- a/docs/configuration-v1_1-exp.md +++ b/docs/configuration-v1_1-exp.md @@ -69,7 +69,8 @@ The Fedora CoreOS configuration is a YAML document conforming to the following s * **_hash_** (string): the hash of the config, in the form `-` where type is `sha512`. * **_append_** (list of objects): list of contents to be appended to the file. Follows the same stucture as `contents` * **_compression_** (string): the type of compression used on the contents (null or gzip). Compression cannot be used with S3. - * **_source_** (string): the URL of the contents to append. Supported schemes are `http`, `https`, `tftp`, `s3`, and [`data`][rfc2397]. When using `http`, it is advisable to use the verification option to ensure the contents haven't been modified. + * **_source_** (string): the URL of the contents to append. Supported schemes are `http`, `https`, `tftp`, `s3`, and [`data`][rfc2397]. When using `http`, it is advisable to use the verification option to ensure the contents haven't been modified. Mutually exclusive with `inline`. + * **_inline_** (string): the contents to append. Mutually exclusive with `source`. * **_verification_** (object): options related to the verification of the appended contents. * **_hash_** (string): the hash of the config, in the form `-` where type is `sha512`. * **_mode_** (integer): the file's permission mode. If not specified, the permission mode for files defaults to 0644 or the existing file's permissions if `overwrite` is false, `source` is unspecified, and a file already exists at the path.