Skip to content

Commit

Permalink
Merge pull request #80 from bgilbert/inline
Browse files Browse the repository at this point in the history
docs: document inline property on files[].append[]
  • Loading branch information
bgilbert authored Feb 21, 2020
2 parents 7c6c453 + f3ca430 commit 2cb12bd
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
3 changes: 2 additions & 1 deletion docs/configuration-v1_0.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 `<type>-<value>` 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 `<type>-<value>` 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.
Expand Down
3 changes: 2 additions & 1 deletion docs/configuration-v1_1-exp.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 `<type>-<value>` 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 `<type>-<value>` 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.
Expand Down

0 comments on commit 2cb12bd

Please sign in to comment.