Skip to content

Butane merge #631

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
vic1707 wants to merge 10 commits into
base: main
Choose a base branch
from
+507 −350
Open

Butane merge #631

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
882b4fa
Add new `local_butane` and `inline_butane` props
vic1707 Aug 1, 2025
df0f56e
move global translate function to avoid cycle imports
vic1707 Aug 2, 2025
7829756
extract ignition treatment
vic1707 Aug 2, 2025
299819b
handle both new merge cases
vic1707 Aug 2, 2025
b2c41ca
add the missing line, still cycle imports
vic1707 Aug 2, 2025
4021d10
solution for the import cycle
vic1707 Aug 3, 2025
56b588a
simplify TranslateResource
vic1707 Aug 3, 2025
c8dbe65
edit release notes
vic1707 Aug 3, 2025
ef1a297
missing validation logic for `inline_butane`
vic1707 Aug 3, 2025
1c19030
dedup translateButaneRessource
vic1707 Aug 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions base/v0_7_exp/schema.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,6 +210,8 @@ type Resource struct {
Inline *string `yaml:"inline"` // Added, not in ignition spec
Local *string `yaml:"local"` // Added, not in ignition spec
Verification Verification `yaml:"verification"`
InlineButane *string `yaml:"inline_butane"` // Added, not in ignition spec
LocalButane *string `yaml:"local_butane"` // Added, not in ignition spec
}

type SSHAuthorizedKey string
Expand Down
12 changes: 12 additions & 0 deletions docs/config-fcos-v1_7-exp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ The Fedora CoreOS configuration is a YAML document conforming to the following s
* **_source_** (string): the URL of the config. Supported schemes are `http`, `https`, `tftp`, `s3`, `arn`, `gs`, and [`data`](https://tools.ietf.org/html/rfc2397). When using `http`, it is advisable to use the verification option to ensure the contents haven't been modified. Mutually exclusive with `inline` and `local`.
* **_inline_** (string): the contents of the config. Mutually exclusive with `source` and `local`.
* **_local_** (string): a local path to the contents of the config, relative to the directory specified by the `--files-dir` command-line argument. Mutually exclusive with `source` and `inline`.
* **_inline_butane_** (string): the contents of the config. Mutually exclusive with `source` and `local`.
* **_local_butane_** (string): a local path to the contents of the config, relative to the directory specified by the `--files-dir` command-line argument. Mutually exclusive with `source` and `inline`.
* **_compression_** (string): the type of compression used on the config (null or gzip). Compression cannot be used with S3.
* **_http_headers_** (list of objects): a list of HTTP headers to be added to the request. Available for `http` and `https` source schemes only.
* **name** (string): the header name.
Expand All @@ -32,6 +34,8 @@ The Fedora CoreOS configuration is a YAML document conforming to the following s
* **_source_** (string): the URL of the config. Supported schemes are `http`, `https`, `tftp`, `s3`, `arn`, `gs`, and [`data`](https://tools.ietf.org/html/rfc2397). When using `http`, it is advisable to use the verification option to ensure the contents haven't been modified. Mutually exclusive with `inline` and `local`.
* **_inline_** (string): the contents of the config. Mutually exclusive with `source` and `local`.
* **_local_** (string): a local path to the contents of the config, relative to the directory specified by the `--files-dir` command-line argument. Mutually exclusive with `source` and `inline`.
* **_inline_butane_** (string): the contents of the config. Mutually exclusive with `source` and `local`.
* **_local_butane_** (string): a local path to the contents of the config, relative to the directory specified by the `--files-dir` command-line argument. Mutually exclusive with `source` and `inline`.
* **_compression_** (string): the type of compression used on the config (null or gzip). Compression cannot be used with S3.
* **_http_headers_** (list of objects): a list of HTTP headers to be added to the request. Available for `http` and `https` source schemes only.
* **name** (string): the header name.
Expand All @@ -47,6 +51,8 @@ The Fedora CoreOS configuration is a YAML document conforming to the following s
* **_source_** (string): the URL of the certificate bundle (in PEM format). The bundle can contain multiple concatenated certificates. Supported schemes are `http`, `https`, `tftp`, `s3`, `arn`, `gs`, and [`data`](https://tools.ietf.org/html/rfc2397). When using `http`, it is advisable to use the verification option to ensure the contents haven't been modified. Mutually exclusive with `inline` and `local`.
* **_inline_** (string): the contents of the certificate bundle (in PEM format). The bundle can contain multiple concatenated certificates. Mutually exclusive with `source` and `local`.
* **_local_** (string): a local path to the contents of the certificate bundle (in PEM format), relative to the directory specified by the `--files-dir` command-line argument. The bundle can contain multiple concatenated certificates. Mutually exclusive with `source` and `inline`.
* **_inline_butane_** (string): the contents of the certificate bundle. Mutually exclusive with `source` and `local`.
Copy link
Collaborator

@prestist prestist Aug 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, this feels odd; probably coming from the fact that the new fields are in "resource". (noting for self need to check about this)

Copy link
Contributor Author

@vic1707 vic1707 Aug 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe I can divide the Resource type?
One for "classic" ressources, another one for merged configs?

* **_local_butane_** (string): a local path to the contents of the certificate bundle, relative to the directory specified by the `--files-dir` command-line argument. Mutually exclusive with `source` and `inline`.
* **_compression_** (string): the type of compression used on the certificate bundle (null or gzip). Compression cannot be used with S3.
* **_http_headers_** (list of objects): a list of HTTP headers to be added to the request. Available for `http` and `https` source schemes only.
* **name** (string): the header name.
Expand Down Expand Up @@ -94,6 +100,8 @@ The Fedora CoreOS configuration is a YAML document conforming to the following s
* **_source_** (string): the URL of the file. Supported schemes are `http`, `https`, `tftp`, `s3`, `arn`, `gs`, and [`data`](https://tools.ietf.org/html/rfc2397). When using `http`, it is advisable to use the verification option to ensure the contents haven't been modified. If source is omitted and a regular file already exists at the path, Ignition will do nothing. If source is omitted and no file exists, an empty file will be created. Mutually exclusive with `inline` and `local`.
* **_inline_** (string): the contents of the file. Mutually exclusive with `source` and `local`.
* **_local_** (string): a local path to the contents of the file, relative to the directory specified by the `--files-dir` command-line argument. Mutually exclusive with `source` and `inline`.
* **_inline_butane_** (string): the contents of the file. Mutually exclusive with `source` and `local`.
* **_local_butane_** (string): a local path to the contents of the file, relative to the directory specified by the `--files-dir` command-line argument. Mutually exclusive with `source` and `inline`.
* **_compression_** (string): the type of compression used on the file (null or gzip). Compression cannot be used with S3.
* **_http_headers_** (list of objects): a list of HTTP headers to be added to the request. Available for `http` and `https` source schemes only.
* **name** (string): the header name.
Expand All @@ -104,6 +112,8 @@ The Fedora CoreOS configuration is a YAML document conforming to the following s
* **_source_** (string): the URL of the fragment. Supported schemes are `http`, `https`, `tftp`, `s3`, `arn`, `gs`, and [`data`](https://tools.ietf.org/html/rfc2397). When using `http`, it is advisable to use the verification option to ensure the contents haven't been modified. Mutually exclusive with `inline` and `local`.
* **_inline_** (string): the contents of the fragment. Mutually exclusive with `source` and `local`.
* **_local_** (string): a local path to the contents of the fragment, relative to the directory specified by the `--files-dir` command-line argument. Mutually exclusive with `source` and `inline`.
* **_inline_butane_** (string): the contents of the fragment. Mutually exclusive with `source` and `local`.
* **_local_butane_** (string): a local path to the contents of the fragment, relative to the directory specified by the `--files-dir` command-line argument. Mutually exclusive with `source` and `inline`.
* **_compression_** (string): the type of compression used on the fragment (null or gzip). Compression cannot be used with S3.
* **_http_headers_** (list of objects): a list of HTTP headers to be added to the request. Available for `http` and `https` source schemes only.
* **name** (string): the header name.
Expand Down Expand Up @@ -145,6 +155,8 @@ The Fedora CoreOS configuration is a YAML document conforming to the following s
* **_source_** (string): the URL of the key file. Supported schemes are `http`, `https`, `tftp`, `s3`, `arn`, `gs`, and [`data`](https://tools.ietf.org/html/rfc2397). When using `http`, it is advisable to use the verification option to ensure the contents haven't been modified. Mutually exclusive with `inline` and `local`.
* **_inline_** (string): the contents of the key file. Mutually exclusive with `source` and `local`.
* **_local_** (string): a local path to the contents of the key file, relative to the directory specified by the `--files-dir` command-line argument. Mutually exclusive with `source` and `inline`.
* **_inline_butane_** (string): the contents of the key file. Mutually exclusive with `source` and `local`.
* **_local_butane_** (string): a local path to the contents of the key file, relative to the directory specified by the `--files-dir` command-line argument. Mutually exclusive with `source` and `inline`.
* **_compression_** (string): the type of compression used on the key file (null or gzip). Compression cannot be used with S3.
* **_http_headers_** (list of objects): a list of HTTP headers to be added to the request. Available for `http` and `https` source schemes only.
* **name** (string): the header name.
Expand Down
10 changes: 10 additions & 0 deletions docs/config-fiot-v1_1-exp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ The Fedora IoT configuration is a YAML document conforming to the following spec
* **_source_** (string): the URL of the config. Supported schemes are `http`, `https`, `tftp`, `s3`, `arn`, `gs`, and [`data`](https://tools.ietf.org/html/rfc2397). When using `http`, it is advisable to use the verification option to ensure the contents haven't been modified. Mutually exclusive with `inline` and `local`.
* **_inline_** (string): the contents of the config. Mutually exclusive with `source` and `local`.
* **_local_** (string): a local path to the contents of the config, relative to the directory specified by the `--files-dir` command-line argument. Mutually exclusive with `source` and `inline`.
* **_inline_butane_** (string): the contents of the config. Mutually exclusive with `source` and `local`.
* **_local_butane_** (string): a local path to the contents of the config, relative to the directory specified by the `--files-dir` command-line argument. Mutually exclusive with `source` and `inline`.
* **_compression_** (string): the type of compression used on the config (null or gzip). Compression cannot be used with S3.
* **_http_headers_** (list of objects): a list of HTTP headers to be added to the request. Available for `http` and `https` source schemes only.
* **name** (string): the header name.
Expand All @@ -32,6 +34,8 @@ The Fedora IoT configuration is a YAML document conforming to the following spec
* **_source_** (string): the URL of the config. Supported schemes are `http`, `https`, `tftp`, `s3`, `arn`, `gs`, and [`data`](https://tools.ietf.org/html/rfc2397). When using `http`, it is advisable to use the verification option to ensure the contents haven't been modified. Mutually exclusive with `inline` and `local`.
* **_inline_** (string): the contents of the config. Mutually exclusive with `source` and `local`.
* **_local_** (string): a local path to the contents of the config, relative to the directory specified by the `--files-dir` command-line argument. Mutually exclusive with `source` and `inline`.
* **_inline_butane_** (string): the contents of the config. Mutually exclusive with `source` and `local`.
* **_local_butane_** (string): a local path to the contents of the config, relative to the directory specified by the `--files-dir` command-line argument. Mutually exclusive with `source` and `inline`.
* **_compression_** (string): the type of compression used on the config (null or gzip). Compression cannot be used with S3.
* **_http_headers_** (list of objects): a list of HTTP headers to be added to the request. Available for `http` and `https` source schemes only.
* **name** (string): the header name.
Expand All @@ -47,6 +51,8 @@ The Fedora IoT configuration is a YAML document conforming to the following spec
* **_source_** (string): the URL of the certificate bundle (in PEM format). The bundle can contain multiple concatenated certificates. Supported schemes are `http`, `https`, `tftp`, `s3`, `arn`, `gs`, and [`data`](https://tools.ietf.org/html/rfc2397). When using `http`, it is advisable to use the verification option to ensure the contents haven't been modified. Mutually exclusive with `inline` and `local`.
* **_inline_** (string): the contents of the certificate bundle (in PEM format). The bundle can contain multiple concatenated certificates. Mutually exclusive with `source` and `local`.
* **_local_** (string): a local path to the contents of the certificate bundle (in PEM format), relative to the directory specified by the `--files-dir` command-line argument. The bundle can contain multiple concatenated certificates. Mutually exclusive with `source` and `inline`.
* **_inline_butane_** (string): the contents of the certificate bundle. Mutually exclusive with `source` and `local`.
* **_local_butane_** (string): a local path to the contents of the certificate bundle, relative to the directory specified by the `--files-dir` command-line argument. Mutually exclusive with `source` and `inline`.
* **_compression_** (string): the type of compression used on the certificate bundle (null or gzip). Compression cannot be used with S3.
* **_http_headers_** (list of objects): a list of HTTP headers to be added to the request. Available for `http` and `https` source schemes only.
* **name** (string): the header name.
Expand All @@ -65,6 +71,8 @@ The Fedora IoT configuration is a YAML document conforming to the following spec
* **_source_** (string): the URL of the file. Supported schemes are `http`, `https`, `tftp`, `s3`, `arn`, `gs`, and [`data`](https://tools.ietf.org/html/rfc2397). When using `http`, it is advisable to use the verification option to ensure the contents haven't been modified. If source is omitted and a regular file already exists at the path, Ignition will do nothing. If source is omitted and no file exists, an empty file will be created. Mutually exclusive with `inline` and `local`.
* **_inline_** (string): the contents of the file. Mutually exclusive with `source` and `local`.
* **_local_** (string): a local path to the contents of the file, relative to the directory specified by the `--files-dir` command-line argument. Mutually exclusive with `source` and `inline`.
* **_inline_butane_** (string): the contents of the file. Mutually exclusive with `source` and `local`.
* **_local_butane_** (string): a local path to the contents of the file, relative to the directory specified by the `--files-dir` command-line argument. Mutually exclusive with `source` and `inline`.
* **_compression_** (string): the type of compression used on the file (null or gzip). Compression cannot be used with S3.
* **_http_headers_** (list of objects): a list of HTTP headers to be added to the request. Available for `http` and `https` source schemes only.
* **name** (string): the header name.
Expand All @@ -75,6 +83,8 @@ The Fedora IoT configuration is a YAML document conforming to the following spec
* **_source_** (string): the URL of the fragment. Supported schemes are `http`, `https`, `tftp`, `s3`, `arn`, `gs`, and [`data`](https://tools.ietf.org/html/rfc2397). When using `http`, it is advisable to use the verification option to ensure the contents haven't been modified. Mutually exclusive with `inline` and `local`.
* **_inline_** (string): the contents of the fragment. Mutually exclusive with `source` and `local`.
* **_local_** (string): a local path to the contents of the fragment, relative to the directory specified by the `--files-dir` command-line argument. Mutually exclusive with `source` and `inline`.
* **_inline_butane_** (string): the contents of the fragment. Mutually exclusive with `source` and `local`.
* **_local_butane_** (string): a local path to the contents of the fragment, relative to the directory specified by the `--files-dir` command-line argument. Mutually exclusive with `source` and `inline`.
* **_compression_** (string): the type of compression used on the fragment (null or gzip). Compression cannot be used with S3.
* **_http_headers_** (list of objects): a list of HTTP headers to be added to the request. Available for `http` and `https` source schemes only.
* **name** (string): the header name.
Expand Down
Loading